# Access Management API

Version: v3

## Servers

Sandbox URL
```
https://api-ext-sboxmeta.partners.spotnana.com
```

## Security

### Bearer

Type: http
Scheme: bearer

## Download OpenAPI description

[Access Management API](https://developer.spotnana.com/_bundle/openapi/RbacApi.yaml)

## User Groups

APIs to manage use groups.

### List user groups for company

 - [POST /v3/companies/{companyId}/user-groups/list](https://developer.spotnana.com/openapi/rbacapi/user-groups/listusergroupsforcompany.md): This endpoint provides list of user groups of a company, with filtering, sorting, and pagination support.

### Create user group

 - [POST /v3/companies/{companyId}/user-groups](https://developer.spotnana.com/openapi/rbacapi/user-groups/createusergroup.md): This endpoint is used to create user groups.

### Read user group

 - [GET /v3/companies/{companyId}/user-groups/{groupId}](https://developer.spotnana.com/openapi/rbacapi/user-groups/getusergroup.md): This endpoint returns user group information for given group ID.

### Delete user group

 - [DELETE /v3/companies/{companyId}/user-groups/{groupId}](https://developer.spotnana.com/openapi/rbacapi/user-groups/deleteusergroup.md): This endpoint deletes a user group by ID.

### Update user group

 - [PUT /v3/companies/{companyId}/user-groups/{groupId}](https://developer.spotnana.com/openapi/rbacapi/user-groups/updateusergroup.md)

### List user group members

 - [POST /v3/companies/{companyId}/user-groups/{groupId}/members](https://developer.spotnana.com/openapi/rbacapi/user-groups/listusergroupmembers.md): This endpoint provides a list of members in a user group with filtering, sorting, and pagination support.

### Update user group members

 - [PATCH /v3/companies/{companyId}/user-groups/{groupId}/members](https://developer.spotnana.com/openapi/rbacapi/user-groups/updateusergroupmembers.md): This endpoint updates the members of a user group.

### List user groups for user

 - [POST /v3/users/{userId}/user-groups](https://developer.spotnana.com/openapi/rbacapi/user-groups/listusergroupsforuser.md): This endpoint provides list of user groups of a user, with filtering, sorting, and pagination support.

## Roles

APIs to manage roles.

### List all permissions on the platform

 - [GET /v3/permissions](https://developer.spotnana.com/openapi/rbacapi/roles/listpermissions.md): This endpoint returns all available permissions on the platform for display purposes.

### List permissions for a company

 - [GET /v3/companies/{companyId}/permissions](https://developer.spotnana.com/openapi/rbacapi/roles/listcompanypermissions.md): This endpoint returns all available permissions for a company.

### List user roles for company

 - [POST /v3/companies/{companyId}/roles](https://developer.spotnana.com/openapi/rbacapi/roles/listrolesv3.md): This endpoint provides list of available user roles for a company.

### Create role

 - [POST /v3/roles](https://developer.spotnana.com/openapi/rbacapi/roles/createrolev3.md): This endpoint is used to create user roles.

### Get role

 - [GET /v3/roles/{roleId}](https://developer.spotnana.com/openapi/rbacapi/roles/getrolev3.md): This endpoint returns role details for given role ID.

### Delete role

 - [DELETE /v3/roles/{roleId}](https://developer.spotnana.com/openapi/rbacapi/roles/deleterolev3.md): This endpoint deletes a role by role ID.

### Update role

 - [PUT /v3/roles/{roleId}](https://developer.spotnana.com/openapi/rbacapi/roles/updaterolev3.md)

### Get applicable scopes for selected roles.

 - [POST /v3/companies/{companyId}/roles/applicable-scopes](https://developer.spotnana.com/openapi/rbacapi/roles/getapplicablescopes.md): Returns the applicable scope predicate types and their permitted values for the selected roles within a company.

### List user group roles

 - [POST /v3/companies/{companyId}/user-groups/{groupId}/roles](https://developer.spotnana.com/openapi/rbacapi/roles/listusergrouprolesv3.md): This endpoint provides list of roles assigned to the usergroup.

### Update user group roles

 - [PATCH /v3/companies/{companyId}/user-groups/{groupId}/roles](https://developer.spotnana.com/openapi/rbacapi/roles/updateusergrouprolesv3.md): This endpoint updates roles assigned to a usergroup.

### List user roles

 - [POST /v3/users/{userId}/roles](https://developer.spotnana.com/openapi/rbacapi/roles/listuserrolesv3.md): This endpoint provides list of roles assigned to the user.

### Update user roles

 - [PATCH /v3/users/{userId}/roles](https://developer.spotnana.com/openapi/rbacapi/roles/updateuserrolesv3.md): This endpoint updates roles assigned to a user.

### Get user permissions on specific entity.

 - [POST /v3/users/{userId}/entity-permissions](https://developer.spotnana.com/openapi/rbacapi/roles/getentitypermissions.md): Returns user's permissions with actions on a specified entity.

### Get RBAC info for a user

 - [GET /v3/users/{userId}/rbac-info](https://developer.spotnana.com/openapi/rbacapi/roles/getrbacinfo.md): Returns RBAC information for a user indicating what permissions the user has.