This example describes an example OAuth2 workflow using the Authorization Code Grant flow as per section 4.1 of the OAuth2 specification. Uris of required endpoints are assumed to have been obtained from the authentication resource as described in section 2.2 of the Foundation API specification.
For this example, it is assumed that the client has been registered with the server in advance and has been issued valid credentials in the form of client_id and client_secret.
To initiate the workflow, the client sends the user to the "oauth2_auth_url" with the following parameters added:
| parameter | value |
|---|---|
| response_type | code as string literal |
| client_id | your client id |
| state | unique user defined value |
| redirect_url | The redirect_url registered for your client. This parameter is optional for OAUTH servers that don't support multiple redirect URLs |
Example URL:
GET https://example.com/foundation/oauth2/auth?response_type=code&client_id=<your_client_id>&state=<user_defined_string>&redirect_url=https://YourWebsite.com/retrieveCode
On Windows operating systems, it is possible to open the systems default browser by using the url to start a new process.
Example redirected URL:
https://YourWebsite.com/retrieveCode?code=<server_generated_code>&state=<user_defined_string>
The Open CDE API server will ask the user to confirm that the client may access resources on his behalf. On authorization, the server redirects to an url that has been defined by the client author in advance. The generated code parameter will be appended as query parameter. Additionally, the state parameter is included in the redirection, it may be used to match server responses to client requests issued by your application.
If the user denies client access, there will be an error query parameter in the redirection indicating an error reason as described in section 4.1.2.1 of the OAuth2 specification.
With the obtained authorization code, the client is able to request an access token from the server. The "oauth2_token_url" from the authentication resource is used to send token requests to, for example:
POST https://example.com/foundation/oauth2/token
The POST request should be done via HTTP Basic Authorization with your applications client_id as the username and your client_secret as the password.
Example Request
POST https://example.com/foundation/oauth2/token?grant_type=authorization_code&code=<your_access_code>
The access token will be returned as JSON in the response body and is an arbitrary string. There is no maximum length, per oauth2 documentation.
Response parameters
| parameter | type | description |
|---|---|---|
| access_token | string | The issued OAuth2 token |
| token_type | string | Always bearer |
| expires_in | integer | The lifetime of the access token in seconds |
| refresh_token | string | The issued OAuth2 refresh token, one-time-usable only |
Example Response
Response Code: 201 - Created
Body:
{
"access_token": "Zjk1YjYyNDQtOTgwMy0xMWU0LWIxMDAtMTIzYjkzZjc1Y2Jh",
"token_type": "bearer",
"expires_in": "3600",
"refresh_token": "MTRiMjkzZTYtOTgwNC0xMWU0LWIxMDAtMTIzYjkzZjc1Y2Jh"
}
The process to retrieve a refresh token is exactly the same as retrieving a token via the code workflow except the refresh_token is sent instead of the code parameter and the refresh_token grant type is used.
Example Request
POST https://example.com/foundation/oauth2/token?grant_type=refresh_token&refresh_token=<your_refresh_token>
The access token will be returned as JSON in the response body and is an arbitrary string.
Example Response
Response Code: 201 - Created
Body:
{
"access_token": "Zjk1YjYyNDQtOTgwMy0xMWU0LWIxMDAtMTIzYjkzZjc1Y2Jh",
"token_type": "bearer",
"expires_in": "3600",
"refresh_token": "MTRiMjkzZTYtOTgwNC0xMWU0LWIxMDAtMTIzYjkzZjc1Y2Jh"
}
The refresh token can only be used once to retrieve a token and a new refresh token.
When requesting other resources the access token must be passed via the Authorization header using the Bearer scheme (e.g. Authorization: Bearer Zjk1YjYyNDQtOTgwMy0xMWU0LWIxMDAtMTIzYjkzZjc1Y2Jh).