List Condition Values
Use this API to return a list of possible values to compare to a condition type.
Not all conditions 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 condition value can be set to free text string.
Resource URL
https://<subdomain>/api/2/mappings/conditions/:condition_value/values
Header Parameters
Authorization required string | Set to Set 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: |
Query Parameters
condition_value string | The value for the selected condition. For a complete list of possible condition values see List Conditons. |
Sample Responses
- 200 OK
- 401 Unauthorized
Empty response indicates free text can be used for condition value.
When condition type of has_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"
}
Response Elements
When an array is returned use the value attribute when creating or updating mappings.
name |
The name or description of the operator. |
value |
The condition operator value to use when creating or updating User Mappings. |
Postman Collection
- Clicking Run in Postman button navigates to the page where you can fork the collection to your workspace. Forking the collection into your workspace will enable you to contribute to the source collection using pull requests. You can also view the collection in a public workspace if you like and even import a copy of the collection using the links present on the screen.
Sample Code
cURL
Replace sample values indicated by < >
with your actual values.
List Condition Values
curl 'https://<subdomain>/api/2/mappings/<condition_value>>/values' \
-X GET \
-H "Authorization: bearer <access_token>"
Have a Question?
Found a problem or a bug? Submit a support ticket.
Looking for walkthroughs or how-to guides on OneLogin's user and admin features? Check out the documentation in our Knowledge Base.
Have a product idea or request? Share it with us in our Ideas Portal.