Update Reassignment Configuration
PUT/reassignment-configurations/:identityId
Replaces existing Reassignment configuration for an identity with the newly provided configuration.
Request
Path Parameters
unique identity id
- application/json
Body
required
The identity id to reassign an item from
The identity id to reassign an item to
Possible values: [ACCESS_REQUESTS
, CERTIFICATIONS
, MANUAL_TASKS
]
Enum list of valid work types that can be selected for a Reassignment Configuration
The date from which to start reassigning work items
The date from which to stop reassigning work items. If this is an null string it indicates a permanent reassignment.
Responses
- 200
- 400
- 401
- 403
- 429
- 500
Reassignment Configuration updated
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
identity
object
The definition of an Identity according to the Reassignment Configuration service
The ID of the object
Human-readable display name of the object
configDetails
object[]
Details of how work should be reassigned for an Identity
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
The ID of the object
Human-readable display name of the object
The date from which to start reassigning work items
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
Initial date and time when the record was created
createdBy
object
The definition of an Identity according to the Reassignment Configuration service
The ID of the object
Human-readable display name of the object
Last modified date and time for the record
modifiedBy
object
The definition of an Identity according to the Reassignment Configuration service
The ID of the object
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
Array [
]
Array [
]
Fine-grained error code providing more detail of the error.
Unique tracking id for the error.
messages
object[]
Generic localized reason for error
The locale for the message text, a BCP 47 language tag.
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.
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
The locale for the message text, a BCP 47 language tag.
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.
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
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
Array [
]
Array [
]
Fine-grained error code providing more detail of the error.
Unique tracking id for the error.
messages
object[]
Generic localized reason for error
The locale for the message text, a BCP 47 language tag.
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.
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
The locale for the message text, a BCP 47 language tag.
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.
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
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
Array [
]
Array [
]
Fine-grained error code providing more detail of the error.
Unique tracking id for the error.
messages
object[]
Generic localized reason for error
The locale for the message text, a BCP 47 language tag.
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.
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
The locale for the message text, a BCP 47 language tag.
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.
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."
}
]
}