Suggest Edits

Cloud User Management

 
Suggest Edits

Change cloud user properties.

User must be a cloud user.
Specified user must be you, you must be a system administrator or have user management permissions.
Specifying 'ServiceUser' will override the 'InEveryBodyRole' property if both are provided.

 
post/CDirectoryService/ChangeUser
curl --request POST \
  --url https://example.com/CDirectoryService/ChangeUser
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/CDirectoryService/ChangeUser' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/CDirectoryService/ChangeUser")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/CDirectoryService/ChangeUser");

xhr.send(data);
import requests

url = "https://example.com/CDirectoryService/ChangeUser"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

CmaRedirectedUserUuid
string

Centrify mobile authenticator redirected user uuid

HomeNumber
string

User home number.

AccountExp
date-time

Account expires date/time. You must be a system administrator or have user management permissions to change this field.

ReportsTo
string

User reports to this user UUID. You must be a system administrator or have user management permissions to change this field.

DisplayName
string

User display name.

PasswordNeverExpire
boolean

Does user's password expire? You must be a system administrator or have user management permissions to change this field.

ID
string

UUID of the cloud user to change (default=current user).

OfficeNumber
string

User office number.

MobileNumber
string

User mobile number.

InEverybodyRole
boolean

Is user in the Everybody role? You must be a system administrator or have user management permissions to change this field.

ServiceUser
boolean

User is a service user

PreferredCulture
string

User preferred culture.

Mail
string

User email.

Description
string

User description.

Name
string

User name. You must be a system administrator or have user management permissions to change this field.

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

Standard result

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Create a new user in the Cloud Directory Service.

You must be a system administrator or have user management permissions.
Specifying 'ServiceUser' will override the 'InEveryBodyRole' property if both are provided.

 
posthttps://example.com/CDirectoryService/CreateUser
curl --request POST \
  --url https://example.com/CDirectoryService/CreateUser
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/CDirectoryService/CreateUser' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/CDirectoryService/CreateUser")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/CDirectoryService/CreateUser");

xhr.send(data);
import requests

url = "https://example.com/CDirectoryService/CreateUser"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

Password
string

URL encoded password of the user (default=randomly generated strong password)

CmaRedirectedUserUuid
string

Centrify mobile authenticator redirected user uuid

HomeNumber
string

User's home number (default=null)

ReportsTo
string

Uuid of user this user reports to (default=null)

PasswordNeverExpire
boolean

User's password never expires (default=false)

DisplayName
string

Display name of user (default=null)

SendSmsInvite
boolean

Send user an sms invite to enroll their mobile device in the protal (default=false)

OfficeNumber
string

User's office number (default=null)

ForcePasswordChangeNext
boolean

Force password change at first login (default=true)

InSysAdminRole
boolean

Place user in System Adminstrator role (default=false)

MobileNumber
string

User's mobile number (default=null); note this field is required if SendSmsInvite is true

InEverybodyRole
boolean

Place user in Everybody role (default=true)

ServiceUser
boolean

User is a service user (default=false)

Mail
string

Email of user (default=null); note this field is required if 'SendEmailInvite' is true.

SendEmailInvite
boolean

Send user an email invite to the portal (default=true)

Description
string

Description of user (default=null)

Name
string
required

Name of user

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

UUID of the created user.

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Create a new user in the Cloud Directory Service.

You must be a system administrator or have user management permissions.

 
posthttps://example.com/CDirectoryService/CreateUserQuick
curl --request POST \
  --url https://example.com/CDirectoryService/CreateUserQuick
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/CDirectoryService/CreateUserQuick' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/CDirectoryService/CreateUserQuick")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/CDirectoryService/CreateUserQuick");

xhr.send(data);
import requests

url = "https://example.com/CDirectoryService/CreateUserQuick"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

HomeNumber
string

User home phone number (default=null)

AccountExp
date-time

Date/time account expires (default=never)

ReportsTo
string

User reports to user UUID (default=null)

PasswordNeverExpire
string

Does the user's password never expire (must be 'True' or 'False)? (default=False)

DisplayName
string

User display name (default=null)

OfficeNumber
string

User office phone number (default=null)

MobileNumber
string

User mobile phone number (default=null)

InEverybodyRole
string

Is user in the Everybody role (must be 'True' or 'False)? (default=True)

Mail
string
required

Email of user

Description
string

User description (default=null)

Name
string
required

Name of user

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

UUID of the created user.

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Delete a cloud user. (DEPRECATED)

(Deprecated - use UserMgmt/RemoveUser instead.)
You must be a system administrator or have user management permissions. User must exist, and cannot be the current user.
Cloud users will be deleted; users from other directory services will be removed from the cloud.

 
posthttps://example.com/CDirectoryService/DeleteUser
curl --request POST \
  --url 'https://example.com/CDirectoryService/DeleteUser?ID=ID'
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/CDirectoryService/DeleteUser',
  qs: { ID: 'ID' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/CDirectoryService/DeleteUser?ID=ID")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/CDirectoryService/DeleteUser?ID=ID");

xhr.send(data);
import requests

url = "https://example.com/CDirectoryService/DeleteUser"

querystring = {"ID":"ID"}

response = requests.request("POST", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

ID
string
required

User UUID or Name to delete

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

Standard result

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Get details for a specified cloud user.

Specified user must be you, you must be a system administrator, or have user management permissions.

 
posthttps://example.com/CDirectoryService/GetUser
curl --request POST \
  --url https://example.com/CDirectoryService/GetUser
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/CDirectoryService/GetUser' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/CDirectoryService/GetUser")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/CDirectoryService/GetUser");

xhr.send(data);
import requests

url = "https://example.com/CDirectoryService/GetUser"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

ID
string

UUID of the cloud user to fetch (default=current user).

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

Cloud user details

Result.HomeNumberstring

User home phone number

Result.Aliasstring

Login suffix of the user

Result.ReportsTostring

User reports to user UUID.

Result.PasswordNeverExpireboolean

Does the user's password never expire?

Result.PictureUristring

File system path to user picture file

Result.DisplayNamestring

User display name

Result.Uuidstring

User UUID

Result.OfficeNumberstring

User office phone number

Result.LastPasswordChangeDatestring

Date/time user last changed their password

Result.MobileNumberstring

User mobile phone number

Result.InEverybodyRoleboolean

Is user in the Everybody role?

Result.PreferredCulturestring

User preferred culture

Result.Statestring

User state (locked, enabled, expired)

Result.Mailstring

User email

Result.Descriptionstring

User description

Result.Namestring

User name

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Get all cloud users.

 
posthttps://example.com/CDirectoryService/GetUsers
curl --request POST \
  --url https://example.com/CDirectoryService/GetUsers
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/CDirectoryService/GetUsers' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/CDirectoryService/GetUsers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/CDirectoryService/GetUsers");

xhr.send(data);
import requests

url = "https://example.com/CDirectoryService/GetUsers"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

List of cloud users; each user contains the following properties.

Result.HomeNumberstring

User home phone number

Result.ReportsTostring

User reports to user UUID.

Result.PictureUristring

File system path to user picture file

Result.DisplayNamestring

User display name

Result.Uuidstring

User UUID

Result.OfficeNumberstring

User office phone number

Result.MobileNumberstring

User mobile phone number

Result.PreferredCulturestring

User preferred culture

Result.Mailstring

User email

Result.Descriptionstring

User description

Result.Namestring

User name

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Set a cloud user's picture file.

Specified user must be you, you must be a system administrator or have user management permissions.

 
posthttps://example.com/CDirectoryService/SetUserPicture
curl --request POST \
  --url 'https://example.com/CDirectoryService/SetUserPicture?ID=ID'
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/CDirectoryService/SetUserPicture',
  qs: { ID: 'ID' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/CDirectoryService/SetUserPicture?ID=ID")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/CDirectoryService/SetUserPicture?ID=ID");

xhr.send(data);
import requests

url = "https://example.com/CDirectoryService/SetUserPicture"

querystring = {"ID":"ID"}

response = requests.request("POST", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

ID
string
required

User UUID

Form Data

payload
file
required

Included picture file.

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

URI path of the user's picture

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Set user State (locked, disabled, expired) for a specified cloud user.

You must be a system administrator or have user management permissions. Specified cloud user may not be the default system adminstrator.
Specified new state may either be 'None' or include one or more of the following values (comma separated): Locked, Disabled, or Expired.

 
posthttps://example.com/CDirectoryService/SetUserState
curl --request POST \
  --url https://example.com/CDirectoryService/SetUserState
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/CDirectoryService/SetUserState' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/CDirectoryService/SetUserState")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/CDirectoryService/SetUserState");

xhr.send(data);
import requests

url = "https://example.com/CDirectoryService/SetUserState"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

ID
string
required

UUID of the cloud user to change.

state
string
required

New state of the user.

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

Standard result

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

User Management

 
Suggest Edits

Exempt a specified user from MFA login for a period of time.

You must be a system administrator or have user management permissions. User is exempt from MFA login for a specified amount of time.

 
posthttps://example.com/CDirectoryService/ExemptUserFromMfa
curl --request POST \
  --url 'https://example.com/CDirectoryService/ExemptUserFromMfa?ID=ID'
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/CDirectoryService/ExemptUserFromMfa',
  qs: { ID: 'ID' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/CDirectoryService/ExemptUserFromMfa?ID=ID")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/CDirectoryService/ExemptUserFromMfa?ID=ID");

xhr.send(data);
import requests

url = "https://example.com/CDirectoryService/ExemptUserFromMfa"

querystring = {"ID":"ID"}

response = requests.request("POST", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

ID
string
required

User UUID to except from MFA

timespan
integer

Amount of time to exempt the user from MFA (default=10 minutes)

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

Standard result

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Get details for the current user.

 
posthttps://example.com/CDirectoryService/GetUserAttributes
curl --request POST \
  --url https://example.com/CDirectoryService/GetUserAttributes
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/CDirectoryService/GetUserAttributes' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/CDirectoryService/GetUserAttributes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/CDirectoryService/GetUserAttributes");

xhr.send(data);
import requests

url = "https://example.com/CDirectoryService/GetUserAttributes"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

Cloud user details

Result.HomeNumberstring

User home phone number

Result.Aliasstring

Login suffix of the user

Result.ReportsTostring

User reports to user UUID.

Result.PasswordNeverExpireboolean

Does the user's password never expire?

Result.PictureUristring

File system path to user picture file

Result.DisplayNamestring

User display name

Result.Uuidstring

User UUID

Result.OfficeNumberstring

User office phone number

Result.LastPasswordChangeDatestring

Date/time user last changed their password

Result.MobileNumberstring

User mobile phone number

Result.InEverybodyRoleboolean

Is user in the Everybody role?

Result.Statestring

User state (locked, enabled, expired)

Result.Mailstring

User email

Result.Descriptionstring

User description

Result.Namestring

User name

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Refresh a user's cached identity.

You must be a system administrator or have user management permissions. User cached identity in the cloud is reloaded from their directory service.
Useful when user details have changed in their remote directory service, but have not yet been pushed to the cloud.

 
posthttps://example.com/CDirectoryService/RefreshToken
curl --request POST \
  --url 'https://example.com/CDirectoryService/RefreshToken?ID=ID'
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/CDirectoryService/RefreshToken',
  qs: { ID: 'ID' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/CDirectoryService/RefreshToken?ID=ID")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/CDirectoryService/RefreshToken?ID=ID");

xhr.send(data);
import requests

url = "https://example.com/CDirectoryService/RefreshToken"

querystring = {"ID":"ID"}

response = requests.request("POST", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

ID
string
required

User UUID to refresh

directoryServiceUuid
string

UUID of the user's directory service (default=null)

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

Standard result

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Refresh current user's cached identity.

User cached identity in the cloud is reloaded from their directory service. Useful when user details have changed in their remote directory service, but have not yet been pushed to the cloud.

 
posthttps://example.com/Security/RefreshToken
curl --request POST \
  --url https://example.com/Security/RefreshToken
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/Security/RefreshToken' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/Security/RefreshToken")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/Security/RefreshToken");

xhr.send(data);
import requests

url = "https://example.com/Security/RefreshToken"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

Standard result

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Delete admin security question.

 
posthttps://example.com/TenantConfig/DeleteAdminSecurityQuestion
curl --request POST \
  --url https://example.com/TenantConfig/DeleteAdminSecurityQuestion
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/TenantConfig/DeleteAdminSecurityQuestion' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/TenantConfig/DeleteAdminSecurityQuestion")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/TenantConfig/DeleteAdminSecurityQuestion");

xhr.send(data);
import requests

url = "https://example.com/TenantConfig/DeleteAdminSecurityQuestion"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

Id
string
required

Uuid of the question to delete

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

Standard result

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Get a specific admin security question

 
posthttps://example.com/TenantConfig/GetAdminSecurityQuestion
curl --request POST \
  --url https://example.com/TenantConfig/GetAdminSecurityQuestion
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/TenantConfig/GetAdminSecurityQuestion' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/TenantConfig/GetAdminSecurityQuestion")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/TenantConfig/GetAdminSecurityQuestion");

xhr.send(data);
import requests

url = "https://example.com/TenantConfig/GetAdminSecurityQuestion"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

Id
string
required

Uuid of the question

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject
          Admin Security Question withs the following properties
          {
            description: "Admin Security Question",
            properties: {
              Uuid: { description: "Question Uuid", type: "string" },
              Question: { "description": "Text of the question", type: "string" }
              Culture: { "description": "Culture of the question, 'all' implies all cultures", type: "string" }
            }
          }
Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Get admin security questions

 
posthttps://example.com/TenantConfig/GetAdminSecurityQuestions
curl --request POST \
  --url https://example.com/TenantConfig/GetAdminSecurityQuestions
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/TenantConfig/GetAdminSecurityQuestions' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/TenantConfig/GetAdminSecurityQuestions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/TenantConfig/GetAdminSecurityQuestions");

xhr.send(data);
import requests

url = "https://example.com/TenantConfig/GetAdminSecurityQuestions"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject
          List of Admin Security Questions; each entry is has the following properties
          {
            description: "Admin Security Question",
            properties: {
              Uuid: { description: "Question Uuid", type: "string" },
              Question: { "description": "Text of the question", type: "string" }
              Culture: { "description": "Culture of the question, 'all' implies all cultures", type: "string" }
            }
          }
Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Add admin security question.

 
posthttps://example.com/TenantConfig/SetAdminSecurityQuestion
curl --request POST \
  --url https://example.com/TenantConfig/SetAdminSecurityQuestion
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/TenantConfig/SetAdminSecurityQuestion' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/TenantConfig/SetAdminSecurityQuestion")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/TenantConfig/SetAdminSecurityQuestion");

xhr.send(data);
import requests

url = "https://example.com/TenantConfig/SetAdminSecurityQuestion"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

Culture
string

Culture of the question to add.

Question
string
required

Test of the question to add.

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

Standard result

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Runs a risk check for the current user.

You must be logged in and the tenant must have the Adaptive MFA entitlement enabled.

 
posthttps://example.com/UserMgmt/AnalyzeAdaptiveMfaRisk
curl --request POST \
  --url https://example.com/UserMgmt/AnalyzeAdaptiveMfaRisk
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/UserMgmt/AnalyzeAdaptiveMfaRisk' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/UserMgmt/AnalyzeAdaptiveMfaRisk")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/UserMgmt/AnalyzeAdaptiveMfaRisk");

xhr.send(data);
import requests

url = "https://example.com/UserMgmt/AnalyzeAdaptiveMfaRisk"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

Risk level returned by the risk check, 'SystemUnavailable' indicates an error of some kind.

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Check to see if a user can edit attributes.

 
posthttps://example.com/UserMgmt/CanEditUserAttributes
curl --request POST \
  --url https://example.com/UserMgmt/CanEditUserAttributes
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/UserMgmt/CanEditUserAttributes' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/UserMgmt/CanEditUserAttributes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/UserMgmt/CanEditUserAttributes");

xhr.send(data);
import requests

url = "https://example.com/UserMgmt/CanEditUserAttributes"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

ID
string

User UUID or name to check (default=current user)

directoryServiceUuid
string

Directory service UUID of the user (default=null)

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

Standard result

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Update user attributes

 
posthttps://example.com/UserMgmt/ChangeUserAttributes
curl --request POST \
  --url https://example.com/UserMgmt/ChangeUserAttributes
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/UserMgmt/ChangeUserAttributes' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/UserMgmt/ChangeUserAttributes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/UserMgmt/ChangeUserAttributes");

xhr.send(data);
import requests

url = "https://example.com/UserMgmt/ChangeUserAttributes"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

CmaRedirectedUserUuid
string

Reidrected user uuid

ID
string
required

User UUID or name to set redirection for

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

Standard result

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Change the password for the current user.

 
posthttps://example.com/UserMgmt/ChangeUserPassword
curl --request POST \
  --url https://example.com/UserMgmt/ChangeUserPassword
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/UserMgmt/ChangeUserPassword' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/UserMgmt/ChangeUserPassword")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/UserMgmt/ChangeUserPassword");

xhr.send(data);
import requests

url = "https://example.com/UserMgmt/ChangeUserPassword"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

oldPassword
string
required

Current password

newPassword
string
required

New password

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

Standard result

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Query all directory services for users, groups, and/or roles using a json query string.

Either a 'user', a 'group', or a 'role' query must be specified. If no directoryServices are specified, all available
directory services will be searched.

 
posthttps://example.com/UserMgmt/DirectoryServiceQuery
curl --request POST \
  --url https://example.com/UserMgmt/DirectoryServiceQuery
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/UserMgmt/DirectoryServiceQuery' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/UserMgmt/DirectoryServiceQuery")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/UserMgmt/DirectoryServiceQuery");

xhr.send(data);
import requests

url = "https://example.com/UserMgmt/DirectoryServiceQuery"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

roles
string

Json query for the roles table

group
string

Json query for the dsgroups table

directoryServices
array of objects

string list of diretory service uuids to limit search to

user
string

Json query for the dsusers table

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

Query results

Result.Exceptionsobject

Any exceptions that occurred

Result.Exceptions.Rolesobject

Exception for role query

Result.Exceptions.Groupobject

Exception for group query

Result.Exceptions.Userobject

Exception for user query

Result.Rolesobject

Query results for role query

Result.Groupobject

Query results for group query

Result.Userobject

Query results for user query

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Get security questions for the current user

Specified user must be you or you must have user management permissions.

 
posthttps://example.com/UserMgmt/GetSecurityQuestions
curl --request POST \
  --url https://example.com/UserMgmt/GetSecurityQuestions
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/UserMgmt/GetSecurityQuestions' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/UserMgmt/GetSecurityQuestions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/UserMgmt/GetSecurityQuestions");

xhr.send(data);
import requests

url = "https://example.com/UserMgmt/GetSecurityQuestions"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

addAdminQuestions
boolean

Add list of available administrator questions in response

Id
string

User UUID or name to get security questions for

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

DataEntity with user security questions data

Result.AnswerMinLengthinteger

Minimum length in characters of answers

Result.Questionsarray

Security questions for user; list of entities with following properties.

Result.MaxQuestionsinteger

Max questions allowed for user

Result.MinAdminQuestionsinteger

Minimum admin questions required for user

Result.AdminQuestionsarray

Available administrator questions; list of entities with following properties.

Result.MinUserQuestionsinteger

Minimum user questions required for user

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Fetch attributes for a specified user.

Attributes will vary depending on the type of the directory service the user belongs to.

 
posthttps://example.com/UserMgmt/GetUserAttributes
curl --request POST \
  --url https://example.com/UserMgmt/GetUserAttributes
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/UserMgmt/GetUserAttributes' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/UserMgmt/GetUserAttributes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/UserMgmt/GetUserAttributes");

xhr.send(data);
import requests

url = "https://example.com/UserMgmt/GetUserAttributes"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

ID
string

User UUID to fetch attributes for (default=current user)

directoryServiceUuid
string

Directory service UUID of the user (default=null)

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

User Attributes results

Result.propertynobject

nth property of the user (name varies)

Result.property2object

Second property of the user (name varies)

Result.directoryServiceUuidstring

UUID of the directory service the user is from

Result....object

More properties (name varies)

Result.property1object

First property of the user (name varies)

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Fetch the reporting hierarchy for a specified user.

Attributes will vary depending on the type of the directory service the user belongs to.

 
posthttps://example.com/UserMgmt/GetUserHierarchy
curl --request POST \
  --url https://example.com/UserMgmt/GetUserHierarchy
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/UserMgmt/GetUserHierarchy' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/UserMgmt/GetUserHierarchy")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/UserMgmt/GetUserHierarchy");

xhr.send(data);
import requests

url = "https://example.com/UserMgmt/GetUserHierarchy"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

ID
string

User UUID to fetch hierarchy for (default=current user)

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

User Attributes results

Result.propertynobject

nth property of the user (name varies)

Result.property2object

Second property of the user (name varies)

Result.directoryServiceUuidstring

UUID of the directory service the user is from

Result....object

More properties (name varies)

Result.property1object

First property of the user (name varies)

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Get additional info for a specified user.

Specified user must be you or you must be a system administrator or have user management permissions. Note that this call is somewhat costly and its use should be minimized (cache the results as needed).

 
posthttps://example.com/UserMgmt/GetUserInfo
curl --request POST \
  --url https://example.com/UserMgmt/GetUserInfo
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/UserMgmt/GetUserInfo' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/UserMgmt/GetUserInfo")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/UserMgmt/GetUserInfo");

xhr.send(data);
import requests

url = "https://example.com/UserMgmt/GetUserInfo"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

ID
string

User UUID to fetch attributes for (default=current user)

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

User additional information

Result.IsSysAdminboolean

Is user a system administrator

Result.TenantIdstring

Tenant id of the user

Result.DirectoryServiceIdstring

Directory service UUID

Result.PasswordExpDatestring

Date/time user's password will expire

Result.DisplayNamestring

User display name

Result.DirectoryServiceNamestring

Directory service name

Result.Idstring

User UUID

Result.DisplayPreferredCulturestring

User's preferred culture if any in display format (e.g. French - français)

Result.DirectoryServiceTypestring

Directory service type

Result.MobileNumberstring

User mobile phone number

Result.HasPictureboolean

User has a picture available

Result.SqEnabledboolean

Are security questions enabled for this user

Result.PreferredCulturestring

User's preferred culture if any in culture code format (e.g. fr)

Result.Settingsobject

Contains internal state for the Portal Web UI; this property can be ignored.

Result.SecurityQuestionstring

Does user have security questions? 'yes' if so, null if not

Result.EmailAddressstring

User email address

Result.CanChangePasswordboolean

Can user change their password

Result.DirectoryServiceLocalizedNamestring

Directory service name localized to user's preferred language

Result.PasswordChangeHardHoursinteger

Hours before a user should be prompted to change an near to expiring password

Result.PasswordChangeSoftDaysinteger

Days before a user should be warned to change a near to expiring password

Result.PasswordResetFlaginteger

Password reset state: 0=no reset needed, 1=Reset required, 2=Reset optional, 3=Reset warning

Result.Namestring

User name

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Fetch a cloud user's picture.

Specified user must be you or you must be a system administrator or have user management permissions.

 
posthttps://example.com/UserMgmt/GetUserPicture
curl --request POST \
  --url 'https://example.com/UserMgmt/GetUserPicture?ID=ID'
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/UserMgmt/GetUserPicture',
  qs: { ID: 'ID' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/UserMgmt/GetUserPicture?ID=ID")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/UserMgmt/GetUserPicture?ID=ID");

xhr.send(data);
import requests

url = "https://example.com/UserMgmt/GetUserPicture"

querystring = {"ID":"ID"}

response = requests.request("POST", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

ID
string
required

User UUID or name to fetch picture for

directoryServiceUuid
string

UUID of the user's directory service (default=null)

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

User's picture file if one is available

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Get list of all of a user's roles and associated administrative rights associated with a role.

 
posthttps://example.com/UserMgmt/GetUsersRolesAndAdministrativeRights
curl --request POST \
  --url 'https://example.com/UserMgmt/GetUsersRolesAndAdministrativeRights?id=id'
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/UserMgmt/GetUsersRolesAndAdministrativeRights',
  qs: { id: 'id' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/UserMgmt/GetUsersRolesAndAdministrativeRights?id=id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/UserMgmt/GetUsersRolesAndAdministrativeRights?id=id");

xhr.send(data);
import requests

url = "https://example.com/UserMgmt/GetUsersRolesAndAdministrativeRights"

querystring = {"id":"id"}

response = requests.request("POST", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

id
string
required

UUID of User

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject
         Standard Redrock data format, with the following columns:
             ID : The role UUID
             Name: The role name
             Description: The role description
             AdministrativeRights : List of objects that have
               Description: localized name of the administrative right
               Path: file that describes the administrative right

             ** Obsolete columns - Exist for backward compatibility **
             Role : The role UUID
             RoleName: The role name
Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Invite one or more users to the cloud portal.

You must be a system administrator or have user management permissions.

 
posthttps://example.com/UserMgmt/InviteUsers
curl --request POST \
  --url https://example.com/UserMgmt/InviteUsers
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/UserMgmt/InviteUsers' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/UserMgmt/InviteUsers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/UserMgmt/InviteUsers");

xhr.send(data);
import requests

url = "https://example.com/UserMgmt/InviteUsers"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

SmsInvite
boolean

Send SMS invitations to invited entities if possible (default=false)

Entities
array of objects

Users or groups to invite; each entry is a dictionary including 'Type' (User, Group, Role), 'Guid' (entity UUID), and 'Name' (entity name, only applicable to User entities)

Role
string

Add each invited user to this role name if specified (default=null)

GroupInvite
boolean

For invited groups, send a single email invitation to the group rather than to each user within the group (default=true)

EmailInvite
boolean

Send email invitations to invited entities if possible (default=true)

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

Standard result

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Determine if the current user can (or cannot...) satisfy the requisite MFA challenges.

 
posthttps://example.com/UserMgmt/IsUserLockedOutByPolicy
curl --request POST \
  --url 'https://example.com/UserMgmt/IsUserLockedOutByPolicy?user=user'
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/UserMgmt/IsUserLockedOutByPolicy',
  qs: { user: 'user' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/UserMgmt/IsUserLockedOutByPolicy?user=user")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/UserMgmt/IsUserLockedOutByPolicy?user=user");

xhr.send(data);
import requests

url = "https://example.com/UserMgmt/IsUserLockedOutByPolicy"

querystring = {"user":"user"}

response = requests.request("POST", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

user
string
required

The name or uuid of the user to test. Pass an empty string to test the
currently logged-in user. Note that only administrative users can test other users.

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

True if the user is locked out (i.e. cannot answer MFA challenges), false otherwise.

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Remove a user from the cloud.

You must be a system administrator or have user management permissions. Will delete cloud users. Users for other directory services are only removed from the cloud.
This API will fail if the id specified is the current user.

 
posthttps://example.com/UserMgmt/RemoveUser
curl --request POST \
  --url 'https://example.com/UserMgmt/RemoveUser?ID=ID'
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/UserMgmt/RemoveUser',
  qs: { ID: 'ID' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/UserMgmt/RemoveUser?ID=ID")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/UserMgmt/RemoveUser?ID=ID");

xhr.send(data);
import requests

url = "https://example.com/UserMgmt/RemoveUser"

querystring = {"ID":"ID"}

response = requests.request("POST", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

ID
string
required

The name or UUID of the user to remove.

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

Standard result

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Remove one or more users.

You must be a system administrator or have user management permissions. Will delete cloud users. Users for other directory services are only removed from the cloud.
This API will fail if any of the ids specified are the current user.

 
posthttps://example.com/UserMgmt/RemoveUsers
curl --request POST \
  --url https://example.com/UserMgmt/RemoveUsers
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/UserMgmt/RemoveUsers' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/UserMgmt/RemoveUsers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/UserMgmt/RemoveUsers");

xhr.send(data);
import requests

url = "https://example.com/UserMgmt/RemoveUsers"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

Users
array of strings
required

List of user UUIDs to send invitations to

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

Standard result

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Resets (clears) security questions for a user.

Specified user must be you or you must have user management permissions.

 
posthttps://example.com/UserMgmt/ResetSecurityQuestions
curl --request POST \
  --url https://example.com/UserMgmt/ResetSecurityQuestions
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/UserMgmt/ResetSecurityQuestions' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/UserMgmt/ResetSecurityQuestions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/UserMgmt/ResetSecurityQuestions");

xhr.send(data);
import requests

url = "https://example.com/UserMgmt/ResetSecurityQuestions"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

Id
string

User UUID or name to reset security questions for

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

Standard result

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Reset the password for a specified user.

Specified user must be you or you must be a system administrator or have user management permissions.

 
posthttps://example.com/UserMgmt/ResetUserPassword
curl --request POST \
  --url https://example.com/UserMgmt/ResetUserPassword
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/UserMgmt/ResetUserPassword' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/UserMgmt/ResetUserPassword")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/UserMgmt/ResetUserPassword");

xhr.send(data);
import requests

url = "https://example.com/UserMgmt/ResetUserPassword"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

ID
string
required

User UUID or name to set password for

newPassword
string
required

New password

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

Standard result

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Send email invitation to a specified user.

You must be a system administrator.

 
posthttps://example.com/UserMgmt/SendLoginEmail
curl --request POST \
  --url 'https://example.com/UserMgmt/SendLoginEmail?ID=ID'
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/UserMgmt/SendLoginEmail',
  qs: { ID: 'ID' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/UserMgmt/SendLoginEmail?ID=ID")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/UserMgmt/SendLoginEmail?ID=ID");

xhr.send(data);
import requests

url = "https://example.com/UserMgmt/SendLoginEmail"

querystring = {"ID":"ID"}

response = requests.request("POST", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

ID
string
required

User UUID to send invitation to

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

Standard result

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Send invitation emails to one or more users.

You must be a system administrator.

 
posthttps://example.com/UserMgmt/SendLoginEmails
curl --request POST \
  --url https://example.com/UserMgmt/SendLoginEmails
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/UserMgmt/SendLoginEmails' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/UserMgmt/SendLoginEmails")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/UserMgmt/SendLoginEmails");

xhr.send(data);
import requests

url = "https://example.com/UserMgmt/SendLoginEmails"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

ID
array of strings
required

List of user UUIDs to send invitations to

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

Standard result

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Send SMS invitation to a specified user.

You must be a system administrator or have user management permissions.

 
posthttps://example.com/UserMgmt/SendSmsInvite
curl --request POST \
  --url 'https://example.com/UserMgmt/SendSmsInvite?ID=ID'
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/UserMgmt/SendSmsInvite',
  qs: { ID: 'ID' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/UserMgmt/SendSmsInvite?ID=ID")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/UserMgmt/SendSmsInvite?ID=ID");

xhr.send(data);
import requests

url = "https://example.com/UserMgmt/SendSmsInvite"

querystring = {"ID":"ID"}

response = requests.request("POST", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

ID
string
required

User UUID to send invitation to

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

Standard result

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Set the phone pin for a user.

 
posthttps://example.com/UserMgmt/SetPhonePin
curl --request POST \
  --url https://example.com/UserMgmt/SetPhonePin
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/UserMgmt/SetPhonePin' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/UserMgmt/SetPhonePin")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/UserMgmt/SetPhonePin");

xhr.send(data);
import requests

url = "https://example.com/UserMgmt/SetPhonePin"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

ID
string
required

User UUID or name to set security question for

phonepin
string
required

Phone pin

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

Standard result

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Updates security questions for a user.

 
posthttps://example.com/UserMgmt/UpdateSecurityQuestions
curl --request POST \
  --url https://example.com/UserMgmt/UpdateSecurityQuestions
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/UserMgmt/UpdateSecurityQuestions' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/UserMgmt/UpdateSecurityQuestions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/UserMgmt/UpdateSecurityQuestions");

xhr.send(data);
import requests

url = "https://example.com/UserMgmt/UpdateSecurityQuestions"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

Added
array of objects

List of entities specifying questions to add. Each question entity has the following properties: 'Uuid' (string, uuid of admin question) -OR- 'QuestionText' (string, text of user question), 'Answer' (string, text of answer)

Id
string

User UUID or name to update security questions for

Deleted
array of objects

List of Uuids of questions to delete

Replace
boolean

Replace all existing questions with this update.

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

Standard result

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Updates various user preferences for the currently logged in user.

 
posthttps://example.com/UserMgmt/UpdateUserPreferences
curl --request POST \
  --url https://example.com/UserMgmt/UpdateUserPreferences
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/UserMgmt/UpdateUserPreferences' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/UserMgmt/UpdateUserPreferences")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/UserMgmt/UpdateUserPreferences");

xhr.send(data);
import requests

url = "https://example.com/UserMgmt/UpdateUserPreferences"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

PreferredCulture
string

Centrify supported culture code. Use Core/GetSupportedCultures for a list. Set to an empty string to remove the user's preferred culture.

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

Standard result

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Core Services

 
Suggest Edits

Fetch technical support user.

You must be a system administrator or have user management permissions.

 
posthttps://example.com/CDirectoryService/GetTechSupportUser
curl --request POST \
  --url https://example.com/CDirectoryService/GetTechSupportUser
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/CDirectoryService/GetTechSupportUser' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/CDirectoryService/GetTechSupportUser")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/CDirectoryService/GetTechSupportUser");

xhr.send(data);
import requests

url = "https://example.com/CDirectoryService/GetTechSupportUser"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

Support user information

Result.Uuidstring

Support user UUID

Result.PasswordExpstring

Support user expire date

Result.Namestring

Support user name

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Grant portal access to technical support.

You must be a system administrator or have user management permissions. Support will receive portal access for the specified time period.

 
posthttps://example.com/CDirectoryService/GrantAccess
curl --request POST \
  --url https://example.com/CDirectoryService/GrantAccess
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/CDirectoryService/GrantAccess' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/CDirectoryService/GrantAccess")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/CDirectoryService/GrantAccess");

xhr.send(data);
import requests

url = "https://example.com/CDirectoryService/GrantAccess"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

SupportAccessTimeInMinute
integer

Number of minutes support user will have portal access (default=240 (4 hours), max of 30 days)

SupportEmailAddress
string

Email address of the support user (default=internal support email); an email with login info will be sent to this address.

SendEmail
boolean

Whether or not to send Auth URL in email (default=true); if false, Auth URL will be in the 'AuthUrl' response property

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

Support user information

Result.Uuidstring

Support user UUID

Result.AuthUrlstring

If 'SendEmail' in request is false, this property will contain the Auth URL that would have been in the email.

Result.PasswordExpstring

Support user expire date

Result.Namestring

Support user name

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Requests a heath check from a specific cloud connector or from all cloud connectors.

Returns a JSON package that includes health information for one or more connectors.
Each connector contains a health status from one or more regions within the connector.
There will always be a region which reports on the general health of the connector. I.e. each connector includes a 'ConnectorInfo' region which will have a 'Status'.
There may be other regions that report on the health of specific features within the connector. E.g. if the connector supports AD, there will be an 'AdInfo' section that covers AD.
When determining the overall heath of a connector, examine the 'Status' of each region. It is possible for regions to have different statuses. E.g. the 'ConnectorInfo' region may have a Status of 'Healthy' while the 'AdInfo' region has a status of 'Unhealthy'.
The list of regions returned will vary based on various factors. E.g. if the cloud cannot reach the connector, the 'ConnectorInfo' Status will be 'Unhealthy' and there will be no 'AdInfo' region.
Additional regions may be added in the future without a Version change (if they follow the format of the existing regions).
Return package breakdown:
The top level object contains a list of Connectors and a package Version
{
"Connectors": [ ... ],
"Version": "1.0"
}
Each connector in the array contains a generic 'ConnectorInfo' region and might contain additional regions like 'AdInfo' (depending upon how the connector is configured):
{
"ConnectorInfo": { ... },
"AdInfo": { ... }
...
}
The 'ConnectorInfo' region contains information that other identification data, a list of enabled features and the status of the connector itself (without considering AD):
"ConnectorInfo":
{
"Id": "31dfe79d-2c7f-4e40-9b1b-2e897f6f0ca1",
"Version": "1.0.0.0",
"MachineName": "clouddev-dev1",
"FeaturesEnabled": [ "adwatcher", "mobile.gpupdate", "mobile.stateSync" ],
"Name": "clouddev-dev1",
"Status": "Healthy"
}
All regions will contain a 'Status' ('Healthy', 'Unhealthy' or 'NotApplicable') and may contain additional fields that help explain the status:
"...Info":
{
"Status": "Unhealthy",
"Reason": "Exception",
"Exception": "The server is not operational."
}
Other regions may contain additional information appropriate to the region being queried. E.g.:
"AdInfo":
{
"Status": "Healthy",
"ForestUuid": "fbefa7535168f04cb764cf1f92d90363",
"Forest": "clouddev.test"
}
Example return package (2 connectors, the first is online, the second is not):
{
"Connectors":
[
{
"ConnectorInfo":
{
"Id": "31dfe79d-2c7f-4e40-9b1b-2e897f6f0ca1",
"Version": "1.0.0.0",
"MachineName": "clouddev-dev1",
"FeaturesEnabled": ["adwatcher", "mobile.gpupdate", "mobile.stateSync"],
"Name": "clouddev-dev1",
"Status": "Healthy"
},
"AdInfo":
{
"Status": "Healthy",
"ForestUuid": "fbefa7535168f04cb764cf1f92d90363",
"Forest": "clouddev.test"
}
},
{
"ConnectorInfo":
{
"Id": "98dff19d-23cf-ef41-91cc-2f811e6cbab2",
"Version": "1.0.0.0",
"MachineName": "clouddev-dev2",
"FeaturesEnabled": ["adwatcher", "mobile.gpupdate", "mobile.stateSync"],
"Name": "clouddev-dev2",
"Status": "Unhealthy",
"Exception": "Remote side of connection is not available",
"Reason": "Health check failed"
},
}
],
"Version": "1.0"
}

 
posthttps://example.com/Core/CheckProxyHealth
curl --request POST \
  --url https://example.com/Core/CheckProxyHealth
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/Core/CheckProxyHealth' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/Core/CheckProxyHealth")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/Core/CheckProxyHealth");

xhr.send(data);
import requests

url = "https://example.com/Core/CheckProxyHealth"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

proxyUuid
string

The ID of the cloud connector to check. Omit or leave blank to request a health check from all cloud connectors.

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

A package that includes a list of objects detailing the health statuses of one or more cloud connectors.

Result.Connectorsarray

Array of Cloud Connectors. See notes for a breakdown of this package

Result.Versionstring

Version of the health check package. Will change if the format of this package changes

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Check for the existence of a directory.

 
posthttps://example.com/Core/DirectoryExists
curl --request POST \
  --url 'https://example.com/Core/DirectoryExists?path=path'
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/Core/DirectoryExists',
  qs: { path: 'path' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/Core/DirectoryExists?path=path")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/Core/DirectoryExists?path=path");

xhr.send(data);
import requests

url = "https://example.com/Core/DirectoryExists"

querystring = {"path":"path"}

response = requests.request("POST", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

path
string
required

The path of the directory to check

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

A boolean value indicating whether the directory exists or not.

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Download the contents of a file

 
posthttps://example.com/Core/DownloadFile
curl --request POST \
  --url 'https://example.com/Core/DownloadFile?path=path'
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/Core/DownloadFile',
  qs: { path: 'path' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/Core/DownloadFile?path=path")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/Core/DownloadFile?path=path");

xhr.send(data);
import requests

url = "https://example.com/Core/DownloadFile"

querystring = {"path":"path"}

response = requests.request("POST", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

path
string
required

The path of the file to read

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

The contents of the file as text.

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Check for the existence of a file.

 
posthttps://example.com/Core/FileExists
curl --request POST \
  --url 'https://example.com/Core/FileExists?path=path'
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/Core/FileExists',
  qs: { path: 'path' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/Core/FileExists?path=path")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/Core/FileExists?path=path");

xhr.send(data);
import requests

url = "https://example.com/Core/FileExists"

querystring = {"path":"path"}

response = requests.request("POST", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

path
string
required

The path of the file to check

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

A boolean value indicating whether the file exists or not.

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

List the directory contents of a directory.

The resulting list of subdirectories include the full path to each directory.

 
posthttps://example.com/Core/GetDirectories
curl --request POST \
  --url 'https://example.com/Core/GetDirectories?path=path'
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/Core/GetDirectories',
  qs: { path: 'path' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/Core/GetDirectories?path=path")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/Core/GetDirectories?path=path");

xhr.send(data);
import requests

url = "https://example.com/Core/GetDirectories"

querystring = {"path":"path"}

response = requests.request("POST", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

path
string
required

The path of the directory to list

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

A list of sub directories

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Get metadata and information about a file, as well as the file contents.

 
posthttps://example.com/Core/GetFileInfo
curl --request POST \
  --url 'https://example.com/Core/GetFileInfo?path=path'
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/Core/GetFileInfo',
  qs: { path: 'path' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/Core/GetFileInfo?path=path")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/Core/GetFileInfo?path=path");

xhr.send(data);
import requests

url = "https://example.com/Core/GetFileInfo"

querystring = {"path":"path"}

response = requests.request("POST", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

path
string
required

The path of the file to read

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

File information and metadata object

Result.Typestring

The resource type, always 'file'

Result.Pathstring

Full path to the file

Result.Contentstring

The contents of the file as text

Result.Permsstring

The caller's permissions on the file

Result.Namestring

File name without the path

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Retrieves a list of product licenses for this tenant, from Salesforce.

List of product licenses, by group and with counts.

 
posthttps://example.com/Core/GetPurchasedLicenses
curl --request POST \
  --url https://example.com/Core/GetPurchasedLicenses
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/Core/GetPurchasedLicenses' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/Core/GetPurchasedLicenses")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/Core/GetPurchasedLicenses");

xhr.send(data);
import requests

url = "https://example.com/Core/GetPurchasedLicenses"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

List of product licenses.
{
"type": "object",
"description": "Collections of license objects.",
"properties":
{
"Name" : { "description: "Product name, e.g. App Service Access", "type": "string" },
"Group" : { "description: "Product Category, e.g. App Services", "type": "string" },
"licensed": { "description: "Count of purchased licenses", "type": "numeric" },
"info": { "description: "Optional description or web page of product.", "type": "string" }
}
}

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Get supported cultures, returning their code and native name.

 
posthttps://example.com/Core/GetSupportedCultures
curl --request POST \
  --url https://example.com/Core/GetSupportedCultures
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/Core/GetSupportedCultures' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/Core/GetSupportedCultures")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/Core/GetSupportedCultures");

xhr.send(data);
import requests

url = "https://example.com/Core/GetSupportedCultures"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

Culture map, code to native name, multiple entries.

Result.native namestring

Culture native name

Result.codestring

Culture code value

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Returns a file name that is unique in the directory.

If there is a collision, integers will be added. Example:

        path "~/"
        name "MyFile.txt"
        If MyFile.txt already exists in ~/, this endpoint will return MyFile (1).txt, 
        assuming MyFile (1).txt also doesn't exist.
 
posthttps://example.com/Core/GetUniqueFileName
curl --request POST \
  --url 'https://example.com/Core/GetUniqueFileName?path=path&name=name'
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/Core/GetUniqueFileName',
  qs: 
   { path: 'path',
     name: 'name' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/Core/GetUniqueFileName?path=path&name=name")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/Core/GetUniqueFileName?path=path&name=name");

xhr.send(data);
import requests

url = "https://example.com/Core/GetUniqueFileName"

querystring = {"path":"path","name":"name"}

response = requests.request("POST", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

path
string
required

The path to check for a unique file name

name
string
required

The name of the file. Should include the file extension.

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

A file name that is unique within the path. If the name parameter had a file extension, this name will too.

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

List the file contents of a directory.

 
posthttps://example.com/Core/ListDirectory
curl --request POST \
  --url 'https://example.com/Core/ListDirectory?path=path'
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/Core/ListDirectory',
  qs: { path: 'path' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/Core/ListDirectory?path=path")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/Core/ListDirectory?path=path");

xhr.send(data);
import requests

url = "https://example.com/Core/ListDirectory"

querystring = {"path":"path"}

response = requests.request("POST", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

path
string
required

The path of the directory to list

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultarray

List of files

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Return given text as a file.

 
posthttps://example.com/Core/MakeFile
curl --request POST \
  --url 'https://example.com/Core/MakeFile?fileName=fileName&text=text&contentType=contentType'
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/Core/MakeFile',
  qs: 
   { fileName: 'fileName',
     text: 'text',
     contentType: 'contentType' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/Core/MakeFile?fileName=fileName&text=text&contentType=contentType")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/Core/MakeFile?fileName=fileName&text=text&contentType=contentType");

xhr.send(data);
import requests

url = "https://example.com/Core/MakeFile"

querystring = {"fileName":"fileName","text":"text","contentType":"contentType"}

response = requests.request("POST", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

fileName
string
required

The file name to be set in the content-disposition header.

text
string
required

The content of the file to return.

contentType
string
required

Optional: The contentType for the file, or text/plain if not given.

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Result

Resulting object, if any, of the call

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Read the contents of a file

 
posthttps://example.com/Core/ReadFile
curl --request POST \
  --url 'https://example.com/Core/ReadFile?path=path'
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/Core/ReadFile',
  qs: { path: 'path' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/Core/ReadFile?path=path")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/Core/ReadFile?path=path");

xhr.send(data);
import requests

url = "https://example.com/Core/ReadFile"

querystring = {"path":"path"}

response = requests.request("POST", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

path
string
required

The path of the file to read

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

The contents of the file as text.

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Write string content to a file.

 
posthttps://example.com/Core/WriteFile
curl --request POST \
  --url 'https://example.com/Core/WriteFile?path=path&text=text&content=content'
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/Core/WriteFile',
  qs: 
   { path: 'path',
     text: 'text',
     content: 'content' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/Core/WriteFile?path=path&text=text&content=content")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/Core/WriteFile?path=path&text=text&content=content");

xhr.send(data);
import requests

url = "https://example.com/Core/WriteFile"

querystring = {"path":"path","text":"text","content":"content"}

response = requests.request("POST", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

path
string
required

The path of the file to write to

text
string
required

The content of the file to write

content
string
required

The content type (MIME) of the file

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

Success only if file write succeeds.

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Gets the value of an extended column.

 
posthttps://example.com/ExtData/GetColumn
curl --request POST \
  --url https://example.com/ExtData/GetColumn
var request = require("request");

var options = { method: 'POST', url: 'https://example.com/ExtData/GetColumn' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/ExtData/GetColumn")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/ExtData/GetColumn");

xhr.send(data);
import requests

url = "https://example.com/ExtData/GetColumn"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

ID
string

ID of the row to set

Column
string

Name of the column

Table
string

Name of the table to modify

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

The value strongly typed as the type of the column

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Gets the value of all extended columns for a row.

 
posthttps://example.com/ExtData/GetColumns
curl --request POST \
  --url https://example.com/ExtData/GetColumns
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/ExtData/GetColumns' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/ExtData/GetColumns")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/ExtData/GetColumns");

xhr.send(data);
import requests

url = "https://example.com/ExtData/GetColumns"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

ID
string

ID of the row to set

Table
string

Name of the table to modify

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

The values of the extended columns as an object

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Sets value of an extended column. The value can either be a string, date, bool, double or integer It must match the column definition To clear a value set it to null

 
posthttps://example.com/ExtData/SetColumn
curl --request POST \
  --url https://example.com/ExtData/SetColumn
var request = require("request");

var options = { method: 'POST', url: 'https://example.com/ExtData/SetColumn' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/ExtData/SetColumn")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/ExtData/SetColumn");

xhr.send(data);
import requests

url = "https://example.com/ExtData/SetColumn"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

ID
string

ID of the row to set

Value
string

Value of the column

Column
string

Name of the column

Table
string

Name of the table to modify

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Result

Resulting object, if any, of the call

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Get all radius clients.

You must be a system administrator or have radius administrator permissions.

 
posthttps://example.com/Radius/GetClients
curl --request POST \
  --url https://example.com/Radius/GetClients
var request = require("request");

var options = { method: 'POST', url: 'https://example.com/Radius/GetClients' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/Radius/GetClients")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/Radius/GetClients");

xhr.send(data);
import requests

url = "https://example.com/Radius/GetClients"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

List of radius clients; each user contains the following properties.

Result.ClientAddressstring

Client IP address

Result.ClientCulturestring

Client culture

Result.ClientNamestring

Client name

Result.ClientDescriptionstring

Client description

Result.ClientSecretstring

Client secret

Result.ClientAllowNewLinesInPromptsboolean

Allow embedded new-line characters when sending prompt to the client

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Fetch Radius config for a specified connector

You must be a system administrator or have radius administrator permissions. Will return null if
connector has no radius config.

 
posthttps://example.com/Radius/GetConfig
curl --request POST \
  --url 'https://example.com/Radius/GetConfig?connectorUuid=connectorUuid'
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/Radius/GetConfig',
  qs: { connectorUuid: 'connectorUuid' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/Radius/GetConfig?connectorUuid=connectorUuid")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/Radius/GetConfig?connectorUuid=connectorUuid");

xhr.send(data);
import requests

url = "https://example.com/Radius/GetConfig"

querystring = {"connectorUuid":"connectorUuid"}

response = requests.request("POST", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

connectorUuid
string
required

Connector UUID to fetch radius config for

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

Radius connector config information

Result.Portinteger

Listen port

Result.ReceiveTimeoutinteger

receive timeout in millseconds

Result.Enabledboolean

Is radius enabled

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Get the list of RADIUS servers

 
posthttps://example.com/Radius/GetServers
curl --request POST \
  --url https://example.com/Radius/GetServers
var request = require("request");

var options = { method: 'POST', url: 'https://example.com/Radius/GetServers' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/Radius/GetServers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/Radius/GetServers");

xhr.send(data);
import requests

url = "https://example.com/Radius/GetServers"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Result

Resulting object, if any, of the call

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Remove one or more radius clients if they exist.

You must be a system administrator or have radius administrator permissions.

 
posthttps://example.com/Radius/RemoveClients
curl --request POST \
  --url https://example.com/Radius/RemoveClients
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/Radius/RemoveClients' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/Radius/RemoveClients")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/Radius/RemoveClients");

xhr.send(data);
import requests

url = "https://example.com/Radius/RemoveClients"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

clients
array of objects

List of client addresses to delete

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

Remove clients result

Result.RemovedClientsarray

List of removed clients

Result.Removedinteger

Total clients removed

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Add or update a radius client.

You must be a system administrator or have radius administrator permissions. When updating an existing client,
any properties not provided in the body will retain the existing values. ClientSecret and ClientName are
required on all new clients.

 
posthttps://example.com/Radius/SetClient
curl --request POST \
  --url https://example.com/Radius/SetClient
var request = require("request");

var options = { method: 'POST', url: 'https://example.com/Radius/SetClient' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/Radius/SetClient")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/Radius/SetClient");

xhr.send(data);
import requests

url = "https://example.com/Radius/SetClient"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

ClientAddress
string

Client IP address

ClientCulture
string

Client culture

ClientName
string

Client name

ClientDescription
string

Client description

ClientSecret
string

Client secret

ClientAllowNewLinesInPrompts
boolean

Allow embedded new-line characters when sending prompts to the client

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

Standard result

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Change radius config for a connector.

You must be a system administrator or have radius administrator permissions.

 
posthttps://example.com/Radius/SetConfig
curl --request POST \
  --url https://example.com/Radius/SetConfig
var request = require("request");

var options = { method: 'POST', url: 'https://example.com/Radius/SetConfig' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/Radius/SetConfig")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/Radius/SetConfig");

xhr.send(data);
import requests

url = "https://example.com/Radius/SetConfig"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

Port
integer

Radius listen port

ReceiveTimeout
integer

Radius receive timeout in milliseconds (default=1000)

connectorUuid
string

Connector uuid to set config for

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

Standard result

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Stop impersonating a target user's identity.

When called using an impersonation token, the calling context is reverted to the original
callers identity. If the original session has expired or been invalidated, the calling user will
be logged out.

 
posthttps://example.com/Security/FinishImpersonate
curl --request POST \
  --url https://example.com/Security/FinishImpersonate
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/Security/FinishImpersonate' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/Security/FinishImpersonate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/Security/FinishImpersonate");

xhr.send(data);
import requests

url = "https://example.com/Security/FinishImpersonate"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Result

Resulting object, if any, of the call

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Begin the process of recovering a lost or forgotten user name.

The request must be made using a tenant-specific URL.

 
posthttps://example.com/Security/ForgotUsername
curl --request POST \
  --url https://example.com/Security/ForgotUsername
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/Security/ForgotUsername' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/Security/ForgotUsername")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/Security/ForgotUsername");

xhr.send(data);
import requests

url = "https://example.com/Security/ForgotUsername"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

SearchKey
string
required

Email address of the user to search for.

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Result

Resulting object, if any, of the call

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Begin impersonating a target user's identity.

The caller must have the ImpersonateUser right. Either uuid or username of the target user can be used, but at least one must be specified.
A successful call results in the current session's identity cookie being replaced
with that of the target user. An impersonated identity cookie can only be used on API calls specifically denoted as callable in this manner,
and only when the originator of the cookie (the impersonator) has appropriate permission to that call as well. For instance, the
"Run queries as another user" privilege, when added to a role, allows users within that role to call the /redrock/query API using an
impersonated identity.

 
posthttps://example.com/Security/StartImpersonate
curl --request POST \
  --url https://example.com/Security/StartImpersonate
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/Security/StartImpersonate' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/Security/StartImpersonate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/Security/StartImpersonate");

xhr.send(data);
import requests

url = "https://example.com/Security/StartImpersonate"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

uuid
string

Uuid of the user to impersonate

username
string

Username of the user to impersonate

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Result

Resulting object, if any, of the call

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

List the cnames assigned for the tenant.

 
posthttps://example.com/TenantCnames/Get
curl --request POST \
  --url https://example.com/TenantCnames/Get
var request = require("request");

var options = { method: 'POST', url: 'https://example.com/TenantCnames/Get' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/TenantCnames/Get")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/TenantCnames/Get");

xhr.send(data);
import requests

url = "https://example.com/TenantCnames/Get"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

Resulting set contains Cname and type of Cname. Cname type can be one of following - System, Preferred, Other

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Gets the domain of tenant urls

 
posthttps://example.com/TenantCnames/GetDomainInfo
curl --request POST \
  --url https://example.com/TenantCnames/GetDomainInfo
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/TenantCnames/GetDomainInfo' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/TenantCnames/GetDomainInfo")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/TenantCnames/GetDomainInfo");

xhr.send(data);
import requests

url = "https://example.com/TenantCnames/GetDomainInfo"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

Resulting set contains the domain of the tenant url

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Creates a cname with prefix specified for the tenant. If the cname is the only user created, it is set as preferred cname.

 
posthttps://example.com/TenantCnames/Register
curl --request POST \
  --url 'https://example.com/TenantCnames/Register?cnamePrefix=cnamePrefix'
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/TenantCnames/Register',
  qs: { cnamePrefix: 'cnamePrefix' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/TenantCnames/Register?cnamePrefix=cnamePrefix")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/TenantCnames/Register?cnamePrefix=cnamePrefix");

xhr.send(data);
import requests

url = "https://example.com/TenantCnames/Register"

querystring = {"cnamePrefix":"cnamePrefix"}

response = requests.request("POST", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

cnamePrefix
string
required

Prefix of cname to create

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

Fully qualified cname

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Deletes a single key record from the config table.

 
posthttps://example.com/TenantConfig/DeleteAdvancedConfig
curl --request POST \
  --url https://example.com/TenantConfig/DeleteAdvancedConfig
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/TenantConfig/DeleteAdvancedConfig' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/TenantConfig/DeleteAdvancedConfig")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/TenantConfig/DeleteAdvancedConfig");

xhr.send(data);
import requests

url = "https://example.com/TenantConfig/DeleteAdvancedConfig"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

tenantId
string
required

Tenant ID, aka _PartitionKey

key

Record Key

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Result

Resulting object, if any, of the call

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Returns tenant's configuration values.

Retrieves the full configuration list for Opie... the combined set of "centrify" config table rows
and "blessed tenant" rows from config table, so that they can be presented in a UI.

 
posthttps://example.com/TenantConfig/GetAdvancedConfig
curl --request POST \
  --url https://example.com/TenantConfig/GetAdvancedConfig
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/TenantConfig/GetAdvancedConfig' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/TenantConfig/GetAdvancedConfig")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/TenantConfig/GetAdvancedConfig");

xhr.send(data);
import requests

url = "https://example.com/TenantConfig/GetAdvancedConfig"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject
          List of config table values verbatim...
          {
            description: "Admin Security Question",
            properties: 
            {
              _PartitionKey: { description: "Tenant ID", type: "string" },
              ID: { "description": "Config value key", type: "string" }
              Value: { "description": "Configuration setting", type: "string" }
            }
          }
Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Resource Management

 
Suggest Edits

Get list of permissions associated with a collection

 
posthttps://example.com/Collection/GetCollectionPermissions
curl --request POST \
  --url https://example.com/Collection/GetCollectionPermissions
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/Collection/GetCollectionPermissions' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/Collection/GetCollectionPermissions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/Collection/GetCollectionPermissions");

xhr.send(data);
import requests

url = "https://example.com/Collection/GetCollectionPermissions"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

ID
string

ID of the collection, set to null to get global permissions

Response

API-Result

ErrorIDstring

Unique support identifier for this occurrence of an error

Resultobject

List of permissions

Result.Rightsstring

list of permissions

Result.Principalstring

User name or role name

Result.PrincipalIdstring

Uuid of the principal

Result.PTypestring

Principal type: User, Role,..

Messagestring

Error message text on failure, may be null

successboolean

Indicates API success or failure

Suggest Edits

Grant permissions on a collection

You must be a system administrator or have 'Grant' permission on the collection or have global 'Grant' permission on collections.

 
posthttps://example.com/Collection/SetCollectionPermissions
curl --request POST \
  --url https://example.com/Collection/SetCollectionPermissions
var request = require("request");

var options = { method: 'POST',
  url: 'https://example.com/Collection/SetCollectionPermissions' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://example.com/Collection/SetCollectionPermissions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com/Collection/SetCollectionPermissions");

xhr.send(data);
import requests

url = "https://example.com/Collection/SetCollectionPermissions"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

ID
string

ID of the collection, Set to null for global permissions

Grants
object

Array of permissions to be set. Each item must include Principal: User name or role name, PType: User, Role.., Rights: Grant, Edit..

 
Grants.Rights
string

Permissions: Edit, Delete, Grant

Grants.Principal
string

User name or role name