List persistent identifier profiles.

GET

/api/admin/field-mapping/persistent-identifier-profiles

Code sample: Shell / cURL

curl --request GET \
  --url https://auth.example.com/api/admin/field-mapping/persistent-identifier-profiles \
  --header 'Authorization: Bearer <token>'

Lists persistent identifier profiles for the tenant, including algorithm, protocol scope, audience handling, lifecycle state, and timestamps.

Authorizations

• adminBearer
• adminSessionCookie

Responses

200

Persistent identifier profile list response.

Media type application/json

object

profiles

required

Array<object>

object

id

required

string

tenantId

required

string

profileKey

required

string

displayName

required

string

description

string | null

mode

required

string

algorithm

required

string

protocolScope

required

string

usage

required

Array<string>

sourceRef

object | null

secretRef

string | null

issuerEntityId

string | null

audienceMode

required

string

format

required

object

key

additional properties

lifecycleState

required

string

createdAt

required

integer

updatedAt

required

integer

key

additional properties

key

additional properties

Example ^generated

{
  "profiles": [
    {
      "id": "example",
      "tenantId": "example",
      "profileKey": "example",
      "displayName": "example",
      "description": "example",
      "mode": "example",
      "algorithm": "example",
      "protocolScope": "example",
      "usage": [
        "example"
      ],
      "sourceRef": "example",
      "secretRef": "example",
      "issuerEntityId": "example",
      "audienceMode": "example",
      "format": {
        "additionalProperty": "example"
      },
      "lifecycleState": "example",
      "createdAt": 1,
      "updatedAt": 1
    }
  ]
}

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