Get a Document by ID

GET 
/search/:index/:id

Fetches a single document from the specified index, using the specified document ID.

Request

Path Parameters

index stringrequired
The index from which to fetch the specified document.
The currently supported index names are: accessprofiles, accountactivities, entitlements, events, identities, and roles.
Example: accounts
id stringrequired
ID of the requested document.
Example: 2c91808568c529c60168cca6f90c1313

Responses

200

The requested document.

application/json

Schema

Schema

oneOf

AccessProfileDocument

id stringrequired

The unique ID of the referenced object.

name stringrequired

The human readable name of the referenced object.

description string

Access item's description.

created date-timenullable

ISO-8601 date-time referring to the time when the object was created.

modified date-timenullable

ISO-8601 date-time referring to the time when the object was last modified.

synced date-timenullable

ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API.
This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the synced time and the time when the updated data is actually available in the search API.

enabled boolean

Default value: false

Indicates whether the access item is currently enabled.

requestable boolean

Default value: true

Indicates whether the access item can be requested.

requestCommentsRequired boolean

Default value: false

Indicates whether comments are required for requests to access the item.

owner object

Owner's identity.

type string

Possible values: [IDENTITY]

Owner's DTO type.

id string

Owner's identity ID.

name string

Owner's display name.

email string

Owner's email.

_type stringrequired

Possible values: [accessprofile, accountactivity, account, aggregation, entitlement, event, identity, role]

Access profile's document type. This enum represents the currently supported document types. Additional values may be added in the future without notice.

source object

Access profile's source.

id string

Source's ID.

name string

Source's name.

entitlements object[]

Entitlements the access profile has access to.

Array [

hasPermissions boolean

Default value: false

Indicates whether the entitlement has permissions.

description string

Entitlement's description.

attribute string

Entitlement attribute's name.

value string

Entitlement's value.

schema string

Entitlement's schema.

privileged boolean

Default value: false

Indicates whether the entitlement is privileged.

id string

Entitlement's ID.

name string

Entitlement's name.

]

entitlementCount integer

Number of entitlements.

tags string[]

Tags that have been applied to the object.

AccountActivityDocument

id stringrequired

name stringrequired

_type DocumentTyperequired

Possible values: [accessprofile, accountactivity, account, aggregation, entitlement, event, identity, role]

Enum representing the currently supported document types.

Additional values may be added in the future without notice.

action string

Type of action performed in the activity.

created date-timenullable

ISO-8601 date-time referring to the time when the object was created.

modified date-timenullable

ISO-8601 date-time referring to the time when the object was last modified.

stage string

Activity's current stage.

origin stringnullable

Activity's origin.

status string

Activity's current status.

requester object

id string

The unique ID of the referenced object.

name string

The human readable name of the referenced object.

type string

Type of source returned.

recipient object

id string

The unique ID of the referenced object.

name string

The human readable name of the referenced object.

type string

Type of source returned.

trackingNumber string

Account activity's tracking number.

errors string[]nullable

Errors provided by the source while completing account actions.

warnings string[]nullable

Warnings provided by the source while completing account actions.

approvals object[]

Approvals performed on an item during activity.

Array [

comments object[]

Array [

comment string

The comment text

commenter string

The name of the commenter

date date-timenullable

A date-time in ISO-8601 format

]

created date-timenullable

A date-time in ISO-8601 format

modified date-timenullable

A date-time in ISO-8601 format

owner object

id string

The unique ID of the referenced object.

name string

The human readable name of the referenced object.

type string

Type of source returned.

result string

The result of the approval

type stringnullable

]

originalRequests object[]

Original actions that triggered all individual source actions related to the account action.

Array [

accountId string

Account ID.

attributeRequests object[]

Attribute changes requested for account.

Array [

name string

Attribute name.

op string

Operation to perform on attribute.

value string

Value of attribute.

]

op string

Operation used.

source object

Account's source.

id string

The unique ID of the referenced object.

name string

The human readable name of the referenced object.

type string

Type of source returned.

]

expansionItems object[]

Controls that translated the attribute requests into actual provisioning actions on the source.

Array [

accountId string

The ID of the account

cause string

name string

The name of the item

attributeRequests object[]

Array [

name string

Attribute name.

op string

Operation to perform on attribute.

value string

Value of attribute.

]

source object

id string

The unique ID of the referenced object.

name string

The human readable name of the referenced object.

type string

Type of source returned.

]

accountRequests object[]

Account data for each individual source action triggered by the original requests.

Array [

accountId string

Unique ID of the account

attributeRequests object[]

Array [

name string

Attribute name.

op string

Operation to perform on attribute.

value string

Value of attribute.

]

op string

The operation that was performed

provisioningTarget object

id string

The unique ID of the referenced object.

name string

The human readable name of the referenced object.

type string

Type of source returned.

result object

errors string[]

status string

The status of the account request

ticketId stringnullable

source object

id string

The unique ID of the referenced object.

name string

The human readable name of the referenced object.

type string

Type of source returned.

]

sources string

Sources involved in the account activity.

EntitlementDocument

id stringrequired

name stringrequired

_type DocumentTyperequired

Possible values: [accessprofile, accountactivity, account, aggregation, entitlement, event, identity, role]

Enum representing the currently supported document types.

Additional values may be added in the future without notice.

modified date-timenullable

ISO-8601 date-time referring to the time when the object was last modified.

synced string

ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API.
This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the synced time and the time when the updated data is actually available in the search API.

displayName string

Entitlement's display name.

source object

Entitlement's source.

id string

ID of entitlement's source.

name string

Display name of entitlement's source.

segments object[]

Segments with the role.

Array [

id string

Segment's unique ID.

name string

Segment's display name.

]

segmentCount int32

Number of segments with the role.

requestable boolean

Default value: false

Indicates whether the entitlement is requestable.

cloudGoverned boolean

Default value: false

Indicates whether the entitlement is cloud governed.

created date-timenullable

ISO-8601 date-time referring to the time when the object was created.

privileged boolean

Default value: false

Indicates whether the entitlement is privileged.

identityCount int32

Number of identities who have access to the entitlement.

tags string[]

Tags that have been applied to the object.

EventDocument

id stringrequired

name stringrequired

_type DocumentTyperequired

Possible values: [accessprofile, accountactivity, account, aggregation, entitlement, event, identity, role]

Enum representing the currently supported document types.

Additional values may be added in the future without notice.

created date-timenullable

ISO-8601 date-time referring to the time when the object was created.

synced string

ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API.
This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the synced time and the time when the updated data is actually available in the search API.

action string

Name of the event as it's displayed in audit reports.

type string

Event type. Refer to Event Types for a list of event types and their meanings.

actor string

Name of the actor that generated the event.

target string

Name of the target, or recipient, of the event.

stack string

The event's stack.

trackingNumber string

ID of the group of events.

ipAddress string

Target system's IP address.

details string

ID of event's details.

attributes object

Attributes involved in the event.

property name* any

Attributes involved in the event.

objects string[]

Objects the event is happening to.

operation string

Operation, or action, performed during the event.

status string

Event status. Refer to Event Statuses for a list of event statuses and their meanings.

technicalName string

Event's normalized name. This normalized name always follows the pattern of 'objects_operation_status'.

IdentityDocument

id stringrequired

The unique ID of the referenced object.

name stringrequired

The human readable name of the referenced object.

_type DocumentTyperequired

Possible values: [accessprofile, accountactivity, account, aggregation, entitlement, event, identity, role]

Enum representing the currently supported document types.

Additional values may be added in the future without notice.

displayName string

Identity's display name.

firstName string

Identity's first name.

lastName string

Identity's last name.

email string

Identity's primary email address.

created date-timenullable

ISO-8601 date-time referring to the time when the object was created.

modified date-timenullable

ISO-8601 date-time referring to the time when the object was last modified.

phone string

Identity's phone number.

synced string

ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API.
This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the synced time and the time when the updated data is actually available in the search API.

inactive boolean

Default value: false

Indicates whether the identity is inactive.

protected boolean

Default value: false

Indicates whether the identity is protected.

status string

Identity's status in SailPoint.

employeeNumber string

Identity's employee number.

manager objectnullable

Identity's manager.

id string

ID of identity's manager.

name string

Name of identity's manager.

displayName string

Display name of identity's manager.

isManager boolean

Indicates whether the identity is a manager of other identities.

identityProfile object

Identity's identity profile.

id string

Identity profile's ID.

name string

Identity profile's name.

source object

Identity's source.

id string

ID of identity's source.

name string

Display name of identity's source.

attributes object

Map or dictionary of key/value pairs.

property name* any

Map or dictionary of key/value pairs.

processingState stringnullable

Identity's processing state.

processingDetails objectnullable

Identity's processing details.

date date-timenullable

A date-time in ISO-8601 format

stage string

retryCount int32

stackTrace string

message string

accounts object[]

List of accounts associated with the identity.

Array [

id string

The unique ID of the referenced object.

name string

The human readable name of the referenced object.

accountId string

Account ID.

source object

id string

The unique ID of the referenced object.

name string

The human readable name of the referenced object.

type string

Type of source returned.

disabled boolean

Default value: false

Indicates whether the account is disabled.

locked boolean

Default value: false

Indicates whether the account is locked.

privileged boolean

Default value: false

Indicates whether the account is privileged.

manuallyCorrelated boolean

Default value: false

Indicates whether the account has been manually correlated to an identity.

passwordLastSet date-timenullable

A date-time in ISO-8601 format

entitlementAttributes objectnullable

Map or dictionary of key/value pairs.

property name* anynullable

Map or dictionary of key/value pairs.

created date-timenullable

ISO-8601 date-time referring to the time when the object was created.

]

accountCount int32

Number of accounts associated with the identity.

apps object[]

List of applications the identity has access to.

Array [

id string

The unique ID of the referenced object.

name string

The human readable name of the referenced object.

source object

id string

The unique ID of the referenced object.

name string

The human readable name of the referenced object.

account object

id string

The SailPoint generated unique ID

accountId string

The account ID generated by the source

]

appCount int32

Number of applications the identity has access to.

access object[]

List of access items assigned to the identity.

Array [

oneOf

AccessProfileSummary

id string

The unique ID of the referenced object.

name string

The human readable name of the referenced object.

displayName string

type DtoType

Possible values: [ACCOUNT_CORRELATION_CONFIG, ACCESS_PROFILE, ACCESS_REQUEST_APPROVAL, ACCOUNT, APPLICATION, CAMPAIGN, CAMPAIGN_FILTER, CERTIFICATION, CLUSTER, CONNECTOR_SCHEMA, ENTITLEMENT, GOVERNANCE_GROUP, IDENTITY, IDENTITY_PROFILE, IDENTITY_REQUEST, LIFECYCLE_STATE, PASSWORD_POLICY, ROLE, RULE, SOD_POLICY, SOURCE, TAG, TAG_CATEGORY, TASK_RESULT, REPORT_RESULT, SOD_VIOLATION, ACCOUNT_ACTIVITY, WORKGROUP]

An enumeration of the types of DTOs supported within the IdentityNow infrastructure.

description stringnullable

source object

id string

The unique ID of the referenced object.

name string

The human readable name of the referenced object.

owner object

id string

The unique ID of the referenced object.

name string

The human readable name of the referenced object.

displayName string

revocable boolean

AccessProfileEntitlement

id string

The unique ID of the referenced object.

name string

The human readable name of the referenced object.

displayName string

type DtoType

Possible values: [ACCOUNT_CORRELATION_CONFIG, ACCESS_PROFILE, ACCESS_REQUEST_APPROVAL, ACCOUNT, APPLICATION, CAMPAIGN, CAMPAIGN_FILTER, CERTIFICATION, CLUSTER, CONNECTOR_SCHEMA, ENTITLEMENT, GOVERNANCE_GROUP, IDENTITY, IDENTITY_PROFILE, IDENTITY_REQUEST, LIFECYCLE_STATE, PASSWORD_POLICY, ROLE, RULE, SOD_POLICY, SOURCE, TAG, TAG_CATEGORY, TASK_RESULT, REPORT_RESULT, SOD_VIOLATION, ACCOUNT_ACTIVITY, WORKGROUP]

An enumeration of the types of DTOs supported within the IdentityNow infrastructure.

description stringnullable

source object

id string

The unique ID of the referenced object.

name string

The human readable name of the referenced object.

privileged boolean

attribute string

value string

standalone boolean

AccessProfileRole

id string

The unique ID of the referenced object.

name string

The human readable name of the referenced object.

displayName string

type DtoType

Possible values: [ACCOUNT_CORRELATION_CONFIG, ACCESS_PROFILE, ACCESS_REQUEST_APPROVAL, ACCOUNT, APPLICATION, CAMPAIGN, CAMPAIGN_FILTER, CERTIFICATION, CLUSTER, CONNECTOR_SCHEMA, ENTITLEMENT, GOVERNANCE_GROUP, IDENTITY, IDENTITY_PROFILE, IDENTITY_REQUEST, LIFECYCLE_STATE, PASSWORD_POLICY, ROLE, RULE, SOD_POLICY, SOURCE, TAG, TAG_CATEGORY, TASK_RESULT, REPORT_RESULT, SOD_VIOLATION, ACCOUNT_ACTIVITY, WORKGROUP]

An enumeration of the types of DTOs supported within the IdentityNow infrastructure.

description stringnullable

owner object

id string

The unique ID of the referenced object.

name string

The human readable name of the referenced object.

displayName string

disabled boolean

revocable boolean

]

accessCount int32

Number of access items assigned to the identity.

entitlementCount int32

Number of entitlements assigned to the identity.

roleCount int32

Number of roles assigned to the identity.

accessProfileCount int32

Number of access profiles assigned to the identity.

owns object[]

Access items the identity owns.

Array [

sources object[]

Array [

id string

The unique ID of the referenced object.

name string

The human readable name of the referenced object.

]

entitlements object[]

Array [

id string

The unique ID of the referenced object.

name string

The human readable name of the referenced object.

]

accessProfiles object[]

Array [

id string

The unique ID of the referenced object.

name string

The human readable name of the referenced object.

]

roles object[]

Array [

id string

The unique ID of the referenced object.

name string

The human readable name of the referenced object.

]

apps object[]

Array [

id string

The unique ID of the referenced object.

name string

The human readable name of the referenced object.

]

governanceGroups object[]

Array [

id string

The unique ID of the referenced object.

name string

The human readable name of the referenced object.

]

fallbackApprover boolean

]

ownsCount int32

Number of access items the identity owns.

tags string[]

Tags that have been applied to the object.

RoleDocument

id stringrequired

The unique ID of the referenced object.

name stringrequired

The human readable name of the referenced object.

_type DocumentTyperequired

Possible values: [accessprofile, accountactivity, account, aggregation, entitlement, event, identity, role]

Enum representing the currently supported document types.

Additional values may be added in the future without notice.

description string

Access item's description.

created date-timenullable

ISO-8601 date-time referring to the time when the object was created.

modified date-timenullable

ISO-8601 date-time referring to the time when the object was last modified.

synced date-timenullable

ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API.
This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the synced time and the time when the updated data is actually available in the search API.

enabled boolean

Default value: false

Indicates whether the access item is currently enabled.

requestable boolean

Default value: true

Indicates whether the access item can be requested.

requestCommentsRequired boolean

Default value: false

Indicates whether comments are required for requests to access the item.

owner object

Owner's identity.

type string

Possible values: [IDENTITY]

Owner's DTO type.

id string

Owner's identity ID.

name string

Owner's display name.

email string

Owner's email.

accessProfiles object[]

Access profiles included with the role.

Array [

id string

Access profile's unique ID.

name string

Access profile's display name.

]

accessProfileCount int32

Number of access profiles included with the role.

tags string[]

Tags that have been applied to the object.

segments object[]

Segments with the role.

Array [

id string

Segment's unique ID.

name string

Segment's display name.

]

segmentCount int32

Number of segments with the role.

entitlements object[]

Entitlements included with the role.

Array [

hasPermissions boolean

Default value: false

Indicates whether the entitlement has permissions.

description string

Entitlement's description.

attribute string

Entitlement attribute's name.

value string

Entitlement's value.

schema string

Entitlement's schema.

privileged boolean

Default value: false

Indicates whether the entitlement is privileged.

id string

Entitlement's ID.

name string

Entitlement's name.

]

entitlementCount int32

Number of entitlements included with the role.

accessProfile

AccessProfile

{
  "id": "2c9180825a6c1adc015a71c9023f0818",
  "name": "Cloud Eng",
  "description": "Cloud Eng",
  "created": "2017-02-24T20:21:23.145Z",
  "modified": "2019-05-24T20:36:04.312Z",
  "synced": "2020-02-18T05:30:20.414Z",
  "enabled": true,
  "requestable": true,
  "requestCommentsRequired": false,
  "owner": {
    "id": "ff8081815757d36a015757d42e56031e",
    "name": "SailPoint Support",
    "type": "IDENTITY",
    "email": "[email protected]"
  },
  "source": {
    "id": "ff8081815757d4fb0157588f3d9d008f",
    "name": "Employees"
  },
  "entitlements": [
    {
      "id": "2c918084575812550157589064f33b89",
      "name": "CN=Cloud Engineering,DC=sailpoint,DC=COM",
      "description": "mull",
      "attribute": "memberOf",
      "value": "CN=Cloud Engineering,DC=sailpoint,DC=COM"
    }
  ],
  "entitlementCount": 1,
  "tags": [
    "TAG_1",
    "TAG_2"
  ]
}

entitlement

Entitlement

{
  "id": "2c9180946ed0c43d016eec1a80892fbd",
  "name": "entitlement.aa415ae7",
  "description": "null",
  "attribute": "groups",
  "value": "entitlement.aa415ae7",
  "modified": "2019-12-09T19:19:50.154Z",
  "created": "2018-12-07T01:07:48Z",
  "synced": "2020-02-19T04:30:32.906Z",
  "displayName": "entitlement.aa415ae7",
  "source": {
    "id": "2c91808b6e9e6fb8016eec1a2b6f7b5f",
    "name": "ODS-HR-Employees"
  },
  "owner": {
    "type": "IDENTITY",
    "id": "2c9180858315595501831958427e5424",
    "name": "Addie Lee"
  },
  "privileged": false,
  "identityCount": 68,
  "tags": [
    "TAG_1",
    "TAG_2"
  ]
}

event

Event

{
  "id": "e092842f-c904-4b59-aac8-2544abeeef4b",
  "name": "Update Task Schedule Passed",
  "created": "2020-02-17T16:23:18.327Z",
  "synced": "2020-02-17T16:23:18.388Z",
  "action": "TASK_SCHEDULE_UPDATE_PASSED",
  "type": "SYSTEM_CONFIG",
  "actor": {
    "name": "MantisTaskScheduler"
  },
  "target": {
    "name": "Perform provisioning activity search delete synchronization"
  },
  "stack": "tpe",
  "trackingNumber": "c6b98bc39ece48b080826d16c76b166c",
  "ipAddress": "207.189.160.158",
  "details": "null",
  "attributes": {
    "sourceName": "SailPoint"
  },
  "objects": [
    "TASK",
    "SCHEDULE"
  ],
  "operation": "UPDATE",
  "status": "PASSED",
  "technicalName": "TASK_SCHEDULE_UPDATE_PASSED"
}

identity

Identity

{
  "id": "2c9180865c45e7e3015c46c434a80622",
  "name": "ad.admin",
  "firstName": "AD",
  "lastName": "Admin",
  "displayName": "AD Admin",
  "email": "[email protected]",
  "created": "2018-08-22T19:54:54.302Z",
  "modified": "2018-08-22T19:54:54.302Z",
  "synced": "2018-08-22T19:54:54.302Z",
  "phone": "512-942-7578",
  "inactive": false,
  "protected": false,
  "status": "UNREGISTERED",
  "employeeNumber": "O349804",
  "manager": null,
  "isManager": false,
  "identityProfile": {
    "id": "2c918085605c8d0601606f357cb231e6",
    "name": "E2E AD"
  },
  "source": {
    "id": "2c9180855c45b230015c46c19b9c0202",
    "name": "EndToEnd-ADSource"
  },
  "attributes": {
    "uid": "ad.admin",
    "firstname": "AD",
    "cloudAuthoritativeSource": "2c9180855c45b230015c46c19b9c0202",
    "cloudStatus": "UNREGISTERED",
    "iplanet-am-user-alias-list": null,
    "displayName": "AD Admin",
    "internalCloudStatus": "UNREGISTERED",
    "workPhone": "512-942-7578",
    "email": "[email protected]",
    "lastname": "Admin"
  },
  "processingState": null,
  "processingDetails": null,
  "accounts": [
    {
      "id": "2c9180865c45e7e3015c46c434a80623",
      "name": "ad.admin",
      "accountId": "CN=AD Admin,OU=slpt-automation,DC=TestAutomationAD,DC=local",
      "source": {
        "id": "2c9180855c45b230015c46c19b9c0202",
        "name": "EndToEnd-ADSource",
        "type": "Active Directory - Direct"
      },
      "disabled": false,
      "locked": false,
      "privileged": false,
      "manuallyCorrelated": false,
      "passwordLastSet": "2018-08-22T19:54:54.302Z",
      "entitlementAttributes": {
        "memberOf": [
          "CN=Group Policy Creator Owners,CN=Users,DC=TestAutomationAD,DC=local",
          "CN=Domain Guests,CN=Users,DC=TestAutomationAD,DC=local",
          "CN=Domain Admins,CN=Users,DC=TestAutomationAD,DC=local",
          "CN=Enterprise Admins,CN=Users,DC=TestAutomationAD,DC=local",
          "CN=Schema Admins,CN=Users,DC=TestAutomationAD,DC=local",
          "CN=Guests,CN=Builtin,DC=TestAutomationAD,DC=local",
          "CN=Administrators,CN=Builtin,DC=TestAutomationAD,DC=local"
        ]
      },
      "created": "2018-08-22T19:54:54.302Z"
    },
    {
      "id": "2c918083606d670c01606f35a30a0349",
      "name": "ad.admin",
      "accountId": "ad.admin",
      "source": {
        "id": "ff8081815c46b85b015c46b90c7c02a6",
        "name": "IdentityNow",
        "type": "IdentityNowConnector"
      },
      "disabled": false,
      "locked": false,
      "privileged": false,
      "manuallyCorrelated": false,
      "passwordLastSet": null,
      "entitlementAttributes": null,
      "created": "2018-08-22T19:54:54.302Z"
    }
  ],
  "accountCount": 2,
  "apps": [
    {
      "id": "22751",
      "name": "ADP Workforce Now",
      "source": {
        "id": "2c9180855c45b230015c46e2f6a8026a",
        "name": "Corporate Active Directory"
      },
      "account": {
        "id": "2c9180865c45efa4015c470be0de1606",
        "accountId": "CN=Bob Wilson,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com"
      }
    }
  ],
  "appCount": 1,
  "access": [
    {
      "id": "2c918083634bc6cb01639808d40270ba",
      "name": "test [AccessProfile-1527264105448]",
      "displayName": "test",
      "type": "ACCESS_PROFILE",
      "description": "test",
      "source": {
        "id": "2c9180855c45b230015c46c19b9c0202",
        "name": "EndToEnd-ADSource"
      },
      "owner": {
        "id": "2c9180865c45e7e3015c46c434a80622",
        "name": "ad.admin",
        "displayName": "AD Admin"
      }
    },
    {
      "id": "2c9180865c45e7e3015c46c457c50755",
      "name": "Administrators",
      "displayName": "Administrators",
      "type": "ENTITLEMENT",
      "description": null,
      "source": {
        "id": "2c9180855c45b230015c46c19b9c0202",
        "name": "EndToEnd-ADSource"
      },
      "privileged": false,
      "attribute": "memberOf",
      "value": "CN=Administrators,CN=Builtin,DC=TestAutomationAD,DC=local",
      "standalone": false
    },
    {
      "id": "2c9180865decdaa5015e06598b293108",
      "name": "test [cloudRole-1503345085223]",
      "displayName": "test",
      "type": "ROLE",
      "description": "test",
      "owner": {
        "id": "2c9180865c45e7e3015c46c5030707a0",
        "name": "will.albin",
        "displayName": "Albin Will"
      },
      "disabled": false
    }
  ],
  "accessCount": 3,
  "accessProfileCount": 1,
  "entitlementCount": 1,
  "roleCount": 1,
  "tags": [
    "TAG_1",
    "TAG_2"
  ]
}

role

Role

{
  "id": "2c91808c6faadea6016fb4f2bc69077b",
  "name": "IT Role",
  "description": "IT role",
  "created": "2020-01-17T19:20:15.040Z",
  "modified": null,
  "synced": "2020-02-18T05:30:20.145Z",
  "enabled": true,
  "requestable": false,
  "requestCommentsRequired": false,
  "owner": {
    "id": "2c9180a46faadee4016fb4e018c20639",
    "name": "Cloud Support",
    "type": "IDENTITY",
    "email": "[email protected]"
  },
  "accessProfiles": [
    {
      "id": "2c91809c6faade77016fb4f0b63407ae",
      "name": "Admin Access"
    }
  ],
  "accessProfileCount": 1,
  "segments": [
    {
      "id": "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde",
      "name": "segment-xyz",
      "description": "This segment represents xyz"
    }
  ],
  "segmentCount": 1,
  "entitlements": [
    {
      "id": "2c91809c6faade77016fb4f0b63407ae",
      "name": "Admin Access",
      "description": "Access to everything",
      "privileged": true,
      "hasPermissions": true
    }
  ],
  "entitlementCount": 1,
  "tags": [
    "TAG_1",
    "TAG_2"
  ]
}

400

Client Error - Returned if the request body is invalid.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages object[]
Generic localized reason for error
Array [
locale stringnullable
The locale for the message text, a BCP 47 language tag.
localeOrigin LocaleOriginnullable
Possible values: [DEFAULT, REQUEST, null]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
text string
Actual text of the error message in the indicated locale.
]
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
Array [
locale stringnullable
The locale for the message text, a BCP 47 language tag.
localeOrigin LocaleOriginnullable
Possible values: [DEFAULT, REQUEST, null]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
text string
Actual text of the error message in the indicated locale.
]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

401

Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.

application/json

Schema

Schema

error

A message describing the error

Example (from schema)

{
  "error": "JWT validation failed: JWT is expired"
}

403

Forbidden - Returned if the user you are running as, doesn't have access to this end-point.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages object[]
Generic localized reason for error
Array [
locale stringnullable
The locale for the message text, a BCP 47 language tag.
localeOrigin LocaleOriginnullable
Possible values: [DEFAULT, REQUEST, null]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
text string
Actual text of the error message in the indicated locale.
]
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
Array [
locale stringnullable
The locale for the message text, a BCP 47 language tag.
localeOrigin LocaleOriginnullable
Possible values: [DEFAULT, REQUEST, null]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
text string
Actual text of the error message in the indicated locale.
]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

403

An example of a 403 response object

{
  "detailCode": "403 Forbidden",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The server understood the request but refuses to authorize it."
    }
  ]
}

404

Not Found - returned if the request URL refers to a resource or object that does not exist

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages object[]
Generic localized reason for error
Array [
locale stringnullable
The locale for the message text, a BCP 47 language tag.
localeOrigin LocaleOriginnullable
Possible values: [DEFAULT, REQUEST, null]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
text string
Actual text of the error message in the indicated locale.
]
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
Array [
locale stringnullable
The locale for the message text, a BCP 47 language tag.
localeOrigin LocaleOriginnullable
Possible values: [DEFAULT, REQUEST, null]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
text string
Actual text of the error message in the indicated locale.
]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

404

An example of a 404 response object

{
  "detailCode": "404 Not found",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The server did not find a current representation for the target resource."
    }
  ]
}

429

Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.

application/json

Schema

Schema

message

A message describing the error

Example (from schema)

{
  "message": " Rate Limit Exceeded "
}

500

Internal Server Error - Returned if there is an unexpected error.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages object[]
Generic localized reason for error
Array [
locale stringnullable
The locale for the message text, a BCP 47 language tag.
localeOrigin LocaleOriginnullable
Possible values: [DEFAULT, REQUEST, null]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
text string
Actual text of the error message in the indicated locale.
]
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
Array [
locale stringnullable
The locale for the message text, a BCP 47 language tag.
localeOrigin LocaleOriginnullable
Possible values: [DEFAULT, REQUEST, null]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
text string
Actual text of the error message in the indicated locale.
]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

500

An example of a 500 response object

{
  "detailCode": "500.0 Internal Fault",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "An internal fault occurred."
    }
  ]
}

Loading...