A group (also known as an IAM group) is a grouping of usersOpen in new context and/or applicationsOpen in new context. Creating groups allows you to attach policiesOpen in new context to multiple users and/or applications at the same time.
List groups
List groups. By default, the groups listed are ordered by creation date in ascending order. This can be modified via the order_by field. You can define additional parameters to filter your query. Use user_ids or application_ids to list all groups certain users or applications belong to.
query Parameters
order_bySort order of groups.
pageRequested page number. Value must be greater or equal to 1.
page_sizeNumber of items per page. Value must be between 1 and 100.
organization_idFilter by Organization ID.
nameName of group to find.
application_idsFilter by a list of application IDs.
user_idsFilter by a list of user IDs.
group_idsFilter by a list of group IDs.
tagFilter by tags containing a given string.
List groups › Responses
List of groups.
total_countTotal count of groups.
Create a group
Create a new group. You must define the name and organization_id parameters in the request.
Create a group › Request Body
organization_idID of Organization linked to the group.
nameName of the group to create (max length is 64 chars). MUST be unique inside an Organization.
descriptionDescription of the group to create (max length is 200 chars).
tagsTags associated with the group (maximum of 10 tags).
Create a group › Responses
idID of the group.
created_atDate and time of group creation. (RFC 3339 format)
updated_atDate and time of last group update. (RFC 3339 format)
organization_idID of Organization linked to the group.
nameName of the group.
descriptionDescription of the group.
user_idsIDs of users attached to this group.
application_idsIDs of applications attached to this group.
tagsTags associated to the group.
editableDefines whether or not the group is editable.
deletableDefines whether or not the group is deletable.
managedDefines whether or not the group is managed.
Get a group
Retrieve information about a given group, specified by the group_id parameter. The group's full details, including user_ids and application_ids are returned in the response.
path Parameters
group_idID of the group.
Get a group › Responses
idID of the group.
created_atDate and time of group creation. (RFC 3339 format)
updated_atDate and time of last group update. (RFC 3339 format)
organization_idID of Organization linked to the group.
nameName of the group.
descriptionDescription of the group.
user_idsIDs of users attached to this group.
application_idsIDs of applications attached to this group.
tagsTags associated to the group.
editableDefines whether or not the group is editable.
deletableDefines whether or not the group is deletable.
managedDefines whether or not the group is managed.
Update a group
Update the parameters of group, including name and description.
path Parameters
group_idID of the group to update.
Update a group › Request Body
nameNew name for the group (max length is 64 chars). MUST be unique inside an Organization.
descriptionNew description for the group (max length is 200 chars).
tagsNew tags for the group (maximum of 10 tags).
Update a group › Responses
idID of the group.
created_atDate and time of group creation. (RFC 3339 format)
updated_atDate and time of last group update. (RFC 3339 format)
organization_idID of Organization linked to the group.
nameName of the group.
descriptionDescription of the group.
user_idsIDs of users attached to this group.
application_idsIDs of applications attached to this group.
tagsTags associated to the group.
editableDefines whether or not the group is editable.
deletableDefines whether or not the group is deletable.
managedDefines whether or not the group is managed.
Add a user or an application to a group
Add a user or an application to a group. You can specify a user_id and application_id in the body of your request. Note that you can only add one of each per request.
path Parameters
group_idID of the group.
Add a user or an application to a group › Request Body
user_idID of the user to add.
application_idID of the application to add.
Add a user or an application to a group › Responses
idID of the group.
created_atDate and time of group creation. (RFC 3339 format)
updated_atDate and time of last group update. (RFC 3339 format)
organization_idID of Organization linked to the group.
nameName of the group.
descriptionDescription of the group.
user_idsIDs of users attached to this group.
application_idsIDs of applications attached to this group.
tagsTags associated to the group.
editableDefines whether or not the group is editable.
deletableDefines whether or not the group is deletable.
managedDefines whether or not the group is managed.
Add multiple users and applications to a group
Add multiple users and applications to a group in a single call. You can specify an array of user_ids and application_ids. Note that any existing users and applications in the group will remain. To add new users/applications and delete pre-existing ones, use the Overwrite users and applications of a group method.
path Parameters
group_idID of the group.
Add multiple users and applications to a group › Request Body
user_idsIDs of the users to add.
application_idsIDs of the applications to add.
Add multiple users and applications to a group › Responses
idID of the group.
created_atDate and time of group creation. (RFC 3339 format)
updated_atDate and time of last group update. (RFC 3339 format)
organization_idID of Organization linked to the group.
nameName of the group.
descriptionDescription of the group.
user_idsIDs of users attached to this group.
application_idsIDs of applications attached to this group.
tagsTags associated to the group.
editableDefines whether or not the group is editable.
deletableDefines whether or not the group is deletable.
managedDefines whether or not the group is managed.
Overwrite users and applications of a group
Overwrite users and applications configuration in a group. Any information that you add using this command will overwrite the previous configuration.
path Parameters
group_idOverwrite users and applications of a group › Request Body
user_idsapplication_idsOverwrite users and applications of a group › Responses
idID of the group.
created_atDate and time of group creation. (RFC 3339 format)
updated_atDate and time of last group update. (RFC 3339 format)
organization_idID of Organization linked to the group.
nameName of the group.
descriptionDescription of the group.
user_idsIDs of users attached to this group.
application_idsIDs of applications attached to this group.
tagsTags associated to the group.
editableDefines whether or not the group is editable.
deletableDefines whether or not the group is deletable.
managedDefines whether or not the group is managed.
Remove a user or an application from a group
Remove a user or an application from a group. You can specify a user_id and application_id in the body of your request. Note that you can only remove one of each per request. Removing a user from a group means that any permissions given to them via the group (i.e. from an attached policy) will no longer apply. Be sure you want to remove these permissions from the user before proceeding.
path Parameters
group_idID of the group.
Remove a user or an application from a group › Request Body
user_idID of the user to remove.
application_idID of the application to remove.
Remove a user or an application from a group › Responses
idID of the group.
created_atDate and time of group creation. (RFC 3339 format)
updated_atDate and time of last group update. (RFC 3339 format)
organization_idID of Organization linked to the group.
nameName of the group.
descriptionDescription of the group.
user_idsIDs of users attached to this group.
application_idsIDs of applications attached to this group.
tagsTags associated to the group.
editableDefines whether or not the group is editable.
deletableDefines whether or not the group is deletable.
managedDefines whether or not the group is managed.