Skip to main content

Identity Campaign Certifications by IDs

GET 

/certifications

This API returns a list of identity campaign certifications that satisfy the given 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-identity string

    The ID of reviewer identity. me indicates the current user.

    Example: me
    limit int32

    Possible values: <= 250

    Default value: 250

    Max number of results to return. See V3 API Standard Collection Parameters for more information.

    Example: 250
    offset int32

    Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.

    Example: 0
    count boolean

    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.

    Example: true
    filters string

    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, ne

    Example: id eq "ef38f94347e94562b5bb8424a56397d8"
    sorters comma-separated

    Sort results using the standard syntax described in V3 API Standard Collection Parameters

    Sorting is supported for the following fields: name, due, signed

    Example: name,due

Responses

List of identity campaign certifications

Schema
  • Array [
  • 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 required

    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 objectnullable
    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

    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.
  • ]
Loading...