Get a Non-Employee Request

GET 
/non-employee-requests/:id

This gets a non-employee request. There are two contextual uses for this endpoint:

1. The user has the role context of idn:nesr:read, in this case the user can get the non-employee request for any user.
2. The user must be the owner of the non-employee request.

Request

Path Parameters

id stringrequired
Non-Employee request id (UUID)
Example: ac110005-7156-1150-8171-5b292e3e0084

Responses

200

Non-Employee request object.

application/json

Schema

Schema

id UUID

Non-Employee source id.

sourceId string

Source Id associated with this non-employee source.

name string

Source name associated with this non-employee source.

description string

Source description associated with this non-employee source.

accountName string

Requested identity account name.

firstName string

Non-Employee's first name.

lastName string

Non-Employee's last name.

email string

Non-Employee's email.

phone string

Non-Employee's phone.

manager string

The account ID of a valid identity to serve as this non-employee's manager.

nonEmployeeSource object

id UUID

Non-Employee source id.

sourceId string

Source Id associated with this non-employee source.

name string

Source name associated with this non-employee source.

description string

Source description associated with this non-employee source.

data object
Attribute blob/bag for a non-employee.
property name* string
approvalItems object[]
List of approval item for the request
Array [
id UUID
Non-Employee approval item id
approver object
Reference to the associated Identity
type NonEmployeeIdentityDtoType
Possible values: [GOVERNANCE_GROUP, IDENTITY]
Identifies if the identity is a normal identity or a governance group
id string
Identity id
accountName string
Requested identity account name
approvalStatus ApprovalStatus
Possible values: [APPROVED, REJECTED, PENDING, NOT_READY, CANCELLED]
Enum representing the non-employee request approval status
approvalOrder float
Approval order
comment string
comment of approver
modified date-time
When the request was last modified.
created date-time
When the request was created.
]
approvalStatus ApprovalStatus

Possible values: [APPROVED, REJECTED, PENDING, NOT_READY, CANCELLED]

Enum representing the non-employee request approval status

comment string

comment of requester

completionDate date-time

When the request was completely approved.

startDate date-time

Non-Employee employment start date.

endDate date-time

Non-Employee employment end date.

modified date-time

When the request was last modified.

created date-time

When the request was created.

Example (from schema)

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

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