OPopal
resources

Get resource users

Changed on

Gets the list of users for this resource.

get/resources/{resource_id}/users

Request

  • Base URL
    https://api.opal.dev/v1
  • Auth
    HTTP bearer

Path parameters

resource_idstring uuid required

The ID of the resource.

Query parameters

limitinteger

Limit the number of results returned.

Response

List of users with access to this resource.

nextstring nullable

The cursor with which to continue pagination if additional result pages exist.

previousstring nullable

The cursor used to obtain the current result page.

Example response

{
  "results": [
    {
      "full_name": "Jake Barnes",
      "user_id": "29827fb8-f2dd-4e80-9576-28e31e9934ac",
      "resource_id": "1b978423-db0a-4037-a4cf-f79c60cb67b3",
      "expiration_date": "2022-01-23T04:56:07Z",
      "email": "jake@company.dev",
      "has_direct_access": true,
      "num_access_paths": 2
    },
    {
      "full_name": "Brett Ashley",
      "user_id": "7646aa9a-e2ee-4eb5-8c62-91f29038a373",
      "resource_id": "1b978423-db0a-4037-a4cf-f79c60cb67b3",
      "expiration_date": "2022-02-03T12:33:02Z",
      "email": "brett@company.dev",
      "has_direct_access": true,
      "num_access_paths": 3
    }
  ]
}

Changes

  • 1f15df5de3bcRevision changes
    • warning

      added the new ERR_CONNECTION_VALIDATION_FAILED enum value to the /// response property for the response status

  • 327ea741c867Revision changes
    • warning

      added the new ERR_REMOTE_TICKET_NOT_FOUND enum value to the /// response property for the response status