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

application/json

Body

required

ids string[]nullable

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

uninvited boolean

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

Responses

202

Responds with an initial TaskStatus for the executed task

application/json

Schema

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

object

nullable

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

object

nullable

required

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

object

required

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

object

required

Formal parameters of the TaskDefinition, without values

property name* any

Formal parameters of the TaskDefinition, without values

Example (from schema)

{
  "id": "id12345",
  "type": "QUARTZ",
  "uniqueName": "Big Task",
  "description": "A Really Big Task",
  "parentName": "Parent Task",
  "launcher": "sweep",
  "target": {
    "id": "c6dc37bf508149b28ce5b7d90ca4bbf9",
    "type": "APPLICATION",
    "name": "Active Directory [source]"
  },
  "created": "2020-07-11T21:23:15.000Z",
  "modified": "2020-07-11T21:23:15.000Z",
  "launched": "2020-07-11T21:23:15.000Z",
  "completed": "2020-07-11T21:23:15.000Z",
  "completionStatus": "SUCCESS",
  "messages": [
    {
      "type": "INFO",
      "localizedText": {
        "locale": "An error has occurred!",
        "message": "Error has occurred!"
      },
      "key": "akey",
      "parameters": [
        {
          "name": "value"
        }
      ]
    }
  ],
  "returns": [
    {
      "name": "label",
      "attributeName": "identityCount"
    }
  ],
  "attributes": {
    "identityCount": 0
  },
  "progress": "Started",
  "percentComplete": 100,
  "taskDefinitionSummary": {
    "id": "2c91808475b4334b0175e1dff64b63c5",
    "uniqueName": "Cloud Account Aggregation",
    "description": "Aggregates from the specified application.",
    "parentName": "Cloud Account Aggregation",
    "executor": "sailpoint.task.ServiceTaskExecutor",
    "arguments": {}
  }
}

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