Skip to content
Authrim

Replace the tenant's test users.

PUT
/api/admin/identity-mapping/test-users
Code sample: Shell / cURL 
curl --request PUT \
  --url https://auth.example.com/api/admin/identity-mapping/test-users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "test_users": [ { "user_id": "example", "label": "example", "attributes": { "additionalProperty": { "additionalProperty": "example" } } } ] }'

Replaces the whole list in one batch (at most 10 test users, 50 attributes each). A test user kept from before is named by the user_id the endpoint gave; one without is new and gets an ID. An attribute key must be a canonical field of the tenant’s or the platform’s field catalog, or one of the tenant’s custom fields (400 with unknown_attributes otherwise); sub is never one. A value is a string (at most 256 characters), a number, a boolean, null, a list of those (at most 20), or one object of strings (an address). The audit record names the counts, never a value. An Agent is refused.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
object
test_users
required
Array<object>
<= 10 items
object
user_id

A test user kept from before; left out for a new one.

string
/^tu_[A-Za-z0-9_-]{1,61}$/
label
required
string
>= 1 characters <= 100 characters
attributes
required

Attribute key → a made-up value.

object
key
additional properties
One of:
string
<= 256 characters
key
additional properties
key
additional properties
Example generated
{
  "test_users": [
    {
      "user_id": "example",
      "label": "example",
      "attributes": {
        "additionalProperty": {
          "additionalProperty": "example"
        }
      }
    }
  ]
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

The tenant’s test users.

Media type application/json
object
test_users
required
Array<object>
object
user_id
required
string
label
required
string
attributes
required

Attribute key → a made-up value.

object
key
additional properties
One of:
string
<= 256 characters
updated_at
required

Milliseconds since the epoch.

integer
key
additional properties
limits
required
object
max_users
required
integer
max_attributes
required
integer
key
additional properties
key
additional properties
Example generated
{
  "test_users": [
    {
      "user_id": "example",
      "label": "example",
      "attributes": {
        "additionalProperty": {
          "additionalProperty": "example"
        }
      },
      "updated_at": 1
    }
  ],
  "limits": {
    "max_users": 1,
    "max_attributes": 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"
}

401

Section titled “401 ”

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"
}

429

Section titled “429 ”

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"
}

503

Section titled “503 ”

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"
}