Difference between revisions of "Device flow description"
Pavel.lobko (talk | contribs) m (Pavel.lobko moved page Device-flow-decription to Device-flow-description) |
Pavel.lobko (talk | contribs) |
||
| Line 13: | Line 13: | ||
#At the time end-user i2 rest starts polling authorization server. | #At the time end-user i2 rest starts polling authorization server. | ||
#The authorization server validates the device code provided by the client and responds with the access token if the client is granted access, an error if they are denied access, or an indication that the client should continue to poll. | #The authorization server validates the device code provided by the client and responds with the access token if the client is granted access, an error if they are denied access, or an indication that the client should continue to poll. | ||
| + | |||
| + | == Required parameters == | ||
| + | |||
| + | {| class="wikitable" | ||
| + | ! Parameter!! Description | ||
| + | |- | ||
| + | |[[i2Rest-client command#AUTHMETHOD | Authentication method]] || <code>*OAUTH2C</code> must be specified | ||
| + | |- | ||
| + | |[[i2Rest-client command#COMAND| Command]] || Any of available request type can be choosen | ||
| + | |- | ||
| + | |[[i2Rest-client command#URL| API endpoint]] || HTTP resource to serve the request | ||
| + | |- | ||
| + | |[[i2Rest-client command#TOKENS| Tokens storage]] || ??????? | ||
| + | |- | ||
| + | |[[i2Rest-client command#AUTHID| User/OAuth2 client/device ID]] ||rowspan="2"| Client Credentials to authenticate with authorization server | ||
| + | |- | ||
| + | |[[i2Rest-client command#AUTHPW| User/OAuth2 client/dev passwd]] | ||
| + | |- | ||
| + | |[[i2Rest-client command#TOKENURL| OAuth2 token endpoint]] || HTTP resource used by the client to abtain an access token | ||
| + | |- | ||
| + | |} | ||
---- | ---- | ||
[[I2Rest_Client|Back to i2Rest Client]] | [[I2Rest_Client|Back to i2Rest Client]] | ||
Revision as of 12:56, 10 April 2020
The flow consists of the following steps:
- i2Rest client sends a request to the authorization server and includes its client identifier in the request.
- The authorization server responds with a device code, an end-user code and the verification URL.
- i2rest client provides end-user with a device code and the verification URL.
- Now it's time end-user to follow provided verification URL on any capable device. After authentification on authorization server end-user will be prompted to grant (or deny) access to the application.
- At the time end-user i2 rest starts polling authorization server.
- The authorization server validates the device code provided by the client and responds with the access token if the client is granted access, an error if they are denied access, or an indication that the client should continue to poll.
Required parameters
| Parameter | Description |
|---|---|
| Authentication method | *OAUTH2C must be specified
|
| Command | Any of available request type can be choosen |
| API endpoint | HTTP resource to serve the request |
| Tokens storage | ??????? |
| User/OAuth2 client/device ID | Client Credentials to authenticate with authorization server |
| User/OAuth2 client/dev passwd | |
| OAuth2 token endpoint | HTTP resource used by the client to abtain an access token |
