Ping Identity logo
API docs by Redocly

PingOne Advanced Identity Cloud API

Download OpenAPI specification:Download

Introduction

The PingOne Advanced Identity Cloud REST API lets you manage your Advanced Identity Cloud tenants. The API exposes access management and identity management endpoints, with additional endpoints specific to Advanced Identity Cloud tenant environments.

We are now publishing the API spec in OpenAPI 3.0. For the legacy Swagger 2.0 spec, please download swagger.yaml, but note that it may not contain all new functionality.

For full PingOne Advanced Identity Cloud documentation, please visit the docs website.

Authenticating to the API

The PingOne Advanced Identity Cloud REST API has two different authentication methods:

  • API key and secret: used for tenant read-only operations
  • Access token: used for access management operations, identity management operations or tenant write operations

For a summary of how to use these authentication methods, refer to Authenticate to Advanced Identity Cloud REST API.

Admins - Notifications v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
teammemberId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Notifications _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
teammemberId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
teammemberId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
teammemberId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
teammemberId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Notifications _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
teammemberId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
teammemberId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
teammemberId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
teammemberId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Notifications _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Admins v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_id
string

User ID

object (Metadata)

Metadata for managed/teammembermeta

Array of objects (Notifications)

Notifications

accountStatus
string (Status)

Status

aliasList
Array of strings (Admin Alias Names List)

List of identity aliases used to record federated IdP subjects for this admin

cn
string

Common Name

country
string (Country)

Country

givenName
required
string (First Name)

First Name

groups
Array of strings (Groups)

Groups

inviteDate
required
string (Date Invited)

Date Invited

jurisdiction
string (Jurisdiction)

Jurisdiction

mail
required
string (Email Address)

Email Address

onboardDate
string (Date Onboarded)

Date Onboarded

password
string (Password)

Password

sn
required
string (Last Name)

Last Name

userName
required
string (Username) non-empty

Username

Responses

Request samples

Content type
{
  • "_id": "string",
  • "_meta": {
    },
  • "_notifications": [
    ],
  • "accountStatus": "string",
  • "aliasList": [
    ],
  • "cn": "string",
  • "country": "string",
  • "givenName": "string",
  • "groups": [
    ],
  • "inviteDate": "string",
  • "jurisdiction": "string",
  • "mail": "string",
  • "onboardDate": "string",
  • "password": "string",
  • "sn": "string",
  • "userName": "string"
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_meta": {
    },
  • "_notifications": [
    ],
  • "accountStatus": "string",
  • "aliasList": [
    ],
  • "cn": "string",
  • "country": "string",
  • "givenName": "string",
  • "groups": [
    ],
  • "inviteDate": "string",
  • "jurisdiction": "string",
  • "mail": "string",
  • "onboardDate": "string",
  • "password": "string",
  • "sn": "string",
  • "userName": "string"
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Action: triggerSyncCheck

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
teammemberId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "triggerSyncCheck"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
teammemberId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_id
string

User ID

object (Metadata)

Metadata for managed/teammembermeta

Array of objects (Notifications)

Notifications

accountStatus
string (Status)

Status

aliasList
Array of strings (Admin Alias Names List)

List of identity aliases used to record federated IdP subjects for this admin

cn
string

Common Name

country
string (Country)

Country

givenName
required
string (First Name)

First Name

groups
Array of strings (Groups)

Groups

inviteDate
required
string (Date Invited)

Date Invited

jurisdiction
string (Jurisdiction)

Jurisdiction

mail
required
string (Email Address)

Email Address

onboardDate
string (Date Onboarded)

Date Onboarded

password
string (Password)

Password

sn
required
string (Last Name)

Last Name

userName
required
string (Username) non-empty

Username

Responses

Request samples

Content type
{
  • "_id": "string",
  • "_meta": {
    },
  • "_notifications": [
    ],
  • "accountStatus": "string",
  • "aliasList": [
    ],
  • "cn": "string",
  • "country": "string",
  • "givenName": "string",
  • "groups": [
    ],
  • "inviteDate": "string",
  • "jurisdiction": "string",
  • "mail": "string",
  • "onboardDate": "string",
  • "password": "string",
  • "sn": "string",
  • "userName": "string"
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_meta": {
    },
  • "_notifications": [
    ],
  • "accountStatus": "string",
  • "aliasList": [
    ],
  • "cn": "string",
  • "country": "string",
  • "givenName": "string",
  • "groups": [
    ],
  • "inviteDate": "string",
  • "jurisdiction": "string",
  • "mail": "string",
  • "onboardDate": "string",
  • "password": "string",
  • "sn": "string",
  • "userName": "string"
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
teammemberId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_meta": {
    },
  • "_notifications": [
    ],
  • "accountStatus": "string",
  • "aliasList": [
    ],
  • "cn": "string",
  • "country": "string",
  • "givenName": "string",
  • "groups": [
    ],
  • "inviteDate": "string",
  • "jurisdiction": "string",
  • "mail": "string",
  • "onboardDate": "string",
  • "password": "string",
  • "sn": "string",
  • "userName": "string"
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
teammemberId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_meta": {
    },
  • "_notifications": [
    ],
  • "accountStatus": "string",
  • "aliasList": [
    ],
  • "cn": "string",
  • "country": "string",
  • "givenName": "string",
  • "groups": [
    ],
  • "inviteDate": "string",
  • "jurisdiction": "string",
  • "mail": "string",
  • "onboardDate": "string",
  • "password": "string",
  • "sn": "string",
  • "userName": "string"
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
teammemberId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_meta": {
    },
  • "_notifications": [
    ],
  • "accountStatus": "string",
  • "aliasList": [
    ],
  • "cn": "string",
  • "country": "string",
  • "givenName": "string",
  • "groups": [
    ],
  • "inviteDate": "string",
  • "jurisdiction": "string",
  • "mail": "string",
  • "onboardDate": "string",
  • "password": "string",
  • "sn": "string",
  • "userName": "string"
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
teammemberId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_id
string

User ID

object (Metadata)

Metadata for managed/teammembermeta

Array of objects (Notifications)

Notifications

accountStatus
string (Status)

Status

aliasList
Array of strings (Admin Alias Names List)

List of identity aliases used to record federated IdP subjects for this admin

cn
string

Common Name

country
string (Country)

Country

givenName
required
string (First Name)

First Name

groups
Array of strings (Groups)

Groups

inviteDate
required
string (Date Invited)

Date Invited

jurisdiction
string (Jurisdiction)

Jurisdiction

mail
required
string (Email Address)

Email Address

onboardDate
string (Date Onboarded)

Date Onboarded

password
string (Password)

Password

sn
required
string (Last Name)

Last Name

userName
required
string (Username) non-empty

Username

Responses

Request samples

Content type
{
  • "_id": "string",
  • "_meta": {
    },
  • "_notifications": [
    ],
  • "accountStatus": "string",
  • "aliasList": [
    ],
  • "cn": "string",
  • "country": "string",
  • "givenName": "string",
  • "groups": [
    ],
  • "inviteDate": "string",
  • "jurisdiction": "string",
  • "mail": "string",
  • "onboardDate": "string",
  • "password": "string",
  • "sn": "string",
  • "userName": "string"
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_meta": {
    },
  • "_notifications": [
    ],
  • "accountStatus": "string",
  • "aliasList": [
    ],
  • "cn": "string",
  • "country": "string",
  • "givenName": "string",
  • "groups": [
    ],
  • "inviteDate": "string",
  • "jurisdiction": "string",
  • "mail": "string",
  • "onboardDate": "string",
  • "password": "string",
  • "sn": "string",
  • "userName": "string"
}

Alpha realm - Application - Members v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_applicationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Group Members Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_applicationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_applicationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_applicationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_applicationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Group Members Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_applicationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_applicationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_applicationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_applicationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Group Members Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Alpha realm - Application - Owners v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_applicationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object (Application _refProperties)

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_applicationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_applicationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_applicationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_applicationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object (Application _refProperties)

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_applicationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_applicationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_applicationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_applicationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object (Application _refProperties)

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Alpha realm - Application - Roles v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_applicationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_applicationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_applicationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_applicationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_applicationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_applicationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_applicationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_applicationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_applicationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Alpha realm - Application v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_id
string

Application ID

authoritative
boolean (Authoritative)

Is this an authoritative application

connectorId
string (Connector ID)

Id of the connector associated with the application

description
string (Description)

Application Description

icon
string (Icon)
mappingNames
Array of strings (Sync Mapping Names)

Names of the sync mappings used by an application with provisioning configured.

Array of objects (Members)

Application Members

name
required
string (Name)

Application name

Array of objects (Owners)

Application Owners

Array of objects (Roles)

Roles granting users the application

object (SSO Entity Id)

SSO Entity Id

templateName
string (Template Name)

Name of the template the application was created from

templateVersion
string (Template Version)

The template version

uiConfig
object (UI Config)

UI Config

url
string (Url)

Responses

Request samples

Content type
{
  • "_id": "string",
  • "authoritative": true,
  • "connectorId": "string",
  • "description": "string",
  • "icon": "string",
  • "mappingNames": [
    ],
  • "members": [
    ],
  • "name": "string",
  • "owners": [
    ],
  • "roles": [
    ],
  • "ssoEntities": {
    },
  • "templateName": "string",
  • "templateVersion": "string",
  • "uiConfig": { },
  • "url": "string"
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "authoritative": true,
  • "connectorId": "string",
  • "description": "string",
  • "icon": "string",
  • "mappingNames": [
    ],
  • "members": [
    ],
  • "name": "string",
  • "owners": [
    ],
  • "roles": [
    ],
  • "ssoEntities": {
    },
  • "templateName": "string",
  • "templateVersion": "string",
  • "uiConfig": { },
  • "url": "string"
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Action: triggerSyncCheck

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_applicationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "triggerSyncCheck"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_applicationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_id
string

Application ID

authoritative
boolean (Authoritative)

Is this an authoritative application

connectorId
string (Connector ID)

Id of the connector associated with the application

description
string (Description)

Application Description

icon
string (Icon)
mappingNames
Array of strings (Sync Mapping Names)

Names of the sync mappings used by an application with provisioning configured.

Array of objects (Members)

Application Members

name
required
string (Name)

Application name

Array of objects (Owners)

Application Owners

Array of objects (Roles)

Roles granting users the application

object (SSO Entity Id)

SSO Entity Id

templateName
string (Template Name)

Name of the template the application was created from

templateVersion
string (Template Version)

The template version

uiConfig
object (UI Config)

UI Config

url
string (Url)

Responses

Request samples

Content type
{
  • "_id": "string",
  • "authoritative": true,
  • "connectorId": "string",
  • "description": "string",
  • "icon": "string",
  • "mappingNames": [
    ],
  • "members": [
    ],
  • "name": "string",
  • "owners": [
    ],
  • "roles": [
    ],
  • "ssoEntities": {
    },
  • "templateName": "string",
  • "templateVersion": "string",
  • "uiConfig": { },
  • "url": "string"
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "authoritative": true,
  • "connectorId": "string",
  • "description": "string",
  • "icon": "string",
  • "mappingNames": [
    ],
  • "members": [
    ],
  • "name": "string",
  • "owners": [
    ],
  • "roles": [
    ],
  • "ssoEntities": {
    },
  • "templateName": "string",
  • "templateVersion": "string",
  • "uiConfig": { },
  • "url": "string"
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_applicationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "authoritative": true,
  • "connectorId": "string",
  • "description": "string",
  • "icon": "string",
  • "mappingNames": [
    ],
  • "members": [
    ],
  • "name": "string",
  • "owners": [
    ],
  • "roles": [
    ],
  • "ssoEntities": {
    },
  • "templateName": "string",
  • "templateVersion": "string",
  • "uiConfig": { },
  • "url": "string"
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_applicationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_id": "string",
  • "authoritative": true,
  • "connectorId": "string",
  • "description": "string",
  • "icon": "string",
  • "mappingNames": [
    ],
  • "members": [
    ],
  • "name": "string",
  • "owners": [
    ],
  • "roles": [
    ],
  • "ssoEntities": {
    },
  • "templateName": "string",
  • "templateVersion": "string",
  • "uiConfig": { },
  • "url": "string"
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_applicationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "authoritative": true,
  • "connectorId": "string",
  • "description": "string",
  • "icon": "string",
  • "mappingNames": [
    ],
  • "members": [
    ],
  • "name": "string",
  • "owners": [
    ],
  • "roles": [
    ],
  • "ssoEntities": {
    },
  • "templateName": "string",
  • "templateVersion": "string",
  • "uiConfig": { },
  • "url": "string"
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_applicationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_id
string

Application ID

authoritative
boolean (Authoritative)

Is this an authoritative application

connectorId
string (Connector ID)

Id of the connector associated with the application

description
string (Description)

Application Description

icon
string (Icon)
mappingNames
Array of strings (Sync Mapping Names)

Names of the sync mappings used by an application with provisioning configured.

Array of objects (Members)

Application Members

name
required
string (Name)

Application name

Array of objects (Owners)

Application Owners

Array of objects (Roles)

Roles granting users the application

object (SSO Entity Id)

SSO Entity Id

templateName
string (Template Name)

Name of the template the application was created from

templateVersion
string (Template Version)

The template version

uiConfig
object (UI Config)

UI Config

url
string (Url)

Responses

Request samples

Content type
{
  • "_id": "string",
  • "authoritative": true,
  • "connectorId": "string",
  • "description": "string",
  • "icon": "string",
  • "mappingNames": [
    ],
  • "members": [
    ],
  • "name": "string",
  • "owners": [
    ],
  • "roles": [
    ],
  • "ssoEntities": {
    },
  • "templateName": "string",
  • "templateVersion": "string",
  • "uiConfig": { },
  • "url": "string"
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "authoritative": true,
  • "connectorId": "string",
  • "description": "string",
  • "icon": "string",
  • "mappingNames": [
    ],
  • "members": [
    ],
  • "name": "string",
  • "owners": [
    ],
  • "roles": [
    ],
  • "ssoEntities": {
    },
  • "templateName": "string",
  • "templateVersion": "string",
  • "uiConfig": { },
  • "url": "string"
}

Alpha realm - Assignment - Assignment Members v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_assignmentId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Assignment Members Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_assignmentId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_assignmentId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_assignmentId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_assignmentId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Assignment Members Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_assignmentId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_assignmentId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_assignmentId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_assignmentId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Assignment Members Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Alpha realm - Assignment - Managed Roles v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_assignmentId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Managed Roles Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_assignmentId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_assignmentId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_assignmentId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_assignmentId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Managed Roles Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_assignmentId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_assignmentId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_assignmentId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_assignmentId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Managed Roles Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Alpha realm - Assignment v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_id
string (Name)

The assignment ID

Array of objects (Assignment Attributes)

The attributes operated on by this assignment.

condition
string (Condition)

A conditional filter for this assignment

description
required
string (Description)

The assignment description, used for display purposes.

linkQualifiers
Array of strings (Link Qualifiers)

Conditional link qualifiers to restrict this assignment to.

mapping
required
string (Mapping)

The name of the mapping this assignment applies to

Array of objects (Assignment Members)

Assignment Members

name
required
string (Name)

The assignment name, used for display purposes.

Array of objects (Managed Roles)

Managed Roles

type
string (Type)

The type of object this assignment represents

weight
number <double> (Weight)

The weight of the assignment.

Responses

Request samples

Content type
{
  • "_id": "string",
  • "attributes": [
    ],
  • "condition": "string",
  • "description": "string",
  • "linkQualifiers": [
    ],
  • "mapping": "string",
  • "members": [
    ],
  • "name": "string",
  • "roles": [
    ],
  • "type": "string",
  • "weight": 0.1
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "attributes": [
    ],
  • "condition": "string",
  • "description": "string",
  • "linkQualifiers": [
    ],
  • "mapping": "string",
  • "members": [
    ],
  • "name": "string",
  • "roles": [
    ],
  • "type": "string",
  • "weight": 0.1
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Action: triggerSyncCheck

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_assignmentId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "triggerSyncCheck"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_assignmentId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_id
string (Name)

The assignment ID

Array of objects (Assignment Attributes)

The attributes operated on by this assignment.

condition
string (Condition)

A conditional filter for this assignment

description
required
string (Description)

The assignment description, used for display purposes.

linkQualifiers
Array of strings (Link Qualifiers)

Conditional link qualifiers to restrict this assignment to.

mapping
required
string (Mapping)

The name of the mapping this assignment applies to

Array of objects (Assignment Members)

Assignment Members

name
required
string (Name)

The assignment name, used for display purposes.

Array of objects (Managed Roles)

Managed Roles

type
string (Type)

The type of object this assignment represents

weight
number <double> (Weight)

The weight of the assignment.

Responses

Request samples

Content type
{
  • "_id": "string",
  • "attributes": [
    ],
  • "condition": "string",
  • "description": "string",
  • "linkQualifiers": [
    ],
  • "mapping": "string",
  • "members": [
    ],
  • "name": "string",
  • "roles": [
    ],
  • "type": "string",
  • "weight": 0.1
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "attributes": [
    ],
  • "condition": "string",
  • "description": "string",
  • "linkQualifiers": [
    ],
  • "mapping": "string",
  • "members": [
    ],
  • "name": "string",
  • "roles": [
    ],
  • "type": "string",
  • "weight": 0.1
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_assignmentId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "attributes": [
    ],
  • "condition": "string",
  • "description": "string",
  • "linkQualifiers": [
    ],
  • "mapping": "string",
  • "members": [
    ],
  • "name": "string",
  • "roles": [
    ],
  • "type": "string",
  • "weight": 0.1
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_assignmentId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_id": "string",
  • "attributes": [
    ],
  • "condition": "string",
  • "description": "string",
  • "linkQualifiers": [
    ],
  • "mapping": "string",
  • "members": [
    ],
  • "name": "string",
  • "roles": [
    ],
  • "type": "string",
  • "weight": 0.1
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_assignmentId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "attributes": [
    ],
  • "condition": "string",
  • "description": "string",
  • "linkQualifiers": [
    ],
  • "mapping": "string",
  • "members": [
    ],
  • "name": "string",
  • "roles": [
    ],
  • "type": "string",
  • "weight": 0.1
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_assignmentId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_id
string (Name)

The assignment ID

Array of objects (Assignment Attributes)

The attributes operated on by this assignment.

condition
string (Condition)

A conditional filter for this assignment

description
required
string (Description)

The assignment description, used for display purposes.

linkQualifiers
Array of strings (Link Qualifiers)

Conditional link qualifiers to restrict this assignment to.

mapping
required
string (Mapping)

The name of the mapping this assignment applies to

Array of objects (Assignment Members)

Assignment Members

name
required
string (Name)

The assignment name, used for display purposes.

Array of objects (Managed Roles)

Managed Roles

type
string (Type)

The type of object this assignment represents

weight
number <double> (Weight)

The weight of the assignment.

Responses

Request samples

Content type
{
  • "_id": "string",
  • "attributes": [
    ],
  • "condition": "string",
  • "description": "string",
  • "linkQualifiers": [
    ],
  • "mapping": "string",
  • "members": [
    ],
  • "name": "string",
  • "roles": [
    ],
  • "type": "string",
  • "weight": 0.1
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "attributes": [
    ],
  • "condition": "string",
  • "description": "string",
  • "linkQualifiers": [
    ],
  • "mapping": "string",
  • "members": [
    ],
  • "name": "string",
  • "roles": [
    ],
  • "type": "string",
  • "weight": 0.1
}

Alpha realm - Organization - Administrators v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_organizationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_organizationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_organizationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_organizationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_organizationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_organizationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_organizationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_organizationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_organizationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Alpha realm - Organization - Child Organizations v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_organizationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_organizationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_organizationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_organizationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_organizationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_organizationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_organizationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_organizationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_organizationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Alpha realm - Organization - Members v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_organizationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_organizationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_organizationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_organizationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_organizationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_organizationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_organizationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_organizationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_organizationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Alpha realm - Organization - Owner v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_organizationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_organizationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_organizationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_organizationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_organizationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_organizationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_organizationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_organizationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_organizationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Alpha realm - Organization v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
adminIDs
Array of strings (Admin user ids)
Array of objects (Administrators)
Array of objects (Child Organizations)

Child Organizations

description
string (Description)
Array of objects (Members)
name
required
string (Name)
ownerIDs
Array of strings (Owner user ids)
Array of objects (Owner)
object (Parent Organization)

Parent Organization

parentAdminIDs
Array of strings (user ids of parent admins)
parentIDs
Array of strings (parent org ids)
parentOwnerIDs
Array of strings (user ids of parent owners)

Responses

Request samples

Content type
{
  • "adminIDs": [
    ],
  • "admins": [
    ],
  • "children": [
    ],
  • "description": "string",
  • "members": [
    ],
  • "name": "string",
  • "ownerIDs": [
    ],
  • "owners": [
    ],
  • "parent": {
    },
  • "parentAdminIDs": [
    ],
  • "parentIDs": [
    ],
  • "parentOwnerIDs": [
    ]
}

Response samples

Content type
application/json
{
  • "adminIDs": [
    ],
  • "admins": [
    ],
  • "children": [
    ],
  • "description": "string",
  • "members": [
    ],
  • "name": "string",
  • "ownerIDs": [
    ],
  • "owners": [
    ],
  • "parent": {
    },
  • "parentAdminIDs": [
    ],
  • "parentIDs": [
    ],
  • "parentOwnerIDs": [
    ]
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Action: triggerSyncCheck

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_organizationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "triggerSyncCheck"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_organizationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
adminIDs
Array of strings (Admin user ids)
Array of objects (Administrators)
Array of objects (Child Organizations)

Child Organizations

description
string (Description)
Array of objects (Members)
name
required
string (Name)
ownerIDs
Array of strings (Owner user ids)
Array of objects (Owner)
object (Parent Organization)

Parent Organization

parentAdminIDs
Array of strings (user ids of parent admins)
parentIDs
Array of strings (parent org ids)
parentOwnerIDs
Array of strings (user ids of parent owners)

Responses

Request samples

Content type
{
  • "adminIDs": [
    ],
  • "admins": [
    ],
  • "children": [
    ],
  • "description": "string",
  • "members": [
    ],
  • "name": "string",
  • "ownerIDs": [
    ],
  • "owners": [
    ],
  • "parent": {
    },
  • "parentAdminIDs": [
    ],
  • "parentIDs": [
    ],
  • "parentOwnerIDs": [
    ]
}

Response samples

Content type
application/json
{
  • "adminIDs": [
    ],
  • "admins": [
    ],
  • "children": [
    ],
  • "description": "string",
  • "members": [
    ],
  • "name": "string",
  • "ownerIDs": [
    ],
  • "owners": [
    ],
  • "parent": {
    },
  • "parentAdminIDs": [
    ],
  • "parentIDs": [
    ],
  • "parentOwnerIDs": [
    ]
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_organizationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "adminIDs": [
    ],
  • "admins": [
    ],
  • "children": [
    ],
  • "description": "string",
  • "members": [
    ],
  • "name": "string",
  • "ownerIDs": [
    ],
  • "owners": [
    ],
  • "parent": {
    },
  • "parentAdminIDs": [
    ],
  • "parentIDs": [
    ],
  • "parentOwnerIDs": [
    ]
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_organizationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "adminIDs": [
    ],
  • "admins": [
    ],
  • "children": [
    ],
  • "description": "string",
  • "members": [
    ],
  • "name": "string",
  • "ownerIDs": [
    ],
  • "owners": [
    ],
  • "parent": {
    },
  • "parentAdminIDs": [
    ],
  • "parentIDs": [
    ],
  • "parentOwnerIDs": [
    ]
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_organizationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "adminIDs": [
    ],
  • "admins": [
    ],
  • "children": [
    ],
  • "description": "string",
  • "members": [
    ],
  • "name": "string",
  • "ownerIDs": [
    ],
  • "owners": [
    ],
  • "parent": {
    },
  • "parentAdminIDs": [
    ],
  • "parentIDs": [
    ],
  • "parentOwnerIDs": [
    ]
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_organizationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
adminIDs
Array of strings (Admin user ids)
Array of objects (Administrators)
Array of objects (Child Organizations)

Child Organizations

description
string (Description)
Array of objects (Members)
name
required
string (Name)
ownerIDs
Array of strings (Owner user ids)
Array of objects (Owner)
object (Parent Organization)

Parent Organization

parentAdminIDs
Array of strings (user ids of parent admins)
parentIDs
Array of strings (parent org ids)
parentOwnerIDs
Array of strings (user ids of parent owners)

Responses

Request samples

Content type
{
  • "adminIDs": [
    ],
  • "admins": [
    ],
  • "children": [
    ],
  • "description": "string",
  • "members": [
    ],
  • "name": "string",
  • "ownerIDs": [
    ],
  • "owners": [
    ],
  • "parent": {
    },
  • "parentAdminIDs": [
    ],
  • "parentIDs": [
    ],
  • "parentOwnerIDs": [
    ]
}

Response samples

Content type
application/json
{
  • "adminIDs": [
    ],
  • "admins": [
    ],
  • "children": [
    ],
  • "description": "string",
  • "members": [
    ],
  • "name": "string",
  • "ownerIDs": [
    ],
  • "owners": [
    ],
  • "parent": {
    },
  • "parentAdminIDs": [
    ],
  • "parentIDs": [
    ],
  • "parentOwnerIDs": [
    ]
}

Alpha realm - Role - Applications v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_roleId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Role Application Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_roleId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_roleId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_roleId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_roleId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Role Application Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_roleId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_roleId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_roleId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_roleId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Role Application Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Alpha realm - Role - Managed Assignments v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_roleId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Managed Assignments Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_roleId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_roleId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_roleId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_roleId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Managed Assignments Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_roleId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_roleId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_roleId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_roleId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Managed Assignments Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Alpha realm - Role - Role Members v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_roleId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Role Members Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_roleId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_roleId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_roleId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_roleId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Role Members Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_roleId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_roleId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_roleId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_roleId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Role Members Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Alpha realm - Role v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_id
string (Name)

Role ID

Array of objects (Applications)

Role Applications

Array of objects (Managed Assignments)

Managed Assignments

condition
string (Condition)

A conditional filter for this role

description
string (Description)

The role description, used for display purposes.

Array of objects (Role Members)

Role Members

name
required
string (Name)

The role name, used for display purposes.

Array of objects (Temporal Constraints)

An array of temporal constraints for a role

Responses

Request samples

Content type
{
  • "_id": "string",
  • "applications": [
    ],
  • "assignments": [
    ],
  • "condition": "string",
  • "description": "string",
  • "members": [
    ],
  • "name": "string",
  • "temporalConstraints": [
    ]
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "applications": [
    ],
  • "assignments": [
    ],
  • "condition": "string",
  • "description": "string",
  • "members": [
    ],
  • "name": "string",
  • "temporalConstraints": [
    ]
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Action: triggerSyncCheck

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_roleId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "triggerSyncCheck"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_roleId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_id
string (Name)

Role ID

Array of objects (Applications)

Role Applications

Array of objects (Managed Assignments)

Managed Assignments

condition
string (Condition)

A conditional filter for this role

description
string (Description)

The role description, used for display purposes.

Array of objects (Role Members)

Role Members

name
required
string (Name)

The role name, used for display purposes.

Array of objects (Temporal Constraints)

An array of temporal constraints for a role

Responses

Request samples

Content type
{
  • "_id": "string",
  • "applications": [
    ],
  • "assignments": [
    ],
  • "condition": "string",
  • "description": "string",
  • "members": [
    ],
  • "name": "string",
  • "temporalConstraints": [
    ]
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "applications": [
    ],
  • "assignments": [
    ],
  • "condition": "string",
  • "description": "string",
  • "members": [
    ],
  • "name": "string",
  • "temporalConstraints": [
    ]
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_roleId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "applications": [
    ],
  • "assignments": [
    ],
  • "condition": "string",
  • "description": "string",
  • "members": [
    ],
  • "name": "string",
  • "temporalConstraints": [
    ]
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_roleId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_id": "string",
  • "applications": [
    ],
  • "assignments": [
    ],
  • "condition": "string",
  • "description": "string",
  • "members": [
    ],
  • "name": "string",
  • "temporalConstraints": [
    ]
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_roleId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "applications": [
    ],
  • "assignments": [
    ],
  • "condition": "string",
  • "description": "string",
  • "members": [
    ],
  • "name": "string",
  • "temporalConstraints": [
    ]
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_roleId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_id
string (Name)

Role ID

Array of objects (Applications)

Role Applications

Array of objects (Managed Assignments)

Managed Assignments

condition
string (Condition)

A conditional filter for this role

description
string (Description)

The role description, used for display purposes.

Array of objects (Role Members)

Role Members

name
required
string (Name)

The role name, used for display purposes.

Array of objects (Temporal Constraints)

An array of temporal constraints for a role

Responses

Request samples

Content type
{
  • "_id": "string",
  • "applications": [
    ],
  • "assignments": [
    ],
  • "condition": "string",
  • "description": "string",
  • "members": [
    ],
  • "name": "string",
  • "temporalConstraints": [
    ]
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "applications": [
    ],
  • "assignments": [
    ],
  • "condition": "string",
  • "description": "string",
  • "members": [
    ],
  • "name": "string",
  • "temporalConstraints": [
    ]
}

Alpha realm - User - Applications I Own v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Alpha realm - User - Applications v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Groups Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Groups Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Groups Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Alpha realm - User - Assignments v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Provisioning Roles Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Provisioning Roles Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Provisioning Roles Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Alpha realm - User - Authorization Roles v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Authorization Roles Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Authorization Roles Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Authorization Roles Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Alpha realm - User - Direct Reports v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Direct Reports Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Direct Reports Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Direct Reports Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Alpha realm - User - Groups v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Groups Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Groups Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Groups Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Alpha realm - User - Notifications v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Notifications _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Notifications _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Notifications _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Alpha realm - User - Organizations I Administer v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Alpha realm - User - Organizations I Own v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Alpha realm - User - Organizations to which I Belong v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Alpha realm - User - Provisioning Roles v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Provisioning Roles Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Provisioning Roles Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Provisioning Roles Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Alpha realm - User v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_id
string

User ID

object (Metadata)

Metadata for managed/bravo_usermeta

Array of objects (Notifications)

Notifications

accountStatus
string (Status)
Default: "active"

Status

Array of objects (Organizations I Administer)
aliasList
Array of strings (User Alias Names List)

List of identity aliases used primarily to record social IdP subjects for this user

Array of objects (Applications)

Applications

assignedDashboard
Array of strings (Assigned Dashboard)

List of items to click on for this user

Array of objects (Assignments)

Assignments

Array of objects (Authorization Roles)

Authorization Roles

city
string (City)

City

cn
string (Common Name)
Default: "{{givenName}} {{sn}}"

Common Name

Array of objects (Consented Mappings) [ items ]

Consented Mappings

country
string (Country)

Country

description
string (Description)

Description

effectiveApplications
Array of objects (Effective Applications)

Effective Applications

effectiveAssignments
Array of objects (Effective Assignments)

Effective Assignments

effectiveGroups
Array of objects (Effective Groups)

Effective Groups

effectiveRoles
Array of objects (Effective Roles)

Effective Roles

frIndexedDate1
string (Generic Indexed Date 1)

Generic Indexed Date 1

frIndexedDate2
string (Generic Indexed Date 2)

Generic Indexed Date 2

frIndexedDate3
string (Generic Indexed Date 3)

Generic Indexed Date 3

frIndexedDate4
string (Generic Indexed Date 4)

Generic Indexed Date 4

frIndexedDate5
string (Generic Indexed Date 5)

Generic Indexed Date 5

frIndexedInteger1
number <double> (Generic Indexed Integer 1)

Generic Indexed Integer 1

frIndexedInteger2
number <double> (Generic Indexed Integer 2)

Generic Indexed Integer 2

frIndexedInteger3
number <double> (Generic Indexed Integer 3)

Generic Indexed Integer 3

frIndexedInteger4
number <double> (Generic Indexed Integer 4)

Generic Indexed Integer 4

frIndexedInteger5
number <double> (Generic Indexed Integer 5)

Generic Indexed Integer 5

frIndexedMultivalued1
Array of strings (Generic Indexed Multivalue 1)

Generic Indexed Multivalue 1

frIndexedMultivalued2
Array of strings (Generic Indexed Multivalue 2)

Generic Indexed Multivalue 2

frIndexedMultivalued3
Array of strings (Generic Indexed Multivalue 3)

Generic Indexed Multivalue 3

frIndexedMultivalued4
Array of strings (Generic Indexed Multivalue 4)

Generic Indexed Multivalue 4

frIndexedMultivalued5
Array of strings (Generic Indexed Multivalue 5)

Generic Indexed Multivalue 5

frIndexedString1
string (Generic Indexed String 1)

Generic Indexed String 1

frIndexedString2
string (Generic Indexed String 2)

Generic Indexed String 2

frIndexedString3
string (Generic Indexed String 3)

Generic Indexed String 3

frIndexedString4
string (Generic Indexed String 4)

Generic Indexed String 4

frIndexedString5
string (Generic Indexed String 5)

Generic Indexed String 5

frUnindexedDate1
string (Generic Unindexed Date 1)

Generic Unindexed Date 1

frUnindexedDate2
string (Generic Unindexed Date 2)

Generic Unindexed Date 2

frUnindexedDate3
string (Generic Unindexed Date 3)

Generic Unindexed Date 3

frUnindexedDate4
string (Generic Unindexed Date 4)

Generic Unindexed Date 4

frUnindexedDate5
string (Generic Unindexed Date 5)

Generic Unindexed Date 5

frUnindexedInteger1
number <double> (Generic Unindexed Integer 1)

Generic Unindexed Integer 1

frUnindexedInteger2
number <double> (Generic Unindexed Integer 2)

Generic Unindexed Integer 2

frUnindexedInteger3
number <double> (Generic Unindexed Integer 3)

Generic Unindexed Integer 3

frUnindexedInteger4
number <double> (Generic Unindexed Integer 4)

Generic Unindexed Integer 4

frUnindexedInteger5
number <double> (Generic Unindexed Integer 5)

Generic Unindexed Integer 5

frUnindexedMultivalued1
Array of strings (Generic Unindexed Multivalue 1)

Generic Unindexed Multivalue 1

frUnindexedMultivalued2
Array of strings (Generic Unindexed Multivalue 2)

Generic Unindexed Multivalue 2

frUnindexedMultivalued3
Array of strings (Generic Unindexed Multivalue 3)

Generic Unindexed Multivalue 3

frUnindexedMultivalued4
Array of strings (Generic Unindexed Multivalue 4)

Generic Unindexed Multivalue 4

frUnindexedMultivalued5
Array of strings (Generic Unindexed Multivalue 5)

Generic Unindexed Multivalue 5

frUnindexedString1
string (Generic Unindexed String 1)

Generic Unindexed String 1

frUnindexedString2
string (Generic Unindexed String 2)

Generic Unindexed String 2

frUnindexedString3
string (Generic Unindexed String 3)

Generic Unindexed String 3

frUnindexedString4
string (Generic Unindexed String 4)

Generic Unindexed String 4

frUnindexedString5
string (Generic Unindexed String 5)

Generic Unindexed String 5

givenName
required
string (First Name)

First Name

Array of objects (Groups)

Groups

Array of objects (KBA Info Items)

KBA Info

object (Last Sync timestamp)

Last Sync timestamp

mail
required
string (Email Address)

Email Address

object (Manager)

Manager

Array of objects (Organizations to which I Belong)
memberOfOrgIDs
Array of strings (MemberOfOrgIDs)
Array of objects (Applications I Own)
Array of objects (Organizations I Own)
password
string (Password)

Password

passwordExpirationTime
string (Password Expiration Time)

Password Expiration Time

passwordLastChangedTime
string (Password Last Changed Time)

Password Last Changed Time

postalAddress
string (Address 1)

Address 1

postalCode
string (Postal Code)

Postal Code

object (Preferences)

Preferences

profileImage
string (Profile Image)

Profile Image

Array of objects (Direct Reports)

Direct Reports

Array of objects (Provisioning Roles)

Provisioning Roles

sn
required
string (Last Name)

Last Name

stateProvince
string (State/Province)

State/Province

telephoneNumber
string (Telephone Number) ^\+?([0-9\- \(\)])*$

Telephone Number

userName
required
string (Username) non-empty

Username

Responses

Request samples

Content type
{
  • "_id": "string",
  • "_meta": {
    },
  • "_notifications": [
    ],
  • "accountStatus": "active",
  • "adminOfOrg": [
    ],
  • "aliasList": [
    ],
  • "applications": [
    ],
  • "assignedDashboard": [
    ],
  • "assignments": [
    ],
  • "authzRoles": [
    ],
  • "city": "string",
  • "cn": "{{givenName}} {{sn}}",
  • "consentedMappings": [
    ],
  • "country": "string",
  • "description": "string",
  • "effectiveApplications": [
    ],
  • "effectiveAssignments": [
    ],
  • "effectiveGroups": [
    ],
  • "effectiveRoles": [
    ],
  • "frIndexedDate1": "string",
  • "frIndexedDate2": "string",
  • "frIndexedDate3": "string",
  • "frIndexedDate4": "string",
  • "frIndexedDate5": "string",
  • "frIndexedInteger1": 0.1,
  • "frIndexedInteger2": 0.1,
  • "frIndexedInteger3": 0.1,
  • "frIndexedInteger4": 0.1,
  • "frIndexedInteger5": 0.1,
  • "frIndexedMultivalued1": [
    ],
  • "frIndexedMultivalued2": [
    ],
  • "frIndexedMultivalued3": [
    ],
  • "frIndexedMultivalued4": [
    ],
  • "frIndexedMultivalued5": [
    ],
  • "frIndexedString1": "string",
  • "frIndexedString2": "string",
  • "frIndexedString3": "string",
  • "frIndexedString4": "string",
  • "frIndexedString5": "string",
  • "frUnindexedDate1": "string",
  • "frUnindexedDate2": "string",
  • "frUnindexedDate3": "string",
  • "frUnindexedDate4": "string",
  • "frUnindexedDate5": "string",
  • "frUnindexedInteger1": 0.1,
  • "frUnindexedInteger2": 0.1,
  • "frUnindexedInteger3": 0.1,
  • "frUnindexedInteger4": 0.1,
  • "frUnindexedInteger5": 0.1,
  • "frUnindexedMultivalued1": [
    ],
  • "frUnindexedMultivalued2": [
    ],
  • "frUnindexedMultivalued3": [
    ],
  • "frUnindexedMultivalued4": [
    ],
  • "frUnindexedMultivalued5": [
    ],
  • "frUnindexedString1": "string",
  • "frUnindexedString2": "string",
  • "frUnindexedString3": "string",
  • "frUnindexedString4": "string",
  • "frUnindexedString5": "string",
  • "givenName": "string",
  • "groups": [
    ],
  • "kbaInfo": [
    ],
  • "lastSync": {
    },
  • "mail": "string",
  • "manager": {
    },
  • "memberOfOrg": [
    ],
  • "memberOfOrgIDs": [
    ],
  • "ownerOfApp": [
    ],
  • "ownerOfOrg": [
    ],
  • "password": "string",
  • "passwordExpirationTime": "string",
  • "passwordLastChangedTime": "string",
  • "postalAddress": "string",
  • "postalCode": "string",
  • "preferences": {
    },
  • "profileImage": "string",
  • "reports": [
    ],
  • "roles": [
    ],
  • "sn": "string",
  • "stateProvince": "string",
  • "telephoneNumber": "string",
  • "userName": "string"
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_meta": {
    },
  • "_notifications": [
    ],
  • "accountStatus": "active",
  • "adminOfOrg": [
    ],
  • "aliasList": [
    ],
  • "applications": [
    ],
  • "assignedDashboard": [
    ],
  • "assignments": [
    ],
  • "authzRoles": [
    ],
  • "city": "string",
  • "cn": "{{givenName}} {{sn}}",
  • "consentedMappings": [
    ],
  • "country": "string",
  • "description": "string",
  • "effectiveApplications": [
    ],
  • "effectiveAssignments": [
    ],
  • "effectiveGroups": [
    ],
  • "effectiveRoles": [
    ],
  • "frIndexedDate1": "string",
  • "frIndexedDate2": "string",
  • "frIndexedDate3": "string",
  • "frIndexedDate4": "string",
  • "frIndexedDate5": "string",
  • "frIndexedInteger1": 0.1,
  • "frIndexedInteger2": 0.1,
  • "frIndexedInteger3": 0.1,
  • "frIndexedInteger4": 0.1,
  • "frIndexedInteger5": 0.1,
  • "frIndexedMultivalued1": [
    ],
  • "frIndexedMultivalued2": [
    ],
  • "frIndexedMultivalued3": [
    ],
  • "frIndexedMultivalued4": [
    ],
  • "frIndexedMultivalued5": [
    ],
  • "frIndexedString1": "string",
  • "frIndexedString2": "string",
  • "frIndexedString3": "string",
  • "frIndexedString4": "string",
  • "frIndexedString5": "string",
  • "frUnindexedDate1": "string",
  • "frUnindexedDate2": "string",
  • "frUnindexedDate3": "string",
  • "frUnindexedDate4": "string",
  • "frUnindexedDate5": "string",
  • "frUnindexedInteger1": 0.1,
  • "frUnindexedInteger2": 0.1,
  • "frUnindexedInteger3": 0.1,
  • "frUnindexedInteger4": 0.1,
  • "frUnindexedInteger5": 0.1,
  • "frUnindexedMultivalued1": [
    ],
  • "frUnindexedMultivalued2": [
    ],
  • "frUnindexedMultivalued3": [
    ],
  • "frUnindexedMultivalued4": [
    ],
  • "frUnindexedMultivalued5": [
    ],
  • "frUnindexedString1": "string",
  • "frUnindexedString2": "string",
  • "frUnindexedString3": "string",
  • "frUnindexedString4": "string",
  • "frUnindexedString5": "string",
  • "givenName": "string",
  • "groups": [
    ],
  • "kbaInfo": [
    ],
  • "lastSync": {
    },
  • "mail": "string",
  • "manager": {
    },
  • "memberOfOrg": [
    ],
  • "memberOfOrgIDs": [
    ],
  • "ownerOfApp": [
    ],
  • "ownerOfOrg": [
    ],
  • "password": "string",
  • "passwordExpirationTime": "string",
  • "passwordLastChangedTime": "string",
  • "postalAddress": "string",
  • "postalCode": "string",
  • "preferences": {
    },
  • "profileImage": "string",
  • "reports": [
    ],
  • "roles": [
    ],
  • "sn": "string",
  • "stateProvince": "string",
  • "telephoneNumber": "string",
  • "userName": "string"
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Action: triggerSyncCheck

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "triggerSyncCheck"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_id
string

User ID

object (Metadata)

Metadata for managed/bravo_usermeta

Array of objects (Notifications)

Notifications

accountStatus
string (Status)
Default: "active"

Status

Array of objects (Organizations I Administer)
aliasList
Array of strings (User Alias Names List)

List of identity aliases used primarily to record social IdP subjects for this user

Array of objects (Applications)

Applications

assignedDashboard
Array of strings (Assigned Dashboard)

List of items to click on for this user

Array of objects (Assignments)

Assignments

Array of objects (Authorization Roles)

Authorization Roles

city
string (City)

City

cn
string (Common Name)
Default: "{{givenName}} {{sn}}"

Common Name

Array of objects (Consented Mappings) [ items ]

Consented Mappings

country
string (Country)

Country

description
string (Description)

Description

effectiveApplications
Array of objects (Effective Applications)

Effective Applications

effectiveAssignments
Array of objects (Effective Assignments)

Effective Assignments

effectiveGroups
Array of objects (Effective Groups)

Effective Groups

effectiveRoles
Array of objects (Effective Roles)

Effective Roles

frIndexedDate1
string (Generic Indexed Date 1)

Generic Indexed Date 1

frIndexedDate2
string (Generic Indexed Date 2)

Generic Indexed Date 2

frIndexedDate3
string (Generic Indexed Date 3)

Generic Indexed Date 3

frIndexedDate4
string (Generic Indexed Date 4)

Generic Indexed Date 4

frIndexedDate5
string (Generic Indexed Date 5)

Generic Indexed Date 5

frIndexedInteger1
number <double> (Generic Indexed Integer 1)

Generic Indexed Integer 1

frIndexedInteger2
number <double> (Generic Indexed Integer 2)

Generic Indexed Integer 2

frIndexedInteger3
number <double> (Generic Indexed Integer 3)

Generic Indexed Integer 3

frIndexedInteger4
number <double> (Generic Indexed Integer 4)

Generic Indexed Integer 4

frIndexedInteger5
number <double> (Generic Indexed Integer 5)

Generic Indexed Integer 5

frIndexedMultivalued1
Array of strings (Generic Indexed Multivalue 1)

Generic Indexed Multivalue 1

frIndexedMultivalued2
Array of strings (Generic Indexed Multivalue 2)

Generic Indexed Multivalue 2

frIndexedMultivalued3
Array of strings (Generic Indexed Multivalue 3)

Generic Indexed Multivalue 3

frIndexedMultivalued4
Array of strings (Generic Indexed Multivalue 4)

Generic Indexed Multivalue 4

frIndexedMultivalued5
Array of strings (Generic Indexed Multivalue 5)

Generic Indexed Multivalue 5

frIndexedString1
string (Generic Indexed String 1)

Generic Indexed String 1

frIndexedString2
string (Generic Indexed String 2)

Generic Indexed String 2

frIndexedString3
string (Generic Indexed String 3)

Generic Indexed String 3

frIndexedString4
string (Generic Indexed String 4)

Generic Indexed String 4

frIndexedString5
string (Generic Indexed String 5)

Generic Indexed String 5

frUnindexedDate1
string (Generic Unindexed Date 1)

Generic Unindexed Date 1

frUnindexedDate2
string (Generic Unindexed Date 2)

Generic Unindexed Date 2

frUnindexedDate3
string (Generic Unindexed Date 3)

Generic Unindexed Date 3

frUnindexedDate4
string (Generic Unindexed Date 4)

Generic Unindexed Date 4

frUnindexedDate5
string (Generic Unindexed Date 5)

Generic Unindexed Date 5

frUnindexedInteger1
number <double> (Generic Unindexed Integer 1)

Generic Unindexed Integer 1

frUnindexedInteger2
number <double> (Generic Unindexed Integer 2)

Generic Unindexed Integer 2

frUnindexedInteger3
number <double> (Generic Unindexed Integer 3)

Generic Unindexed Integer 3

frUnindexedInteger4
number <double> (Generic Unindexed Integer 4)

Generic Unindexed Integer 4

frUnindexedInteger5
number <double> (Generic Unindexed Integer 5)

Generic Unindexed Integer 5

frUnindexedMultivalued1
Array of strings (Generic Unindexed Multivalue 1)

Generic Unindexed Multivalue 1

frUnindexedMultivalued2
Array of strings (Generic Unindexed Multivalue 2)

Generic Unindexed Multivalue 2

frUnindexedMultivalued3
Array of strings (Generic Unindexed Multivalue 3)

Generic Unindexed Multivalue 3

frUnindexedMultivalued4
Array of strings (Generic Unindexed Multivalue 4)

Generic Unindexed Multivalue 4

frUnindexedMultivalued5
Array of strings (Generic Unindexed Multivalue 5)

Generic Unindexed Multivalue 5

frUnindexedString1
string (Generic Unindexed String 1)

Generic Unindexed String 1

frUnindexedString2
string (Generic Unindexed String 2)

Generic Unindexed String 2

frUnindexedString3
string (Generic Unindexed String 3)

Generic Unindexed String 3

frUnindexedString4
string (Generic Unindexed String 4)

Generic Unindexed String 4

frUnindexedString5
string (Generic Unindexed String 5)

Generic Unindexed String 5

givenName
required
string (First Name)

First Name

Array of objects (Groups)

Groups

Array of objects (KBA Info Items)

KBA Info

object (Last Sync timestamp)

Last Sync timestamp

mail
required
string (Email Address)

Email Address

object (Manager)

Manager

Array of objects (Organizations to which I Belong)
memberOfOrgIDs
Array of strings (MemberOfOrgIDs)
Array of objects (Applications I Own)
Array of objects (Organizations I Own)
password
string (Password)

Password

passwordExpirationTime
string (Password Expiration Time)

Password Expiration Time

passwordLastChangedTime
string (Password Last Changed Time)

Password Last Changed Time

postalAddress
string (Address 1)

Address 1

postalCode
string (Postal Code)

Postal Code

object (Preferences)

Preferences

profileImage
string (Profile Image)

Profile Image

Array of objects (Direct Reports)

Direct Reports

Array of objects (Provisioning Roles)

Provisioning Roles

sn
required
string (Last Name)

Last Name

stateProvince
string (State/Province)

State/Province

telephoneNumber
string (Telephone Number) ^\+?([0-9\- \(\)])*$

Telephone Number

userName
required
string (Username) non-empty

Username

Responses

Request samples

Content type
{
  • "_id": "string",
  • "_meta": {
    },
  • "_notifications": [
    ],
  • "accountStatus": "active",
  • "adminOfOrg": [
    ],
  • "aliasList": [
    ],
  • "applications": [
    ],
  • "assignedDashboard": [
    ],
  • "assignments": [
    ],
  • "authzRoles": [
    ],
  • "city": "string",
  • "cn": "{{givenName}} {{sn}}",
  • "consentedMappings": [
    ],
  • "country": "string",
  • "description": "string",
  • "effectiveApplications": [
    ],
  • "effectiveAssignments": [
    ],
  • "effectiveGroups": [
    ],
  • "effectiveRoles": [
    ],
  • "frIndexedDate1": "string",
  • "frIndexedDate2": "string",
  • "frIndexedDate3": "string",
  • "frIndexedDate4": "string",
  • "frIndexedDate5": "string",
  • "frIndexedInteger1": 0.1,
  • "frIndexedInteger2": 0.1,
  • "frIndexedInteger3": 0.1,
  • "frIndexedInteger4": 0.1,
  • "frIndexedInteger5": 0.1,
  • "frIndexedMultivalued1": [
    ],
  • "frIndexedMultivalued2": [
    ],
  • "frIndexedMultivalued3": [
    ],
  • "frIndexedMultivalued4": [
    ],
  • "frIndexedMultivalued5": [
    ],
  • "frIndexedString1": "string",
  • "frIndexedString2": "string",
  • "frIndexedString3": "string",
  • "frIndexedString4": "string",
  • "frIndexedString5": "string",
  • "frUnindexedDate1": "string",
  • "frUnindexedDate2": "string",
  • "frUnindexedDate3": "string",
  • "frUnindexedDate4": "string",
  • "frUnindexedDate5": "string",
  • "frUnindexedInteger1": 0.1,
  • "frUnindexedInteger2": 0.1,
  • "frUnindexedInteger3": 0.1,
  • "frUnindexedInteger4": 0.1,
  • "frUnindexedInteger5": 0.1,
  • "frUnindexedMultivalued1": [
    ],
  • "frUnindexedMultivalued2": [
    ],
  • "frUnindexedMultivalued3": [
    ],
  • "frUnindexedMultivalued4": [
    ],
  • "frUnindexedMultivalued5": [
    ],
  • "frUnindexedString1": "string",
  • "frUnindexedString2": "string",
  • "frUnindexedString3": "string",
  • "frUnindexedString4": "string",
  • "frUnindexedString5": "string",
  • "givenName": "string",
  • "groups": [
    ],
  • "kbaInfo": [
    ],
  • "lastSync": {
    },
  • "mail": "string",
  • "manager": {
    },
  • "memberOfOrg": [
    ],
  • "memberOfOrgIDs": [
    ],
  • "ownerOfApp": [
    ],
  • "ownerOfOrg": [
    ],
  • "password": "string",
  • "passwordExpirationTime": "string",
  • "passwordLastChangedTime": "string",
  • "postalAddress": "string",
  • "postalCode": "string",
  • "preferences": {
    },
  • "profileImage": "string",
  • "reports": [
    ],
  • "roles": [
    ],
  • "sn": "string",
  • "stateProvince": "string",
  • "telephoneNumber": "string",
  • "userName": "string"
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_meta": {
    },
  • "_notifications": [
    ],
  • "accountStatus": "active",
  • "adminOfOrg": [
    ],
  • "aliasList": [
    ],
  • "applications": [
    ],
  • "assignedDashboard": [
    ],
  • "assignments": [
    ],
  • "authzRoles": [
    ],
  • "city": "string",
  • "cn": "{{givenName}} {{sn}}",
  • "consentedMappings": [
    ],
  • "country": "string",
  • "description": "string",
  • "effectiveApplications": [
    ],
  • "effectiveAssignments": [
    ],
  • "effectiveGroups": [
    ],
  • "effectiveRoles": [
    ],
  • "frIndexedDate1": "string",
  • "frIndexedDate2": "string",
  • "frIndexedDate3": "string",
  • "frIndexedDate4": "string",
  • "frIndexedDate5": "string",
  • "frIndexedInteger1": 0.1,
  • "frIndexedInteger2": 0.1,
  • "frIndexedInteger3": 0.1,
  • "frIndexedInteger4": 0.1,
  • "frIndexedInteger5": 0.1,
  • "frIndexedMultivalued1": [
    ],
  • "frIndexedMultivalued2": [
    ],
  • "frIndexedMultivalued3": [
    ],
  • "frIndexedMultivalued4": [
    ],
  • "frIndexedMultivalued5": [
    ],
  • "frIndexedString1": "string",
  • "frIndexedString2": "string",
  • "frIndexedString3": "string",
  • "frIndexedString4": "string",
  • "frIndexedString5": "string",
  • "frUnindexedDate1": "string",
  • "frUnindexedDate2": "string",
  • "frUnindexedDate3": "string",
  • "frUnindexedDate4": "string",
  • "frUnindexedDate5": "string",
  • "frUnindexedInteger1": 0.1,
  • "frUnindexedInteger2": 0.1,
  • "frUnindexedInteger3": 0.1,
  • "frUnindexedInteger4": 0.1,
  • "frUnindexedInteger5": 0.1,
  • "frUnindexedMultivalued1": [
    ],
  • "frUnindexedMultivalued2": [
    ],
  • "frUnindexedMultivalued3": [
    ],
  • "frUnindexedMultivalued4": [
    ],
  • "frUnindexedMultivalued5": [
    ],
  • "frUnindexedString1": "string",
  • "frUnindexedString2": "string",
  • "frUnindexedString3": "string",
  • "frUnindexedString4": "string",
  • "frUnindexedString5": "string",
  • "givenName": "string",
  • "groups": [
    ],
  • "kbaInfo": [
    ],
  • "lastSync": {
    },
  • "mail": "string",
  • "manager": {
    },
  • "memberOfOrg": [
    ],
  • "memberOfOrgIDs": [
    ],
  • "ownerOfApp": [
    ],
  • "ownerOfOrg": [
    ],
  • "password": "string",
  • "passwordExpirationTime": "string",
  • "passwordLastChangedTime": "string",
  • "postalAddress": "string",
  • "postalCode": "string",
  • "preferences": {
    },
  • "profileImage": "string",
  • "reports": [
    ],
  • "roles": [
    ],
  • "sn": "string",
  • "stateProvince": "string",
  • "telephoneNumber": "string",
  • "userName": "string"
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_meta": {
    },
  • "_notifications": [
    ],
  • "accountStatus": "active",
  • "adminOfOrg": [
    ],
  • "aliasList": [
    ],
  • "applications": [
    ],
  • "assignedDashboard": [
    ],
  • "assignments": [
    ],
  • "authzRoles": [
    ],
  • "city": "string",
  • "cn": "{{givenName}} {{sn}}",
  • "consentedMappings": [
    ],
  • "country": "string",
  • "description": "string",
  • "effectiveApplications": [
    ],
  • "effectiveAssignments": [
    ],
  • "effectiveGroups": [
    ],
  • "effectiveRoles": [
    ],
  • "frIndexedDate1": "string",
  • "frIndexedDate2": "string",
  • "frIndexedDate3": "string",
  • "frIndexedDate4": "string",
  • "frIndexedDate5": "string",
  • "frIndexedInteger1": 0.1,
  • "frIndexedInteger2": 0.1,
  • "frIndexedInteger3": 0.1,
  • "frIndexedInteger4": 0.1,
  • "frIndexedInteger5": 0.1,
  • "frIndexedMultivalued1": [
    ],
  • "frIndexedMultivalued2": [
    ],
  • "frIndexedMultivalued3": [
    ],
  • "frIndexedMultivalued4": [
    ],
  • "frIndexedMultivalued5": [
    ],
  • "frIndexedString1": "string",
  • "frIndexedString2": "string",
  • "frIndexedString3": "string",
  • "frIndexedString4": "string",
  • "frIndexedString5": "string",
  • "frUnindexedDate1": "string",
  • "frUnindexedDate2": "string",
  • "frUnindexedDate3": "string",
  • "frUnindexedDate4": "string",
  • "frUnindexedDate5": "string",
  • "frUnindexedInteger1": 0.1,
  • "frUnindexedInteger2": 0.1,
  • "frUnindexedInteger3": 0.1,
  • "frUnindexedInteger4": 0.1,
  • "frUnindexedInteger5": 0.1,
  • "frUnindexedMultivalued1": [
    ],
  • "frUnindexedMultivalued2": [
    ],
  • "frUnindexedMultivalued3": [
    ],
  • "frUnindexedMultivalued4": [
    ],
  • "frUnindexedMultivalued5": [
    ],
  • "frUnindexedString1": "string",
  • "frUnindexedString2": "string",
  • "frUnindexedString3": "string",
  • "frUnindexedString4": "string",
  • "frUnindexedString5": "string",
  • "givenName": "string",
  • "groups": [
    ],
  • "kbaInfo": [
    ],
  • "lastSync": {
    },
  • "mail": "string",
  • "manager": {
    },
  • "memberOfOrg": [
    ],
  • "memberOfOrgIDs": [
    ],
  • "ownerOfApp": [
    ],
  • "ownerOfOrg": [
    ],
  • "password": "string",
  • "passwordExpirationTime": "string",
  • "passwordLastChangedTime": "string",
  • "postalAddress": "string",
  • "postalCode": "string",
  • "preferences": {
    },
  • "profileImage": "string",
  • "reports": [
    ],
  • "roles": [
    ],
  • "sn": "string",
  • "stateProvince": "string",
  • "telephoneNumber": "string",
  • "userName": "string"
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_meta": {
    },
  • "_notifications": [
    ],
  • "accountStatus": "active",
  • "adminOfOrg": [
    ],
  • "aliasList": [
    ],
  • "applications": [
    ],
  • "assignedDashboard": [
    ],
  • "assignments": [
    ],
  • "authzRoles": [
    ],
  • "city": "string",
  • "cn": "{{givenName}} {{sn}}",
  • "consentedMappings": [
    ],
  • "country": "string",
  • "description": "string",
  • "effectiveApplications": [
    ],
  • "effectiveAssignments": [
    ],
  • "effectiveGroups": [
    ],
  • "effectiveRoles": [
    ],
  • "frIndexedDate1": "string",
  • "frIndexedDate2": "string",
  • "frIndexedDate3": "string",
  • "frIndexedDate4": "string",
  • "frIndexedDate5": "string",
  • "frIndexedInteger1": 0.1,
  • "frIndexedInteger2": 0.1,
  • "frIndexedInteger3": 0.1,
  • "frIndexedInteger4": 0.1,
  • "frIndexedInteger5": 0.1,
  • "frIndexedMultivalued1": [
    ],
  • "frIndexedMultivalued2": [
    ],
  • "frIndexedMultivalued3": [
    ],
  • "frIndexedMultivalued4": [
    ],
  • "frIndexedMultivalued5": [
    ],
  • "frIndexedString1": "string",
  • "frIndexedString2": "string",
  • "frIndexedString3": "string",
  • "frIndexedString4": "string",
  • "frIndexedString5": "string",
  • "frUnindexedDate1": "string",
  • "frUnindexedDate2": "string",
  • "frUnindexedDate3": "string",
  • "frUnindexedDate4": "string",
  • "frUnindexedDate5": "string",
  • "frUnindexedInteger1": 0.1,
  • "frUnindexedInteger2": 0.1,
  • "frUnindexedInteger3": 0.1,
  • "frUnindexedInteger4": 0.1,
  • "frUnindexedInteger5": 0.1,
  • "frUnindexedMultivalued1": [
    ],
  • "frUnindexedMultivalued2": [
    ],
  • "frUnindexedMultivalued3": [
    ],
  • "frUnindexedMultivalued4": [
    ],
  • "frUnindexedMultivalued5": [
    ],
  • "frUnindexedString1": "string",
  • "frUnindexedString2": "string",
  • "frUnindexedString3": "string",
  • "frUnindexedString4": "string",
  • "frUnindexedString5": "string",
  • "givenName": "string",
  • "groups": [
    ],
  • "kbaInfo": [
    ],
  • "lastSync": {
    },
  • "mail": "string",
  • "manager": {
    },
  • "memberOfOrg": [
    ],
  • "memberOfOrgIDs": [
    ],
  • "ownerOfApp": [
    ],
  • "ownerOfOrg": [
    ],
  • "password": "string",
  • "passwordExpirationTime": "string",
  • "passwordLastChangedTime": "string",
  • "postalAddress": "string",
  • "postalCode": "string",
  • "preferences": {
    },
  • "profileImage": "string",
  • "reports": [
    ],
  • "roles": [
    ],
  • "sn": "string",
  • "stateProvince": "string",
  • "telephoneNumber": "string",
  • "userName": "string"
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_meta": {
    },
  • "_notifications": [
    ],
  • "accountStatus": "active",
  • "adminOfOrg": [
    ],
  • "aliasList": [
    ],
  • "applications": [
    ],
  • "assignedDashboard": [
    ],
  • "assignments": [
    ],
  • "authzRoles": [
    ],
  • "city": "string",
  • "cn": "{{givenName}} {{sn}}",
  • "consentedMappings": [
    ],
  • "country": "string",
  • "description": "string",
  • "effectiveApplications": [
    ],
  • "effectiveAssignments": [
    ],
  • "effectiveGroups": [
    ],
  • "effectiveRoles": [
    ],
  • "frIndexedDate1": "string",
  • "frIndexedDate2": "string",
  • "frIndexedDate3": "string",
  • "frIndexedDate4": "string",
  • "frIndexedDate5": "string",
  • "frIndexedInteger1": 0.1,
  • "frIndexedInteger2": 0.1,
  • "frIndexedInteger3": 0.1,
  • "frIndexedInteger4": 0.1,
  • "frIndexedInteger5": 0.1,
  • "frIndexedMultivalued1": [
    ],
  • "frIndexedMultivalued2": [
    ],
  • "frIndexedMultivalued3": [
    ],
  • "frIndexedMultivalued4": [
    ],
  • "frIndexedMultivalued5": [
    ],
  • "frIndexedString1": "string",
  • "frIndexedString2": "string",
  • "frIndexedString3": "string",
  • "frIndexedString4": "string",
  • "frIndexedString5": "string",
  • "frUnindexedDate1": "string",
  • "frUnindexedDate2": "string",
  • "frUnindexedDate3": "string",
  • "frUnindexedDate4": "string",
  • "frUnindexedDate5": "string",
  • "frUnindexedInteger1": 0.1,
  • "frUnindexedInteger2": 0.1,
  • "frUnindexedInteger3": 0.1,
  • "frUnindexedInteger4": 0.1,
  • "frUnindexedInteger5": 0.1,
  • "frUnindexedMultivalued1": [
    ],
  • "frUnindexedMultivalued2": [
    ],
  • "frUnindexedMultivalued3": [
    ],
  • "frUnindexedMultivalued4": [
    ],
  • "frUnindexedMultivalued5": [
    ],
  • "frUnindexedString1": "string",
  • "frUnindexedString2": "string",
  • "frUnindexedString3": "string",
  • "frUnindexedString4": "string",
  • "frUnindexedString5": "string",
  • "givenName": "string",
  • "groups": [
    ],
  • "kbaInfo": [
    ],
  • "lastSync": {
    },
  • "mail": "string",
  • "manager": {
    },
  • "memberOfOrg": [
    ],
  • "memberOfOrgIDs": [
    ],
  • "ownerOfApp": [
    ],
  • "ownerOfOrg": [
    ],
  • "password": "string",
  • "passwordExpirationTime": "string",
  • "passwordLastChangedTime": "string",
  • "postalAddress": "string",
  • "postalCode": "string",
  • "preferences": {
    },
  • "profileImage": "string",
  • "reports": [
    ],
  • "roles": [
    ],
  • "sn": "string",
  • "stateProvince": "string",
  • "telephoneNumber": "string",
  • "userName": "string"
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_id
string

User ID

object (Metadata)

Metadata for managed/bravo_usermeta

Array of objects (Notifications)

Notifications

accountStatus
string (Status)
Default: "active"

Status

Array of objects (Organizations I Administer)
aliasList
Array of strings (User Alias Names List)

List of identity aliases used primarily to record social IdP subjects for this user

Array of objects (Applications)

Applications

assignedDashboard
Array of strings (Assigned Dashboard)

List of items to click on for this user

Array of objects (Assignments)

Assignments

Array of objects (Authorization Roles)

Authorization Roles

city
string (City)

City

cn
string (Common Name)
Default: "{{givenName}} {{sn}}"

Common Name

Array of objects (Consented Mappings) [ items ]

Consented Mappings

country
string (Country)

Country

description
string (Description)

Description

effectiveApplications
Array of objects (Effective Applications)

Effective Applications

effectiveAssignments
Array of objects (Effective Assignments)

Effective Assignments

effectiveGroups
Array of objects (Effective Groups)

Effective Groups

effectiveRoles
Array of objects (Effective Roles)

Effective Roles

frIndexedDate1
string (Generic Indexed Date 1)

Generic Indexed Date 1

frIndexedDate2
string (Generic Indexed Date 2)

Generic Indexed Date 2

frIndexedDate3
string (Generic Indexed Date 3)

Generic Indexed Date 3

frIndexedDate4
string (Generic Indexed Date 4)

Generic Indexed Date 4

frIndexedDate5
string (Generic Indexed Date 5)

Generic Indexed Date 5

frIndexedInteger1
number <double> (Generic Indexed Integer 1)

Generic Indexed Integer 1

frIndexedInteger2
number <double> (Generic Indexed Integer 2)

Generic Indexed Integer 2

frIndexedInteger3
number <double> (Generic Indexed Integer 3)

Generic Indexed Integer 3

frIndexedInteger4
number <double> (Generic Indexed Integer 4)

Generic Indexed Integer 4

frIndexedInteger5
number <double> (Generic Indexed Integer 5)

Generic Indexed Integer 5

frIndexedMultivalued1
Array of strings (Generic Indexed Multivalue 1)

Generic Indexed Multivalue 1

frIndexedMultivalued2
Array of strings (Generic Indexed Multivalue 2)

Generic Indexed Multivalue 2

frIndexedMultivalued3
Array of strings (Generic Indexed Multivalue 3)

Generic Indexed Multivalue 3

frIndexedMultivalued4
Array of strings (Generic Indexed Multivalue 4)

Generic Indexed Multivalue 4

frIndexedMultivalued5
Array of strings (Generic Indexed Multivalue 5)

Generic Indexed Multivalue 5

frIndexedString1
string (Generic Indexed String 1)

Generic Indexed String 1

frIndexedString2
string (Generic Indexed String 2)

Generic Indexed String 2

frIndexedString3
string (Generic Indexed String 3)

Generic Indexed String 3

frIndexedString4
string (Generic Indexed String 4)

Generic Indexed String 4

frIndexedString5
string (Generic Indexed String 5)

Generic Indexed String 5

frUnindexedDate1
string (Generic Unindexed Date 1)

Generic Unindexed Date 1

frUnindexedDate2
string (Generic Unindexed Date 2)

Generic Unindexed Date 2

frUnindexedDate3
string (Generic Unindexed Date 3)

Generic Unindexed Date 3

frUnindexedDate4
string (Generic Unindexed Date 4)

Generic Unindexed Date 4

frUnindexedDate5
string (Generic Unindexed Date 5)

Generic Unindexed Date 5

frUnindexedInteger1
number <double> (Generic Unindexed Integer 1)

Generic Unindexed Integer 1

frUnindexedInteger2
number <double> (Generic Unindexed Integer 2)

Generic Unindexed Integer 2

frUnindexedInteger3
number <double> (Generic Unindexed Integer 3)

Generic Unindexed Integer 3

frUnindexedInteger4
number <double> (Generic Unindexed Integer 4)

Generic Unindexed Integer 4

frUnindexedInteger5
number <double> (Generic Unindexed Integer 5)

Generic Unindexed Integer 5

frUnindexedMultivalued1
Array of strings (Generic Unindexed Multivalue 1)

Generic Unindexed Multivalue 1

frUnindexedMultivalued2
Array of strings (Generic Unindexed Multivalue 2)

Generic Unindexed Multivalue 2

frUnindexedMultivalued3
Array of strings (Generic Unindexed Multivalue 3)

Generic Unindexed Multivalue 3

frUnindexedMultivalued4
Array of strings (Generic Unindexed Multivalue 4)

Generic Unindexed Multivalue 4

frUnindexedMultivalued5
Array of strings (Generic Unindexed Multivalue 5)

Generic Unindexed Multivalue 5

frUnindexedString1
string (Generic Unindexed String 1)

Generic Unindexed String 1

frUnindexedString2
string (Generic Unindexed String 2)

Generic Unindexed String 2

frUnindexedString3
string (Generic Unindexed String 3)

Generic Unindexed String 3

frUnindexedString4
string (Generic Unindexed String 4)

Generic Unindexed String 4

frUnindexedString5
string (Generic Unindexed String 5)

Generic Unindexed String 5

givenName
required
string (First Name)

First Name

Array of objects (Groups)

Groups

Array of objects (KBA Info Items)

KBA Info

object (Last Sync timestamp)

Last Sync timestamp

mail
required
string (Email Address)

Email Address

object (Manager)

Manager

Array of objects (Organizations to which I Belong)
memberOfOrgIDs
Array of strings (MemberOfOrgIDs)
Array of objects (Applications I Own)
Array of objects (Organizations I Own)
password
string (Password)

Password

passwordExpirationTime
string (Password Expiration Time)

Password Expiration Time

passwordLastChangedTime
string (Password Last Changed Time)

Password Last Changed Time

postalAddress
string (Address 1)

Address 1

postalCode
string (Postal Code)

Postal Code

object (Preferences)

Preferences

profileImage
string (Profile Image)

Profile Image

Array of objects (Direct Reports)

Direct Reports

Array of objects (Provisioning Roles)

Provisioning Roles

sn
required
string (Last Name)

Last Name

stateProvince
string (State/Province)

State/Province

telephoneNumber
string (Telephone Number) ^\+?([0-9\- \(\)])*$

Telephone Number

userName
required
string (Username) non-empty

Username

Responses

Request samples

Content type
{
  • "_id": "string",
  • "_meta": {
    },
  • "_notifications": [
    ],
  • "accountStatus": "active",
  • "adminOfOrg": [
    ],
  • "aliasList": [
    ],
  • "applications": [
    ],
  • "assignedDashboard": [
    ],
  • "assignments": [
    ],
  • "authzRoles": [
    ],
  • "city": "string",
  • "cn": "{{givenName}} {{sn}}",
  • "consentedMappings": [
    ],
  • "country": "string",
  • "description": "string",
  • "effectiveApplications": [
    ],
  • "effectiveAssignments": [
    ],
  • "effectiveGroups": [
    ],
  • "effectiveRoles": [
    ],
  • "frIndexedDate1": "string",
  • "frIndexedDate2": "string",
  • "frIndexedDate3": "string",
  • "frIndexedDate4": "string",
  • "frIndexedDate5": "string",
  • "frIndexedInteger1": 0.1,
  • "frIndexedInteger2": 0.1,
  • "frIndexedInteger3": 0.1,
  • "frIndexedInteger4": 0.1,
  • "frIndexedInteger5": 0.1,
  • "frIndexedMultivalued1": [
    ],
  • "frIndexedMultivalued2": [
    ],
  • "frIndexedMultivalued3": [
    ],
  • "frIndexedMultivalued4": [
    ],
  • "frIndexedMultivalued5": [
    ],
  • "frIndexedString1": "string",
  • "frIndexedString2": "string",
  • "frIndexedString3": "string",
  • "frIndexedString4": "string",
  • "frIndexedString5": "string",
  • "frUnindexedDate1": "string",
  • "frUnindexedDate2": "string",
  • "frUnindexedDate3": "string",
  • "frUnindexedDate4": "string",
  • "frUnindexedDate5": "string",
  • "frUnindexedInteger1": 0.1,
  • "frUnindexedInteger2": 0.1,
  • "frUnindexedInteger3": 0.1,
  • "frUnindexedInteger4": 0.1,
  • "frUnindexedInteger5": 0.1,
  • "frUnindexedMultivalued1": [
    ],
  • "frUnindexedMultivalued2": [
    ],
  • "frUnindexedMultivalued3": [
    ],
  • "frUnindexedMultivalued4": [
    ],
  • "frUnindexedMultivalued5": [
    ],
  • "frUnindexedString1": "string",
  • "frUnindexedString2": "string",
  • "frUnindexedString3": "string",
  • "frUnindexedString4": "string",
  • "frUnindexedString5": "string",
  • "givenName": "string",
  • "groups": [
    ],
  • "kbaInfo": [
    ],
  • "lastSync": {
    },
  • "mail": "string",
  • "manager": {
    },
  • "memberOfOrg": [
    ],
  • "memberOfOrgIDs": [
    ],
  • "ownerOfApp": [
    ],
  • "ownerOfOrg": [
    ],
  • "password": "string",
  • "passwordExpirationTime": "string",
  • "passwordLastChangedTime": "string",
  • "postalAddress": "string",
  • "postalCode": "string",
  • "preferences": {
    },
  • "profileImage": "string",
  • "reports": [
    ],
  • "roles": [
    ],
  • "sn": "string",
  • "stateProvince": "string",
  • "telephoneNumber": "string",
  • "userName": "string"
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_meta": {
    },
  • "_notifications": [
    ],
  • "accountStatus": "active",
  • "adminOfOrg": [
    ],
  • "aliasList": [
    ],
  • "applications": [
    ],
  • "assignedDashboard": [
    ],
  • "assignments": [
    ],
  • "authzRoles": [
    ],
  • "city": "string",
  • "cn": "{{givenName}} {{sn}}",
  • "consentedMappings": [
    ],
  • "country": "string",
  • "description": "string",
  • "effectiveApplications": [
    ],
  • "effectiveAssignments": [
    ],
  • "effectiveGroups": [
    ],
  • "effectiveRoles": [
    ],
  • "frIndexedDate1": "string",
  • "frIndexedDate2": "string",
  • "frIndexedDate3": "string",
  • "frIndexedDate4": "string",
  • "frIndexedDate5": "string",
  • "frIndexedInteger1": 0.1,
  • "frIndexedInteger2": 0.1,
  • "frIndexedInteger3": 0.1,
  • "frIndexedInteger4": 0.1,
  • "frIndexedInteger5": 0.1,
  • "frIndexedMultivalued1": [
    ],
  • "frIndexedMultivalued2": [
    ],
  • "frIndexedMultivalued3": [
    ],
  • "frIndexedMultivalued4": [
    ],
  • "frIndexedMultivalued5": [
    ],
  • "frIndexedString1": "string",
  • "frIndexedString2": "string",
  • "frIndexedString3": "string",
  • "frIndexedString4": "string",
  • "frIndexedString5": "string",
  • "frUnindexedDate1": "string",
  • "frUnindexedDate2": "string",
  • "frUnindexedDate3": "string",
  • "frUnindexedDate4": "string",
  • "frUnindexedDate5": "string",
  • "frUnindexedInteger1": 0.1,
  • "frUnindexedInteger2": 0.1,
  • "frUnindexedInteger3": 0.1,
  • "frUnindexedInteger4": 0.1,
  • "frUnindexedInteger5": 0.1,
  • "frUnindexedMultivalued1": [
    ],
  • "frUnindexedMultivalued2": [
    ],
  • "frUnindexedMultivalued3": [
    ],
  • "frUnindexedMultivalued4": [
    ],
  • "frUnindexedMultivalued5": [
    ],
  • "frUnindexedString1": "string",
  • "frUnindexedString2": "string",
  • "frUnindexedString3": "string",
  • "frUnindexedString4": "string",
  • "frUnindexedString5": "string",
  • "givenName": "string",
  • "groups": [
    ],
  • "kbaInfo": [
    ],
  • "lastSync": {
    },
  • "mail": "string",
  • "manager": {
    },
  • "memberOfOrg": [
    ],
  • "memberOfOrgIDs": [
    ],
  • "ownerOfApp": [
    ],
  • "ownerOfOrg": [
    ],
  • "password": "string",
  • "passwordExpirationTime": "string",
  • "passwordLastChangedTime": "string",
  • "postalAddress": "string",
  • "postalCode": "string",
  • "preferences": {
    },
  • "profileImage": "string",
  • "reports": [
    ],
  • "roles": [
    ],
  • "sn": "string",
  • "stateProvince": "string",
  • "telephoneNumber": "string",
  • "userName": "string"
}

Bravo realm - Application - Members v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_applicationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Group Members Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_applicationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_applicationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_applicationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_applicationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Group Members Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_applicationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_applicationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_applicationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_applicationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Group Members Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Bravo realm - Application - Owners v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_applicationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object (Application _refProperties)

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_applicationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_applicationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_applicationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_applicationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object (Application _refProperties)

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_applicationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_applicationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_applicationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_applicationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object (Application _refProperties)

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Bravo realm - Application - Roles v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_applicationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_applicationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_applicationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_applicationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_applicationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_applicationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_applicationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_applicationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_applicationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Bravo realm - Application v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_id
string

Application ID

authoritative
boolean (Authoritative)

Is this an authoritative application

connectorId
string (Connector ID)

Id of the connector associated with the application

description
string (Description)

Application Description

icon
string (Icon)
mappingNames
Array of strings (Sync Mapping Names)

Names of the sync mappings used by an application with provisioning configured.

Array of objects (Members)

Application Members

name
required
string (Name)

Application name

Array of objects (Owners)

Application Owners

Array of objects (Roles)

Roles granting users the application

object (SSO Entity Id)

SSO Entity Id

templateName
string (Template Name)

Name of the template the application was created from

templateVersion
string (Template Version)

The template version

uiConfig
object (UI Config)

UI Config

url
string (Url)

Responses

Request samples

Content type
{
  • "_id": "string",
  • "authoritative": true,
  • "connectorId": "string",
  • "description": "string",
  • "icon": "string",
  • "mappingNames": [
    ],
  • "members": [
    ],
  • "name": "string",
  • "owners": [
    ],
  • "roles": [
    ],
  • "ssoEntities": {
    },
  • "templateName": "string",
  • "templateVersion": "string",
  • "uiConfig": { },
  • "url": "string"
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "authoritative": true,
  • "connectorId": "string",
  • "description": "string",
  • "icon": "string",
  • "mappingNames": [
    ],
  • "members": [
    ],
  • "name": "string",
  • "owners": [
    ],
  • "roles": [
    ],
  • "ssoEntities": {
    },
  • "templateName": "string",
  • "templateVersion": "string",
  • "uiConfig": { },
  • "url": "string"
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Action: triggerSyncCheck

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_applicationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "triggerSyncCheck"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_applicationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_id
string

Application ID

authoritative
boolean (Authoritative)

Is this an authoritative application

connectorId
string (Connector ID)

Id of the connector associated with the application

description
string (Description)

Application Description

icon
string (Icon)
mappingNames
Array of strings (Sync Mapping Names)

Names of the sync mappings used by an application with provisioning configured.

Array of objects (Members)

Application Members

name
required
string (Name)

Application name

Array of objects (Owners)

Application Owners

Array of objects (Roles)

Roles granting users the application

object (SSO Entity Id)

SSO Entity Id

templateName
string (Template Name)

Name of the template the application was created from

templateVersion
string (Template Version)

The template version

uiConfig
object (UI Config)

UI Config

url
string (Url)

Responses

Request samples

Content type
{
  • "_id": "string",
  • "authoritative": true,
  • "connectorId": "string",
  • "description": "string",
  • "icon": "string",
  • "mappingNames": [
    ],
  • "members": [
    ],
  • "name": "string",
  • "owners": [
    ],
  • "roles": [
    ],
  • "ssoEntities": {
    },
  • "templateName": "string",
  • "templateVersion": "string",
  • "uiConfig": { },
  • "url": "string"
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "authoritative": true,
  • "connectorId": "string",
  • "description": "string",
  • "icon": "string",
  • "mappingNames": [
    ],
  • "members": [
    ],
  • "name": "string",
  • "owners": [
    ],
  • "roles": [
    ],
  • "ssoEntities": {
    },
  • "templateName": "string",
  • "templateVersion": "string",
  • "uiConfig": { },
  • "url": "string"
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_applicationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "authoritative": true,
  • "connectorId": "string",
  • "description": "string",
  • "icon": "string",
  • "mappingNames": [
    ],
  • "members": [
    ],
  • "name": "string",
  • "owners": [
    ],
  • "roles": [
    ],
  • "ssoEntities": {
    },
  • "templateName": "string",
  • "templateVersion": "string",
  • "uiConfig": { },
  • "url": "string"
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_applicationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_id": "string",
  • "authoritative": true,
  • "connectorId": "string",
  • "description": "string",
  • "icon": "string",
  • "mappingNames": [
    ],
  • "members": [
    ],
  • "name": "string",
  • "owners": [
    ],
  • "roles": [
    ],
  • "ssoEntities": {
    },
  • "templateName": "string",
  • "templateVersion": "string",
  • "uiConfig": { },
  • "url": "string"
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_applicationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "authoritative": true,
  • "connectorId": "string",
  • "description": "string",
  • "icon": "string",
  • "mappingNames": [
    ],
  • "members": [
    ],
  • "name": "string",
  • "owners": [
    ],
  • "roles": [
    ],
  • "ssoEntities": {
    },
  • "templateName": "string",
  • "templateVersion": "string",
  • "uiConfig": { },
  • "url": "string"
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_applicationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_id
string

Application ID

authoritative
boolean (Authoritative)

Is this an authoritative application

connectorId
string (Connector ID)

Id of the connector associated with the application

description
string (Description)

Application Description

icon
string (Icon)
mappingNames
Array of strings (Sync Mapping Names)

Names of the sync mappings used by an application with provisioning configured.

Array of objects (Members)

Application Members

name
required
string (Name)

Application name

Array of objects (Owners)

Application Owners

Array of objects (Roles)

Roles granting users the application

object (SSO Entity Id)

SSO Entity Id

templateName
string (Template Name)

Name of the template the application was created from

templateVersion
string (Template Version)

The template version

uiConfig
object (UI Config)

UI Config

url
string (Url)

Responses

Request samples

Content type
{
  • "_id": "string",
  • "authoritative": true,
  • "connectorId": "string",
  • "description": "string",
  • "icon": "string",
  • "mappingNames": [
    ],
  • "members": [
    ],
  • "name": "string",
  • "owners": [
    ],
  • "roles": [
    ],
  • "ssoEntities": {
    },
  • "templateName": "string",
  • "templateVersion": "string",
  • "uiConfig": { },
  • "url": "string"
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "authoritative": true,
  • "connectorId": "string",
  • "description": "string",
  • "icon": "string",
  • "mappingNames": [
    ],
  • "members": [
    ],
  • "name": "string",
  • "owners": [
    ],
  • "roles": [
    ],
  • "ssoEntities": {
    },
  • "templateName": "string",
  • "templateVersion": "string",
  • "uiConfig": { },
  • "url": "string"
}

Bravo realm - Assignment - Assignment Members v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_assignmentId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Assignment Members Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_assignmentId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_assignmentId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_assignmentId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_assignmentId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Assignment Members Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_assignmentId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_assignmentId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_assignmentId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_assignmentId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Assignment Members Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Bravo realm - Assignment - Managed Roles v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_assignmentId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Managed Roles Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_assignmentId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_assignmentId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_assignmentId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_assignmentId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Managed Roles Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_assignmentId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_assignmentId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_assignmentId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_assignmentId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Managed Roles Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Bravo realm - Assignment v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_id
string (Name)

The assignment ID

Array of objects (Assignment Attributes)

The attributes operated on by this assignment.

condition
string (Condition)

A conditional filter for this assignment

description
required
string (Description)

The assignment description, used for display purposes.

linkQualifiers
Array of strings (Link Qualifiers)

Conditional link qualifiers to restrict this assignment to.

mapping
required
string (Mapping)

The name of the mapping this assignment applies to

Array of objects (Assignment Members)

Assignment Members

name
required
string (Name)

The assignment name, used for display purposes.

Array of objects (Managed Roles)

Managed Roles

type
string (Type)

The type of object this assignment represents

weight
number <double> (Weight)

The weight of the assignment.

Responses

Request samples

Content type
{
  • "_id": "string",
  • "attributes": [
    ],
  • "condition": "string",
  • "description": "string",
  • "linkQualifiers": [
    ],
  • "mapping": "string",
  • "members": [
    ],
  • "name": "string",
  • "roles": [
    ],
  • "type": "string",
  • "weight": 0.1
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "attributes": [
    ],
  • "condition": "string",
  • "description": "string",
  • "linkQualifiers": [
    ],
  • "mapping": "string",
  • "members": [
    ],
  • "name": "string",
  • "roles": [
    ],
  • "type": "string",
  • "weight": 0.1
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Action: triggerSyncCheck

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_assignmentId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "triggerSyncCheck"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_assignmentId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_id
string (Name)

The assignment ID

Array of objects (Assignment Attributes)

The attributes operated on by this assignment.

condition
string (Condition)

A conditional filter for this assignment

description
required
string (Description)

The assignment description, used for display purposes.

linkQualifiers
Array of strings (Link Qualifiers)

Conditional link qualifiers to restrict this assignment to.

mapping
required
string (Mapping)

The name of the mapping this assignment applies to

Array of objects (Assignment Members)

Assignment Members

name
required
string (Name)

The assignment name, used for display purposes.

Array of objects (Managed Roles)

Managed Roles

type
string (Type)

The type of object this assignment represents

weight
number <double> (Weight)

The weight of the assignment.

Responses

Request samples

Content type
{
  • "_id": "string",
  • "attributes": [
    ],
  • "condition": "string",
  • "description": "string",
  • "linkQualifiers": [
    ],
  • "mapping": "string",
  • "members": [
    ],
  • "name": "string",
  • "roles": [
    ],
  • "type": "string",
  • "weight": 0.1
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "attributes": [
    ],
  • "condition": "string",
  • "description": "string",
  • "linkQualifiers": [
    ],
  • "mapping": "string",
  • "members": [
    ],
  • "name": "string",
  • "roles": [
    ],
  • "type": "string",
  • "weight": 0.1
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_assignmentId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "attributes": [
    ],
  • "condition": "string",
  • "description": "string",
  • "linkQualifiers": [
    ],
  • "mapping": "string",
  • "members": [
    ],
  • "name": "string",
  • "roles": [
    ],
  • "type": "string",
  • "weight": 0.1
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_assignmentId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_id": "string",
  • "attributes": [
    ],
  • "condition": "string",
  • "description": "string",
  • "linkQualifiers": [
    ],
  • "mapping": "string",
  • "members": [
    ],
  • "name": "string",
  • "roles": [
    ],
  • "type": "string",
  • "weight": 0.1
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_assignmentId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "attributes": [
    ],
  • "condition": "string",
  • "description": "string",
  • "linkQualifiers": [
    ],
  • "mapping": "string",
  • "members": [
    ],
  • "name": "string",
  • "roles": [
    ],
  • "type": "string",
  • "weight": 0.1
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_assignmentId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_id
string (Name)

The assignment ID

Array of objects (Assignment Attributes)

The attributes operated on by this assignment.

condition
string (Condition)

A conditional filter for this assignment

description
required
string (Description)

The assignment description, used for display purposes.

linkQualifiers
Array of strings (Link Qualifiers)

Conditional link qualifiers to restrict this assignment to.

mapping
required
string (Mapping)

The name of the mapping this assignment applies to

Array of objects (Assignment Members)

Assignment Members

name
required
string (Name)

The assignment name, used for display purposes.

Array of objects (Managed Roles)

Managed Roles

type
string (Type)

The type of object this assignment represents

weight
number <double> (Weight)

The weight of the assignment.

Responses

Request samples

Content type
{
  • "_id": "string",
  • "attributes": [
    ],
  • "condition": "string",
  • "description": "string",
  • "linkQualifiers": [
    ],
  • "mapping": "string",
  • "members": [
    ],
  • "name": "string",
  • "roles": [
    ],
  • "type": "string",
  • "weight": 0.1
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "attributes": [
    ],
  • "condition": "string",
  • "description": "string",
  • "linkQualifiers": [
    ],
  • "mapping": "string",
  • "members": [
    ],
  • "name": "string",
  • "roles": [
    ],
  • "type": "string",
  • "weight": 0.1
}

Bravo realm - Organization - Administrators v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_organizationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_organizationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_organizationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_organizationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_organizationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_organizationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_organizationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_organizationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_organizationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Bravo realm - Organization - Child Organizations v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_organizationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_organizationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_organizationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_organizationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_organizationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_organizationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_organizationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_organizationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_organizationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Bravo realm - Organization - Members v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_organizationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_organizationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_organizationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_organizationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_organizationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_organizationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_organizationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_organizationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_organizationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Bravo realm - Organization - Owner v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_organizationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_organizationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_organizationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_organizationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_organizationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_organizationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_organizationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_organizationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_organizationId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Bravo realm - Organization v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
adminIDs
Array of strings (Admin user ids)
Array of objects (Administrators)
Array of objects (Child Organizations)

Child Organizations

description
string (Description)
Array of objects (Members)
name
required
string (Name)
ownerIDs
Array of strings (Owner user ids)
Array of objects (Owner)
object (Parent Organization)

Parent Organization

parentAdminIDs
Array of strings (user ids of parent admins)
parentIDs
Array of strings (parent org ids)
parentOwnerIDs
Array of strings (user ids of parent owners)

Responses

Request samples

Content type
{
  • "adminIDs": [
    ],
  • "admins": [
    ],
  • "children": [
    ],
  • "description": "string",
  • "members": [
    ],
  • "name": "string",
  • "ownerIDs": [
    ],
  • "owners": [
    ],
  • "parent": {
    },
  • "parentAdminIDs": [
    ],
  • "parentIDs": [
    ],
  • "parentOwnerIDs": [
    ]
}

Response samples

Content type
application/json
{
  • "adminIDs": [
    ],
  • "admins": [
    ],
  • "children": [
    ],
  • "description": "string",
  • "members": [
    ],
  • "name": "string",
  • "ownerIDs": [
    ],
  • "owners": [
    ],
  • "parent": {
    },
  • "parentAdminIDs": [
    ],
  • "parentIDs": [
    ],
  • "parentOwnerIDs": [
    ]
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Action: triggerSyncCheck

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_organizationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "triggerSyncCheck"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_organizationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
adminIDs
Array of strings (Admin user ids)
Array of objects (Administrators)
Array of objects (Child Organizations)

Child Organizations

description
string (Description)
Array of objects (Members)
name
required
string (Name)
ownerIDs
Array of strings (Owner user ids)
Array of objects (Owner)
object (Parent Organization)

Parent Organization

parentAdminIDs
Array of strings (user ids of parent admins)
parentIDs
Array of strings (parent org ids)
parentOwnerIDs
Array of strings (user ids of parent owners)

Responses

Request samples

Content type
{
  • "adminIDs": [
    ],
  • "admins": [
    ],
  • "children": [
    ],
  • "description": "string",
  • "members": [
    ],
  • "name": "string",
  • "ownerIDs": [
    ],
  • "owners": [
    ],
  • "parent": {
    },
  • "parentAdminIDs": [
    ],
  • "parentIDs": [
    ],
  • "parentOwnerIDs": [
    ]
}

Response samples

Content type
application/json
{
  • "adminIDs": [
    ],
  • "admins": [
    ],
  • "children": [
    ],
  • "description": "string",
  • "members": [
    ],
  • "name": "string",
  • "ownerIDs": [
    ],
  • "owners": [
    ],
  • "parent": {
    },
  • "parentAdminIDs": [
    ],
  • "parentIDs": [
    ],
  • "parentOwnerIDs": [
    ]
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_organizationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "adminIDs": [
    ],
  • "admins": [
    ],
  • "children": [
    ],
  • "description": "string",
  • "members": [
    ],
  • "name": "string",
  • "ownerIDs": [
    ],
  • "owners": [
    ],
  • "parent": {
    },
  • "parentAdminIDs": [
    ],
  • "parentIDs": [
    ],
  • "parentOwnerIDs": [
    ]
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_organizationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "adminIDs": [
    ],
  • "admins": [
    ],
  • "children": [
    ],
  • "description": "string",
  • "members": [
    ],
  • "name": "string",
  • "ownerIDs": [
    ],
  • "owners": [
    ],
  • "parent": {
    },
  • "parentAdminIDs": [
    ],
  • "parentIDs": [
    ],
  • "parentOwnerIDs": [
    ]
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_organizationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "adminIDs": [
    ],
  • "admins": [
    ],
  • "children": [
    ],
  • "description": "string",
  • "members": [
    ],
  • "name": "string",
  • "ownerIDs": [
    ],
  • "owners": [
    ],
  • "parent": {
    },
  • "parentAdminIDs": [
    ],
  • "parentIDs": [
    ],
  • "parentOwnerIDs": [
    ]
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_organizationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
adminIDs
Array of strings (Admin user ids)
Array of objects (Administrators)
Array of objects (Child Organizations)

Child Organizations

description
string (Description)
Array of objects (Members)
name
required
string (Name)
ownerIDs
Array of strings (Owner user ids)
Array of objects (Owner)
object (Parent Organization)

Parent Organization

parentAdminIDs
Array of strings (user ids of parent admins)
parentIDs
Array of strings (parent org ids)
parentOwnerIDs
Array of strings (user ids of parent owners)

Responses

Request samples

Content type
{
  • "adminIDs": [
    ],
  • "admins": [
    ],
  • "children": [
    ],
  • "description": "string",
  • "members": [
    ],
  • "name": "string",
  • "ownerIDs": [
    ],
  • "owners": [
    ],
  • "parent": {
    },
  • "parentAdminIDs": [
    ],
  • "parentIDs": [
    ],
  • "parentOwnerIDs": [
    ]
}

Response samples

Content type
application/json
{
  • "adminIDs": [
    ],
  • "admins": [
    ],
  • "children": [
    ],
  • "description": "string",
  • "members": [
    ],
  • "name": "string",
  • "ownerIDs": [
    ],
  • "owners": [
    ],
  • "parent": {
    },
  • "parentAdminIDs": [
    ],
  • "parentIDs": [
    ],
  • "parentOwnerIDs": [
    ]
}

Bravo realm - Role - Applications v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_roleId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Role Application Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_roleId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_roleId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_roleId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_roleId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Role Application Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_roleId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_roleId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_roleId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_roleId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Role Application Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Bravo realm - Role - Managed Assignments v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_roleId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Managed Assignments Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_roleId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_roleId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_roleId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_roleId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Managed Assignments Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_roleId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_roleId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_roleId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_roleId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Managed Assignments Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Bravo realm - Role - Role Members v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_roleId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Role Members Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_roleId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_roleId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_roleId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_roleId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Role Members Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_roleId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_roleId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_roleId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_roleId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Role Members Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Bravo realm - Role v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_id
string (Name)

Role ID

Array of objects (Applications)

Role Applications

Array of objects (Managed Assignments)

Managed Assignments

condition
string (Condition)

A conditional filter for this role

description
string (Description)

The role description, used for display purposes.

Array of objects (Role Members)

Role Members

name
required
string (Name)

The role name, used for display purposes.

Array of objects (Temporal Constraints)

An array of temporal constraints for a role

Responses

Request samples

Content type
{
  • "_id": "string",
  • "applications": [
    ],
  • "assignments": [
    ],
  • "condition": "string",
  • "description": "string",
  • "members": [
    ],
  • "name": "string",
  • "temporalConstraints": [
    ]
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "applications": [
    ],
  • "assignments": [
    ],
  • "condition": "string",
  • "description": "string",
  • "members": [
    ],
  • "name": "string",
  • "temporalConstraints": [
    ]
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Action: triggerSyncCheck

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_roleId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "triggerSyncCheck"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_roleId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_id
string (Name)

Role ID

Array of objects (Applications)

Role Applications

Array of objects (Managed Assignments)

Managed Assignments

condition
string (Condition)

A conditional filter for this role

description
string (Description)

The role description, used for display purposes.

Array of objects (Role Members)

Role Members

name
required
string (Name)

The role name, used for display purposes.

Array of objects (Temporal Constraints)

An array of temporal constraints for a role

Responses

Request samples

Content type
{
  • "_id": "string",
  • "applications": [
    ],
  • "assignments": [
    ],
  • "condition": "string",
  • "description": "string",
  • "members": [
    ],
  • "name": "string",
  • "temporalConstraints": [
    ]
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "applications": [
    ],
  • "assignments": [
    ],
  • "condition": "string",
  • "description": "string",
  • "members": [
    ],
  • "name": "string",
  • "temporalConstraints": [
    ]
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_roleId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "applications": [
    ],
  • "assignments": [
    ],
  • "condition": "string",
  • "description": "string",
  • "members": [
    ],
  • "name": "string",
  • "temporalConstraints": [
    ]
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_roleId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_id": "string",
  • "applications": [
    ],
  • "assignments": [
    ],
  • "condition": "string",
  • "description": "string",
  • "members": [
    ],
  • "name": "string",
  • "temporalConstraints": [
    ]
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_roleId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "applications": [
    ],
  • "assignments": [
    ],
  • "condition": "string",
  • "description": "string",
  • "members": [
    ],
  • "name": "string",
  • "temporalConstraints": [
    ]
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_roleId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_id
string (Name)

Role ID

Array of objects (Applications)

Role Applications

Array of objects (Managed Assignments)

Managed Assignments

condition
string (Condition)

A conditional filter for this role

description
string (Description)

The role description, used for display purposes.

Array of objects (Role Members)

Role Members

name
required
string (Name)

The role name, used for display purposes.

Array of objects (Temporal Constraints)

An array of temporal constraints for a role

Responses

Request samples

Content type
{
  • "_id": "string",
  • "applications": [
    ],
  • "assignments": [
    ],
  • "condition": "string",
  • "description": "string",
  • "members": [
    ],
  • "name": "string",
  • "temporalConstraints": [
    ]
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "applications": [
    ],
  • "assignments": [
    ],
  • "condition": "string",
  • "description": "string",
  • "members": [
    ],
  • "name": "string",
  • "temporalConstraints": [
    ]
}

Bravo realm - User - Applications I Own v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Bravo realm - User - Applications v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Groups Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Groups Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Groups Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Bravo realm - User - Assignments v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Provisioning Roles Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Provisioning Roles Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Provisioning Roles Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Bravo realm - User - Authorization Roles v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Authorization Roles Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Authorization Roles Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Authorization Roles Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Bravo realm - User - Direct Reports v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Direct Reports Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Direct Reports Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Direct Reports Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Bravo realm - User - Groups v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Groups Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Groups Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Groups Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Bravo realm - User - Notifications v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Notifications _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Notifications _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Notifications _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Bravo realm - User - Organizations I Administer v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Bravo realm - User - Organizations I Own v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Bravo realm - User - Organizations to which I Belong v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string
object

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Bravo realm - User - Provisioning Roles v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Provisioning Roles Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Provisioning Roles Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Provisioning Roles Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Bravo realm - User v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_id
string

User ID

object (Metadata)

Metadata for managed/bravo_usermeta

Array of objects (Notifications)

Notifications

accountStatus
string (Status)
Default: "active"

Status

Array of objects (Organizations I Administer)
aliasList
Array of strings (User Alias Names List)

List of identity aliases used primarily to record social IdP subjects for this user

Array of objects (Applications)

Applications

assignedDashboard
Array of strings (Assigned Dashboard)

List of items to click on for this user

Array of objects (Assignments)

Assignments

Array of objects (Authorization Roles)

Authorization Roles

city
string (City)

City

cn
string (Common Name)
Default: "{{givenName}} {{sn}}"

Common Name

Array of objects (Consented Mappings) [ items ]

Consented Mappings

country
string (Country)

Country

description
string (Description)

Description

effectiveApplications
Array of objects (Effective Applications)

Effective Applications

effectiveAssignments
Array of objects (Effective Assignments)

Effective Assignments

effectiveGroups
Array of objects (Effective Groups)

Effective Groups

effectiveRoles
Array of objects (Effective Roles)

Effective Roles

frIndexedDate1
string (Generic Indexed Date 1)

Generic Indexed Date 1

frIndexedDate2
string (Generic Indexed Date 2)

Generic Indexed Date 2

frIndexedDate3
string (Generic Indexed Date 3)

Generic Indexed Date 3

frIndexedDate4
string (Generic Indexed Date 4)

Generic Indexed Date 4

frIndexedDate5
string (Generic Indexed Date 5)

Generic Indexed Date 5

frIndexedInteger1
number <double> (Generic Indexed Integer 1)

Generic Indexed Integer 1

frIndexedInteger2
number <double> (Generic Indexed Integer 2)

Generic Indexed Integer 2

frIndexedInteger3
number <double> (Generic Indexed Integer 3)

Generic Indexed Integer 3

frIndexedInteger4
number <double> (Generic Indexed Integer 4)

Generic Indexed Integer 4

frIndexedInteger5
number <double> (Generic Indexed Integer 5)

Generic Indexed Integer 5

frIndexedMultivalued1
Array of strings (Generic Indexed Multivalue 1)

Generic Indexed Multivalue 1

frIndexedMultivalued2
Array of strings (Generic Indexed Multivalue 2)

Generic Indexed Multivalue 2

frIndexedMultivalued3
Array of strings (Generic Indexed Multivalue 3)

Generic Indexed Multivalue 3

frIndexedMultivalued4
Array of strings (Generic Indexed Multivalue 4)

Generic Indexed Multivalue 4

frIndexedMultivalued5
Array of strings (Generic Indexed Multivalue 5)

Generic Indexed Multivalue 5

frIndexedString1
string (Generic Indexed String 1)

Generic Indexed String 1

frIndexedString2
string (Generic Indexed String 2)

Generic Indexed String 2

frIndexedString3
string (Generic Indexed String 3)

Generic Indexed String 3

frIndexedString4
string (Generic Indexed String 4)

Generic Indexed String 4

frIndexedString5
string (Generic Indexed String 5)

Generic Indexed String 5

frUnindexedDate1
string (Generic Unindexed Date 1)

Generic Unindexed Date 1

frUnindexedDate2
string (Generic Unindexed Date 2)

Generic Unindexed Date 2

frUnindexedDate3
string (Generic Unindexed Date 3)

Generic Unindexed Date 3

frUnindexedDate4
string (Generic Unindexed Date 4)

Generic Unindexed Date 4

frUnindexedDate5
string (Generic Unindexed Date 5)

Generic Unindexed Date 5

frUnindexedInteger1
number <double> (Generic Unindexed Integer 1)

Generic Unindexed Integer 1

frUnindexedInteger2
number <double> (Generic Unindexed Integer 2)

Generic Unindexed Integer 2

frUnindexedInteger3
number <double> (Generic Unindexed Integer 3)

Generic Unindexed Integer 3

frUnindexedInteger4
number <double> (Generic Unindexed Integer 4)

Generic Unindexed Integer 4

frUnindexedInteger5
number <double> (Generic Unindexed Integer 5)

Generic Unindexed Integer 5

frUnindexedMultivalued1
Array of strings (Generic Unindexed Multivalue 1)

Generic Unindexed Multivalue 1

frUnindexedMultivalued2
Array of strings (Generic Unindexed Multivalue 2)

Generic Unindexed Multivalue 2

frUnindexedMultivalued3
Array of strings (Generic Unindexed Multivalue 3)

Generic Unindexed Multivalue 3

frUnindexedMultivalued4
Array of strings (Generic Unindexed Multivalue 4)

Generic Unindexed Multivalue 4

frUnindexedMultivalued5
Array of strings (Generic Unindexed Multivalue 5)

Generic Unindexed Multivalue 5

frUnindexedString1
string (Generic Unindexed String 1)

Generic Unindexed String 1

frUnindexedString2
string (Generic Unindexed String 2)

Generic Unindexed String 2

frUnindexedString3
string (Generic Unindexed String 3)

Generic Unindexed String 3

frUnindexedString4
string (Generic Unindexed String 4)

Generic Unindexed String 4

frUnindexedString5
string (Generic Unindexed String 5)

Generic Unindexed String 5

givenName
required
string (First Name)

First Name

Array of objects (Groups)

Groups

Array of objects (KBA Info Items)

KBA Info

object (Last Sync timestamp)

Last Sync timestamp

mail
required
string (Email Address)

Email Address

object (Manager)

Manager

Array of objects (Organizations to which I Belong)
memberOfOrgIDs
Array of strings (MemberOfOrgIDs)
Array of objects (Applications I Own)
Array of objects (Organizations I Own)
password
string (Password)

Password

passwordExpirationTime
string (Password Expiration Time)

Password Expiration Time

passwordLastChangedTime
string (Password Last Changed Time)

Password Last Changed Time

postalAddress
string (Address 1)

Address 1

postalCode
string (Postal Code)

Postal Code

object (Preferences)

Preferences

profileImage
string (Profile Image)

Profile Image

Array of objects (Direct Reports)

Direct Reports

Array of objects (Provisioning Roles)

Provisioning Roles

sn
required
string (Last Name)

Last Name

stateProvince
string (State/Province)

State/Province

telephoneNumber
string (Telephone Number) ^\+?([0-9\- \(\)])*$

Telephone Number

userName
required
string (Username) non-empty

Username

Responses

Request samples

Content type
{
  • "_id": "string",
  • "_meta": {
    },
  • "_notifications": [
    ],
  • "accountStatus": "active",
  • "adminOfOrg": [
    ],
  • "aliasList": [
    ],
  • "applications": [
    ],
  • "assignedDashboard": [
    ],
  • "assignments": [
    ],
  • "authzRoles": [
    ],
  • "city": "string",
  • "cn": "{{givenName}} {{sn}}",
  • "consentedMappings": [
    ],
  • "country": "string",
  • "description": "string",
  • "effectiveApplications": [
    ],
  • "effectiveAssignments": [
    ],
  • "effectiveGroups": [
    ],
  • "effectiveRoles": [
    ],
  • "frIndexedDate1": "string",
  • "frIndexedDate2": "string",
  • "frIndexedDate3": "string",
  • "frIndexedDate4": "string",
  • "frIndexedDate5": "string",
  • "frIndexedInteger1": 0.1,
  • "frIndexedInteger2": 0.1,
  • "frIndexedInteger3": 0.1,
  • "frIndexedInteger4": 0.1,
  • "frIndexedInteger5": 0.1,
  • "frIndexedMultivalued1": [
    ],
  • "frIndexedMultivalued2": [
    ],
  • "frIndexedMultivalued3": [
    ],
  • "frIndexedMultivalued4": [
    ],
  • "frIndexedMultivalued5": [
    ],
  • "frIndexedString1": "string",
  • "frIndexedString2": "string",
  • "frIndexedString3": "string",
  • "frIndexedString4": "string",
  • "frIndexedString5": "string",
  • "frUnindexedDate1": "string",
  • "frUnindexedDate2": "string",
  • "frUnindexedDate3": "string",
  • "frUnindexedDate4": "string",
  • "frUnindexedDate5": "string",
  • "frUnindexedInteger1": 0.1,
  • "frUnindexedInteger2": 0.1,
  • "frUnindexedInteger3": 0.1,
  • "frUnindexedInteger4": 0.1,
  • "frUnindexedInteger5": 0.1,
  • "frUnindexedMultivalued1": [
    ],
  • "frUnindexedMultivalued2": [
    ],
  • "frUnindexedMultivalued3": [
    ],
  • "frUnindexedMultivalued4": [
    ],
  • "frUnindexedMultivalued5": [
    ],
  • "frUnindexedString1": "string",
  • "frUnindexedString2": "string",
  • "frUnindexedString3": "string",
  • "frUnindexedString4": "string",
  • "frUnindexedString5": "string",
  • "givenName": "string",
  • "groups": [
    ],
  • "kbaInfo": [
    ],
  • "lastSync": {
    },
  • "mail": "string",
  • "manager": {
    },
  • "memberOfOrg": [
    ],
  • "memberOfOrgIDs": [
    ],
  • "ownerOfApp": [
    ],
  • "ownerOfOrg": [
    ],
  • "password": "string",
  • "passwordExpirationTime": "string",
  • "passwordLastChangedTime": "string",
  • "postalAddress": "string",
  • "postalCode": "string",
  • "preferences": {
    },
  • "profileImage": "string",
  • "reports": [
    ],
  • "roles": [
    ],
  • "sn": "string",
  • "stateProvince": "string",
  • "telephoneNumber": "string",
  • "userName": "string"
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_meta": {
    },
  • "_notifications": [
    ],
  • "accountStatus": "active",
  • "adminOfOrg": [
    ],
  • "aliasList": [
    ],
  • "applications": [
    ],
  • "assignedDashboard": [
    ],
  • "assignments": [
    ],
  • "authzRoles": [
    ],
  • "city": "string",
  • "cn": "{{givenName}} {{sn}}",
  • "consentedMappings": [
    ],
  • "country": "string",
  • "description": "string",
  • "effectiveApplications": [
    ],
  • "effectiveAssignments": [
    ],
  • "effectiveGroups": [
    ],
  • "effectiveRoles": [
    ],
  • "frIndexedDate1": "string",
  • "frIndexedDate2": "string",
  • "frIndexedDate3": "string",
  • "frIndexedDate4": "string",
  • "frIndexedDate5": "string",
  • "frIndexedInteger1": 0.1,
  • "frIndexedInteger2": 0.1,
  • "frIndexedInteger3": 0.1,
  • "frIndexedInteger4": 0.1,
  • "frIndexedInteger5": 0.1,
  • "frIndexedMultivalued1": [
    ],
  • "frIndexedMultivalued2": [
    ],
  • "frIndexedMultivalued3": [
    ],
  • "frIndexedMultivalued4": [
    ],
  • "frIndexedMultivalued5": [
    ],
  • "frIndexedString1": "string",
  • "frIndexedString2": "string",
  • "frIndexedString3": "string",
  • "frIndexedString4": "string",
  • "frIndexedString5": "string",
  • "frUnindexedDate1": "string",
  • "frUnindexedDate2": "string",
  • "frUnindexedDate3": "string",
  • "frUnindexedDate4": "string",
  • "frUnindexedDate5": "string",
  • "frUnindexedInteger1": 0.1,
  • "frUnindexedInteger2": 0.1,
  • "frUnindexedInteger3": 0.1,
  • "frUnindexedInteger4": 0.1,
  • "frUnindexedInteger5": 0.1,
  • "frUnindexedMultivalued1": [
    ],
  • "frUnindexedMultivalued2": [
    ],
  • "frUnindexedMultivalued3": [
    ],
  • "frUnindexedMultivalued4": [
    ],
  • "frUnindexedMultivalued5": [
    ],
  • "frUnindexedString1": "string",
  • "frUnindexedString2": "string",
  • "frUnindexedString3": "string",
  • "frUnindexedString4": "string",
  • "frUnindexedString5": "string",
  • "givenName": "string",
  • "groups": [
    ],
  • "kbaInfo": [
    ],
  • "lastSync": {
    },
  • "mail": "string",
  • "manager": {
    },
  • "memberOfOrg": [
    ],
  • "memberOfOrgIDs": [
    ],
  • "ownerOfApp": [
    ],
  • "ownerOfOrg": [
    ],
  • "password": "string",
  • "passwordExpirationTime": "string",
  • "passwordLastChangedTime": "string",
  • "postalAddress": "string",
  • "postalCode": "string",
  • "preferences": {
    },
  • "profileImage": "string",
  • "reports": [
    ],
  • "roles": [
    ],
  • "sn": "string",
  • "stateProvince": "string",
  • "telephoneNumber": "string",
  • "userName": "string"
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Action: triggerSyncCheck

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "triggerSyncCheck"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_id
string

User ID

object (Metadata)

Metadata for managed/bravo_usermeta

Array of objects (Notifications)

Notifications

accountStatus
string (Status)
Default: "active"

Status

Array of objects (Organizations I Administer)
aliasList
Array of strings (User Alias Names List)

List of identity aliases used primarily to record social IdP subjects for this user

Array of objects (Applications)

Applications

assignedDashboard
Array of strings (Assigned Dashboard)

List of items to click on for this user

Array of objects (Assignments)

Assignments

Array of objects (Authorization Roles)

Authorization Roles

city
string (City)

City

cn
string (Common Name)
Default: "{{givenName}} {{sn}}"

Common Name

Array of objects (Consented Mappings) [ items ]

Consented Mappings

country
string (Country)

Country

description
string (Description)

Description

effectiveApplications
Array of objects (Effective Applications)

Effective Applications

effectiveAssignments
Array of objects (Effective Assignments)

Effective Assignments

effectiveGroups
Array of objects (Effective Groups)

Effective Groups

effectiveRoles
Array of objects (Effective Roles)

Effective Roles

frIndexedDate1
string (Generic Indexed Date 1)

Generic Indexed Date 1

frIndexedDate2
string (Generic Indexed Date 2)

Generic Indexed Date 2

frIndexedDate3
string (Generic Indexed Date 3)

Generic Indexed Date 3

frIndexedDate4
string (Generic Indexed Date 4)

Generic Indexed Date 4

frIndexedDate5
string (Generic Indexed Date 5)

Generic Indexed Date 5

frIndexedInteger1
number <double> (Generic Indexed Integer 1)

Generic Indexed Integer 1

frIndexedInteger2
number <double> (Generic Indexed Integer 2)

Generic Indexed Integer 2

frIndexedInteger3
number <double> (Generic Indexed Integer 3)

Generic Indexed Integer 3

frIndexedInteger4
number <double> (Generic Indexed Integer 4)

Generic Indexed Integer 4

frIndexedInteger5
number <double> (Generic Indexed Integer 5)

Generic Indexed Integer 5

frIndexedMultivalued1
Array of strings (Generic Indexed Multivalue 1)

Generic Indexed Multivalue 1

frIndexedMultivalued2
Array of strings (Generic Indexed Multivalue 2)

Generic Indexed Multivalue 2

frIndexedMultivalued3
Array of strings (Generic Indexed Multivalue 3)

Generic Indexed Multivalue 3

frIndexedMultivalued4
Array of strings (Generic Indexed Multivalue 4)

Generic Indexed Multivalue 4

frIndexedMultivalued5
Array of strings (Generic Indexed Multivalue 5)

Generic Indexed Multivalue 5

frIndexedString1
string (Generic Indexed String 1)

Generic Indexed String 1

frIndexedString2
string (Generic Indexed String 2)

Generic Indexed String 2

frIndexedString3
string (Generic Indexed String 3)

Generic Indexed String 3

frIndexedString4
string (Generic Indexed String 4)

Generic Indexed String 4

frIndexedString5
string (Generic Indexed String 5)

Generic Indexed String 5

frUnindexedDate1
string (Generic Unindexed Date 1)

Generic Unindexed Date 1

frUnindexedDate2
string (Generic Unindexed Date 2)

Generic Unindexed Date 2

frUnindexedDate3
string (Generic Unindexed Date 3)

Generic Unindexed Date 3

frUnindexedDate4
string (Generic Unindexed Date 4)

Generic Unindexed Date 4

frUnindexedDate5
string (Generic Unindexed Date 5)

Generic Unindexed Date 5

frUnindexedInteger1
number <double> (Generic Unindexed Integer 1)

Generic Unindexed Integer 1

frUnindexedInteger2
number <double> (Generic Unindexed Integer 2)

Generic Unindexed Integer 2

frUnindexedInteger3
number <double> (Generic Unindexed Integer 3)

Generic Unindexed Integer 3

frUnindexedInteger4
number <double> (Generic Unindexed Integer 4)

Generic Unindexed Integer 4

frUnindexedInteger5
number <double> (Generic Unindexed Integer 5)

Generic Unindexed Integer 5

frUnindexedMultivalued1
Array of strings (Generic Unindexed Multivalue 1)

Generic Unindexed Multivalue 1

frUnindexedMultivalued2
Array of strings (Generic Unindexed Multivalue 2)

Generic Unindexed Multivalue 2

frUnindexedMultivalued3
Array of strings (Generic Unindexed Multivalue 3)

Generic Unindexed Multivalue 3

frUnindexedMultivalued4
Array of strings (Generic Unindexed Multivalue 4)

Generic Unindexed Multivalue 4

frUnindexedMultivalued5
Array of strings (Generic Unindexed Multivalue 5)

Generic Unindexed Multivalue 5

frUnindexedString1
string (Generic Unindexed String 1)

Generic Unindexed String 1

frUnindexedString2
string (Generic Unindexed String 2)

Generic Unindexed String 2

frUnindexedString3
string (Generic Unindexed String 3)

Generic Unindexed String 3

frUnindexedString4
string (Generic Unindexed String 4)

Generic Unindexed String 4

frUnindexedString5
string (Generic Unindexed String 5)

Generic Unindexed String 5

givenName
required
string (First Name)

First Name

Array of objects (Groups)

Groups

Array of objects (KBA Info Items)

KBA Info

object (Last Sync timestamp)

Last Sync timestamp

mail
required
string (Email Address)

Email Address

object (Manager)

Manager

Array of objects (Organizations to which I Belong)
memberOfOrgIDs
Array of strings (MemberOfOrgIDs)
Array of objects (Applications I Own)
Array of objects (Organizations I Own)
password
string (Password)

Password

passwordExpirationTime
string (Password Expiration Time)

Password Expiration Time

passwordLastChangedTime
string (Password Last Changed Time)

Password Last Changed Time

postalAddress
string (Address 1)

Address 1

postalCode
string (Postal Code)

Postal Code

object (Preferences)

Preferences

profileImage
string (Profile Image)

Profile Image

Array of objects (Direct Reports)

Direct Reports

Array of objects (Provisioning Roles)

Provisioning Roles

sn
required
string (Last Name)

Last Name

stateProvince
string (State/Province)

State/Province

telephoneNumber
string (Telephone Number) ^\+?([0-9\- \(\)])*$

Telephone Number

userName
required
string (Username) non-empty

Username

Responses

Request samples

Content type
{
  • "_id": "string",
  • "_meta": {
    },
  • "_notifications": [
    ],
  • "accountStatus": "active",
  • "adminOfOrg": [
    ],
  • "aliasList": [
    ],
  • "applications": [
    ],
  • "assignedDashboard": [
    ],
  • "assignments": [
    ],
  • "authzRoles": [
    ],
  • "city": "string",
  • "cn": "{{givenName}} {{sn}}",
  • "consentedMappings": [
    ],
  • "country": "string",
  • "description": "string",
  • "effectiveApplications": [
    ],
  • "effectiveAssignments": [
    ],
  • "effectiveGroups": [
    ],
  • "effectiveRoles": [
    ],
  • "frIndexedDate1": "string",
  • "frIndexedDate2": "string",
  • "frIndexedDate3": "string",
  • "frIndexedDate4": "string",
  • "frIndexedDate5": "string",
  • "frIndexedInteger1": 0.1,
  • "frIndexedInteger2": 0.1,
  • "frIndexedInteger3": 0.1,
  • "frIndexedInteger4": 0.1,
  • "frIndexedInteger5": 0.1,
  • "frIndexedMultivalued1": [
    ],
  • "frIndexedMultivalued2": [
    ],
  • "frIndexedMultivalued3": [
    ],
  • "frIndexedMultivalued4": [
    ],
  • "frIndexedMultivalued5": [
    ],
  • "frIndexedString1": "string",
  • "frIndexedString2": "string",
  • "frIndexedString3": "string",
  • "frIndexedString4": "string",
  • "frIndexedString5": "string",
  • "frUnindexedDate1": "string",
  • "frUnindexedDate2": "string",
  • "frUnindexedDate3": "string",
  • "frUnindexedDate4": "string",
  • "frUnindexedDate5": "string",
  • "frUnindexedInteger1": 0.1,
  • "frUnindexedInteger2": 0.1,
  • "frUnindexedInteger3": 0.1,
  • "frUnindexedInteger4": 0.1,
  • "frUnindexedInteger5": 0.1,
  • "frUnindexedMultivalued1": [
    ],
  • "frUnindexedMultivalued2": [
    ],
  • "frUnindexedMultivalued3": [
    ],
  • "frUnindexedMultivalued4": [
    ],
  • "frUnindexedMultivalued5": [
    ],
  • "frUnindexedString1": "string",
  • "frUnindexedString2": "string",
  • "frUnindexedString3": "string",
  • "frUnindexedString4": "string",
  • "frUnindexedString5": "string",
  • "givenName": "string",
  • "groups": [
    ],
  • "kbaInfo": [
    ],
  • "lastSync": {
    },
  • "mail": "string",
  • "manager": {
    },
  • "memberOfOrg": [
    ],
  • "memberOfOrgIDs": [
    ],
  • "ownerOfApp": [
    ],
  • "ownerOfOrg": [
    ],
  • "password": "string",
  • "passwordExpirationTime": "string",
  • "passwordLastChangedTime": "string",
  • "postalAddress": "string",
  • "postalCode": "string",
  • "preferences": {
    },
  • "profileImage": "string",
  • "reports": [
    ],
  • "roles": [
    ],
  • "sn": "string",
  • "stateProvince": "string",
  • "telephoneNumber": "string",
  • "userName": "string"
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_meta": {
    },
  • "_notifications": [
    ],
  • "accountStatus": "active",
  • "adminOfOrg": [
    ],
  • "aliasList": [
    ],
  • "applications": [
    ],
  • "assignedDashboard": [
    ],
  • "assignments": [
    ],
  • "authzRoles": [
    ],
  • "city": "string",
  • "cn": "{{givenName}} {{sn}}",
  • "consentedMappings": [
    ],
  • "country": "string",
  • "description": "string",
  • "effectiveApplications": [
    ],
  • "effectiveAssignments": [
    ],
  • "effectiveGroups": [
    ],
  • "effectiveRoles": [
    ],
  • "frIndexedDate1": "string",
  • "frIndexedDate2": "string",
  • "frIndexedDate3": "string",
  • "frIndexedDate4": "string",
  • "frIndexedDate5": "string",
  • "frIndexedInteger1": 0.1,
  • "frIndexedInteger2": 0.1,
  • "frIndexedInteger3": 0.1,
  • "frIndexedInteger4": 0.1,
  • "frIndexedInteger5": 0.1,
  • "frIndexedMultivalued1": [
    ],
  • "frIndexedMultivalued2": [
    ],
  • "frIndexedMultivalued3": [
    ],
  • "frIndexedMultivalued4": [
    ],
  • "frIndexedMultivalued5": [
    ],
  • "frIndexedString1": "string",
  • "frIndexedString2": "string",
  • "frIndexedString3": "string",
  • "frIndexedString4": "string",
  • "frIndexedString5": "string",
  • "frUnindexedDate1": "string",
  • "frUnindexedDate2": "string",
  • "frUnindexedDate3": "string",
  • "frUnindexedDate4": "string",
  • "frUnindexedDate5": "string",
  • "frUnindexedInteger1": 0.1,
  • "frUnindexedInteger2": 0.1,
  • "frUnindexedInteger3": 0.1,
  • "frUnindexedInteger4": 0.1,
  • "frUnindexedInteger5": 0.1,
  • "frUnindexedMultivalued1": [
    ],
  • "frUnindexedMultivalued2": [
    ],
  • "frUnindexedMultivalued3": [
    ],
  • "frUnindexedMultivalued4": [
    ],
  • "frUnindexedMultivalued5": [
    ],
  • "frUnindexedString1": "string",
  • "frUnindexedString2": "string",
  • "frUnindexedString3": "string",
  • "frUnindexedString4": "string",
  • "frUnindexedString5": "string",
  • "givenName": "string",
  • "groups": [
    ],
  • "kbaInfo": [
    ],
  • "lastSync": {
    },
  • "mail": "string",
  • "manager": {
    },
  • "memberOfOrg": [
    ],
  • "memberOfOrgIDs": [
    ],
  • "ownerOfApp": [
    ],
  • "ownerOfOrg": [
    ],
  • "password": "string",
  • "passwordExpirationTime": "string",
  • "passwordLastChangedTime": "string",
  • "postalAddress": "string",
  • "postalCode": "string",
  • "preferences": {
    },
  • "profileImage": "string",
  • "reports": [
    ],
  • "roles": [
    ],
  • "sn": "string",
  • "stateProvince": "string",
  • "telephoneNumber": "string",
  • "userName": "string"
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_meta": {
    },
  • "_notifications": [
    ],
  • "accountStatus": "active",
  • "adminOfOrg": [
    ],
  • "aliasList": [
    ],
  • "applications": [
    ],
  • "assignedDashboard": [
    ],
  • "assignments": [
    ],
  • "authzRoles": [
    ],
  • "city": "string",
  • "cn": "{{givenName}} {{sn}}",
  • "consentedMappings": [
    ],
  • "country": "string",
  • "description": "string",
  • "effectiveApplications": [
    ],
  • "effectiveAssignments": [
    ],
  • "effectiveGroups": [
    ],
  • "effectiveRoles": [
    ],
  • "frIndexedDate1": "string",
  • "frIndexedDate2": "string",
  • "frIndexedDate3": "string",
  • "frIndexedDate4": "string",
  • "frIndexedDate5": "string",
  • "frIndexedInteger1": 0.1,
  • "frIndexedInteger2": 0.1,
  • "frIndexedInteger3": 0.1,
  • "frIndexedInteger4": 0.1,
  • "frIndexedInteger5": 0.1,
  • "frIndexedMultivalued1": [
    ],
  • "frIndexedMultivalued2": [
    ],
  • "frIndexedMultivalued3": [
    ],
  • "frIndexedMultivalued4": [
    ],
  • "frIndexedMultivalued5": [
    ],
  • "frIndexedString1": "string",
  • "frIndexedString2": "string",
  • "frIndexedString3": "string",
  • "frIndexedString4": "string",
  • "frIndexedString5": "string",
  • "frUnindexedDate1": "string",
  • "frUnindexedDate2": "string",
  • "frUnindexedDate3": "string",
  • "frUnindexedDate4": "string",
  • "frUnindexedDate5": "string",
  • "frUnindexedInteger1": 0.1,
  • "frUnindexedInteger2": 0.1,
  • "frUnindexedInteger3": 0.1,
  • "frUnindexedInteger4": 0.1,
  • "frUnindexedInteger5": 0.1,
  • "frUnindexedMultivalued1": [
    ],
  • "frUnindexedMultivalued2": [
    ],
  • "frUnindexedMultivalued3": [
    ],
  • "frUnindexedMultivalued4": [
    ],
  • "frUnindexedMultivalued5": [
    ],
  • "frUnindexedString1": "string",
  • "frUnindexedString2": "string",
  • "frUnindexedString3": "string",
  • "frUnindexedString4": "string",
  • "frUnindexedString5": "string",
  • "givenName": "string",
  • "groups": [
    ],
  • "kbaInfo": [
    ],
  • "lastSync": {
    },
  • "mail": "string",
  • "manager": {
    },
  • "memberOfOrg": [
    ],
  • "memberOfOrgIDs": [
    ],
  • "ownerOfApp": [
    ],
  • "ownerOfOrg": [
    ],
  • "password": "string",
  • "passwordExpirationTime": "string",
  • "passwordLastChangedTime": "string",
  • "postalAddress": "string",
  • "postalCode": "string",
  • "preferences": {
    },
  • "profileImage": "string",
  • "reports": [
    ],
  • "roles": [
    ],
  • "sn": "string",
  • "stateProvince": "string",
  • "telephoneNumber": "string",
  • "userName": "string"
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_meta": {
    },
  • "_notifications": [
    ],
  • "accountStatus": "active",
  • "adminOfOrg": [
    ],
  • "aliasList": [
    ],
  • "applications": [
    ],
  • "assignedDashboard": [
    ],
  • "assignments": [
    ],
  • "authzRoles": [
    ],
  • "city": "string",
  • "cn": "{{givenName}} {{sn}}",
  • "consentedMappings": [
    ],
  • "country": "string",
  • "description": "string",
  • "effectiveApplications": [
    ],
  • "effectiveAssignments": [
    ],
  • "effectiveGroups": [
    ],
  • "effectiveRoles": [
    ],
  • "frIndexedDate1": "string",
  • "frIndexedDate2": "string",
  • "frIndexedDate3": "string",
  • "frIndexedDate4": "string",
  • "frIndexedDate5": "string",
  • "frIndexedInteger1": 0.1,
  • "frIndexedInteger2": 0.1,
  • "frIndexedInteger3": 0.1,
  • "frIndexedInteger4": 0.1,
  • "frIndexedInteger5": 0.1,
  • "frIndexedMultivalued1": [
    ],
  • "frIndexedMultivalued2": [
    ],
  • "frIndexedMultivalued3": [
    ],
  • "frIndexedMultivalued4": [
    ],
  • "frIndexedMultivalued5": [
    ],
  • "frIndexedString1": "string",
  • "frIndexedString2": "string",
  • "frIndexedString3": "string",
  • "frIndexedString4": "string",
  • "frIndexedString5": "string",
  • "frUnindexedDate1": "string",
  • "frUnindexedDate2": "string",
  • "frUnindexedDate3": "string",
  • "frUnindexedDate4": "string",
  • "frUnindexedDate5": "string",
  • "frUnindexedInteger1": 0.1,
  • "frUnindexedInteger2": 0.1,
  • "frUnindexedInteger3": 0.1,
  • "frUnindexedInteger4": 0.1,
  • "frUnindexedInteger5": 0.1,
  • "frUnindexedMultivalued1": [
    ],
  • "frUnindexedMultivalued2": [
    ],
  • "frUnindexedMultivalued3": [
    ],
  • "frUnindexedMultivalued4": [
    ],
  • "frUnindexedMultivalued5": [
    ],
  • "frUnindexedString1": "string",
  • "frUnindexedString2": "string",
  • "frUnindexedString3": "string",
  • "frUnindexedString4": "string",
  • "frUnindexedString5": "string",
  • "givenName": "string",
  • "groups": [
    ],
  • "kbaInfo": [
    ],
  • "lastSync": {
    },
  • "mail": "string",
  • "manager": {
    },
  • "memberOfOrg": [
    ],
  • "memberOfOrgIDs": [
    ],
  • "ownerOfApp": [
    ],
  • "ownerOfOrg": [
    ],
  • "password": "string",
  • "passwordExpirationTime": "string",
  • "passwordLastChangedTime": "string",
  • "postalAddress": "string",
  • "postalCode": "string",
  • "preferences": {
    },
  • "profileImage": "string",
  • "reports": [
    ],
  • "roles": [
    ],
  • "sn": "string",
  • "stateProvince": "string",
  • "telephoneNumber": "string",
  • "userName": "string"
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_meta": {
    },
  • "_notifications": [
    ],
  • "accountStatus": "active",
  • "adminOfOrg": [
    ],
  • "aliasList": [
    ],
  • "applications": [
    ],
  • "assignedDashboard": [
    ],
  • "assignments": [
    ],
  • "authzRoles": [
    ],
  • "city": "string",
  • "cn": "{{givenName}} {{sn}}",
  • "consentedMappings": [
    ],
  • "country": "string",
  • "description": "string",
  • "effectiveApplications": [
    ],
  • "effectiveAssignments": [
    ],
  • "effectiveGroups": [
    ],
  • "effectiveRoles": [
    ],
  • "frIndexedDate1": "string",
  • "frIndexedDate2": "string",
  • "frIndexedDate3": "string",
  • "frIndexedDate4": "string",
  • "frIndexedDate5": "string",
  • "frIndexedInteger1": 0.1,
  • "frIndexedInteger2": 0.1,
  • "frIndexedInteger3": 0.1,
  • "frIndexedInteger4": 0.1,
  • "frIndexedInteger5": 0.1,
  • "frIndexedMultivalued1": [
    ],
  • "frIndexedMultivalued2": [
    ],
  • "frIndexedMultivalued3": [
    ],
  • "frIndexedMultivalued4": [
    ],
  • "frIndexedMultivalued5": [
    ],
  • "frIndexedString1": "string",
  • "frIndexedString2": "string",
  • "frIndexedString3": "string",
  • "frIndexedString4": "string",
  • "frIndexedString5": "string",
  • "frUnindexedDate1": "string",
  • "frUnindexedDate2": "string",
  • "frUnindexedDate3": "string",
  • "frUnindexedDate4": "string",
  • "frUnindexedDate5": "string",
  • "frUnindexedInteger1": 0.1,
  • "frUnindexedInteger2": 0.1,
  • "frUnindexedInteger3": 0.1,
  • "frUnindexedInteger4": 0.1,
  • "frUnindexedInteger5": 0.1,
  • "frUnindexedMultivalued1": [
    ],
  • "frUnindexedMultivalued2": [
    ],
  • "frUnindexedMultivalued3": [
    ],
  • "frUnindexedMultivalued4": [
    ],
  • "frUnindexedMultivalued5": [
    ],
  • "frUnindexedString1": "string",
  • "frUnindexedString2": "string",
  • "frUnindexedString3": "string",
  • "frUnindexedString4": "string",
  • "frUnindexedString5": "string",
  • "givenName": "string",
  • "groups": [
    ],
  • "kbaInfo": [
    ],
  • "lastSync": {
    },
  • "mail": "string",
  • "manager": {
    },
  • "memberOfOrg": [
    ],
  • "memberOfOrgIDs": [
    ],
  • "ownerOfApp": [
    ],
  • "ownerOfOrg": [
    ],
  • "password": "string",
  • "passwordExpirationTime": "string",
  • "passwordLastChangedTime": "string",
  • "postalAddress": "string",
  • "postalCode": "string",
  • "preferences": {
    },
  • "profileImage": "string",
  • "reports": [
    ],
  • "roles": [
    ],
  • "sn": "string",
  • "stateProvince": "string",
  • "telephoneNumber": "string",
  • "userName": "string"
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_id
string

User ID

object (Metadata)

Metadata for managed/bravo_usermeta

Array of objects (Notifications)

Notifications

accountStatus
string (Status)
Default: "active"

Status

Array of objects (Organizations I Administer)
aliasList
Array of strings (User Alias Names List)

List of identity aliases used primarily to record social IdP subjects for this user

Array of objects (Applications)

Applications

assignedDashboard
Array of strings (Assigned Dashboard)

List of items to click on for this user

Array of objects (Assignments)

Assignments

Array of objects (Authorization Roles)

Authorization Roles

city
string (City)

City

cn
string (Common Name)
Default: "{{givenName}} {{sn}}"

Common Name

Array of objects (Consented Mappings) [ items ]

Consented Mappings

country
string (Country)

Country

description
string (Description)

Description

effectiveApplications
Array of objects (Effective Applications)

Effective Applications

effectiveAssignments
Array of objects (Effective Assignments)

Effective Assignments

effectiveGroups
Array of objects (Effective Groups)

Effective Groups

effectiveRoles
Array of objects (Effective Roles)

Effective Roles

frIndexedDate1
string (Generic Indexed Date 1)

Generic Indexed Date 1

frIndexedDate2
string (Generic Indexed Date 2)

Generic Indexed Date 2

frIndexedDate3
string (Generic Indexed Date 3)

Generic Indexed Date 3

frIndexedDate4
string (Generic Indexed Date 4)

Generic Indexed Date 4

frIndexedDate5
string (Generic Indexed Date 5)

Generic Indexed Date 5

frIndexedInteger1
number <double> (Generic Indexed Integer 1)

Generic Indexed Integer 1

frIndexedInteger2
number <double> (Generic Indexed Integer 2)

Generic Indexed Integer 2

frIndexedInteger3
number <double> (Generic Indexed Integer 3)

Generic Indexed Integer 3

frIndexedInteger4
number <double> (Generic Indexed Integer 4)

Generic Indexed Integer 4

frIndexedInteger5
number <double> (Generic Indexed Integer 5)

Generic Indexed Integer 5

frIndexedMultivalued1
Array of strings (Generic Indexed Multivalue 1)

Generic Indexed Multivalue 1

frIndexedMultivalued2
Array of strings (Generic Indexed Multivalue 2)

Generic Indexed Multivalue 2

frIndexedMultivalued3
Array of strings (Generic Indexed Multivalue 3)

Generic Indexed Multivalue 3

frIndexedMultivalued4
Array of strings (Generic Indexed Multivalue 4)

Generic Indexed Multivalue 4

frIndexedMultivalued5
Array of strings (Generic Indexed Multivalue 5)

Generic Indexed Multivalue 5

frIndexedString1
string (Generic Indexed String 1)

Generic Indexed String 1

frIndexedString2
string (Generic Indexed String 2)

Generic Indexed String 2

frIndexedString3
string (Generic Indexed String 3)

Generic Indexed String 3

frIndexedString4
string (Generic Indexed String 4)

Generic Indexed String 4

frIndexedString5
string (Generic Indexed String 5)

Generic Indexed String 5

frUnindexedDate1
string (Generic Unindexed Date 1)

Generic Unindexed Date 1

frUnindexedDate2
string (Generic Unindexed Date 2)

Generic Unindexed Date 2

frUnindexedDate3
string (Generic Unindexed Date 3)

Generic Unindexed Date 3

frUnindexedDate4
string (Generic Unindexed Date 4)

Generic Unindexed Date 4

frUnindexedDate5
string (Generic Unindexed Date 5)

Generic Unindexed Date 5

frUnindexedInteger1
number <double> (Generic Unindexed Integer 1)

Generic Unindexed Integer 1

frUnindexedInteger2
number <double> (Generic Unindexed Integer 2)

Generic Unindexed Integer 2

frUnindexedInteger3
number <double> (Generic Unindexed Integer 3)

Generic Unindexed Integer 3

frUnindexedInteger4
number <double> (Generic Unindexed Integer 4)

Generic Unindexed Integer 4

frUnindexedInteger5
number <double> (Generic Unindexed Integer 5)

Generic Unindexed Integer 5

frUnindexedMultivalued1
Array of strings (Generic Unindexed Multivalue 1)

Generic Unindexed Multivalue 1

frUnindexedMultivalued2
Array of strings (Generic Unindexed Multivalue 2)

Generic Unindexed Multivalue 2

frUnindexedMultivalued3
Array of strings (Generic Unindexed Multivalue 3)

Generic Unindexed Multivalue 3

frUnindexedMultivalued4
Array of strings (Generic Unindexed Multivalue 4)

Generic Unindexed Multivalue 4

frUnindexedMultivalued5
Array of strings (Generic Unindexed Multivalue 5)

Generic Unindexed Multivalue 5

frUnindexedString1
string (Generic Unindexed String 1)

Generic Unindexed String 1

frUnindexedString2
string (Generic Unindexed String 2)

Generic Unindexed String 2

frUnindexedString3
string (Generic Unindexed String 3)

Generic Unindexed String 3

frUnindexedString4
string (Generic Unindexed String 4)

Generic Unindexed String 4

frUnindexedString5
string (Generic Unindexed String 5)

Generic Unindexed String 5

givenName
required
string (First Name)

First Name

Array of objects (Groups)

Groups

Array of objects (KBA Info Items)

KBA Info

object (Last Sync timestamp)

Last Sync timestamp

mail
required
string (Email Address)

Email Address

object (Manager)

Manager

Array of objects (Organizations to which I Belong)
memberOfOrgIDs
Array of strings (MemberOfOrgIDs)
Array of objects (Applications I Own)
Array of objects (Organizations I Own)
password
string (Password)

Password

passwordExpirationTime
string (Password Expiration Time)

Password Expiration Time

passwordLastChangedTime
string (Password Last Changed Time)

Password Last Changed Time

postalAddress
string (Address 1)

Address 1

postalCode
string (Postal Code)

Postal Code

object (Preferences)

Preferences

profileImage
string (Profile Image)

Profile Image

Array of objects (Direct Reports)

Direct Reports

Array of objects (Provisioning Roles)

Provisioning Roles

sn
required
string (Last Name)

Last Name

stateProvince
string (State/Province)

State/Province

telephoneNumber
string (Telephone Number) ^\+?([0-9\- \(\)])*$

Telephone Number

userName
required
string (Username) non-empty

Username

Responses

Request samples

Content type
{
  • "_id": "string",
  • "_meta": {
    },
  • "_notifications": [
    ],
  • "accountStatus": "active",
  • "adminOfOrg": [
    ],
  • "aliasList": [
    ],
  • "applications": [
    ],
  • "assignedDashboard": [
    ],
  • "assignments": [
    ],
  • "authzRoles": [
    ],
  • "city": "string",
  • "cn": "{{givenName}} {{sn}}",
  • "consentedMappings": [
    ],
  • "country": "string",
  • "description": "string",
  • "effectiveApplications": [
    ],
  • "effectiveAssignments": [
    ],
  • "effectiveGroups": [
    ],
  • "effectiveRoles": [
    ],
  • "frIndexedDate1": "string",
  • "frIndexedDate2": "string",
  • "frIndexedDate3": "string",
  • "frIndexedDate4": "string",
  • "frIndexedDate5": "string",
  • "frIndexedInteger1": 0.1,
  • "frIndexedInteger2": 0.1,
  • "frIndexedInteger3": 0.1,
  • "frIndexedInteger4": 0.1,
  • "frIndexedInteger5": 0.1,
  • "frIndexedMultivalued1": [
    ],
  • "frIndexedMultivalued2": [
    ],
  • "frIndexedMultivalued3": [
    ],
  • "frIndexedMultivalued4": [
    ],
  • "frIndexedMultivalued5": [
    ],
  • "frIndexedString1": "string",
  • "frIndexedString2": "string",
  • "frIndexedString3": "string",
  • "frIndexedString4": "string",
  • "frIndexedString5": "string",
  • "frUnindexedDate1": "string",
  • "frUnindexedDate2": "string",
  • "frUnindexedDate3": "string",
  • "frUnindexedDate4": "string",
  • "frUnindexedDate5": "string",
  • "frUnindexedInteger1": 0.1,
  • "frUnindexedInteger2": 0.1,
  • "frUnindexedInteger3": 0.1,
  • "frUnindexedInteger4": 0.1,
  • "frUnindexedInteger5": 0.1,
  • "frUnindexedMultivalued1": [
    ],
  • "frUnindexedMultivalued2": [
    ],
  • "frUnindexedMultivalued3": [
    ],
  • "frUnindexedMultivalued4": [
    ],
  • "frUnindexedMultivalued5": [
    ],
  • "frUnindexedString1": "string",
  • "frUnindexedString2": "string",
  • "frUnindexedString3": "string",
  • "frUnindexedString4": "string",
  • "frUnindexedString5": "string",
  • "givenName": "string",
  • "groups": [
    ],
  • "kbaInfo": [
    ],
  • "lastSync": {
    },
  • "mail": "string",
  • "manager": {
    },
  • "memberOfOrg": [
    ],
  • "memberOfOrgIDs": [
    ],
  • "ownerOfApp": [
    ],
  • "ownerOfOrg": [
    ],
  • "password": "string",
  • "passwordExpirationTime": "string",
  • "passwordLastChangedTime": "string",
  • "postalAddress": "string",
  • "postalCode": "string",
  • "preferences": {
    },
  • "profileImage": "string",
  • "reports": [
    ],
  • "roles": [
    ],
  • "sn": "string",
  • "stateProvince": "string",
  • "telephoneNumber": "string",
  • "userName": "string"
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_meta": {
    },
  • "_notifications": [
    ],
  • "accountStatus": "active",
  • "adminOfOrg": [
    ],
  • "aliasList": [
    ],
  • "applications": [
    ],
  • "assignedDashboard": [
    ],
  • "assignments": [
    ],
  • "authzRoles": [
    ],
  • "city": "string",
  • "cn": "{{givenName}} {{sn}}",
  • "consentedMappings": [
    ],
  • "country": "string",
  • "description": "string",
  • "effectiveApplications": [
    ],
  • "effectiveAssignments": [
    ],
  • "effectiveGroups": [
    ],
  • "effectiveRoles": [
    ],
  • "frIndexedDate1": "string",
  • "frIndexedDate2": "string",
  • "frIndexedDate3": "string",
  • "frIndexedDate4": "string",
  • "frIndexedDate5": "string",
  • "frIndexedInteger1": 0.1,
  • "frIndexedInteger2": 0.1,
  • "frIndexedInteger3": 0.1,
  • "frIndexedInteger4": 0.1,
  • "frIndexedInteger5": 0.1,
  • "frIndexedMultivalued1": [
    ],
  • "frIndexedMultivalued2": [
    ],
  • "frIndexedMultivalued3": [
    ],
  • "frIndexedMultivalued4": [
    ],
  • "frIndexedMultivalued5": [
    ],
  • "frIndexedString1": "string",
  • "frIndexedString2": "string",
  • "frIndexedString3": "string",
  • "frIndexedString4": "string",
  • "frIndexedString5": "string",
  • "frUnindexedDate1": "string",
  • "frUnindexedDate2": "string",
  • "frUnindexedDate3": "string",
  • "frUnindexedDate4": "string",
  • "frUnindexedDate5": "string",
  • "frUnindexedInteger1": 0.1,
  • "frUnindexedInteger2": 0.1,
  • "frUnindexedInteger3": 0.1,
  • "frUnindexedInteger4": 0.1,
  • "frUnindexedInteger5": 0.1,
  • "frUnindexedMultivalued1": [
    ],
  • "frUnindexedMultivalued2": [
    ],
  • "frUnindexedMultivalued3": [
    ],
  • "frUnindexedMultivalued4": [
    ],
  • "frUnindexedMultivalued5": [
    ],
  • "frUnindexedString1": "string",
  • "frUnindexedString2": "string",
  • "frUnindexedString3": "string",
  • "frUnindexedString4": "string",
  • "frUnindexedString5": "string",
  • "givenName": "string",
  • "groups": [
    ],
  • "kbaInfo": [
    ],
  • "lastSync": {
    },
  • "mail": "string",
  • "manager": {
    },
  • "memberOfOrg": [
    ],
  • "memberOfOrgIDs": [
    ],
  • "ownerOfApp": [
    ],
  • "ownerOfOrg": [
    ],
  • "password": "string",
  • "passwordExpirationTime": "string",
  • "passwordLastChangedTime": "string",
  • "postalAddress": "string",
  • "postalCode": "string",
  • "preferences": {
    },
  • "profileImage": "string",
  • "reports": [
    ],
  • "roles": [
    ],
  • "sn": "string",
  • "stateProvince": "string",
  • "telephoneNumber": "string",
  • "userName": "string"
}

CSV Import v1.0

Download: Bulk Import Failure CSV

Downloads a CSV of failed rows from a Bulk CSV Import. Returns 404 if there were no failures for the given Import UUID.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
importUUID
required
string <uuid>

Import UUID

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Action: cleanupList

Lists import UUIDs that may need the cleanup action, if the import is not in-progress.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "cleanupList"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "hasErrorRecords": [
    ],
  • "hasTempRecords": [
    ]
}

Query by Filter

Query import records.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Action: cancel

Cancels an in-progress import.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
importUUID
required
string

Import UUID

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "cancel"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "status": "OK"
}

Action: cleanup

Cleans up temporary import records.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
importUUID
required
string

Import UUID

query Parameters
deleteErrorRecords
boolean

Delete failed import records

_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "cleanup"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "status": "OK"
}

Delete

Delete import record.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
importUUID
required
string

Import UUID

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_rev": "string",
  • "authId": "string",
  • "authzComponent": "string",
  • "created": 0,
  • "failure": 0,
  • "filename": "string",
  • "header": [
    ],
  • "reconId": "string",
  • "resourcePath": "managed/user",
  • "success": 0,
  • "total": 0,
  • "unchanged": 0,
  • "updated": 0
}

Read

Read import record.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
importUUID
required
string

Import UUID

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_rev": "string",
  • "authId": "string",
  • "authzComponent": "string",
  • "created": 0,
  • "failure": 0,
  • "filename": "string",
  • "header": [
    ],
  • "reconId": "string",
  • "resourcePath": "managed/user",
  • "success": 0,
  • "total": 0,
  • "unchanged": 0,
  • "updated": 0
}

Read

Provides a CSV header row suitable for use as a template for subsequent upload & import. Set query parameters _fields=header and _mimeType=text/csv to download file.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
resourceCollection
required
string

Schema resource path

_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "header": "string"
}

Upload: Bulk Import CSV

Upload a CSV file for Bulk Import. The CSV must contain the template header row for the specified resource collection (e.g., managed/user).

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
resourceCollection
required
string
Example: managed/user

Schema resource path

query Parameters
uniqueProperty
required
string
Example: uniqueProperty=userName

Comma-separated property names which correlate CSV rows to unique records.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema: multipart/form-data
required
multipart-form
required
string <binary>

One or more CSV files to upload.

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "importUUIDs": [
    ]
}

Configuration v1.0

Query by Filter

Queries the configurations.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Read

Lists all configuration endpoints. Some configurations are single-instance (e.g., audit) while others are multi-instance (grouped), which can be observed when the _id field contains a forward-slash (e.g., factoryId/instanceId).

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "configurations": [
    ]
}

Read

Read a multi-instance configuration.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
factoryPid
required
string

Persistent identity for group (factory)

instanceId
required
string

Instance ID under parent group

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_id": "string"
}

Read

Read a single-instance configuration.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
instanceId
required
string

Instance ID

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_id": "string"
}

Connector v1.0

Action: availableConnectors

Lists all available connectors, which includes those that are not configured and ready-for-use.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "availableConnectors"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "connectorRef": [
    ]
}

Action: availableConnectorServers

Lists all available connector servers.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "availableConnectorServers"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "connectorServersRef": [
    ]
}

Action: createConnectorServerCoreConfig

Generate core-configuration template for a connector server.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "createConnectorServerCoreConfig"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "connectorServersRef": [
    ]
}

Action: createCoreConfig

Generate core-configuration template for a connector.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "createCoreConfig"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
required
object (Connector Identifiers)

Connector identifiers

Responses

Request samples

Content type
{
  • "connectorRef": {
    }
}

Response samples

Content type
application/json
{
  • "configurationProperties": { },
  • "connectorPoolingSupported": true,
  • "connectorRef": {
    },
  • "name": "string",
  • "objectTypes": { },
  • "operationOptions": {
    },
  • "operationTimeout": {
    },
  • "poolConfigOption": {
    },
  • "producerBufferSize": 100,
  • "resultsHandlerConfig": {
    },
  • "syncFailureHandler": {
    },
  • "systemActions": [
    ]
}

Action: createFullConfig

Complete full-configuration for a connector. One would then save the response JSON to a file conf/provisioner.openicf-name.json, where name is the unique name of the connector.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "createFullConfig"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
configurationProperties
required
object

Connector specific configuration

connectorPoolingSupported
boolean
Default: true

Enables connector pooling, when supported

required
object (Connector Identifiers)

Connector identifiers

name
string

Unique connector name

objectTypes
object

Map of object-classes to JSON Schemas

object (Operation Options)

Configuration settings per operation

object (Operation Timeout)

Timeouts per operation

required
object (Connector Pool Config)

Connector pool configuration

producerBufferSize
integer <int32>
Default: 100

Size of SYNC/QUERY result-queue

object (Results Handler Config)

Results handler configuration

object (Sync Failure Handler Config)

Configures how live-sync failures are handled

Array of objects (System Action Config)

Connector actions (e.g., scripts)

Responses

Request samples

Content type
{
  • "configurationProperties": { },
  • "connectorPoolingSupported": true,
  • "connectorRef": {
    },
  • "name": "string",
  • "objectTypes": { },
  • "operationOptions": {
    },
  • "operationTimeout": {
    },
  • "poolConfigOption": {
    },
  • "producerBufferSize": 100,
  • "resultsHandlerConfig": {
    },
  • "syncFailureHandler": {
    },
  • "systemActions": [
    ]
}

Response samples

Content type
application/json
{
  • "configurationProperties": { },
  • "connectorPoolingSupported": true,
  • "connectorRef": {
    },
  • "name": "string",
  • "objectTypes": { },
  • "operationOptions": {
    },
  • "operationTimeout": {
    },
  • "poolConfigOption": {
    },
  • "producerBufferSize": 100,
  • "resultsHandlerConfig": {
    },
  • "syncFailureHandler": {
    },
  • "systemActions": [
    ]
}

Action: liveSync

Trigger Live-Sync on a connector.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
source
required
string

URI of connector to Live-Sync (e.g., system/ldap/account)

detailedFailure
boolean

Return detailed failure information

_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "liveSync"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_rev": "string",
  • "connectorData": {
    }
}

Action: test

Check status of configured connectors. Send an empty-object request payload {} to list all configured connectors, or { "id" : "some_id" } for a single connector.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "test"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
id
string

Connector identifier (sometimes same as 'name')

Responses

Request samples

Content type
{
  • "id": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Action: testConfig

Test connector configuration, for validity.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "testConfig"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
configurationProperties
required
object

Connector specific configuration

connectorPoolingSupported
boolean
Default: true

Enables connector pooling, when supported

required
object (Connector Identifiers)

Connector identifiers

name
string

Unique connector name

objectTypes
object

Map of object-classes to JSON Schemas

object (Operation Options)

Configuration settings per operation

object (Operation Timeout)

Timeouts per operation

required
object (Connector Pool Config)

Connector pool configuration

producerBufferSize
integer <int32>
Default: 100

Size of SYNC/QUERY result-queue

object (Results Handler Config)

Results handler configuration

object (Sync Failure Handler Config)

Configures how live-sync failures are handled

Array of objects (System Action Config)

Connector actions (e.g., scripts)

Responses

Request samples

Content type
{
  • "configurationProperties": { },
  • "connectorPoolingSupported": true,
  • "connectorRef": {
    },
  • "name": "string",
  • "objectTypes": { },
  • "operationOptions": {
    },
  • "operationTimeout": {
    },
  • "poolConfigOption": {
    },
  • "producerBufferSize": 100,
  • "resultsHandlerConfig": {
    },
  • "syncFailureHandler": {
    },
  • "systemActions": [
    ]
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "name": "string",
  • "ok": true
}

Action: testConnectorServers

Test if a connector server is operational.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "testConnectorServers"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "connectorServersRef": [
    ]
}

Consent v1.0

Consent v2.0

Email v1.0

Action: send

Send email

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
waitForCompletion
boolean

Whether or not request will block until email has been accepted by the SMTP server.

_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "send"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
bcc
string <email>

Comma-separated blind carbon copy addresses

body
string
Default: "<empty message>"

Message body

cc
string <email>

Comma-separated carbon copy addresses

from
required
string <email>

Sender address

subject
string
Default: "<empty subject>"

Message subject

to
required
string <email>

Comma-separated recipient addresses

type
string
Default: "text/plain"
Enum: "text/plain" "text/html" "text/xml"

MIME type of message body

Responses

Request samples

Content type
{
  • "bcc": "user@example.com",
  • "body": "<empty message>",
  • "cc": "user@example.com",
  • "from": "user@example.com",
  • "subject": "<empty subject>",
  • "to": "user@example.com",
  • "type": "text/plain"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "OK"
}

Action: sendTemplate

Send template

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "sendTemplate"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
bcc
string <email>

Comma-separated BCC addresses

cc
string <email>

Comma-separated CC addresses

object
object

Key-value pairs to inject into template

templateName
required
string

Template Name

to
string <email>

Comma-separated recipient addresses

Responses

Request samples

Content type
{
  • "bcc": "user@example.com",
  • "cc": "user@example.com",
  • "object": { },
  • "templateName": "string",
  • "to": "user@example.com"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "OK"
}

External REST v1.0

Action: call

Connects to external REST endpoint. If the response is application/json, then it will be passed through unchanged, otherwise it will be wrapped in a JSON response. HTTP error status code headers, from an external endpoint, will also be passed through in the response.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "call"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
object (Authentication Options)

Configures basic- or bearer-authentication on external endpoint

base64
boolean
Default: false

Indicates that body is a base-64 encoded binary value

body
string

HTTP request payload

contentType
string
Default: "application/json; charset=utf-8"

Optional content-type header for request payload

forceWrap
boolean
Default: false

The indicator that the response must be wrapped in the headers/body JSON message-format, even if the response was JSON and would otherwise have been passed-through unchanged

headers
object

Header key/value pairs to pass to external REST endpoint

method
required
string
Enum: "GET" "HEAD" "POST" "PUT" "DELETE" "CONNECT" "OPTIONS" "TRACE" "PATCH"

HTTP request method

url
required
string

The URL to request

Responses

Request samples

Content type
{
  • "authenticate": {
    },
  • "base64": false,
  • "body": "string",
  • "contentType": "application/json; charset=utf-8",
  • "forceWrap": false,
  • "headers": { },
  • "method": "GET",
  • "url": "string"
}

Response samples

Content type
application/json
{
  • "base64": true,
  • "body": "string",
  • "code": 0,
  • "headers": { }
}

Information v1.0

Query by Filter

Provides a list of available features in this OpenIDM instance, whether the feature is enabled, and any related endpoints.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Read

Provides a single feature in this OpenIDM instance, whether it's enabled, and any related endpoints.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "enabled": true,
  • "endpoints": [
    ],
  • "name": "string"
}

Read

Provides authentication and authorization details, for the authenticated caller (e.g., User).

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "authenticationId": "string",
  • "authorization": {
    }
}

Read

Returns OpenIDM status information, and is an endpoint suitable for pinging the server.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "shortDesc": "string",
  • "state": "STARTING"
}

Read

Provides the UI configuration of this OpenIDM instance.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "configuration": {
    }
}

Read

Provides the software version of this OpenIDM instance.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "productBuildDate": "string",
  • "productRevision": "string",
  • "productVersion": "string"
}

Internal Notification v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_id
string (Name)

Notification ID

createDate
string (Create Date)

Date the notification was created.

message
string (Message)

The notification message.

notificationType
string (Notification Type)

The type of notification, used for display purposes.

required
object (Notification Target)

Responses

Request samples

Content type
{
  • "_id": "string",
  • "createDate": "string",
  • "message": "string",
  • "notificationType": "string",
  • "target": {
    }
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "createDate": "string",
  • "message": "string",
  • "notificationType": "string",
  • "target": {
    }
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
notificationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_id
string (Name)

Notification ID

createDate
string (Create Date)

Date the notification was created.

message
string (Message)

The notification message.

notificationType
string (Notification Type)

The type of notification, used for display purposes.

required
object (Notification Target)

Responses

Request samples

Content type
{
  • "_id": "string",
  • "createDate": "string",
  • "message": "string",
  • "notificationType": "string",
  • "target": {
    }
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "createDate": "string",
  • "message": "string",
  • "notificationType": "string",
  • "target": {
    }
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
notificationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "createDate": "string",
  • "message": "string",
  • "notificationType": "string",
  • "target": {
    }
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
notificationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_id": "string",
  • "createDate": "string",
  • "message": "string",
  • "notificationType": "string",
  • "target": {
    }
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
notificationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "createDate": "string",
  • "message": "string",
  • "notificationType": "string",
  • "target": {
    }
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
notificationId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_id
string (Name)

Notification ID

createDate
string (Create Date)

Date the notification was created.

message
string (Message)

The notification message.

notificationType
string (Notification Type)

The type of notification, used for display purposes.

required
object (Notification Target)

Responses

Request samples

Content type
{
  • "_id": "string",
  • "createDate": "string",
  • "message": "string",
  • "notificationType": "string",
  • "target": {
    }
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "createDate": "string",
  • "message": "string",
  • "notificationType": "string",
  • "target": {
    }
}

Internal Role - Members v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
roleId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Authorization Role Members Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
roleId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
roleId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
roleId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
roleId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Authorization Role Members Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
roleId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
roleId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
roleId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
roleId
required
string
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_ref
string

References a relationship from a managed object

object (Authorization Role Members Items _refProperties)

Supports metadata within the relationship

Responses

Request samples

Content type
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Response samples

Content type
application/json
{
  • "_ref": "string",
  • "_refProperties": {
    }
}

Internal Role v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_id
string (Name)

Role ID

Array of objects (Members)

Authorization Role Members

condition
string (Condition)

A conditional filter for this role

description
string (Description)

The role description, used for display purposes.

name
required
string (Name)

The role name, used for display purposes.

Array of objects (Privileges)

Internal Privileges

Array of objects (Time Constraint)

Set a start and end date during which this role will be active

Responses

Request samples

Content type
{
  • "_id": "string",
  • "authzMembers": [
    ],
  • "condition": "string",
  • "description": "string",
  • "name": "string",
  • "privileges": [
    ],
  • "temporalConstraints": [
    ]
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "authzMembers": [
    ],
  • "condition": "string",
  • "description": "string",
  • "name": "string",
  • "privileges": [
    ],
  • "temporalConstraints": [
    ]
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
roleId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_id
string (Name)

Role ID

Array of objects (Members)

Authorization Role Members

condition
string (Condition)

A conditional filter for this role

description
string (Description)

The role description, used for display purposes.

name
required
string (Name)

The role name, used for display purposes.

Array of objects (Privileges)

Internal Privileges

Array of objects (Time Constraint)

Set a start and end date during which this role will be active

Responses

Request samples

Content type
{
  • "_id": "string",
  • "authzMembers": [
    ],
  • "condition": "string",
  • "description": "string",
  • "name": "string",
  • "privileges": [
    ],
  • "temporalConstraints": [
    ]
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "authzMembers": [
    ],
  • "condition": "string",
  • "description": "string",
  • "name": "string",
  • "privileges": [
    ],
  • "temporalConstraints": [
    ]
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
roleId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "authzMembers": [
    ],
  • "condition": "string",
  • "description": "string",
  • "name": "string",
  • "privileges": [
    ],
  • "temporalConstraints": [
    ]
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
roleId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_id": "string",
  • "authzMembers": [
    ],
  • "condition": "string",
  • "description": "string",
  • "name": "string",
  • "privileges": [
    ],
  • "temporalConstraints": [
    ]
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
roleId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "authzMembers": [
    ],
  • "condition": "string",
  • "description": "string",
  • "name": "string",
  • "privileges": [
    ],
  • "temporalConstraints": [
    ]
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
roleId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_id
string (Name)

Role ID

Array of objects (Members)

Authorization Role Members

condition
string (Condition)

A conditional filter for this role

description
string (Description)

The role description, used for display purposes.

name
required
string (Name)

The role name, used for display purposes.

Array of objects (Privileges)

Internal Privileges

Array of objects (Time Constraint)

Set a start and end date during which this role will be active

Responses

Request samples

Content type
{
  • "_id": "string",
  • "authzMembers": [
    ],
  • "condition": "string",
  • "description": "string",
  • "name": "string",
  • "privileges": [
    ],
  • "temporalConstraints": [
    ]
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "authzMembers": [
    ],
  • "condition": "string",
  • "description": "string",
  • "name": "string",
  • "privileges": [
    ],
  • "temporalConstraints": [
    ]
}

Internal Service Account v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_id
string (Account ID)

Account ID

accountStatus
string (Status)
Default: "active"

Status

description
string (Description)

Description

jwks
string (JWKs)

Public JSON Web Keys that are valid for JWT verification

maxCachingTime
number <double> (Max Caching Time)
maxIdleTime
number <double> (Max Idle Time)
maxSessionTime
number <double> (Max Session Time)
name
string (Name)

Name

quotaLimit
number <double> (Quota Limit)
scopes
Array of strings (Scopes)

Authorized Scopes

Responses

Request samples

Content type
{
  • "_id": "string",
  • "accountStatus": "active",
  • "description": "string",
  • "jwks": "string",
  • "maxCachingTime": 0.1,
  • "maxIdleTime": 0.1,
  • "maxSessionTime": 0.1,
  • "name": "string",
  • "quotaLimit": 0.1,
  • "scopes": [
    ]
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "accountStatus": "active",
  • "description": "string",
  • "jwks": "string",
  • "maxCachingTime": 0.1,
  • "maxIdleTime": 0.1,
  • "maxSessionTime": 0.1,
  • "name": "string",
  • "quotaLimit": 0.1,
  • "scopes": [
    ]
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Action: triggerSyncCheck

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
svcacctId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "triggerSyncCheck"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
svcacctId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_id
string (Account ID)

Account ID

accountStatus
string (Status)
Default: "active"

Status

description
string (Description)

Description

jwks
string (JWKs)

Public JSON Web Keys that are valid for JWT verification

maxCachingTime
number <double> (Max Caching Time)
maxIdleTime
number <double> (Max Idle Time)
maxSessionTime
number <double> (Max Session Time)
name
string (Name)

Name

quotaLimit
number <double> (Quota Limit)
scopes
Array of strings (Scopes)

Authorized Scopes

Responses

Request samples

Content type
{
  • "_id": "string",
  • "accountStatus": "active",
  • "description": "string",
  • "jwks": "string",
  • "maxCachingTime": 0.1,
  • "maxIdleTime": 0.1,
  • "maxSessionTime": 0.1,
  • "name": "string",
  • "quotaLimit": 0.1,
  • "scopes": [
    ]
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "accountStatus": "active",
  • "description": "string",
  • "jwks": "string",
  • "maxCachingTime": 0.1,
  • "maxIdleTime": 0.1,
  • "maxSessionTime": 0.1,
  • "name": "string",
  • "quotaLimit": 0.1,
  • "scopes": [
    ]
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
svcacctId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "accountStatus": "active",
  • "description": "string",
  • "jwks": "string",
  • "maxCachingTime": 0.1,
  • "maxIdleTime": 0.1,
  • "maxSessionTime": 0.1,
  • "name": "string",
  • "quotaLimit": 0.1,
  • "scopes": [
    ]
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
svcacctId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_id": "string",
  • "accountStatus": "active",
  • "description": "string",
  • "jwks": "string",
  • "maxCachingTime": 0.1,
  • "maxIdleTime": 0.1,
  • "maxSessionTime": 0.1,
  • "name": "string",
  • "quotaLimit": 0.1,
  • "scopes": [
    ]
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
svcacctId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "accountStatus": "active",
  • "description": "string",
  • "jwks": "string",
  • "maxCachingTime": 0.1,
  • "maxIdleTime": 0.1,
  • "maxSessionTime": 0.1,
  • "name": "string",
  • "quotaLimit": 0.1,
  • "scopes": [
    ]
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
svcacctId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_id
string (Account ID)

Account ID

accountStatus
string (Status)
Default: "active"

Status

description
string (Description)

Description

jwks
string (JWKs)

Public JSON Web Keys that are valid for JWT verification

maxCachingTime
number <double> (Max Caching Time)
maxIdleTime
number <double> (Max Idle Time)
maxSessionTime
number <double> (Max Session Time)
name
string (Name)

Name

quotaLimit
number <double> (Quota Limit)
scopes
Array of strings (Scopes)

Authorized Scopes

Responses

Request samples

Content type
{
  • "_id": "string",
  • "accountStatus": "active",
  • "description": "string",
  • "jwks": "string",
  • "maxCachingTime": 0.1,
  • "maxIdleTime": 0.1,
  • "maxSessionTime": 0.1,
  • "name": "string",
  • "quotaLimit": 0.1,
  • "scopes": [
    ]
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "accountStatus": "active",
  • "description": "string",
  • "jwks": "string",
  • "maxCachingTime": 0.1,
  • "maxIdleTime": 0.1,
  • "maxSessionTime": 0.1,
  • "name": "string",
  • "quotaLimit": 0.1,
  • "scopes": [
    ]
}

Internal User Metadata v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_id
string

UserMeta ID

Responses

Request samples

Content type
{
  • "_id": "string"
}

Response samples

Content type
application/json
{
  • "_id": "string"
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
usermetaId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_id
string

UserMeta ID

Responses

Request samples

Content type
{
  • "_id": "string"
}

Response samples

Content type
application/json
{
  • "_id": "string"
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
usermetaId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_id": "string"
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
usermetaId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_id": "string"
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
usermetaId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_id": "string"
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
usermetaId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_id
string

UserMeta ID

Responses

Request samples

Content type
{
  • "_id": "string"
}

Response samples

Content type
application/json
{
  • "_id": "string"
}

Internal User v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_id
string (User ID)

User ID

password
string (Password)

Password

Responses

Request samples

Content type
{
  • "_id": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "password": "string"
}

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_id
string (User ID)

User ID

password
string (Password)

Password

Responses

Request samples

Content type
{
  • "_id": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "password": "string"
}

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "password": "string"
}

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_id": "string",
  • "password": "string"
}

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "password": "string"
}

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
userId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_id
string (User ID)

User ID

password
string (Password)

Password

Responses

Request samples

Content type
{
  • "_id": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "password": "string"
}

Notification v1.0

Action: deleteNotificationsForTarget

Deletes all notifications tied to the specified target

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
target
required
string

Specifies what resource to delete notifications from

_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "deleteNotificationsForTarget"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Action: notifyByQueryFilter

Creates a notification for each resource that matches a query filter.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
targetResourceCollection
required
string

Resource collection to query

_queryFilter
required
string

Query to compare resources to

_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "notifyByQueryFilter"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_id
required
string

Notification identifier

createDate
required
string

Date the notification was created

message
required
string

Notification content

notificationType
required
string

Type of notification (see info/uiconfig for types of notifications)

required
object (Notification Target Object)

Relationship that defines the intended target of the notification

Responses

Request samples

Content type
{
  • "_id": "string",
  • "createDate": "string",
  • "message": "string",
  • "notificationType": "string",
  • "target": {
    }
}

Response samples

Content type
application/json
[
  • {
    }
]

Policies v1.0

Read

List policies defined in the policy.json file. We recommend using /policy/managed/{type} endpoints for reading a complete list of policies for a given type.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ]
}

Read

List policies for Alpha realm - Application objects.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "properties": [
    ],
  • "resource": "string"
}

Action: validateObject

Validates a given Alpha realm - Application object against its policy requirements.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
nullId
required
string

Alpha realm - Application ID

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "validateObject"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_id
string

Application ID

authoritative
boolean (Authoritative)

Is this an authoritative application

connectorId
string (Connector ID)

Id of the connector associated with the application

description
string (Description)

Application Description

icon
string (Icon)
mappingNames
Array of strings (Sync Mapping Names)

Names of the sync mappings used by an application with provisioning configured.

Array of objects (Members)

Application Members

name
required
string (Name)

Application name

Array of objects (Owners)

Application Owners

Array of objects (Roles)

Roles granting users the application

object (SSO Entity Id)

SSO Entity Id

templateName
string (Template Name)

Name of the template the application was created from

templateVersion
string (Template Version)

The template version

uiConfig
object (UI Config)

UI Config

url
string (Url)

Responses

Request samples

Content type
{
  • "_id": "string",
  • "authoritative": true,
  • "connectorId": "string",
  • "description": "string",
  • "icon": "string",
  • "mappingNames": [
    ],
  • "members": [
    ],
  • "name": "string",
  • "owners": [
    ],
  • "roles": [
    ],
  • "ssoEntities": {
    },
  • "templateName": "string",
  • "templateVersion": "string",
  • "uiConfig": { },
  • "url": "string"
}

Response samples

Content type
application/json
{
  • "failedPolicyRequirements": [
    ],
  • "result": true
}

Action: validateProperty

Verifies that a given property adheres to policy requirements.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
nullId
required
string

Alpha realm - Application ID

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "validateProperty"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
property name*
additional property
any

Responses

Request samples

Content type
{
  • "property1": null,
  • "property2": null
}

Response samples

Content type
application/json
{
  • "failedPolicyRequirements": [
    ],
  • "result": true
}

Read

List policies for Alpha realm - Assignment objects.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "properties": [
    ],
  • "resource": "string"
}

Action: validateObject

Validates a given Alpha realm - Assignment object against its policy requirements.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
nullId
required
string

Alpha realm - Assignment ID

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "validateObject"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_id
string (Name)

The assignment ID

Array of objects (Assignment Attributes)

The attributes operated on by this assignment.

condition
string (Condition)

A conditional filter for this assignment

description
required
string (Description)

The assignment description, used for display purposes.

linkQualifiers
Array of strings (Link Qualifiers)

Conditional link qualifiers to restrict this assignment to.

mapping
required
string (Mapping)

The name of the mapping this assignment applies to

Array of objects (Assignment Members)

Assignment Members

name
required
string (Name)

The assignment name, used for display purposes.

Array of objects (Managed Roles)

Managed Roles

type
string (Type)

The type of object this assignment represents

weight
number <double> (Weight)

The weight of the assignment.

Responses

Request samples

Content type
{
  • "_id": "string",
  • "attributes": [
    ],
  • "condition": "string",
  • "description": "string",
  • "linkQualifiers": [
    ],
  • "mapping": "string",
  • "members": [
    ],
  • "name": "string",
  • "roles": [
    ],
  • "type": "string",
  • "weight": 0.1
}

Response samples

Content type
application/json
{
  • "failedPolicyRequirements": [
    ],
  • "result": true
}

Action: validateProperty

Verifies that a given property adheres to policy requirements.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
nullId
required
string

Alpha realm - Assignment ID

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "validateProperty"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
property name*
additional property
any

Responses

Request samples

Content type
{
  • "property1": null,
  • "property2": null
}

Response samples

Content type
application/json
{
  • "failedPolicyRequirements": [
    ],
  • "result": true
}

Read

List policies for Alpha realm - Group objects.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "properties": [
    ],
  • "resource": "string"
}

Action: validateObject

Validates a given Alpha realm - Group object against its policy requirements.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
nullId
required
string

Alpha realm - Group ID

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "validateObject"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
property name*
additional property
any

Responses

Request samples

Content type
{
  • "property1": null,
  • "property2": null
}

Response samples

Content type
application/json
{
  • "failedPolicyRequirements": [
    ],
  • "result": true
}

Action: validateProperty

Verifies that a given property adheres to policy requirements.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
nullId
required
string

Alpha realm - Group ID

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "validateProperty"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
property name*
additional property
any

Responses

Request samples

Content type
{
  • "property1": null,
  • "property2": null
}

Response samples

Content type
application/json
{
  • "failedPolicyRequirements": [
    ],
  • "result": true
}

Read

List policies for Alpha realm - Organization objects.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "properties": [
    ],
  • "resource": "string"
}

Action: validateObject

Validates a given Alpha realm - Organization object against its policy requirements.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
nullId
required
string

Alpha realm - Organization ID

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "validateObject"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
adminIDs
Array of strings (Admin user ids)
Array of objects (Administrators)
Array of objects (Child Organizations)

Child Organizations

description
string (Description)
Array of objects (Members)
name
required
string (Name)
ownerIDs
Array of strings (Owner user ids)
Array of objects (Owner)
object (Parent Organization)

Parent Organization

parentAdminIDs
Array of strings (user ids of parent admins)
parentIDs
Array of strings (parent org ids)
parentOwnerIDs
Array of strings (user ids of parent owners)

Responses

Request samples

Content type
{
  • "adminIDs": [
    ],
  • "admins": [
    ],
  • "children": [
    ],
  • "description": "string",
  • "members": [
    ],
  • "name": "string",
  • "ownerIDs": [
    ],
  • "owners": [
    ],
  • "parent": {
    },
  • "parentAdminIDs": [
    ],
  • "parentIDs": [
    ],
  • "parentOwnerIDs": [
    ]
}

Response samples

Content type
application/json
{
  • "failedPolicyRequirements": [
    ],
  • "result": true
}

Action: validateProperty

Verifies that a given property adheres to policy requirements.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
nullId
required
string

Alpha realm - Organization ID

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "validateProperty"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
property name*
additional property
any

Responses

Request samples

Content type
{
  • "property1": null,
  • "property2": null
}

Response samples

Content type
application/json
{
  • "failedPolicyRequirements": [
    ],
  • "result": true
}

Read

List policies for Alpha realm - Role objects.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "properties": [
    ],
  • "resource": "string"
}

Action: validateObject

Validates a given Alpha realm - Role object against its policy requirements.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
nullId
required
string

Alpha realm - Role ID

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "validateObject"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_id
string (Name)

Role ID

Array of objects (Applications)

Role Applications

Array of objects (Managed Assignments)

Managed Assignments

condition
string (Condition)

A conditional filter for this role

description
string (Description)

The role description, used for display purposes.

Array of objects (Role Members)

Role Members

name
required
string (Name)

The role name, used for display purposes.

Array of objects (Temporal Constraints)

An array of temporal constraints for a role

Responses

Request samples

Content type
{
  • "_id": "string",
  • "applications": [
    ],
  • "assignments": [
    ],
  • "condition": "string",
  • "description": "string",
  • "members": [
    ],
  • "name": "string",
  • "temporalConstraints": [
    ]
}

Response samples

Content type
application/json
{
  • "failedPolicyRequirements": [
    ],
  • "result": true
}

Action: validateProperty

Verifies that a given property adheres to policy requirements.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
nullId
required
string

Alpha realm - Role ID

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "validateProperty"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
property name*
additional property
any

Responses

Request samples

Content type
{
  • "property1": null,
  • "property2": null
}

Response samples

Content type
application/json
{
  • "failedPolicyRequirements": [
    ],
  • "result": true
}

Read

List policies for Alpha realm - User objects.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "properties": [
    ],
  • "resource": "string"
}

Action: validateObject

Validates a given Alpha realm - User object against its policy requirements.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
nullId
required
string

Alpha realm - User ID

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "validateObject"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_id
string

User ID

object (Metadata)

Metadata for managed/bravo_usermeta

Array of objects (Notifications)

Notifications

accountStatus
string (Status)
Default: "active"

Status

Array of objects (Organizations I Administer)
aliasList
Array of strings (User Alias Names List)

List of identity aliases used primarily to record social IdP subjects for this user

Array of objects (Applications)

Applications

assignedDashboard
Array of strings (Assigned Dashboard)

List of items to click on for this user

Array of objects (Assignments)

Assignments

Array of objects (Authorization Roles)

Authorization Roles

city
string (City)

City

cn
string (Common Name)
Default: "{{givenName}} {{sn}}"

Common Name

Array of objects (Consented Mappings) [ items ]

Consented Mappings

country
string (Country)

Country

description
string (Description)

Description

effectiveApplications
Array of objects (Effective Applications)

Effective Applications

effectiveAssignments
Array of objects (Effective Assignments)

Effective Assignments

effectiveGroups
Array of objects (Effective Groups)

Effective Groups

effectiveRoles
Array of objects (Effective Roles)

Effective Roles

frIndexedDate1
string (Generic Indexed Date 1)

Generic Indexed Date 1

frIndexedDate2
string (Generic Indexed Date 2)

Generic Indexed Date 2

frIndexedDate3
string (Generic Indexed Date 3)

Generic Indexed Date 3

frIndexedDate4
string (Generic Indexed Date 4)

Generic Indexed Date 4

frIndexedDate5
string (Generic Indexed Date 5)

Generic Indexed Date 5

frIndexedInteger1
number <double> (Generic Indexed Integer 1)

Generic Indexed Integer 1

frIndexedInteger2
number <double> (Generic Indexed Integer 2)

Generic Indexed Integer 2

frIndexedInteger3
number <double> (Generic Indexed Integer 3)

Generic Indexed Integer 3

frIndexedInteger4
number <double> (Generic Indexed Integer 4)

Generic Indexed Integer 4

frIndexedInteger5
number <double> (Generic Indexed Integer 5)

Generic Indexed Integer 5

frIndexedMultivalued1
Array of strings (Generic Indexed Multivalue 1)

Generic Indexed Multivalue 1

frIndexedMultivalued2
Array of strings (Generic Indexed Multivalue 2)

Generic Indexed Multivalue 2

frIndexedMultivalued3
Array of strings (Generic Indexed Multivalue 3)

Generic Indexed Multivalue 3

frIndexedMultivalued4
Array of strings (Generic Indexed Multivalue 4)

Generic Indexed Multivalue 4

frIndexedMultivalued5
Array of strings (Generic Indexed Multivalue 5)

Generic Indexed Multivalue 5

frIndexedString1
string (Generic Indexed String 1)

Generic Indexed String 1

frIndexedString2
string (Generic Indexed String 2)

Generic Indexed String 2

frIndexedString3
string (Generic Indexed String 3)

Generic Indexed String 3

frIndexedString4
string (Generic Indexed String 4)

Generic Indexed String 4

frIndexedString5
string (Generic Indexed String 5)

Generic Indexed String 5

frUnindexedDate1
string (Generic Unindexed Date 1)

Generic Unindexed Date 1

frUnindexedDate2
string (Generic Unindexed Date 2)

Generic Unindexed Date 2

frUnindexedDate3
string (Generic Unindexed Date 3)

Generic Unindexed Date 3

frUnindexedDate4
string (Generic Unindexed Date 4)

Generic Unindexed Date 4

frUnindexedDate5
string (Generic Unindexed Date 5)

Generic Unindexed Date 5

frUnindexedInteger1
number <double> (Generic Unindexed Integer 1)

Generic Unindexed Integer 1

frUnindexedInteger2
number <double> (Generic Unindexed Integer 2)

Generic Unindexed Integer 2

frUnindexedInteger3
number <double> (Generic Unindexed Integer 3)

Generic Unindexed Integer 3

frUnindexedInteger4
number <double> (Generic Unindexed Integer 4)

Generic Unindexed Integer 4

frUnindexedInteger5
number <double> (Generic Unindexed Integer 5)

Generic Unindexed Integer 5

frUnindexedMultivalued1
Array of strings (Generic Unindexed Multivalue 1)

Generic Unindexed Multivalue 1

frUnindexedMultivalued2
Array of strings (Generic Unindexed Multivalue 2)

Generic Unindexed Multivalue 2

frUnindexedMultivalued3
Array of strings (Generic Unindexed Multivalue 3)

Generic Unindexed Multivalue 3

frUnindexedMultivalued4
Array of strings (Generic Unindexed Multivalue 4)

Generic Unindexed Multivalue 4

frUnindexedMultivalued5
Array of strings (Generic Unindexed Multivalue 5)

Generic Unindexed Multivalue 5

frUnindexedString1
string (Generic Unindexed String 1)

Generic Unindexed String 1

frUnindexedString2
string (Generic Unindexed String 2)

Generic Unindexed String 2

frUnindexedString3
string (Generic Unindexed String 3)

Generic Unindexed String 3

frUnindexedString4
string (Generic Unindexed String 4)

Generic Unindexed String 4

frUnindexedString5
string (Generic Unindexed String 5)

Generic Unindexed String 5

givenName
required
string (First Name)

First Name

Array of objects (Groups)

Groups

Array of objects (KBA Info Items)

KBA Info

object (Last Sync timestamp)

Last Sync timestamp

mail
required
string (Email Address)

Email Address

object (Manager)

Manager

Array of objects (Organizations to which I Belong)
memberOfOrgIDs
Array of strings (MemberOfOrgIDs)
Array of objects (Applications I Own)
Array of objects (Organizations I Own)
password
string (Password)

Password

passwordExpirationTime
string (Password Expiration Time)

Password Expiration Time

passwordLastChangedTime
string (Password Last Changed Time)

Password Last Changed Time

postalAddress
string (Address 1)

Address 1

postalCode
string (Postal Code)

Postal Code

object (Preferences)

Preferences

profileImage
string (Profile Image)

Profile Image

Array of objects (Direct Reports)

Direct Reports

Array of objects (Provisioning Roles)

Provisioning Roles

sn
required
string (Last Name)

Last Name

stateProvince
string (State/Province)

State/Province

telephoneNumber
string (Telephone Number) ^\+?([0-9\- \(\)])*$

Telephone Number

userName
required
string (Username) non-empty

Username

Responses

Request samples

Content type
{
  • "_id": "string",
  • "_meta": {
    },
  • "_notifications": [
    ],
  • "accountStatus": "active",
  • "adminOfOrg": [
    ],
  • "aliasList": [
    ],
  • "applications": [
    ],
  • "assignedDashboard": [
    ],
  • "assignments": [
    ],
  • "authzRoles": [
    ],
  • "city": "string",
  • "cn": "{{givenName}} {{sn}}",
  • "consentedMappings": [
    ],
  • "country": "string",
  • "description": "string",
  • "effectiveApplications": [
    ],
  • "effectiveAssignments": [
    ],
  • "effectiveGroups": [
    ],
  • "effectiveRoles": [
    ],
  • "frIndexedDate1": "string",
  • "frIndexedDate2": "string",
  • "frIndexedDate3": "string",
  • "frIndexedDate4": "string",
  • "frIndexedDate5": "string",
  • "frIndexedInteger1": 0.1,
  • "frIndexedInteger2": 0.1,
  • "frIndexedInteger3": 0.1,
  • "frIndexedInteger4": 0.1,
  • "frIndexedInteger5": 0.1,
  • "frIndexedMultivalued1": [
    ],
  • "frIndexedMultivalued2": [
    ],
  • "frIndexedMultivalued3": [
    ],
  • "frIndexedMultivalued4": [
    ],
  • "frIndexedMultivalued5": [
    ],
  • "frIndexedString1": "string",
  • "frIndexedString2": "string",
  • "frIndexedString3": "string",
  • "frIndexedString4": "string",
  • "frIndexedString5": "string",
  • "frUnindexedDate1": "string",
  • "frUnindexedDate2": "string",
  • "frUnindexedDate3": "string",
  • "frUnindexedDate4": "string",
  • "frUnindexedDate5": "string",
  • "frUnindexedInteger1": 0.1,
  • "frUnindexedInteger2": 0.1,
  • "frUnindexedInteger3": 0.1,
  • "frUnindexedInteger4": 0.1,
  • "frUnindexedInteger5": 0.1,
  • "frUnindexedMultivalued1": [
    ],
  • "frUnindexedMultivalued2": [
    ],
  • "frUnindexedMultivalued3": [
    ],
  • "frUnindexedMultivalued4": [
    ],
  • "frUnindexedMultivalued5": [
    ],
  • "frUnindexedString1": "string",
  • "frUnindexedString2": "string",
  • "frUnindexedString3": "string",
  • "frUnindexedString4": "string",
  • "frUnindexedString5": "string",
  • "givenName": "string",
  • "groups": [
    ],
  • "kbaInfo": [
    ],
  • "lastSync": {
    },
  • "mail": "string",
  • "manager": {
    },
  • "memberOfOrg": [
    ],
  • "memberOfOrgIDs": [
    ],
  • "ownerOfApp": [
    ],
  • "ownerOfOrg": [
    ],
  • "password": "string",
  • "passwordExpirationTime": "string",
  • "passwordLastChangedTime": "string",
  • "postalAddress": "string",
  • "postalCode": "string",
  • "preferences": {
    },
  • "profileImage": "string",
  • "reports": [
    ],
  • "roles": [
    ],
  • "sn": "string",
  • "stateProvince": "string",
  • "telephoneNumber": "string",
  • "userName": "string"
}

Response samples

Content type
application/json
{
  • "failedPolicyRequirements": [
    ],
  • "result": true
}

Action: validateProperty

Verifies that a given property adheres to policy requirements.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
nullId
required
string

Alpha realm - User ID

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "validateProperty"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
property name*
additional property
any

Responses

Request samples

Content type
{
  • "property1": null,
  • "property2": null
}

Response samples

Content type
application/json
{
  • "failedPolicyRequirements": [
    ],
  • "result": true
}

Read

List policies for Alpha realm - metadata for user objects.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "properties": [
    ],
  • "resource": "string"
}

Action: validateObject

Validates a given Alpha realm - metadata for user object against its policy requirements.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
nullId
required
string

Alpha realm - metadata for user ID

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "validateObject"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
property name*
additional property
any

Responses

Request samples

Content type
{
  • "property1": null,
  • "property2": null
}

Response samples

Content type
application/json
{
  • "failedPolicyRequirements": [
    ],
  • "result": true
}

Action: validateProperty

Verifies that a given property adheres to policy requirements.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
nullId
required
string

Alpha realm - metadata for user ID

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "validateProperty"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
property name*
additional property
any

Responses

Request samples

Content type
{
  • "property1": null,
  • "property2": null
}

Response samples

Content type
application/json
{
  • "failedPolicyRequirements": [
    ],
  • "result": true
}

Read

List policies for Bravo realm - Application objects.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "properties": [
    ],
  • "resource": "string"
}

Action: validateObject

Validates a given Bravo realm - Application object against its policy requirements.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
nullId
required
string

Bravo realm - Application ID

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "validateObject"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_id
string

Application ID

authoritative
boolean (Authoritative)

Is this an authoritative application

connectorId
string (Connector ID)

Id of the connector associated with the application

description
string (Description)

Application Description

icon
string (Icon)
mappingNames
Array of strings (Sync Mapping Names)

Names of the sync mappings used by an application with provisioning configured.

Array of objects (Members)

Application Members

name
required
string (Name)

Application name

Array of objects (Owners)

Application Owners

Array of objects (Roles)

Roles granting users the application

object (SSO Entity Id)

SSO Entity Id

templateName
string (Template Name)

Name of the template the application was created from

templateVersion
string (Template Version)

The template version

uiConfig
object (UI Config)

UI Config

url
string (Url)

Responses

Request samples

Content type
{
  • "_id": "string",
  • "authoritative": true,
  • "connectorId": "string",
  • "description": "string",
  • "icon": "string",
  • "mappingNames": [
    ],
  • "members": [
    ],
  • "name": "string",
  • "owners": [
    ],
  • "roles": [
    ],
  • "ssoEntities": {
    },
  • "templateName": "string",
  • "templateVersion": "string",
  • "uiConfig": { },
  • "url": "string"
}

Response samples

Content type
application/json
{
  • "failedPolicyRequirements": [
    ],
  • "result": true
}

Action: validateProperty

Verifies that a given property adheres to policy requirements.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
nullId
required
string

Bravo realm - Application ID

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "validateProperty"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
property name*
additional property
any

Responses

Request samples

Content type
{
  • "property1": null,
  • "property2": null
}

Response samples

Content type
application/json
{
  • "failedPolicyRequirements": [
    ],
  • "result": true
}

Read

List policies for Bravo realm - Assignment objects.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "properties": [
    ],
  • "resource": "string"
}

Action: validateObject

Validates a given Bravo realm - Assignment object against its policy requirements.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
nullId
required
string

Bravo realm - Assignment ID

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "validateObject"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_id
string (Name)

The assignment ID

Array of objects (Assignment Attributes)

The attributes operated on by this assignment.

condition
string (Condition)

A conditional filter for this assignment

description
required
string (Description)

The assignment description, used for display purposes.

linkQualifiers
Array of strings (Link Qualifiers)

Conditional link qualifiers to restrict this assignment to.

mapping
required
string (Mapping)

The name of the mapping this assignment applies to

Array of objects (Assignment Members)

Assignment Members

name
required
string (Name)

The assignment name, used for display purposes.

Array of objects (Managed Roles)

Managed Roles

type
string (Type)

The type of object this assignment represents

weight
number <double> (Weight)

The weight of the assignment.

Responses

Request samples

Content type
{
  • "_id": "string",
  • "attributes": [
    ],
  • "condition": "string",
  • "description": "string",
  • "linkQualifiers": [
    ],
  • "mapping": "string",
  • "members": [
    ],
  • "name": "string",
  • "roles": [
    ],
  • "type": "string",
  • "weight": 0.1
}

Response samples

Content type
application/json
{
  • "failedPolicyRequirements": [
    ],
  • "result": true
}

Action: validateProperty

Verifies that a given property adheres to policy requirements.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
nullId
required
string

Bravo realm - Assignment ID

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "validateProperty"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
property name*
additional property
any

Responses

Request samples

Content type
{
  • "property1": null,
  • "property2": null
}

Response samples

Content type
application/json
{
  • "failedPolicyRequirements": [
    ],
  • "result": true
}

Read

List policies for Bravo realm - Group objects.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "properties": [
    ],
  • "resource": "string"
}

Action: validateObject

Validates a given Bravo realm - Group object against its policy requirements.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
nullId
required
string

Bravo realm - Group ID

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "validateObject"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
property name*
additional property
any

Responses

Request samples

Content type
{
  • "property1": null,
  • "property2": null
}

Response samples

Content type
application/json
{
  • "failedPolicyRequirements": [
    ],
  • "result": true
}

Action: validateProperty

Verifies that a given property adheres to policy requirements.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
nullId
required
string

Bravo realm - Group ID

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "validateProperty"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
property name*
additional property
any

Responses

Request samples

Content type
{
  • "property1": null,
  • "property2": null
}

Response samples

Content type
application/json
{
  • "failedPolicyRequirements": [
    ],
  • "result": true
}

Read

List policies for Bravo realm - Organization objects.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "properties": [
    ],
  • "resource": "string"
}

Action: validateObject

Validates a given Bravo realm - Organization object against its policy requirements.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
nullId
required
string

Bravo realm - Organization ID

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "validateObject"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
adminIDs
Array of strings (Admin user ids)
Array of objects (Administrators)
Array of objects (Child Organizations)

Child Organizations

description
string (Description)
Array of objects (Members)
name
required
string (Name)
ownerIDs
Array of strings (Owner user ids)
Array of objects (Owner)
object (Parent Organization)

Parent Organization

parentAdminIDs
Array of strings (user ids of parent admins)
parentIDs
Array of strings (parent org ids)
parentOwnerIDs
Array of strings (user ids of parent owners)

Responses

Request samples

Content type
{
  • "adminIDs": [
    ],
  • "admins": [
    ],
  • "children": [
    ],
  • "description": "string",
  • "members": [
    ],
  • "name": "string",
  • "ownerIDs": [
    ],
  • "owners": [
    ],
  • "parent": {
    },
  • "parentAdminIDs": [
    ],
  • "parentIDs": [
    ],
  • "parentOwnerIDs": [
    ]
}

Response samples

Content type
application/json
{
  • "failedPolicyRequirements": [
    ],
  • "result": true
}

Action: validateProperty

Verifies that a given property adheres to policy requirements.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
nullId
required
string

Bravo realm - Organization ID

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "validateProperty"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
property name*
additional property
any

Responses

Request samples

Content type
{
  • "property1": null,
  • "property2": null
}

Response samples

Content type
application/json
{
  • "failedPolicyRequirements": [
    ],
  • "result": true
}

Read

List policies for Bravo realm - Role objects.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "properties": [
    ],
  • "resource": "string"
}

Action: validateObject

Validates a given Bravo realm - Role object against its policy requirements.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
nullId
required
string

Bravo realm - Role ID

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "validateObject"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_id
string (Name)

Role ID

Array of objects (Applications)

Role Applications

Array of objects (Managed Assignments)

Managed Assignments

condition
string (Condition)

A conditional filter for this role

description
string (Description)

The role description, used for display purposes.

Array of objects (Role Members)

Role Members

name
required
string (Name)

The role name, used for display purposes.

Array of objects (Temporal Constraints)

An array of temporal constraints for a role

Responses

Request samples

Content type
{
  • "_id": "string",
  • "applications": [
    ],
  • "assignments": [
    ],
  • "condition": "string",
  • "description": "string",
  • "members": [
    ],
  • "name": "string",
  • "temporalConstraints": [
    ]
}

Response samples

Content type
application/json
{
  • "failedPolicyRequirements": [
    ],
  • "result": true
}

Action: validateProperty

Verifies that a given property adheres to policy requirements.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
nullId
required
string

Bravo realm - Role ID

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "validateProperty"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
property name*
additional property
any

Responses

Request samples

Content type
{
  • "property1": null,
  • "property2": null
}

Response samples

Content type
application/json
{
  • "failedPolicyRequirements": [
    ],
  • "result": true
}

Read

List policies for Bravo realm - User objects.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "properties": [
    ],
  • "resource": "string"
}

Action: validateObject

Validates a given Bravo realm - User object against its policy requirements.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
nullId
required
string

Bravo realm - User ID

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "validateObject"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_id
string

User ID

object (Metadata)

Metadata for managed/bravo_usermeta

Array of objects (Notifications)

Notifications

accountStatus
string (Status)
Default: "active"

Status

Array of objects (Organizations I Administer)
aliasList
Array of strings (User Alias Names List)

List of identity aliases used primarily to record social IdP subjects for this user

Array of objects (Applications)

Applications

assignedDashboard
Array of strings (Assigned Dashboard)

List of items to click on for this user

Array of objects (Assignments)

Assignments

Array of objects (Authorization Roles)

Authorization Roles

city
string (City)

City

cn
string (Common Name)
Default: "{{givenName}} {{sn}}"

Common Name

Array of objects (Consented Mappings) [ items ]

Consented Mappings

country
string (Country)

Country

description
string (Description)

Description

effectiveApplications
Array of objects (Effective Applications)

Effective Applications

effectiveAssignments
Array of objects (Effective Assignments)

Effective Assignments

effectiveGroups
Array of objects (Effective Groups)

Effective Groups

effectiveRoles
Array of objects (Effective Roles)

Effective Roles

frIndexedDate1
string (Generic Indexed Date 1)

Generic Indexed Date 1

frIndexedDate2
string (Generic Indexed Date 2)

Generic Indexed Date 2

frIndexedDate3
string (Generic Indexed Date 3)

Generic Indexed Date 3

frIndexedDate4
string (Generic Indexed Date 4)

Generic Indexed Date 4

frIndexedDate5
string (Generic Indexed Date 5)

Generic Indexed Date 5

frIndexedInteger1
number <double> (Generic Indexed Integer 1)

Generic Indexed Integer 1

frIndexedInteger2
number <double> (Generic Indexed Integer 2)

Generic Indexed Integer 2

frIndexedInteger3
number <double> (Generic Indexed Integer 3)

Generic Indexed Integer 3

frIndexedInteger4
number <double> (Generic Indexed Integer 4)

Generic Indexed Integer 4

frIndexedInteger5
number <double> (Generic Indexed Integer 5)

Generic Indexed Integer 5

frIndexedMultivalued1
Array of strings (Generic Indexed Multivalue 1)

Generic Indexed Multivalue 1

frIndexedMultivalued2
Array of strings (Generic Indexed Multivalue 2)

Generic Indexed Multivalue 2

frIndexedMultivalued3
Array of strings (Generic Indexed Multivalue 3)

Generic Indexed Multivalue 3

frIndexedMultivalued4
Array of strings (Generic Indexed Multivalue 4)

Generic Indexed Multivalue 4

frIndexedMultivalued5
Array of strings (Generic Indexed Multivalue 5)

Generic Indexed Multivalue 5

frIndexedString1
string (Generic Indexed String 1)

Generic Indexed String 1

frIndexedString2
string (Generic Indexed String 2)

Generic Indexed String 2

frIndexedString3
string (Generic Indexed String 3)

Generic Indexed String 3

frIndexedString4
string (Generic Indexed String 4)

Generic Indexed String 4

frIndexedString5
string (Generic Indexed String 5)

Generic Indexed String 5

frUnindexedDate1
string (Generic Unindexed Date 1)

Generic Unindexed Date 1

frUnindexedDate2
string (Generic Unindexed Date 2)

Generic Unindexed Date 2

frUnindexedDate3
string (Generic Unindexed Date 3)

Generic Unindexed Date 3

frUnindexedDate4
string (Generic Unindexed Date 4)

Generic Unindexed Date 4

frUnindexedDate5
string (Generic Unindexed Date 5)

Generic Unindexed Date 5

frUnindexedInteger1
number <double> (Generic Unindexed Integer 1)

Generic Unindexed Integer 1

frUnindexedInteger2
number <double> (Generic Unindexed Integer 2)

Generic Unindexed Integer 2

frUnindexedInteger3
number <double> (Generic Unindexed Integer 3)

Generic Unindexed Integer 3

frUnindexedInteger4
number <double> (Generic Unindexed Integer 4)

Generic Unindexed Integer 4

frUnindexedInteger5
number <double> (Generic Unindexed Integer 5)

Generic Unindexed Integer 5

frUnindexedMultivalued1
Array of strings (Generic Unindexed Multivalue 1)

Generic Unindexed Multivalue 1

frUnindexedMultivalued2
Array of strings (Generic Unindexed Multivalue 2)

Generic Unindexed Multivalue 2

frUnindexedMultivalued3
Array of strings (Generic Unindexed Multivalue 3)

Generic Unindexed Multivalue 3

frUnindexedMultivalued4
Array of strings (Generic Unindexed Multivalue 4)

Generic Unindexed Multivalue 4

frUnindexedMultivalued5
Array of strings (Generic Unindexed Multivalue 5)

Generic Unindexed Multivalue 5

frUnindexedString1
string (Generic Unindexed String 1)

Generic Unindexed String 1

frUnindexedString2
string (Generic Unindexed String 2)

Generic Unindexed String 2

frUnindexedString3
string (Generic Unindexed String 3)

Generic Unindexed String 3

frUnindexedString4
string (Generic Unindexed String 4)

Generic Unindexed String 4

frUnindexedString5
string (Generic Unindexed String 5)

Generic Unindexed String 5

givenName
required
string (First Name)

First Name

Array of objects (Groups)

Groups

Array of objects (KBA Info Items)

KBA Info

object (Last Sync timestamp)

Last Sync timestamp

mail
required
string (Email Address)

Email Address

object (Manager)

Manager

Array of objects (Organizations to which I Belong)
memberOfOrgIDs
Array of strings (MemberOfOrgIDs)
Array of objects (Applications I Own)
Array of objects (Organizations I Own)
password
string (Password)

Password

passwordExpirationTime
string (Password Expiration Time)

Password Expiration Time

passwordLastChangedTime
string (Password Last Changed Time)

Password Last Changed Time

postalAddress
string (Address 1)

Address 1

postalCode
string (Postal Code)

Postal Code

object (Preferences)

Preferences

profileImage
string (Profile Image)

Profile Image

Array of objects (Direct Reports)

Direct Reports

Array of objects (Provisioning Roles)

Provisioning Roles

sn
required
string (Last Name)

Last Name

stateProvince
string (State/Province)

State/Province

telephoneNumber
string (Telephone Number) ^\+?([0-9\- \(\)])*$

Telephone Number

userName
required
string (Username) non-empty

Username

Responses

Request samples

Content type
{
  • "_id": "string",
  • "_meta": {
    },
  • "_notifications": [
    ],
  • "accountStatus": "active",
  • "adminOfOrg": [
    ],
  • "aliasList": [
    ],
  • "applications": [
    ],
  • "assignedDashboard": [
    ],
  • "assignments": [
    ],
  • "authzRoles": [
    ],
  • "city": "string",
  • "cn": "{{givenName}} {{sn}}",
  • "consentedMappings": [
    ],
  • "country": "string",
  • "description": "string",
  • "effectiveApplications": [
    ],
  • "effectiveAssignments": [
    ],
  • "effectiveGroups": [
    ],
  • "effectiveRoles": [
    ],
  • "frIndexedDate1": "string",
  • "frIndexedDate2": "string",
  • "frIndexedDate3": "string",
  • "frIndexedDate4": "string",
  • "frIndexedDate5": "string",
  • "frIndexedInteger1": 0.1,
  • "frIndexedInteger2": 0.1,
  • "frIndexedInteger3": 0.1,
  • "frIndexedInteger4": 0.1,
  • "frIndexedInteger5": 0.1,
  • "frIndexedMultivalued1": [
    ],
  • "frIndexedMultivalued2": [
    ],
  • "frIndexedMultivalued3": [
    ],
  • "frIndexedMultivalued4": [
    ],
  • "frIndexedMultivalued5": [
    ],
  • "frIndexedString1": "string",
  • "frIndexedString2": "string",
  • "frIndexedString3": "string",
  • "frIndexedString4": "string",
  • "frIndexedString5": "string",
  • "frUnindexedDate1": "string",
  • "frUnindexedDate2": "string",
  • "frUnindexedDate3": "string",
  • "frUnindexedDate4": "string",
  • "frUnindexedDate5": "string",
  • "frUnindexedInteger1": 0.1,
  • "frUnindexedInteger2": 0.1,
  • "frUnindexedInteger3": 0.1,
  • "frUnindexedInteger4": 0.1,
  • "frUnindexedInteger5": 0.1,
  • "frUnindexedMultivalued1": [
    ],
  • "frUnindexedMultivalued2": [
    ],
  • "frUnindexedMultivalued3": [
    ],
  • "frUnindexedMultivalued4": [
    ],
  • "frUnindexedMultivalued5": [
    ],
  • "frUnindexedString1": "string",
  • "frUnindexedString2": "string",
  • "frUnindexedString3": "string",
  • "frUnindexedString4": "string",
  • "frUnindexedString5": "string",
  • "givenName": "string",
  • "groups": [
    ],
  • "kbaInfo": [
    ],
  • "lastSync": {
    },
  • "mail": "string",
  • "manager": {
    },
  • "memberOfOrg": [
    ],
  • "memberOfOrgIDs": [
    ],
  • "ownerOfApp": [
    ],
  • "ownerOfOrg": [
    ],
  • "password": "string",
  • "passwordExpirationTime": "string",
  • "passwordLastChangedTime": "string",
  • "postalAddress": "string",
  • "postalCode": "string",
  • "preferences": {
    },
  • "profileImage": "string",
  • "reports": [
    ],
  • "roles": [
    ],
  • "sn": "string",
  • "stateProvince": "string",
  • "telephoneNumber": "string",
  • "userName": "string"
}

Response samples

Content type
application/json
{
  • "failedPolicyRequirements": [
    ],
  • "result": true
}

Action: validateProperty

Verifies that a given property adheres to policy requirements.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
nullId
required
string

Bravo realm - User ID

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "validateProperty"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
property name*
additional property
any

Responses

Request samples

Content type
{
  • "property1": null,
  • "property2": null
}

Response samples

Content type
application/json
{
  • "failedPolicyRequirements": [
    ],
  • "result": true
}

Read

List policies for Bravo realm - metadata for user objects.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "properties": [
    ],
  • "resource": "string"
}

Action: validateObject

Validates a given Bravo realm - metadata for user object against its policy requirements.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
nullId
required
string

Bravo realm - metadata for user ID

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "validateObject"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
property name*
additional property
any

Responses

Request samples

Content type
{
  • "property1": null,
  • "property2": null
}

Response samples

Content type
application/json
{
  • "failedPolicyRequirements": [
    ],
  • "result": true
}

Action: validateProperty

Verifies that a given property adheres to policy requirements.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
nullId
required
string

Bravo realm - metadata for user ID

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "validateProperty"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
property name*
additional property
any

Responses

Request samples

Content type
{
  • "property1": null,
  • "property2": null
}

Response samples

Content type
application/json
{
  • "failedPolicyRequirements": [
    ],
  • "result": true
}

Read

List policies for Internal Service Account objects.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "properties": [
    ],
  • "resource": "string"
}

Action: validateObject

Validates a given Internal Service Account object against its policy requirements.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
nullId
required
string

Internal Service Account ID

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "validateObject"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_id
string (Account ID)

Account ID

accountStatus
string (Status)
Default: "active"

Status

description
string (Description)

Description

jwks
string (JWKs)

Public JSON Web Keys that are valid for JWT verification

maxCachingTime
number <double> (Max Caching Time)
maxIdleTime
number <double> (Max Idle Time)
maxSessionTime
number <double> (Max Session Time)
name
string (Name)

Name

quotaLimit
number <double> (Quota Limit)
scopes
Array of strings (Scopes)

Authorized Scopes

Responses

Request samples

Content type
{
  • "_id": "string",
  • "accountStatus": "active",
  • "description": "string",
  • "jwks": "string",
  • "maxCachingTime": 0.1,
  • "maxIdleTime": 0.1,
  • "maxSessionTime": 0.1,
  • "name": "string",
  • "quotaLimit": 0.1,
  • "scopes": [
    ]
}

Response samples

Content type
application/json
{
  • "failedPolicyRequirements": [
    ],
  • "result": true
}

Action: validateProperty

Verifies that a given property adheres to policy requirements.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
nullId
required
string

Internal Service Account ID

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "validateProperty"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
property name*
additional property
any

Responses

Request samples

Content type
{
  • "property1": null,
  • "property2": null
}

Response samples

Content type
application/json
{
  • "failedPolicyRequirements": [
    ],
  • "result": true
}

Read

List policies for Admins objects.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "properties": [
    ],
  • "resource": "string"
}

Action: validateObject

Validates a given Admins object against its policy requirements.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
nullId
required
string

Admins ID

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "validateObject"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_id
string

User ID

object (Metadata)

Metadata for managed/teammembermeta

Array of objects (Notifications)

Notifications

accountStatus
string (Status)

Status

aliasList
Array of strings (Admin Alias Names List)

List of identity aliases used to record federated IdP subjects for this admin

cn
string

Common Name

country
string (Country)

Country

givenName
required
string (First Name)

First Name

groups
Array of strings (Groups)

Groups

inviteDate
required
string (Date Invited)

Date Invited

jurisdiction
string (Jurisdiction)

Jurisdiction

mail
required
string (Email Address)

Email Address

onboardDate
string (Date Onboarded)

Date Onboarded

password
string (Password)

Password

sn
required
string (Last Name)

Last Name

userName
required
string (Username) non-empty

Username

Responses

Request samples

Content type
{
  • "_id": "string",
  • "_meta": {
    },
  • "_notifications": [
    ],
  • "accountStatus": "string",
  • "aliasList": [
    ],
  • "cn": "string",
  • "country": "string",
  • "givenName": "string",
  • "groups": [
    ],
  • "inviteDate": "string",
  • "jurisdiction": "string",
  • "mail": "string",
  • "onboardDate": "string",
  • "password": "string",
  • "sn": "string",
  • "userName": "string"
}

Response samples

Content type
application/json
{
  • "failedPolicyRequirements": [
    ],
  • "result": true
}

Action: validateProperty

Verifies that a given property adheres to policy requirements.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
nullId
required
string

Admins ID

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "validateProperty"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
property name*
additional property
any

Responses

Request samples

Content type
{
  • "property1": null,
  • "property2": null
}

Response samples

Content type
application/json
{
  • "failedPolicyRequirements": [
    ],
  • "result": true
}

Read

List policies for teammember - metadata for user objects.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "properties": [
    ],
  • "resource": "string"
}

Action: validateObject

Validates a given teammember - metadata for user object against its policy requirements.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
nullId
required
string

teammember - metadata for user ID

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "validateObject"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
property name*
additional property
any

Responses

Request samples

Content type
{
  • "property1": null,
  • "property2": null
}

Response samples

Content type
application/json
{
  • "failedPolicyRequirements": [
    ],
  • "result": true
}

Action: validateProperty

Verifies that a given property adheres to policy requirements.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
nullId
required
string

teammember - metadata for user ID

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "validateProperty"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
property name*
additional property
any

Responses

Request samples

Content type
{
  • "property1": null,
  • "property2": null
}

Response samples

Content type
application/json
{
  • "failedPolicyRequirements": [
    ],
  • "result": true
}

Privilege v1.0

Action: listPrivileges

List privilege details for the requester.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "listPrivileges"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
object

Responses

Request samples

Content type
{ }

Response samples

Content type
application/json
[
  • {
    }
]

Read

Obtain permission privileges for Alpha realm - Application objects.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "ACTION": {
    },
  • "CREATE": {
    },
  • "DELETE": {
    },
  • "UPDATE": {
    },
  • "VIEW": {
    }
}

Read

Obtain permission privileges for a specified Alpha realm - Application object.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_applicationId
required
string

Alpha realm - Application ID

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "ACTION": {
    },
  • "CREATE": {
    },
  • "DELETE": {
    },
  • "UPDATE": {
    },
  • "VIEW": {
    }
}

Read

Obtain permission privileges for Alpha realm - Assignment objects.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "ACTION": {
    },
  • "CREATE": {
    },
  • "DELETE": {
    },
  • "UPDATE": {
    },
  • "VIEW": {
    }
}

Read

Obtain permission privileges for a specified Alpha realm - Assignment object.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_assignmentId
required
string

Alpha realm - Assignment ID

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "ACTION": {
    },
  • "CREATE": {
    },
  • "DELETE": {
    },
  • "UPDATE": {
    },
  • "VIEW": {
    }
}

Read

Obtain permission privileges for Alpha realm - Group objects.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "ACTION": {
    },
  • "CREATE": {
    },
  • "DELETE": {
    },
  • "UPDATE": {
    },
  • "VIEW": {
    }
}

Read

Obtain permission privileges for a specified Alpha realm - Group object.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_groupId
required
string

Alpha realm - Group ID

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "ACTION": {
    },
  • "CREATE": {
    },
  • "DELETE": {
    },
  • "UPDATE": {
    },
  • "VIEW": {
    }
}

Read

Obtain permission privileges for Alpha realm - Organization objects.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "ACTION": {
    },
  • "CREATE": {
    },
  • "DELETE": {
    },
  • "UPDATE": {
    },
  • "VIEW": {
    }
}

Read

Obtain permission privileges for a specified Alpha realm - Organization object.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_organizationId
required
string

Alpha realm - Organization ID

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "ACTION": {
    },
  • "CREATE": {
    },
  • "DELETE": {
    },
  • "UPDATE": {
    },
  • "VIEW": {
    }
}

Read

Obtain permission privileges for Alpha realm - Role objects.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "ACTION": {
    },
  • "CREATE": {
    },
  • "DELETE": {
    },
  • "UPDATE": {
    },
  • "VIEW": {
    }
}

Read

Obtain permission privileges for a specified Alpha realm - Role object.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_roleId
required
string

Alpha realm - Role ID

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "ACTION": {
    },
  • "CREATE": {
    },
  • "DELETE": {
    },
  • "UPDATE": {
    },
  • "VIEW": {
    }
}

Read

Obtain permission privileges for Alpha realm - User objects.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "ACTION": {
    },
  • "CREATE": {
    },
  • "DELETE": {
    },
  • "UPDATE": {
    },
  • "VIEW": {
    }
}

Read

Obtain permission privileges for a specified Alpha realm - User object.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_userId
required
string

Alpha realm - User ID

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "ACTION": {
    },
  • "CREATE": {
    },
  • "DELETE": {
    },
  • "UPDATE": {
    },
  • "VIEW": {
    }
}

Read

Obtain permission privileges for Alpha realm - metadata for user objects.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "ACTION": {
    },
  • "CREATE": {
    },
  • "DELETE": {
    },
  • "UPDATE": {
    },
  • "VIEW": {
    }
}

Read

Obtain permission privileges for a specified Alpha realm - metadata for user object.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_usermetaId
required
string

Alpha realm - metadata for user ID

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "ACTION": {
    },
  • "CREATE": {
    },
  • "DELETE": {
    },
  • "UPDATE": {
    },
  • "VIEW": {
    }
}

Read

Obtain permission privileges for Bravo realm - Application objects.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "ACTION": {
    },
  • "CREATE": {
    },
  • "DELETE": {
    },
  • "UPDATE": {
    },
  • "VIEW": {
    }
}

Read

Obtain permission privileges for a specified Bravo realm - Application object.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_applicationId
required
string

Bravo realm - Application ID

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "ACTION": {
    },
  • "CREATE": {
    },
  • "DELETE": {
    },
  • "UPDATE": {
    },
  • "VIEW": {
    }
}

Read

Obtain permission privileges for Bravo realm - Assignment objects.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "ACTION": {
    },
  • "CREATE": {
    },
  • "DELETE": {
    },
  • "UPDATE": {
    },
  • "VIEW": {
    }
}

Read

Obtain permission privileges for a specified Bravo realm - Assignment object.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_assignmentId
required
string

Bravo realm - Assignment ID

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "ACTION": {
    },
  • "CREATE": {
    },
  • "DELETE": {
    },
  • "UPDATE": {
    },
  • "VIEW": {
    }
}

Read

Obtain permission privileges for Bravo realm - Group objects.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "ACTION": {
    },
  • "CREATE": {
    },
  • "DELETE": {
    },
  • "UPDATE": {
    },
  • "VIEW": {
    }
}

Read

Obtain permission privileges for a specified Bravo realm - Group object.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_groupId
required
string

Bravo realm - Group ID

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "ACTION": {
    },
  • "CREATE": {
    },
  • "DELETE": {
    },
  • "UPDATE": {
    },
  • "VIEW": {
    }
}

Read

Obtain permission privileges for Bravo realm - Organization objects.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "ACTION": {
    },
  • "CREATE": {
    },
  • "DELETE": {
    },
  • "UPDATE": {
    },
  • "VIEW": {
    }
}

Read

Obtain permission privileges for a specified Bravo realm - Organization object.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_organizationId
required
string

Bravo realm - Organization ID

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "ACTION": {
    },
  • "CREATE": {
    },
  • "DELETE": {
    },
  • "UPDATE": {
    },
  • "VIEW": {
    }
}

Read

Obtain permission privileges for Bravo realm - Role objects.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "ACTION": {
    },
  • "CREATE": {
    },
  • "DELETE": {
    },
  • "UPDATE": {
    },
  • "VIEW": {
    }
}

Read

Obtain permission privileges for a specified Bravo realm - Role object.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_roleId
required
string

Bravo realm - Role ID

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "ACTION": {
    },
  • "CREATE": {
    },
  • "DELETE": {
    },
  • "UPDATE": {
    },
  • "VIEW": {
    }
}

Read

Obtain permission privileges for Bravo realm - User objects.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "ACTION": {
    },
  • "CREATE": {
    },
  • "DELETE": {
    },
  • "UPDATE": {
    },
  • "VIEW": {
    }
}

Read

Obtain permission privileges for a specified Bravo realm - User object.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_userId
required
string

Bravo realm - User ID

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "ACTION": {
    },
  • "CREATE": {
    },
  • "DELETE": {
    },
  • "UPDATE": {
    },
  • "VIEW": {
    }
}

Read

Obtain permission privileges for Bravo realm - metadata for user objects.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "ACTION": {
    },
  • "CREATE": {
    },
  • "DELETE": {
    },
  • "UPDATE": {
    },
  • "VIEW": {
    }
}

Read

Obtain permission privileges for a specified Bravo realm - metadata for user object.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_usermetaId
required
string

Bravo realm - metadata for user ID

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "ACTION": {
    },
  • "CREATE": {
    },
  • "DELETE": {
    },
  • "UPDATE": {
    },
  • "VIEW": {
    }
}

Read

Obtain permission privileges for Internal Service Account objects.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "ACTION": {
    },
  • "CREATE": {
    },
  • "DELETE": {
    },
  • "UPDATE": {
    },
  • "VIEW": {
    }
}

Read

Obtain permission privileges for a specified Internal Service Account object.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
svcacctId
required
string

Internal Service Account ID

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "ACTION": {
    },
  • "CREATE": {
    },
  • "DELETE": {
    },
  • "UPDATE": {
    },
  • "VIEW": {
    }
}

Read

Obtain permission privileges for Admins objects.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "ACTION": {
    },
  • "CREATE": {
    },
  • "DELETE": {
    },
  • "UPDATE": {
    },
  • "VIEW": {
    }
}

Read

Obtain permission privileges for a specified Admins object.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
teammemberId
required
string

Admins ID

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "ACTION": {
    },
  • "CREATE": {
    },
  • "DELETE": {
    },
  • "UPDATE": {
    },
  • "VIEW": {
    }
}

Read

Obtain permission privileges for teammember - metadata for user objects.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "ACTION": {
    },
  • "CREATE": {
    },
  • "DELETE": {
    },
  • "UPDATE": {
    },
  • "VIEW": {
    }
}

Read

Obtain permission privileges for a specified teammember - metadata for user object.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
teammembermetaId
required
string

teammember - metadata for user ID

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "ACTION": {
    },
  • "CREATE": {
    },
  • "DELETE": {
    },
  • "UPDATE": {
    },
  • "VIEW": {
    }
}

Reconciliation Association Entry v1.0

Query by Filter

Queries recon association status.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
reconId
required
string

Recon ID

query Parameters
sourceQueryFilter
string

Optional query filter that merges entries with source objects

targetQueryFilter
string

Optional query filter that merges entries with target objects

_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Read

Reads a recon association entry.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
reconId
required
string

Recon ID

id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_rev": "string",
  • "action": "string",
  • "exception": "string",
  • "linkQualifier": "string",
  • "message": "string",
  • "messageDetail": {
    },
  • "phase": "string",
  • "reconId": "string",
  • "situation": "string",
  • "sourceObjectId": "string",
  • "status": "string",
  • "targetObjectId": "string"
}

Reconciliation Association Header v1.0

Query by Filter

Queries recons for which association state is available.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Read

Reads a recon association header, identified by recon id.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_rev": "string",
  • "finishTime": "string",
  • "mapping": "string",
  • "sourceResourceCollection": "string",
  • "targetResourceCollection": "string"
}

Reconciliation v1.0

Action: recon

Recon all available source identifiers.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
mapping
required
string

Mapping name (e.g., systemXmlfileAccounts_managedUser)

waitForCompletion
boolean

When true, request will block until reconciliation completes, and will respond immediately when false.

persistAssociations
boolean

When true, association data will be persisted within the repository. Defaults to false.

_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "recon"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "state": "ACTIVE"
}

Action: reconById

Recon for a single source identifier.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
mapping
required
string

Mapping name (e.g., systemXmlfileAccounts_managedUser)

waitForCompletion
boolean

When true, request will block until reconciliation completes, and will respond immediately when false.

amendReconAssociation
boolean

When true, amend association data within the repository. Defaults to false.

id
required
string

Source identifier

_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "reconById"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "state": "ACTIVE"
}

Read

Lists all reconciliation summaries.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "reconciliations": [
    ]
}

Action: cancel

Cancels a running reconciliation

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
reconId
required
string

Recon ID

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "cancel"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "action": "string",
  • "status": "string"
}

Action: markCanceled

Forcibly marks a reconciliation as canceled.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
reconId
required
string

Recon ID

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "markCanceled"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "action": "string",
  • "message": "string",
  • "status": "string"
}

Read

Read an individual reconciliation summary.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
reconId
required
string

Recon ID

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "duration": 0,
  • "durationSummary": { },
  • "ended": "2019-08-24T14:15:22Z",
  • "mapping": "string",
  • "parameters": { },
  • "progress": {
    },
  • "situationSummary": { },
  • "stage": "ACTIVE_INITIALIZED",
  • "stageDescription": "string",
  • "started": "2019-08-24T14:15:22Z",
  • "state": "ACTIVE",
  • "statusSummary": { }
}

Scheduler Job v1.0

Action: create

Creates a schedule with a system-generated ID.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "create"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
concurrentExecution
boolean
Default: false

Reschedule the job even when a previous run is still executing

enabled
boolean
Default: true

Enable this job schedule

endTime
string <date-time>

End time for job in ISO 8601 date-time format

invokeContext
object

Context object to be passed to the invokeService

invokeLogLevel
string
Default: "INFO"
Enum: "ERROR" "WARN" "INFO" "DEBUG" "TRACE"

The SLF4J log level used while invoking the job

invokeService
required
string

Service PID of the service to be invoked. If no '.' is included, it is prefixed with 'org.forgerock.openidm.'

misfirePolicy
string
Default: "fireAndProceed"
Enum: "doNothing" "fireAndProceed"

Misfire handling policy

persisted
boolean
Default: false

True to persist schedule and false for in-memory

recoverable
boolean
Default: false

Schedule a new recovery job when previous run fails during execution

repeatCount
integer <int32> >= -1
Default: -1

Repeat count for schedule type 'simple' (-1 to repeat indefinitely)

repeatInterval
integer <int64> >= 0
Default: 0

Repeat interval, in milliseconds, for schedule type 'simple'

schedule
string

Cron expression to use for schedule type 'cron'

startTime
string <date-time>

Start time for job in ISO 8601 date-time format

type
string
Default: "cron"
Enum: "cron" "simple"

Schedule type

Responses

Request samples

Content type
{
  • "concurrentExecution": false,
  • "enabled": true,
  • "endTime": "2019-08-24T14:15:22Z",
  • "invokeContext": { },
  • "invokeLogLevel": "ERROR",
  • "invokeService": "string",
  • "misfirePolicy": "doNothing",
  • "persisted": false,
  • "recoverable": false,
  • "repeatCount": -1,
  • "repeatInterval": 0,
  • "schedule": "string",
  • "startTime": "2019-08-24T14:15:22Z",
  • "type": "cron"
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "concurrentExecution": false,
  • "enabled": true,
  • "endTime": "2019-08-24T14:15:22Z",
  • "invokeContext": { },
  • "invokeLogLevel": "ERROR",
  • "invokeService": "string",
  • "misfirePolicy": "doNothing",
  • "nextRunDate": "2019-08-24T14:15:22Z",
  • "persisted": false,
  • "recoverable": false,
  • "repeatCount": -1,
  • "repeatInterval": 0,
  • "schedule": "string",
  • "startTime": "2019-08-24T14:15:22Z",
  • "triggers": [
    ],
  • "type": "cron"
}

Action: listCurrentlyExecutingJobs

Returns a list of the jobs that are currently running.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "listCurrentlyExecutingJobs"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Action: pauseJobs

Suspends all scheduled jobs.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "pauseJobs"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Action: resumeJobs

Resumes all suspended scheduled jobs.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "resumeJobs"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Query by Filter

Queries the existing defined schedules.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Create with Client-Assigned ID

Creates or updates a schedule with the specified ID.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_id
string

Job instance ID

concurrentExecution
boolean
Default: false

Reschedule the job even when a previous run is still executing

enabled
boolean
Default: true

Enable this job schedule

endTime
string <date-time>

End time for job in ISO 8601 date-time format

invokeContext
object

Context object to be passed to the invokeService

invokeLogLevel
string
Default: "INFO"
Enum: "ERROR" "WARN" "INFO" "DEBUG" "TRACE"

The SLF4J log level used while invoking the job

invokeService
required
string

Service PID of the service to be invoked. If no '.' is included, it is prefixed with 'org.forgerock.openidm.'

misfirePolicy
string
Default: "fireAndProceed"
Enum: "doNothing" "fireAndProceed"

Misfire handling policy

nextRunDate
string <date-time>

Next run date for job in ISO 8601 date-time format

persisted
boolean
Default: false

True to persist schedule and false for in-memory

recoverable
boolean
Default: false

Schedule a new recovery job when previous run fails during execution

repeatCount
integer <int32> >= -1
Default: -1

Repeat count for schedule type 'simple' (-1 to repeat indefinitely)

repeatInterval
integer <int64> >= 0
Default: 0

Repeat interval, in milliseconds, for schedule type 'simple'

schedule
string

Cron expression to use for schedule type 'cron'

startTime
string <date-time>

Start time for job in ISO 8601 date-time format

Array of objects (State of a Quartz Trigger)

List of triggers that will fire this Scheduled Job

type
string
Default: "cron"
Enum: "cron" "simple"

Schedule type

Responses

Request samples

Content type
{
  • "_id": "string",
  • "concurrentExecution": false,
  • "enabled": true,
  • "endTime": "2019-08-24T14:15:22Z",
  • "invokeContext": { },
  • "invokeLogLevel": "ERROR",
  • "invokeService": "string",
  • "misfirePolicy": "doNothing",
  • "nextRunDate": "2019-08-24T14:15:22Z",
  • "persisted": false,
  • "recoverable": false,
  • "repeatCount": -1,
  • "repeatInterval": 0,
  • "schedule": "string",
  • "startTime": "2019-08-24T14:15:22Z",
  • "triggers": [
    ],
  • "type": "cron"
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "concurrentExecution": false,
  • "enabled": true,
  • "endTime": "2019-08-24T14:15:22Z",
  • "invokeContext": { },
  • "invokeLogLevel": "ERROR",
  • "invokeService": "string",
  • "misfirePolicy": "doNothing",
  • "nextRunDate": "2019-08-24T14:15:22Z",
  • "persisted": false,
  • "recoverable": false,
  • "repeatCount": -1,
  • "repeatInterval": 0,
  • "schedule": "string",
  • "startTime": "2019-08-24T14:15:22Z",
  • "triggers": [
    ],
  • "type": "cron"
}

Delete

Deletes the specified schedule.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "concurrentExecution": false,
  • "enabled": true,
  • "endTime": "2019-08-24T14:15:22Z",
  • "invokeContext": { },
  • "invokeLogLevel": "ERROR",
  • "invokeService": "string",
  • "misfirePolicy": "doNothing",
  • "nextRunDate": "2019-08-24T14:15:22Z",
  • "persisted": false,
  • "recoverable": false,
  • "repeatCount": -1,
  • "repeatInterval": 0,
  • "schedule": "string",
  • "startTime": "2019-08-24T14:15:22Z",
  • "triggers": [
    ],
  • "type": "cron"
}

Read

Obtains the details of the specified schedule.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "concurrentExecution": false,
  • "enabled": true,
  • "endTime": "2019-08-24T14:15:22Z",
  • "invokeContext": { },
  • "invokeLogLevel": "ERROR",
  • "invokeService": "string",
  • "misfirePolicy": "doNothing",
  • "nextRunDate": "2019-08-24T14:15:22Z",
  • "persisted": false,
  • "recoverable": false,
  • "repeatCount": -1,
  • "repeatInterval": 0,
  • "schedule": "string",
  • "startTime": "2019-08-24T14:15:22Z",
  • "triggers": [
    ],
  • "type": "cron"
}

Update

Update the job schedule.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
required
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_id
string

Job instance ID

concurrentExecution
boolean
Default: false

Reschedule the job even when a previous run is still executing

enabled
boolean
Default: true

Enable this job schedule

endTime
string <date-time>

End time for job in ISO 8601 date-time format

invokeContext
object

Context object to be passed to the invokeService

invokeLogLevel
string
Default: "INFO"
Enum: "ERROR" "WARN" "INFO" "DEBUG" "TRACE"

The SLF4J log level used while invoking the job

invokeService
required
string

Service PID of the service to be invoked. If no '.' is included, it is prefixed with 'org.forgerock.openidm.'

misfirePolicy
string
Default: "fireAndProceed"
Enum: "doNothing" "fireAndProceed"

Misfire handling policy

nextRunDate
string <date-time>

Next run date for job in ISO 8601 date-time format

persisted
boolean
Default: false

True to persist schedule and false for in-memory

recoverable
boolean
Default: false

Schedule a new recovery job when previous run fails during execution

repeatCount
integer <int32> >= -1
Default: -1

Repeat count for schedule type 'simple' (-1 to repeat indefinitely)

repeatInterval
integer <int64> >= 0
Default: 0

Repeat interval, in milliseconds, for schedule type 'simple'

schedule
string

Cron expression to use for schedule type 'cron'

startTime
string <date-time>

Start time for job in ISO 8601 date-time format

Array of objects (State of a Quartz Trigger)

List of triggers that will fire this Scheduled Job

type
string
Default: "cron"
Enum: "cron" "simple"

Schedule type

Responses

Request samples

Content type
{
  • "_id": "string",
  • "concurrentExecution": false,
  • "enabled": true,
  • "endTime": "2019-08-24T14:15:22Z",
  • "invokeContext": { },
  • "invokeLogLevel": "ERROR",
  • "invokeService": "string",
  • "misfirePolicy": "doNothing",
  • "nextRunDate": "2019-08-24T14:15:22Z",
  • "persisted": false,
  • "recoverable": false,
  • "repeatCount": -1,
  • "repeatInterval": 0,
  • "schedule": "string",
  • "startTime": "2019-08-24T14:15:22Z",
  • "triggers": [
    ],
  • "type": "cron"
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "concurrentExecution": false,
  • "enabled": true,
  • "endTime": "2019-08-24T14:15:22Z",
  • "invokeContext": { },
  • "invokeLogLevel": "ERROR",
  • "invokeService": "string",
  • "misfirePolicy": "doNothing",
  • "nextRunDate": "2019-08-24T14:15:22Z",
  • "persisted": false,
  • "recoverable": false,
  • "repeatCount": -1,
  • "repeatInterval": 0,
  • "schedule": "string",
  • "startTime": "2019-08-24T14:15:22Z",
  • "triggers": [
    ],
  • "type": "cron"
}

Scheduler Job v2.0

Action: create

Creates a schedule with a system-generated ID.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "create"
header Parameters
Accept-API-Version
required
string
Value: "resource=2.0"
Request Body schema:
required
concurrentExecution
boolean
Default: false

Reschedule the job even when a previous run is still executing

enabled
boolean
Default: true

Enable this job schedule

endTime
string <date-time>

End time for job in ISO 8601 date-time format

invokeContext
object

Context object to be passed to the invokeService

invokeLogLevel
string
Default: "INFO"
Enum: "ERROR" "WARN" "INFO" "DEBUG" "TRACE"

The SLF4J log level used while invoking the job

invokeService
required
string

Service PID of the service to be invoked. If no '.' is included, it is prefixed with 'org.forgerock.openidm.'

misfirePolicy
string
Default: "fireAndProceed"
Enum: "doNothing" "fireAndProceed"

Misfire handling policy

persisted
boolean
Default: false

True to persist schedule and false for in-memory

recoverable
boolean
Default: false

Schedule a new recovery job when previous run fails during execution

repeatCount
integer <int32> >= -1
Default: -1

Repeat count for schedule type 'simple' (-1 to repeat indefinitely)

repeatInterval
integer <int64> >= 0
Default: 0

Repeat interval, in milliseconds, for schedule type 'simple'

schedule
string

Cron expression to use for schedule type 'cron'

startTime
string <date-time>

Start time for job in ISO 8601 date-time format

type
string
Default: "cron"
Enum: "cron" "simple"

Schedule type

Responses

Request samples

Content type
{
  • "concurrentExecution": false,
  • "enabled": true,
  • "endTime": "2019-08-24T14:15:22Z",
  • "invokeContext": { },
  • "invokeLogLevel": "ERROR",
  • "invokeService": "string",
  • "misfirePolicy": "doNothing",
  • "persisted": false,
  • "recoverable": false,
  • "repeatCount": -1,
  • "repeatInterval": 0,
  • "schedule": "string",
  • "startTime": "2019-08-24T14:15:22Z",
  • "type": "cron"
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "concurrentExecution": false,
  • "enabled": true,
  • "endTime": "2019-08-24T14:15:22Z",
  • "invokeContext": { },
  • "invokeLogLevel": "ERROR",
  • "invokeService": "string",
  • "misfirePolicy": "doNothing",
  • "nextRunDate": "2019-08-24T14:15:22Z",
  • "persisted": false,
  • "previousRunDate": "2019-08-24T14:15:22Z",
  • "recoverable": false,
  • "repeatCount": -1,
  • "repeatInterval": 0,
  • "schedule": "string",
  • "startTime": "2019-08-24T14:15:22Z",
  • "triggers": [
    ],
  • "type": "cron"
}

Action: listCurrentlyExecutingJobs

Returns a list of the jobs that are currently running.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "listCurrentlyExecutingJobs"
header Parameters
Accept-API-Version
required
string
Value: "resource=2.0"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Action: pauseJobs

Suspends all scheduled jobs.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "pauseJobs"
header Parameters
Accept-API-Version
required
string
Value: "resource=2.0"

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Action: resumeJobs

Resumes all suspended scheduled jobs.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "resumeJobs"
header Parameters
Accept-API-Version
required
string
Value: "resource=2.0"

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Action: validateQuartzCronExpression

Validates a cron expression.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "validateQuartzCronExpression"
header Parameters
Accept-API-Version
required
string
Value: "resource=2.0"
Request Body schema:
required
cronExpression
string

Cron expression to test for validity

Responses

Request samples

Content type
{
  • "cronExpression": "string"
}

Response samples

Content type
application/json
{
  • "valid": true
}

Query by Filter

Queries the existing defined schedules.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=2.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Action: pause

Pause the specified job.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "pause"
header Parameters
Accept-API-Version
required
string
Value: "resource=2.0"

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Action: resume

Resume the specified job.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "resume"
header Parameters
Accept-API-Version
required
string
Value: "resource=2.0"

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Action: trigger

Trigger the specified job.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "trigger"
header Parameters
Accept-API-Version
required
string
Value: "resource=2.0"

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Create with Client-Assigned ID

Creates or updates a schedule with the specified ID.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=2.0"
Request Body schema:
required
_id
string

Job instance ID

concurrentExecution
boolean
Default: false

Reschedule the job even when a previous run is still executing

enabled
boolean
Default: true

Enable this job schedule

endTime
string <date-time>

End time for job in ISO 8601 date-time format

invokeContext
object

Context object to be passed to the invokeService

invokeLogLevel
string
Default: "INFO"
Enum: "ERROR" "WARN" "INFO" "DEBUG" "TRACE"

The SLF4J log level used while invoking the job

invokeService
required
string

Service PID of the service to be invoked. If no '.' is included, it is prefixed with 'org.forgerock.openidm.'

misfirePolicy
string
Default: "fireAndProceed"
Enum: "doNothing" "fireAndProceed"

Misfire handling policy

nextRunDate
string <date-time>

Next run date for job in ISO 8601 date-time format

persisted
boolean
Default: false

True to persist schedule and false for in-memory

previousRunDate
string <date-time>

Previous run date for job in ISO 8601 date-time format

recoverable
boolean
Default: false

Schedule a new recovery job when previous run fails during execution

repeatCount
integer <int32> >= -1
Default: -1

Repeat count for schedule type 'simple' (-1 to repeat indefinitely)

repeatInterval
integer <int64> >= 0
Default: 0

Repeat interval, in milliseconds, for schedule type 'simple'

schedule
string

Cron expression to use for schedule type 'cron'

startTime
string <date-time>

Start time for job in ISO 8601 date-time format

Array of objects (State of a Quartz Trigger)

List of triggers that will fire this Scheduled Job

type
string
Default: "cron"
Enum: "cron" "simple"

Schedule type

Responses

Request samples

Content type
{
  • "_id": "string",
  • "concurrentExecution": false,
  • "enabled": true,
  • "endTime": "2019-08-24T14:15:22Z",
  • "invokeContext": { },
  • "invokeLogLevel": "ERROR",
  • "invokeService": "string",
  • "misfirePolicy": "doNothing",
  • "nextRunDate": "2019-08-24T14:15:22Z",
  • "persisted": false,
  • "previousRunDate": "2019-08-24T14:15:22Z",
  • "recoverable": false,
  • "repeatCount": -1,
  • "repeatInterval": 0,
  • "schedule": "string",
  • "startTime": "2019-08-24T14:15:22Z",
  • "triggers": [
    ],
  • "type": "cron"
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "concurrentExecution": false,
  • "enabled": true,
  • "endTime": "2019-08-24T14:15:22Z",
  • "invokeContext": { },
  • "invokeLogLevel": "ERROR",
  • "invokeService": "string",
  • "misfirePolicy": "doNothing",
  • "nextRunDate": "2019-08-24T14:15:22Z",
  • "persisted": false,
  • "previousRunDate": "2019-08-24T14:15:22Z",
  • "recoverable": false,
  • "repeatCount": -1,
  • "repeatInterval": 0,
  • "schedule": "string",
  • "startTime": "2019-08-24T14:15:22Z",
  • "triggers": [
    ],
  • "type": "cron"
}

Delete

Deletes the specified schedule.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=2.0"

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "concurrentExecution": false,
  • "enabled": true,
  • "endTime": "2019-08-24T14:15:22Z",
  • "invokeContext": { },
  • "invokeLogLevel": "ERROR",
  • "invokeService": "string",
  • "misfirePolicy": "doNothing",
  • "nextRunDate": "2019-08-24T14:15:22Z",
  • "persisted": false,
  • "previousRunDate": "2019-08-24T14:15:22Z",
  • "recoverable": false,
  • "repeatCount": -1,
  • "repeatInterval": 0,
  • "schedule": "string",
  • "startTime": "2019-08-24T14:15:22Z",
  • "triggers": [
    ],
  • "type": "cron"
}

Read

Obtains the details of the specified schedule.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=2.0"

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "concurrentExecution": false,
  • "enabled": true,
  • "endTime": "2019-08-24T14:15:22Z",
  • "invokeContext": { },
  • "invokeLogLevel": "ERROR",
  • "invokeService": "string",
  • "misfirePolicy": "doNothing",
  • "nextRunDate": "2019-08-24T14:15:22Z",
  • "persisted": false,
  • "previousRunDate": "2019-08-24T14:15:22Z",
  • "recoverable": false,
  • "repeatCount": -1,
  • "repeatInterval": 0,
  • "schedule": "string",
  • "startTime": "2019-08-24T14:15:22Z",
  • "triggers": [
    ],
  • "type": "cron"
}

Update

Update the job schedule.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
required
string
Default: *
Accept-API-Version
required
string
Value: "resource=2.0"
Request Body schema:
required
_id
string

Job instance ID

concurrentExecution
boolean
Default: false

Reschedule the job even when a previous run is still executing

enabled
boolean
Default: true

Enable this job schedule

endTime
string <date-time>

End time for job in ISO 8601 date-time format

invokeContext
object

Context object to be passed to the invokeService

invokeLogLevel
string
Default: "INFO"
Enum: "ERROR" "WARN" "INFO" "DEBUG" "TRACE"

The SLF4J log level used while invoking the job

invokeService
required
string

Service PID of the service to be invoked. If no '.' is included, it is prefixed with 'org.forgerock.openidm.'

misfirePolicy
string
Default: "fireAndProceed"
Enum: "doNothing" "fireAndProceed"

Misfire handling policy

nextRunDate
string <date-time>

Next run date for job in ISO 8601 date-time format

persisted
boolean
Default: false

True to persist schedule and false for in-memory

previousRunDate
string <date-time>

Previous run date for job in ISO 8601 date-time format

recoverable
boolean
Default: false

Schedule a new recovery job when previous run fails during execution

repeatCount
integer <int32> >= -1
Default: -1

Repeat count for schedule type 'simple' (-1 to repeat indefinitely)

repeatInterval
integer <int64> >= 0
Default: 0

Repeat interval, in milliseconds, for schedule type 'simple'

schedule
string

Cron expression to use for schedule type 'cron'

startTime
string <date-time>

Start time for job in ISO 8601 date-time format

Array of objects (State of a Quartz Trigger)

List of triggers that will fire this Scheduled Job

type
string
Default: "cron"
Enum: "cron" "simple"

Schedule type

Responses

Request samples

Content type
{
  • "_id": "string",
  • "concurrentExecution": false,
  • "enabled": true,
  • "endTime": "2019-08-24T14:15:22Z",
  • "invokeContext": { },
  • "invokeLogLevel": "ERROR",
  • "invokeService": "string",
  • "misfirePolicy": "doNothing",
  • "nextRunDate": "2019-08-24T14:15:22Z",
  • "persisted": false,
  • "previousRunDate": "2019-08-24T14:15:22Z",
  • "recoverable": false,
  • "repeatCount": -1,
  • "repeatInterval": 0,
  • "schedule": "string",
  • "startTime": "2019-08-24T14:15:22Z",
  • "triggers": [
    ],
  • "type": "cron"
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "concurrentExecution": false,
  • "enabled": true,
  • "endTime": "2019-08-24T14:15:22Z",
  • "invokeContext": { },
  • "invokeLogLevel": "ERROR",
  • "invokeService": "string",
  • "misfirePolicy": "doNothing",
  • "nextRunDate": "2019-08-24T14:15:22Z",
  • "persisted": false,
  • "previousRunDate": "2019-08-24T14:15:22Z",
  • "recoverable": false,
  • "repeatCount": -1,
  • "repeatInterval": 0,
  • "schedule": "string",
  • "startTime": "2019-08-24T14:15:22Z",
  • "triggers": [
    ],
  • "type": "cron"
}

Scheduler Trigger v1.0

Query by Filter

Queries the existing triggers.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Read

Obtains the details of the specified trigger.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_rev": "string",
  • "acquired": true,
  • "calendar": "string",
  • "group": "string",
  • "jobName": "string",
  • "name": "string",
  • "nodeId": "string",
  • "previousState": 0,
  • "serialized": "string",
  • "state": 0
}

Scheduler Trigger v2.0

Query by Filter

Queries the existing triggers.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=2.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Read

Obtains the details of the specified trigger.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=2.0"

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_rev": "string",
  • "calendar": "string",
  • "group": "string",
  • "jobKey": "string",
  • "name": "string",
  • "nodeId": "string",
  • "previousState": "string",
  • "serialized": { },
  • "state": "string"
}

Schema v2.0

Create with Client-Assigned ID

Create a property from managed/alpha_application/properties.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=2.0"
Request Body schema:
required
description
string

Specifies a brief description of the property.

isPersonal
boolean

Designed to highlight personally identifying information.

notify
boolean

Specifies if the referenced object should be notified when there is a relationship change.

notifyRelationships
Array of strings

Controls the propagation of notifications out of an object when one of its properties changes orwhen that object receives a notification through one of these fields.

notifySelf
boolean

Specifies if the origin object should be notified when there is a relationship change.

required
object (The properties of this JSON schema object)

The properties defined in the JSON schema.

required
Array of objects (Details a Resource Collection this property maps to)

The collection of resources (objects) on which this relationship is based.

returnByDefault
boolean

Specifies whether the property will be returned in the results of a query on an object of this typeif it is not explicitly requested

reversePropertyName
required
string

The corresponding property name, in the case of a bidirectional relationship.

reverseRelationship
required
boolean

Specifies whether this is a bidirectional relationship.

title
string

A human-readable string, used to display the property in the UI.

type
required
string

Specifies the type and cardinality this relationship is.

usageDescription
string

Designed to help end users understand the sensitivity of a property such as a telephone number.

userEditable
boolean

Specifies whether the relationship property is editable by the user.

validate
boolean

Specifies whether the relationship should be validated.

viewable
boolean

Specifies whether this property is viewable in the object’s profile in the UI.

Responses

Request samples

Content type
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Update

Update a property from managed/alpha_application/properties.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
required
string
Default: *
Accept-API-Version
required
string
Value: "resource=2.0"
Request Body schema:
required
description
string

Specifies a brief description of the property.

isPersonal
boolean

Designed to highlight personally identifying information.

notify
boolean

Specifies if the referenced object should be notified when there is a relationship change.

notifyRelationships
Array of strings

Controls the propagation of notifications out of an object when one of its properties changes orwhen that object receives a notification through one of these fields.

notifySelf
boolean

Specifies if the origin object should be notified when there is a relationship change.

required
object (The properties of this JSON schema object)

The properties defined in the JSON schema.

required
Array of objects (Details a Resource Collection this property maps to)

The collection of resources (objects) on which this relationship is based.

returnByDefault
boolean

Specifies whether the property will be returned in the results of a query on an object of this typeif it is not explicitly requested

reversePropertyName
required
string

The corresponding property name, in the case of a bidirectional relationship.

reverseRelationship
required
boolean

Specifies whether this is a bidirectional relationship.

title
string

A human-readable string, used to display the property in the UI.

type
required
string

Specifies the type and cardinality this relationship is.

usageDescription
string

Designed to help end users understand the sensitivity of a property such as a telephone number.

userEditable
boolean

Specifies whether the relationship property is editable by the user.

validate
boolean

Specifies whether the relationship should be validated.

viewable
boolean

Specifies whether this property is viewable in the object’s profile in the UI.

Responses

Request samples

Content type
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Create with Client-Assigned ID

Create a property from managed/alpha_assignment/properties.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=2.0"
Request Body schema:
required
description
string

Specifies a brief description of the property.

isPersonal
boolean

Designed to highlight personally identifying information.

notify
boolean

Specifies if the referenced object should be notified when there is a relationship change.

notifyRelationships
Array of strings

Controls the propagation of notifications out of an object when one of its properties changes orwhen that object receives a notification through one of these fields.

notifySelf
boolean

Specifies if the origin object should be notified when there is a relationship change.

required
object (The properties of this JSON schema object)

The properties defined in the JSON schema.

required
Array of objects (Details a Resource Collection this property maps to)

The collection of resources (objects) on which this relationship is based.

returnByDefault
boolean

Specifies whether the property will be returned in the results of a query on an object of this typeif it is not explicitly requested

reversePropertyName
required
string

The corresponding property name, in the case of a bidirectional relationship.

reverseRelationship
required
boolean

Specifies whether this is a bidirectional relationship.

title
string

A human-readable string, used to display the property in the UI.

type
required
string

Specifies the type and cardinality this relationship is.

usageDescription
string

Designed to help end users understand the sensitivity of a property such as a telephone number.

userEditable
boolean

Specifies whether the relationship property is editable by the user.

validate
boolean

Specifies whether the relationship should be validated.

viewable
boolean

Specifies whether this property is viewable in the object’s profile in the UI.

Responses

Request samples

Content type
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Update

Update a property from managed/alpha_assignment/properties.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
required
string
Default: *
Accept-API-Version
required
string
Value: "resource=2.0"
Request Body schema:
required
description
string

Specifies a brief description of the property.

isPersonal
boolean

Designed to highlight personally identifying information.

notify
boolean

Specifies if the referenced object should be notified when there is a relationship change.

notifyRelationships
Array of strings

Controls the propagation of notifications out of an object when one of its properties changes orwhen that object receives a notification through one of these fields.

notifySelf
boolean

Specifies if the origin object should be notified when there is a relationship change.

required
object (The properties of this JSON schema object)

The properties defined in the JSON schema.

required
Array of objects (Details a Resource Collection this property maps to)

The collection of resources (objects) on which this relationship is based.

returnByDefault
boolean

Specifies whether the property will be returned in the results of a query on an object of this typeif it is not explicitly requested

reversePropertyName
required
string

The corresponding property name, in the case of a bidirectional relationship.

reverseRelationship
required
boolean

Specifies whether this is a bidirectional relationship.

title
string

A human-readable string, used to display the property in the UI.

type
required
string

Specifies the type and cardinality this relationship is.

usageDescription
string

Designed to help end users understand the sensitivity of a property such as a telephone number.

userEditable
boolean

Specifies whether the relationship property is editable by the user.

validate
boolean

Specifies whether the relationship should be validated.

viewable
boolean

Specifies whether this property is viewable in the object’s profile in the UI.

Responses

Request samples

Content type
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Create with Client-Assigned ID

Create a property from managed/alpha_group/properties.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=2.0"
Request Body schema:
required
description
string

Specifies a brief description of the property.

isPersonal
boolean

Designed to highlight personally identifying information.

notify
boolean

Specifies if the referenced object should be notified when there is a relationship change.

notifyRelationships
Array of strings

Controls the propagation of notifications out of an object when one of its properties changes orwhen that object receives a notification through one of these fields.

notifySelf
boolean

Specifies if the origin object should be notified when there is a relationship change.

required
object (The properties of this JSON schema object)

The properties defined in the JSON schema.

required
Array of objects (Details a Resource Collection this property maps to)

The collection of resources (objects) on which this relationship is based.

returnByDefault
boolean

Specifies whether the property will be returned in the results of a query on an object of this typeif it is not explicitly requested

reversePropertyName
required
string

The corresponding property name, in the case of a bidirectional relationship.

reverseRelationship
required
boolean

Specifies whether this is a bidirectional relationship.

title
string

A human-readable string, used to display the property in the UI.

type
required
string

Specifies the type and cardinality this relationship is.

usageDescription
string

Designed to help end users understand the sensitivity of a property such as a telephone number.

userEditable
boolean

Specifies whether the relationship property is editable by the user.

validate
boolean

Specifies whether the relationship should be validated.

viewable
boolean

Specifies whether this property is viewable in the object’s profile in the UI.

Responses

Request samples

Content type
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Update

Update a property from managed/alpha_group/properties.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
required
string
Default: *
Accept-API-Version
required
string
Value: "resource=2.0"
Request Body schema:
required
description
string

Specifies a brief description of the property.

isPersonal
boolean

Designed to highlight personally identifying information.

notify
boolean

Specifies if the referenced object should be notified when there is a relationship change.

notifyRelationships
Array of strings

Controls the propagation of notifications out of an object when one of its properties changes orwhen that object receives a notification through one of these fields.

notifySelf
boolean

Specifies if the origin object should be notified when there is a relationship change.

required
object (The properties of this JSON schema object)

The properties defined in the JSON schema.

required
Array of objects (Details a Resource Collection this property maps to)

The collection of resources (objects) on which this relationship is based.

returnByDefault
boolean

Specifies whether the property will be returned in the results of a query on an object of this typeif it is not explicitly requested

reversePropertyName
required
string

The corresponding property name, in the case of a bidirectional relationship.

reverseRelationship
required
boolean

Specifies whether this is a bidirectional relationship.

title
string

A human-readable string, used to display the property in the UI.

type
required
string

Specifies the type and cardinality this relationship is.

usageDescription
string

Designed to help end users understand the sensitivity of a property such as a telephone number.

userEditable
boolean

Specifies whether the relationship property is editable by the user.

validate
boolean

Specifies whether the relationship should be validated.

viewable
boolean

Specifies whether this property is viewable in the object’s profile in the UI.

Responses

Request samples

Content type
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Create with Client-Assigned ID

Create a property from managed/alpha_organization/properties.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=2.0"
Request Body schema:
required
description
string

Specifies a brief description of the property.

isPersonal
boolean

Designed to highlight personally identifying information.

notify
boolean

Specifies if the referenced object should be notified when there is a relationship change.

notifyRelationships
Array of strings

Controls the propagation of notifications out of an object when one of its properties changes orwhen that object receives a notification through one of these fields.

notifySelf
boolean

Specifies if the origin object should be notified when there is a relationship change.

required
object (The properties of this JSON schema object)

The properties defined in the JSON schema.

required
Array of objects (Details a Resource Collection this property maps to)

The collection of resources (objects) on which this relationship is based.

returnByDefault
boolean

Specifies whether the property will be returned in the results of a query on an object of this typeif it is not explicitly requested

reversePropertyName
required
string

The corresponding property name, in the case of a bidirectional relationship.

reverseRelationship
required
boolean

Specifies whether this is a bidirectional relationship.

title
string

A human-readable string, used to display the property in the UI.

type
required
string

Specifies the type and cardinality this relationship is.

usageDescription
string

Designed to help end users understand the sensitivity of a property such as a telephone number.

userEditable
boolean

Specifies whether the relationship property is editable by the user.

validate
boolean

Specifies whether the relationship should be validated.

viewable
boolean

Specifies whether this property is viewable in the object’s profile in the UI.

Responses

Request samples

Content type
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Update

Update a property from managed/alpha_organization/properties.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
required
string
Default: *
Accept-API-Version
required
string
Value: "resource=2.0"
Request Body schema:
required
description
string

Specifies a brief description of the property.

isPersonal
boolean

Designed to highlight personally identifying information.

notify
boolean

Specifies if the referenced object should be notified when there is a relationship change.

notifyRelationships
Array of strings

Controls the propagation of notifications out of an object when one of its properties changes orwhen that object receives a notification through one of these fields.

notifySelf
boolean

Specifies if the origin object should be notified when there is a relationship change.

required
object (The properties of this JSON schema object)

The properties defined in the JSON schema.

required
Array of objects (Details a Resource Collection this property maps to)

The collection of resources (objects) on which this relationship is based.

returnByDefault
boolean

Specifies whether the property will be returned in the results of a query on an object of this typeif it is not explicitly requested

reversePropertyName
required
string

The corresponding property name, in the case of a bidirectional relationship.

reverseRelationship
required
boolean

Specifies whether this is a bidirectional relationship.

title
string

A human-readable string, used to display the property in the UI.

type
required
string

Specifies the type and cardinality this relationship is.

usageDescription
string

Designed to help end users understand the sensitivity of a property such as a telephone number.

userEditable
boolean

Specifies whether the relationship property is editable by the user.

validate
boolean

Specifies whether the relationship should be validated.

viewable
boolean

Specifies whether this property is viewable in the object’s profile in the UI.

Responses

Request samples

Content type
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Create with Client-Assigned ID

Create a property from managed/alpha_role/properties.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=2.0"
Request Body schema:
required
description
string

Specifies a brief description of the property.

isPersonal
boolean

Designed to highlight personally identifying information.

notify
boolean

Specifies if the referenced object should be notified when there is a relationship change.

notifyRelationships
Array of strings

Controls the propagation of notifications out of an object when one of its properties changes orwhen that object receives a notification through one of these fields.

notifySelf
boolean

Specifies if the origin object should be notified when there is a relationship change.

required
object (The properties of this JSON schema object)

The properties defined in the JSON schema.

required
Array of objects (Details a Resource Collection this property maps to)

The collection of resources (objects) on which this relationship is based.

returnByDefault
boolean

Specifies whether the property will be returned in the results of a query on an object of this typeif it is not explicitly requested

reversePropertyName
required
string

The corresponding property name, in the case of a bidirectional relationship.

reverseRelationship
required
boolean

Specifies whether this is a bidirectional relationship.

title
string

A human-readable string, used to display the property in the UI.

type
required
string

Specifies the type and cardinality this relationship is.

usageDescription
string

Designed to help end users understand the sensitivity of a property such as a telephone number.

userEditable
boolean

Specifies whether the relationship property is editable by the user.

validate
boolean

Specifies whether the relationship should be validated.

viewable
boolean

Specifies whether this property is viewable in the object’s profile in the UI.

Responses

Request samples

Content type
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Update

Update a property from managed/alpha_role/properties.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
required
string
Default: *
Accept-API-Version
required
string
Value: "resource=2.0"
Request Body schema:
required
description
string

Specifies a brief description of the property.

isPersonal
boolean

Designed to highlight personally identifying information.

notify
boolean

Specifies if the referenced object should be notified when there is a relationship change.

notifyRelationships
Array of strings

Controls the propagation of notifications out of an object when one of its properties changes orwhen that object receives a notification through one of these fields.

notifySelf
boolean

Specifies if the origin object should be notified when there is a relationship change.

required
object (The properties of this JSON schema object)

The properties defined in the JSON schema.

required
Array of objects (Details a Resource Collection this property maps to)

The collection of resources (objects) on which this relationship is based.

returnByDefault
boolean

Specifies whether the property will be returned in the results of a query on an object of this typeif it is not explicitly requested

reversePropertyName
required
string

The corresponding property name, in the case of a bidirectional relationship.

reverseRelationship
required
boolean

Specifies whether this is a bidirectional relationship.

title
string

A human-readable string, used to display the property in the UI.

type
required
string

Specifies the type and cardinality this relationship is.

usageDescription
string

Designed to help end users understand the sensitivity of a property such as a telephone number.

userEditable
boolean

Specifies whether the relationship property is editable by the user.

validate
boolean

Specifies whether the relationship should be validated.

viewable
boolean

Specifies whether this property is viewable in the object’s profile in the UI.

Responses

Request samples

Content type
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Create with Client-Assigned ID

Create a property from managed/alpha_user/properties.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=2.0"
Request Body schema:
required
description
string

Specifies a brief description of the property.

isPersonal
boolean

Designed to highlight personally identifying information.

notify
boolean

Specifies if the referenced object should be notified when there is a relationship change.

notifyRelationships
Array of strings

Controls the propagation of notifications out of an object when one of its properties changes orwhen that object receives a notification through one of these fields.

notifySelf
boolean

Specifies if the origin object should be notified when there is a relationship change.

required
object (The properties of this JSON schema object)

The properties defined in the JSON schema.

required
Array of objects (Details a Resource Collection this property maps to)

The collection of resources (objects) on which this relationship is based.

returnByDefault
boolean

Specifies whether the property will be returned in the results of a query on an object of this typeif it is not explicitly requested

reversePropertyName
required
string

The corresponding property name, in the case of a bidirectional relationship.

reverseRelationship
required
boolean

Specifies whether this is a bidirectional relationship.

title
string

A human-readable string, used to display the property in the UI.

type
required
string

Specifies the type and cardinality this relationship is.

usageDescription
string

Designed to help end users understand the sensitivity of a property such as a telephone number.

userEditable
boolean

Specifies whether the relationship property is editable by the user.

validate
boolean

Specifies whether the relationship should be validated.

viewable
boolean

Specifies whether this property is viewable in the object’s profile in the UI.

Responses

Request samples

Content type
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Update

Update a property from managed/alpha_user/properties.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
required
string
Default: *
Accept-API-Version
required
string
Value: "resource=2.0"
Request Body schema:
required
description
string

Specifies a brief description of the property.

isPersonal
boolean

Designed to highlight personally identifying information.

notify
boolean

Specifies if the referenced object should be notified when there is a relationship change.

notifyRelationships
Array of strings

Controls the propagation of notifications out of an object when one of its properties changes orwhen that object receives a notification through one of these fields.

notifySelf
boolean

Specifies if the origin object should be notified when there is a relationship change.

required
object (The properties of this JSON schema object)

The properties defined in the JSON schema.

required
Array of objects (Details a Resource Collection this property maps to)

The collection of resources (objects) on which this relationship is based.

returnByDefault
boolean

Specifies whether the property will be returned in the results of a query on an object of this typeif it is not explicitly requested

reversePropertyName
required
string

The corresponding property name, in the case of a bidirectional relationship.

reverseRelationship
required
boolean

Specifies whether this is a bidirectional relationship.

title
string

A human-readable string, used to display the property in the UI.

type
required
string

Specifies the type and cardinality this relationship is.

usageDescription
string

Designed to help end users understand the sensitivity of a property such as a telephone number.

userEditable
boolean

Specifies whether the relationship property is editable by the user.

validate
boolean

Specifies whether the relationship should be validated.

viewable
boolean

Specifies whether this property is viewable in the object’s profile in the UI.

Responses

Request samples

Content type
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Create with Client-Assigned ID

Create a property from managed/alpha_usermeta/properties.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=2.0"
Request Body schema:
required
description
string

Specifies a brief description of the property.

isPersonal
boolean

Designed to highlight personally identifying information.

notify
boolean

Specifies if the referenced object should be notified when there is a relationship change.

notifyRelationships
Array of strings

Controls the propagation of notifications out of an object when one of its properties changes orwhen that object receives a notification through one of these fields.

notifySelf
boolean

Specifies if the origin object should be notified when there is a relationship change.

required
object (The properties of this JSON schema object)

The properties defined in the JSON schema.

required
Array of objects (Details a Resource Collection this property maps to)

The collection of resources (objects) on which this relationship is based.

returnByDefault
boolean

Specifies whether the property will be returned in the results of a query on an object of this typeif it is not explicitly requested

reversePropertyName
required
string

The corresponding property name, in the case of a bidirectional relationship.

reverseRelationship
required
boolean

Specifies whether this is a bidirectional relationship.

title
string

A human-readable string, used to display the property in the UI.

type
required
string

Specifies the type and cardinality this relationship is.

usageDescription
string

Designed to help end users understand the sensitivity of a property such as a telephone number.

userEditable
boolean

Specifies whether the relationship property is editable by the user.

validate
boolean

Specifies whether the relationship should be validated.

viewable
boolean

Specifies whether this property is viewable in the object’s profile in the UI.

Responses

Request samples

Content type
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Update

Update a property from managed/alpha_usermeta/properties.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
required
string
Default: *
Accept-API-Version
required
string
Value: "resource=2.0"
Request Body schema:
required
description
string

Specifies a brief description of the property.

isPersonal
boolean

Designed to highlight personally identifying information.

notify
boolean

Specifies if the referenced object should be notified when there is a relationship change.

notifyRelationships
Array of strings

Controls the propagation of notifications out of an object when one of its properties changes orwhen that object receives a notification through one of these fields.

notifySelf
boolean

Specifies if the origin object should be notified when there is a relationship change.

required
object (The properties of this JSON schema object)

The properties defined in the JSON schema.

required
Array of objects (Details a Resource Collection this property maps to)

The collection of resources (objects) on which this relationship is based.

returnByDefault
boolean

Specifies whether the property will be returned in the results of a query on an object of this typeif it is not explicitly requested

reversePropertyName
required
string

The corresponding property name, in the case of a bidirectional relationship.

reverseRelationship
required
boolean

Specifies whether this is a bidirectional relationship.

title
string

A human-readable string, used to display the property in the UI.

type
required
string

Specifies the type and cardinality this relationship is.

usageDescription
string

Designed to help end users understand the sensitivity of a property such as a telephone number.

userEditable
boolean

Specifies whether the relationship property is editable by the user.

validate
boolean

Specifies whether the relationship should be validated.

viewable
boolean

Specifies whether this property is viewable in the object’s profile in the UI.

Responses

Request samples

Content type
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Create with Client-Assigned ID

Create a property from managed/bravo_application/properties.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=2.0"
Request Body schema:
required
description
string

Specifies a brief description of the property.

isPersonal
boolean

Designed to highlight personally identifying information.

notify
boolean

Specifies if the referenced object should be notified when there is a relationship change.

notifyRelationships
Array of strings

Controls the propagation of notifications out of an object when one of its properties changes orwhen that object receives a notification through one of these fields.

notifySelf
boolean

Specifies if the origin object should be notified when there is a relationship change.

required
object (The properties of this JSON schema object)

The properties defined in the JSON schema.

required
Array of objects (Details a Resource Collection this property maps to)

The collection of resources (objects) on which this relationship is based.

returnByDefault
boolean

Specifies whether the property will be returned in the results of a query on an object of this typeif it is not explicitly requested

reversePropertyName
required
string

The corresponding property name, in the case of a bidirectional relationship.

reverseRelationship
required
boolean

Specifies whether this is a bidirectional relationship.

title
string

A human-readable string, used to display the property in the UI.

type
required
string

Specifies the type and cardinality this relationship is.

usageDescription
string

Designed to help end users understand the sensitivity of a property such as a telephone number.

userEditable
boolean

Specifies whether the relationship property is editable by the user.

validate
boolean

Specifies whether the relationship should be validated.

viewable
boolean

Specifies whether this property is viewable in the object’s profile in the UI.

Responses

Request samples

Content type
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Update

Update a property from managed/bravo_application/properties.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
required
string
Default: *
Accept-API-Version
required
string
Value: "resource=2.0"
Request Body schema:
required
description
string

Specifies a brief description of the property.

isPersonal
boolean

Designed to highlight personally identifying information.

notify
boolean

Specifies if the referenced object should be notified when there is a relationship change.

notifyRelationships
Array of strings

Controls the propagation of notifications out of an object when one of its properties changes orwhen that object receives a notification through one of these fields.

notifySelf
boolean

Specifies if the origin object should be notified when there is a relationship change.

required
object (The properties of this JSON schema object)

The properties defined in the JSON schema.

required
Array of objects (Details a Resource Collection this property maps to)

The collection of resources (objects) on which this relationship is based.

returnByDefault
boolean

Specifies whether the property will be returned in the results of a query on an object of this typeif it is not explicitly requested

reversePropertyName
required
string

The corresponding property name, in the case of a bidirectional relationship.

reverseRelationship
required
boolean

Specifies whether this is a bidirectional relationship.

title
string

A human-readable string, used to display the property in the UI.

type
required
string

Specifies the type and cardinality this relationship is.

usageDescription
string

Designed to help end users understand the sensitivity of a property such as a telephone number.

userEditable
boolean

Specifies whether the relationship property is editable by the user.

validate
boolean

Specifies whether the relationship should be validated.

viewable
boolean

Specifies whether this property is viewable in the object’s profile in the UI.

Responses

Request samples

Content type
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Create with Client-Assigned ID

Create a property from managed/bravo_assignment/properties.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=2.0"
Request Body schema:
required
description
string

Specifies a brief description of the property.

isPersonal
boolean

Designed to highlight personally identifying information.

notify
boolean

Specifies if the referenced object should be notified when there is a relationship change.

notifyRelationships
Array of strings

Controls the propagation of notifications out of an object when one of its properties changes orwhen that object receives a notification through one of these fields.

notifySelf
boolean

Specifies if the origin object should be notified when there is a relationship change.

required
object (The properties of this JSON schema object)

The properties defined in the JSON schema.

required
Array of objects (Details a Resource Collection this property maps to)

The collection of resources (objects) on which this relationship is based.

returnByDefault
boolean

Specifies whether the property will be returned in the results of a query on an object of this typeif it is not explicitly requested

reversePropertyName
required
string

The corresponding property name, in the case of a bidirectional relationship.

reverseRelationship
required
boolean

Specifies whether this is a bidirectional relationship.

title
string

A human-readable string, used to display the property in the UI.

type
required
string

Specifies the type and cardinality this relationship is.

usageDescription
string

Designed to help end users understand the sensitivity of a property such as a telephone number.

userEditable
boolean

Specifies whether the relationship property is editable by the user.

validate
boolean

Specifies whether the relationship should be validated.

viewable
boolean

Specifies whether this property is viewable in the object’s profile in the UI.

Responses

Request samples

Content type
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Update

Update a property from managed/bravo_assignment/properties.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
required
string
Default: *
Accept-API-Version
required
string
Value: "resource=2.0"
Request Body schema:
required
description
string

Specifies a brief description of the property.

isPersonal
boolean

Designed to highlight personally identifying information.

notify
boolean

Specifies if the referenced object should be notified when there is a relationship change.

notifyRelationships
Array of strings

Controls the propagation of notifications out of an object when one of its properties changes orwhen that object receives a notification through one of these fields.

notifySelf
boolean

Specifies if the origin object should be notified when there is a relationship change.

required
object (The properties of this JSON schema object)

The properties defined in the JSON schema.

required
Array of objects (Details a Resource Collection this property maps to)

The collection of resources (objects) on which this relationship is based.

returnByDefault
boolean

Specifies whether the property will be returned in the results of a query on an object of this typeif it is not explicitly requested

reversePropertyName
required
string

The corresponding property name, in the case of a bidirectional relationship.

reverseRelationship
required
boolean

Specifies whether this is a bidirectional relationship.

title
string

A human-readable string, used to display the property in the UI.

type
required
string

Specifies the type and cardinality this relationship is.

usageDescription
string

Designed to help end users understand the sensitivity of a property such as a telephone number.

userEditable
boolean

Specifies whether the relationship property is editable by the user.

validate
boolean

Specifies whether the relationship should be validated.

viewable
boolean

Specifies whether this property is viewable in the object’s profile in the UI.

Responses

Request samples

Content type
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Create with Client-Assigned ID

Create a property from managed/bravo_group/properties.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=2.0"
Request Body schema:
required
description
string

Specifies a brief description of the property.

isPersonal
boolean

Designed to highlight personally identifying information.

notify
boolean

Specifies if the referenced object should be notified when there is a relationship change.

notifyRelationships
Array of strings

Controls the propagation of notifications out of an object when one of its properties changes orwhen that object receives a notification through one of these fields.

notifySelf
boolean

Specifies if the origin object should be notified when there is a relationship change.

required
object (The properties of this JSON schema object)

The properties defined in the JSON schema.

required
Array of objects (Details a Resource Collection this property maps to)

The collection of resources (objects) on which this relationship is based.

returnByDefault
boolean

Specifies whether the property will be returned in the results of a query on an object of this typeif it is not explicitly requested

reversePropertyName
required
string

The corresponding property name, in the case of a bidirectional relationship.

reverseRelationship
required
boolean

Specifies whether this is a bidirectional relationship.

title
string

A human-readable string, used to display the property in the UI.

type
required
string

Specifies the type and cardinality this relationship is.

usageDescription
string

Designed to help end users understand the sensitivity of a property such as a telephone number.

userEditable
boolean

Specifies whether the relationship property is editable by the user.

validate
boolean

Specifies whether the relationship should be validated.

viewable
boolean

Specifies whether this property is viewable in the object’s profile in the UI.

Responses

Request samples

Content type
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Update

Update a property from managed/bravo_group/properties.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
required
string
Default: *
Accept-API-Version
required
string
Value: "resource=2.0"
Request Body schema:
required
description
string

Specifies a brief description of the property.

isPersonal
boolean

Designed to highlight personally identifying information.

notify
boolean

Specifies if the referenced object should be notified when there is a relationship change.

notifyRelationships
Array of strings

Controls the propagation of notifications out of an object when one of its properties changes orwhen that object receives a notification through one of these fields.

notifySelf
boolean

Specifies if the origin object should be notified when there is a relationship change.

required
object (The properties of this JSON schema object)

The properties defined in the JSON schema.

required
Array of objects (Details a Resource Collection this property maps to)

The collection of resources (objects) on which this relationship is based.

returnByDefault
boolean

Specifies whether the property will be returned in the results of a query on an object of this typeif it is not explicitly requested

reversePropertyName
required
string

The corresponding property name, in the case of a bidirectional relationship.

reverseRelationship
required
boolean

Specifies whether this is a bidirectional relationship.

title
string

A human-readable string, used to display the property in the UI.

type
required
string

Specifies the type and cardinality this relationship is.

usageDescription
string

Designed to help end users understand the sensitivity of a property such as a telephone number.

userEditable
boolean

Specifies whether the relationship property is editable by the user.

validate
boolean

Specifies whether the relationship should be validated.

viewable
boolean

Specifies whether this property is viewable in the object’s profile in the UI.

Responses

Request samples

Content type
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Create with Client-Assigned ID

Create a property from managed/bravo_organization/properties.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=2.0"
Request Body schema:
required
description
string

Specifies a brief description of the property.

isPersonal
boolean

Designed to highlight personally identifying information.

notify
boolean

Specifies if the referenced object should be notified when there is a relationship change.

notifyRelationships
Array of strings

Controls the propagation of notifications out of an object when one of its properties changes orwhen that object receives a notification through one of these fields.

notifySelf
boolean

Specifies if the origin object should be notified when there is a relationship change.

required
object (The properties of this JSON schema object)

The properties defined in the JSON schema.

required
Array of objects (Details a Resource Collection this property maps to)

The collection of resources (objects) on which this relationship is based.

returnByDefault
boolean

Specifies whether the property will be returned in the results of a query on an object of this typeif it is not explicitly requested

reversePropertyName
required
string

The corresponding property name, in the case of a bidirectional relationship.

reverseRelationship
required
boolean

Specifies whether this is a bidirectional relationship.

title
string

A human-readable string, used to display the property in the UI.

type
required
string

Specifies the type and cardinality this relationship is.

usageDescription
string

Designed to help end users understand the sensitivity of a property such as a telephone number.

userEditable
boolean

Specifies whether the relationship property is editable by the user.

validate
boolean

Specifies whether the relationship should be validated.

viewable
boolean

Specifies whether this property is viewable in the object’s profile in the UI.

Responses

Request samples

Content type
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Update

Update a property from managed/bravo_organization/properties.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
required
string
Default: *
Accept-API-Version
required
string
Value: "resource=2.0"
Request Body schema:
required
description
string

Specifies a brief description of the property.

isPersonal
boolean

Designed to highlight personally identifying information.

notify
boolean

Specifies if the referenced object should be notified when there is a relationship change.

notifyRelationships
Array of strings

Controls the propagation of notifications out of an object when one of its properties changes orwhen that object receives a notification through one of these fields.

notifySelf
boolean

Specifies if the origin object should be notified when there is a relationship change.

required
object (The properties of this JSON schema object)

The properties defined in the JSON schema.

required
Array of objects (Details a Resource Collection this property maps to)

The collection of resources (objects) on which this relationship is based.

returnByDefault
boolean

Specifies whether the property will be returned in the results of a query on an object of this typeif it is not explicitly requested

reversePropertyName
required
string

The corresponding property name, in the case of a bidirectional relationship.

reverseRelationship
required
boolean

Specifies whether this is a bidirectional relationship.

title
string

A human-readable string, used to display the property in the UI.

type
required
string

Specifies the type and cardinality this relationship is.

usageDescription
string

Designed to help end users understand the sensitivity of a property such as a telephone number.

userEditable
boolean

Specifies whether the relationship property is editable by the user.

validate
boolean

Specifies whether the relationship should be validated.

viewable
boolean

Specifies whether this property is viewable in the object’s profile in the UI.

Responses

Request samples

Content type
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Create with Client-Assigned ID

Create a property from managed/bravo_role/properties.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=2.0"
Request Body schema:
required
description
string

Specifies a brief description of the property.

isPersonal
boolean

Designed to highlight personally identifying information.

notify
boolean

Specifies if the referenced object should be notified when there is a relationship change.

notifyRelationships
Array of strings

Controls the propagation of notifications out of an object when one of its properties changes orwhen that object receives a notification through one of these fields.

notifySelf
boolean

Specifies if the origin object should be notified when there is a relationship change.

required
object (The properties of this JSON schema object)

The properties defined in the JSON schema.

required
Array of objects (Details a Resource Collection this property maps to)

The collection of resources (objects) on which this relationship is based.

returnByDefault
boolean

Specifies whether the property will be returned in the results of a query on an object of this typeif it is not explicitly requested

reversePropertyName
required
string

The corresponding property name, in the case of a bidirectional relationship.

reverseRelationship
required
boolean

Specifies whether this is a bidirectional relationship.

title
string

A human-readable string, used to display the property in the UI.

type
required
string

Specifies the type and cardinality this relationship is.

usageDescription
string

Designed to help end users understand the sensitivity of a property such as a telephone number.

userEditable
boolean

Specifies whether the relationship property is editable by the user.

validate
boolean

Specifies whether the relationship should be validated.

viewable
boolean

Specifies whether this property is viewable in the object’s profile in the UI.

Responses

Request samples

Content type
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Update

Update a property from managed/bravo_role/properties.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
required
string
Default: *
Accept-API-Version
required
string
Value: "resource=2.0"
Request Body schema:
required
description
string

Specifies a brief description of the property.

isPersonal
boolean

Designed to highlight personally identifying information.

notify
boolean

Specifies if the referenced object should be notified when there is a relationship change.

notifyRelationships
Array of strings

Controls the propagation of notifications out of an object when one of its properties changes orwhen that object receives a notification through one of these fields.

notifySelf
boolean

Specifies if the origin object should be notified when there is a relationship change.

required
object (The properties of this JSON schema object)

The properties defined in the JSON schema.

required
Array of objects (Details a Resource Collection this property maps to)

The collection of resources (objects) on which this relationship is based.

returnByDefault
boolean

Specifies whether the property will be returned in the results of a query on an object of this typeif it is not explicitly requested

reversePropertyName
required
string

The corresponding property name, in the case of a bidirectional relationship.

reverseRelationship
required
boolean

Specifies whether this is a bidirectional relationship.

title
string

A human-readable string, used to display the property in the UI.

type
required
string

Specifies the type and cardinality this relationship is.

usageDescription
string

Designed to help end users understand the sensitivity of a property such as a telephone number.

userEditable
boolean

Specifies whether the relationship property is editable by the user.

validate
boolean

Specifies whether the relationship should be validated.

viewable
boolean

Specifies whether this property is viewable in the object’s profile in the UI.

Responses

Request samples

Content type
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Create with Client-Assigned ID

Create a property from managed/bravo_user/properties.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=2.0"
Request Body schema:
required
description
string

Specifies a brief description of the property.

isPersonal
boolean

Designed to highlight personally identifying information.

notify
boolean

Specifies if the referenced object should be notified when there is a relationship change.

notifyRelationships
Array of strings

Controls the propagation of notifications out of an object when one of its properties changes orwhen that object receives a notification through one of these fields.

notifySelf
boolean

Specifies if the origin object should be notified when there is a relationship change.

required
object (The properties of this JSON schema object)

The properties defined in the JSON schema.

required
Array of objects (Details a Resource Collection this property maps to)

The collection of resources (objects) on which this relationship is based.

returnByDefault
boolean

Specifies whether the property will be returned in the results of a query on an object of this typeif it is not explicitly requested

reversePropertyName
required
string

The corresponding property name, in the case of a bidirectional relationship.

reverseRelationship
required
boolean

Specifies whether this is a bidirectional relationship.

title
string

A human-readable string, used to display the property in the UI.

type
required
string

Specifies the type and cardinality this relationship is.

usageDescription
string

Designed to help end users understand the sensitivity of a property such as a telephone number.

userEditable
boolean

Specifies whether the relationship property is editable by the user.

validate
boolean

Specifies whether the relationship should be validated.

viewable
boolean

Specifies whether this property is viewable in the object’s profile in the UI.

Responses

Request samples

Content type
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Update

Update a property from managed/bravo_user/properties.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
required
string
Default: *
Accept-API-Version
required
string
Value: "resource=2.0"
Request Body schema:
required
description
string

Specifies a brief description of the property.

isPersonal
boolean

Designed to highlight personally identifying information.

notify
boolean

Specifies if the referenced object should be notified when there is a relationship change.

notifyRelationships
Array of strings

Controls the propagation of notifications out of an object when one of its properties changes orwhen that object receives a notification through one of these fields.

notifySelf
boolean

Specifies if the origin object should be notified when there is a relationship change.

required
object (The properties of this JSON schema object)

The properties defined in the JSON schema.

required
Array of objects (Details a Resource Collection this property maps to)

The collection of resources (objects) on which this relationship is based.

returnByDefault
boolean

Specifies whether the property will be returned in the results of a query on an object of this typeif it is not explicitly requested

reversePropertyName
required
string

The corresponding property name, in the case of a bidirectional relationship.

reverseRelationship
required
boolean

Specifies whether this is a bidirectional relationship.

title
string

A human-readable string, used to display the property in the UI.

type
required
string

Specifies the type and cardinality this relationship is.

usageDescription
string

Designed to help end users understand the sensitivity of a property such as a telephone number.

userEditable
boolean

Specifies whether the relationship property is editable by the user.

validate
boolean

Specifies whether the relationship should be validated.

viewable
boolean

Specifies whether this property is viewable in the object’s profile in the UI.

Responses

Request samples

Content type
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Create with Client-Assigned ID

Create a property from managed/bravo_usermeta/properties.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=2.0"
Request Body schema:
required
description
string

Specifies a brief description of the property.

isPersonal
boolean

Designed to highlight personally identifying information.

notify
boolean

Specifies if the referenced object should be notified when there is a relationship change.

notifyRelationships
Array of strings

Controls the propagation of notifications out of an object when one of its properties changes orwhen that object receives a notification through one of these fields.

notifySelf
boolean

Specifies if the origin object should be notified when there is a relationship change.

required
object (The properties of this JSON schema object)

The properties defined in the JSON schema.

required
Array of objects (Details a Resource Collection this property maps to)

The collection of resources (objects) on which this relationship is based.

returnByDefault
boolean

Specifies whether the property will be returned in the results of a query on an object of this typeif it is not explicitly requested

reversePropertyName
required
string

The corresponding property name, in the case of a bidirectional relationship.

reverseRelationship
required
boolean

Specifies whether this is a bidirectional relationship.

title
string

A human-readable string, used to display the property in the UI.

type
required
string

Specifies the type and cardinality this relationship is.

usageDescription
string

Designed to help end users understand the sensitivity of a property such as a telephone number.

userEditable
boolean

Specifies whether the relationship property is editable by the user.

validate
boolean

Specifies whether the relationship should be validated.

viewable
boolean

Specifies whether this property is viewable in the object’s profile in the UI.

Responses

Request samples

Content type
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Update

Update a property from managed/bravo_usermeta/properties.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
required
string
Default: *
Accept-API-Version
required
string
Value: "resource=2.0"
Request Body schema:
required
description
string

Specifies a brief description of the property.

isPersonal
boolean

Designed to highlight personally identifying information.

notify
boolean

Specifies if the referenced object should be notified when there is a relationship change.

notifyRelationships
Array of strings

Controls the propagation of notifications out of an object when one of its properties changes orwhen that object receives a notification through one of these fields.

notifySelf
boolean

Specifies if the origin object should be notified when there is a relationship change.

required
object (The properties of this JSON schema object)

The properties defined in the JSON schema.

required
Array of objects (Details a Resource Collection this property maps to)

The collection of resources (objects) on which this relationship is based.

returnByDefault
boolean

Specifies whether the property will be returned in the results of a query on an object of this typeif it is not explicitly requested

reversePropertyName
required
string

The corresponding property name, in the case of a bidirectional relationship.

reverseRelationship
required
boolean

Specifies whether this is a bidirectional relationship.

title
string

A human-readable string, used to display the property in the UI.

type
required
string

Specifies the type and cardinality this relationship is.

usageDescription
string

Designed to help end users understand the sensitivity of a property such as a telephone number.

userEditable
boolean

Specifies whether the relationship property is editable by the user.

validate
boolean

Specifies whether the relationship should be validated.

viewable
boolean

Specifies whether this property is viewable in the object’s profile in the UI.

Responses

Request samples

Content type
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Create with Client-Assigned ID

Create a property from managed/svcacct/properties.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=2.0"
Request Body schema:
required
description
string

Specifies a brief description of the property.

isPersonal
boolean

Designed to highlight personally identifying information.

notify
boolean

Specifies if the referenced object should be notified when there is a relationship change.

notifyRelationships
Array of strings

Controls the propagation of notifications out of an object when one of its properties changes orwhen that object receives a notification through one of these fields.

notifySelf
boolean

Specifies if the origin object should be notified when there is a relationship change.

required
object (The properties of this JSON schema object)

The properties defined in the JSON schema.

required
Array of objects (Details a Resource Collection this property maps to)

The collection of resources (objects) on which this relationship is based.

returnByDefault
boolean

Specifies whether the property will be returned in the results of a query on an object of this typeif it is not explicitly requested

reversePropertyName
required
string

The corresponding property name, in the case of a bidirectional relationship.

reverseRelationship
required
boolean

Specifies whether this is a bidirectional relationship.

title
string

A human-readable string, used to display the property in the UI.

type
required
string

Specifies the type and cardinality this relationship is.

usageDescription
string

Designed to help end users understand the sensitivity of a property such as a telephone number.

userEditable
boolean

Specifies whether the relationship property is editable by the user.

validate
boolean

Specifies whether the relationship should be validated.

viewable
boolean

Specifies whether this property is viewable in the object’s profile in the UI.

Responses

Request samples

Content type
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Update

Update a property from managed/svcacct/properties.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
required
string
Default: *
Accept-API-Version
required
string
Value: "resource=2.0"
Request Body schema:
required
description
string

Specifies a brief description of the property.

isPersonal
boolean

Designed to highlight personally identifying information.

notify
boolean

Specifies if the referenced object should be notified when there is a relationship change.

notifyRelationships
Array of strings

Controls the propagation of notifications out of an object when one of its properties changes orwhen that object receives a notification through one of these fields.

notifySelf
boolean

Specifies if the origin object should be notified when there is a relationship change.

required
object (The properties of this JSON schema object)

The properties defined in the JSON schema.

required
Array of objects (Details a Resource Collection this property maps to)

The collection of resources (objects) on which this relationship is based.

returnByDefault
boolean

Specifies whether the property will be returned in the results of a query on an object of this typeif it is not explicitly requested

reversePropertyName
required
string

The corresponding property name, in the case of a bidirectional relationship.

reverseRelationship
required
boolean

Specifies whether this is a bidirectional relationship.

title
string

A human-readable string, used to display the property in the UI.

type
required
string

Specifies the type and cardinality this relationship is.

usageDescription
string

Designed to help end users understand the sensitivity of a property such as a telephone number.

userEditable
boolean

Specifies whether the relationship property is editable by the user.

validate
boolean

Specifies whether the relationship should be validated.

viewable
boolean

Specifies whether this property is viewable in the object’s profile in the UI.

Responses

Request samples

Content type
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Create with Client-Assigned ID

Create a property from managed/teammember/properties.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=2.0"
Request Body schema:
required
description
string

Specifies a brief description of the property.

isPersonal
boolean

Designed to highlight personally identifying information.

notify
boolean

Specifies if the referenced object should be notified when there is a relationship change.

notifyRelationships
Array of strings

Controls the propagation of notifications out of an object when one of its properties changes orwhen that object receives a notification through one of these fields.

notifySelf
boolean

Specifies if the origin object should be notified when there is a relationship change.

required
object (The properties of this JSON schema object)

The properties defined in the JSON schema.

required
Array of objects (Details a Resource Collection this property maps to)

The collection of resources (objects) on which this relationship is based.

returnByDefault
boolean

Specifies whether the property will be returned in the results of a query on an object of this typeif it is not explicitly requested

reversePropertyName
required
string

The corresponding property name, in the case of a bidirectional relationship.

reverseRelationship
required
boolean

Specifies whether this is a bidirectional relationship.

title
string

A human-readable string, used to display the property in the UI.

type
required
string

Specifies the type and cardinality this relationship is.

usageDescription
string

Designed to help end users understand the sensitivity of a property such as a telephone number.

userEditable
boolean

Specifies whether the relationship property is editable by the user.

validate
boolean

Specifies whether the relationship should be validated.

viewable
boolean

Specifies whether this property is viewable in the object’s profile in the UI.

Responses

Request samples

Content type
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Update

Update a property from managed/teammember/properties.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
required
string
Default: *
Accept-API-Version
required
string
Value: "resource=2.0"
Request Body schema:
required
description
string

Specifies a brief description of the property.

isPersonal
boolean

Designed to highlight personally identifying information.

notify
boolean

Specifies if the referenced object should be notified when there is a relationship change.

notifyRelationships
Array of strings

Controls the propagation of notifications out of an object when one of its properties changes orwhen that object receives a notification through one of these fields.

notifySelf
boolean

Specifies if the origin object should be notified when there is a relationship change.

required
object (The properties of this JSON schema object)

The properties defined in the JSON schema.

required
Array of objects (Details a Resource Collection this property maps to)

The collection of resources (objects) on which this relationship is based.

returnByDefault
boolean

Specifies whether the property will be returned in the results of a query on an object of this typeif it is not explicitly requested

reversePropertyName
required
string

The corresponding property name, in the case of a bidirectional relationship.

reverseRelationship
required
boolean

Specifies whether this is a bidirectional relationship.

title
string

A human-readable string, used to display the property in the UI.

type
required
string

Specifies the type and cardinality this relationship is.

usageDescription
string

Designed to help end users understand the sensitivity of a property such as a telephone number.

userEditable
boolean

Specifies whether the relationship property is editable by the user.

validate
boolean

Specifies whether the relationship should be validated.

viewable
boolean

Specifies whether this property is viewable in the object’s profile in the UI.

Responses

Request samples

Content type
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Create with Client-Assigned ID

Create a property from managed/teammembermeta/properties.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=2.0"
Request Body schema:
required
description
string

Specifies a brief description of the property.

isPersonal
boolean

Designed to highlight personally identifying information.

notify
boolean

Specifies if the referenced object should be notified when there is a relationship change.

notifyRelationships
Array of strings

Controls the propagation of notifications out of an object when one of its properties changes orwhen that object receives a notification through one of these fields.

notifySelf
boolean

Specifies if the origin object should be notified when there is a relationship change.

required
object (The properties of this JSON schema object)

The properties defined in the JSON schema.

required
Array of objects (Details a Resource Collection this property maps to)

The collection of resources (objects) on which this relationship is based.

returnByDefault
boolean

Specifies whether the property will be returned in the results of a query on an object of this typeif it is not explicitly requested

reversePropertyName
required
string

The corresponding property name, in the case of a bidirectional relationship.

reverseRelationship
required
boolean

Specifies whether this is a bidirectional relationship.

title
string

A human-readable string, used to display the property in the UI.

type
required
string

Specifies the type and cardinality this relationship is.

usageDescription
string

Designed to help end users understand the sensitivity of a property such as a telephone number.

userEditable
boolean

Specifies whether the relationship property is editable by the user.

validate
boolean

Specifies whether the relationship should be validated.

viewable
boolean

Specifies whether this property is viewable in the object’s profile in the UI.

Responses

Request samples

Content type
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Update

Update a property from managed/teammembermeta/properties.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
required
string
Default: *
Accept-API-Version
required
string
Value: "resource=2.0"
Request Body schema:
required
description
string

Specifies a brief description of the property.

isPersonal
boolean

Designed to highlight personally identifying information.

notify
boolean

Specifies if the referenced object should be notified when there is a relationship change.

notifyRelationships
Array of strings

Controls the propagation of notifications out of an object when one of its properties changes orwhen that object receives a notification through one of these fields.

notifySelf
boolean

Specifies if the origin object should be notified when there is a relationship change.

required
object (The properties of this JSON schema object)

The properties defined in the JSON schema.

required
Array of objects (Details a Resource Collection this property maps to)

The collection of resources (objects) on which this relationship is based.

returnByDefault
boolean

Specifies whether the property will be returned in the results of a query on an object of this typeif it is not explicitly requested

reversePropertyName
required
string

The corresponding property name, in the case of a bidirectional relationship.

reverseRelationship
required
boolean

Specifies whether this is a bidirectional relationship.

title
string

A human-readable string, used to display the property in the UI.

type
required
string

Specifies the type and cardinality this relationship is.

usageDescription
string

Designed to help end users understand the sensitivity of a property such as a telephone number.

userEditable
boolean

Specifies whether the relationship property is editable by the user.

validate
boolean

Specifies whether the relationship should be validated.

viewable
boolean

Specifies whether this property is viewable in the object’s profile in the UI.

Responses

Request samples

Content type
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "isPersonal": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "notifySelf": true,
  • "properties": {
    },
  • "resourceCollection": [
    ],
  • "returnByDefault": true,
  • "reversePropertyName": "string",
  • "reverseRelationship": true,
  • "title": "string",
  • "type": "string",
  • "usageDescription": "string",
  • "userEditable": true,
  • "validate": true,
  • "viewable": true
}

Script v1.0

Action: compile

Compiles a script, to validate that it can be executed.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "compile"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
file
string

Path to file containing the script

globals
object (Global Variable Key/Value Pairs)

Global Variables

source
string

Inlined script

type
required
string

Script type (e.g., text/javascript, groovy)

Responses

Request samples

Content type
{
  • "file": "string",
  • "globals": { },
  • "source": "string",
  • "type": "string"
}

Response samples

Content type
application/json
true

Action: eval

Executes a script and returns the result, if any.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "eval"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
file
string

Path to file containing the script

globals
object (Global Variable Key/Value Pairs)

Global Variables

source
string

Inlined script

type
required
string

Script type (e.g., text/javascript, groovy)

Responses

Request samples

Content type
{
  • "file": "string",
  • "globals": { },
  • "source": "string",
  • "type": "string"
}

Response samples

Content type
application/json
{ }

SelfService - KBA v1.0

Read

Gathers KBA Configuration.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "kbaPropertyName": "string",
  • "minimumAnswersToDefine": 0,
  • "minimumAnswersToVerify": 0,
  • "questions": { }
}

SelfService - Profile Completeness v1.0

Read

Returns the profile completeness score for the object specified by the remainder of the resource path.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_rev": "string",
  • "completeness": 0.1
}

SelfService - Profile Create Date v1.0

Read

Returns the create date for the object specified by the remainder of the resource path.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_rev": "string",
  • "createDate": "string"
}

SelfService - Profile Login Count v1.0

Action: increment

Increments the login count of the resource specified specified by the remainder of the resource path.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "increment"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_rev": "string",
  • "loginCount": 0
}

Read

Returns the login count for the resource specified by the remainder of the resource path.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_rev": "string",
  • "loginCount": 0
}

SelfService - Profile Terms Accepted v1.0

Read

Returns the terms and conditions for the resource specified by the remainder of the resource path.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_rev": "string",
  • "termsAccepted": {
    }
}

Update

Updates the terms and conditions for the resource specified by the remainder of the resource path.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
required
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
_id
required
string

The full resource path of the object in question

_rev
required
string

The revision of the object in question

required
object (Terms Accepted)

The terms and conditions acceptance details of the object in question

Responses

Request samples

Content type
{
  • "_id": "string",
  • "_rev": "string",
  • "termsAccepted": {
    }
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_rev": "string",
  • "termsAccepted": {
    }
}

SelfService - Terms v1.0

Read

Gathers the active Terms & Conditions.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "createDate": "string",
  • "terms": "string",
  • "version": "string"
}

Sync Mappings v1.0

Query by Filter

Provides the list of mappings.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Read

Returns the configuration details about a given mapping

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "correlationQuery": { },
  • "name": "string",
  • "policies": [
    ],
  • "properties": [
    ],
  • "source": "string",
  • "target": "string"
}

Synchronization v1.0

Action: getLinkedResources

Provides a list of linked resources for the given resource-name.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
resourceName
required
string

Resource name (e.g., system/xmlfile/account/bjensen)

_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "getLinkedResources"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "linkedTo": [
    ]
}

Action: notifyCreate

Informs the Synchronization Service that an object has been created and that the change should be synchronized across all relevant mappings.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
resourceContainer
required
string

Resource container for the source object (e.g., system/ldap/account)

resourceId
required
string

Resource ID (e.g., bjensen)

_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "notifyCreate"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
newValue
object

The new value of the source object

Responses

Request samples

Content type
{
  • "newValue": { }
}

Response samples

Content type
application/json
{
  • "syncResults": [
    ]
}

Action: notifyDelete

Informs the Synchronization Service that an object has been deleted and that the change should be synchronized across all relevant mappings.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
resourceContainer
required
string

Resource container for the source object (e.g., system/ldap/account)

resourceId
required
string

Resource ID (e.g., bjensen)

_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "notifyDelete"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
oldValue
object

The former value of the source object, if any

Responses

Request samples

Content type
{
  • "oldValue": { }
}

Response samples

Content type
application/json
{
  • "syncResults": [
    ]
}

Action: notifyUpdate

Informs the Synchronization Service that an object has been updated and that the change should be synchronized across all relevant mappings.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
resourceContainer
required
string

Resource container for the source object (e.g., system/ldap/account)

resourceId
required
string

Resource ID (e.g., bjensen)

_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "notifyUpdate"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
newValue
object

The new value of the source object

oldValue
object

The former value of the source object, if any

Responses

Request samples

Content type
{
  • "newValue": { },
  • "oldValue": { }
}

Response samples

Content type
application/json
{
  • "syncResults": [
    ]
}

Action: performAction

Perform an action on a resource.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
action
required
string
Enum: "CREATE" "UPDATE" "DELETE" "LINK" "UNLINK" "EXCEPTION" "REPORT" "NOREPORT" "ASYNC" "IGNORE"

The action to be taken

mapping
required
string

Mapping name (e.g., systemXmlfileAccounts_managedUser)

sourceId
string

Source ID

targetId
string

Target ID

reconId
string

Recon ID

linkQualifier
string

Link qualifier (e.g., default)

linkType
string

The type of the link used for that mapping

target
boolean

true or false for source-sync and omit for target-sync

ignorePostAction
boolean

Ignore post action

_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "performAction"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Task Scanner v1.0

Action: execute

Executes a task by name.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
name
required
string

Task name

_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "execute"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_id": "string"
}

Query by Filter

Applies query filter to task entries.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "EXACT"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Action: cancel

Marks a task as cancelled, but only if not yet completed.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "cancel"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "status": "FAILURE"
}

Read

Reads a task entry.

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
id
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "ended": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "progress": {
    },
  • "started": "2019-08-24T14:15:22Z"
}

alpha_usermeta v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
object

Responses

Request samples

Content type
{ }

Response samples

Content type
application/json
{ }

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Action: triggerSyncCheck

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_usermetaId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "triggerSyncCheck"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_usermetaId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
object

Responses

Request samples

Content type
{ }

Response samples

Content type
application/json
{ }

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_usermetaId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{ }

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_usermetaId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{ }

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_usermetaId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{ }

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
alpha_usermetaId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
object

Responses

Request samples

Content type
{ }

Response samples

Content type
application/json
{ }

bravo_usermeta v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
object

Responses

Request samples

Content type
{ }

Response samples

Content type
application/json
{ }

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Action: triggerSyncCheck

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_usermetaId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "triggerSyncCheck"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_usermetaId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
object

Responses

Request samples

Content type
{ }

Response samples

Content type
application/json
{ }

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_usermetaId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{ }

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_usermetaId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{ }

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_usermetaId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{ }

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
bravo_usermetaId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
object

Responses

Request samples

Content type
{ }

Response samples

Content type
application/json
{ }

teammembermeta v1.0

Create with Server-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
object

Responses

Request samples

Content type
{ }

Response samples

Content type
application/json
{ }

Query by Filter

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryFilter
required
string
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Query by ID: query-all-ids

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_queryId
required
string
Value: "query-all-ids"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "pagedResultsCookie": "string",
  • "remainingPagedResults": -1,
  • "result": [
    ],
  • "resultCount": 0,
  • "totalPagedResults": -1,
  • "totalPagedResultsPolicy": "NONE"
}

Action: triggerSyncCheck

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
teammembermetaId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_action
required
string
Value: "triggerSyncCheck"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Create with Client-Assigned ID

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
teammembermetaId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-None-Match
required
string
Value: "*"
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
object

Responses

Request samples

Content type
{ }

Response samples

Content type
application/json
{ }

Delete

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
teammembermetaId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{ }

Update via Patch Operations

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
teammembermetaId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
Array
field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{ }

Read

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
teammembermetaId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

_mimeType
string

Optional parameter requesting that the response have the given MIME-Type. Use of this parameter requires a _fields parameter with a single field specified.

header Parameters
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{ }

Update

Authorizations:
OAuth2api_key_idapi_key_secretbasic_auth
path Parameters
teammembermetaId
required
string
query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.

_prettyPrint
boolean

Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable.

header Parameters
If-Match
string
Default: *
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
object

Responses

Request samples

Content type
{ }

Response samples

Content type
application/json
{ }