MachineAuthApi
| Method | HTTP request | Description |
|---|---|---|
| create_machine_authenticator_using_post | POST /api/web/v1/users/{userid}/machines | Create a Machine Authenticator |
| delete_machine_authenticator_using_delete | DELETE /api/web/v1/users/{userid}/machines/{id} | Delete a Machine Authenticator |
| list_machine_authenticators_using_get | GET /api/web/v1/users/{userid}/machines | List machine authenticators for a user |
create_machine_authenticator_using_post
MachineAuthenticatorRegistrationResult create_machine_authenticator_using_post(userid, machine_authenticator_registration)
Create a Machine Authenticator
Create a Machine Authenticator for a user. Caller requires the USERMACHINES:ADD permission.
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userid | str | The UUID of the user for which the machine authenticator is to be added. | |
| machine_authenticator_registration | MachineAuthenticatorRegistration |
Return type
MachineAuthenticatorRegistrationResult
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
delete_machine_authenticator_using_delete
delete_machine_authenticator_using_delete(userid, id)
Delete a Machine Authenticator
Deletes a Machine Authenticator from a user. Caller requires the USERMACHINES:REMOVE permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userid | str | The UUID of the user from which the machine authenticator is to be deleted. | |
| id | str | The UUID of the machine authenticator which is to be deleted. |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
list_machine_authenticators_using_get
List[UserMachineAuthenticator] list_machine_authenticators_using_get(userid)
List machine authenticators for a user
List all machine authenticators for the specified user. Caller requires the USERMACHINES:VIEW permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userid | str | The UUID of the user for which machine authenticators are to be fetched. |
Return type
List[UserMachineAuthenticator]
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |