Skip to content
Authrim

Replace an account support context.

PUT
/api/admin/users/{id}/support-context
Code sample: Shell / cURL 
curl --request PUT \
  --url https://auth.example.com/api/admin/users/example/support-context \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "expected_version": 1, "context": { "schema_version": 1, "summary": "example", "external_references": [ { "system": "example", "kind": "example", "reference": "example" } ] } }'

Replaces the typed support document using optimistic versioning. Summaries and external reference values are not copied into Admin audit metadata.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Header Parameters

Section titled “Header Parameters ”
X-Tenant-Id
string

Tenant selector for multi-tenant admin requests.

Request Body required

Section titled “Request Body required ”
Media type application/json
object
expected_version
required
integer
context
required
object
schema_version
required
integer
Allowed values: 1
summary
string
>= 1 characters <= 4000 characters
external_references
required
Array<object>
<= 20 items unique items
object
system
required
string
>= 1 characters <= 64 characters /^[a-z0-9][a-z0-9._-]{0,63}$/
kind
required
string
>= 1 characters <= 64 characters /^[a-z0-9][a-z0-9._-]{0,63}$/
reference
required

Opaque identifier in the named support system; arbitrary URLs are rejected.

string
>= 1 characters <= 256 characters
key
additional properties
key
additional properties
key
additional properties

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Updated support context.

Media type application/json
object
context
required
object
schema_version
required
integer
Allowed values: 1
summary
string
>= 1 characters <= 4000 characters
external_references
required
Array<object>
<= 20 items unique items
object
system
required
string
>= 1 characters <= 64 characters /^[a-z0-9][a-z0-9._-]{0,63}$/
kind
required
string
>= 1 characters <= 64 characters /^[a-z0-9][a-z0-9._-]{0,63}$/
reference
required

Opaque identifier in the named support system; arbitrary URLs are rejected.

string
>= 1 characters <= 256 characters
key
additional properties
key
additional properties
version
required
integer
created_by
required
string | null
updated_by
required
string | null
created_at
required
integer | null
updated_at
required
integer | null
key
additional properties
Example 
{
  "context": {
    "schema_version": 1
  }
}

400

Section titled “400 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Section titled “403 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

404

Section titled “404 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

409

Section titled “409 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

500

Section titled “500 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}