Get a Non-Employee Request

GET 
https://sailpoint.api.identitynow.com/v2024/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

idUUID
Non-Employee source id.
Example: a0303682-5e4a-44f7-bdc2-6ce6112549c1
sourceIdstring
Source Id associated with this non-employee source.
Example: 2c91808568c529c60168cca6f90c1313
namestring
Source name associated with this non-employee source.
Example: Retail
descriptionstring
Source description associated with this non-employee source.
Example: Source description
accountNamestring
Requested identity account name.
Example: william.smith
firstNamestring
Non-Employee's first name.
Example: William
lastNamestring
Non-Employee's last name.
Example: Smith
emailstring
Non-Employee's email.
Example: william.smith@example.com
phonestring
Non-Employee's phone.
Example: 5125555555
managerstring
The account ID of a valid identity to serve as this non-employee's manager.
Example: jane.doe
nonEmployeeSource object
idUUID
Non-Employee source id.
Example: a0303682-5e4a-44f7-bdc2-6ce6112549c1
sourceIdstring
Source Id associated with this non-employee source.
Example: 2c91808568c529c60168cca6f90c1313
namestring
Source name associated with this non-employee source.
Example: Retail
descriptionstring
Source description associated with this non-employee source.
Example: Source description
data object
Additional attributes for a non-employee. Up to 10 custom attributes can be added.
property name*string
approvalItems object[]
List of approval item for the request
Array [
idUUID
Non-Employee approval item id
Example: 2c1e388b-1e55-4b0a-ab5c-897f1204159c
approver object
Reference to the associated Identity
typestring
Identifies if the identity is a normal identity or a governance group
Possible values: [GOVERNANCE_GROUP, IDENTITY]
Example: IDENTITY
idstring
Identity id
Example: 5168015d32f890ca15812c9180835d2e
accountNamestring
Requested identity account name
Example: test.account
approvalStatusstring
Enum representing the non-employee request approval status
Possible values: [APPROVED, REJECTED, PENDING, NOT_READY, CANCELLED]
Example: APPROVED
approvalOrderfloat
Approval order
Example: 1
commentstring
comment of approver
Example: I approve
modifieddate-time
When the request was last modified.
Example: 2019-08-23T18:52:59.162Z
createddate-time
When the request was created.
Example: 2019-08-23T18:40:35.772Z
]
approvalStatusstring
Enum representing the non-employee request approval status
Possible values: [APPROVED, REJECTED, PENDING, NOT_READY, CANCELLED]
Example: APPROVED
commentstring
Comment of requester
Example: approved
completionDatedate-time
When the request was completely approved.
Example: 2020-03-24T11:11:41.139-05:00
startDatedate-time
Non-Employee employment start date.
Example: 2020-03-24T00:00:00-05:00
endDatedate-time
Non-Employee employment end date.
Example: 2021-03-25T00:00:00-05:00
modifieddate-time
When the request was last modified.
Example: 2020-03-24T11:11:41.139-05:00
createddate-time
When the request was created.
Example: 2020-03-24T11:11:41.139-05:00

Example (auto)

{
  "id": "a0303682-5e4a-44f7-bdc2-6ce6112549c1",
  "sourceId": "2c91808568c529c60168cca6f90c1313",
  "name": "Retail",
  "description": "Source description",
  "accountName": "william.smith",
  "firstName": "William",
  "lastName": "Smith",
  "email": "william.smith@example.com",
  "phone": "5125555555",
  "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

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

404

Not Found - returned if the request URL refers to a resource or object that does not exist

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

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

• 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

package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "https://sailpoint.api.identitynow.com/v2024/non-employee-requests/:id"
  method := "GET"

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, nil)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Accept", "application/json")
  req.Header.Add("Authorization", "Bearer <TOKEN>")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := io.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

Request Collapse all

Base URL

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

Auth

Bearer Token

Parameters

id — pathrequired

ResponseClear

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