Page History
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
const fetch = require(""node-fetch"");
async function main() {
const host = ""http://localhost:8080/Yellowfin"";
const restUsername = ""admin@yellowfin.com.au"";
const restPassword = ""test"";
const newGroupName = ""New Group"";
const newGroupDescription = ""This is a new group"";
const token = await generateToken(host, restUsername, restPassword);
if (token === null) {
console.error(""Failed to retrieve access token"");
return;
}
const createGroupPayload = `{
""groupName"": ""${newGroupName}"",
""groupDescription"": ""${newGroupDescription}"",
""groupStatus"": ""OPEN"",
""isSecureGroup"": ""false""
}`;
console.log(""Payload:"", createGroupPayload);
const nonce = Math.floor(Math.random() * Number.MAX_SAFE_INTEGER);
const headers = {
'Authorization': `YELLOWFIN ts=${Date.now()}, nonce=${nonce}, token=${token}`,
'Accept': 'application/vnd.yellowfin.api-v1+json',
'Content-Type': 'application/json'
};
try {
const response = await fetch(`${host}/api/user-groups`, {
method: 'POST',
headers: headers,
body: createGroupPayload
});
if (!response.ok) {
throw new Error(`HTTP error! Status: ${response.status}`);
}
const responseBody = await response.text();
console.log(responseBody);
} catch (error) {
console.error(""Error:"", error.message);
}
}
async function generateToken(host, restUsername, restPassword) {
// Generate nonce
const nonce = Math.floor(Math.random() * Number.MAX_SAFE_INTEGER);
// Create request headers
const headers = {
'Authorization': `YELLOWFIN ts=${Date.now()}, nonce=${nonce}`,
'Accept': 'application/vnd.yellowfin.api-v1+json',
'Content-Type': 'application/json'
};
// Create request body
const body = `{
""userName"": ""${restUsername}"",
""password"": ""${restPassword}""
}`;
try {
// Make POST request
const response = await fetch(`${host}/api/refresh-tokens`, {
method: 'POST',
headers: headers,
body: body
});
// Check if request was successful
if (!response.ok) {
throw new Error(`HTTP error! Status: ${response.status}`);
}
// Parse JSON response
const jsonResponse = await response.json();
const accessToken = jsonResponse._embedded.accessToken.securityToken;
if (accessToken) {
console.log(`Access Token: ${accessToken}`);
} else {
console.log(""Token not retrieved"");
}
return accessToken;
} catch (error) {
console.error(""Error:"", error.message);
}
return null;
}
main(); |
Java | C# | Go | JavaScript | PHP | Python
Add Members to a Group
Members can be added to a group using the POST /api/user-groups/{groupId}/members end-point (https://developers.yellowfinbi.com/dev/api-docs/current/#operation/bulkAddUserGroupMembers ).
A list of new members can be posted using this end-point. The model that represents a group member is:
{
"entityType": "PERSON",
"entityCode": "",
"entityId": 13235,
"membershipType": "INCLUDED"
}
EntityType can be one of PERSON, GROUP, LDAP or ROLE.
EntityCode needs to be populated with a Role Code or LDAP group DN.
EntityId needs to be populated with either a user’s IpId, or a group’s IpId (where the IpId is the integer identifier for the member).
MembershipType can be one of INCLUDED or EXCLUDED. This determines whether the group member is included or explicitly excluded from the group.
The following examples illustrate how to add a user (identified by username), to a group (identified by its name) in various programming languages.
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<?php
function main() {
$host = ""http://localhost:8080/Yellowfin"";
$restUsername = ""admin@yellowfin.com.au"";
$restPassword = ""test"";
$newGroupName = ""New Group"";
$newGroupDescription = ""This is a new group"";
try {
$token = generateToken($host, $restUsername, $restPassword);
} catch (Exception $e) {
echo ""Error generating token: "" . $e->getMessage();
return;
}
$createGroupPayload = '{""groupName"":""' . $newGroupName . '"",""groupDescription"":""' . $newGroupDescription . '"",""groupStatus"":""OPEN"",""isSecureGroup"":""false""}';
echo ""Payload: "" . $createGroupPayload . ""\n"";
$nonce = mt_rand();
$headers = array(
'Authorization: YELLOWFIN ts=' . intval(microtime(true) * 1000) . ', nonce=' . $nonce . ', token=' . $token,
'Accept: application/vnd.yellowfin.api-v1+json',
'Content-Type: application/json'
);
try {
$response = httpRequest('POST', ""$host/api/user-groups"", $headers, $createGroupPayload);
echo $response;
} catch (Exception $e) {
echo ""Error sending request: "" . $e->getMessage();
}
}
function generateToken($host, $restUsername, $restPassword) {
// Generate nonce
$nonce = mt_rand();
// Create request body
$requestBody = '{""userName"":""' . $restUsername . '"",""password"":""' . $restPassword . '""}';
// Create request headers
$headers = array(
'Authorization: YELLOWFIN ts=' . intval(microtime(true) * 1000) . ', nonce=' . $nonce,
'Accept: application/vnd.yellowfin.api-v1+json',
'Content-Type: application/json'
);
$response = httpRequest('POST', ""$host/api/refresh-tokens"", $headers, $requestBody);
// Parse JSON response
$jsonResponse = json_decode($response, true);
// Get access token from response
if (isset($jsonResponse[""_embedded""][""accessToken""][""securityToken""])) {
$accessToken = $jsonResponse[""_embedded""][""accessToken""][""securityToken""];
echo ""Access Token: "" . $accessToken;
return $accessToken;
} else {
throw new Exception(""Token not retrieved successfully"");
}
}
function httpRequest($method, $url, $headers, $data = null) {
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
if ($data !== null) {
curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
}
$response = curl_exec($ch);
if (curl_errno($ch)) {
throw new Exception('Error: ' . curl_error($ch));
}
curl_close($ch);
return $response;
}
main()
?> |
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
import json
import random
import time
import requests
def main():
host = ""http://localhost:8080/Yellowfin""
rest_username = ""admin@yellowfin.com.au""
rest_password = ""test""
new_group_name = ""New Group""
new_group_description = ""This is a new group""
try:
token = generate_token(host, rest_username, rest_password)
create_group_payload = (
""{""
f"" \""groupName\"": \""{new_group_name}\"",""
f"" \""groupDescription\"": \""{new_group_description}\"",""
"" \""groupStatus\"": \""OPEN\"",""
"" \""isSecureGroup\"": \""false\""""
""}""
)
print(""Payload:"", create_group_payload)
nonce = random.randint(0, 2 ** 63 - 1)
headers = {
'Authorization': f'YELLOWFIN ts={int(time.time() * 1000)}, nonce={nonce}, token={token}',
'Accept': 'application/vnd.yellowfin.api-v1+json',
'Content-Type': 'application/json'
}
response = requests.post(host + ""/api/user-groups"", headers=headers, data=create_group_payload)
response.raise_for_status()
print(response.text)
except Exception as e:
print(f""Error: {e}"")
def generate_token(host, rest_username, rest_password):
nonce = random.randint(0, 2 ** 63 - 1)
request_body = json.dumps({
""userName"": rest_username,
""password"": rest_password
})
headers = {
'Authorization': f'YELLOWFIN ts={int(time.time() * 1000)}, nonce={nonce}',
'Accept': 'application/vnd.yellowfin.api-v1+json',
'Content-Type': 'application/json'
}
response = requests.post(host + ""/api/refresh-tokens"", headers=headers, data=request_body)
response.raise_for_status()
json_response = response.json()
access_token = json_response[""_embedded""][""accessToken""][""securityToken""]
print(""Access Token:"", access_token)
return access_token
if __name__ == ""__main__"":
main() |
Add Members to a Group
Members can be added to a group using the POST /api/user-groups/{groupId}/members end-point Bulk-add User Group Members.
A list of new members can be posted using this end-point. The model that represents a group member is:
| Code Block |
|---|
{
"entityType": "PERSON",
"entityCode": "",
"entityId": 13235,
"membershipType": "INCLUDED"
} |
EntityType can be one of PERSON, GROUP, LDAP or ROLE.
EntityCode needs to be populated with a Role Code or LDAP group DN.
EntityId needs to be populated with either a user’s IpId, or a group’s IpId (where the IpId is the integer identifier for the member).
MembershipType can be one of INCLUDED or EXCLUDED. This determines whether the group member is included or explicitly excluded from the group.
The following examples illustrate how to add a user (identified by username), to a group (identified by its name) in various programming languages.
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
package rest.code.examples;
import java.io.IOException;
import java.util.Random;
import org.apache.hc.client5.http.fluent.Content;
import org.apache.hc.client5.http.fluent.Request;
import com.google.gson.JsonArray;
import com.google.gson.JsonElement;
import com.google.gson.JsonObject;
import com.google.gson.JsonParser;
/**
* Create a user using the Yellowfin REST API
*/
public class AddMemberToGroup {
public static void main(String[] args) throws Exception {
String host = ""http://localhost:8080/Yellowfin"";
String restUsername = ""admin@yellowfin.com.au"";
String restPassword = ""test"";
String userGroupToAddUserTo = ""New Group"";
String usernameOfUserToAdd = ""user1@yellowfin.com.au"";
String token = generateToken(host, restUsername, restPassword);
Integer userIpId = retrieveUserIpIdForUsername(host, token, usernameOfUserToAdd);
Integer groupId = retrieveGroupIpIdForGroupName(host, token, userGroupToAddUserTo);
String groupMembersPayload =
""[\n""
+ "" {\n""
+ "" \""entityType\"": \""PERSON\"",\n""
+ "" \""entityId\"": "" + userIpId + "",\n""
+ "" \""membershipType\"": \""INCLUDED\""\n""
+ "" }\n""
+ ""]"";
System.out.println(""UserIpId: "" + userIpId);
System.out.println(""GroupId: "" + groupId);
System.out.println(""Payload: "" + groupMembersPayload);
Content c = Request.post(host + ""/api/user-groups/"" + groupId + ""/members"")
.addHeader(""Authorization"", ""YELLOWFIN ts="" + System.currentTimeMillis() + "" , nonce="" + new Random().nextLong() + "", token="" + token)
.addHeader(""Accept"", ""application/vnd.yellowfin.api-v1+json"")
.addHeader(""Content-Type"", ""application/json"")
.bodyString(groupMembersPayload, null)
.execute().returnContent();
System.out.println(""User "" + usernameOfUserToAdd + "" added to group "" + userGroupToAddUserTo + "" successfully"");
System.out.println(""Response: "" + c.asString());
}
public static Integer retrieveGroupIpIdForGroupName(String host, String token, String groupName) throws IOException {
Content c = Request.get(host + ""/api/user-groups"")
.addHeader(""Authorization"", ""YELLOWFIN ts="" + System.currentTimeMillis() + "" , nonce="" + new Random().nextLong() + "", token="" + token)
.addHeader(""Accept"", ""application/vnd.yellowfin.api-v1+json"")
.addHeader(""Content-Type"", ""application/json"")
.execute().returnContent();
JsonObject jsonObject = new JsonParser().parse(c.asString()).getAsJsonObject();
JsonElement groupList = jsonObject.get(""items"");
JsonArray groups = groupList.getAsJsonArray();
for (int i=0; i < groups.size(); i++ ) {
JsonObject group = groups.getAsJsonArray().get(i).getAsJsonObject();
if (groupName.equals(group.get(""shortDescription"").getAsString())) return group.get(""userGroupId"").getAsInt();
}
System.out.println(""Group could not be found for name:"" + groupName);
System.exit(-1);
return null;
}
public static Integer retrieveUserIpIdForUsername(String host, String token, String userName) throws IOException {
Content c = Request.get(host + ""/api/rpc/users/user-details-by-username/"" + userName)
.addHeader(""Authorization"", ""YELLOWFIN ts="" + System.currentTimeMillis() + "" , nonce="" + new Random().nextLong()+ "", token="" + token)
.addHeader(""Accept"", ""application/vnd.yellowfin.api-v1+json"")
.addHeader(""Content-Type"", ""application/json"")
.execute().returnContent();
JsonObject jsonObject = new JsonParser().parse(c.asString()).getAsJsonObject();
JsonElement userIpJsonAttribute = jsonObject.get(""userId"");
Integer userIpId = userIpJsonAttribute.getAsInt();
return userIpId;
}
/*
* This function generates an access token for a user that will grant them access to
* call REST API endpoints.
*/
public static String generateToken(String host, String username, String password) throws IOException {
Content c = Request.post(host + ""/api/refresh-tokens"")
.addHeader(""Authorization"", ""YELLOWFIN ts="" + System.currentTimeMillis() + "" , nonce="" + new Random().nextLong())
.addHeader(""Accept"", ""application/vnd.yellowfin.api-v1+json"")
.addHeader(""Content-Type"", ""application/json"")
.bodyString(""{ \""userName\"": \""""+ username + ""\"",\""password\"": \""""+ password + ""\""}"", null)
.execute().returnContent();
JsonObject jsonObject = new JsonParser().parse(c.asString()).getAsJsonObject();
JsonElement accessToken = jsonObject.getAsJsonObject(""_embedded"").getAsJsonObject(""accessToken"").get(""securityToken"");
if (accessToken!=null) {
System.out.println(""Access Token: "" + accessToken);
} else {
System.out.println(""Token not retrieved successfully"");
System.exit(-1);
}
return accessToken.getAsString();
}
} |
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
using System.Net.Http.Headers;
using Newtonsoft.Json;
using Newtonsoft.Json.Linq;
namespace rest.code.examples
{
public class AddMemberToGroup
{
static async Task Main(string[] args)
{
string host = ""http://localhost:8080/Yellowfin"";
string restUsername = ""admin@yellowfin.com.au"";
string restPassword = ""test"";
string userGroupToAddUserTo = ""New Group"";
string usernameOfUserToAdd = ""user1@yellowfin.com.au"";
string token = await GenerateToken(host, restUsername, restPassword);
int userIpId = await RetrieveUserIpIdForUsername(host, token, usernameOfUserToAdd);
int groupId = await RetrieveGroupIpIdForGroupName(host, token, userGroupToAddUserTo);
string groupMembersPayload = ""[{\""entityType\"": \""PERSON\"",\""entityId\"": "" + userIpId + "",\""membershipType\"": \""INCLUDED\""}]"";
Console.WriteLine(""UserIpId: "" + userIpId);
Console.WriteLine(""GroupId: "" + groupId);
Console.WriteLine(""Payload: "" + groupMembersPayload);
using (var httpClient = new HttpClient())
{
httpClient.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue(""YELLOWFIN"", ""ts="" + DateTimeOffset.UtcNow.ToUnixTimeMilliseconds() + "" , nonce="" + new Random().NextInt64() + "", token="" + token);
httpClient.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue(""application/vnd.yellowfin.api-v1+json""));
var content = new StringContent(groupMembersPayload);
content.Headers.ContentType = new MediaTypeHeaderValue(""application/json"");
var response = await httpClient.PostAsync(host + ""/api/user-groups/"" + groupId + ""/members"", content);
if (response.IsSuccessStatusCode)
{
Console.WriteLine(""User "" + usernameOfUserToAdd + "" added to group "" + userGroupToAddUserTo + "" successfully"");
string responseBody = await response.Content.ReadAsStringAsync();
Console.WriteLine(""Response: "" + responseBody);
}
else
{
Console.WriteLine(""Failed to add user to group. Status code: "" + response.StatusCode);
}
}
}
static async Task<int> RetrieveGroupIpIdForGroupName(string host, string token, string groupName)
{
using (var httpClient = new HttpClient())
{
httpClient.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue(""YELLOWFIN"", ""ts="" + DateTimeOffset.UtcNow.ToUnixTimeMilliseconds() + "" , nonce="" + new Random().NextInt64() + "", token="" + token);
httpClient.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue(""application/vnd.yellowfin.api-v1+json""));
var response = await httpClient.GetAsync(host + ""/api/user-groups"");
if (response.IsSuccessStatusCode)
{
string responseBody = await response.Content.ReadAsStringAsync();
JObject jsonObject = JObject.Parse(responseBody);
JArray groupList = (JArray)jsonObject[""items""];
foreach (var group in groupList)
{
if (groupName.Equals(group[""shortDescription""].ToString()))
{
return Convert.ToInt32(group[""userGroupId""]);
}
}
Console.WriteLine(""Group could not be found for name: "" + groupName);
Environment.Exit(-1);
}
else
{
Console.WriteLine(""Failed to retrieve groups. Status code: "" + response.StatusCode);
}
}
return -1;
}
static async Task<int> RetrieveUserIpIdForUsername(string host, string token, string userName)
{
using (var httpClient = new HttpClient())
{
httpClient.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue(""YELLOWFIN"", ""ts="" + DateTimeOffset.UtcNow.ToUnixTimeMilliseconds() + "" , nonce="" + new Random().NextInt64() + "", token="" + token);
httpClient.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue(""application/vnd.yellowfin.api-v1+json""));
var response = await httpClient.GetAsync(host + ""/api/rpc/users/user-details-by-username/"" + userName);
if (response.IsSuccessStatusCode)
{
string responseBody = await response.Content.ReadAsStringAsync();
JObject jsonObject = JObject.Parse(responseBody);
return Convert.ToInt32(jsonObject[""userId""]);
}
else
{
Console.WriteLine(""Failed to retrieve user. Status code: "" + response.StatusCode);
}
}
return -1;
}
static async Task<string> GenerateToken(string host, string username, string password)
{
using (var client = new HttpClient())
{
// Generate nonce
long nonce = new Random().NextInt64();
// Create HTTP request
var request = new HttpRequestMessage(HttpMethod.Post, host + ""/api/refresh-tokens"");
request.Headers.Add(""Authorization"", ""YELLOWFIN ts="" + DateTimeOffset.UtcNow.ToUnixTimeMilliseconds() + "", nonce="" + nonce);
request.Headers.Add(""Accept"", ""application/vnd.yellowfin.api-v1+json"");
request.Content = new StringContent(
JsonConvert.SerializeObject(new { userName = username, password = password }),
MediaTypeHeaderValue.Parse(""application/json"")
);
// Send request and get response
HttpResponseMessage response = await client.SendAsync(request);
string responseContent = await response.Content.ReadAsStringAsync();
// Parse JSON response
JObject jsonObject = JObject.Parse(responseContent);
string accessToken = jsonObject[""_embedded""][""accessToken""][""securityToken""].ToString();
if (!string.IsNullOrEmpty(accessToken))
{
Console.WriteLine(""Access Token: "" + accessToken);
}
else
{
Console.WriteLine(""Token not retrieved successfully"");
Environment.Exit(-1);
}
return accessToken;
}
}
}
} |
| Code Block | ||||
|---|---|---|---|---|
| ||||
package main
import (
""bytes""
""encoding/json""
""fmt""
""io/ioutil""
""math/rand""
""net/http""
""time""
)
func main() {
host := ""http://localhost:8080/Yellowfin""
restUsername := ""admin@yellowfin.com.au""
restPassword := ""test""
userGroupToAddUserTo := ""New Group""
usernameOfUserToAdd := ""user1@yellowfin.com.au""
token, err := generateToken(host, restUsername, restPassword)
if err != nil {
fmt.Println(""Error generating token:"", err)
return
}
userIpId, err := retrieveUserIpIdForUsername(host, token, usernameOfUserToAdd)
if err != nil {
fmt.Println(""Error retrieving user IP ID:"", err)
return
}
groupId, err := retrieveGroupIpIdForGroupName(host, token, userGroupToAddUserTo)
if err != nil {
fmt.Println(""Error retrieving group IP ID:"", err)
return
}
groupMembersPayload := fmt.Sprintf(`[
{
""entityType"": ""PERSON"",
""entityId"": %d,
""membershipType"": ""INCLUDED""
}
]`, userIpId)
fmt.Println(""UserIpId:"", userIpId)
fmt.Println(""GroupId:"", groupId)
fmt.Println(""Payload:"", groupMembersPayload)
client := &http.Client{}
req, err := http.NewRequest(""POST"", fmt.Sprintf(""%s/api/user-groups/%d/members"", host, groupId), bytes.NewBufferString(groupMembersPayload))
if err != nil {
fmt.Println(""Error creating request:"", err)
return
}
nonce := rand.Int63()
req.Header.Set(""Authorization"", fmt.Sprintf(""YELLOWFIN ts=%d, nonce=%d, token=%s"", time.Now().UnixMilli(), nonce, token))
req.Header.Set(""Accept"", ""application/vnd.yellowfin.api-v1+json"")
req.Header.Set(""Content-Type"", ""application/json"")
resp, err := client.Do(req)
if err != nil {
fmt.Println(""Error sending request:"", err)
return
}
defer resp.Body.Close()
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
fmt.Println(""Error reading response body:"", err)
return
}
fmt.Printf(""User %s added to group %s successfully\n"", usernameOfUserToAdd, userGroupToAddUserTo)
fmt.Println(""Response:"", string(body))
}
func retrieveGroupIpIdForGroupName(host, token, groupName string) (int, error) {
client := &http.Client{}
req, err := http.NewRequest(""GET"", host+""/api/user-groups"", nil)
if err != nil {
return 0, err
}
nonce := rand.Int63()
req.Header.Set(""Authorization"", fmt.Sprintf(""YELLOWFIN ts=%d, nonce=%d, token=%s"", time.Now().UnixMilli(), nonce, token))
req.Header.Set(""Accept"", ""application/vnd.yellowfin.api-v1+json"")
req.Header.Set(""Content-Type"", ""application/json"")
resp, err := client.Do(req)
if err != nil {
return 0, err
}
defer resp.Body.Close()
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
return 0, err
}
var data map[string]interface{}
err = json.Unmarshal(body, &data)
if err != nil {
return 0, err
}
groups := data[""items""].([]interface{})
for _, g := range groups {
group := g.(map[string]interface{})
if groupName == group[""shortDescription""].(string) {
return int(group[""userGroupId""].(float64)), nil
}
}
return 0, fmt.Errorf(""Group could not be found for name: %s"", groupName)
}
func retrieveUserIpIdForUsername(host, token, userName string) (int, error) {
client := &http.Client{}
req, err := http.NewRequest(""GET"", host+""/api/rpc/users/user-details-by-username/""+userName, nil)
if err != nil {
return 0, err
}
nonce := rand.Int63()
req.Header.Set(""Authorization"", fmt.Sprintf(""YELLOWFIN ts=%d, nonce=%d, token=%s"", time.Now().UnixMilli(), nonce, token))
req.Header.Set(""Accept"", ""application/vnd.yellowfin.api-v1+json"")
req.Header.Set(""Content-Type"", ""application/json"")
resp, err := client.Do(req)
if err != nil {
return 0, err
}
defer resp.Body.Close()
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
return 0, err
}
var data map[string]interface{}
err = json.Unmarshal(body, &data)
if err != nil {
return 0, err
}
return int(data[""userId""].(float64)), nil
}
func generateToken(host, username, password string) (string, error) {
nonce := rand.Int63()
requestBody, err := json.Marshal(map[string]string{
""userName"": username,
""password"": password,
})
if err != nil {
return """", err
}
client := &http.Client{}
req, err := http.NewRequest(""POST"", host+""/api/refresh-tokens"", bytes.NewBuffer(requestBody))
if err != nil {
return """", err
}
req.Header.Set(""Authorization"", fmt.Sprintf(""YELLOWFIN ts=%d, nonce=%d"", time.Now().UnixMilli(), nonce))
req.Header.Set(""Accept"", ""application/vnd.yellowfin.api-v1+json"")
req.Header.Set(""Content-Type"", ""application/json"")
resp, err := client.Do(req)
if err != nil {
return """", err
}
defer resp.Body.Close()
responseBody, err := ioutil.ReadAll(resp.Body)
if err != nil {
return """", err
}
var jsonResponse map[string]interface{}
err = json.Unmarshal(responseBody, &jsonResponse)
if err != nil {
return """", err
}
accessToken := jsonResponse[""_embedded""].(map[string]interface{})[""accessToken""].(map[string]interface{})[""securityToken""].(string)
return accessToken, nil
} |
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
const fetch = require(""node-fetch"");
async function main() {
const host = ""http://localhost:8080/Yellowfin"";
const restUsername = ""admin@yellowfin.com.au"";
const restPassword = ""test"";
const userGroupToAddUserTo = ""New Group"";
const usernameOfUserToAdd = ""user1@yellowfin.com.au"";
const token = await generateToken(host, restUsername, restPassword);
if (token === null) {
console.error(""Failed to retrieve access token"");
return;
}
const userIpId = await retrieveUserIpIdForUsername(host, token, usernameOfUserToAdd);
const groupId = await retrieveGroupIpIdForGroupName(host, token, userGroupToAddUserTo);
const groupMembersPayload = JSON.stringify([
{
entityType: ""PERSON"",
entityId: userIpId,
membershipType: ""INCLUDED""
}
]);
console.log(""UserIpId:"", userIpId);
console.log(""GroupId:"", groupId);
console.log(""Payload:"", groupMembersPayload);
const nonce = Math.floor(Math.random() * Number.MAX_SAFE_INTEGER);
const headers = {
'Authorization': `YELLOWFIN ts=${Date.now()}, nonce=${nonce}, token=${token}`,
'Accept': 'application/vnd.yellowfin.api-v1+json',
'Content-Type': 'application/json'
};
try {
const response = await fetch(`${host}/api/user-groups/${groupId}/members`, {
method: 'POST',
headers: headers,
body: groupMembersPayload
});
if (!response.ok) {
throw new Error(`HTTP error! Status: ${response.status}`);
}
const responseBody = await response.text();
console.log(`User ${usernameOfUserToAdd} added to group ${userGroupToAddUserTo} successfully`);
console.log(""Response:"", responseBody);
} catch (error) {
console.error(""Error:"", error.message);
}
}
async function retrieveGroupIpIdForGroupName(host, token, groupName) {
const nonce = Math.floor(Math.random() * Number.MAX_SAFE_INTEGER);
const headers = {
'Authorization': `YELLOWFIN ts=${Date.now()}, nonce=${nonce}, token=${token}`,
'Accept': 'application/vnd.yellowfin.api-v1+json',
'Content-Type': 'application/json'
};
try {
const response = await fetch(`${host}/api/user-groups`, {
method: 'GET',
headers: headers
});
if (!response.ok) {
throw new Error(`HTTP error! Status: ${response.status}`);
}
const jsonResponse = await response.json();
const groups = jsonResponse.items;
for (const group of groups) {
if (group.shortDescription === groupName) {
return group.userGroupId;
}
}
console.log(`Group could not be found for name: ${groupName}`);
process.exit(-1);
} catch (error) {
console.error(""Error:"", error.message);
}
return null;
}
async function retrieveUserIpIdForUsername(host, token, userName) {
const nonce = Math.floor(Math.random() * Number.MAX_SAFE_INTEGER);
const headers = {
'Authorization': `YELLOWFIN ts=${Date.now()}, nonce=${nonce}, token=${token}`,
'Accept': 'application/vnd.yellowfin.api-v1+json',
'Content-Type': 'application/json'
};
try {
const response = await fetch(`${host}/api/rpc/users/user-details-by-username/${userName}`, {
method: 'GET',
headers: headers
});
if (!response.ok) {
throw new Error(`HTTP error! Status: ${response.status}`);
}
const jsonResponse = await response.json();
return jsonResponse.userId;
} catch (error) {
console.error(""Error:"", error.message);
}
return null;
}
async function generateToken(host, username, password) {
const nonce = Math.floor(Math.random() * Number.MAX_SAFE_INTEGER);
const headers = {
'Authorization': `YELLOWFIN ts=${Date.now()}, nonce=${nonce}`,
'Accept': 'application/vnd.yellowfin.api-v1+json',
'Content-Type': 'application/json'
};
const body = JSON.stringify({
userName: username,
password: password
});
try {
const response = await fetch(`${host}/api/refresh-tokens`, {
method: 'POST',
headers: headers,
body: body
});
if (!response.ok) {
throw new Error(`HTTP error! Status: ${response.status}`);
}
const jsonResponse = await response.json();
const accessToken = jsonResponse._embedded.accessToken.securityToken;
if (accessToken) {
console.log(`Access Token: ${accessToken}`);
} else {
console.log(""Token not retrieved"");
}
return accessToken;
} catch (error) {
console.error(""Error:"", error.message);
}
return null;
}
main(); |
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<?php
function main() {
$host = ""http://localhost:8080/Yellowfin"";
$restUsername = ""admin@yellowfin.com.au"";
$restPassword = ""test"";
$userGroupToAddUserTo = ""New Group"";
$usernameOfUserToAdd = ""user1@yellowfin.com.au"";
try {
$token = generateToken($host, $restUsername, $restPassword);
} catch (Exception $e) {
echo ""Error generating token: "" . $e->getMessage();
return;
}
try {
$userIpId = retrieveUserIpIdForUsername($host, $token, $usernameOfUserToAdd);
$groupId = retrieveGroupIpIdForGroupName($host, $token, $userGroupToAddUserTo);
} catch (Exception $e) {
echo ""Error: "" . $e->getMessage();
return;
}
$groupMembersPayload = '[{""entityType"": ""PERSON"",""entityId"": ' . $userIpId . ',""membershipType"": ""INCLUDED""}]';
echo ""UserIpId: "" . $userIpId . ""\n"";
echo ""GroupId: "" . $groupId . ""\n"";
echo ""Payload: "" . $groupMembersPayload . ""\n"";
$nonce = mt_rand();
$headers = array(
'Authorization: YELLOWFIN ts=' . intval(microtime(true) * 1000) . ', nonce=' . $nonce . ', token=' . $token,
'Accept: application/vnd.yellowfin.api-v1+json',
'Content-Type: application/json'
);
try {
$response = httpRequest('POST', $host . ""/api/user-groups/"" . $groupId . ""/members"", $headers, $groupMembersPayload);
echo $response;
} catch (Exception $e) {
echo ""Error sending request: "" . $e->getMessage();
}
}
function generateToken($host, $restUsername, $restPassword) {
// Generate nonce
$nonce = mt_rand();
// Create request body
$requestBody = json_encode(array(
""userName"" => $restUsername,
""password"" => $restPassword
));
// Create request headers
$headers = array(
'Authorization: YELLOWFIN ts=' . intval(microtime(true) * 1000) . ', nonce=' . $nonce,
'Accept: application/vnd.yellowfin.api-v1+json',
'Content-Type: application/json'
);
$response = httpRequest('POST', $host . ""/api/refresh-tokens"", $headers, $requestBody);
// Parse JSON response
$jsonResponse = json_decode($response, true);
// Get access token from response
if (isset($jsonResponse[""_embedded""][""accessToken""][""securityToken""])) {
$accessToken = $jsonResponse[""_embedded""][""accessToken""][""securityToken""];
echo ""Access Token: "" . $accessToken;
return $accessToken;
} else {
throw new Exception(""Token not retrieved successfully"");
}
}
function retrieveGroupIpIdForGroupName($host, $token, $groupName) {
$nonce = mt_rand();
$headers = array(
'Authorization: YELLOWFIN ts=' . intval(microtime(true) * 1000) . ', nonce=' . $nonce . ', token=' . $token,
'Accept: application/vnd.yellowfin.api-v1+json',
'Content-Type: application/json'
);
$response = httpRequest('GET', $host . ""/api/user-groups"", $headers);
// Parse JSON response
$jsonResponse = json_decode($response, true);
$groups = $jsonResponse[""items""];
foreach ($groups as $group) {
if ($group[""shortDescription""] === $groupName) {
return $group[""userGroupId""];
}
}
echo ""Group could not be found for name:"" . $groupName;
exit(-1);
}
function retrieveUserIpIdForUsername($host, $token, $userName) {
$nonce = mt_rand();
$headers = array(
'Authorization: YELLOWFIN ts=' . intval(microtime(true) * 1000) . ', nonce=' . $nonce . ', token=' . $token,
'Accept: application/vnd.yellowfin.api-v1+json',
'Content-Type: application/json'
);
$response = httpRequest('GET', $host . ""/api/rpc/users/user-details-by-username/"" . $userName, $headers);
// Parse JSON response
$jsonResponse = json_decode($response, true);
return $jsonResponse[""userId""];
}
function httpRequest($method, $url, $headers, $data = null) {
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
if ($data !== null) {
curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
}
$response = curl_exec($ch);
if (curl_errno($ch)) {
throw new Exception('Error: ' . curl_error($ch));
}
curl_close($ch);
return $response;
}
main();
?> |
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
import json
import random
import time
import requests
def main():
host = ""http://localhost:8080/Yellowfin""
rest_username = ""admin@yellowfin.com.au""
rest_password = ""test""
user_group_to_add_user_to = ""New Group""
username_of_user_to_add = ""user1@yellowfin.com.au""
try:
token = generate_token(host, rest_username, rest_password)
except Exception as e:
print(f""Error generating token: {e}"")
return
try:
user_ip_id = retrieve_user_ip_id_for_username(host, token, username_of_user_to_add)
group_id = retrieve_group_ip_id_for_group_name(host, token, user_group_to_add_user_to)
except Exception as e:
print(f""Error: {e}"")
return
group_members_payload = f""[{{\""entityType\"": \""PERSON\"", \""entityId\"": {user_ip_id}, \""membershipType\"": \""INCLUDED\""}}]""
print(f""UserIpId: {user_ip_id}"")
print(f""GroupId: {group_id}"")
print(f""Payload: {group_members_payload}"")
nonce = random.randint(0, 2**63 - 1)
headers = {
'Authorization': f'YELLOWFIN ts={int(time.time() * 1000)}, nonce={nonce}, token={token}',
'Accept': 'application/vnd.yellowfin.api-v1+json',
'Content-Type': 'application/json'
}
try:
response = requests.post(f""{host}/api/user-groups/{group_id}/members"", headers=headers, data=group_members_payload)
response.raise_for_status()
print(response.text)
except requests.RequestException as e:
print(f""Error sending request: {e}"")
def generate_token(host, rest_username, rest_password):
nonce = random.randint(0, 2**63 - 1)
request_body = json.dumps({
""userName"": rest_username,
""password"": rest_password
})
headers = {
'Authorization': f'YELLOWFIN ts={int(time.time() * 1000)}, nonce={nonce}',
'Accept': 'application/vnd.yellowfin.api-v1+json',
'Content-Type': 'application/json'
}
response = requests.post(f""{host}/api/refresh-tokens"", headers=headers, data=request_body)
if response.status_code == 200:
json_response = response.json()
access_token = json_response[""_embedded""][""accessToken""][""securityToken""]
print(""Access Token:"", access_token)
return access_token
else:
raise Exception(""Token not retrieved successfully"")
def retrieve_group_ip_id_for_group_name(host, token, group_name):
nonce = random.randint(0, 2**63 - 1)
headers = {
'Authorization': f'YELLOWFIN ts={int(time.time() * 1000)}, nonce={nonce}, token={token}',
'Accept': 'application/vnd.yellowfin.api-v1+json',
'Content-Type': 'application/json'
}
response = requests.get(f""{host}/api/user-groups"", headers=headers)
if response.status_code == 200:
json_response = response.json()
groups = json_response[""items""]
for group in groups:
if group[""shortDescription""] == group_name:
return group[""userGroupId""]
print(f""Group could not be found for name: {group_name}"")
exit(-1)
else:
raise Exception(""Error retrieving group"")
def retrieve_user_ip_id_for_username(host, token, username):
nonce = random.randint(0, 2**63 - 1)
headers = {
'Authorization': f'YELLOWFIN ts={int(time.time() * 1000)}, nonce={nonce}, token={token}',
'Accept': 'application/vnd.yellowfin.api-v1+json',
'Content-Type': 'application/json'
}
response = requests.get(f""{host}/api/rpc/users/user-details-by-username/{username}"", headers=headers)
if response.status_code == 200:
json_response = response.json()
return json_response[""userId""]
else:
raise Exception(""Error retrieving user ID"")
if __name__ == ""__main__"":
main() |
Remove Members from a Group
...