List of Attributes

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

import requests

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

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/attributes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

[
  {
    "id": "dratr_01hq8xyzabc123def456ghi789",
    "state": "active",
    "type": "integration",
    "name": "Engineering",
    "handle": "eng",
    "blueprint_signature": "{blueprint_id_last4}-{dimension_id}-{attribute_id}-{ref_id}",
    "profile_value": "Engineering",
    "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": {
      "attribute_conditions": 123,
      "attribute_predecessors": 123,
      "policy_rules": 123,
      "manifest_users": 123,
      "qualified_users": 123,
      "staged_users": 123,
      "audit_logs_parent": 123,
      "audit_logs_record": 123,
      "audit_logs_related": 123
    },
    "included": [
      "<string>"
    ],
    "links": {
      "self": "<string>",
      "attribute_conditions": "<string>",
      "directory_dimension": "<string>",
      "integration": "<string>",
      "policy_ruleset": "<string>",
      "policy_rules": "<string>",
      "manifest_users": "<string>",
      "qualified_users": "<string>",
      "staged_users": "<string>"
    }
  }
]

{
  "message": "<string>"
}

{
  "message": "<string>"
}

GET

directory

attributes

List of Attributes

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

import requests

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

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/attributes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

[
  {
    "id": "dratr_01hq8xyzabc123def456ghi789",
    "state": "active",
    "type": "integration",
    "name": "Engineering",
    "handle": "eng",
    "blueprint_signature": "{blueprint_id_last4}-{dimension_id}-{attribute_id}-{ref_id}",
    "profile_value": "Engineering",
    "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": {
      "attribute_conditions": 123,
      "attribute_predecessors": 123,
      "policy_rules": 123,
      "manifest_users": 123,
      "qualified_users": 123,
      "staged_users": 123,
      "audit_logs_parent": 123,
      "audit_logs_record": 123,
      "audit_logs_related": 123
    },
    "included": [
      "<string>"
    ],
    "links": {
      "self": "<string>",
      "attribute_conditions": "<string>",
      "directory_dimension": "<string>",
      "integration": "<string>",
      "policy_ruleset": "<string>",
      "policy_rules": "<string>",
      "manifest_users": "<string>",
      "qualified_users": "<string>",
      "staged_users": "<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[directory_attribute_id_successor]

string

filter[type]

string

filter[metadata_search]

string

Search custom organization business logic metadata key/value pairs for any partial 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[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).

include

enum<string>[]

Available options:

attribute-conditions-count,

attribute-predecessors-count,

manifest-users-count,

qualified-users-count,

staged-users-count,

policy-rules-count,

attribute-predecessors,

attribute-predecessors-count,

attribute-predecessors-exists,

policy-rules,

policy-rules-count,

policy-rules-exists

filter

string

page

string

sort

string

filter[id_search]

string

Filter by a partial match of the attribute 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[directory_dimension_id]

string

Filter by an exact match of the directory dimension ID

filter[profile_value]

string

Filter by an exact match of the profile key field value

filter[profile_value_search]

string

Filter by a partial match of the profile key field value

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[blueprint_signature]

string

Filter by an exact match of the blueprint signature field

filter[blueprint_signature_search]

string

Filter by a partial match of the blueprint signature field

filter[conditions_enabled]

string

Filter by whether this attribute can be used for conditions

filter[state]

string

Filter by an exact match of the state field

Response

string

required

Example:

"dratr_01hq8xyzabc123def456ghi789"

state

enum<string>

required

The state of the directory attribute


`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

Example:

"active"

type

enum<string>

required

The type of the directory attribute


`integration` The attribute was imported by the Workspace Integration when `attributes_enabled` is enabled for a Directory Dimension
`ruleset` The custom attribute was created by an administrator to define a reusable set of rules and conditions
`catch` The attribute is designed as a catch all for a dimension for users that don't meet the criteria (ex. Unknown)

Available options:

integration,

ruleset,

catch

Example:

"integration"

name

string | null

required

The name of the attribute

Example:

"Engineering"

handle

string | null

required

The handle of the attribute

Example:

"eng"

blueprint_signature

string | null

required

If this Attribute is generated from a Blueprint, this is the signature of the blueprint when it is created. This allows tracking of which attributes were created from which blueprint version, while allowing the handle and name to be renamed to a more descriptive name based on business needs

Examples:

"{blueprint_id_last4}-{dimension_id}-{attribute_id}-{ref_id}"

"bbbb-dddd-aaaa-rrrr"

profile_value

string | null

required

The raw value of the attribute from the Vendor API

Example:

"Engineering"

timestamp

TimestampStateData · object

required

The timestamps for the attribute record

Show child attributes

count

object

required

Counts of related resources

Show child attributes

included

string[]

required

Included related resources.

attribute_successor: DirectoryAttributeSummaryResponseData|null, attribute_predecessors: array|null integration: IntegrationSummaryResponseData|null, directory_dimension: DirectoryDimensionSummaryResponseData|null, policy_ruleset: PolicyRulesetSummaryResponseData|null, policy_rules: array|null, }

Minimum array length: 1

links

object

required

API hyperlinks related to the attribute record

Show child attributes

Getting Started

Endpoints

List of Attributes

Authorizations

Query Parameters

Response