See api-docs Menu
  1. Home >
  2. API >
  3. 2 >
  4. User Mappings >
  5. List Mappings

List Mappings

Use this API to return a list of user mappings.

By default this endpoint only returns the mappings that are currently enabled. To return disabled mappings set the enabled query parameter to false.

Pagination is not supported on this endpoint.





Resource URL

https://<subdomain>/api/2/mappings

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

enabled

boolean

Defaults to true. When set to `false` will return all disabled mappings.

has_condition

string

Filters Mappings based on their Conditions. Values formatted as :, where name is the Condition to look for, and value is the value to find. Multiple filters can be declared by using a comma delimited list. Wildcards are supported in both the name and value fields.

For example:

Single filter. has_condition=has_role:123456

Multiple filters. has_condition=has_role:123456,status:1

Wildcard for conditions. has_condition=*:123456

Wildcard for condition values. has_condition=has_role:*

has_condition_type

string

Filters Mappings based on their condition types.

Allowed values are:

  • builtin - actions that involve standard attributes
  • custom - actions that involve custom attributes
  • none - no actions are defined

For example:

Find Mappings using custom user attributes has_condition_type=custom

Find Mappings with no conditions has_condition_type=none

has_action

string

Filters Mappings based on their Actions. Values formatted as :, where name is the Action to look for, and value is the value to find. Multiple filters can be declared by using a comma delimited list. Wildcards are supported in both the name and value fields.

For example:

Single filter. has_action=set_licenses:123456

Multiple filters. has_action=set_groups:123456,set_usertype:*

Wildcard for actions. has_action=*:123456

Wildcard for action values. has_action=set_userprincipalname:*

has_action_type

string

Filters Mappings based on their action types.

Allowed values are:

  • builtin - actions that involve standard attributes
  • custom - actions that involve custom attributes
  • none - no actions are defined

For example:

Find Mappings with no actions has_action_type=none

Many of the search tools described in our Getting Started documentation can be applied to your parameters, allowing you to fine-tune your results.

Sample Responses

  • 200 OK
  • 401 Unauthorized
[
  {
      "id": 196673,
      "name": "My first mapping",
      "match": "all",
      "enabled": true,
      "position": 1,
      "conditions": [
          {
              "source": "last_login",
              "operator": ">",
              "value": "90"
          }
      ],
      "actions": [
          {
              "action": "set_status",
              "value": ["2"]
          }
      ]
  }
  ...
]

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

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

Postman Collection

Run In Postman

    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 Mappings

curl 'https://<subdomain>/api/2/mappings' \
-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.