Get Mapper Set for a specific Template in the indicated Environment. This API is designed to support Get operation for Mapper Set.
Notice
Accessing the APIs is through a dedicated domain/URL, according to your PlainID Tenant LocationUsing HTML Encoded Special Characters
Use HTML encoded patterns when working with values that contain special characters like spaces, dashes, etc. Refer to this HTML URL Encoding Reference for a full list.
Important note about headers
Refer to the headers below to modify your cURL sample. Check if the following headers are in the sample, if not, ensure you add it to your API tool.
Headers
*Required| Header | Value | cURL Line |
|---|---|---|
| Accept | `application/json` | `-H "Accept:application/json"` |
cURL Sample Guidelines
In order for the relevant parameters to appear in the cURL sample, you can input the values in the interactive API console on the right in the Try It or Code Sample tabs. You can then copy the cURL sample from the Code Sample tab in the correct format.
For more details about Administration API Authentication, check out the Authentication APIs documentation
Provide your bearer token in the Authorization header when making requests to protected resources.
Example: Authorization: Bearer 123
The Environment ID can be found under the Details Tab in the Environment Settings.
The Identity Template ID. This can be found in your Identity Workspace Settings.
The Mapper Set ID. This can be found in the Identity Workspace Settings under the relevent Mapper Set.
When set to true, retrieves unimported Source mappings.
Successful operation
{
"data": [
{
"mappersSetId": "ms_123456",
"displayName": "User Mapper Set",
"description": null,
"linkedSources": [
{
"sourceId": "REQUEST_INPUT",
"sourceUsedAs": "BASE",
"mappers": [
{
"type": "IDENTITY_ATTRIBUTES",
"mappings": [
{
"origin": "uid",
"target": "uid"
},
{
"origin": "assignmentId",
"target": "assignmentId"
},
{
"origin": "assignmentName",
"target": "assignmentName"
}
]
}
]
},
{
"sourceId": "REQUEST_MAPPERS",
"sourceUsedAs": "BASE",
"mappers": [
{
"type": "IDENTITY_ATTRIBUTES",
"mappings": [
{
"origin": "$.JWT.a.claim",
"target": "userAssignment"
}
]
}
]
},
{
"sourceId": "ds_users",
"sourceUsedAs": "MAIN",
"additionalProps": {
"isValidateUser": true
},
"mappers": [
{
"type": "IDENTITY_ATTRIBUTES",
"mappings": [
{
"origin": "userID",
"target": "uid"
}
]
}
]
},
{
"sourceId": "ds_classes",
"sourceUsedAs": "AUX",
"additionalProps": {
"cacheDuration": 0
},
"mappers": [
{
"type": "CORRELATION",
"mappings": [
{
"origin": "userIdentifier",
"target": "uid",
"operator": "EQUALS"
}
]
},
{
"type": "IDENTITY_ATTRIBUTES",
"mappings": [
{
"origin": "assignmentId",
"target": "userAssignmentId"
},
{
"origin": "assignmentName",
"target": "userAssignmentName"
}
]
}
]
},
{
"sourceId": "ds_classes",
"sourceUsedAs": "CONTEXT",
"additionalProps": {},
"mappers": [
{
"type": "CORRELATION",
"mappings": [
{
"origin": "userIdentifier",
"target": "uid",
"operator": "EQUALS"
}
]
},
{
"type": "CONTEXT_FILTERS",
"mappings": [
{
"origin": "class",
"target": "classification",
"originMapper": "$.JWT.a.claim",
"isRequired": true,
"isExcludedFromCache": false
}
]
},
{
"type": "IDENTITY_ATTRIBUTES",
"mappings": [
{
"origin": "assignmentId",
"target": "userAssignmentId"
},
{
"origin": "assignmentName",
"target": "userAssignmentName"
}
]
}
]
},
{
"sourceId": "CALCULATED",
"sourceUsedAs": "AUX",
"mappers": [
{
"type": "IDENTITY_ATTRIBUTES",
"mappings": [
{
"origin": "SUBSTRING({{assignmentName}},0,5)",
"target": "userAssignmentPrefix"
}
]
}
]
}
]
}
]
}Response payload for a Mapper Set
Mapper Set
Unique identifier for the Mapper Set
Display name for the Mapper Set
Description of the Mapper Set
List of linked sources for the Mapper Set
Source identifier. This can be found in the relevant Source in your Identity Workspace Settings.
How the source is used in the mapping
Additional properties for the source
Cache duration in minutes
Whether to validate the user in MAIN source only
List of Mappers for the Source
Type of mapper
List of Attribute mappings
Origin Attribute or expression
Target Attribute
Operator for correlation (for correlation mappers)
Origin mapper expression (for context filters mappers)
If the Mapping is required (for context filters mappers)
Exclude from cache (for context filters mappers)
Unauthorized
Forbidden
Object not found
{
"errors": [
{
"code": "EMTMS-001",
"id": "EQ7CMX",
"status": "404",
"name": "TemplateMapperSetNotFoundError",
"message": "Template Mapper Set: [TMS] not found, Hint: did you mean [User, Target]"
}
]
}Response object
Internal Server Error