# Access management API

> Users, teams, role groups, auth tokens (API keys) and authentication settings.

Source: https://developer.kustomer.com/api/access-management

Server: `https://api.kustomerapp.com/v1` · 33 operations

This category describes endpoints related to managing user access, roles, teams, permissions, and authentication in Kustomer.

To learn more, see [Manage User Access](https://help.kustomer.com/categories/managing-user-access-Sy2VJIxmU) and [Authenticating Users](https://help.kustomer.com/categories/authenticating-users-S15_8jB48) in the Kustomer Help Center.

## Auth Settings

Auth settings control how people sign in to your Kustomer org (with a Kustomer password, Google or SAML single sign-on) and how long their sessions last. A related endpoint returns the secret your server uses to verify chat customers' identity.

- [Get Auth Settings](https://developer.kustomer.com/api/access-management/get-auth-settings.md): `GET /v1/auth/settings`
- [Update Auth Settings](https://developer.kustomer.com/api/access-management/update-auth-settings.md): `PUT /v1/auth/settings`
- [Get Auth Customer Settings](https://developer.kustomer.com/api/access-management/get-auth-customer-settings.md): `GET /v1/auth/customer/settings`
- [Get Public Auth Settings](https://developer.kustomer.com/api/access-management/get-public-auth-settings.md): `GET /v1/p/auth/settings`

## Auth Tokens

An auth token is the bearer credential sent with every API request. API keys are long-lived tokens that belong to a machine user with a fixed set of roles; session tokens are created when a person signs in. These endpoints list, inspect and revoke tokens.

- [Get Auth Tokens](https://developer.kustomer.com/api/access-management/get-auth-tokens.md): `GET /v1/auth/tokens`
- [Create Token](https://developer.kustomer.com/api/access-management/create-token.md): `POST /v1/auth/tokens`
- [Get Auth Token by ID](https://developer.kustomer.com/api/access-management/get-auth-token-by-id.md): `GET /v1/auth/tokens/{id}`
- [Delete Auth Token by ID](https://developer.kustomer.com/api/access-management/delete-auth-token-by-id.md): `DELETE /v1/auth/tokens/{id}`
- [Get Current Auth Token](https://developer.kustomer.com/api/access-management/get-current-auth-token.md): `GET /v1/auth/tokens/current`
- [Delete Current Auth Token](https://developer.kustomer.com/api/access-management/delete-current-auth-token.md): `DELETE /v1/auth/tokens/current`

## Role Groups

A role group, called a permission set in the Kustomer app, is a named bundle of roles that decides what its members can see and do. Kustomer provides built-in role groups such as Administrator, and admins can create custom ones and assign them to users and teams.

- [Get Auth Roles](https://developer.kustomer.com/api/access-management/get-auth-roles.md): `GET /v1/auth/roles`
- [Get All Role Groups](https://developer.kustomer.com/api/access-management/get-all-role-groups.md): `GET /v1/role-groups`
- [Create a Role Group](https://developer.kustomer.com/api/access-management/create-a-role-group.md): `POST /v1/role-groups`
- [Get A Role Group By ID](https://developer.kustomer.com/api/access-management/get-a-role-group-by-id.md): `GET /v1/role-groups/{id}`
- [Update a Role Group](https://developer.kustomer.com/api/access-management/update-a-role-group.md): `PUT /v1/role-groups/{id}`
- [Delete a Role Group](https://developer.kustomer.com/api/access-management/delete-a-role-group.md): `DELETE /v1/role-groups/{id}`

## Teams

A team is a named group of users, such as "Billing" or "Tier 2". Conversations can be assigned to a team, routing uses teams to decide which queues and capacity rules apply to an agent, and teams can carry role groups that grant their members permissions.

- [Get Teams](https://developer.kustomer.com/api/access-management/get-teams.md): `GET /v1/teams`
- [Create Team](https://developer.kustomer.com/api/access-management/create-team.md): `POST /v1/teams`
- [Get a User's Teams](https://developer.kustomer.com/api/access-management/get-a-users-teams.md): `GET /v1/users/{id}/teams`
- [Add Team Member](https://developer.kustomer.com/api/access-management/add-team-member.md): `POST /v1/teams/{id}/members`
- [Remove Team Member](https://developer.kustomer.com/api/access-management/remove-team-member.md): `DELETE /v1/teams/{id}/members`

## Teams (By ID)

A team is a named group of users, such as "Billing" or "Tier 2". Conversations can be assigned to a team, routing uses teams to decide which queues and capacity rules apply to an agent, and teams can carry role groups that grant their members permissions.

- [Get Team by ID](https://developer.kustomer.com/api/access-management/get-team-by-id.md): `GET /v1/teams/{id}`
- [Update Team by ID](https://developer.kustomer.com/api/access-management/update-team-by-id.md): `PUT /v1/teams/{id}`
- [Update Team Attributes](https://developer.kustomer.com/api/access-management/update-team-attributes.md): `PATCH /v1/teams/{id}`
- [Delete Team](https://developer.kustomer.com/api/access-management/delete-team.md): `DELETE /v1/teams/{id}`

## Users

A user is an account that works in your Kustomer org, such as an agent, an admin or a collaborator, or the machine user behind an API key. Users are the people and integrations doing the support work, as opposed to customers, who receive it.

- [Get Users](https://developer.kustomer.com/api/access-management/get-users.md): `GET /v1/users`
- [Create / Invite New User](https://developer.kustomer.com/api/access-management/create-invite-new-user.md): `POST /v1/users`
- [Get Current User](https://developer.kustomer.com/api/access-management/get-current-user.md): `GET /v1/users/current`
- [Update Current User](https://developer.kustomer.com/api/access-management/update-current-user.md): `PUT /v1/users/current`
- [Reset User's Password](https://developer.kustomer.com/api/access-management/reset-users-password.md): `POST /v1/users/passwordreset`

## Users (By ID)

A user is an account that works in your Kustomer org, such as an agent, an admin or a collaborator, or the machine user behind an API key. Users are the people and integrations doing the support work, as opposed to customers, who receive it.

- [Get User by ID](https://developer.kustomer.com/api/access-management/get-user-by-id.md): `GET /v1/users/{id}`
- [Update User by ID](https://developer.kustomer.com/api/access-management/update-user-by-id.md): `PUT /v1/users/{id}`
- [Get Multiple Users by IDs](https://developer.kustomer.com/api/access-management/get-multiple-users-by-ids.md): `GET /v1/users/{ids}`