UserAttributesApi
| Method | HTTP request | Description |
|---|---|---|
| createUserAttributeUsingPOST | POST /api/web/v1/userattributes | Create a user attribute |
| deleteUserAttributeUsingDELETE | DELETE /api/web/v1/userattributes/{id} | Delete a user attribute |
| getUserAttributeUsingGET | GET /api/web/v1/userattributes/{id} | Get a user attribute |
| listUserAttributesUsingGET | GET /api/web/v1/userattributes | List user attributes |
| modifyUserAttributeUsingPUT | PUT /api/web/v1/userattributes/{id} | Modify a user attribute |
createUserAttributeUsingPOST
UserAttribute createUserAttributeUsingPOST(userAttributeParms)
Create a user attribute
Create a user attribute. Caller requires the USERATTRIBUTES:ADD permission.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userAttributeParms | 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 | - |
deleteUserAttributeUsingDELETE
deleteUserAttributeUsingDELETE(id)
Delete a user attribute
Delete the specified user attribute. Caller requires the USERATTRIBUTES:REMOVE permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | The UUID of the user attribute to delete. |
Return type
null (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 | - |
getUserAttributeUsingGET
UserAttribute getUserAttributeUsingGET(id)
Get a user attribute
Get the specified user attribute. Caller requires the USERATTRIBUTES:VIEW permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | 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 | - |
listUserAttributesUsingGET
List<UserAttribute> listUserAttributesUsingGET()
List user attributes
List all user attributes defined for the account. Caller requires the USERATTRIBUTES:VIEW permission.
Example
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 | - |
modifyUserAttributeUsingPUT
UserAttribute modifyUserAttributeUsingPUT(id, userAttributeParms)
Modify a user attribute
Modify the specified user attribute. Caller requires the USERATTRIBUTES:EDIT permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | The UUID of the user attribute to be modified. | |
| userAttributeParms | 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 | - |