Organization Client

Organization client represents an application user account type in the Switch platform that allows simple but powerfull integration with the Switch API.

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 Client Credentials Flow. 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.

Manage Clients

View clients

Follow the steps below to see your organization clients and their respective IDs.

1. 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.

2. Next, in the upper-right corner of any page on Switch app, click the Settings icon, then click Administer my organization.

3. Next, in the left sidebar menu click API.

4. List of existing organization clients with their respective client IDs will be shown on the right, under the Clients tab.

   

In case there are no existing organization clients available for the organization, an empty list will be shown. In this case just proceed to the next topic about creating new organization client.

Create client

To create new organization client you first need to be on the View clients page as explained above and follow the steps below.

1. Click on the Create client button on the right.

   
2. 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.
3. After saving, the newly created client with its respective client ID will be shown in the list of existing clients.

   

Delete client

To delete existing organization client you need to be on the View clients page as explained above and follow the steps below.

1. 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.

Client roles

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 View clients page as explained above and follow the steps below.

1. 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.

   
2. 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.

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.

Manage Client Secrets

Create client secret

The client secret is a secret string that the application uses to prove its identity when requesting an access token and can be referred to as an application password. Each organization client can have one or multiple secrets. To generate client secret, you need to be on the View clients page as explained above and follow the steps below.

1. Click on the New secret button on the right after which the create new secret window is shown.

   
2. Fill in the required client secret details and click Save. Name - short descriptive name of the client secret Validity - the period under which the client secret will be valid for use. In case you do not provide the validity period, the default period will be 2 years starting from the date when you have created the client secret.
3. After the details are saved, the client secret is generated and displayed below the client information.

   

The secret string should be stored in a safe place and will not be shown here after the page is refreshed.

Delete client secret

To delete existing organization client secret you need to be on the View clients page as explained above and follow the steps below.

1. Click on the Delete icon shown on the right of the client secret name

   

By deleting a client secret, any application using the combination of a client ID and the deleted client secret will lose access to the Switchmarket API.