mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-07 12:27:47 +00:00
259 lines
198 KiB
Plaintext
259 lines
198 KiB
Plaintext
---
|
|
id: list-triggers
|
|
sidebar_label: List Triggers
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: {"operationId":"listTriggers","tags":["Triggers"],"description":"Gets a list of triggers that are available in the tenant.","parameters":[{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/docs/standard_collection_parameters.html) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/docs/standard_collection_parameters.html) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/docs/standard_collection_parameters.html) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"filters","required":false,"schema":{"type":"string"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/docs/standard_collection_parameters.html)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq*","example":"id eq \"idn:access-request-post-approval\""},{"in":"query","name":"sorters","required":false,"schema":{"type":"string","format":"comma-separated"},"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/docs/standard_collection_parameters.html)\n\nSorting is supported for the following fields:\n\n**id** **name**","example":"name"}],"responses":{"200":{"description":"List of triggers.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","required":["id","name","type","inputSchema","exampleInput"],"properties":{"id":{"type":"string","description":"Unique identifier of the trigger.","example":"idn:access-request-dynamic-approver"},"name":{"type":"string","description":"Trigger Name.","example":"Access Request Dynamic Approver"},"type":{"example":"REQUEST_RESPONSE","type":"string","description":"The type of trigger.","enum":["REQUEST_RESPONSE","FIRE_AND_FORGET"]},"description":{"type":"string","description":"Trigger Description.","example":"Trigger for getting a dynamic approver."},"inputSchema":{"type":"string","description":"The JSON schema of the payload that will be sent by the trigger to the subscribed service.","example":"{\"definitions\":{\"record:AccessRequestDynamicApproverInput\":{\"type\":\"object\",\"required\":[\"accessRequestId\",\"requestedFor\",\"requestedItems\",\"requestedBy\"],\"additionalProperties\":true,\"properties\":{\"accessRequestId\":{\"type\":\"string\"},\"requestedFor\":{\"$ref\":\"#/definitions/record:requestedForIdentityRef\"},\"requestedItems\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/record:requestedObjectRef\"}},\"requestedBy\":{\"$ref\":\"#/definitions/record:requestedByIdentityRef\"}}},\"record:requestedForIdentityRef\":{\"type\":\"object\",\"required\":[\"id\",\"name\",\"type\"],\"additionalProperties\":true,\"properties\":{\"id\":{\"type\":\"string\"},\"name\":{\"type\":\"string\"},\"type\":{\"type\":\"string\"}}},\"record:requestedObjectRef\":{\"type\":\"object\",\"optional\":[\"description\",\"comment\"],\"required\":[\"id\",\"name\",\"type\",\"operation\"],\"additionalProperties\":true,\"properties\":{\"id\":{\"type\":\"string\"},\"name\":{\"type\":\"string\"},\"description\":{\"oneOf\":[{\"type\":\"null\"},{\"type\":\"string\"}]},\"type\":{\"type\":\"string\"},\"operation\":{\"type\":\"string\"},\"comment\":{\"oneOf\":[{\"type\":\"null\"},{\"type\":\"string\"}]}}},\"record:requestedByIdentityRef\":{\"type\":\"object\",\"required\":[\"type\",\"id\",\"name\"],\"additionalProperties\":true,\"properties\":{\"type\":{\"type\":\"string\"},\"id\":{\"type\":\"string\"},\"name\":{\"type\":\"string\"}}}},\"$ref\":\"#/definitions/record:AccessRequestDynamicApproverInput\"}"},"exampleInput":{"description":"An example of the JSON payload that will be sent by the trigger to the subscribed service.","oneOf":[{"title":"Access Request Dynamic Approver","type":"object","required":["accessRequestId","requestedFor","requestedItems","requestedBy"],"properties":{"accessRequestId":{"type":"string","description":"The unique ID of the access request object. Can be used with the [access request status endpoint](https://developer.sailpoint.com/apis/beta/#operation/listAccessRequestStatus) to get the status of the request.\n","example":"4b4d982dddff4267ab12f0f1e72b5a6d"},"requestedFor":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["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_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"The identity for whom the access is requested for.","properties":{"type":{"enum":["IDENTITY"],"example":"IDENTITY","description":"The type of object that is referenced"}}},"requestedItems":{"description":"The access items that are being requested.","type":"array","items":{"type":"object","required":["id","name","type","operation"],"properties":{"id":{"type":"string","description":"The unique ID of the access item.","example":"2c91808b6ef1d43e016efba0ce470904"},"name":{"type":"string","description":"Human friendly name of the access item.","example":"Engineering Access"},"description":{"nullable":true,"type":"string","description":"Extended description of the access item.","example":"Engineering Access"},"type":{"enum":["ACCESS_PROFILE","ROLE","ENTITLEMENT"],"description":"The type of access item being requested.","example":"ACCESS_PROFILE"},"operation":{"enum":["Add","Remove"],"description":"Grant or revoke the access item","example":"Add"},"comment":{"nullable":true,"type":"string","description":"A comment from the requestor on why the access is needed.","example":"William needs this access for his day to day job activities."}}}},"requestedBy":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["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_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"The identity that initiated the access request.","properties":{"type":{"enum":["IDENTITY"],"example":"IDENTITY","description":"The type of object that is referenced"}}}}},{"title":"Access Request Post Approval","type":"object","required":["accessRequestId","requestedFor","requestedItemsStatus","requestedBy"],"properties":{"accessRequestId":{"type":"string","description":"The unique ID of the access request.","example":"2c91808b6ef1d43e016efba0ce470904"},"requestedFor":{"required":["id","type","name"],"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["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_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"The identity who the access request is for.","properties":{"type":{"enum":["IDENTITY"],"example":"IDENTITY","description":"The type of object that is referenced"}}},"requestedItemsStatus":{"description":"Details on the outcome of each access item.","type":"array","items":{"type":"object","required":["id","name","type","operation","approvalInfo"],"properties":{"id":{"type":"string","description":"The unique ID of the access item being requested.","example":"2c91808b6ef1d43e016efba0ce470904"},"name":{"type":"string","description":"The human friendly name of the access item.","example":"Engineering Access"},"description":{"nullable":true,"type":"string","description":"Detailed description of the access item.","example":"Access to engineering database"},"type":{"enum":["ACCESS_PROFILE","ROLE","ENTITLEMENT"],"description":"The type of access item.","example":"ACCESS_PROFILE"},"operation":{"enum":["Add","Remove"],"description":"The action to perform on the access item.","example":"Add"},"comment":{"nullable":true,"type":"string","description":"A comment from the identity requesting the access.","example":"William needs this access to do his job."},"clientMetadata":{"description":"Additional customer defined metadata about the access item.","nullable":true,"type":"object","additionalProperties":true,"example":{"applicationName":"My application"}},"approvalInfo":{"description":"A list of one or more approvers for the access request.","type":"array","items":{"type":"object","required":["approvalDecision","approverName","approver"],"properties":{"approvalComment":{"nullable":true,"type":"string","description":"A comment left by the approver.","example":"This access looks good. Approved."},"approvalDecision":{"enum":["APPROVED","DENIED"],"description":"The final decision of the approver.","example":"APPROVED"},"approverName":{"type":"string","description":"The name of the approver","example":"Stephen.Austin"},"approver":{"required":["id","type","name"],"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["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_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"The identity of the approver.","properties":{"type":{"enum":["IDENTITY"],"example":"IDENTITY","description":"The type of object that is referenced"}}}}}}}}},"requestedBy":{"required":["id","type","name"],"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["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_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"The identity that initiated the access request.","properties":{"type":{"enum":["IDENTITY"],"example":"IDENTITY","description":"The type of object that is referenced"}}}}},{"title":"Access Request Pre Approval","type":"object","required":["accessRequestId","requestedFor","requestedItems","requestedBy"],"properties":{"accessRequestId":{"type":"string","description":"The unique ID of the access request.","example":"2c91808b6ef1d43e016efba0ce470904"},"requestedFor":{"required":["id","type","name"],"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["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_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"The identity who the access request is for.","properties":{"type":{"enum":["IDENTITY"],"example":"IDENTITY","description":"The type of object that is referenced"}}},"requestedItems":{"description":"Details of the access items being requested.","type":"array","items":{"type":"object","required":["id","name","type","operation"],"properties":{"id":{"type":"string","description":"The unique ID of the access item being requested.","example":"2c91808b6ef1d43e016efba0ce470904"},"name":{"type":"string","description":"The human friendly name of the access item.","example":"Engineering Access"},"description":{"nullable":true,"type":"string","description":"Detailed description of the access item.","example":"Access to engineering database"},"type":{"enum":["ACCESS_PROFILE","ROLE","ENTITLEMENT"],"description":"The type of access item.","example":"ACCESS_PROFILE"},"operation":{"enum":["Add","Remove"],"description":"The action to perform on the access item.","example":"Add"},"comment":{"nullable":true,"type":"string","description":"A comment from the identity requesting the access.","example":"William needs this access to do his job."}}}},"requestedBy":{"required":["id","type","name"],"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["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_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"The identity that initiated the access request.","properties":{"type":{"enum":["IDENTITY"],"example":"IDENTITY","description":"The type of object that is referenced"}}}}},{"title":"Account Aggregation Completed","type":"object","required":["source","status","started","completed","errors","warnings","stats"],"properties":{"source":{"required":["type","name","id"],"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["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_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"The source from which the accounts were aggregated.","properties":{"type":{"enum":["SOURCE"],"description":"The type of object that is referenced","example":"SOURCE"}}},"status":{"description":"The overall status of the aggregation.","enum":["Success","Failed","Terminated"],"example":"Success"},"started":{"type":"string","format":"date-time","description":"The date and time when the account aggregation started.","example":"2020-06-29T22:01:50.474Z"},"completed":{"type":"string","format":"date-time","description":"The date and time when the account aggregation finished.","example":"2020-06-29T22:02:04.090Z"},"errors":{"nullable":true,"description":"A list of errors that occurred during the aggregation.","type":"array","items":{"type":"string","description":"A descriptive error message.","example":"Accounts unable to be aggregated."}},"warnings":{"nullable":true,"description":"A list of warnings that occurred during the aggregation.","type":"array","items":{"type":"string","description":"A descriptive warning message.","example":"Account Skipped"}},"stats":{"type":"object","description":"Overall statistics about the account aggregation.","required":["scanned","unchanged","changed","added","removed"],"properties":{"scanned":{"type":"integer","format":"int32","minimum":0,"maximum":2147483647,"description":"The number of accounts which were scanned / iterated over.","example":200},"unchanged":{"type":"integer","format":"int32","minimum":0,"maximum":2147483647,"description":"The number of accounts which existed before, but had no changes.","example":190},"changed":{"type":"integer","format":"int32","minimum":0,"maximum":2147483647,"description":"The number of accounts which existed before, but had changes.","example":6},"added":{"type":"integer","format":"int32","minimum":0,"maximum":2147483647,"description":"The number of accounts which are new - have not existed before.","example":4},"removed":{"type":"integer","minimum":0,"maximum":2147483647,"format":"int32","description":"The number accounts which existed before, but no longer exist (thus getting removed).","example":3}}}}},{"title":"Account Attributes Changed","type":"object","required":["identity","source","account","changes"],"properties":{"identity":{"required":["id","type","name"],"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["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_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"The identity whose account attributes changed.","properties":{"type":{"enum":["IDENTITY"],"example":"IDENTITY","description":"The type of object that is referenced"}}},"source":{"required":["id","type","name"],"type":"object","description":"The source that contains the account.","properties":{"id":{"description":"ID of the object to which this reference applies","type":"string","example":"4e4d982dddff4267ab12f0f1e72b5a6d"},"type":{"type":"string","enum":["SOURCE"],"example":"SOURCE","description":"The type of object that is referenced"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"Corporate Active Directory"}}},"account":{"type":"object","description":"Details of the account where the attributes changed.","required":["id","uuid","name","nativeIdentity","type"],"properties":{"id":{"type":"string","description":"SailPoint generated unique identifier.","example":"52170a74-ca89-11ea-87d0-0242ac130003"},"uuid":{"nullable":true,"type":"string","description":"The source's unique identifier for the account. UUID is generated by the source system.","example":"1cb1f07d-3e5a-4431-becd-234fa4306108"},"name":{"type":"string","description":"Name of the account.","example":"john.doe"},"nativeIdentity":{"type":"string","description":"Unique ID of the account on the source.","example":"cn=john.doe,ou=users,dc=acme,dc=com"},"type":{"enum":["ACCOUNT"],"description":"The type of the account","example":"ACCOUNT"}}},"changes":{"type":"array","description":"A list of attributes that changed.","items":{"type":"object","required":["attribute","oldValue","newValue"],"properties":{"attribute":{"type":"string","description":"The name of the attribute.","example":"sn"},"oldValue":{"description":"The previous value of the attribute.","nullable":true,"oneOf":[{"type":"string"},{"type":"boolean"},{"type":"array","items":{"nullable":true,"type":"string"}}],"example":"doe"},"newValue":{"description":"The new value of the attribute.","nullable":true,"oneOf":[{"type":"string"},{"type":"boolean"},{"type":"array","items":{"nullable":true,"type":"string"}}],"example":"ryans"}}}}}},{"title":"Account Correlated","type":"object","required":["identity","source","account","attributes"],"properties":{"identity":{"required":["type","name","id"],"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["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_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"The identity that the account correlated with.","properties":{"type":{"enum":["IDENTITY"],"description":"The type of object that is referenced","example":"IDENTITY"}}},"source":{"required":["id","type","name"],"type":"object","description":"The source from which the account came from.","properties":{"id":{"description":"ID of the object to which this reference applies","type":"string","example":"4e4d982dddff4267ab12f0f1e72b5a6d"},"type":{"type":"string","enum":["SOURCE"],"example":"SOURCE","description":"The type of object that is referenced"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"Corporate Active Directory"}}},"account":{"required":["id","name","nativeIdentity","type"],"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["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_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"The account that was correlated.","properties":{"type":{"enum":["ACCOUNT"],"description":"The type of object that is referenced","example":"ACCOUNT"},"nativeIdentity":{"type":"string","description":"Unique ID of the account on the source.","example":"cn=john.doe,ou=users,dc=acme,dc=com"},"uuid":{"nullable":true,"type":"string","description":"The source's unique identifier for the account. UUID is generated by the source system.","example":"1cb1f07d-3e5a-4431-becd-234fa4306108"}}},"attributes":{"type":"object","description":"The attributes associated with the account. Attributes are unique per source.","additionalProperties":true,"example":{"sn":"doe","givenName":"john","memberOf":["cn=g1,ou=groups,dc=acme,dc=com","cn=g2,ou=groups,dc=acme,dc=com","cn=g3,ou=groups,dc=acme,dc=com"]}},"entitlementCount":{"type":"integer","format":"int32","description":"The number of entitlements associated with this account.","example":0}}},{"title":"Accounts Collected for Aggregation","type":"object","required":["source","status","started","completed","errors","warnings","stats"],"properties":{"source":{"required":["id","type","name"],"type":"object","description":"Reference to the source that has been aggregated.","properties":{"id":{"description":"ID of the object to which this reference applies","type":"string","example":"4e4d982dddff4267ab12f0f1e72b5a6d"},"type":{"type":"string","enum":["SOURCE"],"example":"SOURCE","description":"The type of object that is referenced"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"Corporate Active Directory"}}},"status":{"description":"The overall status of the collection.","enum":["Success","Failed","Terminated"],"example":"Success"},"started":{"type":"string","format":"date-time","description":"The date and time when the account collection started.","example":"2020-06-29T22:01:50.474Z"},"completed":{"type":"string","format":"date-time","description":"The date and time when the account collection finished.","example":"2020-06-29T22:02:04.090Z"},"errors":{"nullable":true,"description":"A list of errors that occurred during the collection.","type":"array","items":{"type":"string","description":"A descriptive error message.","example":"Unable to collect accounts for aggregation."}},"warnings":{"nullable":true,"description":"A list of warnings that occurred during the collection.","type":"array","items":{"type":"string","description":"A descriptive warning message.","example":"Account Skipped"}},"stats":{"type":"object","description":"Overall statistics about the account collection.","required":["scanned","unchanged","changed","added","removed"],"properties":{"scanned":{"type":"integer","format":"int32","minimum":0,"maximum":2147483647,"description":"The number of accounts which were scanned / iterated over.","example":200},"unchanged":{"type":"integer","format":"int32","minimum":0,"maximum":2147483647,"description":"The number of accounts which existed before, but had no changes.","example":190},"changed":{"type":"integer","format":"int32","minimum":0,"maximum":2147483647,"description":"The number of accounts which existed before, but had changes.","example":6},"added":{"type":"integer","format":"int32","minimum":0,"maximum":2147483647,"description":"The number of accounts which are new - have not existed before.","example":4},"removed":{"type":"integer","minimum":0,"maximum":2147483647,"format":"int32","description":"The number accounts which existed before, but no longer exist (thus getting removed).","example":3}}}}},{"title":"Account Uncorrelated","type":"object","required":["identity","source","account"],"properties":{"identity":{"required":["type","name","id"],"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["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_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"The identity that the account uncorrelated with.","properties":{"type":{"enum":["IDENTITY"],"description":"The type of object that is referenced","example":"IDENTITY"}}},"source":{"required":["type","name","id"],"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["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_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"The source from which the account came from.","properties":{"type":{"enum":["SOURCE"],"description":"The type of object that is referenced","example":"SOURCE"}}},"account":{"required":["id","name","nativeIdentity","type"],"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["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_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"The account that was uncorrelated.","properties":{"type":{"enum":["ACCOUNT"],"description":"The type of object that is referenced","example":"ACCOUNT"},"nativeIdentity":{"type":"string","description":"Unique ID of the account on the source.","example":"cn=john.doe,ou=users,dc=acme,dc=com"},"uuid":{"nullable":true,"type":"string","description":"The source's unique identifier for the account. UUID is generated by the source system.","example":"1cb1f07d-3e5a-4431-becd-234fa4306108"}}},"entitlementCount":{"type":"integer","format":"int32","description":"The number of entitlements associated with this account.","example":0}}},{"title":"Campaign Activated","type":"object","required":["campaign"],"properties":{"campaign":{"type":"object","description":"Details about the certification campaign that was activated.","required":["id","name","description","created","deadline","type","campaignOwner","status"],"properties":{"id":{"type":"string","description":"Unique ID for the campaign.","example":"2c91808576f886190176f88cac5a0010"},"name":{"type":"string","description":"The human friendly name of the campaign.","example":"Manager Access Campaign"},"description":{"type":"string","description":"Extended description of the campaign.","example":"Audit access for all employees."},"created":{"type":"string","format":"date-time","description":"The date and time the campaign was created.","example":"2021-02-16T03:04:45.815Z"},"modified":{"nullable":true,"type":"string","format":"date-time","description":"The date and time the campaign was last modified.","example":"2021-02-16T03:06:45.815Z"},"deadline":{"type":"string","format":"date-time","description":"The date and time the campaign is due.","example":"2021-03-16T03:04:45.815Z"},"type":{"description":"The type of campaign.","enum":["MANAGER","SOURCE_OWNER","SEARCH","ROLE_COMPOSITION"],"example":"MANAGER"},"campaignOwner":{"type":"object","description":"Details of the identity that owns the campaign.","required":["id","displayName","email"],"properties":{"id":{"type":"string","description":"The unique ID of the identity.","example":"37f080867702c1910177031320c40n27"},"displayName":{"type":"string","description":"The human friendly name of the identity.","example":"John Snow"},"email":{"type":"string","description":"The primary email address of the identity.","example":"john.snow@example.com"}}},"status":{"enum":["ACTIVE"],"description":"The current status of the campaign.","example":"ACTIVE"}}}}},{"title":"Campaign Ended","type":"object","required":["campaign"],"properties":{"campaign":{"type":"object","description":"Details about the certification campaign that ended.","required":["id","name","description","created","deadline","type","campaignOwner","status"],"properties":{"id":{"type":"string","description":"Unique ID for the campaign.","example":"2c91808576f886190176f88cac5a0010"},"name":{"type":"string","description":"The human friendly name of the campaign.","example":"Manager Access Campaign"},"description":{"type":"string","description":"Extended description of the campaign.","example":"Audit access for all employees."},"created":{"type":"string","format":"date-time","description":"The date and time the campaign was created.","example":"2021-02-16T03:04:45.815Z"},"modified":{"nullable":true,"type":"string","format":"date-time","description":"The date and time the campaign was last modified.","example":"2021-03-16T03:06:45.815Z"},"deadline":{"type":"string","format":"date-time","description":"The date and time the campaign is due.","example":"2021-03-16T03:04:45.815Z"},"type":{"description":"The type of campaign.","enum":["MANAGER","SOURCE_OWNER","SEARCH","ROLE_COMPOSITION"],"example":"MANAGER"},"campaignOwner":{"type":"object","description":"Details of the identity that owns the campaign.","required":["id","displayName","email"],"properties":{"id":{"type":"string","description":"The unique ID of the identity.","example":"37f080867702c1910177031320c40n27"},"displayName":{"type":"string","description":"The human friendly name of the identity.","example":"John Snow"},"email":{"type":"string","description":"The primary email address of the identity.","example":"john.snow@example.com"}}},"status":{"enum":["COMPLETED"],"description":"The current status of the campaign.","example":"COMPLETED"}}}}},{"title":"Campaign Generated","type":"object","required":["campaign"],"properties":{"campaign":{"description":"Details about the campaign that was generated.","type":"object","required":["id","name","description","created","type","campaignOwner","status"],"properties":{"id":{"type":"string","description":"The unique ID of the campaign.","example":"2c91808576f886190176f88cac5a0010"},"name":{"type":"string","description":"Human friendly name of the campaign.","example":"Manager Access Campaign"},"description":{"type":"string","description":"Extended description of the campaign.","example":"Audit access for all employees."},"created":{"type":"string","format":"date-time","description":"The date and time the campaign was created.","example":"2021-02-16T03:04:45.815Z"},"modified":{"nullable":true,"type":"string","description":"The date and time the campaign was last modified.","example":"2021-02-17T03:04:45.815Z"},"deadline":{"nullable":true,"type":"string","description":"The date and time when the campaign must be finished by.","example":"2021-02-18T03:04:45.815Z"},"type":{"enum":["MANAGER","SOURCE_OWNER","SEARCH","ROLE_COMPOSITION"],"description":"The type of campaign that was generated.","example":"MANAGER"},"campaignOwner":{"type":"object","description":"The identity that owns the campaign.","required":["id","displayName","email"],"properties":{"id":{"type":"string","description":"The unique ID of the identity.","example":"37f080867702c1910177031320c40n27"},"displayName":{"type":"string","description":"The display name of the identity.","example":"John Snow"},"email":{"type":"string","description":"The primary email address of the identity.","example":"john.snow@example.com"}}},"status":{"enum":["STAGED","ACTIVATING","ACTIVE"],"description":"The current status of the campaign.","example":"STAGED"}}}}},{"title":"Certification Signed Off","type":"object","required":["certification"],"properties":{"certification":{"description":"The certification campaign that was signed off on.","required":["id","name","created"],"allOf":[{"type":"object","required":["campaignRef","completed","decisionsMade","decisionsTotal","due","signed","reviewer","campaignOwner","hasErrors","phase","entitiesCompleted","entitiesTotal"],"properties":{"campaignRef":{"type":"object","required":["id","name","type","campaignType","description"],"properties":{"id":{"type":"string","description":"The unique ID of the campaign.","example":"ef38f94347e94562b5bb8424a56397d8"},"name":{"type":"string","description":"The name of the campaign.","example":"Campaign Name"},"type":{"type":"string","enum":["CAMPAIGN"],"description":"The type of object that is being referenced.","example":"CAMPAIGN"},"campaignType":{"type":"string","enum":["MANAGER","SOURCE_OWNER","SEARCH"],"description":"The type of the campaign.","example":"MANAGER"},"description":{"type":"string","description":"The description of the campaign set by the admin who created it.","nullable":true,"example":"A description of the campaign"}}},"phase":{"type":"string","description":"The current phase of the campaign.\n* `STAGED`: The campaign is waiting to be activated.\n* `ACTIVE`: The campaign is active.\n* `SIGNED`: The reviewer has signed off on the campaign, and it is considered complete.\n","enum":["STAGED","ACTIVE","SIGNED"],"example":"ACTIVE"},"due":{"type":"string","format":"date-time","description":"The due date of the certification.","example":"2018-10-19T13:49:37.385Z"},"signed":{"type":"string","format":"date-time","description":"The date the reviewer signed off on the certification.","example":"2018-10-19T13:49:37.385Z"},"reviewer":{"description":"A reference to the reviewer of the campaign.","type":"object","required":["type","id","name"],"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["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_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"properties":{"type":{"description":"The type of object that the reviewer is.","enum":["IDENTITY","GOVERNANCE_GROUP"],"example":"IDENTITY"},"email":{"type":"string","nullable":true,"description":"The email of the reviewing identity. Only applicable to `IDENTITY`","example":"reviewer@test.com"}}},"reassignment":{"nullable":true,"description":"A reference to a reviewer that this campaign has been reassigned to.","type":"object","properties":{"from":{"description":"The previous certification","type":"object","allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["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_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},{"type":"object","properties":{"reviewer":{"description":"Certification reviewer","type":"object","required":["type","id","name"],"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["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_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"properties":{"type":{"description":"The type of object that the reviewer is.","enum":["IDENTITY","GOVERNANCE_GROUP"],"example":"IDENTITY"},"email":{"type":"string","nullable":true,"description":"The email of the reviewing identity. Only applicable to `IDENTITY`","example":"reviewer@test.com"}}}}}],"properties":{"type":{"description":"The type of object that the reviewer is.","enum":["CERTIFICATION"],"example":"CERTIFICATION"}},"example":{"reviewer":{"email":"reviewer@test.com","type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"William Wilson"},"type":"CERTIFICATION","id":"2c9180867921dd73017923ddd8d203ba","name":"Identity Access Review for William Wilson"}},"comment":{"type":"string","description":"Comments from the previous reviewer.","example":"Please review"}}},"hasErrors":{"type":"boolean","example":false,"description":"Indicates it the certification has any errors."},"errorMessage":{"type":"string","nullable":true,"example":"The certification has an error","description":"A message indicating what the error is."},"completed":{"type":"boolean","description":"Indicates if all certification decisions have been made.","example":false},"decisionsMade":{"type":"integer","description":"The number of approve/revoke/acknowledge decisions that have been made by the reviewer.","example":20,"format":"int32"},"decisionsTotal":{"type":"integer","description":"The total number of approve/revoke/acknowledge decisions for the certification.","example":40,"format":"int32"},"entitiesCompleted":{"type":"integer","description":"The number of entities (identities, access profiles, roles, etc.) for which all decisions have been made and are complete.","example":5,"format":"int32"},"entitiesTotal":{"type":"integer","format":"int32","description":"The total number of entities (identities, access profiles, roles, etc.) in the certification, both complete and incomplete.","example":10}}}],"properties":{"id":{"type":"string","description":"Unique ID of the certification.","example":"2c91808576f886190176f88caf0d0067"},"name":{"type":"string","description":"The name of the certification.","example":"Manager Access Review for Alice Baker"},"created":{"type":"string","format":"date-time","description":"The date and time the certification was created.","example":"2020-02-16T03:04:45.815Z"},"modified":{"nullable":true,"type":"string","format":"date-time","description":"The date and time the certification was last modified.","example":"2020-02-16T03:06:45.815Z"}}}}},{"title":"Identity Attributes Changed","type":"object","required":["identity","changes"],"properties":{"identity":{"required":["id","type","name"],"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["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_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"The identity who's attributes changed.","properties":{"type":{"enum":["IDENTITY"],"example":"IDENTITY","description":"The type of object that is referenced"}}},"changes":{"description":"A list of one or more identity attributes that changed on the identity.","type":"array","items":{"type":"object","required":["attribute"],"properties":{"attribute":{"type":"string","description":"The name of the identity attribute that changed.","example":"department"},"oldValue":{"description":"The value of the identity attribute before it changed.","nullable":true,"example":"sales","oneOf":[{"type":"string"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"object","nullable":true,"additionalProperties":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"integer"},{"type":"boolean"}]}}]},"newValue":{"description":"The value of the identity attribute after it changed.","example":"marketing","oneOf":[{"type":"string"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"object","nullable":true,"additionalProperties":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"integer"},{"type":"boolean"}]}}]}}}}}},{"title":"Identity Created","type":"object","required":["identity","attributes"],"properties":{"identity":{"required":["id","type","name"],"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["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_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"The identity that was created.","properties":{"type":{"enum":["IDENTITY"],"example":"IDENTITY","description":"The type of object that is referenced"}}},"attributes":{"type":"object","description":"The attributes assigned to the identity. Attributes are determined by the identity profile.","additionalProperties":true,"example":{"firstname":"John"}}}},{"title":"Identity Deleted","type":"object","required":["identity","attributes"],"properties":{"identity":{"required":["id","type","name"],"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["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_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"The identity that was deleted.","properties":{"type":{"enum":["IDENTITY"],"example":"IDENTITY","description":"The type of object that is referenced"}}},"attributes":{"type":"object","description":"The attributes assigned to the identity. Attributes are determined by the identity profile.","additionalProperties":true,"example":{"firstname":"John"}}}},{"title":"Provisioning Completed","type":"object","required":["trackingNumber","sources","recipient","accountRequests"],"properties":{"trackingNumber":{"type":"string","description":"The reference number of the provisioning request. Useful for tracking status in the Account Activity search interface.","example":"4b4d982dddff4267ab12f0f1e72b5a6d"},"sources":{"type":"string","description":"One or more sources that the provisioning transaction(s) were done against. Sources are comma separated.","example":"Corp AD, Corp LDAP, Corp Salesforce"},"action":{"nullable":true,"type":"string","description":"Origin of where the provisioning request came from.","example":"IdentityRefresh"},"errors":{"nullable":true,"description":"A list of any accumulated error messages that occurred during provisioning.","type":"array","items":{"type":"string","example":"Connector AD Failed"}},"warnings":{"nullable":true,"description":"A list of any accumulated warning messages that occurred during provisioning.","type":"array","items":{"type":"string","example":"Notification Skipped due to invalid email"}},"recipient":{"required":["id","type","name"],"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["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_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"Reference to the identity who is the target of the provisioning request.","properties":{"type":{"enum":["IDENTITY"],"example":"IDENTITY","description":"The type of object that is referenced"}}},"requester":{"nullable":true,"required":["id","type","name"],"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["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_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"Reference to the identity (if any) who submitted the provisioning request.","properties":{"type":{"enum":["IDENTITY"],"example":"IDENTITY","description":"The type of object that is referenced"}}},"accountRequests":{"type":"array","description":"A list of provisioning instructions to perform on an account-by-account basis.","items":{"type":"object","required":["source","accountOperation","provisioningResult","provisioningTarget"],"properties":{"source":{"required":["id","type","name"],"type":"object","description":"Reference to the source being provisioned against.","properties":{"id":{"description":"ID of the object to which this reference applies","type":"string","example":"4e4d982dddff4267ab12f0f1e72b5a6d"},"type":{"type":"string","enum":["SOURCE"],"example":"SOURCE","description":"The type of object that is referenced"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"Corporate Active Directory"}}},"accountId":{"type":"string","description":"The unique idenfier of the account being provisioned.","example":"CN=Chewy.Bacca,ou=hardcorefigter,ou=wookies,dc=starwars,dc=com"},"accountOperation":{"type":"string","description":"The provisioning operation; typically Create, Modify, Enable, Disable, Unlock, or Delete.","example":"Modify"},"provisioningResult":{"description":"The overall result of the provisioning transaction; this could be success, pending, failed, etc.","enum":["SUCCESS","PENDING","FAILED"],"example":"SUCCESS"},"provisioningTarget":{"type":"string","description":"The name of the provisioning channel selected; this could be the same as the source, or could be a Service Desk Integration Module (SDIM).","example":"Corp AD"},"ticketId":{"nullable":true,"type":"string","description":"A reference to a tracking number, if this is sent to a Service Desk Integration Module (SDIM).","example":"72619262"},"attributeRequests":{"nullable":true,"description":"A list of attributes as part of the provisioning transaction.","type":"array","items":{"type":"object","required":["attributeName","operation"],"properties":{"attributeName":{"type":"string","description":"The name of the attribute being provisioned.","example":"memberOf"},"attributeValue":{"nullable":true,"type":"string","description":"The value of the attribute being provisioned.","example":"CN=jedi,DC=starwars,DC=com"},"operation":{"enum":["Add","Set","Remove"],"description":"The operation to handle the attribute.","example":"Add"}}}}}}}}},{"title":"Saved Search Complete","type":"object","required":["fileName","ownerEmail","ownerName","query","searchName","searchResults","signedS3Url"],"properties":{"fileName":{"type":"string","description":"A name for the report file.","example":"Modified.zip"},"ownerEmail":{"type":"string","description":"The email address of the identity that owns the saved search.","example":"test@sailpoint.com"},"ownerName":{"type":"string","description":"The name of the identity that owns the saved search.","example":"Cloud Support"},"query":{"type":"string","description":"The search query that was used to generate the report.","example":"modified:[now-7y/d TO now]"},"searchName":{"type":"string","description":"The name of the saved search.","example":"Modified Activity"},"searchResults":{"type":"object","description":"A preview of the search results for each object type. This includes a count as well as headers, and the first several rows of data, per object type.","properties":{"Account":{"description":"A table of accounts that match the search criteria.","nullable":true,"type":"object","required":["count","noun","preview"],"properties":{"count":{"type":"string","description":"The number of rows in the table.","example":3},"noun":{"type":"string","description":"The type of object represented in the table.","example":"accounts"},"preview":{"description":"A sample of the data in the table.","type":"array","items":{"type":"array","items":{"type":"string","example":"Robert.Chase"},"example":[]}}}},"Entitlement":{"description":"A table of entitlements that match the search criteria.","nullable":true,"type":"object","required":["count","noun","preview"],"properties":{"count":{"type":"string","description":"The number of rows in the table.","example":2},"noun":{"type":"string","description":"The type of object represented in the table.","example":"entitlements"},"preview":{"description":"A sample of the data in the table.","type":"array","items":{"type":"array","items":{"type":"string","example":"Administrator"},"example":[]}}}},"Identity":{"description":"A table of identities that match the search criteria.","nullable":true,"type":"object","required":["count","noun","preview"],"properties":{"count":{"type":"string","description":"The number of rows in the table.","example":2},"noun":{"type":"string","description":"The type of object represented in the table.","example":"identities"},"preview":{"description":"A sample of the data in the table.","type":"array","items":{"type":"array","items":{"type":"string","example":"Carol Shelby"},"example":[]}}}}}},"signedS3Url":{"type":"string","description":"The Amazon S3 URL to download the report from.","example":"https://sptcbu-org-data-useast1.s3.amazonaws.com/arsenal-john/reports/Events%20Export.2020-05-06%2018%2759%20GMT.3e580592-86e4-4953-8aea-49e6ef20a086.zip?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20200506T185919Z&X-Amz-SignedHeaders=host&X-Amz-Expires=899&X-Amz-Credential=AKIAV5E54XOGTS4Q4L7A%2F20200506%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=2e732bb97a12a1fd8a215613e3c31fcdae8ba1fb6a25916843ab5b51d2ddefbc"}}},{"type":"object","required":["id","nativeIdentifier","sourceId","sourceName","identityId","identityName","attributes"],"properties":{"uuid":{"type":"string","description":"Source unique identifier for the identity. UUID is generated by the source system.","example":"b7264868-7201-415f-9118-b581d431c688"},"id":{"type":"string","description":"SailPoint generated unique identifier.","example":"ee769173319b41d19ccec35ba52f237b"},"nativeIdentifier":{"type":"string","description":"Unique ID of the account on the source.","example":"E009"},"sourceId":{"type":"string","description":"The ID of the source.","example":"2c918082814e693601816e09471b29b6"},"sourceName":{"type":"string","description":"The name of the source.","example":"Active Directory"},"identityId":{"type":"string","description":"The ID of the identity that is corellated with this account.","example":"ee769173319b41d19ccec6c235423237b"},"identityName":{"type":"string","description":"The name of the identity that is corellated with this account.","example":"john.doe"},"attributes":{"type":"object","additionalProperties":true,"description":"The attributes of the account. The contents of attributes depends on the account schema for the source.","example":{"firstname":"John","lastname":"Doe","email":"john.doe@gmail.com","department":"Sales","displayName":"John Doe","created":"2020-04-27T16:48:33.597Z","employeeNumber":"E009","uid":"E009","inactive":"true","phone":null,"identificationNumber":"E009"}}}},{"type":"object","required":["id","nativeIdentifier","sourceId","sourceName","identityId","identityName","attributes"],"properties":{"uuid":{"type":"string","description":"Source unique identifier for the identity. UUID is generated by the source system.","example":"b7264868-7201-415f-9118-b581d431c688"},"id":{"type":"string","description":"SailPoint generated unique identifier.","example":"ee769173319b41d19ccec35ba52f237b"},"nativeIdentifier":{"type":"string","description":"Unique ID of the account on the source.","example":"E009"},"sourceId":{"type":"string","description":"The ID of the source.","example":"2c918082814e693601816e09471b29b6"},"sourceName":{"type":"string","description":"The name of the source.","example":"Active Directory"},"identityId":{"type":"string","description":"The ID of the identity that is corellated with this account.","example":"ee769173319b41d19ccec6c235423237b"},"identityName":{"type":"string","description":"The name of the identity that is corellated with this account.","example":"john.doe"},"attributes":{"type":"object","additionalProperties":true,"description":"The attributes of the account. The contents of attributes depends on the account schema for the source.","example":{"firstname":"John","lastname":"Doe","email":"john.doe@gmail.com","department":"Sales","displayName":"John Doe","created":"2020-04-27T16:48:33.597Z","employeeNumber":"E009","uid":"E009","inactive":"true","phone":null,"identificationNumber":"E009"}}}},{"type":"object","required":["id","nativeIdentifier","sourceId","sourceName","identityId","identityName","attributes"],"properties":{"uuid":{"type":"string","description":"Source unique identifier for the identity. UUID is generated by the source system.","example":"b7264868-7201-415f-9118-b581d431c688"},"id":{"type":"string","description":"SailPoint generated unique identifier.","example":"ee769173319b41d19ccec35ba52f237b"},"nativeIdentifier":{"type":"string","description":"Unique ID of the account on the source.","example":"E009"},"sourceId":{"type":"string","description":"The ID of the source.","example":"2c918082814e693601816e09471b29b6"},"sourceName":{"type":"string","description":"The name of the source.","example":"Active Directory"},"identityId":{"type":"string","description":"The ID of the identity that is corellated with this account.","example":"ee769173319b41d19ccec6c235423237b"},"identityName":{"type":"string","description":"The name of the identity that is corellated with this account.","example":"john.doe"},"attributes":{"type":"object","additionalProperties":true,"description":"The attributes of the account. The contents of attributes depends on the account schema for the source.","example":{"firstname":"John","lastname":"Doe","email":"john.doe@gmail.com","department":"Sales","displayName":"John Doe","created":"2020-04-27T16:48:33.597Z","employeeNumber":"E009","uid":"E009","inactive":"true","phone":null,"identificationNumber":"E009"}}}},{"title":"Source Created","type":"object","required":["id","name","type","created","connector","actor"],"properties":{"id":{"type":"string","description":"The unique ID of the source.","example":"2c9180866166b5b0016167c32ef31a66"},"name":{"type":"string","description":"Human friendly name of the source.","example":"Test source"},"type":{"type":"string","description":"The connection type.","example":"DIRECT_CONNECT"},"created":{"type":"string","format":"date-time","description":"The date and time the source was created.","example":"2021-03-29T22:01:50.474Z"},"connector":{"type":"string","description":"The connector type used to connect to the source.","example":"active-directory"},"actor":{"required":["id","name","type"],"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["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_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"The identity that created the source.","properties":{"type":{"enum":["IDENTITY"],"example":"IDENTITY","description":"The type of object that is referenced"}}}}},{"title":"Source Deleted","type":"object","required":["id","name","type","deleted","connector","actor"],"properties":{"id":{"type":"string","description":"The unique ID of the source.","example":"2c9180866166b5b0016167c32ef31a66"},"name":{"type":"string","description":"Human friendly name of the source.","example":"Test source"},"type":{"type":"string","description":"The connection type.","example":"DIRECT_CONNECT"},"deleted":{"type":"string","format":"date-time","description":"The date and time the source was deleted.","example":"2021-03-29T22:01:50.474Z"},"connector":{"type":"string","description":"The connector type used to connect to the source.","example":"active-directory"},"actor":{"required":["id","name","type"],"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["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_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"The identity that deleted the source.","properties":{"type":{"enum":["IDENTITY"],"example":"IDENTITY","description":"The type of object that is referenced"}}}}},{"title":"Source Updated","type":"object","required":["id","name","type","modified","connector","actor"],"properties":{"id":{"type":"string","description":"The unique ID of the source.","example":"2c9180866166b5b0016167c32ef31a66"},"name":{"type":"string","description":"The user friendly name of the source.","example":"Corporate Active Directory"},"type":{"type":"string","description":"The connection type of the source.","example":"DIRECT_CONNECT"},"modified":{"type":"string","format":"date-time","description":"The date and time the source was modified.","example":"2021-03-29T22:01:50.474Z"},"connector":{"type":"string","description":"The connector type used to connect to the source.","example":"active-directory"},"actor":{"required":["type","name"],"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["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_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"The identity or system that performed the update.","properties":{"type":{"enum":["IDENTITY"],"example":"IDENTITY","description":"The type of object that is referenced"}}}}},{"title":"VA Cluster Status Change Event","type":"object","required":["created","type","application","healthCheckResult","previousHealthCheckResult"],"properties":{"created":{"type":"string","format":"date-time","description":"The date and time the status change occurred.","example":"2020-06-29T22:01:50.474Z"},"type":{"enum":["SOURCE","CLUSTER"],"description":"The type of the object that initiated this event.","example":"CLUSTER"},"application":{"type":"object","description":"Details about the `CLUSTER` or `SOURCE` that initiated this event.","required":["id","name","attributes"],"properties":{"id":{"type":"string","description":"The GUID of the application","example":"2c9180866166b5b0016167c32ef31a66"},"name":{"type":"string","description":"The name of the application","example":"Production VA Cluster"},"attributes":{"type":"object","description":"Custom map of attributes for a source. This will only be populated if type is `SOURCE` and the source has a proxy.","additionalProperties":true,"nullable":true,"example":null}}},"healthCheckResult":{"type":"object","description":"The results of the most recent health check.","required":["message","resultType","status"],"properties":{"message":{"type":"string","description":"Detailed message of the result of the health check.","example":"Test Connection failed with exception. Error message - java.lang Exception"},"resultType":{"type":"string","description":"The type of the health check result.","example":"SOURCE_STATE_ERROR_CLUSTER"},"status":{"enum":["Succeeded","Failed"],"description":"The status of the health check.","example":"Succeeded"}}},"previousHealthCheckResult":{"type":"object","description":"The results of the last health check.","required":["message","resultType","status"],"properties":{"message":{"type":"string","description":"Detailed message of the result of the health check.","example":"Test Connection failed with exception. Error message - java.lang Exception"},"resultType":{"type":"string","description":"The type of the health check result.","example":"SOURCE_STATE_ERROR_CLUSTER"},"status":{"enum":["Succeeded","Failed"],"description":"The status of the health check.","example":"Failed"}}}}}]},"outputSchema":{"type":"string","description":"The JSON schema of the response that will be sent by the subscribed service to the trigger in response to an event. This only applies to a trigger type of `REQUEST_RESPONSE`.","nullable":true,"example":"{\"definitions\":{\"record:AccessRequestDynamicApproverOutput\":{\"type\":[\"null\",\"object\"],\"required\":[\"id\",\"name\",\"type\"],\"additionalProperties\":true,\"properties\":{\"id\":{\"type\":\"string\"},\"name\":{\"type\":\"string\"},\"type\":{\"type\":\"string\"}}}},\"$ref\":\"#/definitions/record:AccessRequestDynamicApproverOutput\"}"},"exampleOutput":{"description":"An example of the JSON payload that will be sent by the subscribed service to the trigger in response to an event.","nullable":true,"oneOf":[{"title":"Access Request Dynamic Approver","type":"object","nullable":true,"required":["id","name","type"],"properties":{"id":{"type":"string","description":"The unique ID of the identity to add to the approver list for the access request.","example":"2c91808b6ef1d43e016efba0ce470906"},"name":{"type":"string","description":"The name of the identity to add to the approver list for the access request.","example":"Adam Adams"},"type":{"enum":["IDENTITY","GOVERNANCE_GROUP"],"description":"The type of object being referenced.","example":"IDENTITY"}}},{"title":"Access Request Pre Approval","type":"object","required":["approved","comment","approver"],"properties":{"approved":{"type":"boolean","description":"Whether or not to approve the access request.","example":false},"comment":{"type":"string","description":"A comment about the decision to approve or deny the request.","example":"This access should be denied, because this will cause an SOD violation."},"approver":{"type":"string","description":"The name of the entity that approved or denied the request.","example":"AcmeCorpExternalIntegration"}}}]}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"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.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"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.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"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.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"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.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"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.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"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.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:trigger-service-subscriptions:read"]}],"method":"get","path":"/triggers","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/docs/authentication.html) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/docs/authentication.html#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/docs/authentication.html#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/docs/authentication.html#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/docs/authentication.html#which-oauth-2-0-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/docs/authentication.html#finding-your-tenant-s-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"contact":{"email":"developers@sailpoint.com","name":"Developer Relations","url":"https://developer.sailpoint.com/discuss"},"description":"These are the public, beta APIs for SailPoint's SaaS services and are subject to change.","title":"SailPoint - Beta SaaS API","version":"3.1.0-beta"},"postman":{"name":"List Triggers","description":{"content":"Gets a list of triggers that are available in the tenant.","type":"text/plain"},"url":{"path":["triggers"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/docs/standard_collection_parameters.html) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/docs/standard_collection_parameters.html) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/docs/standard_collection_parameters.html) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/docs/standard_collection_parameters.html)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq*","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/docs/standard_collection_parameters.html)\n\nSorting is supported for the following fields:\n\n**id** **name**","type":"text/plain"},"key":"sorters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}}
|
|
sidebar_class_name: "get api-method"
|
|
info_path: docs/sailpoint-api-beta/sail-point-beta-saa-s-api
|
|
---
|
|
|
|
import ApiTabs from "@theme/ApiTabs";
|
|
import MimeTabs from "@theme/MimeTabs";
|
|
import ParamsItem from "@theme/ParamsItem";
|
|
import ResponseSamples from "@theme/ResponseSamples";
|
|
import SchemaItem from "@theme/SchemaItem"
|
|
import SchemaTabs from "@theme/SchemaTabs";
|
|
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
|
|
import TabItem from "@theme/TabItem";
|
|
|
|
## List Triggers
|
|
|
|
|
|
|
|
Gets a list of triggers that are available in the tenant.
|
|
|
|
<details style={{"marginBottom":"1rem"}} data-collapsed={false} open={true}><summary style={{}}><strong>Query Parameters</strong></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/docs/standard_collection_parameters.html) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/docs/standard_collection_parameters.html) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"count","description":"If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/docs/standard_collection_parameters.html) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"filters","required":false,"schema":{"type":"string"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/docs/standard_collection_parameters.html)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq*","example":"id eq \"idn:access-request-post-approval\""}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"sorters","required":false,"schema":{"type":"string","format":"comma-separated"},"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/docs/standard_collection_parameters.html)\n\nSorting is supported for the following fields:\n\n**id** **name**","example":"name"}}></ParamsItem></ul></div></details><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
|
|
|
|
List of triggers.
|
|
|
|
</div><div><MimeTabs groupId={"mime-type"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs groupId={"schema-tabs"}><TabTtem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong><span style={{"opacity":"0.6"}}> array</span></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={"Unique identifier of the trigger."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaDescription={"Trigger Name."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaDescription={"The type of trigger."} schemaName={"string"} qualifierMessage={"**Possible values:** [`REQUEST_RESPONSE`, `FIRE_AND_FORGET`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaDescription={"Trigger Description."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"inputSchema"} required={false} schemaDescription={"The JSON schema of the payload that will be sent by the trigger to the subscribed service."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>exampleInput</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
An example of the JSON payload that will be sent by the trigger to the subscribed service.
|
|
|
|
</div><li><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"Access Request Dynamic Approver"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"accessRequestId"} required={false} schemaDescription={"The unique ID of the access request object. Can be used with the [access request status endpoint](https://developer.sailpoint.com/apis/beta/#operation/listAccessRequestStatus) to get the status of the request.\n"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>requestedFor</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"type"} required={false} schemaDescription={"DTO type"} schemaName={"string"} qualifierMessage={"**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_CATEGORY`, `TASK_RESULT`, `REPORT_RESULT`, `SOD_VIOLATION`, `ACCOUNT_ACTIVITY`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={"ID of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaDescription={"Human-readable display name of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>requestedItems</strong><span style={{"opacity":"0.6"}}> object[]</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
The access items that are being requested.
|
|
|
|
</div><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={"The unique ID of the access item."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaDescription={"Human friendly name of the access item."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaDescription={"Extended description of the access item."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaDescription={"The type of access item being requested."} schemaName={""} qualifierMessage={"**Possible values:** [`ACCESS_PROFILE`, `ROLE`, `ENTITLEMENT`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"operation"} required={false} schemaDescription={"Grant or revoke the access item"} schemaName={""} qualifierMessage={"**Possible values:** [`Add`, `Remove`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"comment"} required={false} schemaDescription={"A comment from the requestor on why the access is needed."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>requestedBy</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"type"} required={false} schemaDescription={"DTO type"} schemaName={"string"} qualifierMessage={"**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_CATEGORY`, `TASK_RESULT`, `REPORT_RESULT`, `SOD_VIOLATION`, `ACCOUNT_ACTIVITY`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={"ID of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaDescription={"Human-readable display name of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem></TabItem><TabItem label={"Access Request Post Approval"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"accessRequestId"} required={false} schemaDescription={"The unique ID of the access request."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>requestedFor</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"type"} required={false} schemaDescription={"DTO type"} schemaName={"string"} qualifierMessage={"**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_CATEGORY`, `TASK_RESULT`, `REPORT_RESULT`, `SOD_VIOLATION`, `ACCOUNT_ACTIVITY`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={"ID of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaDescription={"Human-readable display name of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>requestedItemsStatus</strong><span style={{"opacity":"0.6"}}> object[]</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Details on the outcome of each access item.
|
|
|
|
</div><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={"The unique ID of the access item being requested."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaDescription={"The human friendly name of the access item."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaDescription={"Detailed description of the access item."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaDescription={"The type of access item."} schemaName={""} qualifierMessage={"**Possible values:** [`ACCESS_PROFILE`, `ROLE`, `ENTITLEMENT`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"operation"} required={false} schemaDescription={"The action to perform on the access item."} schemaName={""} qualifierMessage={"**Possible values:** [`Add`, `Remove`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"comment"} required={false} schemaDescription={"A comment from the identity requesting the access."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>clientMetadata</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Additional customer defined metadata about the access item.
|
|
|
|
</div></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>approvalInfo</strong><span style={{"opacity":"0.6"}}> object[]</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
A list of one or more approvers for the access request.
|
|
|
|
</div><SchemaItem collapsible={false} name={"approvalComment"} required={false} schemaDescription={"A comment left by the approver."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"approvalDecision"} required={false} schemaDescription={"The final decision of the approver."} schemaName={""} qualifierMessage={"**Possible values:** [`APPROVED`, `DENIED`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"approverName"} required={false} schemaDescription={"The name of the approver"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>approver</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"type"} required={false} schemaDescription={"DTO type"} schemaName={"string"} qualifierMessage={"**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_CATEGORY`, `TASK_RESULT`, `REPORT_RESULT`, `SOD_VIOLATION`, `ACCOUNT_ACTIVITY`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={"ID of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaDescription={"Human-readable display name of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>requestedBy</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"type"} required={false} schemaDescription={"DTO type"} schemaName={"string"} qualifierMessage={"**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_CATEGORY`, `TASK_RESULT`, `REPORT_RESULT`, `SOD_VIOLATION`, `ACCOUNT_ACTIVITY`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={"ID of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaDescription={"Human-readable display name of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem></TabItem><TabItem label={"Access Request Pre Approval"} value={"2-item-properties"}><SchemaItem collapsible={false} name={"accessRequestId"} required={false} schemaDescription={"The unique ID of the access request."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>requestedFor</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"type"} required={false} schemaDescription={"DTO type"} schemaName={"string"} qualifierMessage={"**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_CATEGORY`, `TASK_RESULT`, `REPORT_RESULT`, `SOD_VIOLATION`, `ACCOUNT_ACTIVITY`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={"ID of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaDescription={"Human-readable display name of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>requestedItems</strong><span style={{"opacity":"0.6"}}> object[]</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Details of the access items being requested.
|
|
|
|
</div><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={"The unique ID of the access item being requested."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaDescription={"The human friendly name of the access item."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaDescription={"Detailed description of the access item."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaDescription={"The type of access item."} schemaName={""} qualifierMessage={"**Possible values:** [`ACCESS_PROFILE`, `ROLE`, `ENTITLEMENT`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"operation"} required={false} schemaDescription={"The action to perform on the access item."} schemaName={""} qualifierMessage={"**Possible values:** [`Add`, `Remove`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"comment"} required={false} schemaDescription={"A comment from the identity requesting the access."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>requestedBy</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"type"} required={false} schemaDescription={"DTO type"} schemaName={"string"} qualifierMessage={"**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_CATEGORY`, `TASK_RESULT`, `REPORT_RESULT`, `SOD_VIOLATION`, `ACCOUNT_ACTIVITY`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={"ID of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaDescription={"Human-readable display name of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem></TabItem><TabItem label={"Account Aggregation Completed"} value={"3-item-properties"}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>source</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"type"} required={false} schemaDescription={"DTO type"} schemaName={"string"} qualifierMessage={"**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_CATEGORY`, `TASK_RESULT`, `REPORT_RESULT`, `SOD_VIOLATION`, `ACCOUNT_ACTIVITY`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={"ID of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaDescription={"Human-readable display name of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaDescription={"The overall status of the aggregation."} schemaName={""} qualifierMessage={"**Possible values:** [`Success`, `Failed`, `Terminated`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"started"} required={false} schemaDescription={"The date and time when the account aggregation started."} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"completed"} required={false} schemaDescription={"The date and time when the account aggregation finished."} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"errors"} required={false} schemaDescription={"A list of errors that occurred during the aggregation."} schemaName={"string[]"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"warnings"} required={false} schemaDescription={"A list of warnings that occurred during the aggregation."} schemaName={"string[]"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>stats</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Overall statistics about the account aggregation.
|
|
|
|
</div><SchemaItem collapsible={false} name={"scanned"} required={false} schemaDescription={"The number of accounts which were scanned / iterated over."} schemaName={"int32"} qualifierMessage={"**Possible values:** `<= 2147483647`"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"unchanged"} required={false} schemaDescription={"The number of accounts which existed before, but had no changes."} schemaName={"int32"} qualifierMessage={"**Possible values:** `<= 2147483647`"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"changed"} required={false} schemaDescription={"The number of accounts which existed before, but had changes."} schemaName={"int32"} qualifierMessage={"**Possible values:** `<= 2147483647`"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"added"} required={false} schemaDescription={"The number of accounts which are new - have not existed before."} schemaName={"int32"} qualifierMessage={"**Possible values:** `<= 2147483647`"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"removed"} required={false} schemaDescription={"The number accounts which existed before, but no longer exist (thus getting removed)."} schemaName={"int32"} qualifierMessage={"**Possible values:** `<= 2147483647`"} defaultValue={undefined}></SchemaItem></div></details></SchemaItem></TabItem><TabItem label={"Account Attributes Changed"} value={"4-item-properties"}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>identity</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"type"} required={false} schemaDescription={"DTO type"} schemaName={"string"} qualifierMessage={"**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_CATEGORY`, `TASK_RESULT`, `REPORT_RESULT`, `SOD_VIOLATION`, `ACCOUNT_ACTIVITY`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={"ID of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaDescription={"Human-readable display name of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>source</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
The source that contains the account.
|
|
|
|
</div><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={"ID of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaDescription={"The type of object that is referenced"} schemaName={"string"} qualifierMessage={"**Possible values:** [`SOURCE`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaDescription={"Human-readable display name of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>account</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Details of the account where the attributes changed.
|
|
|
|
</div><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={"SailPoint generated unique identifier."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"uuid"} required={false} schemaDescription={"The source's unique identifier for the account. UUID is generated by the source system."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaDescription={"Name of the account."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"nativeIdentity"} required={false} schemaDescription={"Unique ID of the account on the source."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaDescription={"The type of the account"} schemaName={""} qualifierMessage={"**Possible values:** [`ACCOUNT`]"} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>changes</strong><span style={{"opacity":"0.6"}}> object[]</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
A list of attributes that changed.
|
|
|
|
</div><SchemaItem collapsible={false} name={"attribute"} required={false} schemaDescription={"The name of the attribute."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>oldValue</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
The previous value of the attribute.
|
|
|
|
</div><li><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"MOD1"} value={"0-item-properties"}><li><div><strong>string</strong></div></li></TabItem><TabItem label={"MOD2"} value={"1-item-properties"}><li><div><strong>boolean</strong></div></li></TabItem><TabItem label={"MOD3"} value={"2-item-properties"}><li><div><strong>string</strong></div></li></TabItem></SchemaTabs></div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>newValue</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
The new value of the attribute.
|
|
|
|
</div><li><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"MOD1"} value={"0-item-properties"}><li><div><strong>string</strong></div></li></TabItem><TabItem label={"MOD2"} value={"1-item-properties"}><li><div><strong>boolean</strong></div></li></TabItem><TabItem label={"MOD3"} value={"2-item-properties"}><li><div><strong>string</strong></div></li></TabItem></SchemaTabs></div></li></div></details></SchemaItem></div></details></SchemaItem></TabItem><TabItem label={"Account Correlated"} value={"5-item-properties"}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>identity</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"type"} required={false} schemaDescription={"DTO type"} schemaName={"string"} qualifierMessage={"**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_CATEGORY`, `TASK_RESULT`, `REPORT_RESULT`, `SOD_VIOLATION`, `ACCOUNT_ACTIVITY`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={"ID of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaDescription={"Human-readable display name of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>source</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
The source from which the account came from.
|
|
|
|
</div><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={"ID of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaDescription={"The type of object that is referenced"} schemaName={"string"} qualifierMessage={"**Possible values:** [`SOURCE`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaDescription={"Human-readable display name of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>account</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"type"} required={false} schemaDescription={"DTO type"} schemaName={"string"} qualifierMessage={"**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_CATEGORY`, `TASK_RESULT`, `REPORT_RESULT`, `SOD_VIOLATION`, `ACCOUNT_ACTIVITY`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={"ID of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaDescription={"Human-readable display name of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>attributes</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
The attributes associated with the account. Attributes are unique per source.
|
|
|
|
</div></div></details></SchemaItem><SchemaItem collapsible={false} name={"entitlementCount"} required={false} schemaDescription={"The number of entitlements associated with this account."} schemaName={"int32"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></TabItem><TabItem label={"Accounts Collected for Aggregation"} value={"6-item-properties"}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>source</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Reference to the source that has been aggregated.
|
|
|
|
</div><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={"ID of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaDescription={"The type of object that is referenced"} schemaName={"string"} qualifierMessage={"**Possible values:** [`SOURCE`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaDescription={"Human-readable display name of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaDescription={"The overall status of the collection."} schemaName={""} qualifierMessage={"**Possible values:** [`Success`, `Failed`, `Terminated`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"started"} required={false} schemaDescription={"The date and time when the account collection started."} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"completed"} required={false} schemaDescription={"The date and time when the account collection finished."} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"errors"} required={false} schemaDescription={"A list of errors that occurred during the collection."} schemaName={"string[]"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"warnings"} required={false} schemaDescription={"A list of warnings that occurred during the collection."} schemaName={"string[]"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>stats</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Overall statistics about the account collection.
|
|
|
|
</div><SchemaItem collapsible={false} name={"scanned"} required={false} schemaDescription={"The number of accounts which were scanned / iterated over."} schemaName={"int32"} qualifierMessage={"**Possible values:** `<= 2147483647`"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"unchanged"} required={false} schemaDescription={"The number of accounts which existed before, but had no changes."} schemaName={"int32"} qualifierMessage={"**Possible values:** `<= 2147483647`"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"changed"} required={false} schemaDescription={"The number of accounts which existed before, but had changes."} schemaName={"int32"} qualifierMessage={"**Possible values:** `<= 2147483647`"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"added"} required={false} schemaDescription={"The number of accounts which are new - have not existed before."} schemaName={"int32"} qualifierMessage={"**Possible values:** `<= 2147483647`"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"removed"} required={false} schemaDescription={"The number accounts which existed before, but no longer exist (thus getting removed)."} schemaName={"int32"} qualifierMessage={"**Possible values:** `<= 2147483647`"} defaultValue={undefined}></SchemaItem></div></details></SchemaItem></TabItem><TabItem label={"Account Uncorrelated"} value={"7-item-properties"}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>identity</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"type"} required={false} schemaDescription={"DTO type"} schemaName={"string"} qualifierMessage={"**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_CATEGORY`, `TASK_RESULT`, `REPORT_RESULT`, `SOD_VIOLATION`, `ACCOUNT_ACTIVITY`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={"ID of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaDescription={"Human-readable display name of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>source</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"type"} required={false} schemaDescription={"DTO type"} schemaName={"string"} qualifierMessage={"**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_CATEGORY`, `TASK_RESULT`, `REPORT_RESULT`, `SOD_VIOLATION`, `ACCOUNT_ACTIVITY`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={"ID of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaDescription={"Human-readable display name of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>account</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"type"} required={false} schemaDescription={"DTO type"} schemaName={"string"} qualifierMessage={"**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_CATEGORY`, `TASK_RESULT`, `REPORT_RESULT`, `SOD_VIOLATION`, `ACCOUNT_ACTIVITY`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={"ID of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaDescription={"Human-readable display name of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"entitlementCount"} required={false} schemaDescription={"The number of entitlements associated with this account."} schemaName={"int32"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></TabItem><TabItem label={"Campaign Activated"} value={"8-item-properties"}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>campaign</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Details about the certification campaign that was activated.
|
|
|
|
</div><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={"Unique ID for the campaign."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaDescription={"The human friendly name of the campaign."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaDescription={"Extended description of the campaign."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaDescription={"The date and time the campaign was created."} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaDescription={"The date and time the campaign was last modified."} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"deadline"} required={false} schemaDescription={"The date and time the campaign is due."} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaDescription={"The type of campaign."} schemaName={""} qualifierMessage={"**Possible values:** [`MANAGER`, `SOURCE_OWNER`, `SEARCH`, `ROLE_COMPOSITION`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>campaignOwner</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Details of the identity that owns the campaign.
|
|
|
|
</div><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={"The unique ID of the identity."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"displayName"} required={false} schemaDescription={"The human friendly name of the identity."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={false} schemaDescription={"The primary email address of the identity."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaDescription={"The current status of the campaign."} schemaName={""} qualifierMessage={"**Possible values:** [`ACTIVE`]"} defaultValue={undefined}></SchemaItem></div></details></SchemaItem></TabItem><TabItem label={"Campaign Ended"} value={"9-item-properties"}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>campaign</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Details about the certification campaign that ended.
|
|
|
|
</div><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={"Unique ID for the campaign."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaDescription={"The human friendly name of the campaign."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaDescription={"Extended description of the campaign."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaDescription={"The date and time the campaign was created."} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaDescription={"The date and time the campaign was last modified."} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"deadline"} required={false} schemaDescription={"The date and time the campaign is due."} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaDescription={"The type of campaign."} schemaName={""} qualifierMessage={"**Possible values:** [`MANAGER`, `SOURCE_OWNER`, `SEARCH`, `ROLE_COMPOSITION`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>campaignOwner</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Details of the identity that owns the campaign.
|
|
|
|
</div><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={"The unique ID of the identity."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"displayName"} required={false} schemaDescription={"The human friendly name of the identity."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={false} schemaDescription={"The primary email address of the identity."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaDescription={"The current status of the campaign."} schemaName={""} qualifierMessage={"**Possible values:** [`COMPLETED`]"} defaultValue={undefined}></SchemaItem></div></details></SchemaItem></TabItem><TabItem label={"Campaign Generated"} value={"10-item-properties"}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>campaign</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Details about the campaign that was generated.
|
|
|
|
</div><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={"The unique ID of the campaign."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaDescription={"Human friendly name of the campaign."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaDescription={"Extended description of the campaign."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaDescription={"The date and time the campaign was created."} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaDescription={"The date and time the campaign was last modified."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"deadline"} required={false} schemaDescription={"The date and time when the campaign must be finished by."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaDescription={"The type of campaign that was generated."} schemaName={""} qualifierMessage={"**Possible values:** [`MANAGER`, `SOURCE_OWNER`, `SEARCH`, `ROLE_COMPOSITION`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>campaignOwner</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
The identity that owns the campaign.
|
|
|
|
</div><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={"The unique ID of the identity."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"displayName"} required={false} schemaDescription={"The display name of the identity."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={false} schemaDescription={"The primary email address of the identity."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaDescription={"The current status of the campaign."} schemaName={""} qualifierMessage={"**Possible values:** [`STAGED`, `ACTIVATING`, `ACTIVE`]"} defaultValue={undefined}></SchemaItem></div></details></SchemaItem></TabItem><TabItem label={"Certification Signed Off"} value={"11-item-properties"}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>certification</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>campaignRef</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={"The unique ID of the campaign."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaDescription={"The name of the campaign."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaDescription={"The type of object that is being referenced."} schemaName={"string"} qualifierMessage={"**Possible values:** [`CAMPAIGN`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"campaignType"} required={false} schemaDescription={"The type of the campaign."} schemaName={"string"} qualifierMessage={"**Possible values:** [`MANAGER`, `SOURCE_OWNER`, `SEARCH`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaDescription={"The description of the campaign set by the admin who created it."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"phase"} required={false} schemaDescription={"The current phase of the campaign.\n* `STAGED`: The campaign is waiting to be activated.\n* `ACTIVE`: The campaign is active.\n* `SIGNED`: The reviewer has signed off on the campaign, and it is considered complete.\n"} schemaName={"string"} qualifierMessage={"**Possible values:** [`STAGED`, `ACTIVE`, `SIGNED`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"due"} required={false} schemaDescription={"The due date of the certification."} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"signed"} required={false} schemaDescription={"The date the reviewer signed off on the certification."} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>reviewer</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
A reference to the reviewer of the campaign.
|
|
|
|
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaDescription={"The type of object that the reviewer is."} schemaName={"string"} qualifierMessage={"**Possible values:** [`GOVERNANCE_GROUP`, `IDENTITY`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={false} schemaDescription={"The email of the reviewing identity. Only applicable to `IDENTITY`"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={"ID of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaDescription={"Human-readable display name of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>reassignment</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
A reference to a reviewer that this campaign has been reassigned to.
|
|
|
|
</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>from</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
The previous certification
|
|
|
|
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaDescription={"The type of object that the reviewer is."} schemaName={"string"} qualifierMessage={"**Possible values:** [`CERTIFICATION`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={"ID of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaDescription={"Human-readable display name of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>reviewer</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Certification reviewer
|
|
|
|
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaDescription={"The type of object that the reviewer is."} schemaName={"string"} qualifierMessage={"**Possible values:** [`GOVERNANCE_GROUP`, `IDENTITY`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={false} schemaDescription={"The email of the reviewing identity. Only applicable to `IDENTITY`"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={"ID of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaDescription={"Human-readable display name of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"comment"} required={false} schemaDescription={"Comments from the previous reviewer."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"hasErrors"} required={false} schemaDescription={"Indicates it the certification has any errors."} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"errorMessage"} required={false} schemaDescription={"A message indicating what the error is."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"completed"} required={false} schemaDescription={"Indicates if all certification decisions have been made."} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"decisionsMade"} required={false} schemaDescription={"The number of approve/revoke/acknowledge decisions that have been made by the reviewer."} schemaName={"int32"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"decisionsTotal"} required={false} schemaDescription={"The total number of approve/revoke/acknowledge decisions for the certification."} schemaName={"int32"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"entitiesCompleted"} required={false} schemaDescription={"The number of entities (identities, access profiles, roles, etc.) for which all decisions have been made and are complete."} schemaName={"int32"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"entitiesTotal"} required={false} schemaDescription={"The total number of entities (identities, access profiles, roles, etc.) in the certification, both complete and incomplete."} schemaName={"int32"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem></TabItem><TabItem label={"Identity Attributes Changed"} value={"12-item-properties"}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>identity</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"type"} required={false} schemaDescription={"DTO type"} schemaName={"string"} qualifierMessage={"**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_CATEGORY`, `TASK_RESULT`, `REPORT_RESULT`, `SOD_VIOLATION`, `ACCOUNT_ACTIVITY`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={"ID of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaDescription={"Human-readable display name of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>changes</strong><span style={{"opacity":"0.6"}}> object[]</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
A list of one or more identity attributes that changed on the identity.
|
|
|
|
</div><SchemaItem collapsible={false} name={"attribute"} required={false} schemaDescription={"The name of the identity attribute that changed."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>oldValue</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
The value of the identity attribute before it changed.
|
|
|
|
</div><li><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"MOD1"} value={"0-item-properties"}><li><div><strong>string</strong></div></li></TabItem><TabItem label={"MOD2"} value={"1-item-properties"}><li><div><strong>boolean</strong></div></li></TabItem><TabItem label={"MOD3"} value={"2-item-properties"}><li><div><strong>string</strong></div></li></TabItem></SchemaTabs></div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>newValue</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
The value of the identity attribute after it changed.
|
|
|
|
</div><li><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"MOD1"} value={"0-item-properties"}><li><div><strong>string</strong></div></li></TabItem><TabItem label={"MOD2"} value={"1-item-properties"}><li><div><strong>boolean</strong></div></li></TabItem><TabItem label={"MOD3"} value={"2-item-properties"}><li><div><strong>string</strong></div></li></TabItem></SchemaTabs></div></li></div></details></SchemaItem></div></details></SchemaItem></TabItem><TabItem label={"Identity Created"} value={"13-item-properties"}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>identity</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"type"} required={false} schemaDescription={"DTO type"} schemaName={"string"} qualifierMessage={"**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_CATEGORY`, `TASK_RESULT`, `REPORT_RESULT`, `SOD_VIOLATION`, `ACCOUNT_ACTIVITY`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={"ID of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaDescription={"Human-readable display name of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>attributes</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
The attributes assigned to the identity. Attributes are determined by the identity profile.
|
|
|
|
</div></div></details></SchemaItem></TabItem><TabItem label={"Identity Deleted"} value={"14-item-properties"}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>identity</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"type"} required={false} schemaDescription={"DTO type"} schemaName={"string"} qualifierMessage={"**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_CATEGORY`, `TASK_RESULT`, `REPORT_RESULT`, `SOD_VIOLATION`, `ACCOUNT_ACTIVITY`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={"ID of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaDescription={"Human-readable display name of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>attributes</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
The attributes assigned to the identity. Attributes are determined by the identity profile.
|
|
|
|
</div></div></details></SchemaItem></TabItem><TabItem label={"Provisioning Completed"} value={"15-item-properties"}><SchemaItem collapsible={false} name={"trackingNumber"} required={false} schemaDescription={"The reference number of the provisioning request. Useful for tracking status in the Account Activity search interface."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"sources"} required={false} schemaDescription={"One or more sources that the provisioning transaction(s) were done against. Sources are comma separated."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"action"} required={false} schemaDescription={"Origin of where the provisioning request came from."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"errors"} required={false} schemaDescription={"A list of any accumulated error messages that occurred during provisioning."} schemaName={"string[]"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"warnings"} required={false} schemaDescription={"A list of any accumulated warning messages that occurred during provisioning."} schemaName={"string[]"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>recipient</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"type"} required={false} schemaDescription={"DTO type"} schemaName={"string"} qualifierMessage={"**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_CATEGORY`, `TASK_RESULT`, `REPORT_RESULT`, `SOD_VIOLATION`, `ACCOUNT_ACTIVITY`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={"ID of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaDescription={"Human-readable display name of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>requester</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"type"} required={false} schemaDescription={"DTO type"} schemaName={"string"} qualifierMessage={"**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_CATEGORY`, `TASK_RESULT`, `REPORT_RESULT`, `SOD_VIOLATION`, `ACCOUNT_ACTIVITY`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={"ID of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaDescription={"Human-readable display name of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>accountRequests</strong><span style={{"opacity":"0.6"}}> object[]</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
A list of provisioning instructions to perform on an account-by-account basis.
|
|
|
|
</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>source</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Reference to the source being provisioned against.
|
|
|
|
</div><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={"ID of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaDescription={"The type of object that is referenced"} schemaName={"string"} qualifierMessage={"**Possible values:** [`SOURCE`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaDescription={"Human-readable display name of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"accountId"} required={false} schemaDescription={"The unique idenfier of the account being provisioned."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"accountOperation"} required={false} schemaDescription={"The provisioning operation; typically Create, Modify, Enable, Disable, Unlock, or Delete."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"provisioningResult"} required={false} schemaDescription={"The overall result of the provisioning transaction; this could be success, pending, failed, etc."} schemaName={""} qualifierMessage={"**Possible values:** [`SUCCESS`, `PENDING`, `FAILED`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"provisioningTarget"} required={false} schemaDescription={"The name of the provisioning channel selected; this could be the same as the source, or could be a Service Desk Integration Module (SDIM)."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"ticketId"} required={false} schemaDescription={"A reference to a tracking number, if this is sent to a Service Desk Integration Module (SDIM)."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>attributeRequests</strong><span style={{"opacity":"0.6"}}> object[]</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
A list of attributes as part of the provisioning transaction.
|
|
|
|
</div><SchemaItem collapsible={false} name={"attributeName"} required={false} schemaDescription={"The name of the attribute being provisioned."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"attributeValue"} required={false} schemaDescription={"The value of the attribute being provisioned."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"operation"} required={false} schemaDescription={"The operation to handle the attribute."} schemaName={""} qualifierMessage={"**Possible values:** [`Add`, `Set`, `Remove`]"} defaultValue={undefined}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></TabItem><TabItem label={"Saved Search Complete"} value={"16-item-properties"}><SchemaItem collapsible={false} name={"fileName"} required={false} schemaDescription={"A name for the report file."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"ownerEmail"} required={false} schemaDescription={"The email address of the identity that owns the saved search."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"ownerName"} required={false} schemaDescription={"The name of the identity that owns the saved search."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"query"} required={false} schemaDescription={"The search query that was used to generate the report."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"searchName"} required={false} schemaDescription={"The name of the saved search."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>searchResults</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
A preview of the search results for each object type. This includes a count as well as headers, and the first several rows of data, per object type.
|
|
|
|
</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>Account</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
A table of accounts that match the search criteria.
|
|
|
|
</div><SchemaItem collapsible={false} name={"count"} required={false} schemaDescription={"The number of rows in the table."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"noun"} required={false} schemaDescription={"The type of object represented in the table."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"preview"} required={false} schemaDescription={"A sample of the data in the table."} schemaName={"array[]"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>Entitlement</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
A table of entitlements that match the search criteria.
|
|
|
|
</div><SchemaItem collapsible={false} name={"count"} required={false} schemaDescription={"The number of rows in the table."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"noun"} required={false} schemaDescription={"The type of object represented in the table."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"preview"} required={false} schemaDescription={"A sample of the data in the table."} schemaName={"array[]"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>Identity</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
A table of identities that match the search criteria.
|
|
|
|
</div><SchemaItem collapsible={false} name={"count"} required={false} schemaDescription={"The number of rows in the table."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"noun"} required={false} schemaDescription={"The type of object represented in the table."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"preview"} required={false} schemaDescription={"A sample of the data in the table."} schemaName={"array[]"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"signedS3Url"} required={false} schemaDescription={"The Amazon S3 URL to download the report from."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></TabItem><TabItem label={"MOD18"} value={"17-item-properties"}><SchemaItem collapsible={false} name={"uuid"} required={false} schemaDescription={"Source unique identifier for the identity. UUID is generated by the source system."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={"SailPoint generated unique identifier."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"nativeIdentifier"} required={false} schemaDescription={"Unique ID of the account on the source."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"sourceId"} required={false} schemaDescription={"The ID of the source."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"sourceName"} required={false} schemaDescription={"The name of the source."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"identityId"} required={false} schemaDescription={"The ID of the identity that is corellated with this account."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"identityName"} required={false} schemaDescription={"The name of the identity that is corellated with this account."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>attributes</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
The attributes of the account. The contents of attributes depends on the account schema for the source.
|
|
|
|
</div></div></details></SchemaItem></TabItem><TabItem label={"MOD19"} value={"18-item-properties"}><SchemaItem collapsible={false} name={"uuid"} required={false} schemaDescription={"Source unique identifier for the identity. UUID is generated by the source system."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={"SailPoint generated unique identifier."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"nativeIdentifier"} required={false} schemaDescription={"Unique ID of the account on the source."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"sourceId"} required={false} schemaDescription={"The ID of the source."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"sourceName"} required={false} schemaDescription={"The name of the source."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"identityId"} required={false} schemaDescription={"The ID of the identity that is corellated with this account."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"identityName"} required={false} schemaDescription={"The name of the identity that is corellated with this account."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>attributes</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
The attributes of the account. The contents of attributes depends on the account schema for the source.
|
|
|
|
</div></div></details></SchemaItem></TabItem><TabItem label={"MOD20"} value={"19-item-properties"}><SchemaItem collapsible={false} name={"uuid"} required={false} schemaDescription={"Source unique identifier for the identity. UUID is generated by the source system."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={"SailPoint generated unique identifier."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"nativeIdentifier"} required={false} schemaDescription={"Unique ID of the account on the source."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"sourceId"} required={false} schemaDescription={"The ID of the source."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"sourceName"} required={false} schemaDescription={"The name of the source."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"identityId"} required={false} schemaDescription={"The ID of the identity that is corellated with this account."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"identityName"} required={false} schemaDescription={"The name of the identity that is corellated with this account."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>attributes</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
The attributes of the account. The contents of attributes depends on the account schema for the source.
|
|
|
|
</div></div></details></SchemaItem></TabItem><TabItem label={"Source Created"} value={"20-item-properties"}><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={"The unique ID of the source."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaDescription={"Human friendly name of the source."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaDescription={"The connection type."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaDescription={"The date and time the source was created."} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"connector"} required={false} schemaDescription={"The connector type used to connect to the source."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>actor</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"type"} required={false} schemaDescription={"DTO type"} schemaName={"string"} qualifierMessage={"**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_CATEGORY`, `TASK_RESULT`, `REPORT_RESULT`, `SOD_VIOLATION`, `ACCOUNT_ACTIVITY`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={"ID of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaDescription={"Human-readable display name of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem></TabItem><TabItem label={"Source Deleted"} value={"21-item-properties"}><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={"The unique ID of the source."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaDescription={"Human friendly name of the source."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaDescription={"The connection type."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"deleted"} required={false} schemaDescription={"The date and time the source was deleted."} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"connector"} required={false} schemaDescription={"The connector type used to connect to the source."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>actor</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"type"} required={false} schemaDescription={"DTO type"} schemaName={"string"} qualifierMessage={"**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_CATEGORY`, `TASK_RESULT`, `REPORT_RESULT`, `SOD_VIOLATION`, `ACCOUNT_ACTIVITY`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={"ID of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaDescription={"Human-readable display name of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem></TabItem><TabItem label={"Source Updated"} value={"22-item-properties"}><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={"The unique ID of the source."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaDescription={"The user friendly name of the source."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaDescription={"The connection type of the source."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaDescription={"The date and time the source was modified."} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"connector"} required={false} schemaDescription={"The connector type used to connect to the source."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>actor</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"type"} required={false} schemaDescription={"DTO type"} schemaName={"string"} qualifierMessage={"**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_CATEGORY`, `TASK_RESULT`, `REPORT_RESULT`, `SOD_VIOLATION`, `ACCOUNT_ACTIVITY`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={"ID of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaDescription={"Human-readable display name of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem></TabItem><TabItem label={"VA Cluster Status Change Event"} value={"23-item-properties"}><SchemaItem collapsible={false} name={"created"} required={false} schemaDescription={"The date and time the status change occurred."} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaDescription={"The type of the object that initiated this event."} schemaName={""} qualifierMessage={"**Possible values:** [`SOURCE`, `CLUSTER`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>application</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Details about the `CLUSTER` or `SOURCE` that initiated this event.
|
|
|
|
</div><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={"The GUID of the application"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaDescription={"The name of the application"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>attributes</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Custom map of attributes for a source. This will only be populated if type is `SOURCE` and the source has a proxy.
|
|
|
|
</div></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>healthCheckResult</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
The results of the most recent health check.
|
|
|
|
</div><SchemaItem collapsible={false} name={"message"} required={false} schemaDescription={"Detailed message of the result of the health check."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"resultType"} required={false} schemaDescription={"The type of the health check result."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaDescription={"The status of the health check."} schemaName={""} qualifierMessage={"**Possible values:** [`Succeeded`, `Failed`]"} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>previousHealthCheckResult</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
The results of the last health check.
|
|
|
|
</div><SchemaItem collapsible={false} name={"message"} required={false} schemaDescription={"Detailed message of the result of the health check."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"resultType"} required={false} schemaDescription={"The type of the health check result."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaDescription={"The status of the health check."} schemaName={""} qualifierMessage={"**Possible values:** [`Succeeded`, `Failed`]"} defaultValue={undefined}></SchemaItem></div></details></SchemaItem></TabItem></SchemaTabs></div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"outputSchema"} required={false} schemaDescription={"The JSON schema of the response that will be sent by the subscribed service to the trigger in response to an event. This only applies to a trigger type of `REQUEST_RESPONSE`."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>exampleOutput</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
An example of the JSON payload that will be sent by the subscribed service to the trigger in response to an event.
|
|
|
|
</div><li><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"Access Request Dynamic Approver"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={"The unique ID of the identity to add to the approver list for the access request."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaDescription={"The name of the identity to add to the approver list for the access request."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaDescription={"The type of object being referenced."} schemaName={""} qualifierMessage={"**Possible values:** [`IDENTITY`, `GOVERNANCE_GROUP`]"} defaultValue={undefined}></SchemaItem></TabItem><TabItem label={"Access Request Pre Approval"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"approved"} required={false} schemaDescription={"Whether or not to approve the access request."} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"comment"} required={false} schemaDescription={"A comment about the decision to approve or deny the request."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"approver"} required={false} schemaDescription={"The name of the entity that approved or denied the request."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></TabItem></SchemaTabs></div></li></div></details></SchemaItem></ul></details></TabTtem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
|
|
|
Client Error - Returned if the request body is invalid.
|
|
|
|
</div><div><MimeTabs groupId={"mime-type"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs groupId={"schema-tabs"}><TabTtem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaDescription={"Fine-grained error code providing more detail of the error."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaDescription={"Unique tracking id for the error."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>messages</strong><span style={{"opacity":"0.6"}}> object[]</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Generic localized reason for error
|
|
|
|
</div><SchemaItem collapsible={false} name={"locale"} required={false} schemaDescription={"The locale for the message text, a BCP 47 language tag."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaDescription={"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."} schemaName={"string"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaDescription={"Actual text of the error message in the indicated locale."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>causes</strong><span style={{"opacity":"0.6"}}> object[]</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
|
|
|
</div><SchemaItem collapsible={false} name={"locale"} required={false} schemaDescription={"The locale for the message text, a BCP 47 language tag."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaDescription={"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."} schemaName={"string"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaDescription={"Actual text of the error message in the indicated locale."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem></ul></details></TabTtem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
|
|
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
|
|
|
</div><div><MimeTabs groupId={"mime-type"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs groupId={"schema-tabs"}><TabTtem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaDescription={"A message describing the error"} schemaName={""} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></ul></details></TabTtem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
|
|
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
|
|
|
</div><div><MimeTabs groupId={"mime-type"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs groupId={"schema-tabs"}><TabTtem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaDescription={"Fine-grained error code providing more detail of the error."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaDescription={"Unique tracking id for the error."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>messages</strong><span style={{"opacity":"0.6"}}> object[]</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Generic localized reason for error
|
|
|
|
</div><SchemaItem collapsible={false} name={"locale"} required={false} schemaDescription={"The locale for the message text, a BCP 47 language tag."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaDescription={"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."} schemaName={"string"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaDescription={"Actual text of the error message in the indicated locale."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>causes</strong><span style={{"opacity":"0.6"}}> object[]</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
|
|
|
</div><SchemaItem collapsible={false} name={"locale"} required={false} schemaDescription={"The locale for the message text, a BCP 47 language tag."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaDescription={"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."} schemaName={"string"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaDescription={"Actual text of the error message in the indicated locale."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem></ul></details></TabTtem><TabItem label={"403"} value={"403"}><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
|
|
|
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.
|
|
|
|
</div><div><MimeTabs groupId={"mime-type"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs groupId={"schema-tabs"}><TabTtem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaDescription={"A message describing the error"} schemaName={""} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></ul></details></TabTtem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
|
|
|
Internal Server Error - Returned if there is an unexpected error.
|
|
|
|
</div><div><MimeTabs groupId={"mime-type"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs groupId={"schema-tabs"}><TabTtem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaDescription={"Fine-grained error code providing more detail of the error."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaDescription={"Unique tracking id for the error."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>messages</strong><span style={{"opacity":"0.6"}}> object[]</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Generic localized reason for error
|
|
|
|
</div><SchemaItem collapsible={false} name={"locale"} required={false} schemaDescription={"The locale for the message text, a BCP 47 language tag."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaDescription={"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."} schemaName={"string"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaDescription={"Actual text of the error message in the indicated locale."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>causes</strong><span style={{"opacity":"0.6"}}> object[]</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
|
|
|
</div><SchemaItem collapsible={false} name={"locale"} required={false} schemaDescription={"The locale for the message text, a BCP 47 language tag."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaDescription={"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."} schemaName={"string"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaDescription={"Actual text of the error message in the indicated locale."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem></ul></details></TabTtem><TabItem label={"500"} value={"500"}><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div>
|
|
|