Update user

Updates an existing user with the provided details. Scoped OAuth requires: users.write

Authorization

apiKey bearerToken

Authorization<token>

A General Access API Key with format Token token=<API_KEY>

In: header

AuthorizationBearer <token>

An App OAuth Token with format Bearer <TOKEN>

In: header

Path Parameters

id*string

The ID of the user targeted in this request.

Request Body

application/json

SCIM User Update Params

TypeScript Definitions

Use the request body type in TypeScript.

The properties of a SCIM user that can be set/modified. All other properties are ignored.

active?boolean

A Boolean value indicating the User's administrative status. When set to false, the user will be deleted.

All users are created as active by default. It is an error to attempt to create a user with the active field set to false.

Defaulttrue

displayName*string

The name of the User, suitable for display to end-users. The name SHOULD be the full name of the User being described, if known.

Length1 <= length <= 255

entitlements?array<>

A list containing the User's entitlements. PagerDuty Users have a single entitlement representing the User's license. The value field of this item must be set to the User's license ID, and the type field must be set to license.

The license is not required to be set when creating a user. If not set, a default license will be assigned. Valid license IDs can be fetched from the PagerDuty Public API: https://developer.pagerduty.com/api-reference/4c10cb38f7381-list-licenses

Items1 <= items <= 1

externalId?string

A unique identifier for the User, set by the SCIM client. The SCIM client is responsible for ensuring that the value is unique across all Users.

Length1 <= length <= 100

id?ResourceIdentifier

A unique identifier for a SCIM resource as defined by the service provider. The identifier is unique across the service provider's entire set of resources. It is a stable, non-reassignable identifier that does not change when the same resource is returned in subsequent requests.

The ID must always be treated as a case-sensitive opaque string.

Length26 <= length <= 100

roles?array<>

A list containing the User's role. PagerDuty Users have a single role and the list will always contain a single item.

The roles field accepts two formats:

Format 1 - Using the primary field:

{"roles": [{"value": "user", "primary": true}]}

Required: value (role name), primary (must be true)

Optional: type (can be any string value, will be ignored and default to "base")

Format 2 - Using the type field:

{"roles": [{"value": "user", "type": "base"}]}

Required: value (role name), type (must be "base")

Optional: primary (must be true if included)

The role is not required when creating a user. If not set, a default role will be assigned. Valid user roles are defined in the PagerDuty Public API documentation: https://developer.pagerduty.com/api-reference/4cb4fd0f5444a-create-a-user

The only supported role type at this time is "base", which maps to the user's base account role in PagerDuty.

Items1 <= items <= 1

schemas?array<>

URIs that indicate the schemas used in data

Items1 <= items

Default

[  "urn:ietf:params:scim:schemas:core:2.0:User"]

timezone?|

The User's case-sensitive time zone. Must be a valid IANA time zone identifier.

title?|

The job title of the User.

userName*string

A unique identifier for the User, typically used by the user to directly authenticate to the service provider. Each User MUST include a non-empty userName value. This identifier MUST be unique across the service provider's entire set of Users.

Formatemail

Length1 <= length <= 100

Response Body

`application/scim+json`

curl -X PUT "https://example.com/Users/AGKWDNQ24N4SXBBWYENPROSIYQ" \  -H "Content-Type: application/json" \  -d '{    "displayName": "Fake User",    "userName": "fake.user@example.com"  }'

{  "active": true,  "displayName": "Fake User",  "entitlements": [    {      "type": "license",      "value": "PABC123"    }  ],  "externalId": "00ujl29u0le5T6Aj10h7",  "id": "AGKWDNQ24N4SXBBWYENPROSIYQ",  "meta": {    "resourceType": "User"  },  "roles": [    {      "primary": true,      "type": "base",      "value": "user"    }  ],  "schemas": [    "urn:ietf:params:scim:schemas:core:2.0:User"  ],  "timezone": "America/New_York",  "title": "Software Developer",  "userName": "fake.user@example.com"}

Update user

Authorization

Path Parameters

Request Body

Response Body

200application/scim+json

204

400application/scim+json

401application/scim+json

403application/scim+json

404application/scim+json

500application/scim+json

`application/scim+json`

`application/scim+json`

`application/scim+json`

`application/scim+json`

`application/scim+json`

`application/scim+json`