Add a client-credentials client
- Last UpdatedApr 22, 2024
- 2 minute read
Client-credentials clients are used for server-to-server communication where no user interaction is required.
Prerequisite
You must have the role of Tenant Administrator to add and manage clients.
Procedure
To add a client-credentials client:
-
In the left pane, select Security > Clients.
-
In the Client Type dropdown list, select Client-Credentials Client. This option is displayed by default.
-
In the toolbar, select Add Client.
The Add Client pane opens.
-
In the Name field, enter a name to identify the device or application that will use this client.
-
(Optional) In the Token Lifetime field, enter the length of time in seconds that the access token functions before it expires.
The default, 3600 seconds (one hour), is the maximum length of time. The minimum value is 60 seconds.
-
In the Tenant Roles and Community Roles tabs, select the roles that are appropriate for the client.
By default, the client has the Tenant Member role which cannot be removed. Roles can be modified after the client is created.
-
Select Next.
The Create Secret pane opens.
-
(Optional) In the Description field, enter a description for the client secret.
-
In the Expiration Date field, enter a date and time that the secret expires.
Ensure that the expiration date is valid for the secret. By default, the secret is set to expire one year after creation. Select the Never Expires checkbox to specify that the secret does not expire. Secrets can be deleted later, including secrets that are set to never expire.
-
Select Save.
The Client Successfully Created window opens and displays the Client Id and Client Secret.
Important: Select Copy
to the right of each field and store the client secret and client Id in a secure
place. You need this information to connect your applications. Once the window is
closed, the client secret cannot be accessed or retrieved.
-
Select Close.
Note: In the list of secrets, the Client Id is still visible. If you did not save the client secret, see Maintain a client for instructions on adding a new secret.