Suspend a user

HTTP Basic authentication using your Tenant ID and API secret.

• Username is the Tenant ID (i.e. eu-west-2_AbcdEfghI)
• Password is the API secret you would have received.

You can also authenticate using OAuth 2.0 client credentials (oauth2 security scheme) instead of Basic auth.

OAuth 2.0 client credentials authentication.

Use the following token endpoints (replace :tenantId with your Tenant ID):

• Public API access tokens

  • Staging: https://public.api.learnstaging.link/oauth2/token/:tenantId
  • Production: https://public.api.learn.link/oauth2/token/:tenantId
  • Staging MEA: https://public.api.meastaging.learn.tech/oauth2/token/:tenantId
  • Production MEA: https://public.api.mea.learn.tech/oauth2/token/:tenantId

• Webhooks access tokens

  • Staging: https://user.api.learnstaging.link/oauth2/token/:tenantId
  • Production: https://user.api.learn.link/oauth2/token/:tenantId
  • Staging MEA: https://user.api.meastaging.learn.tech/oauth2/token/:tenantId
  • Production MEA: https://user.api.mea.learn.tech/oauth2/token/:tenantId

All access tokens must be sent using the Authorization: Bearer <access_token> header.

Scopes

For API access (non-webhooks), the following scopes are available:

• api/all – Full read and write access to the API.
• api/read – Read-only access to the API.
• api/write – Write access to the API.

For webhooks, the following scopes are available:

• api/webhooks – Access to webhook functionality.
• api/all – Full read and write access to the API, including webhooks.

Tokens must include appropriate scopes for the endpoints you wish to call.