Skip to content
Authrim

List imported external schemas.

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

Lists imported external schemas registered for source systems and their lifecycle state.

Authorizations

Section titled “Authorizations ”

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Imported external schema list response.

Media type application/json
object
externalSchemas
required
Array<object>
object
id
required
string
tenantId
required
string
sourceType
required
string
sourceId
required
string
schemaKey
required
string
schema
object
key
additional properties
lifecycleState
required
string
importedAt
integer
key
additional properties
key
additional properties
Example generated
{
  "externalSchemas": [
    {
      "id": "example",
      "tenantId": "example",
      "sourceType": "example",
      "sourceId": "example",
      "schemaKey": "example",
      "schema": {
        "additionalProperty": "example"
      },
      "lifecycleState": "example",
      "importedAt": 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"
}