Create a user

POST

/scim/v2/Users

POST

/scim/v2/Users

$ curl -X POST https://api.getpostman.com/scim/v2/Users \
>      -H "x-api-key: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "schemas": [
>     "urn:ietf:params:scim:schemas:core:2.0:User"
>   ],
>   "userName": "taylor.lee@example.com",
>   "active": true,
>   "externalId": "12345678",
>   "groups": [
>     "Test Group"
>   ],
>   "locale": "en-US",
>   "name": {
>     "givenName": "Taylor",
>     "familyName": "Lee"
>   },
>   "displayName": "Taylor 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": "Test",
9     "familyName": "User"
10   },
11   "externalId": "12345678",
12   "active": true,
13   "meta": {
14     "created": "2021-02-22T04:24:13.000Z",
15     "lastModified": "2021-02-22T04:24:13.000Z",
16     "resourceType": "User"
17   }
18 }

Creates a new user account in Postman and adds the user to your organization’s Postman team.

If the account does not exist, this also activates the user so they can authenticate in to your Postman team.
If an account matching the email ID exists, the user receives email invite to join the Postman team. The user joins the team when they accept the invite.
If the user’s email domain matches your team’s verified domains, the user is immediately added to the team.

By default, the system assigns new users the developer role. You can update user roles in Postman.

Note:

Users must join the team before you can assign them to any groups.
If the user is a member of a different team during SCIM provisioning and their email domain is not verified with your Postman team, then the user is not provisioned. The endpoint returns an HTTP 409 Conflict response.

Creates a new user account in Postman and adds the user to your organization's Postman team. - If the account does not exist, this also activates the user so they can authenticate in to your Postman team. - If an account matching the email ID exists, the user receives [email invite](https://learning.postman.com/docs/administration/managing-your-team/manage-team-members/#manage-invites) to join the Postman team. The user joins the team when they accept the invite. - If the user's email domain matches your team's verified domains, the user is immediately added to the team. By default, the system assigns new users the developer role. You can [update user roles in Postman](https://learning.postman.com/docs/administration/managing-your-team/manage-team-members/#manage-team-roles). **Note:** - Users must join the team before you can assign them to any groups. - If the user is a member of a different team during SCIM provisioning and their email domain is **not** verified with your Postman team, then the user is **not** provisioned. The endpoint returns an HTTP `409 Conflict` response.

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)>.

Request

This endpoint expects an object.

schemaslist of stringsOptional

The SCIM schema URI.

userNamestringOptional

The user's username.

activebooleanOptional

If true, activates the user. This lets them authenticate in to your Postman team.

externalIdstringOptional

The user's external ID.

groupslist of stringsOptional

A list of groups to assign the user to.

localestringOptional

The user’s IETF language tag.

nameobjectOptional

Information about the user's name.

Response

Created

schemaslist of strings

The SCIM schema URI.

idstring

The user's SCIM ID.

userNamestringformat: "email"

The user's username.

nameobject

externalIdstring

The user's external ID.

activeboolean

If true, the user is active.

metaobject

The response’s non-standard meta information.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

409

Conflict Error

500

Internal Server Error