Skip to content

Get SCIM user by ID

Request

Search for a SCIM user by user ID.

Required permissions: apps:read, [appId]:read, users:read.

Security
ClientAccessToken
Path
user_idstringrequired

The user ID to search for

Headers
Acceptstringrequired

application/scim+json

curl -i -X GET \
  'https://api.sbx.transmitsecurity.io/cis/scim/Users/{user_id}' \
  -H 'Accept: string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
schemasArray of stringsrequired

List of included SCIM schemas that are used to indicate the attributes contained within a resource.

userNamestringrequired

Unique identifier of the user. In Transmit, the username can be used for password authentication unless a primary email is used instead.

nameobject

Full name

displayNamestring

The name of the user, suitable for display to end-users

preferredLanguagestring

Indicates the user's preferred written or spoken languages and is generally used for selecting a localized user interface

activeboolean

A Boolean value indicating the user's administrative status

emailsArray of strings

Email addresses for the user.

phoneNumbersArray of strings

Phone numbers for the user.

photosArray of strings

A URI that is a uniform resource locator (as defined in Section 1.1.3 of [RFC3986]) that points to a resource location representing the user's image.

addressesArray of strings

The user's addresses

idstringrequired

The ID of the user

externalIdstring

The external ID of the user

metaobjectrequired

A complex attribute containing resource metadata

custom_user_fieldsobject

Custom user fields defined by the tenant schema

urn:ietf:params:scim:schemas:extension:CustomAppData:2.0:Userobject

Custom app data object for app-related user info

urn:ietf:params:scim:schemas:extension:UserExtended:2.0:Userobjectrequired

Extended user fields

Response
{
  "schemas": [
    "string"
  ],
  "userName": "string",
  "name": {
    "honorificPrefix": "string",
    "givenName": "string",
    "familyName": "string",
    "middleName": "string"
  },
  "displayName": "string",
  "preferredLanguage": "string",
  "active": true,
  "emails": [
    "string"
  ],
  "phoneNumbers": [
    "string"
  ],
  "photos": [
    "string"
  ],
  "addresses": [
    "string"
  ],
  "id": "string",
  "externalId": "string",
  "meta": {
    "resourceType": "string",
    "created": "2019-08-24T14:15:22Z",
    "lastModified": "2019-08-24T14:15:22Z",
    "location": "string"
  },
  "custom_user_fields": {},
  "urn:ietf:params:scim:schemas:extension:CustomAppData:2.0:User": {},
  "urn:ietf:params:scim:schemas:extension:UserExtended:2.0:User": {
    "status": "Active",
    "lastAuth": "2019-08-24T14:15:22Z",
    "passwordInformation": { … }
  }
}