コンテンツにスキップ
Authrim

Replace a persistent identifier profile.

PUT
/api/admin/field-mapping/persistent-identifier-profiles/{profileId}
Code sample: Shell / cURL 
curl --request PUT \
  --url https://auth.example.com/api/admin/field-mapping/persistent-identifier-profiles/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "profileKey": "saml-persistent-id", "displayName": "SAML persistent NameID", "protocolScope": "saml", "algorithm": "shibboleth_sha1_base64", "audienceMode": "saml_sp_entity_id" }'

Replaces mutable persistent identifier profile settings for the selected profile id. The response returns the updated profile in a result envelope.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
profileId
required
string

Request Body required

Section titled “Request Body required ”
Media type application/json
object
profileKey
string
displayName
required
string
description
string | null
mode
string
Allowed values: computed stored imported
algorithm
string
Allowed values: authrim_sha256_base64url shibboleth_sha1_base64 stored imported
protocolScope
string
Allowed values: any saml oidc generic
usage
Array<string>
sourceRef
object
key
additional properties
secretRef
string
issuerEntityId
string | null
audienceMode
string
Allowed values: runtime saml_sp_entity_id oidc_sector_identifier
format
object
key
additional properties
lifecycleState
string
key
additional properties
Example 
{
  "profileKey": "saml-persistent-id",
  "displayName": "SAML persistent NameID",
  "protocolScope": "saml",
  "algorithm": "shibboleth_sha1_base64",
  "audienceMode": "saml_sp_entity_id"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Persistent identifier profile mutation response.

Media type application/json
object
result
required
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
{
  "result": {
    "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

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