コンテンツにスキップ
Authrim

Preview a persistent identifier value.

POST
/api/admin/field-mapping/persistent-identifier-profiles/preview
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/field-mapping/persistent-identifier-profiles/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "profileId": "persistent_identifier_profile_123", "subject": "subject_123", "audience": "https://sp.example.com/metadata" }'

Computes a non-persisted preview for a persistent identifier profile, subject, and audience. The response includes protocol-specific values and whether secret material was included.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
object
profileId
required
string
subject
required
string
audience
required
string
issuerEntityId
string
key
additional properties
Example 
{
  "profileId": "persistent_identifier_profile_123",
  "subject": "subject_123",
  "audience": "https://sp.example.com/metadata"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Persistent identifier preview response.

Media type application/json
object
result
required
object
profileId
required
string
algorithm
required
string
subject
required
string
audience
required
string
opaque
required
string
samlAttributeValue
required
string | null
oidcPairwiseSub
required
string
secretRef
required
string | null
secretMaterialIncluded
required
boolean
key
additional properties
key
additional properties
Example generated
{
  "result": {
    "profileId": "example",
    "algorithm": "example",
    "subject": "example",
    "audience": "example",
    "opaque": "example",
    "samlAttributeValue": "example",
    "oidcPairwiseSub": "example",
    "secretRef": "example",
    "secretMaterialIncluded": true
  }
}

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