Skip to main content
PUT
/
api
/
scim
/
v2
/
Users
/
{userId}
Replace a user
curl --request PUT \
  --url https://app.trelica.com/api/scim/v2/Users/{userId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/scim+json' \
  --data '
{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "userName": "erika.mustermann@example.com",
  "name": {
    "formatted": "Erika Mustermann",
    "familyName": "Mustermann",
    "givenName": "Erika"
  },
  "displayName": "Erika Mustermann",
  "title": "Customer Success Manager",
  "preferredLanguage": "en-GB",
  "locale": "en-GB",
  "active": true,
  "emails": [
    {
      "primary": true,
      "type": "work",
      "value": "erika.mustermann@example.com"
    }
  ],
  "roles": [
    {
      "value": "Admin",
      "display": "Admin",
      "primary": false
    }
  ],
  "id": "8089ac9b31841227d4aee4f0adecd81f",
  "meta": {
    "created": "2019-01-01T00:00:00Z",
    "lastModified": "2024-12-06T14:58:12Z",
    "resourceType": "User"
  }
}
'
{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "userName": "erika.mustermann@example.com",
  "name": {
    "formatted": "Erika Mustermann",
    "familyName": "Mustermann",
    "givenName": "Erika"
  },
  "displayName": "Erika Mustermann",
  "title": "Customer Success Manager",
  "preferredLanguage": "en-GB",
  "locale": "en-GB",
  "active": true,
  "emails": [
    {
      "primary": true,
      "type": "work",
      "value": "erika.mustermann@example.com"
    }
  ],
  "roles": [
    {
      "value": "Admin",
      "display": "Admin",
      "primary": false
    }
  ],
  "id": "8089ac9b31841227d4aee4f0adecd81f",
  "meta": {
    "created": "2019-01-01T00:00:00Z",
    "lastModified": "2024-12-06T14:58:12Z",
    "resourceType": "User"
  }
}

Authorizations

​
Authorization
string
header
required

OAuth 2.0. Obtain an access token via the Client Credentials or Authorization Code flow, then send it as Authorization: Bearer <token>.

Path Parameters

​
userId
string<uuid>
required

The user's SCIM resource ID.

Body

application/scim+json
​
schemas
string[]
​
userName
string | null

Unique identifier for the user, typically their email address. Required; must belong to a domain verified for your organization. Immutable once set.

​
name
object

The components of the user's name.

​
nickName
string | null
write-only

Accepted for SCIM compatibility but ignored (not stored or returned).

​
profileUrl
string | null
write-only

Accepted for SCIM compatibility but ignored (not stored or returned).

​
title
string | null

The user's job title, e.g. "Vice President".

​
userType
string | null
write-only

Accepted for SCIM compatibility but ignored (not stored or returned).

​
locale
string | null

The user's default locale, e.g. "en-US", used for localizing currency, dates and numbers.

​
timezone
string | null

The user's time zone in IANA ("Olson") format, e.g. "America/Los_Angeles".

​
active
boolean

Whether the user is active. false suspends the user's SaaS Manager access.

​
password
string | null
write-only

A password for the user. Write-only; accepted for SCIM compatibility but never returned.

​
emails
object[] | null

Email addresses for the user.

​
phoneNumbers
object[] | null

Phone numbers for the user. Only the first value is stored.

​
photos
object[] | null
write-only

Accepted for SCIM compatibility but ignored (not stored or returned).

​
addresses
object[] | null
write-only

A physical mailing address. Accepted for SCIM compatibility but ignored (not stored or returned).

​
groups
object[] | null
write-only

Groups the user belongs to. Accepted for SCIM compatibility but ignored (not stored or returned).

​
entitlements
object[] | null
write-only

Entitlements held by the user. Accepted for SCIM compatibility but ignored (not stored or returned).

​
roles
object[] | null

The SaaS Manager roles assigned to the user. Each role's value must match an existing role name.

​
x509Certificates
object[] | null
write-only

Accepted for SCIM compatibility but ignored (not stored or returned).

​
externalId
string | null

An identifier for the resource as defined by the provisioning client.

Response

OK

​
schemas
string[]
​
userName
string | null

Unique identifier for the user, typically their email address. Required; must belong to a domain verified for your organization. Immutable once set.

​
name
object

The components of the user's name.

​
displayName
string | null
read-only

The user's display name (derived from their name on output). Server-controlled.

​
title
string | null

The user's job title, e.g. "Vice President".

​
preferredLanguage
string | null
read-only

The user's preferred language; mirrors locale on output. Set locale instead.

​
locale
string | null

The user's default locale, e.g. "en-US", used for localizing currency, dates and numbers.

​
timezone
string | null

The user's time zone in IANA ("Olson") format, e.g. "America/Los_Angeles".

​
active
boolean

Whether the user is active. false suspends the user's SaaS Manager access.

​
emails
object[] | null

Email addresses for the user.

​
phoneNumbers
object[] | null

Phone numbers for the user. Only the first value is stored.

​
roles
object[] | null

The SaaS Manager roles assigned to the user. Each role's value must match an existing role name.

​
id
string | null
read-only

The service-provider-assigned SCIM resource ID. Server-controlled; ignored on requests.

​
externalId
string | null

An identifier for the resource as defined by the provisioning client.

​
meta
object

Resource metadata (created/last-modified timestamps, resource type, location). Server-controlled; ignored on requests.