Get all users

GET

/scim/v2/Users

GET

/scim/v2/Users

$ curl -G https://api.getpostman.com/scim/v2/Users \
>      -H "x-api-key: <apiKey>" \
>      --data-urlencode "filter=userName eq "taylor%2Dlee@example.com""

1 {
2   "Resources": [
3     {
4       "schemas": [
5         "urn:ietf:params:scim:schemas:core:2.0:User"
6       ],
7       "id": "405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99",
8       "userName": "taylor.lee@example.com",
9       "name": {
10         "givenName": "Taylor",
11         "familyName": "Lee"
12       },
13       "externalId": "12345678",
14       "active": true,
15       "meta": {
16         "resourceType": "User",
17         "created": "2021-02-22T04:24:13.000Z",
18         "lastModified": "2021-02-22T04:24:13.000Z"
19       }
20     },
21     {
22       "schemas": [
23         "urn:ietf:params:scim:schemas:core:2.0:User"
24       ],
25       "id": "123775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99",
26       "userName": "alex.cruz@example.com",
27       "name": {
28         "givenName": "Alex",
29         "familyName": "Cruz"
30       },
31       "externalId": "87654321",
32       "active": false,
33       "meta": {
34         "resourceType": "User",
35         "created": "2021-02-22T04:24:13.000Z",
36         "lastModified": "2021-02-22T04:24:13.000Z"
37       }
38     }
39   ],
40   "itemsPerPage": 2,
41   "schemas": [
42     "urn:ietf:params:scim:api:messages:2.0:ListResponse"
43   ],
44   "startIndex": 1,
45   "totalResults": 2
46 }

Gets information about all Postman team members.

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

Query parameters

startIndexdoubleOptional>=1Defaults to 1

The index entry by which to begin the list of returned results. Must be a value of 1 or greater.

countdoubleOptionalDefaults to 100

Limit the number of results returned in a single response.

filterstringOptional

Filter results by a specific word or phrase. This query parameter accepts the following:

userName — Filter values are case-sensitive, and special characters and spaces must be URL encoded.
active — Return only users who are active (true) or inactive (false).

Filter results by a specific word or phrase. This query parameter accepts the following: - `userName` — Filter values are case-sensitive, and special characters and spaces must be URL encoded. - `active` — Return only users who are active (`true`) or inactive (`false`).

Response

Successful Response

Resourceslist of objects

A list of user resources.

itemsPerPagedouble

The number of items per response page.

schemaslist of strings

The SCIM schema URI.

startIndexdouble

The index entry by which the returned results begin.

totalResultsdouble

The total number of results found.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error