Security API

The Security API provides REST endpoints that you can use to manage your groups, users, memberships, roles, and permissions.

Note: For more information, you can view the API reference by using ReDoc. In ReDoc, you can expand the items in the left navigation pane and then scroll to find the commands that you want. You can copy each command to your development environment and customize it as needed. To view the API reference in ReDoc, enter the following URL in the browser address bar:

https://am1.bartendercloud.com/api/security_reference/redoc

The following Security APIs are available.

Group

The Group API includes commands that you can use to retrieve and perform actions on a group.

Action	Command	Description
Create a Group		Creates a group.
Update a Group		Updates a specific group.
Delete a Group		Deletes a specific group.
Get a Group		Gets a group.

Groups

Action	Command	Description
Get All Groups		Gets all groups.

Memberships

Action	Command	Description
Create a Group-to-Group Relationship		Creates a group-to-group relationship.
Delete a Group-to-Group Relationship		Removes a group-to-group relationship.
Get Users Within a Group		Gets users within a group.
Get Group-to-Group Records		Gets a collection of group-to-group records.
Create a User-to-Group Relationship		Creates a user-to-group relationship.
Delete a User-to-Group Relationship		Removes the user-to-group relationship for one or more users.
Get a User's Groups		Gets the groups in which a user is an implicit or explicit member.

Permission

Action	Command	Description
Check User Permissions		Checks permissions for the current user.
Get Permissions Descriptions		Gets descriptions for all of the security permissions.
Get a User's Permissions Information		Gets permissions information for the current user.

Roles

The Roles API includes commands that you can use to create, update, and delete roles and to get a role or a list of roles.

Action	Command	Description
Create a New Role		Creates a new role.
Update a Role		Updates an existing role.
Get a Role		Retrieves a specific role.
Delete a Role		Deletes a role.
Get a List of Roles		Gets a list of available roles.

User

Action	Command	Description
Get User Information		Gets information about a specific user.
Get a User's Advanced Properties		Gets advanced properties for a specific user.
Create a New User		Creates a new user.
Update a User		Updates the definition of a user.
Delete a User		Deletes a user.
Search for a User		Searches for a user that matches the specified criteria.
Get a User's 2FA Status		Gets the two-factor authentication status for a user.
Delete a User's 2FA Phone Number		Deletes the phone number that was configured for two-factor authentication for a user.
Get Information About 2FA Support		Gets information about whether the backing identity provider supports two-factor authentication.

Users

The Users API includes a command that you can use to get a range of user information.

Action	Command	Description
Get All User Information		Gets a range of user information.
Search for Users		Searches for one or more users that match the specified criteria.