# Wazo Users API

**Canonical:** https://apis.io/apis/wazo/wazo-users-api/  
**Provider:** Wazo — https://apis.io/providers/wazo/  
**Base URL:** https://{wazo_stack}/api/auth/0.1  
**Documentation:** https://api.wazo.io/documentation/api/authentication.html

Wazo Users API is one of 113 APIs that [Wazo](https://apis.io/providers/wazo/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification. Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, a changelog, authentication docs, and an AsyncAPI specification.

The users API from Wazo — 104 operation(s) for users.

## Operations (60 of 155)

| Method | Path | Summary |
|---|---|---|
| GET | `/users/me/agents` | Get agent status of the user holding the authentication token. |
| POST | `/users/me/agents/login` | Log the agent of the user holding the authentication token |
| POST | `/users/me/agents/logoff` | Logoff the agent of the user holding the authentication token |
| POST | `/users/me/agents/pause` | Pause the agent of the user holding the authentication token |
| POST | `/users/me/agents/unpause` | Unpause the agent of the user holding the authentication token |
| PUT | `/users/me/agents/queues/{queue_id}/login` | Login user agent to queue |
| PUT | `/users/me/agents/queues/{queue_id}/logoff` | Logoff user agent from queue |
| GET | `/users/{user_uuid}/external/google` | Get a Google token |
| POST | `/users/{user_uuid}/external/google` | Ask for a verification URL and store code to get token |
| DELETE | `/users/{user_uuid}/external/google` | Delete a Google token |
| GET | `/users/{user_uuid}/external/microsoft` | Get a Microsoft token |
| POST | `/users/{user_uuid}/external/microsoft` | Ask for a verification URL and store code to get token |
| DELETE | `/users/{user_uuid}/external/microsoft` | Delete a Microsoft token |
| GET | `/users/{user_uuid}/external/mobile` | Get device tokens for push notifications |
| POST | `/users/{user_uuid}/external/mobile` | Configure device tokens for push notifications |
| PUT | `/users/{user_uuid}/external/mobile` | Update device tokens for push notifications |
| DELETE | `/users/{user_uuid}/external/mobile` | Delete device tokens for push notifications |
| GET | `/users/{user_uuid}/external/mobile/sender_id` | Get your Mobile sender_id |
| GET | `/users/{user_uuid}/external` | Retrieves the list of the users external auth data |
| PUT | `/idp/{idp_type}/users/{user_uuid}` | Associate user to a IDP |
| DELETE | `/idp/{idp_type}/users/{user_uuid}` | Dissocuate a user from an IDP |
| GET | `/users/password/reset` | Reset the user password |
| POST | `/users/password/reset` | Set the user password |
| GET | `/users/{user_uuid_or_me}/tokens` | Retrieve a user's refresh token list |
| DELETE | `/users/{user_uuid_or_me}/tokens/{client_id}` | Delete a user's refresh token |
| PUT | `/admin/users/{user_uuid}/emails` | Update email addresses |
| PUT | `/users/{user_uuid}/emails` | Update email addresses |
| GET | `/users/{user_uuid}/emails/{email_uuid}/confirm` | Ask a new confirmation email |
| PUT | `/groups/{group_uuid}/users/{user_uuid}` | Associate a group to a user |
| DELETE | `/groups/{group_uuid}/users/{user_uuid}` | Dissociate a user from a group |
| GET | `/users/{user_uuid}/groups` | Retrieves the list of groups associated to a user |
| GET | `/users/{user_uuid}/policies` | Retrieves the list of policies associated to a user |
| PUT | `/users/{user_uuid}/policies/{policy_uuid}` | Associate a policy to a user |
| DELETE | `/users/{user_uuid}/policies/{policy_uuid}` | Dissociate a policy from a user |
| POST | `/users/register` | Create a user |
| GET | `/users/{user_uuid}/sessions` | Retrieves the list of sessions associated to a user |
| DELETE | `/users/{user_uuid}/sessions/{session_uuid}` | Delete a session |
| GET | `/users` | Retrieves the list of users |
| POST | `/users` | Create a user |
| GET | `/users/{user_uuid}` | Retrieves the details of a user |
| DELETE | `/users/{user_uuid}` | Delete a user |
| PUT | `/users/{user_uuid}` | Update an existing user |
| PUT | `/users/{user_uuid}/password` | Change the user's password |
| GET | `/users/{user_uuid}/cdr` | List CDR of the given user |
| GET | `/users/me/cdr` | List CDR of the authenticated user |
| GET | `/users/me/calls` | List calls of a user |
| POST | `/users/me/calls` | Make a new call from a user |
| DELETE | `/users/me/calls/{call_id}` | Hangup a call from a user |
| PUT | `/users/me/calls/{call_id}/mute/start` | Mute a call from user |
| PUT | `/users/me/calls/{call_id}/mute/stop` | Unmute a call from user |
| PUT | `/users/me/calls/{call_id}/hold/start` | Hold a call from user |
| PUT | `/users/me/calls/{call_id}/hold/stop` | Unhold a call from user |
| PUT | `/users/me/calls/{call_id}/record/start` | Start recording a call |
| PUT | `/users/me/calls/{call_id}/record/stop` | Stop recording a call |
| PUT | `/users/me/calls/{call_id}/record/pause` | Pause recording a call |
| PUT | `/users/me/calls/{call_id}/record/resume` | Resume recording a call |
| PUT | `/users/me/calls/{call_id}/answer` | Answer a call from user |
| PUT | `/users/me/calls/{call_id}/dtmf` | Simulate a user pressing DTMF keys |
| GET | `/users/me/conferences/{conference_id}/participants` | List participants of a conference as a user |
| GET | `/users/me/meetings/{meeting_uuid}/participants` | List participants of a meeting as a user |

…and 95 more operations. They are listed in full on the page.

## Machine-readable artifacts (61)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/wazo/refs/heads/main/openapi/wazo-users-api-openapi.yml
- **APIReference** — https://api.wazo.io/documentation/api/authentication.html
- **Console** — https://api.wazo.io/documentation/console/authentication/
- **SourceCode** — https://github.com/wazo-platform/wazo-auth
- **ChangeLog** — https://github.com/wazo-platform/wazo-auth/blob/master/CHANGELOG.md
- **Authentication** — https://raw.githubusercontent.com/api-evangelist/wazo/refs/heads/main/authentication/wazo-authentication.yml
- **Conventions** — https://raw.githubusercontent.com/api-evangelist/wazo/refs/heads/main/conventions/wazo-conventions.yml
- **ErrorCatalog** — https://raw.githubusercontent.com/api-evangelist/wazo/refs/heads/main/errors/wazo-problem-types.yml
- **AsyncAPI** — https://raw.githubusercontent.com/api-evangelist/wazo/refs/heads/main/asyncapi/wazo-auth-asyncapi.yml
- **APIReference** — https://api.wazo.io/documentation/api/configuration.html
- **Console** — https://api.wazo.io/documentation/console/configuration/
- **SourceCode** — https://github.com/wazo-platform/wazo-confd
- **ChangeLog** — https://github.com/wazo-platform/wazo-confd/blob/master/CHANGELOG.md
- **AsyncAPI** — https://raw.githubusercontent.com/api-evangelist/wazo/refs/heads/main/asyncapi/wazo-confd-asyncapi.yml
- **APIReference** — https://api.wazo.io/documentation/api/application.html
- **Console** — https://api.wazo.io/documentation/console/application/
- **SourceCode** — https://github.com/wazo-platform/wazo-calld
- **ChangeLog** — https://github.com/wazo-platform/wazo-calld/blob/master/CHANGELOG.md
- **AsyncAPI** — https://raw.githubusercontent.com/api-evangelist/wazo/refs/heads/main/asyncapi/wazo-calld-asyncapi.yml
- **APIReference** — https://api.wazo.io/documentation/api/cdr.html
- **Console** — https://api.wazo.io/documentation/console/cdr/
- **SourceCode** — https://github.com/wazo-platform/wazo-call-logd
- **ChangeLog** — https://github.com/wazo-platform/wazo-call-logd/blob/master/CHANGELOG.md
- **AsyncAPI** — https://raw.githubusercontent.com/api-evangelist/wazo/refs/heads/main/asyncapi/wazo-call-logd-asyncapi.yml
- **APIReference** — https://api.wazo.io/documentation/api/contact.html
- **Console** — https://api.wazo.io/documentation/console/contact/
- **SourceCode** — https://github.com/wazo-platform/wazo-dird
- **ChangeLog** — https://github.com/wazo-platform/wazo-dird/blob/master/CHANGELOG.md
- **AsyncAPI** — https://raw.githubusercontent.com/api-evangelist/wazo/refs/heads/main/asyncapi/wazo-dird-asyncapi.yml
- **APIReference** — https://api.wazo.io/documentation/api/webhook.html
- **Console** — https://api.wazo.io/documentation/console/webhook/
- **SourceCode** — https://github.com/wazo-platform/wazo-webhookd
- **ChangeLog** — https://github.com/wazo-platform/wazo-webhookd/blob/master/CHANGELOG.md
- **Webhooks** — https://raw.githubusercontent.com/api-evangelist/wazo/refs/heads/main/asyncapi/wazo-events-webhooks.yml
- **AsyncAPI** — https://raw.githubusercontent.com/api-evangelist/wazo/refs/heads/main/asyncapi/wazo-webhookd-asyncapi.yml
- **APIReference** — https://api.wazo.io/documentation/api/plugins.html
- **Console** — https://api.wazo.io/documentation/console/plugins/
- **SourceCode** — https://github.com/wazo-platform/wazo-plugind
- **ChangeLog** — https://github.com/wazo-platform/wazo-plugind/blob/master/CHANGELOG.md
- **AsyncAPI** — https://raw.githubusercontent.com/api-evangelist/wazo/refs/heads/main/asyncapi/wazo-plugind-asyncapi.yml
- …and 21 more, listed in full on the page.

## Other Wazo APIs (12)

- [Wazo Phone Provisioning API (wazo-provd)](https://apis.io/apis/wazo/wazo-phone-provisioning-api-wazo-provd/)
- [Wazo Websocket Event Stream (wazo-websocketd)](https://apis.io/apis/wazo/wazo-websocket-event-stream-wazo-websocketd/)
- [Wazo Aastra API](https://apis.io/apis/wazo/wazo-aastra-api/)
- [Wazo Access Features API](https://apis.io/apis/wazo/wazo-access-features-api/)
- [Wazo Action API](https://apis.io/apis/wazo/wazo-action-api/)
- [Wazo Adhoc Conferences API](https://apis.io/apis/wazo/wazo-adhoc-conferences-api/)
- [Wazo Admin API](https://apis.io/apis/wazo/wazo-admin-api/)
- [Wazo Agent Statistics API](https://apis.io/apis/wazo/wazo-agent-statistics-api/)
- [Wazo Agents API](https://apis.io/apis/wazo/wazo-agents-api/)
- [Wazo Applications API](https://apis.io/apis/wazo/wazo-applications-api/)
- [Wazo Asterisk API](https://apis.io/apis/wazo/wazo-asterisk-api/)
- [Wazo Backends API](https://apis.io/apis/wazo/wazo-backends-api/)

## Tags

User

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/wazo/wazo-users-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/wazo/.