Create a Reassignment Configuration

POST 
https://sailpoint.api.identitynow.com/v2024/reassignment-configurations

experimental

This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.

Creates a new Reassignment Configuration for the specified identity.

Request

Header Parameters

X-SailPoint-Experimental stringrequired
Use this header to enable this experimental API.
Default value: true
Example: true

application/json

Bodyrequired

reassignedFromIdstring
The identity id to reassign an item from
Example: 2c91808781a71ddb0181b9090b5c504e
reassignedToIdstring
The identity id to reassign an item to
Example: 2c91808781a71ddb0181b9090b53504a
configTypestring
Enum list of valid work types that can be selected for a Reassignment Configuration
Possible values: [ACCESS_REQUESTS, CERTIFICATIONS, MANUAL_TASKS]
Example: ACCESS_REQUESTS
startDatedate-time
The date from which to start reassigning work items
Example: 2022-07-21T11:13:12.345Z
endDatedate-timenullable
The date from which to stop reassigning work items. If this is an null string it indicates a permanent reassignment.
Example: 2022-07-30T17:00:00.000Z

Responses

201

The newly created Reassignment Configuration object

application/json

Schema

Schema

identity object
The definition of an Identity according to the Reassignment Configuration service
idstring
The ID of the object
Example: 2c91808380aa05580180aaaaf1940410
namestring
Human-readable display name of the object
Example: William Wilson
configDetails object[]
Details of how work should be reassigned for an Identity
Array [
configTypestring
Enum list of valid work types that can be selected for a Reassignment Configuration
Possible values: [ACCESS_REQUESTS, CERTIFICATIONS, MANUAL_TASKS]
Example: ACCESS_REQUESTS
targetIdentity object
The definition of an Identity according to the Reassignment Configuration service
idstring
The ID of the object
Example: 2c91808380aa05580180aaaaf1940410
namestring
Human-readable display name of the object
Example: William Wilson
startDatedate-time
The date from which to start reassigning work items
Example: 2022-07-21T11:13:12.345Z
endDatedate-time
The date from which to stop reassigning work items. If this is an empty string it indicates a permanent reassignment.
Example: 0001-01-01T00:00:00Z
auditDetails object
Audit details for the reassignment configuration of an identity
createddate-time
Initial date and time when the record was created
Example: 2022-07-21T11:13:12.345Z
createdBy object
The definition of an Identity according to the Reassignment Configuration service
idstring
The ID of the object
Example: 2c91808380aa05580180aaaaf1940410
namestring
Human-readable display name of the object
Example: William Wilson
modifieddate-time
Last modified date and time for the record
Example: 2022-07-21T11:13:12.345Z
modifiedBy object
The definition of an Identity according to the Reassignment Configuration service
idstring
The ID of the object
Example: 2c91808380aa05580180aaaaf1940410
namestring
Human-readable display name of the object
Example: William Wilson
]

Example (auto)

{
  "identity": {
    "id": "2c91808380aa05580180aaaaf1940410",
    "name": "William Wilson"
  },
  "configDetails": [
    {
      "configType": "ACCESS_REQUESTS",
      "targetIdentity": {
        "id": "2c91808380aa05580180aaaaf1940410",
        "name": "William Wilson"
      },
      "startDate": "2022-07-21T11:13:12.345Z",
      "endDate": "0001-01-01T00:00:00Z",
      "auditDetails": {
        "created": "2022-07-21T11:13:12.345Z",
        "createdBy": {
          "id": "2c91808380aa05580180aaaaf1940410",
          "name": "William Wilson"
        },
        "modified": "2022-07-21T11:13:12.345Z",
        "modifiedBy": {
          "id": "2c91808380aa05580180aaaaf1940410",
          "name": "William Wilson"
        }
      }
    }
  ]
}

400

Client Error - Returned if the request body is invalid.

application/json

Schema

Schema

detailCodestring
Fine-grained error code providing more detail of the error.
Example: 400.1 Bad Request Content
trackingIdstring
Unique tracking id for the error.
Example: e7eab60924f64aa284175b9fa3309599
messages object[]
Generic localized reason for error
Array [
localestringnullable
The locale for the message text, a BCP 47 language tag.
Example: en-US
localeOriginstringnullable
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.
Possible values: [DEFAULT, REQUEST, null]
Example: DEFAULT
textstring
Actual text of the error message in the indicated locale.
Example: The request was syntactically correct but its content is semantically invalid.
]
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
Array [
localestringnullable
The locale for the message text, a BCP 47 language tag.
Example: en-US
localeOriginstringnullable
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.
Possible values: [DEFAULT, REQUEST, null]
Example: DEFAULT
textstring
Actual text of the error message in the indicated locale.
Example: The request was syntactically correct but its content is semantically invalid.
]

Example (auto)

{
  "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: JWT validation failed: JWT is expired

Example (auto)

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

detailCodestring
Fine-grained error code providing more detail of the error.
Example: 400.1 Bad Request Content
trackingIdstring
Unique tracking id for the error.
Example: e7eab60924f64aa284175b9fa3309599
messages object[]
Generic localized reason for error
Array [
localestringnullable
The locale for the message text, a BCP 47 language tag.
Example: en-US
localeOriginstringnullable
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.
Possible values: [DEFAULT, REQUEST, null]
Example: DEFAULT
textstring
Actual text of the error message in the indicated locale.
Example: The request was syntactically correct but its content is semantically invalid.
]
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
Array [
localestringnullable
The locale for the message text, a BCP 47 language tag.
Example: en-US
localeOriginstringnullable
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.
Possible values: [DEFAULT, REQUEST, null]
Example: DEFAULT
textstring
Actual text of the error message in the indicated locale.
Example: The request was syntactically correct but its content is semantically invalid.
]

Example (auto)

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

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: Rate Limit Exceeded

Example (auto)

{
  "message": " Rate Limit Exceeded "
}

500

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

application/json

Schema

Schema

detailCodestring
Fine-grained error code providing more detail of the error.
Example: 400.1 Bad Request Content
trackingIdstring
Unique tracking id for the error.
Example: e7eab60924f64aa284175b9fa3309599
messages object[]
Generic localized reason for error
Array [
localestringnullable
The locale for the message text, a BCP 47 language tag.
Example: en-US
localeOriginstringnullable
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.
Possible values: [DEFAULT, REQUEST, null]
Example: DEFAULT
textstring
Actual text of the error message in the indicated locale.
Example: The request was syntactically correct but its content is semantically invalid.
]
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
Array [
localestringnullable
The locale for the message text, a BCP 47 language tag.
Example: en-US
localeOriginstringnullable
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.
Possible values: [DEFAULT, REQUEST, null]
Example: DEFAULT
textstring
Actual text of the error message in the indicated locale.
Example: The request was syntactically correct but its content is semantically invalid.
]

Example (auto)

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

Authorization: oauth2

type: Personal Access Token
scopes: idn:reassignment-configuration:create

• go
• powershell
  SailPoint SDK
• python
  SailPoint SDK
• csharp
• curl
• dart
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• r
• ruby
• rust
• shell
• swift

• NATIVE

Request Collapse all

Base URL

https://sailpoint.api.identitynow.com/v2024

Auth

Bearer Token

Parameters

X-SailPoint-Experimental — headerrequired

Body required

{
  "reassignedFromId": "2c91808781a71ddb0181b9090b5c504e",
  "reassignedToId": "2c91808781a71ddb0181b9090b53504a",
  "configType": "ACCESS_REQUESTS",
  "startDate": "2022-07-21T11:13:12.345Z",
  "endDate": "2022-07-30T17:00:00.000Z"
}

ResponseClear

Click the Send API Request button above and see the response here!