light-mode-image
Learn
Authorization Code flowInteraction hook

API Reference

Create an Interaction hook

PUT/v1/openid/configuration

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

The Interaction Hook configuration payload

interactionHook?

Interaction Hook configuration.

Response Body

application/json

application/json

curl -X PUT "https://example.vii.au01.mattr.global/v1/openid/configuration" \  -H "Content-Type: application/json" \  -d '{}'
{
  "interactionHook": {
    "url": "https://example-university.com/callback",
    "claims": [
      "first_name",
      "last_name",
      "email"
    ],
    "sessionTimeoutInSec": 1200,
    "disabled": false,
    "secret": "dGtUrijBOT6UUJ8JO4kAFyGfhahDlVVeIk/sPbWTa7c="
  }
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

Retrieve Interaction hook

GET/v1/openid/configuration

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

application/json

curl -X GET "https://example.vii.au01.mattr.global/v1/openid/configuration"
{
  "interactionHook": {
    "url": "https://example-university.com/callback",
    "claims": [
      "first_name",
      "last_name",
      "email"
    ],
    "sessionTimeoutInSec": 1200,
    "disabled": false,
    "secret": "dGtUrijBOT6UUJ8JO4kAFyGfhahDlVVeIk/sPbWTa7c="
  }
}

How would you rate this page?

On this page