Replace a source profile.

PUT

/api/admin/field-mapping/source-profiles/{sourceProfileId}

Code sample: Shell / cURL

curl --request PUT \
  --url https://auth.example.com/api/admin/field-mapping/source-profiles/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "displayName": "Workforce CSV v2", "schema": { "columns": [ { "name": "Department", "path": "department" } ] } }'

Replaces source profile metadata and version input for the selected source profile id, returning the updated profile in a result envelope.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

sourceProfileId

required

string

Header Parameters

Idempotency-Key

string

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

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

Example

{
  "displayName": "Workforce CSV v2",
  "schema": {
    "columns": [
      {
        "name": "Department",
        "path": "department"
      }
    ]
  }
}

Responses

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

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

null

null

key

additional properties

key

additional properties

Example

{
  "result": {
    "sourceType": "csv"
  }
}

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

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

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

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

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

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