i2rest_request_authorize

From i2Rest
Jump to: navigation, search

This object represents parameters which are required to get device access token.

Field Type Description Default value
token_endpoint string REQUIRED. Token endpoint

Defines URL to send device access token request

client_id, client_secret string REQUIRED. Client's ID and password

i2Camunda will use these values as client_id and client_secret parameters of device access token request

device_code string REQUIRED. Device code

This is the value of device code that was received in the response to i2rest_request_authorize request

grant_type string REQUIRED. Grant type

It should be the value "urn:ietf:params:oauth:grant-type:device_code" for Device Code flow

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 token endpoint returns response with HTTP status 401 unauthorized or "access_denied". If not defined, the incident will be created

on_expired string "Device code expired" BPMN error code

This code will be used for throwing BPMN error when token endpoint returns "expired_token". If not defined, the incident will be created

on_slowdown string "Slow down" BPMN error code

This code will be used for throwing BPMN error when token endpoint returns "slow_down". If not defined, the incident will be created

on_pending string "Authorization pending" BPMN error code

This code will be used for throwing BPMN error when token endpoint returns "authorization_pending". If not defined, the incident will be created

Upon response, i2camunda will save access token response parameters in i2camunda_response Json variable (the name of this variable can be overridden in i2camunda configuration object):

  • access_token
  • token_type
  • expires_in
  • refresh_token
  • scope