Difference between revisions of "Client flow description"
Pavel.lobko (talk | contribs) |
Pavel.lobko (talk | contribs) |
||
| (13 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | {{DISPLAYTITLE:Client | + | {{DISPLAYTITLE:Client credential flow description}} |
| − | An application can request an access token using only its own credentials, the flow is pretty simple. | + | An application can request an access token using only its own credentials, the flow is pretty simple.<br> |
| − | [[File:Client-flow-scheme.png]] | + | [[File:Client-flow-scheme.png|400px]] |
The flow consists of the following steps:<br> | The flow consists of the following steps:<br> | ||
| − | (A) The client authenticates with the authorization server and requests an access token from the token endpoint. | + | :'''(A)''' The client authenticates with the authorization server and requests an access token from the token endpoint. |
| − | (B) The authorization server authenticates the client, and if valid, issues an access token. | + | :'''(B)''' The authorization server authenticates the client, and if valid, issues an access token. |
| − | |||
| − | |||
| − | |||
| + | ==Client Credential flow by i2Rest command== | ||
| + | The next parameters are mandotary to perform request with Client Credential flow by I2Rest command.<br> | ||
{| class="wikitable" | {| class="wikitable" | ||
! Parameter!! Description | ! Parameter!! Description | ||
|- | |- | ||
| − | |[[ | + | |[[I2Rest_Client_command#AUTHMETHOD | Authentication method]] || *OAUTH2C 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#AUTHID| User/OAuth2 client/device ID]] ||rowspan="2"| Credentials to authenticate I2Rest Client with authorization server |
|- | |- | ||
| − | |[[ | + | |[[I2Rest_Client_command#AUTHPW| User/OAuth2 client/dev passwd]] |
|- | |- | ||
| − | |[[ | + | |[[I2Rest_Client_command#AUTHURL| OAuth2 authorization endpoint]] || HTTP resource to be requested for an access token |
|- | |- | ||
| − | |[[ | + | |[[I2Rest_Client_command#SCOPE| Scope]] || The set of resources and operations that are allowed to application with access token |
|- | |- | ||
|} | |} | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Latest revision as of 10:03, 9 July 2020
An application can request an access token using only its own credentials, the flow is pretty simple.
The flow consists of the following steps:
- (A) The client authenticates with the authorization server and requests an access token from the token endpoint.
- (B) The authorization server authenticates the client, and if valid, issues an access token.
Client Credential flow by i2Rest command
The next parameters are mandotary to perform request with Client Credential flow by I2Rest command.
| 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 |
| User/OAuth2 client/device ID | Credentials to authenticate I2Rest Client with authorization server |
| User/OAuth2 client/dev passwd | |
| OAuth2 authorization endpoint | HTTP resource to be requested for an access token |
| Scope | The set of resources and operations that are allowed to application with access token |
