Organization Client
Organization client represents an application user account type in the Switch platform that allows simple but powerfull integration with the Switch API.
Last updated
Was this helpful?
Organization client represents an application user account type in the Switch platform that allows simple but powerfull integration with the Switch API.
Last updated
Was this helpful?
In order to get an access token from the Switch Authorization Server, you need to pass valid client ID and client secret in the request as explained in . For this purpose you need to create an Organization Client.
The Switch app offers a way for the organization administrators to manage their organization clients, such as view, and delete existing clients, create new clients and manage each client secrets.
Follow the steps below to see your organization clients and their respective IDs.
In the upper-right corner of any page in the Switch app, click the User icon, then click on the organization for which you whish to see the clients for.
Next, in the upper-right corner of any page on Switch app, click the Settings icon, then click My organization.
Next, in the left sidebar menu click API.
List of existing organization clients with their respective client IDs will be shown on the right, under the Clients tab.
Click on the Create client button on the right.
After saving, the newly created client with its respective client ID will be shown in the list of existing clients.
Click on the rotate button right next to the secret hint, of the client secret that you want to rotate.
The secret will be rotated and the new value will be shown until you refresh the page, after which you will be able to see only the secret hint.
Click on the Delete button on the right of the client name, of the client you want to delete.
By deleting a client, any application using this client will lose access to the Switchmarket API.
Click on the pencil-like edit icon below the client name, right next to list of associated roles, after which the Roles popup window will be shown.
By updating the client roles you will potentially change the permissions that the client has at the moment and thus change what the client has access to.
To create new organization client you first need to be on the page as explained above and follow the steps below.
Next, enter the client Name, select which roles the client should have from the list of Available roles, and click the Save button in the bottom-right.
To rotate the client secret you need to be on the page as explained above and follow the steps below.
To delete existing organization client you need to be on the page as explained above and follow the steps below.
The roles associated with organization client ensure which permissions the client will have when accessing the SwitchmarketAPI. It is important that you are aware of this when changing the roles to the organization client since you might lose some permissions that you require, or give some permissions that you did not intended to, depending on which roles you will select. To manage the associated roles with a client you need to be on the page as explained above and follow the steps below.
Select from the Available roles shown on the left to add/associate them with the client. Click on the Selected roles shown on the right to remove/dissociate them from the client. Click on the Save button in the bottom-right to save the changes.
