Difference between revisions of "I2Camunda i2rest request authorize"
(Created page with "{{DISPLAYTITLE:i2Rest_request_authorize}} This object represents parameters which are required to initiate the [https://tools.ietf.org/html/rfc8628 Device Code flow]. {| styl...") |
|||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | {{DISPLAYTITLE: | + | {{DISPLAYTITLE:i2rest_request_authorize}} |
This object represents parameters which are required to initiate the [https://tools.ietf.org/html/rfc8628 Device Code flow]. | This object represents parameters which are required to initiate the [https://tools.ietf.org/html/rfc8628 Device Code flow]. | ||
{| style="width: 100%; vertical-align:top; border-collapse:collapse" border="1" | {| style="width: 100%; vertical-align:top; border-collapse:collapse" border="1" | ||
| Line 29: | Line 29: | ||
|style="padding: 5px"|string | |style="padding: 5px"|string | ||
|style="padding: 5px"|'''BPMN error code''' | |style="padding: 5px"|'''BPMN error code''' | ||
| − | If defined, i2Camunda will | + | If defined, i2Camunda will throw BPMN error with this code instead of creating incident. |
| | | | ||
|-style="vertical-align:top;" | |-style="vertical-align:top;" | ||
| Line 35: | Line 35: | ||
|style="padding: 5px"|string | |style="padding: 5px"|string | ||
|style="padding: 5px"|'''"Unauthorized" BPMN error code''' | |style="padding: 5px"|'''"Unauthorized" BPMN error code''' | ||
| − | This code will be used for | + | This code will be used for throwing BPMN error when authorization endpoint returns response with HTTP status 401 unauthorized. If not defined, the incident will be created |
| | | | ||
|} | |} | ||
Latest revision as of 09:47, 25 August 2020
This object represents parameters which are required to initiate the Device Code flow.
| Field | Type | Description | Default value |
| authorization_endpoint | string | REQUIRED. Device authorization endpoint
Defines URL to send device authorization request |
|
| client_id | string | REQUIRED. Client's ID
i2Camunda will use this value as client_id parameter of device authorization request |
|
| scope | string | The scope of the access request
The scope of the access request. It can contain one or more scopes separated with spaces, for example: run_program run_command |
|
| on_error | string | BPMN error code
If defined, i2Camunda will throw BPMN error with this code instead of creating incident. |
|
| on_401 | string | "Unauthorized" BPMN error code
This code will be used for throwing BPMN error when authorization endpoint returns response with HTTP status 401 unauthorized. If not defined, the incident will be created |
Upon response, i2camunda will save Device authorization response parameters in i2camunda_response Json variable (the name of this variable can be overridden in i2camunda configuration object):
- device_code
- user_code
- verification_url
- verification_url_complete
- expires_in
- interval
