Oauth2 Client credentials flow

Oauth2 Client Credentials flow is the most direct form of authentication. The Client Credentials must be treated confidentially and must not be disclosed to third parties.
In any case, the following guidelines apply:
The Client Credentials are not accessible by or visible to the user.
The code is not plainly accessible in a public downloadable binary.

The client credentials consist of two fields:

  • Client ID: XXXXXXXXXXXX
  • Client Secret: XXXXXXXXXXXXXXXXXXXXXXXXX

After registration, the Client Credentials are provided per application by email.



These credentials can be exchanged for a JWT (JSON web token), which can then be used to communicate with the APIs. This takes place via the OAuth2 client credentials flow. You can read about this in Okta's documentation:
https://developer.okta.com/authentication-guide/implementing-authentication/client-creds#3-using-the-client-credentials-flow

TheURL with which credentials can be exchanged for a JWT is included in the configuration files of the authentication server:

Staging:https://idm.staging.floriday.io/oauth2/ausmw6b47z1BnlHkw0h7/.well-known/oauth-authorization-server

Live: [https://idm.floriday.io/oauth2/aus3testdcf2vyfs70i7 (https://idm.floriday.io/oauth2/aus3testdcf2vyfs70i7)


🚧

Configure token endpoint

Please note that depending on the OAuth library that you use, you have to either configure the token endpoint directly (https://idm.floriday.io/oauth2/aus3testdcf2vyfs70i7/v1/token), or the address of the authorization server itself (https://idm.floriday.io/oauth2/aus3testdcf2vyfs70i7/)



The obtained JWT has to be included with every API call in the Authorization HTTP header, preceded by 'Bearer'.



This JWT is an encrypted JSON message. You can read more about this token and you can also easily inspect the contents on www.jwt.io.

Using the API-key and the JWT-token, the data of the user can be accessed.



The implementation will then look as follows:



More information can be found here: https://developer.okta.com/docs/guides/implement-client-creds/overview/

Validating it works

By executing the following requests one can easily validate if the authentication properly works.

First request a token. Replace the CLIENT_ID and CLIENT_SECRET placeholders with your personal values.

curl --location --request POST 'https://idm.staging.floriday.io/oauth2/ausmw6b47z1BnlHkw0h7/v1/token' \
--header 'Accept: application/json' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=client_credentials' \
--data-urlencode 'client_id=##CLIENT_ID##' \
--data-urlencode 'client_secret=##CLIENT_SECRET##' \
--data-urlencode 'scope=role:app catalog:read sales-order:write organization:read supply:read supply:write sales-order:read delivery-conditions:read fulfillment:write fulfillment:read'


With the returned access token try to GET all organization belonging to the account identified by the API-Key.

curl --location --request GET 'https://api.staging.floriday.io/apps/organizations' \
--header 'X-Api-Key: ##API_KEY##' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer ##ACCESS_TOKEN##

Did this page help you?