OPopal
resources

GET /resource-user-access-status/{resource_id}/{user_id}

Get user's access status to a resource.

Request

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

Path parameters

resource_idstring uuid required

The ID of the resource.

user_idstring uuid required

The ID of the user.

Query parameters

access_level_remote_idstring

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.

cursorstring

The pagination cursor value.

page_sizeinteger

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

Response

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

resource_idstring uuid required

The ID of the resource.

user_idstring uuid required

The ID of the user.

status'AUTHORIZED' | 'REQUESTED' | 'UNAUTHORIZED' required

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

expiration_datestring date-time nullable

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

Example response

{
  "user_id": "29827fb8-f2dd-4e80-9576-28e31e9934ac",
  "resource_id": "1b978423-db0a-4037-a4cf-f79c60cb67b3",
  "expiration_date": "2022-01-23T04:56:07Z",
  "status": "AUTHORIZED"
}

Changes

No recorded changes to this operation across all 43 revisions of this API.