List Identity Campaign Certifications
GET/certifications
Use this API to get a list of identity campaign certifications for the specified query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. This API does not support requests for certifications assigned to governance groups.
Request
Query Parameters
Reviewer's identity. me indicates the current user.
Possible values: <= 250
Default value: 250
Max number of results to return. See V3 API Standard Collection Parameters for more information.
Default value: 0
Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.
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.
Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used.
See V3 API Standard Collection Parameters for more information.
Filter results using the standard syntax described in V3 API Standard Collection Parameters
Filtering is supported for the following fields and operators:
id: eq, in
campaign.id: eq, in
phase: eq
completed: eq
Sort results using the standard syntax described in V3 API Standard Collection Parameters
Sorting is supported for the following fields: name, due, signed
Responses
- 200
- 400
- 401
- 403
- 429
- 500
List of identity campaign certifications.
- application/json
- Schema
- Example (from schema)
Schema
Array [
STAGED
: The campaign is waiting to be activated.ACTIVE
: The campaign is active.SIGNED
: The reviewer has signed off on the campaign, and it is considered complete.]
id of the certification
name of the certification
campaign
object
The unique ID of the campaign.
The name of the campaign.
Possible values: [CAMPAIGN
]
The type of object that is being referenced.
Possible values: [MANAGER
, SOURCE_OWNER
, SEARCH
]
The type of the campaign.
The description of the campaign set by the admin who created it.
Possible values: [CORRELATED
, UNCORRELATED
]
The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source).
Possible values: [ALL_DECISIONS
, REVOKE_ONLY_DECISIONS
, NO_DECISIONS
]
Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions.
Have all decisions been made?
The number of identities for whom all decisions have been made and are complete.
The total number of identities in the Certification, both complete and incomplete.
created date
modified date
The number of approve/revoke/acknowledge decisions that have been made.
The total number of approve/revoke/acknowledge decisions.
The due date of the certification.
The date the reviewer signed off on the Certification.
reviewer
object
The id of the reviewer.
The name of the reviewer.
The email of the reviewing identity.
Possible values: [IDENTITY
]
The type of the reviewing identity.
The created date of the reviewing identity.
The modified date of the reviewing identity.
reassignment
object
nullable
from
object
The id of the certification.
The name of the certification.
Possible values: [CERTIFICATION
]
reviewer
object
The id of the reviewer.
The name of the reviewer.
The email of the reviewing identity.
Possible values: [IDENTITY
]
The type of the reviewing identity.
The created date of the reviewing identity.
The modified date of the reviewing identity.
The comment entered when the Certification was reassigned
Identifies if the certification has an error
Description of the certification error
Possible values: [STAGED
, ACTIVE
, SIGNED
]
The current phase of the campaign.
[
{
"id": "2c9180835d2e5168015d32f890ca1581",
"name": "Source Owner Access Review for Employees [source]",
"campaign": {
"id": "ef38f94347e94562b5bb8424a56397d8",
"name": "Campaign Name",
"type": "CAMPAIGN",
"campaignType": "MANAGER",
"description": "A description of the campaign",
"correlatedStatus": "CORRELATED",
"mandatoryCommentRequirement": "NO_DECISIONS"
},
"completed": true,
"identitiesCompleted": 5,
"identitiesTotal": 10,
"created": "2018-06-25T20:22:28.104Z",
"modified": "2018-06-25T20:22:28.104Z",
"decisionsMade": 20,
"decisionsTotal": 40,
"due": "2018-10-19T13:49:37.385Z",
"signed": "2018-10-19T13:49:37.385Z",
"reviewer": {
"id": "ef38f94347e94562b5bb8424a56397d8",
"name": "Reviewer Name",
"email": "[email protected]",
"type": "IDENTITY",
"created": "2018-06-25T20:22:28.104Z",
"modified": "2018-06-25T20:22:28.104Z"
},
"reassignment": {
"from": {
"id": "ef38f94347e94562b5bb8424a56397d8",
"name": "Certification Name",
"type": "CERTIFICATION",
"reviewer": {
"id": "ef38f94347e94562b5bb8424a56397d8",
"name": "Reviewer Name",
"email": "[email protected]",
"type": "IDENTITY",
"created": "2018-06-25T20:22:28.104Z",
"modified": "2018-06-25T20:22:28.104Z"
}
},
"comment": "Reassigned for a reason"
},
"hasErrors": false,
"errorMessage": "The certification has an error",
"phase": "ACTIVE"
}
]
Client Error - Returned if the request body is invalid.
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Array [
]
Fine-grained error code providing more detail of the error.
Unique tracking id for the error.
messages
object[]
Generic localized reason for error
The locale for the message text, a BCP 47 language tag.
Possible values: [DEFAULT
, REQUEST
, null
]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Actual text of the error message in the indicated locale.
causes
object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
The locale for the message text, a BCP 47 language tag.
Possible values: [DEFAULT
, REQUEST
, null
]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Actual text of the error message in the indicated locale.
{
"detailCode": "400.1 Bad Request Content",
"trackingId": "e7eab60924f64aa284175b9fa3309599",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The request was syntactically correct but its content is semantically invalid."
}
],
"causes": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The request was syntactically correct but its content is semantically invalid."
}
]
}
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
- application/json
- Schema
- Example (from schema)
Schema
A message describing the error
{
"error": "JWT validation failed: JWT is expired"
}
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
- application/json
- Schema
- Example (from schema)
- 403
Schema
Array [
]
Array [
]
Fine-grained error code providing more detail of the error.
Unique tracking id for the error.
messages
object[]
Generic localized reason for error
The locale for the message text, a BCP 47 language tag.
Possible values: [DEFAULT
, REQUEST
, null
]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Actual text of the error message in the indicated locale.
causes
object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
The locale for the message text, a BCP 47 language tag.
Possible values: [DEFAULT
, REQUEST
, null
]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Actual text of the error message in the indicated locale.
{
"detailCode": "400.1 Bad Request Content",
"trackingId": "e7eab60924f64aa284175b9fa3309599",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The request was syntactically correct but its content is semantically invalid."
}
],
"causes": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The request was syntactically correct but its content is semantically invalid."
}
]
}
An example of a 403 response object
{
"detailCode": "403 Forbidden",
"trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The server understood the request but refuses to authorize it."
}
]
}
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
- application/json
- Schema
- Example (from schema)
Schema
A message describing the error
{
"message": " Rate Limit Exceeded "
}
Internal Server Error - Returned if there is an unexpected error.
- application/json
- Schema
- Example (from schema)
- 500
Schema
Array [
]
Array [
]
Fine-grained error code providing more detail of the error.
Unique tracking id for the error.
messages
object[]
Generic localized reason for error
The locale for the message text, a BCP 47 language tag.
Possible values: [DEFAULT
, REQUEST
, null
]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Actual text of the error message in the indicated locale.
causes
object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
The locale for the message text, a BCP 47 language tag.
Possible values: [DEFAULT
, REQUEST
, null
]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Actual text of the error message in the indicated locale.
{
"detailCode": "400.1 Bad Request Content",
"trackingId": "e7eab60924f64aa284175b9fa3309599",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The request was syntactically correct but its content is semantically invalid."
}
],
"causes": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The request was syntactically correct but its content is semantically invalid."
}
]
}
An example of a 500 response object
{
"detailCode": "500.0 Internal Fault",
"trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "An internal fault occurred."
}
]
}