Skip to main content

Creating an Oauth2 Client

Notice

The OAuth 2.0 authorization framework enables a third-party application to obtain access to an HTTP service.

OAuth2 clients allow you to configure external services and applications to authenticate against Relativity in a secure manner.

The OAuth2 client setup information also includes:

  1. A client ID.

  2. A redirect URI.

  3. Client secret key.

These details will be used to validate your application and authorize the API calls.

Creating New Oauth2 Clients

After logging in for the first time to Checkmarx One the Oauth2 Clients window will be empty.

2302836870.png

To create a new client, perform the following:

  1. Click Create_Client.png

  2. In the Add Client window, type the client ID and click Create Client

    2296153917.png

  3. The following will happen:

    1. The client ID and its secret key will be presented.

    2. Settings & Role Mapping sections will be added.

    3. Name and Description fields are optional.

    2330591662.png

  4. It is possible to change the secret key by clicking Reload

    2332491947.png

  5. Expand the Role Mapping section.

    2303000712.png

  6. There are 2 different role tabs:

    1. Checkmarx One roles - Checkmarx One application roles (Actions in the Checkmarx One application) (blue star)

    2. IAM roles - System user management.

    2303524977.png

  7. In the Checkmarx One roles tab, click Add to add roles to the client.

    For example:

    2296121148.png

  8. Once a Composite role is added to the client, its actions will be presented for viewing.

    2302967983.png

  9. To delete a role, click the “x” sign.

    2303263106.png

  10. Click Save_Client.png

Notice

There are 2 Checkmarx One role types in the system:

  1. Composite Roles - Aggregative actions collected into 1 roles type.

  2. Action Roles - A single action role.

For a detailed information regarding all role types see Managing Roles

In this section: