BEbeyondidentity
SCIM

Retrieve an Existing User

To retrieve an existing user, send a GET request to /Users/$USER_ID. The response will contain a full representation of the User resource matching the specified identifier. Per RFC-7644 §3.4.1, the server will respond with HTTP status 200 and the resource if found, or 404 if not found.

get/scim/v2/Users/{user_id}

Request

Path parameters

user_idstring required

ID of the user.

Response

Successfully returns the requested User resource. As per RFC-7643 §4.1, the response contains a complete representation of the User resource.

schemasstring[] 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").

idstring

The unique ID of the user. This is automatically generated on creation. This field is immutable and output-only.

externalIdstring

The provisioning client's unique identifier for the resource. This value must be unique across all users.

userNamestring

The unique username of the user. The value of this field will be returned as the subject of an OIDC ID Token.

displayNamestring

Display name of the User. This name is used for display purposes.

activeboolean

Indicator for the user's administrative status. If true, the user has administrative capabilities.

Example response

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "id": "ed9fcce6-ec82-458e-ae58-e2d975cfc32d",
  "externalId": "external-id-abcdef",
  "userName": "test_user",
  "displayName": "Test User",
  "active": true,
  "emails": [
    {
      "primary": true,
      "value": "test@test.com",
      "type": "work"
    }
  ],
  "name": {
    "givenName": "Barbara",
    "familyName": "Jensen"
  },
  "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
    "employeeNumber": "10.164682/g9j6r80"
  },
  "groups": [
    {
      "value": "e9e30dba-f08f-4109-8486-d5c6a331660a",
      "$ref": "../Groups/e9e30dba-f08f-4109-8486-d5c6a331660a",
      "type": "direct"
    }
  ],
  "meta": {
    "resourceType": "Group",
    "created": "2022-04-07T07:23:33Z",
    "lastModified": "2023-03-30T07:00:14Z",
    "location": "Groups/ed9fcce6-ec82-458e-ae58-e2d975cfc32d",
    "version": "W/0"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.