Update profile metadata or disable a profile

PATCH

/api/admin/credential-profiles/{id}

Code sample: Shell / cURL

curl --request PATCH \
  --url https://auth.example.com/api/admin/credential-profiles/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "display_name": "example", "description": "example", "lifecycle_state": "draft" }'

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

id

required

string

Request Body ^required

Media type application/json

object

display_name

string

>= 1 characters <= 200 characters

description

string | null

<= 2000 characters

lifecycle_state

string

Allowed values: draft disabled

Responses

200

Credential profile updated.

400

Invalid lifecycle or metadata update.

404

Credential profile not found.