Home >
API >
2 >
User Mappings >
Create Mapping

Create Mapping

Use this API to create an a new User Mapping.

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.

Content-Type

required

string

Set to application/json.

Request Parameters

name required	The name of the mapping.	String
enabled required	Indicates if the mapping is enabled or not.	Boolean
match required	Indicates how conditions should be matched. all - Match all conditions any - Match any condition	String
position required	Indicates the order of the mapping. When `null` this will default to last position.	Integer
conditions required	An array of conditions that the user must meet in order for the mapping to be applied. source - The source field to check. See List Conditions for possible values. operator - A valid operator for the selected condition source. See List Condition Operators for possible values. value - A plain text string or valid value for the selected condition source. See List Condition Values for possible values.	Array
actions required	An array of actions that will be applied to the users that are matched by the conditions. action - The action to apply. See List Actions for possible values. value - An array of strings. Items in the array will be a plain text string or valid value for the selected action. See List Action Values for possible values. In most cases only a single item will be accepted in the array.	Array

Sample Request Body

{
    "name": "My Second Mapping",
    "match": "all",
    "enabled": true,
    "position": null,
    "conditions": [
        {
            "source": "last_login",
            "operator": ">",
            "value": "90"
        }
    ],
    "actions": [
        {
            "action": "set_status",
            "value": ["2"]
        }
    ]
}

Sample Responses

201 Created
401 Unauthorized
422 Unprocessable Entity

{
    "id": 1022743
}

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

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

{
    "code": 422,
    "message": "Validation Failed",
    "errors": [
        {
            "field": "enabled",
            "message": [
                "Required field is missing"
            ]
        }
    ]
}

An invalid condition value was supplied

{
    "code": 422,
    "message": "Validation Failed",
    "errors": [
        {
            "field": "conditions.[0].value",
            "message": [
                "Invalid condition value: 12345"
            ]
        }
    ]
}

Response Elements

`id`	New User Mapping ID.

Postman Collection

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

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.

Create a Mapping

curl 'https://<subdomain>/api/2/mappings' \
-X POST \
-H "Authorization: bearer <access_token>"
-H "Content-Type: application/json" \
-d '{
    "name": "My Second Mapping",
    "match": "all",
    "enabled": true,
    "position": null,
    "conditions": [
        {
            "source": "last_login",
            "operator": ">",
            "value": "90"
        }
    ],
    "actions": [
        {
            "action": "set_status",
            "value": "2"
        }
    ]
}'

Have a Question?

Found a bug? Submit a support ticket.

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