List Non-Employee Requests
GET/non-employee-requests
This gets a list of non-employee requests. There are two contextual uses for the requested-for
path parameter:
- The user has the role context of
idn:nesr:read
, in which case he or she may request a list non-employee requests assigned to a particular account manager by passing in that manager's id. - The current user is an account manager, in which case "me" should be
provided as the
requested-for
value. This will provide the user with a list of the non-employee requests in the source(s) he or she manages.
Request
Query Parameters
Possible values: <= 250
Default value: 250
Max number of results to return. See V3 API Standard Collection Parameters for more information.
Default value: 0
Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.
If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored.
Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used.
See V3 API Standard Collection Parameters for more information.
The identity for whom the request was made. me indicates the current user.
Sort results using the standard syntax described in V3 API Standard Collection Parameters
Sorting is supported for the following fields: created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate
Filter results using the standard syntax described in V3 API Standard Collection Parameters
Filtering is supported for the following fields and operators:
sourceId: eq
Responses
- 200
- 400
- 401
- 403
- 429
- 500
List of non-employee request objects.
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
]
]
Non-Employee source id.
Source Id associated with this non-employee source.
Source name associated with this non-employee source.
Source description associated with this non-employee source.
Requested identity account name.
Non-Employee's first name.
Non-Employee's last name.
Non-Employee's email.
Non-Employee's phone.
The account ID of a valid identity to serve as this non-employee's manager.
nonEmployeeSource
object
Non-Employee source id.
Source Id associated with this non-employee source.
Source name associated with this non-employee source.
Source description associated with this non-employee source.
data
object
Attribute blob/bag for a non-employee.
approvalItems
object[]
List of approval item for the request
Non-Employee approval item id
approver
object
Reference to the associated Identity
Possible values: [GOVERNANCE_GROUP
, IDENTITY
]
Identifies if the identity is a normal identity or a governance group
Identity id
Requested identity account name
Possible values: [APPROVED
, REJECTED
, PENDING
, NOT_READY
, CANCELLED
]
Enum representing the non-employee request approval status
Approval order
comment of approver
When the request was last modified.
When the request was created.
Possible values: [APPROVED
, REJECTED
, PENDING
, NOT_READY
, CANCELLED
]
Enum representing the non-employee request approval status
comment of requester
When the request was completely approved.
Non-Employee employment start date.
Non-Employee employment end date.
When the request was last modified.
When the request was created.
[
{
"id": "a0303682-5e4a-44f7-bdc2-6ce6112549c1",
"sourceId": "2c91808568c529c60168cca6f90c1313",
"name": "Retail",
"description": "Source description",
"accountName": "william.smith",
"firstName": "William",
"lastName": "Smith",
"email": "[email protected]",
"phone": "5555555555",
"manager": "jane.doe",
"nonEmployeeSource": {
"id": "a0303682-5e4a-44f7-bdc2-6ce6112549c1",
"sourceId": "2c91808568c529c60168cca6f90c1313",
"name": "Retail",
"description": "Source description"
},
"data": {
"description": "Auditing"
},
"approvalItems": [
{
"id": "2c1e388b-1e55-4b0a-ab5c-897f1204159c",
"approver": {
"type": "IDENTITY",
"id": "5168015d32f890ca15812c9180835d2e"
},
"accountName": "test.account",
"approvalStatus": "APPROVED",
"approvalOrder": 1,
"comment": "I approve",
"modified": "2019-08-23T18:52:59.162Z",
"created": "2019-08-23T18:40:35.772Z"
}
],
"approvalStatus": "APPROVED",
"comment": "approved",
"completionDate": "2020-03-24T11:11:41.139-05:00",
"startDate": "2020-03-24T00:00:00-05:00",
"endDate": "2021-03-25T00:00:00-05:00",
"modified": "2020-03-24T11:11:41.139-05:00",
"created": "2020-03-24T11:11:41.139-05:00"
}
]
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."
}
]
}