Skip to main content
GET
/
resource-user-access-status
/
{resource_id}
/
{user_id}
cURL
curl --request GET \
  --url https://api.opal.dev/v1/resource-user-access-status/{resource_id}/{user_id} \
  --header 'Authorization: Bearer <token>'
{
  "user_id": "29827fb8-f2dd-4e80-9576-28e31e9934ac",
  "resource_id": "1b978423-db0a-4037-a4cf-f79c60cb67b3",
  "expiration_date": "2022-01-23T04:56:07.000Z",
  "status": "AUTHORIZED"
}

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

​
access_level_remote_id
string

The remote ID of the access level that you wish to query for the resource. If omitted, the default access level remote ID value (empty string) is used.

​
cursor
string

The pagination cursor value.

​
page_size
integer

Number of results to return per page. Default is 200.

Required range: x <= 1000

Response

200 - application/json

The access status reflecting the user's access to the resource.

AccessStatus Object

Description

The AccessStatus object is used to represent the user's access to the resource.

Usage Example

View the AccessStatus for a resource/user pair to determine if the user has access to the resource.

​
resource_id
string<uuid>
required

The ID of the resource.

Example:

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

​
user_id
string<uuid>
required

The ID of the user.

Example:

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

​
status
enum<string>
required

The status of the user's access to the resource.

Available options:
AUTHORIZED,
REQUESTED,
UNAUTHORIZED
Example:

"AUTHORIZED"

​
access_level
object

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.

Example:
{
  "access_level_name": "AdminRole",
  "access_level_remote_id": "arn:aws:iam::590304332660:role/AdministratorAccess"
}
​
expiration_date
string<date-time> | null

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

Example:

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