Creating a Custom OAuth Application

Note: This authentication method is only available for suitecrmv8 schema.

SuiteCRM V8 API uses OAuth2.0 as its main method of authentication, in conjunction with either CLIENT credentials grant or PASSWORD grant. A custom OAuth application is used to secure the private and public OAuth keys.

OAuth authentication requires a SuiteCRM admin to create and register a custom OAuth application, and to ensure that users of both grant types have appropriate roles to access the API.

Register an Application

In the SuiteCRM admin console:

1. Log in to your admin account.
2. In the Profile dropdown, select Admin > OAuth2 Clients and Tokens.
3. Click New Password Client or New Client Credentials Client.
4. Enter a name and a secret.
5. Click Save.

Note the OAuth client credentials, the consumer key, and consumer secret for future reference.

Assign Roles for API Access

Normally, users who authenticate with the CLIENT credentials grant type have full access to the API; users who authenticate with the PASSWORD grant type require permissions for each module or table.

To set user access to particular resources as needed, configure REST roles with the necessary privileges, and then assign users to those roles.

1. In the Profile dropdown, select Admin > Role Management.
2. Click Create Role.
3. Enter a name and description for the new role, and click Save.
   The Admin console redirects you to the Role Configuration menu.
4. Select the permissions required for the new role.
5. Click Save.

Now assign the new role to one or more users:

1. In the Profile dropdown, select Admin > Role Management.
2. Click on the role you want to assign to a user.
3. Scroll down to the bottom and click Select User.
   The Admin console displays a user sesarch window.
4. Select the users to whom you want to assign the role.
   For each user you select, click Select, then Save.