Get resource user

curl --request GET \
  --url https://api.opal.dev/v1/resources/{resource_id}/users/{user_id} \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "full_name": "Jake Barnes",
      "user_id": "29827fb8-f2dd-4e80-9576-28e31e9934ac",
      "resource_id": "1b978423-db0a-4037-a4cf-f79c60cb67b3",
      "expiration_date": "2022-01-23T04:56:07.000Z",
      "email": "[email protected]"
    }
  ],
  "cursor": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "total_count": 120
}

GET

resources

{resource_id}

users

{user_id}

Get resource user

curl --request GET \
  --url https://api.opal.dev/v1/resources/{resource_id}/users/{user_id} \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "full_name": "Jake Barnes",
      "user_id": "29827fb8-f2dd-4e80-9576-28e31e9934ac",
      "resource_id": "1b978423-db0a-4037-a4cf-f79c60cb67b3",
      "expiration_date": "2022-01-23T04:56:07.000Z",
      "email": "[email protected]"
    }
  ],
  "cursor": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "total_count": 120
}

Authorizations

Authorization

string

header

required

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

Path Parameters

resource_id

string<uuid>

required

The ID of the resource.

user_id

string<uuid>

required

The ID of the user.

Query Parameters

cursor

string

The pagination cursor value.

Response

List of ResourceUser records for the user's access to the resource.

data

object[]

required

Show child attributes

data.resource_id

string<uuid>

required

The ID of the resource.

Example:

"1b978423-db0a-4037-a4cf-f79c60cb67b3"

data.user_id

string<uuid>

required

The ID of the user.

Example:

"29827fb8-f2dd-4e80-9576-28e31e9934ac"

data.access_level

object

required

Access Level Object

Description

The AccessLevel object is used to represent the level of access that a principal has. The "default" access level is a AccessLevel object whose fields are all empty strings.

Usage Example

View the AccessLevel of a resource/user or resource/group pair to see the level of access granted to the resource.

Show child attributes

data.access_level.access_level_name

string

required

The human-readable name of the access level.

Example:

"AdminRole"

data.access_level.access_level_remote_id

string

required

The machine-readable identifier of the access level.

Example:

"arn:aws:iam::590304332660:role/AdministratorAccess"

Example:

{
  "access_level_name": "AdminRole",
  "access_level_remote_id": "arn:aws:iam::590304332660:role/AdministratorAccess"
}

data.full_name

string

required

The user's full name.

Example:

"Jake Barnes"

data.email

string

required

The user's email.

Example:

"[email protected]"

data.expiration_date

string<date-time> | null

The day and time the user's access will expire.

Example:

"2022-01-23T04:56:07.000Z"

cursor

string

Pagination cursor for the next page of results

Example:

"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"

total_count

integer

Total number of results

Example:

120

Delete resources non human identities Put resources users

⌘I

API Concepts

SDKs

Opal API

Get resource user

Authorizations

Path Parameters

Query Parameters

Response

Access Level Object

Description

Usage Example