API docs by Redocly

API Explorer (7.5.0)

Download OpenAPI specification:Download

Audit v1.0

Action: flush

Requests that a log file have its buffer flushed.

query Parameters
handler
required
string
Value: "json"

Handler 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: "flush"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

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

Query by ID: query-all-ids

Query for all audit event identifiers with the recon topic.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
_pagedResultsOffset
integer
_pagedResultsCookie
string
_totalPagedResultsPolicy
string
Value: "EXACT"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

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

Query by Filter

Query for audit events with the recon topic by query-filter.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
_pagedResultsOffset
integer
_pagedResultsCookie
string
_totalPagedResultsPolicy
string
Value: "EXACT"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

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

Query by ID: query-all

Query for all audit events with the sync topic.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
_pagedResultsOffset
integer
_pagedResultsCookie
string
_totalPagedResultsPolicy
string
Value: "EXACT"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

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

Read

Read an audit event with the authentication topic.

path Parameters
eventId
required
string

Event 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
{
  • "_id": "string",
  • "timestamp": "string",
  • "eventName": "string",
  • "transactionId": "string",
  • "userId": "string",
  • "trackingIds": [
    ],
  • "result": "string",
  • "principal": [
    ],
  • "context": { },
  • "entries": [
    ],
  • "provider": "string",
  • "method": "string"
}

Query by Filter

Query for audit events with the sync topic by query-filter.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
_pagedResultsOffset
integer
_pagedResultsCookie
string
_totalPagedResultsPolicy
string
Value: "EXACT"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

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

Create with Server-Assigned ID

Publish an audit event with the sync topic.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource 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 (_id)

UUID for the message object

transactionId
string (transactionId)

The UUID of the transaction

timestamp
string (timestamp)

The time that the message was logged, in UTC format

eventName
string (event name)

The name of the audit event

userId
string (user ID)

User ID

trackingIds
Array of strings (tracking IDs)

A unique value for an object being tracked

action
string (action)

Reconciliation action, depicted as a CREST action

exception
string (exception)

The stack trace of the exception

linkQualifier
string (link qualifier)

The link qualifier applied to the action

mapping
string (mapping)

The name of the mapping used for the synchronization operation

message
string (message)

Description of the synchronization action

messageDetail
object (message detail)

Details from the synchronization run

situation
string (situation)

The synchronization situation

sourceObjectId
string (source object ID)

The object ID on the source system

sourceObject
object
status
string (status)

Reconciliation result status

targetObjectId
string (target object ID)

The object ID on the target system

targetObject
object

Responses

Request samples

Content type
{
  • "_id": "string",
  • "transactionId": "string",
  • "timestamp": "string",
  • "eventName": "string",
  • "userId": "string",
  • "trackingIds": [
    ],
  • "action": "string",
  • "exception": "string",
  • "linkQualifier": "string",
  • "mapping": "string",
  • "message": "string",
  • "messageDetail": { },
  • "situation": "string",
  • "sourceObjectId": "string",
  • "sourceObject": { },
  • "status": "string",
  • "targetObjectId": "string",
  • "targetObject": { }
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "transactionId": "string",
  • "timestamp": "string",
  • "eventName": "string",
  • "userId": "string",
  • "trackingIds": [
    ],
  • "action": "string",
  • "exception": "string",
  • "linkQualifier": "string",
  • "mapping": "string",
  • "message": "string",
  • "messageDetail": { },
  • "situation": "string",
  • "sourceObjectId": "string",
  • "sourceObject": { },
  • "status": "string",
  • "targetObjectId": "string",
  • "targetObject": { }
}

Action: rotate

Requests that a log file be rotated.

query Parameters
handler
required
string
Value: "json"

Handler 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: "rotate"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "rotated": "true"
}

Query by ID: query-all-ids

Query for all audit event identifiers with the access topic.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
_pagedResultsOffset
integer
_pagedResultsCookie
string
_totalPagedResultsPolicy
string
Value: "EXACT"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

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

Query by ID: query-all

Query for all audit events with the access topic.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
_pagedResultsOffset
integer
_pagedResultsCookie
string
_totalPagedResultsPolicy
string
Value: "EXACT"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

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

Action: flush

Requests that a log file have its buffer flushed.

query Parameters
handler
required
string
Value: "json"

Handler 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: "flush"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

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

Create with Client-Assigned ID

Publish an audit event with the recon topic and client provided identifier.

path Parameters
eventId
required
string

Event 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.

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

UUID for the message object

transactionId
string (transactionId)

The UUID of the transaction

timestamp
string (timestamp)

The time that the message was logged, in UTC format

eventName
string (event name)

The name of the audit event

userId
string (user ID)

User ID

trackingIds
Array of strings (tracking IDs)

A unique value for an object being tracked

action
string (action)

Reconciliation action, depicted as a CREST action

exception
string (exception)

The stack trace of the exception

linkQualifier
string (link qualifier)

The link qualifier applied to the action

mapping
string (mapping)

The name of the mapping used for the synchronization operation

message
string (message)

Description of the synchronization action

messageDetail
object (message detail)

Details from the synchronization run

situation
string (situation)

The synchronization situation

sourceObjectId
string (source object ID)

The object ID on the source system

sourceObject
object
status
string (status)

Reconciliation result status

targetObjectId
string (target object ID)

The object ID on the target system

targetObject
object
reconciling
string (reconciling)

What is currently being reconciled

ambiguousTargetObjectIds
string (ambiguous target object IDs)

The object IDs logged to help figure out what was ambiguous

reconAction
string (recon action)

The reconciliation action

entryType
string (entry type)

The type of reconciliation log entry

reconId
string (recon ID)

UUID for the reconciliation operation

Responses

Request samples

Content type
{
  • "_id": "string",
  • "transactionId": "string",
  • "timestamp": "string",
  • "eventName": "string",
  • "userId": "string",
  • "trackingIds": [
    ],
  • "action": "string",
  • "exception": "string",
  • "linkQualifier": "string",
  • "mapping": "string",
  • "message": "string",
  • "messageDetail": { },
  • "situation": "string",
  • "sourceObjectId": "string",
  • "sourceObject": { },
  • "status": "string",
  • "targetObjectId": "string",
  • "targetObject": { },
  • "reconciling": "string",
  • "ambiguousTargetObjectIds": "string",
  • "reconAction": "string",
  • "entryType": "string",
  • "reconId": "string"
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "transactionId": "string",
  • "timestamp": "string",
  • "eventName": "string",
  • "userId": "string",
  • "trackingIds": [
    ],
  • "action": "string",
  • "exception": "string",
  • "linkQualifier": "string",
  • "mapping": "string",
  • "message": "string",
  • "messageDetail": { },
  • "situation": "string",
  • "sourceObjectId": "string",
  • "sourceObject": { },
  • "status": "string",
  • "targetObjectId": "string",
  • "targetObject": { },
  • "reconciling": "string",
  • "ambiguousTargetObjectIds": "string",
  • "reconAction": "string",
  • "entryType": "string",
  • "reconId": "string"
}

Create with Client-Assigned ID

Publish an audit event with the config topic and client provided identifier.

path Parameters
eventId
required
string

Event 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.

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

UUID for the message object

timestamp
string (timestamp)

The time that IDM logged the message

eventName
string (event name)

The name of the audit event

transactionId
string (transaction ID)

The UUID of the transaction

userId
string (user ID)

User ID

trackingIds
Array of strings (tracking IDs)

A unique value for an object being tracked

runAs
string (run as)

User to run the activity as

objectId
string (object ID)

Object identifier

operation
string (operation)

Typically a CREST operation

before
object (before)

JSON representation of the object prior to the activity

after
object (after)

JSON representation of the object after to the activity

changedFields
Array of strings (changed fields)

Fields that were changed

revision
string (revision)

Object revision number

Responses

Request samples

Content type
{
  • "_id": "string",
  • "timestamp": "string",
  • "eventName": "string",
  • "transactionId": "string",
  • "userId": "string",
  • "trackingIds": [
    ],
  • "runAs": "string",
  • "objectId": "string",
  • "operation": "string",
  • "before": { },
  • "after": { },
  • "changedFields": [
    ],
  • "revision": "string"
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "timestamp": "string",
  • "eventName": "string",
  • "transactionId": "string",
  • "userId": "string",
  • "trackingIds": [
    ],
  • "runAs": "string",
  • "objectId": "string",
  • "operation": "string",
  • "before": { },
  • "after": { },
  • "changedFields": [
    ],
  • "revision": "string"
}

Query by ID: query-all-ids

Query for all audit event identifiers with the sync topic.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
_pagedResultsOffset
integer
_pagedResultsCookie
string
_totalPagedResultsPolicy
string
Value: "EXACT"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

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

Query by ID: query-all-ids

Query for all audit event identifiers with the activity topic.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
_pagedResultsOffset
integer
_pagedResultsCookie
string
_totalPagedResultsPolicy
string
Value: "EXACT"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

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

Create with Server-Assigned ID

Publish an audit event with the config topic.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource 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 (_id)

UUID for the message object

timestamp
string (timestamp)

The time that IDM logged the message

eventName
string (event name)

The name of the audit event

transactionId
string (transaction ID)

The UUID of the transaction

userId
string (user ID)

User ID

trackingIds
Array of strings (tracking IDs)

A unique value for an object being tracked

runAs
string (run as)

User to run the activity as

objectId
string (object ID)

Object identifier

operation
string (operation)

Typically a CREST operation

before
object (before)

JSON representation of the object prior to the activity

after
object (after)

JSON representation of the object after to the activity

changedFields
Array of strings (changed fields)

Fields that were changed

revision
string (revision)

Object revision number

Responses

Request samples

Content type
{
  • "_id": "string",
  • "timestamp": "string",
  • "eventName": "string",
  • "transactionId": "string",
  • "userId": "string",
  • "trackingIds": [
    ],
  • "runAs": "string",
  • "objectId": "string",
  • "operation": "string",
  • "before": { },
  • "after": { },
  • "changedFields": [
    ],
  • "revision": "string"
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "timestamp": "string",
  • "eventName": "string",
  • "transactionId": "string",
  • "userId": "string",
  • "trackingIds": [
    ],
  • "runAs": "string",
  • "objectId": "string",
  • "operation": "string",
  • "before": { },
  • "after": { },
  • "changedFields": [
    ],
  • "revision": "string"
}

Action: flush

Requests that a log file have its buffer flushed.

query Parameters
handler
required
string
Value: "json"

Handler 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: "flush"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

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

Create with Server-Assigned ID

Publish an audit event with the activity topic.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource 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 (_id)

UUID for the message object

timestamp
string (timestamp)

The time that IDM logged the message, in UTC format

eventName
string (event name)

The name of the audit event

transactionId
string (transaction ID)

The UUID of the transaction

userId
string (user ID)

User ID

trackingIds
Array of strings (trackingIds)

A unique value for the object being tracked

runAs
string (run as)

User to run the activity as

objectId
string (object ID)

Object identifier

operation
string (operation)

Typically a CREST operation

before
object (before)

JSON representation of the object prior to the activity

after
object (after)

JSON representation of the object after the activity

changedFields
Array of strings (changed fields)

Fields that were changed

revision
string (revision)

Object revision number

status
string (status)

Result, such as SUCCESS

message
string (message)

Human readable text about the action

passwordChanged
boolean (passwordChanged)

True/False entry on changes to the password

context
string (context)

Flag for self-service logins

provider
string (provider)

Name of the self-service provider

Responses

Request samples

Content type
{
  • "_id": "string",
  • "timestamp": "string",
  • "eventName": "string",
  • "transactionId": "string",
  • "userId": "string",
  • "trackingIds": [
    ],
  • "runAs": "string",
  • "objectId": "string",
  • "operation": "string",
  • "before": { },
  • "after": { },
  • "changedFields": [
    ],
  • "revision": "string",
  • "status": "string",
  • "message": "string",
  • "passwordChanged": true,
  • "context": "string",
  • "provider": "string"
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "timestamp": "string",
  • "eventName": "string",
  • "transactionId": "string",
  • "userId": "string",
  • "trackingIds": [
    ],
  • "runAs": "string",
  • "objectId": "string",
  • "operation": "string",
  • "before": { },
  • "after": { },
  • "changedFields": [
    ],
  • "revision": "string",
  • "status": "string",
  • "message": "string",
  • "passwordChanged": true,
  • "context": "string",
  • "provider": "string"
}

Action: rotate

Requests that a log file be rotated.

query Parameters
handler
required
string
Value: "json"

Handler 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: "rotate"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "rotated": "true"
}

Query by ID: query-all

Query for all audit events with the config topic.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
_pagedResultsOffset
integer
_pagedResultsCookie
string
_totalPagedResultsPolicy
string
Value: "EXACT"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

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

Query by Filter

Query for audit events with the config topic by query-filter.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
_pagedResultsOffset
integer
_pagedResultsCookie
string
_totalPagedResultsPolicy
string
Value: "EXACT"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

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

Read

Read an audit event with the access topic.

path Parameters
eventId
required
string

Event 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
{
  • "_id": "string",
  • "timestamp": "string",
  • "eventName": "string",
  • "transactionId": "string",
  • "userId": "string",
  • "trackingIds": [
    ],
  • "server": {
    },
  • "client": {
    },
  • "request": {
    },
  • "http": {
    },
  • "response": {
    },
  • "roles": [
    ]
}

Read

Read an audit event with the recon topic.

path Parameters
eventId
required
string

Event 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
{
  • "_id": "string",
  • "transactionId": "string",
  • "timestamp": "string",
  • "eventName": "string",
  • "userId": "string",
  • "trackingIds": [
    ],
  • "action": "string",
  • "exception": "string",
  • "linkQualifier": "string",
  • "mapping": "string",
  • "message": "string",
  • "messageDetail": { },
  • "situation": "string",
  • "sourceObjectId": "string",
  • "sourceObject": { },
  • "status": "string",
  • "targetObjectId": "string",
  • "targetObject": { },
  • "reconciling": "string",
  • "ambiguousTargetObjectIds": "string",
  • "reconAction": "string",
  • "entryType": "string",
  • "reconId": "string"
}

Query by Filter

Query for audit events with the access topic by query-filter.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
_pagedResultsOffset
integer
_pagedResultsCookie
string
_totalPagedResultsPolicy
string
Value: "EXACT"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

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

Action: rotate

Requests that a log file be rotated.

query Parameters
handler
required
string
Value: "json"

Handler 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: "rotate"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "rotated": "true"
}

Read

Read an audit event with the activity topic.

path Parameters
eventId
required
string

Event 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
{
  • "_id": "string",
  • "timestamp": "string",
  • "eventName": "string",
  • "transactionId": "string",
  • "userId": "string",
  • "trackingIds": [
    ],
  • "runAs": "string",
  • "objectId": "string",
  • "operation": "string",
  • "before": { },
  • "after": { },
  • "changedFields": [
    ],
  • "revision": "string",
  • "status": "string",
  • "message": "string",
  • "passwordChanged": true,
  • "context": "string",
  • "provider": "string"
}

Read

Read an audit event with the config topic.

path Parameters
eventId
required
string

Event 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
{
  • "_id": "string",
  • "timestamp": "string",
  • "eventName": "string",
  • "transactionId": "string",
  • "userId": "string",
  • "trackingIds": [
    ],
  • "runAs": "string",
  • "objectId": "string",
  • "operation": "string",
  • "before": { },
  • "after": { },
  • "changedFields": [
    ],
  • "revision": "string"
}

Read

Read an audit event with the sync topic.

path Parameters
eventId
required
string

Event 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
{
  • "_id": "string",
  • "transactionId": "string",
  • "timestamp": "string",
  • "eventName": "string",
  • "userId": "string",
  • "trackingIds": [
    ],
  • "action": "string",
  • "exception": "string",
  • "linkQualifier": "string",
  • "mapping": "string",
  • "message": "string",
  • "messageDetail": { },
  • "situation": "string",
  • "sourceObjectId": "string",
  • "sourceObject": { },
  • "status": "string",
  • "targetObjectId": "string",
  • "targetObject": { }
}

Action: flush

Requests that a log file have its buffer flushed.

query Parameters
handler
required
string
Value: "json"

Handler 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: "flush"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

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

Query by ID: query-all-ids

Query for all audit event identifiers with the authentication topic.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
_pagedResultsOffset
integer
_pagedResultsCookie
string
_totalPagedResultsPolicy
string
Value: "EXACT"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

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

Action: availableHandlers

List available audit event handlers.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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: "availableHandlers"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Query by Filter

Query for audit events with the authentication topic by query-filter.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
_pagedResultsOffset
integer
_pagedResultsCookie
string
_totalPagedResultsPolicy
string
Value: "EXACT"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

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

Create with Client-Assigned ID

Publish an audit event with the authentication topic and client provided identifier.

path Parameters
eventId
required
string

Event 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.

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

UUID for the message object

timestamp
string (timestamp)

The time that IDM logged the message

eventName
string (event name)

The name of the audit event:

transactionId
string (transaction ID)

The UUID of the transaction

userId
string (user ID)

User ID

trackingIds
Array of strings (tracking IDs)

A unique value for an object being tracked

result
string (result)

The result of the transaction

principal
Array of strings (principal)

An array of the accounts used to authenticate

context
object (context)

The complete security context of the authentication operation

Array of objects (entries)

The JSON representation of the authentication session

provider
string (provider)

The social identity provider name

method
string (method)

The authentication module

Responses

Request samples

Content type
{
  • "_id": "string",
  • "timestamp": "string",
  • "eventName": "string",
  • "transactionId": "string",
  • "userId": "string",
  • "trackingIds": [
    ],
  • "result": "string",
  • "principal": [
    ],
  • "context": { },
  • "entries": [
    ],
  • "provider": "string",
  • "method": "string"
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "timestamp": "string",
  • "eventName": "string",
  • "transactionId": "string",
  • "userId": "string",
  • "trackingIds": [
    ],
  • "result": "string",
  • "principal": [
    ],
  • "context": { },
  • "entries": [
    ],
  • "provider": "string",
  • "method": "string"
}

Action: flush

Requests that a log file have its buffer flushed.

query Parameters
handler
required
string
Value: "json"

Handler 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: "flush"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

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

Create with Server-Assigned ID

Publish an audit event with the access topic.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource 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 (_id)

Object ID

timestamp
string (timestamp)

The time that IDM logged the message, in UTC format

eventName
string (event name)

The name of the audit event

transactionId
string (transaction ID)

The UUID of the transaction

userId
string (user ID)

User ID

trackingIds
Array of strings (tracking IDs)

A unique value for an object being tracked

object (server)

Server

object (client)

Client

object (request)

Request

object (http)

HTTP Information

object (response)

Server response

roles
Array of strings (roles)

IDM roles associated with the request

Responses

Request samples

Content type
{
  • "_id": "string",
  • "timestamp": "string",
  • "eventName": "string",
  • "transactionId": "string",
  • "userId": "string",
  • "trackingIds": [
    ],
  • "server": {
    },
  • "client": {
    },
  • "request": {
    },
  • "http": {
    },
  • "response": {
    },
  • "roles": [
    ]
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "timestamp": "string",
  • "eventName": "string",
  • "transactionId": "string",
  • "userId": "string",
  • "trackingIds": [
    ],
  • "server": {
    },
  • "client": {
    },
  • "request": {
    },
  • "http": {
    },
  • "response": {
    },
  • "roles": [
    ]
}

Create with Server-Assigned ID

Publish an audit event with the recon topic.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource 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 (_id)

UUID for the message object

transactionId
string (transactionId)

The UUID of the transaction

timestamp
string (timestamp)

The time that the message was logged, in UTC format

eventName
string (event name)

The name of the audit event

userId
string (user ID)

User ID

trackingIds
Array of strings (tracking IDs)

A unique value for an object being tracked

action
string (action)

Reconciliation action, depicted as a CREST action

exception
string (exception)

The stack trace of the exception

linkQualifier
string (link qualifier)

The link qualifier applied to the action

mapping
string (mapping)

The name of the mapping used for the synchronization operation

message
string (message)

Description of the synchronization action

messageDetail
object (message detail)

Details from the synchronization run

situation
string (situation)

The synchronization situation

sourceObjectId
string (source object ID)

The object ID on the source system

sourceObject
object
status
string (status)

Reconciliation result status

targetObjectId
string (target object ID)

The object ID on the target system

targetObject
object
reconciling
string (reconciling)

What is currently being reconciled

ambiguousTargetObjectIds
string (ambiguous target object IDs)

The object IDs logged to help figure out what was ambiguous

reconAction
string (recon action)

The reconciliation action

entryType
string (entry type)

The type of reconciliation log entry

reconId
string (recon ID)

UUID for the reconciliation operation

Responses

Request samples

Content type
{
  • "_id": "string",
  • "transactionId": "string",
  • "timestamp": "string",
  • "eventName": "string",
  • "userId": "string",
  • "trackingIds": [
    ],
  • "action": "string",
  • "exception": "string",
  • "linkQualifier": "string",
  • "mapping": "string",
  • "message": "string",
  • "messageDetail": { },
  • "situation": "string",
  • "sourceObjectId": "string",
  • "sourceObject": { },
  • "status": "string",
  • "targetObjectId": "string",
  • "targetObject": { },
  • "reconciling": "string",
  • "ambiguousTargetObjectIds": "string",
  • "reconAction": "string",
  • "entryType": "string",
  • "reconId": "string"
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "transactionId": "string",
  • "timestamp": "string",
  • "eventName": "string",
  • "userId": "string",
  • "trackingIds": [
    ],
  • "action": "string",
  • "exception": "string",
  • "linkQualifier": "string",
  • "mapping": "string",
  • "message": "string",
  • "messageDetail": { },
  • "situation": "string",
  • "sourceObjectId": "string",
  • "sourceObject": { },
  • "status": "string",
  • "targetObjectId": "string",
  • "targetObject": { },
  • "reconciling": "string",
  • "ambiguousTargetObjectIds": "string",
  • "reconAction": "string",
  • "entryType": "string",
  • "reconId": "string"
}

Action: rotate

Requests that a log file be rotated.

query Parameters
handler
required
string
Value: "json"

Handler 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: "rotate"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "rotated": "true"
}

Create with Client-Assigned ID

Publish an audit event with the sync topic and client provided identifier.

path Parameters
eventId
required
string

Event 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.

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

UUID for the message object

transactionId
string (transactionId)

The UUID of the transaction

timestamp
string (timestamp)

The time that the message was logged, in UTC format

eventName
string (event name)

The name of the audit event

userId
string (user ID)

User ID

trackingIds
Array of strings (tracking IDs)

A unique value for an object being tracked

action
string (action)

Reconciliation action, depicted as a CREST action

exception
string (exception)

The stack trace of the exception

linkQualifier
string (link qualifier)

The link qualifier applied to the action

mapping
string (mapping)

The name of the mapping used for the synchronization operation

message
string (message)

Description of the synchronization action

messageDetail
object (message detail)

Details from the synchronization run

situation
string (situation)

The synchronization situation

sourceObjectId
string (source object ID)

The object ID on the source system

sourceObject
object
status
string (status)

Reconciliation result status

targetObjectId
string (target object ID)

The object ID on the target system

targetObject
object

Responses

Request samples

Content type
{
  • "_id": "string",
  • "transactionId": "string",
  • "timestamp": "string",
  • "eventName": "string",
  • "userId": "string",
  • "trackingIds": [
    ],
  • "action": "string",
  • "exception": "string",
  • "linkQualifier": "string",
  • "mapping": "string",
  • "message": "string",
  • "messageDetail": { },
  • "situation": "string",
  • "sourceObjectId": "string",
  • "sourceObject": { },
  • "status": "string",
  • "targetObjectId": "string",
  • "targetObject": { }
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "transactionId": "string",
  • "timestamp": "string",
  • "eventName": "string",
  • "userId": "string",
  • "trackingIds": [
    ],
  • "action": "string",
  • "exception": "string",
  • "linkQualifier": "string",
  • "mapping": "string",
  • "message": "string",
  • "messageDetail": { },
  • "situation": "string",
  • "sourceObjectId": "string",
  • "sourceObject": { },
  • "status": "string",
  • "targetObjectId": "string",
  • "targetObject": { }
}

Create with Client-Assigned ID

Publish an audit event with the access topic and client provided identifier.

path Parameters
eventId
required
string

Event 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.

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

Object ID

timestamp
string (timestamp)

The time that IDM logged the message, in UTC format

eventName
string (event name)

The name of the audit event

transactionId
string (transaction ID)

The UUID of the transaction

userId
string (user ID)

User ID

trackingIds
Array of strings (tracking IDs)

A unique value for an object being tracked

object (server)

Server

object (client)

Client

object (request)

Request

object (http)

HTTP Information

object (response)

Server response

roles
Array of strings (roles)

IDM roles associated with the request

Responses

Request samples

Content type
{
  • "_id": "string",
  • "timestamp": "string",
  • "eventName": "string",
  • "transactionId": "string",
  • "userId": "string",
  • "trackingIds": [
    ],
  • "server": {
    },
  • "client": {
    },
  • "request": {
    },
  • "http": {
    },
  • "response": {
    },
  • "roles": [
    ]
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "timestamp": "string",
  • "eventName": "string",
  • "transactionId": "string",
  • "userId": "string",
  • "trackingIds": [
    ],
  • "server": {
    },
  • "client": {
    },
  • "request": {
    },
  • "http": {
    },
  • "response": {
    },
  • "roles": [
    ]
}

Query by ID: query-all

Query for all audit events with the authentication topic.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
_pagedResultsOffset
integer
_pagedResultsCookie
string
_totalPagedResultsPolicy
string
Value: "EXACT"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

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

Query by ID: query-all

Query for all audit events with the activity topic.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
_pagedResultsOffset
integer
_pagedResultsCookie
string
_totalPagedResultsPolicy
string
Value: "EXACT"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

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

Query by ID: query-all-ids

Query for all audit event identifiers with the config topic.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
_pagedResultsOffset
integer
_pagedResultsCookie
string
_totalPagedResultsPolicy
string
Value: "EXACT"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

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

Create with Client-Assigned ID

Publish an audit event with the activity topic and client provided identifier.

path Parameters
eventId
required
string

Event 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.

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

UUID for the message object

timestamp
string (timestamp)

The time that IDM logged the message, in UTC format

eventName
string (event name)

The name of the audit event

transactionId
string (transaction ID)

The UUID of the transaction

userId
string (user ID)

User ID

trackingIds
Array of strings (trackingIds)

A unique value for the object being tracked

runAs
string (run as)

User to run the activity as

objectId
string (object ID)

Object identifier

operation
string (operation)

Typically a CREST operation

before
object (before)

JSON representation of the object prior to the activity

after
object (after)

JSON representation of the object after the activity

changedFields
Array of strings (changed fields)

Fields that were changed

revision
string (revision)

Object revision number

status
string (status)

Result, such as SUCCESS

message
string (message)

Human readable text about the action

passwordChanged
boolean (passwordChanged)

True/False entry on changes to the password

context
string (context)

Flag for self-service logins

provider
string (provider)

Name of the self-service provider

Responses

Request samples

Content type
{
  • "_id": "string",
  • "timestamp": "string",
  • "eventName": "string",
  • "transactionId": "string",
  • "userId": "string",
  • "trackingIds": [
    ],
  • "runAs": "string",
  • "objectId": "string",
  • "operation": "string",
  • "before": { },
  • "after": { },
  • "changedFields": [
    ],
  • "revision": "string",
  • "status": "string",
  • "message": "string",
  • "passwordChanged": true,
  • "context": "string",
  • "provider": "string"
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "timestamp": "string",
  • "eventName": "string",
  • "transactionId": "string",
  • "userId": "string",
  • "trackingIds": [
    ],
  • "runAs": "string",
  • "objectId": "string",
  • "operation": "string",
  • "before": { },
  • "after": { },
  • "changedFields": [
    ],
  • "revision": "string",
  • "status": "string",
  • "message": "string",
  • "passwordChanged": true,
  • "context": "string",
  • "provider": "string"
}

Action: flush

Requests that a log file have its buffer flushed.

query Parameters
handler
required
string
Value: "json"

Handler 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: "flush"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

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

Action: rotate

Requests that a log file be rotated.

query Parameters
handler
required
string
Value: "json"

Handler 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: "rotate"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "rotated": "true"
}

Action: rotate

Requests that a log file be rotated.

query Parameters
handler
required
string
Value: "json"

Handler 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: "rotate"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "rotated": "true"
}

Query by ID: query-all

Query for all audit events with the recon topic.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
_pagedResultsOffset
integer
_pagedResultsCookie
string
_totalPagedResultsPolicy
string
Value: "EXACT"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

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

Query by Filter

Query for audit events with the activity topic by query-filter.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
_pagedResultsOffset
integer
_pagedResultsCookie
string
_totalPagedResultsPolicy
string
Value: "EXACT"
_sortKeys
string
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

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

Create with Server-Assigned ID

Publish an audit event with the authentication topic.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource 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 (_id)

UUID for the message object

timestamp
string (timestamp)

The time that IDM logged the message

eventName
string (event name)

The name of the audit event:

transactionId
string (transaction ID)

The UUID of the transaction

userId
string (user ID)

User ID

trackingIds
Array of strings (tracking IDs)

A unique value for an object being tracked

result
string (result)

The result of the transaction

principal
Array of strings (principal)

An array of the accounts used to authenticate

context
object (context)

The complete security context of the authentication operation

Array of objects (entries)

The JSON representation of the authentication session

provider
string (provider)

The social identity provider name

method
string (method)

The authentication module

Responses

Request samples

Content type
{
  • "_id": "string",
  • "timestamp": "string",
  • "eventName": "string",
  • "transactionId": "string",
  • "userId": "string",
  • "trackingIds": [
    ],
  • "result": "string",
  • "principal": [
    ],
  • "context": { },
  • "entries": [
    ],
  • "provider": "string",
  • "method": "string"
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "timestamp": "string",
  • "eventName": "string",
  • "transactionId": "string",
  • "userId": "string",
  • "trackingIds": [
    ],
  • "result": "string",
  • "principal": [
    ],
  • "context": { },
  • "entries": [
    ],
  • "provider": "string",
  • "method": "string"
}

Authentication v1.0

Action: reauthenticate

Reauthenticates a session using the provided "X-OpenIDM-Reauth-Password" header. RFC 5987 encoding can optionally be used with UTF-8 or ISO-8859-1. Note that the API Explorer cannot currently input this header field, but that it does work if provided using traditional REST clients.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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: "reauthenticate"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "reauthenticated": true
}

Read

Lists enabled OpenID Connect and OAuth modules.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "providers": [
    ]
}

Action: login

Authenticate a set of credentials.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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: "login"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "authorization": {
    },
  • "authenticationId": "string"
}

Action: logout

Invalidates the current JWT cookie's value.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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: "logout"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Cluster v1.0

Read

Reads cluster node status.

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
If-None-Match
string
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "instanceId": "string",
  • "startup": "2019-08-24T14:15:22Z",
  • "state": "string",
  • "shutdown": "2019-08-24T14:15:22Z",
  • "recovery": { }
}

Query by ID: query-cluster-instances Deprecated

Lists the status of all cluster nodes via a queryId.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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-cluster-instances"
_pageSize
integer
_totalPagedResultsPolicy
string
Value: "NONE"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"

Responses

Response samples

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

Query by Filter

Query the state of cluster nodes.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Configuration v1.0

Delete

Delete a multi-instance configuration.

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.

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

Responses

Response samples

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

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).

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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 single-instance configuration.

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"
}

Update via Patch Operations

Patch a multi-instance configuration.

path Parameters
factoryPid
required
string

Persistent identity for group (factory)

instanceId
required
string

Instance ID under parent group

query Parameters
waitForCompletion
boolean

If true, the response waits for OSGi service events to corroborate the configuration changes have been consumed.

_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should 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
operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

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

Create with Client-Assigned ID

Create a single-instance configuration.

path Parameters
instanceId
required
string

Instance ID

query Parameters
waitForCompletion
boolean

If true, the response waits for OSGi service events to corroborate the configuration changes have been consumed.

_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should 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
required
string

Configuration identifier (instanceId or factoryId/instanceId)

Responses

Request samples

Content type
{
  • "_id": "string"
}

Response samples

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

Read

Read a multi-instance configuration.

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"
}

Create with Client-Assigned ID

Create a multi-instance configuration.

path Parameters
factoryPid
required
string

Persistent identity for group (factory)

instanceId
required
string

Instance ID under parent group

query Parameters
waitForCompletion
boolean

If true, the response waits for OSGi service events to corroborate the configuration changes have been consumed.

_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should 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
required
string

Configuration identifier (instanceId or factoryId/instanceId)

Responses

Request samples

Content type
{
  • "_id": "string"
}

Response samples

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

Update via Patch Operations

Patch a single-instance configuration.

path Parameters
instanceId
required
string

Instance ID

query Parameters
waitForCompletion
boolean

If true, the response waits for OSGi service events to corroborate the configuration changes have been consumed.

_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should 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
operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

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

Update

Update a multi-instance configuration.

path Parameters
factoryPid
required
string

Persistent identity for group (factory)

instanceId
required
string

Instance ID under parent group

query Parameters
waitForCompletion
boolean

If true, the response waits for OSGi service events to corroborate the configuration changes have been consumed.

_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should 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
required
string

Configuration identifier (instanceId or factoryId/instanceId)

Responses

Request samples

Content type
{
  • "_id": "string"
}

Response samples

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

Query by Filter

Queries the configurations.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Delete

Delete a single-instance configuration.

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.

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

Update a single-instance configuration.

path Parameters
instanceId
required
string

Instance ID

query Parameters
waitForCompletion
boolean

If true, the response waits for OSGi service events to corroborate the configuration changes have been consumed.

_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should 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
required
string

Configuration identifier (instanceId or factoryId/instanceId)

Responses

Request samples

Content type
{
  • "_id": "string"
}

Response samples

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

Consent v1.0

Consent v2.0

CSV Import v1.0

Action: cleanupList

Lists import UUIDs that may need the cleanup action, if the import is not in-progress.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "hasTempRecords": [
    ],
  • "hasErrorRecords": [
    ]
}

Action: cleanup

Cleans up temporary import records.

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.

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
{
  • "header": [
    ],
  • "reconId": "string",
  • "filename": "string",
  • "resourcePath": "managed/user",
  • "total": 0,
  • "success": 0,
  • "failure": 0,
  • "created": 0,
  • "updated": 0,
  • "unchanged": 0,
  • "authId": "string",
  • "authzComponent": "string",
  • "_id": "string",
  • "_rev": "string"
}

Query by Filter

Query import records.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Read

Read import record.

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
{
  • "header": [
    ],
  • "reconId": "string",
  • "filename": "string",
  • "resourcePath": "managed/user",
  • "total": 0,
  • "success": 0,
  • "failure": 0,
  • "created": 0,
  • "updated": 0,
  • "unchanged": 0,
  • "authId": "string",
  • "authzComponent": "string",
  • "_id": "string",
  • "_rev": "string"
}

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.

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"
}

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.

path Parameters
importUUID
required
string <uuid>

Import UUID

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

Responses

Action: cancel

Cancels an in-progress import.

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"
}

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).

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": [
    ]
}

Email v1.0

Action: send

Send email

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
to
required
string <email>

Comma-separated recipient addresses

from
required
string <email>

Sender address

cc
string <email>

Comma-separated carbon copy addresses

bcc
string <email>

Comma-separated blind carbon copy addresses

subject
string
Default: "<empty subject>"

Message subject

body
string
Default: "<empty message>"

Message body

type
string
Default: "text/plain"
Enum: "text/plain" "text/html" "text/xml"

MIME type of message body

Responses

Request samples

Content type
{
  • "to": "user@example.com",
  • "from": "user@example.com",
  • "cc": "user@example.com",
  • "bcc": "user@example.com",
  • "subject": "<empty subject>",
  • "body": "<empty message>",
  • "type": "text/plain"
}

Response samples

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

Action: sendTemplate

Send template

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
templateName
required
string

Template Name

to
string <email>

Comma-separated recipient addresses

cc
string <email>

Comma-separated CC addresses

bcc
string <email>

Comma-separated BCC addresses

object
object

Key-value pairs to inject into template

Responses

Request samples

Content type
{
  • "templateName": "string",
  • "to": "user@example.com",
  • "cc": "user@example.com",
  • "bcc": "user@example.com",
  • "object": { }
}

Response samples

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

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.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
url
required
string

The URL to request

method
required
string
Enum: "GET" "HEAD" "POST" "PUT" "DELETE" "CONNECT" "OPTIONS" "TRACE" "PATCH"

HTTP request method

headers
object

Header key/value pairs to pass to external REST endpoint

contentType
string
Default: "application/json; charset=utf-8"

Optional content-type header for request payload

body
string

HTTP request payload

base64
boolean
Default: false

Indicates that body is a base-64 encoded binary value

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

object (Authentication Options)

Configures basic- or bearer-authentication on external endpoint

Responses

Request samples

Content type
{
  • "url": "string",
  • "method": "GET",
  • "headers": { },
  • "contentType": "application/json; charset=utf-8",
  • "body": "string",
  • "base64": false,
  • "forceWrap": false,
  • "authenticate": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "headers": { },
  • "body": "string",
  • "base64": true
}

Health v1.0

Read Deprecated

Responds with Reconciliation thread pool statistics.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "activeThreads": 0,
  • "corePoolSize": 0,
  • "largestPoolSize": 0,
  • "maximumPoolSize": 0,
  • "currentPoolSize": 0
}

Read Deprecated

Responds with JVM Memory Information.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "objectPendingFinalization": 0,
  • "heapMemoryUsage": {
    },
  • "nonHeapMemoryUsage": {
    }
}

Read Deprecated

Read Operating System Information

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "availableProcessors": 0.1,
  • "systemLoadAverage": 0.1,
  • "operatingSystemArchitecture": "string",
  • "operatingSystemName": "string",
  • "operatingSystemVersion": "string"
}

Identity Provider v1.0

Read

Retrieves all Identity Provider configurations with Client Secret removed.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "providers": [
    ]
}

Action: getLogoutUrl

Provides the logout URL using the X-OpenIDM-DataStoreToken header

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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: "getLogoutUrl"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
object (Request parameters for the GetLogoutUrl API)

Responses

Request samples

Content type
{ }

Response samples

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

Information v1.0

Read

Provides authentication and authorization details, for the authenticated caller (e.g., User).

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "authorization": {
    },
  • "authenticationId": "string"
}

Read

Provides the UI configuration of this OpenIDM instance.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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

Returns OpenIDM status information, and is an endpoint suitable for pinging the server.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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"
}

Query by Filter

Provides a list of available features in this OpenIDM instance, whether the feature is enabled, and any related endpoints.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Read

Provides a single feature in this OpenIDM instance, whether it's enabled, and any related endpoints.

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
{
  • "name": "string",
  • "enabled": true,
  • "endpoints": [
    ]
}

Read

Provides the software version of this OpenIDM instance.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "productVersion": "string",
  • "productBuildDate": "string",
  • "productRevision": "string"
}

Internal Notification v1.0

Delete

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",
  • "message": "string",
  • "notificationType": "string",
  • "createDate": "string",
  • "target": {
    }
}

Read

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",
  • "message": "string",
  • "notificationType": "string",
  • "createDate": "string",
  • "target": {
    }
}

Query by ID: query-all-ids

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Query by Filter

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Query by ID: query-all

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Update via Patch Operations

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
operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_id": "string",
  • "message": "string",
  • "notificationType": "string",
  • "createDate": "string",
  • "target": {
    }
}

Create with Client-Assigned ID

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

message
string (Message)

The notification message.

notificationType
string (Notification Type)

The type of notification, used for display purposes.

createDate
string (Create Date)

Date the notification was created.

required
object (Notification Target)

Responses

Request samples

Content type
{
  • "_id": "string",
  • "message": "string",
  • "notificationType": "string",
  • "createDate": "string",
  • "target": {
    }
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "message": "string",
  • "notificationType": "string",
  • "createDate": "string",
  • "target": {
    }
}

Create with Server-Assigned 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.

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

Notification ID

message
string (Message)

The notification message.

notificationType
string (Notification Type)

The type of notification, used for display purposes.

createDate
string (Create Date)

Date the notification was created.

required
object (Notification Target)

Responses

Request samples

Content type
{
  • "_id": "string",
  • "message": "string",
  • "notificationType": "string",
  • "createDate": "string",
  • "target": {
    }
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "message": "string",
  • "notificationType": "string",
  • "createDate": "string",
  • "target": {
    }
}

Update

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

message
string (Message)

The notification message.

notificationType
string (Notification Type)

The type of notification, used for display purposes.

createDate
string (Create Date)

Date the notification was created.

required
object (Notification Target)

Responses

Request samples

Content type
{
  • "_id": "string",
  • "message": "string",
  • "notificationType": "string",
  • "createDate": "string",
  • "target": {
    }
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "message": "string",
  • "notificationType": "string",
  • "createDate": "string",
  • "target": {
    }
}

Internal Role v1.0

Query by Filter

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Create with Server-Assigned 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.

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

Role ID

name
required
string (Name)

The role name, used for display purposes.

description
string (Description)

The role description, used for display purposes.

Array of objects (Privileges)

Internal Privileges

Array of objects (Members)

Authorization Role Members

Array of objects (Time Constraint)

Set a start and end date during which this role will be active

condition
string (Condition)

A conditional filter for this role

Responses

Request samples

Content type
{
  • "_id": "string",
  • "name": "string",
  • "description": "string",
  • "privileges": [
    ],
  • "authzMembers": [
    ],
  • "temporalConstraints": [
    ],
  • "condition": "string"
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "description": "string",
  • "privileges": [
    ],
  • "authzMembers": [
    ],
  • "temporalConstraints": [
    ],
  • "condition": "string"
}

Read

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",
  • "name": "string",
  • "description": "string",
  • "privileges": [
    ],
  • "authzMembers": [
    ],
  • "temporalConstraints": [
    ],
  • "condition": "string"
}

Query by ID: query-all-ids

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Query by ID: query-all

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Update via Patch Operations

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
operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "description": "string",
  • "privileges": [
    ],
  • "authzMembers": [
    ],
  • "temporalConstraints": [
    ],
  • "condition": "string"
}

Delete

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",
  • "name": "string",
  • "description": "string",
  • "privileges": [
    ],
  • "authzMembers": [
    ],
  • "temporalConstraints": [
    ],
  • "condition": "string"
}

Update

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

name
required
string (Name)

The role name, used for display purposes.

description
string (Description)

The role description, used for display purposes.

Array of objects (Privileges)

Internal Privileges

Array of objects (Members)

Authorization Role Members

Array of objects (Time Constraint)

Set a start and end date during which this role will be active

condition
string (Condition)

A conditional filter for this role

Responses

Request samples

Content type
{
  • "_id": "string",
  • "name": "string",
  • "description": "string",
  • "privileges": [
    ],
  • "authzMembers": [
    ],
  • "temporalConstraints": [
    ],
  • "condition": "string"
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "description": "string",
  • "privileges": [
    ],
  • "authzMembers": [
    ],
  • "temporalConstraints": [
    ],
  • "condition": "string"
}

Create with Client-Assigned ID

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

name
required
string (Name)

The role name, used for display purposes.

description
string (Description)

The role description, used for display purposes.

Array of objects (Privileges)

Internal Privileges

Array of objects (Members)

Authorization Role Members

Array of objects (Time Constraint)

Set a start and end date during which this role will be active

condition
string (Condition)

A conditional filter for this role

Responses

Request samples

Content type
{
  • "_id": "string",
  • "name": "string",
  • "description": "string",
  • "privileges": [
    ],
  • "authzMembers": [
    ],
  • "temporalConstraints": [
    ],
  • "condition": "string"
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "description": "string",
  • "privileges": [
    ],
  • "authzMembers": [
    ],
  • "temporalConstraints": [
    ],
  • "condition": "string"
}

Internal Role - Members v1.0

Query by ID: query-all

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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Create with Server-Assigned ID

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": {
    }
}

Update via Patch Operations

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
operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

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

Query by Filter

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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Delete

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": {
    }
}

Read

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": {
    }
}

Create with Client-Assigned ID

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": {
    }
}

Update

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": {
    }
}

Query by ID: query-all-ids

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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Internal User v1.0

Create with Client-Assigned ID

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"
}

Query by Filter

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Query by ID: query-all

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Create with Server-Assigned 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.

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"
}

Update

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"
}

Delete

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"
}

Query by ID: query-all-ids

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Update via Patch Operations

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
operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_id": "string",
  • "password": "string"
}

Read

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"
}

Internal User Metadata v1.0

Create with Client-Assigned ID

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"
}

Update

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"
}

Update via Patch Operations

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
operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

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

Query by ID: query-all

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Query by ID: query-all-ids

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Create with Server-Assigned 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.

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"
}

Delete

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"
}

Query by Filter

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Read

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"
}

Assignment v1.0

Update

path Parameters
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

name
required
string (Name)

The assignment name, used for display purposes.

description
required
string (Description)

The assignment description, used for display purposes.

mapping
required
string (Mapping)

The name of the mapping this assignment applies to

Array of objects (Assignment Attributes)

The attributes operated on by this assignment.

linkQualifiers
Array of strings (Link Qualifiers)

Conditional link qualifiers to restrict this assignment to.

Array of objects (Managed Roles)

Managed Roles

Array of objects (Assignment Members)

Assignment Members

condition
string (Condition)

A conditional filter for this assignment

weight
number <double> (Weight)

The weight of the assignment.

Responses

Request samples

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

Response samples

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

Query by ID: query-all-ids

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Update via Patch Operations

path Parameters
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
operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

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

Read

path Parameters
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",
  • "name": "string",
  • "description": "string",
  • "mapping": "string",
  • "attributes": [
    ],
  • "linkQualifiers": [
    ],
  • "roles": [
    ],
  • "members": [
    ],
  • "condition": "string",
  • "weight": 0.1
}

Action: triggerSyncCheck

path Parameters
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"
}

Delete

path Parameters
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",
  • "name": "string",
  • "description": "string",
  • "mapping": "string",
  • "attributes": [
    ],
  • "linkQualifiers": [
    ],
  • "roles": [
    ],
  • "members": [
    ],
  • "condition": "string",
  • "weight": 0.1
}

Query by ID: query-all

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Create with Client-Assigned ID

path Parameters
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

name
required
string (Name)

The assignment name, used for display purposes.

description
required
string (Description)

The assignment description, used for display purposes.

mapping
required
string (Mapping)

The name of the mapping this assignment applies to

Array of objects (Assignment Attributes)

The attributes operated on by this assignment.

linkQualifiers
Array of strings (Link Qualifiers)

Conditional link qualifiers to restrict this assignment to.

Array of objects (Managed Roles)

Managed Roles

Array of objects (Assignment Members)

Assignment Members

condition
string (Condition)

A conditional filter for this assignment

weight
number <double> (Weight)

The weight of the assignment.

Responses

Request samples

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

Response samples

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

Query by Filter

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Create with Server-Assigned 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.

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

The assignment ID

name
required
string (Name)

The assignment name, used for display purposes.

description
required
string (Description)

The assignment description, used for display purposes.

mapping
required
string (Mapping)

The name of the mapping this assignment applies to

Array of objects (Assignment Attributes)

The attributes operated on by this assignment.

linkQualifiers
Array of strings (Link Qualifiers)

Conditional link qualifiers to restrict this assignment to.

Array of objects (Managed Roles)

Managed Roles

Array of objects (Assignment Members)

Assignment Members

condition
string (Condition)

A conditional filter for this assignment

weight
number <double> (Weight)

The weight of the assignment.

Responses

Request samples

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

Response samples

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

Assignment - Assignment Members v1.0

Update via Patch Operations

path Parameters
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
operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

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

Read

path Parameters
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": {
    }
}

Create with Server-Assigned ID

path Parameters
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 ID: query-all

path Parameters
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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Query by Filter

path Parameters
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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Delete

path Parameters
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

path Parameters
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": {
    }
}

Create with Client-Assigned ID

path Parameters
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": {
    }
}

Query by ID: query-all-ids

path Parameters
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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Assignment - Managed Roles v1.0

Query by ID: query-all

path Parameters
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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Create with Client-Assigned ID

path Parameters
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": {
    }
}

Read

path Parameters
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": {
    }
}

Delete

path Parameters
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": {
    }
}

Query by ID: query-all-ids

path Parameters
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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Query by Filter

path Parameters
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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Update via Patch Operations

path Parameters
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
operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

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

Create with Server-Assigned ID

path Parameters
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": {
    }
}

Update

path Parameters
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": {
    }
}

Organization v1.0

Update via Patch Operations

path Parameters
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
operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

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

Query by Filter

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Action: triggerSyncCheck

path Parameters
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"
}

Query by ID: query-all-ids

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Query by ID: query-all

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Create with Client-Assigned ID

path Parameters
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
name
required
string (Name)
description
string (Description)
Array of objects (Owner)
Array of objects (Administrators)
Array of objects (Members)
object (Parent Organization)

Parent Organization

Array of objects (Child Organizations)

Child Organizations

adminIDs
Array of strings (Admin user ids)
ownerIDs
Array of strings (Owner user ids)
parentAdminIDs
Array of strings (user ids of parent admins)
parentOwnerIDs
Array of strings (user ids of parent owners)
parentIDs
Array of strings (parent org ids)

Responses

Request samples

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

Response samples

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

Read

path Parameters
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
{
  • "name": "string",
  • "description": "string",
  • "owners": [
    ],
  • "admins": [
    ],
  • "members": [
    ],
  • "parent": {
    },
  • "children": [
    ],
  • "adminIDs": [
    ],
  • "ownerIDs": [
    ],
  • "parentAdminIDs": [
    ],
  • "parentOwnerIDs": [
    ],
  • "parentIDs": [
    ]
}

Update

path Parameters
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
name
required
string (Name)
description
string (Description)
Array of objects (Owner)
Array of objects (Administrators)
Array of objects (Members)
object (Parent Organization)

Parent Organization

Array of objects (Child Organizations)

Child Organizations

adminIDs
Array of strings (Admin user ids)
ownerIDs
Array of strings (Owner user ids)
parentAdminIDs
Array of strings (user ids of parent admins)
parentOwnerIDs
Array of strings (user ids of parent owners)
parentIDs
Array of strings (parent org ids)

Responses

Request samples

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

Response samples

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

Create with Server-Assigned 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.

header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
name
required
string (Name)
description
string (Description)
Array of objects (Owner)
Array of objects (Administrators)
Array of objects (Members)
object (Parent Organization)

Parent Organization

Array of objects (Child Organizations)

Child Organizations

adminIDs
Array of strings (Admin user ids)
ownerIDs
Array of strings (Owner user ids)
parentAdminIDs
Array of strings (user ids of parent admins)
parentOwnerIDs
Array of strings (user ids of parent owners)
parentIDs
Array of strings (parent org ids)

Responses

Request samples

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

Response samples

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

Delete

path Parameters
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
{
  • "name": "string",
  • "description": "string",
  • "owners": [
    ],
  • "admins": [
    ],
  • "members": [
    ],
  • "parent": {
    },
  • "children": [
    ],
  • "adminIDs": [
    ],
  • "ownerIDs": [
    ],
  • "parentAdminIDs": [
    ],
  • "parentOwnerIDs": [
    ],
  • "parentIDs": [
    ]
}

Organization - Administrators v1.0

Query by Filter

path Parameters
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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Delete

path Parameters
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": {
    }
}

Query by ID: query-all-ids

path Parameters
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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Create with Client-Assigned ID

path Parameters
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": {
    }
}

Update via Patch Operations

path Parameters
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
operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

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

Read

path Parameters
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": {
    }
}

Create with Server-Assigned ID

path Parameters
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": {
    }
}

Update

path Parameters
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": {
    }
}

Query by ID: query-all

path Parameters
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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Organization - Child Organizations v1.0

Delete

path Parameters
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": {
    }
}

Read

path Parameters
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 via Patch Operations

path Parameters
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
operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

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

Query by ID: query-all-ids

path Parameters
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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Create with Client-Assigned ID

path Parameters
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": {
    }
}

Query by ID: query-all

path Parameters
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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Update

path Parameters
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": {
    }
}

Create with Server-Assigned ID

path Parameters
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

path Parameters
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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Organization - Members v1.0

Update

path Parameters
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": {
    }
}

Create with Client-Assigned ID

path Parameters
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": {
    }
}

Query by ID: query-all-ids

path Parameters
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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Query by ID: query-all

path Parameters
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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Read

path Parameters
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": {
    }
}

Delete

path Parameters
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": {
    }
}

Create with Server-Assigned ID

path Parameters
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

path Parameters
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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Update via Patch Operations

path Parameters
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
operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

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

Organization - Owner v1.0

Delete

path Parameters
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

path Parameters
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
operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

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

Query by ID: query-all

path Parameters
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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Read

path Parameters
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

path Parameters
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": {
    }
}

Create with Server-Assigned ID

path Parameters
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

path Parameters
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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Query by ID: query-all-ids

path Parameters
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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Create with Client-Assigned ID

path Parameters
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": {
    }
}

Role v1.0

Delete

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",
  • "name": "string",
  • "description": "string",
  • "members": [
    ],
  • "assignments": [
    ],
  • "condition": "string",
  • "temporalConstraints": [
    ]
}

Query by Filter

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Action: triggerSyncCheck

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.

_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"
}

Query by ID: query-all-ids

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Create with Client-Assigned ID

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

name
required
string (Name)

The role name, used for display purposes.

description
string (Description)

The role description, used for display purposes.

Array of objects (Role Members)

Role Members

Array of objects (Managed Assignments)

Managed Assignments

condition
string (Condition)

A conditional filter for this role

Array of objects (Temporal Constraints)

An array of temporal constraints for a role

Responses

Request samples

Content type
{
  • "_id": "string",
  • "name": "string",
  • "description": "string",
  • "members": [
    ],
  • "assignments": [
    ],
  • "condition": "string",
  • "temporalConstraints": [
    ]
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "description": "string",
  • "members": [
    ],
  • "assignments": [
    ],
  • "condition": "string",
  • "temporalConstraints": [
    ]
}

Update via Patch Operations

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
operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "description": "string",
  • "members": [
    ],
  • "assignments": [
    ],
  • "condition": "string",
  • "temporalConstraints": [
    ]
}

Read

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",
  • "name": "string",
  • "description": "string",
  • "members": [
    ],
  • "assignments": [
    ],
  • "condition": "string",
  • "temporalConstraints": [
    ]
}

Create with Server-Assigned 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.

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

Role ID

name
required
string (Name)

The role name, used for display purposes.

description
string (Description)

The role description, used for display purposes.

Array of objects (Role Members)

Role Members

Array of objects (Managed Assignments)

Managed Assignments

condition
string (Condition)

A conditional filter for this role

Array of objects (Temporal Constraints)

An array of temporal constraints for a role

Responses

Request samples

Content type
{
  • "_id": "string",
  • "name": "string",
  • "description": "string",
  • "members": [
    ],
  • "assignments": [
    ],
  • "condition": "string",
  • "temporalConstraints": [
    ]
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "description": "string",
  • "members": [
    ],
  • "assignments": [
    ],
  • "condition": "string",
  • "temporalConstraints": [
    ]
}

Update

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

name
required
string (Name)

The role name, used for display purposes.

description
string (Description)

The role description, used for display purposes.

Array of objects (Role Members)

Role Members

Array of objects (Managed Assignments)

Managed Assignments

condition
string (Condition)

A conditional filter for this role

Array of objects (Temporal Constraints)

An array of temporal constraints for a role

Responses

Request samples

Content type
{
  • "_id": "string",
  • "name": "string",
  • "description": "string",
  • "members": [
    ],
  • "assignments": [
    ],
  • "condition": "string",
  • "temporalConstraints": [
    ]
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "description": "string",
  • "members": [
    ],
  • "assignments": [
    ],
  • "condition": "string",
  • "temporalConstraints": [
    ]
}

Query by ID: query-all

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Role - Managed Assignments v1.0

Delete

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": {
    }
}

Query by Filter

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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Query by ID: query-all

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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Create with Server-Assigned ID

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 (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": {
    }
}

Update

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 (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": {
    }
}

Create with Client-Assigned ID

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 (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": {
    }
}

Read

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": {
    }
}

Query by ID: query-all-ids

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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Update via Patch Operations

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
operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

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

Role - Role Members v1.0

Query by ID: query-all

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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Create with Client-Assigned ID

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 (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": {
    }
}

Update

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 (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 ID: query-all-ids

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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Query by Filter

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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Update via Patch Operations

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
operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

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

Create with Server-Assigned ID

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 (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": {
    }
}

Read

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": {
    }
}

Delete

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": {
    }
}

User v1.0

Action: triggerSyncCheck

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.

_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"
}

Read

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",
  • "userName": "string",
  • "password": "string",
  • "givenName": "string",
  • "sn": "string",
  • "mail": "string",
  • "description": "string",
  • "accountStatus": "active",
  • "telephoneNumber": "string",
  • "postalAddress": "string",
  • "city": "string",
  • "postalCode": "string",
  • "country": "string",
  • "stateProvince": "string",
  • "roles": [
    ],
  • "assignments": [
    ],
  • "manager": {
    },
  • "authzRoles": [
    ],
  • "reports": [
    ],
  • "effectiveRoles": [
    ],
  • "effectiveAssignments": [
    ],
  • "lastSync": {
    },
  • "kbaInfo": [
    ],
  • "preferences": {
    },
  • "consentedMappings": [
    ],
  • "ownerOfOrg": [
    ],
  • "adminOfOrg": [
    ],
  • "memberOfOrg": [
    ],
  • "memberOfOrgIDs": [
    ],
  • "activeDate": "string",
  • "inactiveDate": "string",
  • "cn": "string",
  • "aliasList": [
    ],
  • "tsgID": [
    ],
  • "_meta": {
    },
  • "_notifications": [
    ]
}

Update via Patch Operations

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
operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_id": "string",
  • "userName": "string",
  • "password": "string",
  • "givenName": "string",
  • "sn": "string",
  • "mail": "string",
  • "description": "string",
  • "accountStatus": "active",
  • "telephoneNumber": "string",
  • "postalAddress": "string",
  • "city": "string",
  • "postalCode": "string",
  • "country": "string",
  • "stateProvince": "string",
  • "roles": [
    ],
  • "assignments": [
    ],
  • "manager": {
    },
  • "authzRoles": [
    ],
  • "reports": [
    ],
  • "effectiveRoles": [
    ],
  • "effectiveAssignments": [
    ],
  • "lastSync": {
    },
  • "kbaInfo": [
    ],
  • "preferences": {
    },
  • "consentedMappings": [
    ],
  • "ownerOfOrg": [
    ],
  • "adminOfOrg": [
    ],
  • "memberOfOrg": [
    ],
  • "memberOfOrgIDs": [
    ],
  • "activeDate": "string",
  • "inactiveDate": "string",
  • "cn": "string",
  • "aliasList": [
    ],
  • "tsgID": [
    ],
  • "_meta": {
    },
  • "_notifications": [
    ]
}

Create with Client-Assigned ID

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

userName
required
string (Username)

Username

password
string (Password)

Password

givenName
required
string (First Name)

First Name

sn
required
string (Last Name)

Last Name

mail
required
string (Email Address)

Email Address

description
string (Description)

Description

accountStatus
string (Status)
Default: "active"

Status

telephoneNumber
string (Telephone Number) ^\+?([0-9\- \(\)])*$

Telephone Number

postalAddress
string (Address 1)

Address 1

city
string (City)

City

postalCode
string (Postal Code)

Postal Code

country
string (Country)

Country

stateProvince
string (State/Province)

State/Province

Array of objects (Provisioning Roles)

Provisioning Roles

Array of objects (Assignments)

Assignments

object (Manager)

Manager

Array of objects (Authorization Roles)

Authorization Roles

Array of objects (Direct Reports)

Direct Reports

effectiveRoles
Array of objects (Effective Roles)

Effective Roles

effectiveAssignments
Array of objects (Effective Assignments)

Effective Assignments

object (Last Sync timestamp)

Last Sync timestamp

Array of objects (KBA Info Items)

KBA Info

object (Preferences)

Preferences

Array of objects (Consented Mappings)

Consented Mappings

Array of objects (Organizations I Own)
Array of objects (Organizations I Administer)
Array of objects (Organizations to which I Belong)
memberOfOrgIDs
Array of strings (MemberOfOrgIDs)
activeDate
string <datetime> (Active Date)

Active Date

inactiveDate
string <datetime> (Inactive Date)

Inactive Date

cn
string (Common Name)

Common Name

aliasList
Array of strings (User Alias Names List)

List of identity aliases used primarily to record social IdP subjects for this user

tsgID
Array of strings (tsgID)
object (Metadata)

Metadata for internal/usermeta

Array of objects (Notifications)

Notifications

Responses

Request samples

Content type
{
  • "_id": "string",
  • "userName": "string",
  • "password": "string",
  • "givenName": "string",
  • "sn": "string",
  • "mail": "string",
  • "description": "string",
  • "accountStatus": "active",
  • "telephoneNumber": "string",
  • "postalAddress": "string",
  • "city": "string",
  • "postalCode": "string",
  • "country": "string",
  • "stateProvince": "string",
  • "roles": [
    ],
  • "assignments": [
    ],
  • "manager": {
    },
  • "authzRoles": [
    ],
  • "reports": [
    ],
  • "effectiveRoles": [
    ],
  • "effectiveAssignments": [
    ],
  • "lastSync": {
    },
  • "kbaInfo": [
    ],
  • "preferences": {
    },
  • "consentedMappings": [
    ],
  • "ownerOfOrg": [
    ],
  • "adminOfOrg": [
    ],
  • "memberOfOrg": [
    ],
  • "memberOfOrgIDs": [
    ],
  • "activeDate": "string",
  • "inactiveDate": "string",
  • "cn": "string",
  • "aliasList": [
    ],
  • "tsgID": [
    ],
  • "_meta": {
    },
  • "_notifications": [
    ]
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "userName": "string",
  • "password": "string",
  • "givenName": "string",
  • "sn": "string",
  • "mail": "string",
  • "description": "string",
  • "accountStatus": "active",
  • "telephoneNumber": "string",
  • "postalAddress": "string",
  • "city": "string",
  • "postalCode": "string",
  • "country": "string",
  • "stateProvince": "string",
  • "roles": [
    ],
  • "assignments": [
    ],
  • "manager": {
    },
  • "authzRoles": [
    ],
  • "reports": [
    ],
  • "effectiveRoles": [
    ],
  • "effectiveAssignments": [
    ],
  • "lastSync": {
    },
  • "kbaInfo": [
    ],
  • "preferences": {
    },
  • "consentedMappings": [
    ],
  • "ownerOfOrg": [
    ],
  • "adminOfOrg": [
    ],
  • "memberOfOrg": [
    ],
  • "memberOfOrgIDs": [
    ],
  • "activeDate": "string",
  • "inactiveDate": "string",
  • "cn": "string",
  • "aliasList": [
    ],
  • "tsgID": [
    ],
  • "_meta": {
    },
  • "_notifications": [
    ]
}

Update

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

userName
required
string (Username)

Username

password
string (Password)

Password

givenName
required
string (First Name)

First Name

sn
required
string (Last Name)

Last Name

mail
required
string (Email Address)

Email Address

description
string (Description)

Description

accountStatus
string (Status)
Default: "active"

Status

telephoneNumber
string (Telephone Number) ^\+?([0-9\- \(\)])*$

Telephone Number

postalAddress
string (Address 1)

Address 1

city
string (City)

City

postalCode
string (Postal Code)

Postal Code

country
string (Country)

Country

stateProvince
string (State/Province)

State/Province

Array of objects (Provisioning Roles)

Provisioning Roles

Array of objects (Assignments)

Assignments

object (Manager)

Manager

Array of objects (Authorization Roles)

Authorization Roles

Array of objects (Direct Reports)

Direct Reports

effectiveRoles
Array of objects (Effective Roles)

Effective Roles

effectiveAssignments
Array of objects (Effective Assignments)

Effective Assignments

object (Last Sync timestamp)

Last Sync timestamp

Array of objects (KBA Info Items)

KBA Info

object (Preferences)

Preferences

Array of objects (Consented Mappings)

Consented Mappings

Array of objects (Organizations I Own)
Array of objects (Organizations I Administer)
Array of objects (Organizations to which I Belong)
memberOfOrgIDs
Array of strings (MemberOfOrgIDs)
activeDate
string <datetime> (Active Date)

Active Date

inactiveDate
string <datetime> (Inactive Date)

Inactive Date

cn
string (Common Name)

Common Name

aliasList
Array of strings (User Alias Names List)

List of identity aliases used primarily to record social IdP subjects for this user

tsgID
Array of strings (tsgID)
object (Metadata)

Metadata for internal/usermeta

Array of objects (Notifications)

Notifications

Responses

Request samples

Content type
{
  • "_id": "string",
  • "userName": "string",
  • "password": "string",
  • "givenName": "string",
  • "sn": "string",
  • "mail": "string",
  • "description": "string",
  • "accountStatus": "active",
  • "telephoneNumber": "string",
  • "postalAddress": "string",
  • "city": "string",
  • "postalCode": "string",
  • "country": "string",
  • "stateProvince": "string",
  • "roles": [
    ],
  • "assignments": [
    ],
  • "manager": {
    },
  • "authzRoles": [
    ],
  • "reports": [
    ],
  • "effectiveRoles": [
    ],
  • "effectiveAssignments": [
    ],
  • "lastSync": {
    },
  • "kbaInfo": [
    ],
  • "preferences": {
    },
  • "consentedMappings": [
    ],
  • "ownerOfOrg": [
    ],
  • "adminOfOrg": [
    ],
  • "memberOfOrg": [
    ],
  • "memberOfOrgIDs": [
    ],
  • "activeDate": "string",
  • "inactiveDate": "string",
  • "cn": "string",
  • "aliasList": [
    ],
  • "tsgID": [
    ],
  • "_meta": {
    },
  • "_notifications": [
    ]
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "userName": "string",
  • "password": "string",
  • "givenName": "string",
  • "sn": "string",
  • "mail": "string",
  • "description": "string",
  • "accountStatus": "active",
  • "telephoneNumber": "string",
  • "postalAddress": "string",
  • "city": "string",
  • "postalCode": "string",
  • "country": "string",
  • "stateProvince": "string",
  • "roles": [
    ],
  • "assignments": [
    ],
  • "manager": {
    },
  • "authzRoles": [
    ],
  • "reports": [
    ],
  • "effectiveRoles": [
    ],
  • "effectiveAssignments": [
    ],
  • "lastSync": {
    },
  • "kbaInfo": [
    ],
  • "preferences": {
    },
  • "consentedMappings": [
    ],
  • "ownerOfOrg": [
    ],
  • "adminOfOrg": [
    ],
  • "memberOfOrg": [
    ],
  • "memberOfOrgIDs": [
    ],
  • "activeDate": "string",
  • "inactiveDate": "string",
  • "cn": "string",
  • "aliasList": [
    ],
  • "tsgID": [
    ],
  • "_meta": {
    },
  • "_notifications": [
    ]
}

Query by ID: query-all

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Create with Server-Assigned 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.

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

User ID

userName
required
string (Username)

Username

password
string (Password)

Password

givenName
required
string (First Name)

First Name

sn
required
string (Last Name)

Last Name

mail
required
string (Email Address)

Email Address

description
string (Description)

Description

accountStatus
string (Status)
Default: "active"

Status

telephoneNumber
string (Telephone Number) ^\+?([0-9\- \(\)])*$

Telephone Number

postalAddress
string (Address 1)

Address 1

city
string (City)

City

postalCode
string (Postal Code)

Postal Code

country
string (Country)

Country

stateProvince
string (State/Province)

State/Province

Array of objects (Provisioning Roles)

Provisioning Roles

Array of objects (Assignments)

Assignments

object (Manager)

Manager

Array of objects (Authorization Roles)

Authorization Roles

Array of objects (Direct Reports)

Direct Reports

effectiveRoles
Array of objects (Effective Roles)

Effective Roles

effectiveAssignments
Array of objects (Effective Assignments)

Effective Assignments

object (Last Sync timestamp)

Last Sync timestamp

Array of objects (KBA Info Items)

KBA Info

object (Preferences)

Preferences

Array of objects (Consented Mappings)

Consented Mappings

Array of objects (Organizations I Own)
Array of objects (Organizations I Administer)
Array of objects (Organizations to which I Belong)
memberOfOrgIDs
Array of strings (MemberOfOrgIDs)
activeDate
string <datetime> (Active Date)

Active Date

inactiveDate
string <datetime> (Inactive Date)

Inactive Date

cn
string (Common Name)

Common Name

aliasList
Array of strings (User Alias Names List)

List of identity aliases used primarily to record social IdP subjects for this user

tsgID
Array of strings (tsgID)
object (Metadata)

Metadata for internal/usermeta

Array of objects (Notifications)

Notifications

Responses

Request samples

Content type
{
  • "_id": "string",
  • "userName": "string",
  • "password": "string",
  • "givenName": "string",
  • "sn": "string",
  • "mail": "string",
  • "description": "string",
  • "accountStatus": "active",
  • "telephoneNumber": "string",
  • "postalAddress": "string",
  • "city": "string",
  • "postalCode": "string",
  • "country": "string",
  • "stateProvince": "string",
  • "roles": [
    ],
  • "assignments": [
    ],
  • "manager": {
    },
  • "authzRoles": [
    ],
  • "reports": [
    ],
  • "effectiveRoles": [
    ],
  • "effectiveAssignments": [
    ],
  • "lastSync": {
    },
  • "kbaInfo": [
    ],
  • "preferences": {
    },
  • "consentedMappings": [
    ],
  • "ownerOfOrg": [
    ],
  • "adminOfOrg": [
    ],
  • "memberOfOrg": [
    ],
  • "memberOfOrgIDs": [
    ],
  • "activeDate": "string",
  • "inactiveDate": "string",
  • "cn": "string",
  • "aliasList": [
    ],
  • "tsgID": [
    ],
  • "_meta": {
    },
  • "_notifications": [
    ]
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "userName": "string",
  • "password": "string",
  • "givenName": "string",
  • "sn": "string",
  • "mail": "string",
  • "description": "string",
  • "accountStatus": "active",
  • "telephoneNumber": "string",
  • "postalAddress": "string",
  • "city": "string",
  • "postalCode": "string",
  • "country": "string",
  • "stateProvince": "string",
  • "roles": [
    ],
  • "assignments": [
    ],
  • "manager": {
    },
  • "authzRoles": [
    ],
  • "reports": [
    ],
  • "effectiveRoles": [
    ],
  • "effectiveAssignments": [
    ],
  • "lastSync": {
    },
  • "kbaInfo": [
    ],
  • "preferences": {
    },
  • "consentedMappings": [
    ],
  • "ownerOfOrg": [
    ],
  • "adminOfOrg": [
    ],
  • "memberOfOrg": [
    ],
  • "memberOfOrgIDs": [
    ],
  • "activeDate": "string",
  • "inactiveDate": "string",
  • "cn": "string",
  • "aliasList": [
    ],
  • "tsgID": [
    ],
  • "_meta": {
    },
  • "_notifications": [
    ]
}

Query by ID: query-all-ids

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Delete

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",
  • "userName": "string",
  • "password": "string",
  • "givenName": "string",
  • "sn": "string",
  • "mail": "string",
  • "description": "string",
  • "accountStatus": "active",
  • "telephoneNumber": "string",
  • "postalAddress": "string",
  • "city": "string",
  • "postalCode": "string",
  • "country": "string",
  • "stateProvince": "string",
  • "roles": [
    ],
  • "assignments": [
    ],
  • "manager": {
    },
  • "authzRoles": [
    ],
  • "reports": [
    ],
  • "effectiveRoles": [
    ],
  • "effectiveAssignments": [
    ],
  • "lastSync": {
    },
  • "kbaInfo": [
    ],
  • "preferences": {
    },
  • "consentedMappings": [
    ],
  • "ownerOfOrg": [
    ],
  • "adminOfOrg": [
    ],
  • "memberOfOrg": [
    ],
  • "memberOfOrgIDs": [
    ],
  • "activeDate": "string",
  • "inactiveDate": "string",
  • "cn": "string",
  • "aliasList": [
    ],
  • "tsgID": [
    ],
  • "_meta": {
    },
  • "_notifications": [
    ]
}

Query by Filter

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

User - Notifications v1.0

Delete

path Parameters
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": {
    }
}

Query by Filter

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.

_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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Create with Client-Assigned ID

path Parameters
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": {
    }
}

Read

path Parameters
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": {
    }
}

Query by ID: query-all

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.

_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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Update

path Parameters
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": {
    }
}

Update via Patch Operations

path Parameters
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
operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

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

Query by ID: query-all-ids

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.

_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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Create with Server-Assigned ID

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
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": {
    }
}

User - Organizations I Administer v1.0

Delete

path Parameters
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": {
    }
}

Query by ID: query-all-ids

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.

_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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Create with Client-Assigned ID

path Parameters
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": {
    }
}

Create with Server-Assigned ID

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
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

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.

_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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Update via Patch Operations

path Parameters
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
operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

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

Query by ID: query-all

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.

_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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Update

path Parameters
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": {
    }
}

Read

path Parameters
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": {
    }
}

User - Assignments v1.0

Delete

path Parameters
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": {
    }
}

Read

path Parameters
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": {
    }
}

Query by ID: query-all

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.

_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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Update via Patch Operations

path Parameters
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
operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

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

Create with Server-Assigned ID

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
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": {
    }
}

Create with Client-Assigned ID

path Parameters
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": {
    }
}

Query by Filter

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.

_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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Update

path Parameters
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": {
    }
}

Query by ID: query-all-ids

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.

_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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

User - Authorization Roles v1.0

Query by ID: query-all

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.

_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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Create with Server-Assigned ID

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
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

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.

_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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Query by ID: query-all-ids

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.

_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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Delete

path Parameters
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": {
    }
}

Read

path Parameters
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": {
    }
}

Create with Client-Assigned ID

path Parameters
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": {
    }
}

Update

path Parameters
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": {
    }
}

Update via Patch Operations

path Parameters
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
operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

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

User - Organizations to which I Belong v1.0

Query by ID: query-all-ids

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.

_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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Update

path Parameters
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": {
    }
}

Delete

path Parameters
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": {
    }
}

Read

path Parameters
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": {
    }
}

Query by ID: query-all

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.

_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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Create with Server-Assigned ID

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
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": {
    }
}

Update via Patch Operations

path Parameters
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
operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

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

Query by Filter

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.

_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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Create with Client-Assigned ID

path Parameters
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": {
    }
}

User - Organizations I Own v1.0

Query by Filter

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.

_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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Delete

path Parameters
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": {
    }
}

Query by ID: query-all

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.

_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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Update

path Parameters
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": {
    }
}

Read

path Parameters
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 via Patch Operations

path Parameters
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
operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

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

Create with Server-Assigned ID

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
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": {
    }
}

Create with Client-Assigned ID

path Parameters
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": {
    }
}

Query by ID: query-all-ids

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.

_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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

User - Direct Reports v1.0

Read

path Parameters
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

path Parameters
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": {
    }
}

Query by Filter

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.

_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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Update via Patch Operations

path Parameters
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
operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

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

Delete

path Parameters
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": {
    }
}

Query by ID: query-all-ids

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.

_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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Query by ID: query-all

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.

_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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Create with Client-Assigned ID

path Parameters
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": {
    }
}

Create with Server-Assigned ID

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
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": {
    }
}

User - Provisioning Roles v1.0

Query by Filter

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.

_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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Create with Client-Assigned ID

path Parameters
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": {
    }
}

Update

path Parameters
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": {
    }
}

Query by ID: query-all

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.

_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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Delete

path Parameters
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

path Parameters
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
operation
string
Enum: "add" "copy" "increment" "move" "remove" "replace" "transform"

Operation to perform on the field

field
string

Target JSON Pointer of field to patch

from
string

Source JSON Pointer used with copy and move operations

value
string

Value to apply

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

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

Read

path Parameters
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": {
    }
}

Query by ID: query-all-ids

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.

_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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Create with Server-Assigned ID

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
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": {
    }
}

Notification v1.0

Action: notifyByQueryFilter

Creates a notification for each resource that matches a query filter.

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
required
object (Notification Target Object)

Relationship that defines the intended target of the notification

createDate
required
string

Date the notification was created

notificationType
required
string

Type of notification (see info/uiconfig for types of notifications)

message
required
string

Notification content

_id
required
string

Notification identifier

Responses

Request samples

Content type
{
  • "target": {
    },
  • "createDate": "string",
  • "notificationType": "string",
  • "message": "string",
  • "_id": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Action: deleteNotificationsForTarget

Deletes all notifications tied to the specified target

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
[
  • {
    }
]

Policies v1.0

Read

List policies for Organization objects.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "resource": "string",
  • "properties": [
    ]
}

Action: validateProperty

Verifies that a given property adheres to policy requirements.

path Parameters
nullId
required
string

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
object (Key/Value Pairs)

Responses

Request samples

Content type
{ }

Response samples

Content type
application/json
{
  • "result": true,
  • "failedPolicyRequirements": [
    ]
}

Action: validateObject

Validates a given Role object against its policy requirements.

path Parameters
nullId
required
string

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

name
required
string (Name)

The role name, used for display purposes.

description
string (Description)

The role description, used for display purposes.

Array of objects (Role Members)

Role Members

Array of objects (Managed Assignments)

Managed Assignments

condition
string (Condition)

A conditional filter for this role

Array of objects (Temporal Constraints)

An array of temporal constraints for a role

Responses

Request samples

Content type
{
  • "_id": "string",
  • "name": "string",
  • "description": "string",
  • "members": [
    ],
  • "assignments": [
    ],
  • "condition": "string",
  • "temporalConstraints": [
    ]
}

Response samples

Content type
application/json
{
  • "result": true,
  • "failedPolicyRequirements": [
    ]
}

Action: validateObject

Validates a given Assignment object against its policy requirements.

path Parameters
nullId
required
string

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

name
required
string (Name)

The assignment name, used for display purposes.

description
required
string (Description)

The assignment description, used for display purposes.

mapping
required
string (Mapping)

The name of the mapping this assignment applies to

Array of objects (Assignment Attributes)

The attributes operated on by this assignment.

linkQualifiers
Array of strings (Link Qualifiers)

Conditional link qualifiers to restrict this assignment to.

Array of objects (Managed Roles)

Managed Roles

Array of objects (Assignment Members)

Assignment Members

condition
string (Condition)

A conditional filter for this assignment

weight
number <double> (Weight)

The weight of the assignment.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "result": true,
  • "failedPolicyRequirements": [
    ]
}

Action: validateProperty

Verifies that a given property adheres to policy requirements.

path Parameters
nullId
required
string

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
object (Key/Value Pairs)

Responses

Request samples

Content type
{ }

Response samples

Content type
application/json
{
  • "result": true,
  • "failedPolicyRequirements": [
    ]
}

Read

List policies for Assignment objects.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "resource": "string",
  • "properties": [
    ]
}

Action: validateObject

Validates a given Organization object against its policy requirements.

path Parameters
nullId
required
string

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
name
required
string (Name)
description
string (Description)
Array of objects (Owner)
Array of objects (Administrators)
Array of objects (Members)
object (Parent Organization)

Parent Organization

Array of objects (Child Organizations)

Child Organizations

adminIDs
Array of strings (Admin user ids)
ownerIDs
Array of strings (Owner user ids)
parentAdminIDs
Array of strings (user ids of parent admins)
parentOwnerIDs
Array of strings (user ids of parent owners)
parentIDs
Array of strings (parent org ids)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "result": true,
  • "failedPolicyRequirements": [
    ]
}

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.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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": [
    ]
}

Action: validateProperty

Verifies that a given property adheres to policy requirements.

path Parameters
nullId
required
string

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
object (Key/Value Pairs)

Responses

Request samples

Content type
{ }

Response samples

Content type
application/json
{
  • "result": true,
  • "failedPolicyRequirements": [
    ]
}

Action: validateObject

Validates a given User object against its policy requirements.

path Parameters
nullId
required
string

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

userName
required
string (Username)

Username

password
string (Password)

Password

givenName
required
string (First Name)

First Name

sn
required
string (Last Name)

Last Name

mail
required
string (Email Address)

Email Address

description
string (Description)

Description

accountStatus
string (Status)
Default: "active"

Status

telephoneNumber
string (Telephone Number) ^\+?([0-9\- \(\)])*$

Telephone Number

postalAddress
string (Address 1)

Address 1

city
string (City)

City

postalCode
string (Postal Code)

Postal Code

country
string (Country)

Country

stateProvince
string (State/Province)

State/Province

Array of objects (Provisioning Roles)

Provisioning Roles

Array of objects (Assignments)

Assignments

object (Manager)

Manager

Array of objects (Authorization Roles)

Authorization Roles

Array of objects (Direct Reports)

Direct Reports

effectiveRoles
Array of objects (Effective Roles)

Effective Roles

effectiveAssignments
Array of objects (Effective Assignments)

Effective Assignments

object (Last Sync timestamp)

Last Sync timestamp

Array of objects (KBA Info Items)

KBA Info

object (Preferences)

Preferences

Array of objects (Consented Mappings)

Consented Mappings

Array of objects (Organizations I Own)
Array of objects (Organizations I Administer)
Array of objects (Organizations to which I Belong)
memberOfOrgIDs
Array of strings (MemberOfOrgIDs)
activeDate
string <datetime> (Active Date)

Active Date

inactiveDate
string <datetime> (Inactive Date)

Inactive Date

cn
string (Common Name)

Common Name

aliasList
Array of strings (User Alias Names List)

List of identity aliases used primarily to record social IdP subjects for this user

tsgID
Array of strings (tsgID)
object (Metadata)

Metadata for internal/usermeta

Array of objects (Notifications)

Notifications

Responses

Request samples

Content type
{
  • "_id": "string",
  • "userName": "string",
  • "password": "string",
  • "givenName": "string",
  • "sn": "string",
  • "mail": "string",
  • "description": "string",
  • "accountStatus": "active",
  • "telephoneNumber": "string",
  • "postalAddress": "string",
  • "city": "string",
  • "postalCode": "string",
  • "country": "string",
  • "stateProvince": "string",
  • "roles": [
    ],
  • "assignments": [
    ],
  • "manager": {
    },
  • "authzRoles": [
    ],
  • "reports": [
    ],
  • "effectiveRoles": [
    ],
  • "effectiveAssignments": [
    ],
  • "lastSync": {
    },
  • "kbaInfo": [
    ],
  • "preferences": {
    },
  • "consentedMappings": [
    ],
  • "ownerOfOrg": [
    ],
  • "adminOfOrg": [
    ],
  • "memberOfOrg": [
    ],
  • "memberOfOrgIDs": [
    ],
  • "activeDate": "string",
  • "inactiveDate": "string",
  • "cn": "string",
  • "aliasList": [
    ],
  • "tsgID": [
    ],
  • "_meta": {
    },
  • "_notifications": [
    ]
}

Response samples

Content type
application/json
{
  • "result": true,
  • "failedPolicyRequirements": [
    ]
}

Read

List policies for Role objects.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "resource": "string",
  • "properties": [
    ]
}

Action: validateProperty

Verifies that a given property adheres to policy requirements.

path Parameters
nullId
required
string

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
object (Key/Value Pairs)

Responses

Request samples

Content type
{ }

Response samples

Content type
application/json
{
  • "result": true,
  • "failedPolicyRequirements": [
    ]
}

Read

List policies for User objects.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "resource": "string",
  • "properties": [
    ]
}

Privilege v1.0

Read

Obtain permission privileges for a specified Role object.

path Parameters
roleId
required
string

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
{
  • "VIEW": {
    },
  • "CREATE": {
    },
  • "UPDATE": {
    },
  • "DELETE": {
    },
  • "ACTION": {
    }
}

Read

Obtain permission privileges for Role objects.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "VIEW": {
    },
  • "CREATE": {
    },
  • "UPDATE": {
    },
  • "DELETE": {
    },
  • "ACTION": {
    }
}

Read

Obtain permission privileges for a specified User object.

path Parameters
userId
required
string

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
{
  • "VIEW": {
    },
  • "CREATE": {
    },
  • "UPDATE": {
    },
  • "DELETE": {
    },
  • "ACTION": {
    }
}

Read

Obtain permission privileges for User objects.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "VIEW": {
    },
  • "CREATE": {
    },
  • "UPDATE": {
    },
  • "DELETE": {
    },
  • "ACTION": {
    }
}

Read

Obtain permission privileges for a specified Assignment object.

path Parameters
assignmentId
required
string

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
{
  • "VIEW": {
    },
  • "CREATE": {
    },
  • "UPDATE": {
    },
  • "DELETE": {
    },
  • "ACTION": {
    }
}

Action: listPrivileges

List privilege details for the requester.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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 Assignment objects.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "VIEW": {
    },
  • "CREATE": {
    },
  • "UPDATE": {
    },
  • "DELETE": {
    },
  • "ACTION": {
    }
}

Read

Obtain permission privileges for a specified Organization object.

path Parameters
organizationId
required
string

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
{
  • "VIEW": {
    },
  • "CREATE": {
    },
  • "UPDATE": {
    },
  • "DELETE": {
    },
  • "ACTION": {
    }
}

Read

Obtain permission privileges for Organization objects.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "VIEW": {
    },
  • "CREATE": {
    },
  • "UPDATE": {
    },
  • "DELETE": {
    },
  • "ACTION": {
    }
}

SelfService - Profile Completeness v1.0

Read

Returns the profile completeness score for the object specified by the remainder of the resource path.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "completeness": 0.1,
  • "_id": "string",
  • "_rev": "string"
}

SelfService - Profile Create Date v1.0

Read

Returns the create date for the object specified by the remainder of the resource path.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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",
  • "_id": "string",
  • "_rev": "string"
}

SelfService - Profile Login Count v1.0

Read

Returns the login count for the resource specified by the remainder of the resource path.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "loginCount": 0,
  • "_id": "string",
  • "_rev": "string"
}

Action: increment

Increments the login count of the resource specified specified by the remainder of the resource path.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "loginCount": 0,
  • "_id": "string",
  • "_rev": "string"
}

SelfService - Profile Terms Accepted v1.0

Update

Updates the terms and conditions for the resource specified by the remainder of the resource path.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should 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
required
object (Terms Accepted)

The terms and conditions acceptance details of the object in question

_id
required
string

The full resource path of the object in question

_rev
required
string

The revision of the object in question

Responses

Request samples

Content type
{
  • "termsAccepted": {
    },
  • "_id": "string",
  • "_rev": "string"
}

Response samples

Content type
application/json
{
  • "termsAccepted": {
    },
  • "_id": "string",
  • "_rev": "string"
}

Read

Returns the terms and conditions for the resource specified by the remainder of the resource path.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "termsAccepted": {
    },
  • "_id": "string",
  • "_rev": "string"
}

Reconciliation v1.0

Action: reconById

Recon for a single source identifier.

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
{
  • "state": "ACTIVE",
  • "_id": "string"
}

Read

Lists all reconciliation summaries.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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: recon

Recon all available source identifiers.

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
{
  • "state": "ACTIVE",
  • "_id": "string"
}

Action: cancel

Cancels a running reconciliation

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
{
  • "action": "string",
  • "status": "string",
  • "_id": "string"
}

Action: markCanceled

Forcibly marks a reconciliation as canceled.

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
{
  • "action": "string",
  • "status": "string",
  • "message": "string",
  • "_id": "string"
}

Read

Read an individual reconciliation summary.

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
{
  • "mapping": "string",
  • "state": "ACTIVE",
  • "stage": "ACTIVE_INITIALIZED",
  • "stageDescription": "string",
  • "progress": {
    },
  • "situationSummary": { },
  • "statusSummary": { },
  • "durationSummary": { },
  • "parameters": { },
  • "started": "2019-08-24T14:15:22Z",
  • "ended": "2019-08-24T14:15:22Z",
  • "duration": 0,
  • "_id": "string"
}

Reconciliation Association Header v1.0

Query by Filter

Queries recons for which association state is available.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Read

Reads a recon association header, identified by recon id.

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
{
  • "mapping": "string",
  • "sourceResourceCollection": "string",
  • "targetResourceCollection": "string",
  • "finishTime": "string",
  • "_id": "string",
  • "_rev": "string"
}

Reconciliation Association Entry v1.0

Read

Reads a recon association entry.

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
{
  • "reconId": "string",
  • "situation": "string",
  • "action": "string",
  • "phase": "string",
  • "linkQualifier": "string",
  • "sourceObjectId": "string",
  • "targetObjectId": "string",
  • "status": "string",
  • "exception": "string",
  • "message": "string",
  • "messageDetail": {
    },
  • "_id": "string",
  • "_rev": "string"
}

Query by Filter

Queries recon association status.

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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Scheduler Acquired Triggers v1.0

Read Deprecated

Returns an array of the triggers that have been acquired, per node. Querying the scheduler/trigger endpoint directly by nodeId and state is the preferred means of obtaining a list of acquired triggers.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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",
  • "additionalProperties": [
    ]
}

Scheduler Job v1.0

Action: resumeJobs

Resumes all suspended scheduled jobs.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
}

Read

Obtains the details of the specified schedule.

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,
  • "persisted": false,
  • "recoverable": false,
  • "concurrentExecution": false,
  • "misfirePolicy": "doNothing",
  • "type": "cron",
  • "schedule": "string",
  • "repeatInterval": 0,
  • "repeatCount": -1,
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "invokeService": "string",
  • "invokeContext": { },
  • "invokeLogLevel": "ERROR",
  • "nextRunDate": "2019-08-24T14:15:22Z",
  • "triggers": [
    ],
  • "_id": "string"
}

Action: listCurrentlyExecutingJobs

Returns a list of the jobs that are currently running.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
[
  • {
    }
]

Create with Client-Assigned ID

Creates or updates a schedule with the specified ID.

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
enabled
boolean
Default: true

Enable this job schedule

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

concurrentExecution
boolean
Default: false

Reschedule the job even when a previous run is still executing

misfirePolicy
string
Default: "fireAndProceed"
Enum: "doNothing" "fireAndProceed"

Misfire handling policy

type
string
Default: "cron"
Enum: "cron" "simple"

Schedule type

schedule
string

Cron expression to use for schedule type 'cron'

repeatInterval
integer <int64> >= 0
Default: 0

Repeat interval, in milliseconds, for schedule type 'simple'

repeatCount
integer <int32> >= -1
Default: -1

Repeat count for schedule type 'simple' (-1 to repeat indefinitely)

startTime
string <date-time>

Start time for job in ISO 8601 date-time format

endTime
string <date-time>

End time for job in ISO 8601 date-time format

invokeService
required
string

Service PID of the service to be invoked. If no '.' is included, it is prefixed with 'org.forgerock.openidm.'

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

nextRunDate
string <date-time>

Next run date 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

_id
string

Job instance ID

Responses

Request samples

Content type
{
  • "enabled": true,
  • "persisted": false,
  • "recoverable": false,
  • "concurrentExecution": false,
  • "misfirePolicy": "doNothing",
  • "type": "cron",
  • "schedule": "string",
  • "repeatInterval": 0,
  • "repeatCount": -1,
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "invokeService": "string",
  • "invokeContext": { },
  • "invokeLogLevel": "ERROR",
  • "nextRunDate": "2019-08-24T14:15:22Z",
  • "triggers": [
    ],
  • "_id": "string"
}

Response samples

Content type
application/json
{
  • "enabled": true,
  • "persisted": false,
  • "recoverable": false,
  • "concurrentExecution": false,
  • "misfirePolicy": "doNothing",
  • "type": "cron",
  • "schedule": "string",
  • "repeatInterval": 0,
  • "repeatCount": -1,
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "invokeService": "string",
  • "invokeContext": { },
  • "invokeLogLevel": "ERROR",
  • "nextRunDate": "2019-08-24T14:15:22Z",
  • "triggers": [
    ],
  • "_id": "string"
}

Update

Update the job schedule.

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
enabled
boolean
Default: true

Enable this job schedule

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

concurrentExecution
boolean
Default: false

Reschedule the job even when a previous run is still executing

misfirePolicy
string
Default: "fireAndProceed"
Enum: "doNothing" "fireAndProceed"

Misfire handling policy

type
string
Default: "cron"
Enum: "cron" "simple"

Schedule type

schedule
string

Cron expression to use for schedule type 'cron'

repeatInterval
integer <int64> >= 0
Default: 0

Repeat interval, in milliseconds, for schedule type 'simple'

repeatCount
integer <int32> >= -1
Default: -1

Repeat count for schedule type 'simple' (-1 to repeat indefinitely)

startTime
string <date-time>

Start time for job in ISO 8601 date-time format

endTime
string <date-time>

End time for job in ISO 8601 date-time format

invokeService
required
string

Service PID of the service to be invoked. If no '.' is included, it is prefixed with 'org.forgerock.openidm.'

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

nextRunDate
string <date-time>

Next run date 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

_id
string

Job instance ID

Responses

Request samples

Content type
{
  • "enabled": true,
  • "persisted": false,
  • "recoverable": false,
  • "concurrentExecution": false,
  • "misfirePolicy": "doNothing",
  • "type": "cron",
  • "schedule": "string",
  • "repeatInterval": 0,
  • "repeatCount": -1,
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "invokeService": "string",
  • "invokeContext": { },
  • "invokeLogLevel": "ERROR",
  • "nextRunDate": "2019-08-24T14:15:22Z",
  • "triggers": [
    ],
  • "_id": "string"
}

Response samples

Content type
application/json
{
  • "enabled": true,
  • "persisted": false,
  • "recoverable": false,
  • "concurrentExecution": false,
  • "misfirePolicy": "doNothing",
  • "type": "cron",
  • "schedule": "string",
  • "repeatInterval": 0,
  • "repeatCount": -1,
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "invokeService": "string",
  • "invokeContext": { },
  • "invokeLogLevel": "ERROR",
  • "nextRunDate": "2019-08-24T14:15:22Z",
  • "triggers": [
    ],
  • "_id": "string"
}

Action: pauseJobs

Suspends all scheduled jobs.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
}

Query by Filter

Queries the existing defined schedules.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Action: create

Creates a schedule with a system-generated 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: "create"
header Parameters
Accept-API-Version
required
string
Value: "resource=1.0"
Request Body schema:
required
enabled
boolean
Default: true

Enable this job schedule

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

concurrentExecution
boolean
Default: false

Reschedule the job even when a previous run is still executing

misfirePolicy
string
Default: "fireAndProceed"
Enum: "doNothing" "fireAndProceed"

Misfire handling policy

type
string
Default: "cron"
Enum: "cron" "simple"

Schedule type

schedule
string

Cron expression to use for schedule type 'cron'

repeatInterval
integer <int64> >= 0
Default: 0

Repeat interval, in milliseconds, for schedule type 'simple'

repeatCount
integer <int32> >= -1
Default: -1

Repeat count for schedule type 'simple' (-1 to repeat indefinitely)

startTime
string <date-time>

Start time for job in ISO 8601 date-time format

endTime
string <date-time>

End time for job in ISO 8601 date-time format

invokeService
required
string

Service PID of the service to be invoked. If no '.' is included, it is prefixed with 'org.forgerock.openidm.'

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

Responses

Request samples

Content type
{
  • "enabled": true,
  • "persisted": false,
  • "recoverable": false,
  • "concurrentExecution": false,
  • "misfirePolicy": "doNothing",
  • "type": "cron",
  • "schedule": "string",
  • "repeatInterval": 0,
  • "repeatCount": -1,
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "invokeService": "string",
  • "invokeContext": { },
  • "invokeLogLevel": "ERROR"
}

Response samples

Content type
application/json
{
  • "enabled": true,
  • "persisted": false,
  • "recoverable": false,
  • "concurrentExecution": false,
  • "misfirePolicy": "doNothing",
  • "type": "cron",
  • "schedule": "string",
  • "repeatInterval": 0,
  • "repeatCount": -1,
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "invokeService": "string",
  • "invokeContext": { },
  • "invokeLogLevel": "ERROR",
  • "nextRunDate": "2019-08-24T14:15:22Z",
  • "triggers": [
    ],
  • "_id": "string"
}

Delete

Deletes the specified schedule.

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
{
  • "enabled": true,
  • "persisted": false,
  • "recoverable": false,
  • "concurrentExecution": false,
  • "misfirePolicy": "doNothing",
  • "type": "cron",
  • "schedule": "string",
  • "repeatInterval": 0,
  • "repeatCount": -1,
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "invokeService": "string",
  • "invokeContext": { },
  • "invokeLogLevel": "ERROR",
  • "nextRunDate": "2019-08-24T14:15:22Z",
  • "triggers": [
    ],
  • "_id": "string"
}

Scheduler Job v2.0

Action: create

Creates a schedule with a system-generated 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: "create"
header Parameters
Accept-API-Version
required
string
Value: "resource=2.0"
Request Body schema:
required
enabled
boolean
Default: true

Enable this job schedule

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

concurrentExecution
boolean
Default: false

Reschedule the job even when a previous run is still executing

misfirePolicy
string
Default: "fireAndProceed"
Enum: "doNothing" "fireAndProceed"

Misfire handling policy

type
string
Default: "cron"
Enum: "cron" "simple"

Schedule type

schedule
string

Cron expression to use for schedule type 'cron'

repeatInterval
integer <int64> >= 0
Default: 0

Repeat interval, in milliseconds, for schedule type 'simple'

repeatCount
integer <int32> >= -1
Default: -1

Repeat count for schedule type 'simple' (-1 to repeat indefinitely)

startTime
string <date-time>

Start time for job in ISO 8601 date-time format

endTime
string <date-time>

End time for job in ISO 8601 date-time format

invokeService
required
string

Service PID of the service to be invoked. If no '.' is included, it is prefixed with 'org.forgerock.openidm.'

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

Responses

Request samples

Content type
{
  • "enabled": true,
  • "persisted": false,
  • "recoverable": false,
  • "concurrentExecution": false,
  • "misfirePolicy": "doNothing",
  • "type": "cron",
  • "schedule": "string",
  • "repeatInterval": 0,
  • "repeatCount": -1,
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "invokeService": "string",
  • "invokeContext": { },
  • "invokeLogLevel": "ERROR"
}

Response samples

Content type
application/json
{
  • "enabled": true,
  • "persisted": false,
  • "recoverable": false,
  • "concurrentExecution": false,
  • "misfirePolicy": "doNothing",
  • "type": "cron",
  • "schedule": "string",
  • "repeatInterval": 0,
  • "repeatCount": -1,
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "invokeService": "string",
  • "invokeContext": { },
  • "invokeLogLevel": "ERROR",
  • "nextRunDate": "2019-08-24T14:15:22Z",
  • "previousRunDate": "2019-08-24T14:15:22Z",
  • "triggers": [
    ],
  • "_id": "string"
}

Action: listCurrentlyExecutingJobs

Returns a list of the jobs that are currently running.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
[
  • {
    }
]

Create with Client-Assigned ID

Creates or updates a schedule with the specified ID.

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
enabled
boolean
Default: true

Enable this job schedule

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

concurrentExecution
boolean
Default: false

Reschedule the job even when a previous run is still executing

misfirePolicy
string
Default: "fireAndProceed"
Enum: "doNothing" "fireAndProceed"

Misfire handling policy

type
string
Default: "cron"
Enum: "cron" "simple"

Schedule type

schedule
string

Cron expression to use for schedule type 'cron'

repeatInterval
integer <int64> >= 0
Default: 0

Repeat interval, in milliseconds, for schedule type 'simple'

repeatCount
integer <int32> >= -1
Default: -1

Repeat count for schedule type 'simple' (-1 to repeat indefinitely)

startTime
string <date-time>

Start time for job in ISO 8601 date-time format

endTime
string <date-time>

End time for job in ISO 8601 date-time format

invokeService
required
string

Service PID of the service to be invoked. If no '.' is included, it is prefixed with 'org.forgerock.openidm.'

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

nextRunDate
string <date-time>

Next run date for job in ISO 8601 date-time format

previousRunDate
string <date-time>

Previous run date 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

_id
string

Job instance ID

Responses

Request samples

Content type
{
  • "enabled": true,
  • "persisted": false,
  • "recoverable": false,
  • "concurrentExecution": false,
  • "misfirePolicy": "doNothing",
  • "type": "cron",
  • "schedule": "string",
  • "repeatInterval": 0,
  • "repeatCount": -1,
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "invokeService": "string",
  • "invokeContext": { },
  • "invokeLogLevel": "ERROR",
  • "nextRunDate": "2019-08-24T14:15:22Z",
  • "previousRunDate": "2019-08-24T14:15:22Z",
  • "triggers": [
    ],
  • "_id": "string"
}

Response samples

Content type
application/json
{
  • "enabled": true,
  • "persisted": false,
  • "recoverable": false,
  • "concurrentExecution": false,
  • "misfirePolicy": "doNothing",
  • "type": "cron",
  • "schedule": "string",
  • "repeatInterval": 0,
  • "repeatCount": -1,
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "invokeService": "string",
  • "invokeContext": { },
  • "invokeLogLevel": "ERROR",
  • "nextRunDate": "2019-08-24T14:15:22Z",
  • "previousRunDate": "2019-08-24T14:15:22Z",
  • "triggers": [
    ],
  • "_id": "string"
}

Action: trigger

Trigger the specified job.

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
}

Delete

Deletes the specified schedule.

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
{
  • "enabled": true,
  • "persisted": false,
  • "recoverable": false,
  • "concurrentExecution": false,
  • "misfirePolicy": "doNothing",
  • "type": "cron",
  • "schedule": "string",
  • "repeatInterval": 0,
  • "repeatCount": -1,
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "invokeService": "string",
  • "invokeContext": { },
  • "invokeLogLevel": "ERROR",
  • "nextRunDate": "2019-08-24T14:15:22Z",
  • "previousRunDate": "2019-08-24T14:15:22Z",
  • "triggers": [
    ],
  • "_id": "string"
}

Read

Obtains the details of the specified schedule.

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
{
  • "enabled": true,
  • "persisted": false,
  • "recoverable": false,
  • "concurrentExecution": false,
  • "misfirePolicy": "doNothing",
  • "type": "cron",
  • "schedule": "string",
  • "repeatInterval": 0,
  • "repeatCount": -1,
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "invokeService": "string",
  • "invokeContext": { },
  • "invokeLogLevel": "ERROR",
  • "nextRunDate": "2019-08-24T14:15:22Z",
  • "previousRunDate": "2019-08-24T14:15:22Z",
  • "triggers": [
    ],
  • "_id": "string"
}

Action: resumeJobs

Resumes all suspended scheduled jobs.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
}

Update

Update the job schedule.

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
enabled
boolean
Default: true

Enable this job schedule

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

concurrentExecution
boolean
Default: false

Reschedule the job even when a previous run is still executing

misfirePolicy
string
Default: "fireAndProceed"
Enum: "doNothing" "fireAndProceed"

Misfire handling policy

type
string
Default: "cron"
Enum: "cron" "simple"

Schedule type

schedule
string

Cron expression to use for schedule type 'cron'

repeatInterval
integer <int64> >= 0
Default: 0

Repeat interval, in milliseconds, for schedule type 'simple'

repeatCount
integer <int32> >= -1
Default: -1

Repeat count for schedule type 'simple' (-1 to repeat indefinitely)

startTime
string <date-time>

Start time for job in ISO 8601 date-time format

endTime
string <date-time>

End time for job in ISO 8601 date-time format

invokeService
required
string

Service PID of the service to be invoked. If no '.' is included, it is prefixed with 'org.forgerock.openidm.'

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

nextRunDate
string <date-time>

Next run date for job in ISO 8601 date-time format

previousRunDate
string <date-time>

Previous run date 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

_id
string

Job instance ID

Responses

Request samples

Content type
{
  • "enabled": true,
  • "persisted": false,
  • "recoverable": false,
  • "concurrentExecution": false,
  • "misfirePolicy": "doNothing",
  • "type": "cron",
  • "schedule": "string",
  • "repeatInterval": 0,
  • "repeatCount": -1,
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "invokeService": "string",
  • "invokeContext": { },
  • "invokeLogLevel": "ERROR",
  • "nextRunDate": "2019-08-24T14:15:22Z",
  • "previousRunDate": "2019-08-24T14:15:22Z",
  • "triggers": [
    ],
  • "_id": "string"
}

Response samples

Content type
application/json
{
  • "enabled": true,
  • "persisted": false,
  • "recoverable": false,
  • "concurrentExecution": false,
  • "misfirePolicy": "doNothing",
  • "type": "cron",
  • "schedule": "string",
  • "repeatInterval": 0,
  • "repeatCount": -1,
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "invokeService": "string",
  • "invokeContext": { },
  • "invokeLogLevel": "ERROR",
  • "nextRunDate": "2019-08-24T14:15:22Z",
  • "previousRunDate": "2019-08-24T14:15:22Z",
  • "triggers": [
    ],
  • "_id": "string"
}

Action: resume

Resume the specified job.

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: pause

Pause the specified job.

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
}

Query by Filter

Queries the existing defined schedules.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Action: validateQuartzCronExpression

Validates a cron expression.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
}

Action: pauseJobs

Suspends all scheduled jobs.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
}

Scheduler Trigger v1.0

Read

Obtains the details of the specified trigger.

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
{
  • "name": "string",
  • "group": "string",
  • "calendar": "string",
  • "serialized": "string",
  • "previousState": 0,
  • "state": 0,
  • "acquired": true,
  • "nodeId": "string",
  • "jobName": "string",
  • "_rev": "string",
  • "_id": "string"
}

Query by Filter

Queries the existing triggers.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Scheduler Trigger v2.0

Read

Obtains the details of the specified trigger.

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
{
  • "name": "string",
  • "group": "string",
  • "jobKey": "string",
  • "calendar": "string",
  • "serialized": { },
  • "previousState": "string",
  • "state": "string",
  • "nodeId": "string",
  • "_rev": "string",
  • "_id": "string"
}

Query by Filter

Queries the existing triggers.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Scheduler Waiting Triggers v1.0

Read Deprecated

Returns an array of the triggers that are waiting to be acquired. Querying the scheduler/trigger endpoint directly by state is the preferred means of obtaining a list of waiting triggers.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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",
  • "additionalProperties": [
    ]
}

Schema v1.0

Read

Read the schema for internal/notification objects.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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",
  • "title": "string",
  • "viewable": true,
  • "type": "string",
  • "properties": [
    ],
  • "order": [
    ],
  • "required": [
    ],
  • "resourceCollection": "string",
  • "$schema": "string"
}

Read

Read the schema for managed/role objects.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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",
  • "title": "string",
  • "viewable": true,
  • "type": "string",
  • "properties": [
    ],
  • "order": [
    ],
  • "required": [
    ],
  • "resourceCollection": "string",
  • "$schema": "string"
}

Read

Read the schema for managed/assignment objects.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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",
  • "title": "string",
  • "viewable": true,
  • "type": "string",
  • "properties": [
    ],
  • "order": [
    ],
  • "required": [
    ],
  • "resourceCollection": "string",
  • "$schema": "string"
}

Read

Read the schema for internal/user objects.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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",
  • "title": "string",
  • "viewable": true,
  • "type": "string",
  • "properties": [
    ],
  • "order": [
    ],
  • "required": [
    ],
  • "resourceCollection": "string",
  • "$schema": "string"
}

Read

Read the schema for internal/role objects.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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",
  • "title": "string",
  • "viewable": true,
  • "type": "string",
  • "properties": [
    ],
  • "order": [
    ],
  • "required": [
    ],
  • "resourceCollection": "string",
  • "$schema": "string"
}

Read

Read the schema for managed/organization objects.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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",
  • "title": "string",
  • "viewable": true,
  • "type": "string",
  • "properties": [
    ],
  • "order": [
    ],
  • "required": [
    ],
  • "resourceCollection": "string",
  • "$schema": "string"
}

Read

Read the schema for internal/usermeta objects.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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",
  • "title": "string",
  • "viewable": true,
  • "type": "string",
  • "properties": [
    ],
  • "order": [
    ],
  • "required": [
    ],
  • "resourceCollection": "string",
  • "$schema": "string"
}

Read

Read the schema for managed/user objects.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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",
  • "title": "string",
  • "viewable": true,
  • "type": "string",
  • "properties": [
    ],
  • "order": [
    ],
  • "required": [
    ],
  • "resourceCollection": "string",
  • "$schema": "string"
}

Schema v2.0

Read

Read the schema for managed/assignment objects.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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",
  • "title": "string",
  • "viewable": true,
  • "type": "string",
  • "properties": [
    ],
  • "order": [
    ],
  • "required": [
    ],
  • "resourceCollection": "string",
  • "$schema": "string"
}

Delete

Delete a property from managed/role/properties.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource 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
{
  • "description": "string",
  • "title": "string",
  • "viewable": true,
  • "userEditable": true,
  • "returnByDefault": true,
  • "usageDescription": "string",
  • "isPersonal": true,
  • "type": "string",
  • "validate": true,
  • "notifySelf": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "reverseRelationship": true,
  • "reversePropertyName": "string",
  • "properties": {
    },
  • "resourceCollection": [
    ]
}

Read

Read a property from managed/role/properties.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "description": "string",
  • "title": "string",
  • "viewable": true,
  • "userEditable": true,
  • "returnByDefault": true,
  • "usageDescription": "string",
  • "isPersonal": true,
  • "type": "string",
  • "validate": true,
  • "notifySelf": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "reverseRelationship": true,
  • "reversePropertyName": "string",
  • "properties": {
    },
  • "resourceCollection": [
    ]
}

Read

Read the schema for internal/notification objects.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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",
  • "title": "string",
  • "viewable": true,
  • "type": "string",
  • "properties": [
    ],
  • "order": [
    ],
  • "required": [
    ],
  • "resourceCollection": "string",
  • "$schema": "string"
}

Read

Read the schema for internal/user objects.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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",
  • "title": "string",
  • "viewable": true,
  • "type": "string",
  • "properties": [
    ],
  • "order": [
    ],
  • "required": [
    ],
  • "resourceCollection": "string",
  • "$schema": "string"
}

Create with Client-Assigned ID

Create a property from managed/organization/properties.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource 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.

title
string

A human-readable string, used to display the property in the UI.

viewable
boolean

Specifies whether this property is viewable in the object’s profile in the UI.

userEditable
boolean

Specifies whether the relationship property is editable by the user.

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

usageDescription
string

Designed to help end users understand the sensitivity of a property such as a telephone number.

isPersonal
boolean

Designed to highlight personally identifying information.

type
required
string

Specifies the type and cardinality this relationship is.

validate
boolean

Specifies whether the relationship should be validated.

notifySelf
boolean

Specifies if the origin object should be notified when there is a relationship change.

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.

reverseRelationship
required
boolean

Specifies whether this is a bidirectional relationship.

reversePropertyName
required
string

The corresponding property name, in the case of a bidirectional relationship.

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.

Responses

Request samples

Content type
{
  • "description": "string",
  • "title": "string",
  • "viewable": true,
  • "userEditable": true,
  • "returnByDefault": true,
  • "usageDescription": "string",
  • "isPersonal": true,
  • "type": "string",
  • "validate": true,
  • "notifySelf": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "reverseRelationship": true,
  • "reversePropertyName": "string",
  • "properties": {
    },
  • "resourceCollection": [
    ]
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "title": "string",
  • "viewable": true,
  • "userEditable": true,
  • "returnByDefault": true,
  • "usageDescription": "string",
  • "isPersonal": true,
  • "type": "string",
  • "validate": true,
  • "notifySelf": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "reverseRelationship": true,
  • "reversePropertyName": "string",
  • "properties": {
    },
  • "resourceCollection": [
    ]
}

Read

Read a property from managed/user/properties.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "description": "string",
  • "title": "string",
  • "viewable": true,
  • "userEditable": true,
  • "returnByDefault": true,
  • "usageDescription": "string",
  • "isPersonal": true,
  • "type": "string",
  • "validate": true,
  • "notifySelf": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "reverseRelationship": true,
  • "reversePropertyName": "string",
  • "properties": {
    },
  • "resourceCollection": [
    ]
}

Read

Read a property from managed/organization/properties.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "description": "string",
  • "title": "string",
  • "viewable": true,
  • "userEditable": true,
  • "returnByDefault": true,
  • "usageDescription": "string",
  • "isPersonal": true,
  • "type": "string",
  • "validate": true,
  • "notifySelf": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "reverseRelationship": true,
  • "reversePropertyName": "string",
  • "properties": {
    },
  • "resourceCollection": [
    ]
}

Delete

Delete a property from managed/user/properties.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource 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
{
  • "description": "string",
  • "title": "string",
  • "viewable": true,
  • "userEditable": true,
  • "returnByDefault": true,
  • "usageDescription": "string",
  • "isPersonal": true,
  • "type": "string",
  • "validate": true,
  • "notifySelf": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "reverseRelationship": true,
  • "reversePropertyName": "string",
  • "properties": {
    },
  • "resourceCollection": [
    ]
}

Read

Read a property from managed/assignment/properties.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "description": "string",
  • "title": "string",
  • "viewable": true,
  • "userEditable": true,
  • "returnByDefault": true,
  • "usageDescription": "string",
  • "isPersonal": true,
  • "type": "string",
  • "validate": true,
  • "notifySelf": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "reverseRelationship": true,
  • "reversePropertyName": "string",
  • "properties": {
    },
  • "resourceCollection": [
    ]
}

Read

Read the schema for managed/user objects.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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",
  • "title": "string",
  • "viewable": true,
  • "type": "string",
  • "properties": [
    ],
  • "order": [
    ],
  • "required": [
    ],
  • "resourceCollection": "string",
  • "$schema": "string"
}

Read

Read the schema for managed/role objects.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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",
  • "title": "string",
  • "viewable": true,
  • "type": "string",
  • "properties": [
    ],
  • "order": [
    ],
  • "required": [
    ],
  • "resourceCollection": "string",
  • "$schema": "string"
}

Update

Update a property from managed/role/properties.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should 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.

title
string

A human-readable string, used to display the property in the UI.

viewable
boolean

Specifies whether this property is viewable in the object’s profile in the UI.

userEditable
boolean

Specifies whether the relationship property is editable by the user.

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

usageDescription
string

Designed to help end users understand the sensitivity of a property such as a telephone number.

isPersonal
boolean

Designed to highlight personally identifying information.

type
required
string

Specifies the type and cardinality this relationship is.

validate
boolean

Specifies whether the relationship should be validated.

notifySelf
boolean

Specifies if the origin object should be notified when there is a relationship change.

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.

reverseRelationship
required
boolean

Specifies whether this is a bidirectional relationship.

reversePropertyName
required
string

The corresponding property name, in the case of a bidirectional relationship.

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.

Responses

Request samples

Content type
{
  • "description": "string",
  • "title": "string",
  • "viewable": true,
  • "userEditable": true,
  • "returnByDefault": true,
  • "usageDescription": "string",
  • "isPersonal": true,
  • "type": "string",
  • "validate": true,
  • "notifySelf": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "reverseRelationship": true,
  • "reversePropertyName": "string",
  • "properties": {
    },
  • "resourceCollection": [
    ]
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "title": "string",
  • "viewable": true,
  • "userEditable": true,
  • "returnByDefault": true,
  • "usageDescription": "string",
  • "isPersonal": true,
  • "type": "string",
  • "validate": true,
  • "notifySelf": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "reverseRelationship": true,
  • "reversePropertyName": "string",
  • "properties": {
    },
  • "resourceCollection": [
    ]
}

Read

Read the schema for internal/role objects.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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",
  • "title": "string",
  • "viewable": true,
  • "type": "string",
  • "properties": [
    ],
  • "order": [
    ],
  • "required": [
    ],
  • "resourceCollection": "string",
  • "$schema": "string"
}

Create with Client-Assigned ID

Create a property from managed/assignment/properties.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource 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.

title
string

A human-readable string, used to display the property in the UI.

viewable
boolean

Specifies whether this property is viewable in the object’s profile in the UI.

userEditable
boolean

Specifies whether the relationship property is editable by the user.

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

usageDescription
string

Designed to help end users understand the sensitivity of a property such as a telephone number.

isPersonal
boolean

Designed to highlight personally identifying information.

type
required
string

Specifies the type and cardinality this relationship is.

validate
boolean

Specifies whether the relationship should be validated.

notifySelf
boolean

Specifies if the origin object should be notified when there is a relationship change.

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.

reverseRelationship
required
boolean

Specifies whether this is a bidirectional relationship.

reversePropertyName
required
string

The corresponding property name, in the case of a bidirectional relationship.

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.

Responses

Request samples

Content type
{
  • "description": "string",
  • "title": "string",
  • "viewable": true,
  • "userEditable": true,
  • "returnByDefault": true,
  • "usageDescription": "string",
  • "isPersonal": true,
  • "type": "string",
  • "validate": true,
  • "notifySelf": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "reverseRelationship": true,
  • "reversePropertyName": "string",
  • "properties": {
    },
  • "resourceCollection": [
    ]
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "title": "string",
  • "viewable": true,
  • "userEditable": true,
  • "returnByDefault": true,
  • "usageDescription": "string",
  • "isPersonal": true,
  • "type": "string",
  • "validate": true,
  • "notifySelf": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "reverseRelationship": true,
  • "reversePropertyName": "string",
  • "properties": {
    },
  • "resourceCollection": [
    ]
}

Delete

Delete a property from managed/organization/properties.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource 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
{
  • "description": "string",
  • "title": "string",
  • "viewable": true,
  • "userEditable": true,
  • "returnByDefault": true,
  • "usageDescription": "string",
  • "isPersonal": true,
  • "type": "string",
  • "validate": true,
  • "notifySelf": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "reverseRelationship": true,
  • "reversePropertyName": "string",
  • "properties": {
    },
  • "resourceCollection": [
    ]
}

Create with Client-Assigned ID

Create a property from managed/user/properties.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource 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.

title
string

A human-readable string, used to display the property in the UI.

viewable
boolean

Specifies whether this property is viewable in the object’s profile in the UI.

userEditable
boolean

Specifies whether the relationship property is editable by the user.

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

usageDescription
string

Designed to help end users understand the sensitivity of a property such as a telephone number.

isPersonal
boolean

Designed to highlight personally identifying information.

type
required
string

Specifies the type and cardinality this relationship is.

validate
boolean

Specifies whether the relationship should be validated.

notifySelf
boolean

Specifies if the origin object should be notified when there is a relationship change.

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.

reverseRelationship
required
boolean

Specifies whether this is a bidirectional relationship.

reversePropertyName
required
string

The corresponding property name, in the case of a bidirectional relationship.

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.

Responses

Request samples

Content type
{
  • "description": "string",
  • "title": "string",
  • "viewable": true,
  • "userEditable": true,
  • "returnByDefault": true,
  • "usageDescription": "string",
  • "isPersonal": true,
  • "type": "string",
  • "validate": true,
  • "notifySelf": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "reverseRelationship": true,
  • "reversePropertyName": "string",
  • "properties": {
    },
  • "resourceCollection": [
    ]
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "title": "string",
  • "viewable": true,
  • "userEditable": true,
  • "returnByDefault": true,
  • "usageDescription": "string",
  • "isPersonal": true,
  • "type": "string",
  • "validate": true,
  • "notifySelf": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "reverseRelationship": true,
  • "reversePropertyName": "string",
  • "properties": {
    },
  • "resourceCollection": [
    ]
}

Create with Client-Assigned ID

Create a property from managed/role/properties.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource 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.

title
string

A human-readable string, used to display the property in the UI.

viewable
boolean

Specifies whether this property is viewable in the object’s profile in the UI.

userEditable
boolean

Specifies whether the relationship property is editable by the user.

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

usageDescription
string

Designed to help end users understand the sensitivity of a property such as a telephone number.

isPersonal
boolean

Designed to highlight personally identifying information.

type
required
string

Specifies the type and cardinality this relationship is.

validate
boolean

Specifies whether the relationship should be validated.

notifySelf
boolean

Specifies if the origin object should be notified when there is a relationship change.

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.

reverseRelationship
required
boolean

Specifies whether this is a bidirectional relationship.

reversePropertyName
required
string

The corresponding property name, in the case of a bidirectional relationship.

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.

Responses

Request samples

Content type
{
  • "description": "string",
  • "title": "string",
  • "viewable": true,
  • "userEditable": true,
  • "returnByDefault": true,
  • "usageDescription": "string",
  • "isPersonal": true,
  • "type": "string",
  • "validate": true,
  • "notifySelf": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "reverseRelationship": true,
  • "reversePropertyName": "string",
  • "properties": {
    },
  • "resourceCollection": [
    ]
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "title": "string",
  • "viewable": true,
  • "userEditable": true,
  • "returnByDefault": true,
  • "usageDescription": "string",
  • "isPersonal": true,
  • "type": "string",
  • "validate": true,
  • "notifySelf": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "reverseRelationship": true,
  • "reversePropertyName": "string",
  • "properties": {
    },
  • "resourceCollection": [
    ]
}

Read

Read the schema for managed/organization objects.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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",
  • "title": "string",
  • "viewable": true,
  • "type": "string",
  • "properties": [
    ],
  • "order": [
    ],
  • "required": [
    ],
  • "resourceCollection": "string",
  • "$schema": "string"
}

Update

Update a property from managed/assignment/properties.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should 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.

title
string

A human-readable string, used to display the property in the UI.

viewable
boolean

Specifies whether this property is viewable in the object’s profile in the UI.

userEditable
boolean

Specifies whether the relationship property is editable by the user.

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

usageDescription
string

Designed to help end users understand the sensitivity of a property such as a telephone number.

isPersonal
boolean

Designed to highlight personally identifying information.

type
required
string

Specifies the type and cardinality this relationship is.

validate
boolean

Specifies whether the relationship should be validated.

notifySelf
boolean

Specifies if the origin object should be notified when there is a relationship change.

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.

reverseRelationship
required
boolean

Specifies whether this is a bidirectional relationship.

reversePropertyName
required
string

The corresponding property name, in the case of a bidirectional relationship.

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.

Responses

Request samples

Content type
{
  • "description": "string",
  • "title": "string",
  • "viewable": true,
  • "userEditable": true,
  • "returnByDefault": true,
  • "usageDescription": "string",
  • "isPersonal": true,
  • "type": "string",
  • "validate": true,
  • "notifySelf": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "reverseRelationship": true,
  • "reversePropertyName": "string",
  • "properties": {
    },
  • "resourceCollection": [
    ]
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "title": "string",
  • "viewable": true,
  • "userEditable": true,
  • "returnByDefault": true,
  • "usageDescription": "string",
  • "isPersonal": true,
  • "type": "string",
  • "validate": true,
  • "notifySelf": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "reverseRelationship": true,
  • "reversePropertyName": "string",
  • "properties": {
    },
  • "resourceCollection": [
    ]
}

Read

Read the schema for internal/usermeta objects.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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",
  • "title": "string",
  • "viewable": true,
  • "type": "string",
  • "properties": [
    ],
  • "order": [
    ],
  • "required": [
    ],
  • "resourceCollection": "string",
  • "$schema": "string"
}

Update

Update a property from managed/user/properties.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should 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.

title
string

A human-readable string, used to display the property in the UI.

viewable
boolean

Specifies whether this property is viewable in the object’s profile in the UI.

userEditable
boolean

Specifies whether the relationship property is editable by the user.

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

usageDescription
string

Designed to help end users understand the sensitivity of a property such as a telephone number.

isPersonal
boolean

Designed to highlight personally identifying information.

type
required
string

Specifies the type and cardinality this relationship is.

validate
boolean

Specifies whether the relationship should be validated.

notifySelf
boolean

Specifies if the origin object should be notified when there is a relationship change.

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.

reverseRelationship
required
boolean

Specifies whether this is a bidirectional relationship.

reversePropertyName
required
string

The corresponding property name, in the case of a bidirectional relationship.

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.

Responses

Request samples

Content type
{
  • "description": "string",
  • "title": "string",
  • "viewable": true,
  • "userEditable": true,
  • "returnByDefault": true,
  • "usageDescription": "string",
  • "isPersonal": true,
  • "type": "string",
  • "validate": true,
  • "notifySelf": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "reverseRelationship": true,
  • "reversePropertyName": "string",
  • "properties": {
    },
  • "resourceCollection": [
    ]
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "title": "string",
  • "viewable": true,
  • "userEditable": true,
  • "returnByDefault": true,
  • "usageDescription": "string",
  • "isPersonal": true,
  • "type": "string",
  • "validate": true,
  • "notifySelf": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "reverseRelationship": true,
  • "reversePropertyName": "string",
  • "properties": {
    },
  • "resourceCollection": [
    ]
}

Delete

Delete a property from managed/assignment/properties.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource 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
{
  • "description": "string",
  • "title": "string",
  • "viewable": true,
  • "userEditable": true,
  • "returnByDefault": true,
  • "usageDescription": "string",
  • "isPersonal": true,
  • "type": "string",
  • "validate": true,
  • "notifySelf": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "reverseRelationship": true,
  • "reversePropertyName": "string",
  • "properties": {
    },
  • "resourceCollection": [
    ]
}

Update

Update a property from managed/organization/properties.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should 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.

title
string

A human-readable string, used to display the property in the UI.

viewable
boolean

Specifies whether this property is viewable in the object’s profile in the UI.

userEditable
boolean

Specifies whether the relationship property is editable by the user.

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

usageDescription
string

Designed to help end users understand the sensitivity of a property such as a telephone number.

isPersonal
boolean

Designed to highlight personally identifying information.

type
required
string

Specifies the type and cardinality this relationship is.

validate
boolean

Specifies whether the relationship should be validated.

notifySelf
boolean

Specifies if the origin object should be notified when there is a relationship change.

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.

reverseRelationship
required
boolean

Specifies whether this is a bidirectional relationship.

reversePropertyName
required
string

The corresponding property name, in the case of a bidirectional relationship.

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.

Responses

Request samples

Content type
{
  • "description": "string",
  • "title": "string",
  • "viewable": true,
  • "userEditable": true,
  • "returnByDefault": true,
  • "usageDescription": "string",
  • "isPersonal": true,
  • "type": "string",
  • "validate": true,
  • "notifySelf": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "reverseRelationship": true,
  • "reversePropertyName": "string",
  • "properties": {
    },
  • "resourceCollection": [
    ]
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "title": "string",
  • "viewable": true,
  • "userEditable": true,
  • "returnByDefault": true,
  • "usageDescription": "string",
  • "isPersonal": true,
  • "type": "string",
  • "validate": true,
  • "notifySelf": true,
  • "notify": true,
  • "notifyRelationships": [
    ],
  • "reverseRelationship": true,
  • "reversePropertyName": "string",
  • "properties": {
    },
  • "resourceCollection": [
    ]
}

Script v1.0

Action: compile

Compiles a script, to validate that it can be executed.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
type
required
string

Script type (e.g., text/javascript, groovy)

file
string

Path to file containing the script

source
string

Inlined script

globals
object (Global Variable Key/Value Pairs)

Global Variables

Responses

Request samples

Content type
{
  • "type": "string",
  • "file": "string",
  • "source": "string",
  • "globals": { }
}

Response samples

Content type
application/json
true

Action: eval

Executes a script and returns the result, if any.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
type
required
string

Script type (e.g., text/javascript, groovy)

file
string

Path to file containing the script

source
string

Inlined script

globals
object (Global Variable Key/Value Pairs)

Global Variables

Responses

Request samples

Content type
{
  • "type": "string",
  • "file": "string",
  • "source": "string",
  • "globals": { }
}

Response samples

Content type
application/json
{ }

SelfService - KBA v1.0

Read

Gathers KBA Configuration.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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 - Terms v1.0

Read

Gathers the active Terms & Conditions.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "version": "string",
  • "terms": "string",
  • "createDate": "string"
}

Synchronization v1.0

Action: performAction

Perform an action on a resource.

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"
}

Action: notifyCreate

Informs the Synchronization Service that an object has been created and that the change should be synchronized across all relevant mappings.

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: getLinkedResources

Provides a list of linked resources for the given resource-name.

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: notifyDelete

Informs the Synchronization Service that an object has been deleted and that the change should be synchronized across all relevant mappings.

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.

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
oldValue
object

The former value of the source object, if any

newValue
object

The new value of the source object

Responses

Request samples

Content type
{
  • "oldValue": { },
  • "newValue": { }
}

Response samples

Content type
application/json
{
  • "syncResults": [
    ]
}

Sync Mappings v1.0

Read

Returns the configuration details about a given mapping

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
{
  • "name": "string",
  • "source": "string",
  • "target": "string",
  • "correlationQuery": { },
  • "properties": [
    ],
  • "policies": [
    ]
}

Query by Filter

Provides the list of mappings.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}

Connector v1.0

Action: createCoreConfig

Generate core-configuration template for a connector.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "name": "string",
  • "connectorRef": {
    },
  • "producerBufferSize": 100,
  • "connectorPoolingSupported": true,
  • "poolConfigOption": {
    },
  • "resultsHandlerConfig": {
    },
  • "operationTimeout": {
    },
  • "configurationProperties": { },
  • "syncFailureHandler": {
    },
  • "objectTypes": { },
  • "operationOptions": {
    },
  • "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.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
name
string

Unique connector name

required
object (Connector Identifiers)

Connector identifiers

producerBufferSize
integer <int32>
Default: 100

Size of SYNC/QUERY result-queue

connectorPoolingSupported
boolean
Default: true

Enables connector pooling, when supported

required
object (Connector Pool Config)

Connector pool configuration

object (Results Handler Config)

Results handler configuration

object (Operation Timeout)

Timeouts per operation

configurationProperties
required
object

Connector specific configuration

object (Sync Failure Handler Config)

Configures how live-sync failures are handled

objectTypes
object

Map of object-classes to JSON Schemas

object (Operation Options)

Configuration settings per operation

Array of objects (System Action Config)

Connector actions (e.g., scripts)

Responses

Request samples

Content type
{
  • "name": "string",
  • "connectorRef": {
    },
  • "producerBufferSize": 100,
  • "connectorPoolingSupported": true,
  • "poolConfigOption": {
    },
  • "resultsHandlerConfig": {
    },
  • "operationTimeout": {
    },
  • "configurationProperties": { },
  • "syncFailureHandler": {
    },
  • "objectTypes": { },
  • "operationOptions": {
    },
  • "systemActions": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "connectorRef": {
    },
  • "producerBufferSize": 100,
  • "connectorPoolingSupported": true,
  • "poolConfigOption": {
    },
  • "resultsHandlerConfig": {
    },
  • "operationTimeout": {
    },
  • "configurationProperties": { },
  • "syncFailureHandler": {
    },
  • "objectTypes": { },
  • "operationOptions": {
    },
  • "systemActions": [
    ]
}

Action: testConnectorServers

Test if a connector server is operational.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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": [
    ]
}

Action: createConnectorServerCoreConfig

Generate core-configuration template for a connector server.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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: liveSync

Trigger Live-Sync on a connector.

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
{
  • "connectorData": {
    },
  • "_id": "string",
  • "_rev": "string"
}

Action: availableConnectorServers

Lists all available connector servers.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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: availableConnectors

Lists all available connectors, which includes those that are not configured and ready-for-use.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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: 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.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
name
string

Unique connector name

required
object (Connector Identifiers)

Connector identifiers

producerBufferSize
integer <int32>
Default: 100

Size of SYNC/QUERY result-queue

connectorPoolingSupported
boolean
Default: true

Enables connector pooling, when supported

required
object (Connector Pool Config)

Connector pool configuration

object (Results Handler Config)

Results handler configuration

object (Operation Timeout)

Timeouts per operation

configurationProperties
required
object

Connector specific configuration

object (Sync Failure Handler Config)

Configures how live-sync failures are handled

objectTypes
object

Map of object-classes to JSON Schemas

object (Operation Options)

Configuration settings per operation

Array of objects (System Action Config)

Connector actions (e.g., scripts)

Responses

Request samples

Content type
{
  • "name": "string",
  • "connectorRef": {
    },
  • "producerBufferSize": 100,
  • "connectorPoolingSupported": true,
  • "poolConfigOption": {
    },
  • "resultsHandlerConfig": {
    },
  • "operationTimeout": {
    },
  • "configurationProperties": { },
  • "syncFailureHandler": {
    },
  • "objectTypes": { },
  • "operationOptions": {
    },
  • "systemActions": [
    ]
}

Response samples

Content type
application/json
{
  • "ok": true,
  • "name": "string",
  • "error": "string"
}

Task Scanner v1.0

Action: cancel

Marks a task as cancelled, but only if not yet completed.

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
{
  • "status": "FAILURE",
  • "_id": "string"
}

Read

Reads a task entry.

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
{
  • "name": "string",
  • "started": "2019-08-24T14:15:22Z",
  • "ended": "2019-08-24T14:15:22Z",
  • "progress": {
    },
  • "_id": "string"
}

Action: execute

Executes a task by name.

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.

query Parameters
_fields
string

Optional parameter containing a comma separated list of field references specifying which fields of the targeted 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
{
  • "result": [
    ],
  • "resultCount": 0,
  • "pagedResultsCookie": "string",
  • "totalPagedResultsPolicy": "NONE",
  • "totalPagedResults": -1,
  • "remainingPagedResults": -1
}