patch-user | SailPoint Developer Community

Update a user by id

Path Parameters

id uuid required
ID of the object to retrieve or update
Example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e

application/json

Request Body required

user object
id uuid
The id
name string
The name
email email
The email
type string
Possible values: [NeprofileUser, NeaccessUser]
Default value: NeprofileUser
The type
profile_id uuid
The profile_id
title string
The title
status string
Possible values: [Active, Disabled]
The status
login string
The login
admin boolean
Is the user an admin
group_strings string
The group strings (used in roles later on)

Responses

Expected response to a valid request

application/json

Schema
Example (from schema)

Schema

user object
id uuid
The id
uid string
Possible values: >= 32 characters and <= 32 characters
The uid
name string
The name
email email
The email
type string
Possible values: [NeprofileUser, NeaccessUser]
Default value: NeprofileUser
The type
title string
The title
status string
Possible values: [Active, Disabled]
The status
login string
The login
last_login date-time
The last login time
cookies_accepted_at date-time
The time the cookies were accepted at
preferred_language string
The preferred language

{
  "user": {
    "id": "db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e",
    "uid": "db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e",
    "name": "bob",
    "email": "example@sailpoint.com",
    "type": "NeprofileUser",
    "title": "mytitle",
    "status": "Active",
    "login": "bob",
    "last_login": "2023-05-01T09:12:28Z",
    "cookies_accepted_at": "2023-05-01T09:12:28Z",
    "preferred_language": "en-US"
  }
}

Bad Request - unable to complete.

application/json

Schema
Example (from schema)

Schema

oneOf

MOD1
MOD2

error

{
  "error": "Invalid JSON syntax. Please check your syntax and try again."
}

Internal Server Error - returned on unhandled exceptions.

application/json

Schema
Example (from schema)

Schema

error
A message describing the error

{
  "error": "Sorry something went wrong"
}

Update a user by id​

Update a user by id