28 May 2024

API client credentials

Details the API client credentials as follows:

  • Name of the client. For example, api_ThirdPartySystem. Note that the api_ prefix is added automatically.

  • Description of the client. For example, Student marketing and recruitment.

  • Scopes that are being granted to the client. For example, AdmissionsService.Api.Integration.Write.

  • Status of the client, such as Active or Expired.

  • Enabled If selected, the API client credentials can be used.

  • Expires on details the date and time that the client credentials expire. The expiry date is no more than one year from the creation of the client credential.

Actions you can perform:

  • Add a client credential: select Add.

  • Update a client credential: go to ⋮ and then select Edit or Delete.

  • Regenerate a client secret: go to ⋮ and then select Regenerate client secret.