Skip to content
Authrim

Import an external schema.

POST
/api/admin/field-mapping/external-schemas
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/field-mapping/external-schemas \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "sourceType": "scim", "sourceId": "workday", "schemaKey": "user", "schema": { "fields": [ { "id": "department", "type": "string" } ] } }'

Imports an external source schema by source type/id and schema key. The mutation is idempotency-aware through Idempotency-Key.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “Header Parameters ”
Idempotency-Key
string

Idempotency key for state-changing operations that support replay protection.

Request Body required

Section titled “Request Body required ”
Media type application/json
object
sourceType
required
string
sourceId
required
string
schemaKey
required
string
schema
required
object
key
additional properties
key
additional properties
Example 
{
  "sourceType": "scim",
  "sourceId": "workday",
  "schemaKey": "user",
  "schema": {
    "fields": [
      {
        "id": "department",
        "type": "string"
      }
    ]
  }
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

External schema import response.

Media type application/json
object
result
required
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
{
  "result": {
    "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"
}