OPopal
groups

PUT /groups/{group_id}/users/{user_id}

Changed on

Updates a user's access level or duration in this group.

Request

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

Path parameters

group_idstring uuid required

The ID of the group.

user_idstring uuid required

The ID of the user whose access is being updated.

Request body

duration_minutesinteger required

The updated duration for which the group can be accessed (in minutes). Use 0 for indefinite, or a negative value to revoke access.

access_level_remote_idstring

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

Example request

{
  "duration_minutes": 60,
  "access_level_remote_id": "arn:aws:iam::590304332660:role/AdministratorAccess"
}

Response

The GroupUser was successfully updated.

group_idstring uuid required

The ID of the group.

group_namestring required

The name of the group.

descriptionstring required

The description of the group.

user_idstring uuid required

The ID of the user.

full_namestring required

The user's full name.

emailstring required

The user's email.

expiration_datestring date-time nullable

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

Example response

{
  "full_name": "Jake Barnes",
  "user_id": "29827fb8-f2dd-4e80-9576-28e31e9934ac",
  "group_id": "1b978423-db0a-4037-a4cf-f79c60cb67b3",
  "expiration_date": "2022-01-23T04:56:07Z",
  "email": "jake@company.dev"
}

Changes

  • 1f15df5de3bcRevision changes
    • warning

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

  • c7469ef15aa4Revision changes
    • info

      the request property's max was increased from 525960.00 to 153722867.00