OIDC Authentication Endpoint (POST)

Identical to the GET form, for tools that submit the authorization request as a form post. Parameters arrive in the request body instead of the query string.

application/x-www-form-urlencoded

Request Body required

client_id string required
login_hint string required
lti_message_hint string required
redirect_uri uri required
scope string required

Possible values: [openid]

response_type string required

Possible values: [id_token]

response_mode string required

Possible values: [form_post]

prompt string required

Possible values: [none]

state string required
nonce string required

Responses

• 302
• 400
• 403
• 404

---

Redirect to your configured Launch URL or Deep Linking URL, carrying ?payload=<JWT>.

One or more request parameters were missing or malformed.

application/json

Schema

Example (from schema)

---

Schema

status integer
error string
details object
errors object[]
One entry per field that failed validation.
Array [
field string
message string
]

{
  "status": 400,
  "error": "Bad Request",
  "details": {
    "errors": [
      {
        "field": "clientId",
        "message": "Missing 'clientId' parameter."
      }
    ]
  }
}

The account is not permitted to use this endpoint — most often because it is an LTIAAS Launch account rather than a Connect one, or because a trial quota has been reached.

application/json

Schema

Example (from schema)

Example

---

Schema

status integer
error string
details object

Context for the failure. Always carries a message code; the other keys depend on what went wrong.

message string

description string

property name* any

Context for the failure. Always carries a message code; the other keys depend on what went wrong.

{
  "status": 403,
  "error": "Forbidden",
  "details": {
    "message": "INACTIVE_SERVICE",
    "description": "string"
  }
}

{
  "status": 403,
  "error": "Forbidden",
  "details": {
    "message": "INVALID_ACCOUNT_TYPE"
  }
}

No tool with that ID is registered on this account.

application/json

Schema

Example (from schema)

Example

---

Schema

status integer
error string
details object

Context for the failure. Always carries a message code; the other keys depend on what went wrong.

message string

description string

property name* any

Context for the failure. Always carries a message code; the other keys depend on what went wrong.

{
  "status": 403,
  "error": "Forbidden",
  "details": {
    "message": "INACTIVE_SERVICE",
    "description": "string"
  }
}

{
  "status": 404,
  "error": "Not Found",
  "details": {
    "message": "UNREGISTERED_TOOL"
  }
}

Loading...