Difference between revisions of "Client flow description"

From i2Rest
Jump to: navigation, search
(Required parameters)
Line 9: Line 9:
 
:'''(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.
  
== Required parameters ==
+
==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]] || <code>*OAUTH2C</code> must be specified
+
|[[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#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#URL| API endpoint]] || HTTP resource to serve the request
 
|-
 
|-
|[[i2Rest-client command#AUTHID| User/OAuth2 client/device ID]] ||rowspan="2"|  Client Credentials to authenticate with authorization server
+
|[[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#AUTHPW| User/OAuth2 client/dev passwd]]  
 
|-
 
|-
|[[i2Rest-client command#TOKENURL| OAuth2 token endpoint]] || HTTP resource to be used by the client to obtain an access token
+
|[[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  
 
|-
 
|-
 
|}
 
|}
 
  
 
----
 
----
 
[[I2Rest_Client|Back to i2Rest Client]]
 
[[I2Rest_Client|Back to i2Rest Client]]

Revision as of 17:31, 28 May 2020

An application can request an access token using only its own credentials, the flow is pretty simple.
Client-flow-scheme.png


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

Back to i2Rest Client