Authentication

Authenticate your requests to the Provisionr Workspace API

The Workspace API uses Bearer token authentication. Include your token in the Authorization header of every request.

curl https://wks-a1b2c3d4.provisionr.io/api/v1/directory/users \
  -H "Authorization: Bearer prv-your-token"

Token Types

Provisionr supports several token types depending on your use case.

Token Type	Use Case	Expiration
CLI Access Token	Interactive CLI usage	60 minutes
CLI Refresh Token	Refreshing CLI access tokens	90 days
Service Account Token	Automated workflows and CI/CD	Configurable
API Token	Direct API access	Configurable

Obtaining a Token

Service Account

Service accounts are designed for automated workflows and integrations. Create a service account and generate a token from the Workspace UI.

1. Sign in to your Workspace UI

   Visit https://wks-{8char}.provisionr.io and sign in.

2. Navigate to Service Accounts

   In the left sidebar, navigate to the Service Accounts section.

3. Create a Service Account

   Create a new service account with the appropriate role and permissions for your use case.

4. Generate a Token

   Generate a bearer token for the service account. Store the token securely as it will only be shown once.

CLI Token

If you have the CLI client installed, your CLI access token can also be used for direct API calls. See the CLI Authentication guide for setup instructions.

Testing Your Token

Use the authentication test endpoint to verify your token is valid.

Request

curl https://wks-a1b2c3d4.provisionr.io/api/v1/auth/test \
  -H "Authorization: Bearer prv-your-token"

You can also test connectivity without authentication using the ping endpoint.

curl https://wks-a1b2c3d4.provisionr.io/api/v1/auth/ping

Unauthenticated Endpoints

Most endpoints require authentication. The following endpoints are accessible without a token:

Endpoint	Description
GET /auth/ping	Test API connectivity
GET /auth/version	Get environment and version data