Skip to content
Authrim

List identity-mapping schema readiness.

GET
/api/admin/field-mapping/schema-readiness
Code sample: Shell / cURL 
curl --request GET \
  --url https://auth.example.com/api/admin/field-mapping/schema-readiness \
  --header 'Authorization: Bearer <token>'

Returns the built-in readiness checklist for identity-mapping schema areas and a summary grouped by pass, attention, blocked, and deferred states.

Authorizations

Section titled “Authorizations ”

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Identity mapping schema readiness response.

Media type application/json
object
rows
required
Array<object>
object
key
additional properties
summary
required
object
total
required
integer
pass
required
integer
attention
required
integer
blocked
required
integer
deferred
required
integer
key
additional properties
key
additional properties
Example generated
{
  "rows": [
    {
      "additionalProperty": "example"
    }
  ],
  "summary": {
    "total": 1,
    "pass": 1,
    "attention": 1,
    "blocked": 1,
    "deferred": 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"
}

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