Skip to main content

Invite identities to register

POST 

/identities/invite

This API submits a task for inviting given identities via email to complete registration. The invitation email will include the link. After selecting the link an identity will be able to set up password and log in into the system. Invitations expire after 7 days. By default invitations send to the work identity email. It can be changed in Admin > Identities > Identity Profiles by selecting corresponding profile and editing Invitation Options.

This task will send an invitation email only for unregistered identities.

The executed task status can be checked by Task Management > Get task status by ID

A token with ORG_ADMIN or HELPDESK authority is required to call this API.

Request

Body

required
    ids string[]nullable

    The list of Identities IDs to invite - required when 'uninvited' is false

    uninvited boolean

    Default value: false

    indicator (optional) to invite all unregistered identities in the system within a limit 1000. This parameter makes sense only when 'ids' is empty.

Responses

Responds with an initial TaskStatus for the executed task

Schema
    id stringrequired

    System-generated unique ID of the task this TaskStatus represents

    type stringrequired

    Possible values: [QUARTZ, QPOC, QUEUED_TASK]

    Type of task this TaskStatus represents

    uniqueName stringrequired

    Name of the task this TaskStatus represents

    description stringrequired

    Description of the task this TaskStatus represents

    parentName stringnullablerequired

    Name of the parent of the task this TaskStatus represents

    launcher stringrequired

    Service to execute the task this TaskStatus represents

    target objectnullable
    id string

    Target ID

    type stringnullable

    Possible values: [APPLICATION, IDENTITY, null]

    Target type

    name string

    Target name

    created date-timerequired

    Creation date of the task this TaskStatus represents

    modified date-timerequired

    Last modification date of the task this TaskStatus represents

    launched date-timenullablerequired

    Launch date of the task this TaskStatus represents

    completed date-timenullablerequired

    Completion date of the task this TaskStatus represents

    completionStatus stringnullablerequired

    Possible values: [SUCCESS, WARNING, ERROR, TERMINATED, TEMPERROR, null]

    Completion status of the task this TaskStatus represents

    messages object[]required

    Messages associated with the task this TaskStatus represents

  • Array [
  • type stringrequired

    Possible values: [INFO, WARN, ERROR]

    Type of the message

    localizedText objectnullablerequired

    Localized form of the message

    locale stringrequired

    Message locale

    message stringrequired

    Message text

    key stringrequired

    Key of the message

    parameters object[]nullablerequired

    Message parameters for internationalization

  • ]
  • returns object[]required

    Return values from the task this TaskStatus represents

  • Array [
  • name stringrequired

    Display name of the TaskReturnDetails

    attributeName stringrequired

    Attribute the TaskReturnDetails is for

  • ]
  • attributes objectrequired

    Attributes of the task this TaskStatus represents

    property name* any

    Attributes of the task this TaskStatus represents

    progress stringnullablerequired

    Current progress of the task this TaskStatus represents

    percentComplete integerrequired

    Current percentage completion of the task this TaskStatus represents

    taskDefinitionSummary object

    Definition of a type of task, used to invoke tasks

    id stringrequired

    System-generated unique ID of the TaskDefinition

    uniqueName stringrequired

    Name of the TaskDefinition

    description stringrequired

    Description of the TaskDefinition

    parentName stringrequired

    Name of the parent of the TaskDefinition

    executor stringnullablerequired

    Executor of the TaskDefinition

    arguments objectrequired

    Formal parameters of the TaskDefinition, without values

    property name* any

    Formal parameters of the TaskDefinition, without values

Loading...