Manage identity clients

Create and manage identity clients in MAS to authenticate with the Vitesse API.

Identity clients are used to generate API access tokens. Each client is configured with a set of API roles that define what it can do.

📘

For information about tokens, see Authentication.

Access requirements

You must have the Merchant Admin role or Manage Identity Clients role to manage identity clients.

Identity client management must be enabled for your account. If you cannot access this feature, contact your Vitesse relationship manager.

View identity clients

  1. Go to Administration > Identity Clients

The list shows all configured clients. From here, you can:

  • View client configuration
  • Edit existing clients
  • Create new clients

Create an identity client

  1. Go to Administration > Identity Clients

  2. Select New Client

  3. Configure the following fields:

    FieldDescriptionConstraints
    Client IDUnique identifier used to request tokens6–100 characters; must be unique across the Vitesse platform
    Client secretSecret used with the client ID to authenticate6–100 characters
    Client nameOptional label for your reference3–100 characters
    DescriptionOptional descriptionUp to 1000 characters
    Token durationToken lifetime (minutes)10–60 minutes
    RolesAPI roles assigned to the clientAt least one role must be selected
    📘

    The client secret is stored securely and cannot be viewed after creation.

  4. Select Create to save the client.
    The client is enabled immediately.

Edit an identity client

You can update the same fields as when creating a client.

You can also:

  • Enable or disable the client
  • Update assigned roles
  1. Go to Administration > Identity Clients

  2. Open the action menu for the client

  3. Select Edit

  4. Make your changes.

  5. Select save submit your changes.
    Changes apply the next time a token is requested.

View client details

To view a client:

  1. Go to Administration > Identity Clients
  2. Select the client ID or choose View from the action menu

The details page shows:

  • Client configuration
  • Status (enabled or disabled)
  • Creation and update timestamps

Request a token

Use the client ID and secret to request a token from the Vitesse identity endpoint.

See How to request a Vitesse identity token.