# Users

Manage user profiles


## Servers

Sandbox environment
```
https://api.sbx.transmitsecurity.io/cis
```

US production environment
```
https://api.transmitsecurity.io/cis
```

EU production environment
```
https://api.eu.transmitsecurity.io/cis
```

CA production environment
```
https://api.ca.transmitsecurity.io/cis
```

AU production environment
```
https://api.au.transmitsecurity.io/cis
```

JP production environment
```
https://api.gasne1-ts01.transmitsecurity.io/cis
```

## Security

### bearer

Type: http
Scheme: bearer
Bearer Format: JWT

### UserAccessToken

A token returned upon end-user authentication, which provides access to resources and data for the user and app for which it was generated

Type: http
Scheme: bearer
Bearer Format: JWT

### AdminAccessToken

[object Object]

Type: oauth2
Token URL: /oidc/token
Scopes:

### ClientAccessToken

[object Object]

Type: oauth2
Token URL: /oidc/token
Scopes:

### OrgAdminAccessToken

A token returned upon B2B authentication for a user that has the organizationAdmin or organizationCreator role.

Type: oauth2
Token URL: /oidc/token
Scopes:

## Download OpenAPI description

 - [Users](https://developer.transmitsecurity.com/_bundle/openapi/user/user.openapi.yaml)

 - [GET /v1/users/count](https://developer.transmitsecurity.com/openapi/user/user.openapi/other/getuserscount.md): Get the number of saved users. <br><br>**Required permissions**: `users:list`, `apps:list`, `[appId]:list`.
 - [POST /v1/users](https://developer.transmitsecurity.com/openapi/user/user.openapi/other/createuser.md): Add a user to Transmit. A user_id is returned as part of the User in the response that can then be used to perform other operations, such as get, update and delete. An email or a phone_number are requ
 - [GET /v1/users](https://developer.transmitsecurity.com/openapi/user/user.openapi/other/getusers.md): Search across your application’s users at Transmit. This endpoint also allows you to return all of your application’s users by sending no filters at all. <br><br>**Required permissions**: `users:read`
 - [GET /v1/users/identifier](https://developer.transmitsecurity.com/openapi/user/user.openapi/other/getuserbyidentifier.md): Search for a user by identifier. <br><br>**Required permissions**: `apps:read`, `[appId]:read`, `users:read`.
 - [GET /v1/users/{user_id}](https://developer.transmitsecurity.com/openapi/user/user.openapi/other/getuserbyid.md): Search for a user by user ID. <br><br>**Required permissions**: `apps:read`, `[appId]:read`, `users:read`.
 - [PUT /v1/users/{user_id}](https://developer.transmitsecurity.com/openapi/user/user.openapi/other/updateuser.md): Update a user's attributes or their custom data. Changes will be merged into the user's profile, so you can specify only the fields you want to update. <br><br> **Note:** <ul> <li> Attributes (like na
 - [GET /v1/users/{user_id}/groups](https://developer.transmitsecurity.com/openapi/user/user.openapi/other/getusergroups.md): Retrieve a list of groups associated with a user. <br><br>**Required permissions**: `apps:read`, `[appId]:read`, `groups:read`.
 - [GET /v1/users/email/{email}](https://developer.transmitsecurity.com/openapi/user/user.openapi/other/getuserbyemail.md): Search for a user by primary email. <br><br>**Required permissions**: `apps:read`, `[appId]:read`, `users:read`.
 - [GET /v1/users/external-user-id/{external_user_id}](https://developer.transmitsecurity.com/openapi/user/user.openapi/other/getuserbyexternaluserid.md): Search for a user by their external_user_id, which represents the user identifier in external provider. <br><br>**Required permissions**: `apps:read`, `[appId]:read`, `users:read`.
 - [GET /v1/users/username/{username}](https://developer.transmitsecurity.com/openapi/user/user.openapi/other/getuserbyusername.md): Search for a user by username. <br><br>**Required permissions**: `apps:read`, `[appId]:read`, `users:read`.
 - [DELETE /v1/users/{user_id}/apps](https://developer.transmitsecurity.com/openapi/user/user.openapi/other/removeuserfromapp.md): Remove a user from the requesting application. <br><br>**Required permissions**: `apps:edit`, `[appId]:edit`, `users:edit`.
 - [DELETE /v1/users/{user_id}/erase](https://developer.transmitsecurity.com/openapi/user/user.openapi/other/harddeleteuser.md): Permanently erases a user and all their data. **This action cannot be undone and the data cannot be recovered.** You can also use it for users previously removed with [Delete user](/openapi/user/user.
 - [POST /v1/users/{user_id}/password](https://developer.transmitsecurity.com/openapi/user/user.openapi/other/addpasswordcredential.md): Creates new password credentials for a user that doesn't already have a password. The password is temporary, and must be reset upon the user's first login. <br><br>**Required permissions**: `apps:crea
 - [PUT /v1/users/{user_id}/password](https://developer.transmitsecurity.com/openapi/user/user.openapi/other/updatepasswordcredential.md): Updates the user's existing credentials with a new temporary password, which must be reset the next time they login. <br><br>**Required permissions**: `apps:edit`, `[appId]:edit`, `authenticators:edit
 - [GET /v1/users/phone-number/{phone_number}](https://developer.transmitsecurity.com/openapi/user/user.openapi/other/getuserbyphone.md): Search for a user by their primary phone number. <br><br>**Required permissions**: `apps:read`, `[appId]:read`, `users:read`.
 - [DELETE /v1/users/{user_id}/emails/{email}](https://developer.transmitsecurity.com/openapi/user/user.openapi/other/removeusersecondaryemail.md): Removes a secondary email address from the user's profile. <br><br>**Required permissions**: `apps:edit`, `[appId]:edit`, `users:edit`.
 - [DELETE /v1/users/{user_id}/phone-numbers/{phone_number}](https://developer.transmitsecurity.com/openapi/user/user.openapi/other/removeusersecondaryphonenumber.md): Remove a secondary phone number from the user's profile. <br><br>**Required permissions**: `apps:edit`, `[appId]:edit`, `users:edit`.
 - [DELETE /v1/users/{user_id}/custom_data/{key}](https://developer.transmitsecurity.com/openapi/user/user.openapi/other/removeusercustomdatakey.md): Remove a single key from the user's custom data. <br><br>**Required permissions**: `apps:edit`, `[appId]:edit`, `users:edit`.
 - [DELETE /v1/users/{user_id}/custom_data](https://developer.transmitsecurity.com/openapi/user/user.openapi/other/clearusercustomdata.md): Remove all of the user's custom data. <br><br>**Required permissions**: `apps:edit`, `[appId]:edit`, `users:edit`.
 - [DELETE /v1/users/{user_id}/custom_app_data/{key}](https://developer.transmitsecurity.com/openapi/user/user.openapi/other/removeusercustomappdatakey.md): Remove a single key from the user's custom app data for the requesting application. <br><br>**Required permissions**: `apps:edit`, `[appId]:edit`, `users:edit`.
 - [DELETE /v1/users/{user_id}/custom_app_data](https://developer.transmitsecurity.com/openapi/user/user.openapi/other/clearusercustomappdata.md): Remove all of the user's custom app data for the requesting application. <br><br>**Required permissions**: `apps:edit`, `[appId]:edit`, `users:edit`.
 - [POST /v1/users/{user_id}/emails/{email}/verify](https://developer.transmitsecurity.com/openapi/user/user.openapi/other/verifyuseremail.md): Indicates that the user's email address was verified externally. A user's email address is automatically marked as verified when used in a Transmit authentication or verification flow. If the email ad
 - [POST /v1/users/{user_id}/phone-numbers/{phone_number}/verify](https://developer.transmitsecurity.com/openapi/user/user.openapi/other/verifyuserphonenumber.md): Indicates that the user's phone number was verified externally. A user's phone number is automatically marked as verified when used in a Transmit authentication or verification flow. If the phone numb
 - [DELETE /v1/manage/users/{user_id}](https://developer.transmitsecurity.com/openapi/user/user.openapi/other/deletetenantuser.md): Delete a user and all their data (tenant-level and app-level). Requires an admin access token (from a management app). <br><br>**Required permissions**: `users:delete`.
 - [POST /v1/users/me/password-credentials](https://developer.transmitsecurity.com/openapi/user/user.openapi/other/addpasswordcredentialstocurrentuser.md): Allows a logged-in user to register their first password. Must be authorized using a valid user access token returned upon successful authentication.
 - [GET /v1/users/me/device-keys](https://developer.transmitsecurity.com/openapi/user/user.openapi/other/getdevicekeysfortenant.md): Get device keys by user id
 - [GET /v1/users/phone/{phone_number}](https://developer.transmitsecurity.com/openapi/user/user.openapi/other/deprecatedgetuserbyphone.md): Search for a user by their primary phone number