Skip to content
Authrim

Patch a SCIM user.

PATCH
/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.

Paths into an extension name its schema URN, then the attribute, for example urn:authrim:params:scim:schemas:extension:assurance:1.0:User:ial. A patch of the assurance extension applies to the claim the authenticating token holds; one that leaves it alone keeps it, and removing the extension (or leaving it without a required attribute) withdraws it or is refused (400 invalidValue). A patch that does not change the extension writes no evidence.

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>
Operations
required
Array<object>
>= 1 items
object
op
required
string
Allowed values: add remove replace
path
string
value
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"
}