Skip to main content

Reassign Certifications Asynchronously

POST 

/certifications/:id/reassign-async

This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another reviewer. The certification-tasks API can be used to get an updated status on the task and determine when the reassignment is complete.

Reviewers for this certification can also call this API.

Request

Path Parameters

    id stringrequired

    The identity campaign certification ID

    Example: ef38f94347e94562b5bb8424a56397d8

Body

required

    reassign

    object[]

    required

  • Array [

  • id stringrequired

    The ID of item or identity being reassigned.

    type stringrequired

    Possible values: [TARGET_SUMMARY, ITEM, IDENTITY_SUMMARY]

    The type of item or identity being reassigned.

  • ]

  • reassignTo stringrequired

    The ID of the identity to which the certification is reassigned

    reason stringrequired

    The reason comment for why the reassign was made

Responses

A certification task object for the reassignment which can be queried for status.

Schema

    id string

    The ID of the certification task.

    type string

    Possible values: [REASSIGN, ADMIN_REASSIGN, COMPLETE_CERTIFICATION, FINISH_CERTIFICATION, COMPLETE_CAMPAIGN, ACTIVATE_CAMPAIGN, CAMPAIGN_CREATE, CAMPAIGN_DELETE]

    The type of the certification task. More values may be added in the future.

    targetType string

    Possible values: [CERTIFICATION, CAMPAIGN]

    The type of item that is being operated on by this task whose ID is stored in the targetId field.

    targetId string

    The ID of the item being operated on by this task.

    status string

    Possible values: [QUEUED, IN_PROGRESS, SUCCESS, ERROR]

    The status of the task.

    errors

    object[]

    A list of errors that have been encountered by the task.

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

  • ]

  • reassignmentTrailDTOs

    object[]

    Reassignment trails that lead to self certification identity

  • Array [

  • previousOwner string

    The ID of previous owner identity.

    newOwner string

    The ID of new owner identity.

    reassignmentType string

    The type of reassignment.

  • ]

  • created date-time

    The date and time on which this task was created.

Loading...