UserAttributesApi
| Method | HTTP request | Description |
|---|---|---|
| create_user_attribute_using_post | POST /api/web/v1/userattributes | Create a user attribute |
| delete_user_attribute_using_delete | DELETE /api/web/v1/userattributes/{id} | Delete a user attribute |
| get_user_attribute_using_get | GET /api/web/v1/userattributes/{id} | Get a user attribute |
| list_user_attributes_using_get | GET /api/web/v1/userattributes | List user attributes |
| modify_user_attribute_using_put | PUT /api/web/v1/userattributes/{id} | Modify a user attribute |
create_user_attribute_using_post
UserAttribute create_user_attribute_using_post(user_attribute_parms)
Create a user attribute
Create a user attribute. Caller requires the USERATTRIBUTES:ADD permission.
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| user_attribute_parms | UserAttributeParms |
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_user_attribute_using_delete
delete_user_attribute_using_delete(id)
Delete a user attribute
Delete the specified user attribute. Caller requires the USERATTRIBUTES:REMOVE permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The UUID of the user attribute to delete. |
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_user_attribute_using_get
UserAttribute get_user_attribute_using_get(id)
Get a user attribute
Get the specified user attribute. Caller requires the USERATTRIBUTES:VIEW permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The UUID of the user attribute to get. |
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 | - |
list_user_attributes_using_get
List[UserAttribute] list_user_attributes_using_get()
List user attributes
List all user attributes defined for the account. Caller requires the USERATTRIBUTES:VIEW permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
This endpoint does not need any parameter.
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 | - |
modify_user_attribute_using_put
UserAttribute modify_user_attribute_using_put(id, user_attribute_parms)
Modify a user attribute
Modify the specified user attribute. Caller requires the USERATTRIBUTES:EDIT permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The UUID of the user attribute to be modified. | |
| user_attribute_parms | UserAttributeParms |
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 | - |