List of Dimensions

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

import requests

url = "https://wksusa1b2c3d.provisionr.app/api/v1/directory/dimensions"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

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

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

[
  {
    "id": "drdim_01hq8xyzabc123def456ghi789",
    "state": "staged",
    "integration_id": "gitg_01hq8xyzabc123def456ghi789",
    "integration_type": "App\\Models\\GoogleIntegration",
    "profile_key": "department",
    "name": "Department",
    "handle": "dept",
    "attributes_enabled": true,
    "conditions_enabled": true,
    "expires_after_days": 30,
    "metadata": {},
    "timestamp": {
      "created_at": "2025-01-28T13:37:00Z",
      "updated_at": "2025-05-04T03:27:00Z",
      "activated_at": "2025-03-14T15:07:00Z",
      "expires_at": null,
      "deleted_at": null
    },
    "count": [
      "<string>"
    ],
    "included": {
      "directory_attributes": [
        {
          "id": "dratr_01hq8xyzabc123def456ghi789",
          "state": "active",
          "type": "integration",
          "parent": "Department",
          "name": "Engineering",
          "handle": "eng",
          "blueprint_signature": "{blueprint_id_last4}-{dimension_id}-{attribute_id}-{ref_id}",
          "profile_value": "Engineering"
        }
      ],
      "integration": {
        "id": "gitg_01hq8xyzabc123def456ghi789",
        "vendor": "google",
        "is_primary": true
      }
    },
    "links": {
      "self": "<string>",
      "directory_attributes": "<string>",
      "integration": "<string>"
    }
  }
]

{
  "message": "<string>"
}

{
  "message": "<string>"
}

GET

Authorizations

Authorization

string

header

required

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

Query Parameters

include

enum<string>[]

Available options:

attributes,

attributes-count,

attributes-exists,

integration,

integration-count,

integration-exists

filter

string

page

string

sort

string

filter[id_search]

string

Filter by a partial match of the dimension ID

filter[integration_id]

string

Filter by an exact match of the integration ID

filter[integration_type]

string

Filter by an exact match of the integration type (polymorphic morph class)

filter[profile_key]

string

Filter by an exact match of the profile key field

filter[profile_key_search]

string

Filter by a partial match of the profile key field

filter[name]

string

Filter by an exact match of the name field

filter[name_search]

string

Filter by a partial match of the name field

filter[handle]

string

Filter by an exact match of the handle field

filter[handle_search]

string

Filter by a partial match of the handle field

filter[attributes_enabled]

string

Filter by an exact match of the attributes_enabled field

filter[conditions_enabled]

string

Filter by an exact match of the conditions_enabled field

filter[expires_after_days]

string

Filter by an exact match of the expires_after_days field

filter[state]

string

Filter by an exact match of the state field

filter[metadata_search]

string

Filter by searching custom metadata key/value pairs for any partial string match

filter[created_before]

string

Filter by created before date

filter[created_after]

string

Filter by created after date

filter[updated_before]

string

Filter by updated before date

filter[updated_after]

string

Filter by updated after date

filter[expires_before]

string

Filter by expires before date

filter[expires_after]

string

Filter by expires after date

filter[deleted_before]

string

Filter by deleted before date

filter[deleted_after]

string

Filter by deleted after date

filter[integration]

string

Filter by whether the dimension has a workspace integration (true = has integration, false = no integration)

filter[trashed]

string

Include trashed records (with, only, without)

Response

The collection of DirectoryDimensionDetailedResponseData

string

required

Example:

"drdim_01hq8xyzabc123def456ghi789"

state

enum<string>

required

The state of the directory dimension


`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

integration_id

string | null

required

The ID of the integration this dimension was sourced from (polymorphic).

Use this together with integration_type when creating an identity-type Policy Condition

Example:

"gitg_01hq8xyzabc123def456ghi789"

integration_type

string | null

required

The type of the integration this dimension was sourced from (polymorphic).

This is the value expected by integration_type when creating an identity-type Policy Condition

Example:

"App\\Models\\GoogleIntegration"

profile_key

string | null

required

The name of the key from the Workspace Integration that is in the Identity metadata array to get values from

Example:

"department"

name

string

required

The display name of the dimension. Any dimensions that are imported from the Integration are formatted with Headline/Title case

Example:

"Department"

handle

string

required

The alpha dash, lowercase abbreviated name of the dimension that is safe to use in email handles and URL paths

Example:

"dept"

attributes_enabled

boolean

required

If enabled, a Directory Attribute record is automatically created for each Dimension Attribute value from the unique Identity metadata profile_key values

conditions_enabled

boolean

required

If disabled, Attributes in this Dimension will not appear in the list of available options when creating a Rule Condition.

This is used when you want to have metadata about users but do not want future maintenance burden with rulesets using this data

expires_after_days

integer | null

required

Users will be automatically deprecated if they no longer qualify for at least one rule in the ruleset.

The expires_after_days value determines how many days after they no longer qualify that they still have access for a graceful transition period when users change job roles.

The value is inherited from the Workspace > Dimension > Attribute/Resource > Rule and can be overridden at any level to provide shorter revoke time controls when needed.

If the value is 0, this skips the grace period and revokes access immediately after expires_at.

By default, users have perpetual access (as Policy Users) as long as their attributes continue to match the conditions for the rule. If the rule is designed for just-in-time or short term access, you can set the expires_at date for all conditional users to be deprecated at that time.

You can use expires_at and expires_after_days=0 together to revoke access immediately.

Best Practice: You should the "low risk" sensible default (ex. 30 days) at the Dimension level and set more strict values at the Attribute/Resource levels where an exception needs to be granted.

A null value means no override is set at this level, so the grace period is inherited from the parent level

Example:

30

metadata

object

required

The dimension's custom key/value metadata added by someone or automation in your organization

Show child attributes

timestamp

TimestampStateData · object

required

The timestamps for the directory dimension record

Show child attributes

count

string[]

required

Counts of related resources.

directory_attributes: int|null audit_logs_parent: int|null, audit_logs_record: int|null, audit_logs_related: int|null, }

Minimum array length: 1

included

object

required

Included related resources

Show child attributes

links

object

required

API hyperlinks related to the directory dimension record

Show child attributes

Getting Started

Endpoints

List of Dimensions

Authorizations

Query Parameters

Response