OAuth

Class Description

OAuth allows to Log into a contagt Account with external Credentials of a certified Provider. Providers must be registered for api key that is used to validate them and can not be generically chosen from. OAuth knows three different states: 1. Neither code nor state are transmitted -> OAuth will start a new Auth-Request and return the Authentication Request Link. 2. Only state is transmitted -> OAuth will start in Longpolling Mode and wait for the Internal Cache to receive a new UserToken. After retrieval the UserToken will be omitted. 3. Both code and state are transmitted -> OAuth will validate the State and write the newly created UserToken into the Internal Cache

RPC Configuration

Rpc Name:

Plain: OAuth
Sha1: 3595dccf10c550ca68f2ee7a6f2ccc6bfe484f2c

Rpc Call

RPCs can be called by their plain name or their SHA1 representation.

Rpc Parameters:

"code" : ?string = null,
"state" : ?string = null 

Requires Login:

false

Requires Context:

Context

The context providing parameter can either be a contagt-id (8-Bytes, Alphaumeric) or an integer as a building id. The context parameter name should make the choice obviouse, the type has not to be defined manually.

false

Requires WriteAccess:

WriteAccess

Only accounts that have an explicit write access to the defined context can execute this RPC, no matter if the authentication level matches or not.

false

Requires AuthenticationLevel:

Context

Authentication levels allow the SuperUser to define a by-RPC granular access configuration. If RPCs are chained in a single unified call and lenient is enabled, all allowed RPCs will be executed, while execution will fail entirely with lenient set to false.

ANONYMOUS

Requires Subbuilding Merge Strategy:

REPLACE

Cache Configuration

Response Cache

All writing RPCs are not Cacheable, also Caching will be disabled by the paramters nocache and readonly.

Cache enabled:

false