Get an Account Activity
GET/account-activities/:id
This gets a single account activity by its id.
Request
Path Parameters
The account activity id
Responses
- 200
- 400
- 401
- 403
- 404
- 429
- 500
An account activity object
- application/json
- Schema
- Example (from schema)
Schema
- CloudAutomated
- IdentityAttributeUpdate
- appRequest
- LifecycleStateChange
- AccountStateUpdate
- AccountAttributeUpdate
- CloudPasswordRequest
- Attribute Synchronization Refresh
- Certification
- Identity Refresh
- Lifecycle Change Refresh
Array [
]
Id of the account activity
The name of the activity
When the activity was first created
When the activity was last modified
When the activity was completed
Possible values: [SUCCESS
, FAILURE
, INCOMPLETE
, PENDING
, null
]
The status after completion.
The type of action the activity performed. Please see the following list of types. This list may grow over time.
requesterIdentitySummary
object
nullable
ID of this identity summary
Human-readable display name of identity
ID of the identity that this summary represents
Indicates if all access items for this summary have been decided on
targetIdentitySummary
object
nullable
ID of this identity summary
Human-readable display name of identity
ID of the identity that this summary represents
Indicates if all access items for this summary have been decided on
A list of error messages, if any, that were encountered.
A list of warning messages, if any, that were encountered.
items
object[]
nullable
Individual actions performed as part of this account activity
Item id
Human-readable display name of item
Date and time item was requested
Possible values: [FINISHED
, REJECTED
, RETURNED
, EXPIRED
, PENDING
, CANCELED
, null
]
The state of an approval status
Possible values: [PENDING
, FINISHED
, UNVERIFIABLE
, COMMITED
, FAILED
, RETRY
]
Provisioning state of an account activity item
requesterComment
object
nullable
Id of the identity making the comment
Human-readable display name of the identity making the comment
Content of the comment
Date and time comment was made
reviewerIdentitySummary
object
nullable
ID of this identity summary
Human-readable display name of identity
ID of the identity that this summary represents
Indicates if all access items for this summary have been decided on
reviewerComment
object
nullable
Id of the identity making the comment
Human-readable display name of the identity making the comment
Content of the comment
Date and time comment was made
Possible values: [ADD
, CREATE
, MODIFY
, DELETE
, DISABLE
, ENABLE
, UNLOCK
, LOCK
, REMOVE
, SET
, null
]
Represents an operation in an account activity item
Attribute to which account activity applies
Value of attribute
Native identity in the target system to which the account activity applies
Id of Source to which account activity applies
accountRequestInfo
object
nullable
If an account activity item is associated with an access request, captures details of that request.
Id of requested object
Human-readable name of requested object
Possible values: [ACCESS_PROFILE
, ROLE
, ENTITLEMENT
]
The currently supported requestable object types.
clientMetadata
object
nullable
Arbitrary key-value pairs, if any were included in the corresponding access request item
The date the role or access profile or entitlement is no longer assigned to the specified identity.
Possible values: [EXECUTING
, VERIFYING
, TERMINATED
, COMPLETED
]
The current state of execution.
clientMetadata
object
nullable
Arbitrary key-value pairs, if any were included in the corresponding access request
{
"id": "2c9180835d2e5168015d32f890ca1581",
"name": "2c9180835d2e5168015d32f890ca1581",
"created": "2017-07-11T18:45:37.098Z",
"modified": "2018-06-25T20:22:28.104Z",
"completed": "2018-10-19T13:49:37.385Z",
"completionStatus": "SUCCESS",
"type": "appRequest",
"requesterIdentitySummary": {
"id": "ff80818155fe8c080155fe8d925b0316",
"name": "SailPoint Services",
"identityId": "c15b9f5cca5a4e9599eaa0e64fa921bd",
"completed": true
},
"targetIdentitySummary": {
"id": "ff80818155fe8c080155fe8d925b0316",
"name": "SailPoint Services",
"identityId": "c15b9f5cca5a4e9599eaa0e64fa921bd",
"completed": true
},
"errors": [
"sailpoint.connector.ConnectorException: java.lang.InterruptedException: Timeout waiting for response to message 0 from client 57a4ab97-ab3f-4aef-9fe2-0eaf15c73d26 after 60 seconds."
],
"warnings": [
"Some warning, another warning"
],
"items": [
{
"id": "48c545831b264409a81befcabb0e3c5a",
"name": "48c545831b264409a81befcabb0e3c5a",
"requested": "2017-07-11T18:45:37.098Z",
"approvalStatus": "PENDING",
"provisioningStatus": "PENDING",
"requesterComment": {
"commenterId": "2c918084660f45d6016617daa9210584",
"commenterName": "Adam Kennedy",
"body": "Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat.",
"date": "2017-07-11T18:45:37.098Z"
},
"reviewerIdentitySummary": {
"id": "ff80818155fe8c080155fe8d925b0316",
"name": "SailPoint Services",
"identityId": "c15b9f5cca5a4e9599eaa0e64fa921bd",
"completed": true
},
"reviewerComment": {
"commenterId": "2c918084660f45d6016617daa9210584",
"commenterName": "Adam Kennedy",
"body": "Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat.",
"date": "2017-07-11T18:45:37.098Z"
},
"operation": "ADD",
"attribute": "detectedRoles",
"value": "Treasury Analyst [AccessProfile-1529010191212]",
"nativeIdentity": "Sandie.Camero",
"sourceId": "2c91808363ef85290164000587130c0c",
"accountRequestInfo": {
"requestedObjectId": "2c91808563ef85690164001c31140c0c",
"requestedObjectName": "Treasury Analyst",
"requestedObjectType": "ACCESS_PROFILE"
},
"clientMetadata": {
"customKey1": "custom value 1",
"customKey2": "custom value 2"
},
"removeDate": "2020-07-11T00:00:00Z"
}
],
"executionStatus": "COMPLETED",
"clientMetadata": {
"customKey1": "custom value 1",
"customKey2": "custom value 2"
}
}
Client Error - Returned if the request body is invalid.
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Array [
]
Fine-grained error code providing more detail of the error.
Unique tracking id for the error.
messages
object[]
Generic localized reason for error
The locale for the message text, a BCP 47 language tag.
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.
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
The locale for the message text, a BCP 47 language tag.
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.
Actual text of the error message in the indicated locale.
{
"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."
}
]
}
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
- application/json
- Schema
- Example (from schema)
Schema
A message describing the error
{
"error": "JWT validation failed: JWT is expired"
}
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
- application/json
- Schema
- Example (from schema)
- 403
Schema
Array [
]
Array [
]
Fine-grained error code providing more detail of the error.
Unique tracking id for the error.
messages
object[]
Generic localized reason for error
The locale for the message text, a BCP 47 language tag.
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.
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
The locale for the message text, a BCP 47 language tag.
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.
Actual text of the error message in the indicated locale.
{
"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."
}
]
}
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."
}
]
}
Not Found - returned if the request URL refers to a resource or object that does not exist
- application/json
- Schema
- Example (from schema)
- 404
Schema
Array [
]
Array [
]
Fine-grained error code providing more detail of the error.
Unique tracking id for the error.
messages
object[]
Generic localized reason for error
The locale for the message text, a BCP 47 language tag.
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.
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
The locale for the message text, a BCP 47 language tag.
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.
Actual text of the error message in the indicated locale.
{
"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."
}
]
}
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."
}
]
}
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
- Example (from schema)
Schema
A message describing the error
{
"message": " Rate Limit Exceeded "
}
Internal Server Error - Returned if there is an unexpected error.
- application/json
- Schema
- Example (from schema)
- 500
Schema
Array [
]
Array [
]
Fine-grained error code providing more detail of the error.
Unique tracking id for the error.
messages
object[]
Generic localized reason for error
The locale for the message text, a BCP 47 language tag.
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.
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
The locale for the message text, a BCP 47 language tag.
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.
Actual text of the error message in the indicated locale.
{
"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."
}
]
}
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."
}
]
}