Create a Reassignment Configuration

Creates a new Reassignment Configuration for the specified identity.

application/json

Request Body required

• reassignedFromId string

  The identity id to reassign an item from

• reassignedToId string

  The identity id to reassign an item to

• configType string

  Possible values: [ACCESS_REQUESTS, CERTIFICATIONS, MANUAL_TASKS]

  Enum list of valid work types that can be selected for a Reassignment Configuration

• startDate date-time

  The date from which to start reassigning work items

• endDate date-time

  The date from which to stop reassigning work items. If this is an null string it indicates a permanent reassignment.

Responses

• 201
• 400
• 401
• 403
• 429
• 500

---

The newly created Reassignment Configuration object

application/json

• Schema
• Example (from schema)

---

Schema

• identity object

  The definition of an Identity according to the Reassignment Configuration service

  id string

  The ID of the object

  name string

  Human-readable display name of the object

• configDetails object[]

  Details of how work should be reassigned for an Identity

  configType string

  Possible values: [ACCESS_REQUESTS, CERTIFICATIONS, MANUAL_TASKS]

  Enum list of valid work types that can be selected for a Reassignment Configuration

  targetIdentity object

  The definition of an Identity according to the Reassignment Configuration service

  id string

  The ID of the object

  name string

  Human-readable display name of the object

  startDate date-time

  The date from which to start reassigning work items

  endDate date-time

  The date from which to stop reassigning work items. If this is an empty string it indicates a permanent reassignment.

  auditDetails object

  Audit details for the reassignment configuration of an identity

  created date-time

  Initial date and time when the record was created

  createdBy object

  The definition of an Identity according to the Reassignment Configuration service

  id string

  The ID of the object

  name string

  Human-readable display name of the object

  modified date-time

  Last modified date and time for the record

  modifiedBy object

  The definition of an Identity according to the Reassignment Configuration service

  id string

  The ID of the object

  name string

  Human-readable display name of the object

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

Client Error - Returned if the request body is invalid.

application/json

• Schema
• Example (from 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

  locale string

  The locale for the message text, a BCP 47 language tag.

  localeOrigin string

  Possible values: [DEFAULT, REQUEST]

  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

  locale string

  The locale for the message text, a BCP 47 language tag.

  localeOrigin string

  Possible values: [DEFAULT, REQUEST]

  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.

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

Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.

application/json

• Schema
• Example (from schema)

---

Schema

• error

  A message describing the error

{
  "error": "JWT validation failed: JWT is expired"
}

Forbidden - Returned if the user you are running as, doesn't have access to this end-point.

application/json

• Schema
• Example (from schema)
• 403

---

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

  locale string

  The locale for the message text, a BCP 47 language tag.

  localeOrigin string

  Possible values: [DEFAULT, REQUEST]

  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

  locale string

  The locale for the message text, a BCP 47 language tag.

  localeOrigin string

  Possible values: [DEFAULT, REQUEST]

  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.

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

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

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
• Example (from schema)

---

Schema

• message

  A message describing the error

{
  "message": " Rate Limit Exceeded "
}

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

application/json

• Schema
• Example (from schema)
• 500

---

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

  locale string

  The locale for the message text, a BCP 47 language tag.

  localeOrigin string

  Possible values: [DEFAULT, REQUEST]

  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

  locale string

  The locale for the message text, a BCP 47 language tag.

  localeOrigin string

  Possible values: [DEFAULT, REQUEST]

  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.

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

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