Skip to content

Replace user attributes

Request

Replace user attributes using SCIM protocol.

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

Security
ClientAccessToken
Path
user_idstringrequired

ID of the user

Headers
Acceptstringrequired

application/scim+json

Content-Typestringrequired

application/scim+json

Bodyapplication/jsonrequired
nameobject

Full name

preferredLanguagestring

The preferred language of the user

emailsArray of objects

The emails for the user

phoneNumbersArray of objects

The phone numbers for the user

photosArray of strings

The photos for the user, only 1 can be sent

addressesArray of objects

The addresses for the user, only 1 can be stored

schemasArray of stringsrequired

One or more schemas that are used in the API call. The core schema 'urn:ietf:params:scim:schemas:core:2.0:User' must be always specified.

Items Enum:"urn:ietf:params:scim:schemas:core:2.0:User""urn:ietf:params:scim:schemas:extension:CustomAppData:2.0:User"
urn:ietf:params:scim:schemas:extension:CustomAppData:2.0:Userobject

Custom app data object for app-related user info

externalIdstring

A unique identifier in a tenant

activeboolean

A Boolean value indicating the user's administrative status

custom_user_fieldsobject

Custom user fields defined by the tenant schema

userNamestring

Unique identifier for the user

passwordstring

The password for the user

hashed_passwordobject

The hashed password for the user

curl -i -X PUT \
  'https://api.sbx.transmitsecurity.io/cis/scim/Users/{user_id}' \
  -H 'Accept: string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": {
      "honorificPrefix": "string",
      "givenName": "string",
      "familyName": "string",
      "middleName": "string"
    },
    "preferredLanguage": "string",
    "emails": [
      {
        "value": "string",
        "primary": false
      }
    ],
    "phoneNumbers": [
      {
        "value": "string",
        "primary": false
      }
    ],
    "photos": [
      "string"
    ],
    "addresses": [
      {
        "streetAddress": "string",
        "locality": "string",
        "region": "string",
        "postalCode": "string",
        "country": "string"
      }
    ],
    "schemas": [
      "urn:ietf:params:scim:schemas:core:2.0:User"
    ],
    "urn:ietf:params:scim:schemas:extension:CustomAppData:2.0:User": {},
    "externalId": "string",
    "active": true,
    "custom_user_fields": {},
    "userName": "string",
    "password": "string",
    "hashed_password": {
      "password": "string",
      "salt": "string",
      "algorithm": "argon2"
    }
  }'

Responses

The user attributes have been successfully replaced.

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": { … }
  }
}