Skip to content
Authrim

Replace a SCIM user.

PUT
/scim/v2/Users/{id}

Changes to userName or the mapped primary email use the durable identifier replacement workflow. Identifier reservation conflicts return 409; retryable directory convergence failures return 503.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Header Parameters

Section titled “Header Parameters ”
If-Match
string

Optional ETag precondition for replace, patch, or delete operations.

Request Body required

Section titled “Request Body required ”
object
schemas
required
Array<string>
id
string
externalId

Source-system correlation identifier. Authrim does not require uniqueness.

string
userName
required

Tenant-wide, case-insensitive unique SCIM login identifier.

string
>= 1 characters
name
object
formatted
string
familyName
string
givenName
string
middleName
string
honorificPrefix
string
honorificSuffix
string
key
additional properties
displayName
string
nickName
string
profileUrl
string format: uri
title
string
userType
string
preferredLanguage
string
locale
string
timezone
string
active
boolean
password

Unsupported by Authrim SCIM provisioning. Requests that include this field are rejected with 400 invalidValue; use Passkey, Email Code, Directory Connector, or External IdP authentication instead.

string
emails
Array<object>
object
value
required
string format: email
type
string
primary
boolean
display
string
key
additional properties
phoneNumbers
Array<object>
object
value
required
string
type
string
primary
boolean
key
additional properties
addresses
Array<object>
object
formatted
string
streetAddress
string
locality
string
region
string
postalCode
string
country
string
type
string
primary
boolean
key
additional properties
groups
Array<object>
object
value
required
string
$ref
string format: uri
type
string
Allowed values: User Group
display
string
key
additional properties
meta
object
resourceType
string
Allowed values: User Group
created
string format: date-time
lastModified
string format: date-time
location
string format: uri
version
string
key
additional properties
key
additional properties

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful SCIM JSON response.

object
schemas
Array<string>
key
additional properties
Example generated
{
  "schemas": [
    "example"
  ]
}

400

Section titled “400 ”

SCIM error response.

Media type application/scim+json
object
schemas
Array<string>
status
string
scimType
string
detail
string
key
additional properties
Example generated
{
  "schemas": [
    "example"
  ],
  "status": "example",
  "scimType": "example",
  "detail": "example"
}

409

Section titled “409 ”

SCIM error response.

Media type application/scim+json
object
schemas
Array<string>
status
string
scimType
string
detail
string
key
additional properties
Example generated
{
  "schemas": [
    "example"
  ],
  "status": "example",
  "scimType": "example",
  "detail": "example"
}

412

Section titled “412 ”

SCIM error response.

Media type application/scim+json
object
schemas
Array<string>
status
string
scimType
string
detail
string
key
additional properties
Example generated
{
  "schemas": [
    "example"
  ],
  "status": "example",
  "scimType": "example",
  "detail": "example"
}

503

Section titled “503 ”

SCIM error response.

Media type application/scim+json
object
schemas
Array<string>
status
string
scimType
string
detail
string
key
additional properties
Example generated
{
  "schemas": [
    "example"
  ],
  "status": "example",
  "scimType": "example",
  "detail": "example"
}