oauth/Requests

Collection of OAuth 2.0 authorization and OpenId Connect 1.0 identification providers.

Created by the ws microservice. Used when serving requests to the /oauth/…​ Endpoint group.

Used for the three-stage external authorization process and linking an external account to a local account.

Successful completion requires a token authorization service script configured in the master domain ('iam_token_svcscript_code').

Contained only in the master domain.

Storage type: runtime.

Table 1. Class fields
Field Description

id

Identifier

remoteIp

Request initiator IP address.

status

Request state:

  • initial - request created.

  • authorized - external authorization completed successfully.

  • linked - external account linked to the internal one, session created.

  • error - authorization/identification process error.

Correct state sequence: 'initial' → 'authorized' → 'linked'.

statusText

Occurred error text. Populated when the 'error' status is set.

provider_key

OAuth authorization provider key (from the 'oauth/Providers' collection).

provider_key

OAuth authorization provider identifier (from the 'oauth/Providers' collection).

refresh_token

Token for refreshing the 'access_token' value used to access the external data server. After initial authorization completes, the system does not access the external authorization server or data server, so the entity is deleted automatically.

scope

Scope granted during external authorization. May be smaller than registered for the system if optional_scope is used and the user does not select some sections.

oid

Discovered identifier of the user external account on the external authorization server.

login

Discovered login of the user external account on the external authorization server. May be used for matching when linking to a local user account.

name

Discovered name of the user external account on the external authorization server. May be used when creating a local user account.

email

Discovered email of the user external account on the external authorization server. May be used both when creating a local user account and when linking to an existing user account.

domain

Local system domain where linking to the user external account is proposed.

info

Collected user information in the external system for placement in the 'opts.info' field of the matched account.

payload

Original content about the user external account. Determined by parsing JWT content or JSON content in the external data server response or the redirect from the external authorization server.

ts

Request creation/modification timestamp.

expires_in

Request lifetime in seconds. Counted from each entity modification (the 'ts' field sets the timestamp). After expiry the request is deleted automatically. In 'initial' and 'authorized' states the lifetime is 120 seconds. In 'ready' state - 60 seconds. After initial authorization completes, the system does not access the external authorization server or data server, so the entity is deleted automatically.