List of Authenticated Users

curl --request GET \
  --url https://wksusa1b2c3d.provisionr.app/api/v1/workspace/users \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://wksusa1b2c3d.provisionr.app/api/v1/workspace/users', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

[
  {
    "id": "wsusr_01hq8xyzabc123def456ghi789",
    "state": "staged",
    "provider": "google",
    "provider_id": "<string>",
    "name": "<string>",
    "handle": "<string>",
    "email": "<string>",
    "ui_mode": "<string>",
    "ui_color": "<string>",
    "timestamp": {
      "created_at": "2024-03-15T10:30:00.000000Z",
      "updated_at": "2024-03-15T14:22:00.000000Z",
      "expires_at": null,
      "last_authenticated_at": "2024-03-16T08:00:00.000000Z",
      "last_activity_at": "2024-03-16T09:30:00.000000Z",
      "deleted_at": null
    },
    "count": {
      "workspace_devices": 123,
      "workspace_roles": 123,
      "workspace_services": 123,
      "audit_logs_actor": 123,
      "audit_logs_parent": 123,
      "audit_logs_record": 123,
      "audit_logs_related": 123,
      "audit_logs_subject": 123
    },
    "included": [
      "<string>"
    ],
    "links": {
      "self": "<string>",
      "directory_user": "<string>",
      "workspace_devices": "<string>",
      "workspace_roles": "<string>",
      "workspace_services": "<string>",
      "workspace_tokens": "<string>"
    }
  }
]

{
  "message": "<string>"
}

{
  "message": "<string>"
}

GET

workspace

users

List of Authenticated Users

curl --request GET \
  --url https://wksusa1b2c3d.provisionr.app/api/v1/workspace/users \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://wksusa1b2c3d.provisionr.app/api/v1/workspace/users', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

[
  {
    "id": "wsusr_01hq8xyzabc123def456ghi789",
    "state": "staged",
    "provider": "google",
    "provider_id": "<string>",
    "name": "<string>",
    "handle": "<string>",
    "email": "<string>",
    "ui_mode": "<string>",
    "ui_color": "<string>",
    "timestamp": {
      "created_at": "2024-03-15T10:30:00.000000Z",
      "updated_at": "2024-03-15T14:22:00.000000Z",
      "expires_at": null,
      "last_authenticated_at": "2024-03-16T08:00:00.000000Z",
      "last_activity_at": "2024-03-16T09:30:00.000000Z",
      "deleted_at": null
    },
    "count": {
      "workspace_devices": 123,
      "workspace_roles": 123,
      "workspace_services": 123,
      "audit_logs_actor": 123,
      "audit_logs_parent": 123,
      "audit_logs_record": 123,
      "audit_logs_related": 123,
      "audit_logs_subject": 123
    },
    "included": [
      "<string>"
    ],
    "links": {
      "self": "<string>",
      "directory_user": "<string>",
      "workspace_devices": "<string>",
      "workspace_roles": "<string>",
      "workspace_services": "<string>",
      "workspace_tokens": "<string>"
    }
  }
]

{
  "message": "<string>"
}

{
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

filter[id]

string

filter[provider_id]

string

filter[provider_id_search]

string

filter[name]

string

filter[name_search]

string

filter[handle]

string

filter[handle_search]

string

filter[email]

string

filter[email_search]

string

filter[ui_mode]

string

filter[ui_color]

string

filter[state]

string

filter[id_search]

string

filter[created_before]

string

filter[created_after]

string

filter[updated_before]

string

filter[updated_after]

string

filter[expires_before]

string

filter[expires_after]

string

filter[expired_before]

string

filter[expired_after]

string

filter[deactivated_before]

string

filter[deactivated_after]

string

filter[deleted_before]

string

filter[deleted_after]

string

filter[last_authenticated_before]

string

filter[last_authenticated_after]

string

filter[last_activity_before]

string

filter[last_activity_after]

string

filter[trashed]

string

Can be a value of with (response will contain deleted items as well), only (will contain only deleted items), or any arbitrary value (will contain only not deleted items).

sort

enum<string>[]

Available options:

id,

-id,

provider_id,

-provider_id,

name,

-name,

handle,

-handle,

email,

-email,

ui_mode,

-ui_mode,

ui_color,

-ui_color,

created_at,

-created_at,

updated_at,

-updated_at,

last_authenticated_at,

-last_authenticated_at,

last_activity_at,

-last_activity_at,

deleted_at,

-deleted_at,

state,

-state,

-id,

--id,

-provider_id,

--provider_id,

-name,

--name,

-handle,

--handle,

-email,

--email,

-ui_mode,

--ui_mode,

-ui_color,

--ui_color,

-created_at,

--created_at,

-updated_at,

--updated_at,

-last_authenticated_at,

--last_authenticated_at,

-last_activity_at,

--last_activity_at,

-deleted_at,

--deleted_at,

-state,

--state

include

enum<string>[]

Available options:

devices,

devices-count,

devices-exists,

roles,

roles-count,

roles-exists

filter

string

page

string

Response

The collection of WorkspaceUserDetailedResponseData

string

required

Example:

"wsusr_01hq8xyzabc123def456ghi789"

state

enum<string>

required


`staged` The record is staged and is only visible to administrators or in the API. Use the `activate` method during your change window.
`active` The record is active.
`expiring` The `expires_at` value is set in the future for the record. You can run the `activate` action to remove the scheduled expiration.
`expired` The `expires_at` value is in the past and the record was deactivated.
`deactivated` The record was deactivated manually by an administrator.

Available options:

staged,

active,

expiring,

expired,

deactivated

provider

enum<string>

required


`google` Google Account (not Workspace specific)
`federation` Provisionr Federation
`okta` Okta Workforce Identity

Available options:

google,

federation,

okta

provider_id

string | null

required

The ID of the user from the IdP SSO Response

name

string

required

The first and last name of the user from the IdP SSO Response

handle

string

required

The username of the user. Unless overridden, this is usually the email address handle

string

required

The email address of the user

ui_mode

string | null

required

Provisionr has UI color accessibility features that allows each user to choose light or dark mode

ui_color

string | null

required

Provisionr has UI color accessibility features that allows each user to choose any color theme that they prefer and light or dark mode for the application UI. The sign in page and the default color theme for users is usually based on your company branding or logo color.

You can see all of the colors in the Tailwind CSS docs: https://tailwindcss.com/docs/colors

timestamp

object

required

The timestamps for the workspace user record

Show child attributes

Example:

{
  "created_at": "2024-03-15T10:30:00.000000Z",
  "updated_at": "2024-03-15T14:22:00.000000Z",
  "expires_at": null,
  "last_authenticated_at": "2024-03-16T08:00:00.000000Z",
  "last_activity_at": "2024-03-16T09:30:00.000000Z",
  "deleted_at": null
}

count

object

required

Count of related records

Show child attributes

included

string[]

required

Minimum array length: 1

links

object

required

API hyperlinks related to the workspace user record

Show child attributes

Getting Started

Endpoints

List of Authenticated Users

Authorizations

Query Parameters

Response