Identity Certification by ID

GET 
/certifications/:id

This API returns a single identity campaign certification by its ID. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups.

Request

Path Parameters

id stringrequired
The certification id
Example: ef38f94347e94562b5bb8424a56397d8

Responses

200

An identity campaign certification object

application/json

Schema

Schema

id string

id of the certification

name string

name of the certification

campaign

object

id stringrequired

The unique ID of the campaign.

name stringrequired

The name of the campaign.

type stringrequired

Possible values: [CAMPAIGN]

The type of object that is being referenced.

campaignType stringrequired

Possible values: [MANAGER, SOURCE_OWNER, SEARCH]

The type of the campaign.

description stringnullablerequired

The description of the campaign set by the admin who created it.

correlatedStatus stringrequired

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

mandatoryCommentRequirement stringrequired

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.

completed boolean

Have all decisions been made?

identitiesCompleted int32

The number of identities for whom all decisions have been made and are complete.

identitiesTotal int32

The total number of identities in the Certification, both complete and incomplete.

created date-time

created date

modified date-time

modified date

decisionsMade int32

The number of approve/revoke/acknowledge decisions that have been made.

decisionsTotal int32

The total number of approve/revoke/acknowledge decisions.

due date-time

The due date of the certification.

signed date-timenullable

The date the reviewer signed off on the Certification.

reviewer

object

id string

The id of the reviewer.

name string

The name of the reviewer.

email string

The email of the reviewing identity.

type string

Possible values: [IDENTITY]

The type of the reviewing identity.

created date-timenullable

The created date of the reviewing identity.

modified date-timenullable

The modified date of the reviewing identity.

reassignment

object

nullable

from

object

id string

The id of the certification.

name string

The name of the certification.

type string

Possible values: [CERTIFICATION]

reviewer

object

id string

The id of the reviewer.

name string

The name of the reviewer.

email string

The email of the reviewing identity.

type string

Possible values: [IDENTITY]

The type of the reviewing identity.

created date-timenullable

The created date of the reviewing identity.

modified date-timenullable

The modified date of the reviewing identity.

comment string

The comment entered when the Certification was reassigned

hasErrors boolean

Identifies if the certification has an error

errorMessage stringnullable

Description of the certification error

phase CertificationPhase (string)
Possible values: [STAGED, ACTIVE, SIGNED]
The current phase of the campaign.
• 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.

Example (from schema)

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

400

Client Error - Returned if the request body is invalid.

application/json

Schema

Schema

detailCode string

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

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

causes

object[]

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

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

401

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

application/json

Schema

Schema

error

A message describing the error

Example (from schema)

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

403

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

application/json

Schema

Schema

detailCode string

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

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

causes

object[]

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

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

403

An example of a 403 response object

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

404

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

application/json

Schema

Schema

detailCode string

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

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

causes

object[]

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

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

404

An example of a 404 response object

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

429

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

application/json

Schema

Schema

message

A message describing the error

Example (from schema)

{
  "message": " Rate Limit Exceeded "
}

500

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

application/json

Schema

Schema

detailCode string

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

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

causes

object[]

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

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

500

An example of a 500 response object

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

Loading...