This guide provides a step by step walkthrough of how to set up an OAuth Client and OAuth Credentials.
Note: Only users with an Admin role can access this setup. For more information about roles and permissions, review this article here.
Set up a Service User
Service users are user accounts used for API access by external systems. They are used in the configuration of machine-to-machine OAuth Clients, intended for API access only, and do not allow interactive UI login.
Click on "Team".
Navigate to the "Service users" tab within the Team setup, and then click "Add service user":
When creating a new Service user, complete the user creation form and assign a Role. For instance, an API Service user assigned the Maker role will only be permitted to execute actions authorized for that specific role.
Access the OAuth configuration to create credentials for this Service User
Click on “Settings”:
In the following screen, tap the icon that opens Security settings:
Select menu “OAuth Clients”:
This “OAuth Clients” menu is only available to the Admin users previously enabled by Jiko to access the OAuth configuration. If you do not see it, please contact us.
Create an OAuth Client
Select “Create client” to add a new OAuth Client.
Give a name to this OAuth Client (since you can create multiple OAuth Clients, for different use cases and scopes), and select the “Machine to Machine” application type. It corresponds to the OAuth Client Credentials flow.
Configure the other parameters, including the selection of Scopes.
Tap button “Create client”: this client is added to the list of OAuth Clients.
Setup OAuth Credentials for a given OAuth Client
Tap button “Add credentials”:
Choose a previously created OAuth Client:
Fill in remaining fields, including the copy of the Public key.
Credentials are created! You are now ready to connect to Jiko's APIs, using the scope you selected in the OAuth Client.