See api-docs Menu

List Action Values

Use this API to return a list of possible values to set using a given action.

Not all actions have a defined list of possible values.

When this request returns a successful HTTP 200 Ok response but the payload body is empty then it indicates that the action value can be set to free text string.





Resource URL

https://<api-domain>/api/2/mappings/:action_value/values

Header Parameters

Authorization

required

string

Set to bearer <access_token>.

Set <access_token> to the access token you generated using the Generate Token API.

The access token must have been generated using an API credential pair created using the scope required to call this API. This API can be called using any one of the following scopes: Manage All.

Query Parameters

action_value

string

The value for the selected action. For a complete list of possible action values see List Actions.

Sample Responses

Empty response indicates free text can be used for action value.

When action type of add_role is supplied then a list of Roles is returned.

[
    {
        "name": "Administrators",
        "value": 272445
    },
    {
        "name": "Contractors",
        "value": 272444
    },
    {
        "name": "Default",
        "value": 199848
    }
]

Typically, this error means that your access token value is invalid.

{
    "message": "Unauthorized",
    "statusCode": 401,
    "name": "UnauthorizedError"
}

Postman Collection

Replace sample variables indicated by {{ }} with your actual values.

Download for User Mappings API

Sample Code

cURL

Replace sample values indicated by < > with your actual values.

List Mapping Action Values

curl 'https://<api-domain>/api/2/mappings/:action_value/values' \
-X GET \
-H "Authorization: bearer <access_token>"

Have a Question?

Found a bug? Submit a support ticket.

Have a product idea or request? Share it with us in our Ideas Portal.