MagicLinkApi
| Method | HTTP request | Description |
|---|---|---|
| create_magic_link_using_put | PUT /api/web/v1/users/{userid}/magiclink | Create and get the Magic Link for a user |
| delete_magic_link_using_delete | DELETE /api/web/v1/users/{userid}/magiclink | Delete the Magic Link for a given user |
| get_magic_link_using_get | GET /api/web/v1/users/{userid}/magiclink | Get the Magic Link for a user |
create_magic_link_using_put
MagicLinkResponse create_magic_link_using_put(userid, magic_link_create_parms)
Create and get the Magic Link for a user
Create and get the Magic Link for the specified user. Caller requires the MAGICLINKS:ADD permission.
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userid | str | ||
| magic_link_create_parms | MagicLinkCreateParms |
Return type
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_magic_link_using_delete
delete_magic_link_using_delete(userid)
Delete the Magic Link for a given user
Delete the Magic Link for the specified user. Caller requires the MAGICLINKS:REMOVE permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userid | str | The UUID of the user to delete the Magic Link for. |
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_magic_link_using_get
MagicLink get_magic_link_using_get(userid)
Get the Magic Link for a user
Get information about the Magic Link for the specified user if one has been created. Caller requires the MAGICLINKS:VIEW permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userid | str |
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 | - |