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 userAttributeParms)
Create a user attribute
Create a user attribute. Caller requires the USERATTRIBUTES:ADD permission.
Using the CreateUserAttributeUsingPOSTWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
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
void DeleteUserAttributeUsingDELETE (string id)
Delete a user attribute
Delete the specified user attribute. Caller requires the USERATTRIBUTES:REMOVE permission.
Example
Using the DeleteUserAttributeUsingDELETEWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | 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 | - |
GetUserAttributeUsingGET
UserAttribute GetUserAttributeUsingGET (string id)
Get a user attribute
Get the specified user attribute. Caller requires the USERATTRIBUTES:VIEW permission.
Example
Using the GetUserAttributeUsingGETWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
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
Using the ListUserAttributesUsingGETWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
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 (string id, UserAttributeParms userAttributeParms)
Modify a user attribute
Modify the specified user attribute. Caller requires the USERATTRIBUTES:EDIT permission.
Example
Using the ModifyUserAttributeUsingPUTWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
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 | - |