Skip to content
Authrim

Preview OIDC destination release.

POST
/api/admin/field-mapping/preview/oidc
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/field-mapping/preview/oidc \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "destination": { "destinationId": "oidc-client", "purpose": "login" }, "values": [ { "targetRef": { "claim": "department" }, "value": "Engineering" } ] }'

Runs a non-persisted OIDC attribute release preview for destination values and optional claims request data. The preview response reports protocol and release constraints without storing the result.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
object
destination
required
object
protocol
string
Allowed values: oidc saml
destinationId
required
string
purpose
required
string
key
additional properties
values
required
Array<object>
<= 250 items
object
key
additional properties
oidcClaimsRequest
object
key
additional properties
samlRequestedAttributes
Array<object>
object
key
additional properties
key
additional properties
Example 
{
  "destination": {
    "destinationId": "oidc-client",
    "purpose": "login"
  },
  "values": [
    {
      "targetRef": {
        "claim": "department"
      },
      "value": "Engineering"
    }
  ]
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OIDC or SAML destination release preview response.

Media type application/json
object
preview
required
object
protocol
required
string
Allowed values: oidc saml
persisted
required
boolean
key
additional properties
key
additional properties
Example 
{
  "preview": {
    "protocol": "oidc",
    "persisted": false
  }
}

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