Skip to content
Authrim

List protocol schemas.

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

Lists protocol schema definitions available for the tenant, including protocol, schema key, display name, version, lifecycle state, and JSON schema payload.

Authorizations

Section titled “Authorizations ”

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Protocol schema list response.

Media type application/json
object
protocolSchemas
required
Array<object>
object
id
required
string
tenantId
required
string
protocol
required
string
schemaKey
required
string
schemaVersion
string | null
schema
object
key
additional properties
lifecycleState
required
string
key
additional properties
key
additional properties
Example generated
{
  "protocolSchemas": [
    {
      "id": "example",
      "tenantId": "example",
      "protocol": "example",
      "schemaKey": "example",
      "schemaVersion": "example",
      "schema": {
        "additionalProperty": "example"
      },
      "lifecycleState": "example"
    }
  ]
}

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