コンテンツにスキップ
Authrim

Create a source profile.

POST
/api/admin/field-mapping/source-profiles
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/field-mapping/source-profiles \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "sourceType": "csv", "profileKey": "workforce-csv", "displayName": "Workforce CSV", "versionLabel": "v1", "schema": { "columns": [ { "name": "Email", "path": "email" } ] } }'

Creates a source profile and optional initial version from parsed schema metadata, parser options, and source metadata.

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
Allowed values: csv saml
profileKey
required
string
displayName
required
string
versionLabel
string
parseDraftId
string
schema
object
key
additional properties
parserOptions
object
key
additional properties
warningSummary
object
key
additional properties
sourceMetadata
object
key
additional properties
key
additional properties
Example 
{
  "sourceType": "csv",
  "profileKey": "workforce-csv",
  "displayName": "Workforce CSV",
  "versionLabel": "v1",
  "schema": {
    "columns": [
      {
        "name": "Email",
        "path": "email"
      }
    ]
  }
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Source profile mutation response.

Media type application/json
object
result
required
object
id
required
string
tenantId
required
string
sourceType
required
string
Allowed values: csv saml
profileKey
required
string
displayName
required
string
lifecycleState
required
string
activeVersionId
string | null
version
One of:
object
id
required
string
versionLabel
required
string
lifecycleState
required
string
schemaHash
required
string
schema
required
object
key
additional properties
warningSummary
required
object
key
additional properties
key
additional properties
key
additional properties
key
additional properties
Example 
{
  "result": {
    "sourceType": "csv"
  }
}

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