TempAccessCodesApi
| Method | HTTP request | Description |
|---|---|---|
| create_temp_access_code_using_post | POST /api/web/v1/users/{userid}/tempaccesscode | Create a temporary access code |
| delete_temp_access_code_using_delete | DELETE /api/web/v1/users/{userid}/tempaccesscode | Delete a temporary access code |
| get_temp_access_code_using_get | GET /api/web/v1/users/{userid}/tempaccesscode | Get a temporary access code |
create_temp_access_code_using_post
TempAccessCode create_temp_access_code_using_post(userid)
Create a temporary access code
Create a temporary access code for the given user. Caller requires the TEMPACCESSCODE:ADD permission.
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userid | str | The UUID of the user for which a temporary access code will be created. |
Return type
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 | - |
delete_temp_access_code_using_delete
delete_temp_access_code_using_delete(userid)
Delete a temporary access code
Delete the temporary access code for the given user. Caller requires the TEMPACCESSCODE:REMOVE permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userid | str | The UUID of the user whose temporary access code will 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 | - |
get_temp_access_code_using_get
TempAccessCode get_temp_access_code_using_get(userid)
Get a temporary access code
Get the temporary access code for the given user. Caller requires the TEMPACCESSCODE:VIEW permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userid | str | The UUID of the user whose temporary access code will be fetched. |
Return type
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 | - |