--- title: "List All Users" method: GET path: "/scim/v2/Users" tags: ["SCIM"] --- # List All Users `GET /scim/v2/Users` ## Request - Base URL: `https://api.byndid.com` - URL: `https://api.byndid.com/scim/v2/Users` - Auth: HTTP bearer - TypeScript: (a function with typed inputs; its response is checked against the schema) To list all users, send a GET request to `/Users`. Currently, filtering on users only supports the `eq` and `ne` operators and the `userName` and `externalId` attributes. The response will contain at most 1000 items. If count is not specified or is zero, the response will not contain any resources. There is no defined ordering of the list of users in the response. Note that the maximum page size is subject to change. ## Query parameters - `filter` string - `count` integer - `startIndex` integer ## Response `200` The response will be a ListResponse containing the users corresponding to the request. The `totalResults` key may be used to determine whether there are additional pages to fetch for the request. - object: Response for ListUsers. - `schemas` string[], required: The list of schemas used to define the list response. This only contains the ListResponse schema ("urn:ietf:params:scim:api:messages:2.0:ListResponse"). - `Resources` SCIMUser[], required: An array of users corresponding to the filter from the request. - `schemas` string[], required: The list of schemas used to define the user. This must contain only the core User schema ("urn:ietf:params:scim:schemas:core:2.0:User"). - `id` string: The unique ID of the user. This is automatically generated on creation. This field is immutable and output-only. - `externalId` string: The provisioning client's unique identifier for the resource. This value must be unique across all users. - `userName` string: The unique username of the user. The value of this field will be returned as the subject of an OIDC ID Token. - `displayName` string: Display name of the User. This name is used for display purposes. - `active` boolean: Indicator for the user's administrative status. If true, the user has administrative capabilities. - `emails` object[]: The list containing the user's emails. Important notes about email handling: - Only one email address is supported per user - The email must be marked as primary (primary: true) - If multiple email addresses are provided, only the primary email will be used and all others will be ignored - `primary` boolean: Indicator for the primary email address. Important notes about email handling: - Only one email address is supported per user - The email must be marked as primary (primary: true) - If multiple email addresses are provided, only the primary email will be used and all others will be ignored - `value` string: The email address. Important notes about email handling: - Only one email address is supported per user - The email must be marked as primary (primary: true) - If multiple email addresses are provided, only the primary email will be used and all others will be ignored - `type` 'work' | 'home' | 'other': The type of email address. Valid values are "work", "home", and "other" as defined in [RFC 7643](https://www.rfc-editor.org/rfc/rfc7643). Important notes about email handling: - Only one email address is supported per user - The email must be marked as primary (primary: true) - If multiple email addresses are provided, only the primary email will be used and all others will be ignored - `name` object: Definition of the user's name. - `givenName` string: The given name of the user, or first name in most Western languages. - `familyName` string: The family name of the user, or last name in most Western languages. - `urn:ietf:params:scim:schemas:extension:enterprise:2.0:User` object: The Employee Number as defined in the enterprise SCIM extension - `employeeNumber` string: A string identifier, typically numeric or alphanumeric, assigned to a person, typically based on order of hire or association with an organization as defined in [RFC 7643](https://datatracker.ietf.org/doc/html/rfc7643#section-4.3). - `groups` object[]: A list of groups that the user belongs to, as defined in [RFC 7643 Section 4.1.2](https://www.rfc-editor.org/rfc/rfc7643#section-4.1.2). This is a read-only attribute populated by the service provider. - `value` string: The identifier of the group. - `$ref` string: The URI of the corresponding group resource. - `type` string: A label indicating the attribute's function, e.g., 'direct' for direct group membership. Beyond Identity SCIM server supports only 'direct' membership for groups. Indirect membership is not supported. - `meta` object: Resource metadata as defined in [RFC 7643 Section 3.1](https://www.rfc-editor.org/rfc/rfc7643#section-3.1). This attribute is only populated on responses and is ignored on requests. - `resourceType` string, required: The name of the resource type of the resource. - `created` string, date-time, required: Timestamp of when the resource was created. - `lastModified` string, date-time, required: Timestamp of when the resource was last updated. - `location` string, required: The URI of the resource being returned. - `version` string, required: The version of the resource being returned. This is always "W/0". - `totalResults` integer, required: Total number of results matching the request. This value may be larger than the number of resources returned, such as when returning a single page of results where multiple pages are available. - `startIndex` integer, required: The 1-based index of the first result in the current set of list results. - `itemsPerPage` integer, required: The number of resources returned in a list response page. ## Other responses - `400`: Bad request. - `401`: Unauthorized. - `429`: Rate limit exceeded. - `500`: Server error. --- [API](https://skmtc.dev/beyondidentity/apis/beyond-identity-secure-workforce-api.md) - [All operations](https://skmtc.dev/beyondidentity/apis/beyond-identity-secure-workforce-api/llms.txt) - [OpenAPI document](https://skmtc.dev/beyondidentity/apis/beyond-identity-secure-workforce-api/revisions/562e14b2e4ba?raw)