Sign in

v5

latestOpenAPI 3.1.02026-07-31151195455.5 KB
groups

Adds a user to this group.

post/groups/{group_id}/users/{user_id}

Path parameters

group_idstring uuid required

The ID of the group.

user_idstring uuid required

The ID of the user to add.

Query parameters

duration_minutesinteger

The duration for which the group can be accessed (in minutes). Use 0 to set to indefinite.

access_level_remote_idstring

The remote ID of the access level to grant to this user. If omitted, the default access level remote ID value (empty string) is used.

Request body

duration_minutesinteger required

The duration for which the group can be accessed (in minutes). Use 0 to set to indefinite.

access_level_remote_idstring

The remote ID of the access level to grant to this user. If omitted, the default access level remote ID value (empty string) is used.

Example request

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

Response

The GroupUser that was created.

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"
}