Update a user

PUT

/scim/v2/Users/:userId

PUT

/scim/v2/Users/:userId

$ curl -X PUT https://api.getpostman.com/scim/v2/Users/405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99 \
>      -H "x-api-key: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "schemas": [
>     "urn:ietf:params:scim:schemas:core:2.0:User"
>   ],
>   "name": {
>     "givenName": "Taylor",
>     "familyName": "Lee"
>   }
> }'

1 {
2   "schemas": [
3     "urn:ietf:params:scim:schemas:core:2.0:User"
4   ],
5   "id": "405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99",
6   "userName": "taylor.lee@example.com",
7   "name": {
8     "givenName": "Taylor",
9     "familyName": "Lee"
10   },
11   "externalId": "12345678",
12   "active": true,
13   "meta": {
14     "resourceType": "User",
15     "created": "2021-02-22T04:24:13.000Z",
16     "lastModified": "2021-02-22T04:24:13.000Z"
17   }
18 }

Updates a user in Postman.

Reactivating a user

By setting the active property from false to true, this reactivates an account. This allows the account to authenticate in to Postman and adds the account back on to your Postman team.

Authentication

x-api-keystring

API Key authentication via header

Authorizationstring

A valid SCIM API key for calls to SCIM endpoints.

A valid [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key) for calls to SCIM endpoints.

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

userIdstringRequired

The user's SCIM ID.

Request

This endpoint expects an object.

schemaslist of stringsOptional

The SCIM schema URI.

userNamestringOptionalformat: "email"

The user's email address.

nameobjectOptional

Information about the user's name.

activebooleanOptional

Sets the user’s active state:

true — Activates the user. This lets them authenticate in to your Postman team.
false — Removes the user from your Postman team and deactivates the account. This blocks the user from authenticating in to Postman.

Response

Successful Response

schemaslist of strings

The SCIM schema URI.

idstring

The team member's SCIM ID.

userNamestring

The team member's SCIM username.

nameobject

Information about the Postman team member.

externalIdstring

The team member's external ID.

activeboolean

If true, the team member is active.

metaobject

The response’s non-standard meta information.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error