Skip to main content

Update Non-Employee Record

PUT 

https://sailpoint.api.identitynow.com/v3/non-employee-records/:id

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

  1. The user has the role context of idn:nesr:update, in which case they update all available fields.
  2. The user is owner of the source, in this case they can only update the end date.

Request

Path Parameters

    id stringrequired

    Non-employee record id (UUID)

    Example: ef38f94347e94562b5bb8424a56397d8

Bodyrequired

Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields.

    accountNamestringrequired

    Requested identity account name.

    Example: william.smith
    firstNamestringrequired

    Non-Employee's first name.

    Example: William
    lastNamestringrequired

    Non-Employee's last name.

    Example: Smith
    emailstringrequired

    Non-Employee's email.

    Example: william.smith@example.com
    phonestringrequired

    Non-Employee's phone.

    Example: 5125555555
    managerstringrequired

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

    Example: jane.doe
    sourceIdstringrequired

    Non-Employee's source id.

    Example: 2c91808568c529c60168cca6f90c1313
    data object

    Additional attributes for a non-employee. Up to 10 custom attributes can be added.

    property name*string
    startDatedate-timerequired

    Non-Employee employment start date.

    Example: 2020-03-24T00:00:00-05:00
    endDatedate-timerequired

    Non-Employee employment end date.

    Example: 2021-03-25T00:00:00-05:00

Responses

An updated non-employee record.

Schema
    idUUID

    Non-Employee record id.

    Example: ef38f94347e94562b5bb8424a56397d8
    accountNamestring

    Requested identity account name.

    Example: Abby.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
    sourceIdstring

    Non-Employee's source id.

    Example: 2c91808568c529c60168cca6f90c1313
    data object

    Additional attributes for a non-employee. Up to 10 custom attributes can be added.

    property name*string
    startDatedate-time

    Non-Employee employment start date.

    Example: 2019-08-23T18:52:59.162Z
    endDatedate-time

    Non-Employee employment end date.

    Example: 2020-08-23T18:52:59.162Z
    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

Authorization: oauth2

package main

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

func main() {

url := "https://sailpoint.api.identitynow.com/v3/non-employee-records/:id"
method := "PUT"

payload := strings.NewReader(`{
"accountName": "william.smith",
"firstName": "William",
"lastName": "Smith",
"email": "william.smith@example.com",
"phone": "5125555555",
"manager": "jane.doe",
"sourceId": "2c91808568c529c60168cca6f90c1313",
"data": {
"description": "Auditing"
},
"startDate": "2020-03-24T00:00:00-05:00",
"endDate": "2021-03-25T00:00:00-05:00"
}`)

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

if err != nil {
fmt.Println(err)
return
}
req.Header.Add("Content-Type", "application/json")
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/v3
Auth
Parameters
— pathrequired
Body required
{
  "accountName": "william.smith",
  "firstName": "William",
  "lastName": "Smith",
  "email": "william.smith@example.com",
  "phone": "5125555555",
  "manager": "jane.doe",
  "sourceId": "2c91808568c529c60168cca6f90c1313",
  "data": {
    "description": "Auditing"
  },
  "startDate": "2020-03-24T00:00:00-05:00",
  "endDate": "2021-03-25T00:00:00-05:00"
}
ResponseClear

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