Skip to main content
PUT
cURL

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 whose access is being updated.

Body

application/json
duration_minutes
integer
required

The updated duration for which the resource can be accessed (in minutes). Use 0 for indefinite.

Required range: x <= 153722867
Example:

120

access_level_remote_id
string

The updated remote ID of the access level granted to this user.

Example:

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

acting_user_id
string<uuid>

Record this Opal user as the actor of the access change in the audit event instead of the caller. Only for service users an admin has allowed to act for users, in organizations with the feature enabled. The named user must be a person (not a service user) in the caller's organization and active in the identity provider. Authorization is unchanged: the caller still needs permission to edit assignments on the resource. The named user's own permissions on the resource are not evaluated.

Response

The ResourceUser was successfully updated.

Resource User Object

Description

The ResourceUser object is used to represent a user with direct access to a 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"

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.

Example:
full_name
string
required

The user's full name.

Example:

"Jake Barnes"

email
string
required

The user's email.

Example:

"jake@company.dev"

expiration_date
string<date-time> | null

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

Example:

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