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.
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.
| Header | Value | cURL Line |
|---|---|---|
| Accept | `application/json` | `-H "Accept:application/json"` |
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.
## OpenAPI ````json GET /api/1.0/identity-templates/{envId}/{identityTemplateId}/mapper-sets { "openapi": "3.0.3", "info": { "title": "Management APIs", "version": "1.0.0", "contact": { "name": "PlainID", "url": "https://plainid.com", "email": "contact@plainid.com" }, "license": { "name": "Commercial", "url": "https://plainid.com/license" }, "termsOfService": "https://www.plainid.com/terms/", "description": "| Region | Base URL |
|---|---|
| United States (US) | https://api.us1.plainid.io |
| Canada (CA) | https://api.ca1.plainid.io |
| Europe (EU) | https://api.eu1.plainid.io |
| Local PAA | https://api.plainid.local |
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.
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.
| Header | Value | cURL Line |
|---|---|---|
| Accept | `application/json` | `-H \"Accept:application/json\"` |
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.
", "tags": [ "Mapper Sets" ], "parameters": [ { "name": "envId", "in": "path", "required": "true", "schema": { "type": "string", "format": "uuid" }, "description": "The Environment ID can be found under the Details Tab in the Environment Settings." }, { "name": "identityTemplateId", "in": "path", "required": "true", "schema": { "type": "string" }, "description": "The Identity Template ID can be found in the Details tab in the Identities Workspace Settings." }, { "name": "detailed", "in": "query", "required": "false", "schema": { "type": "boolean" }, "description": "When set to true, retrieves the full Mapper Set data." }, { "name": "includeUnimportableSources", "in": "query", "required": "false", "schema": { "type": "boolean", "default": "false" }, "description": "When set to true, retrieves unimportable Source mappings." } ], "responses": { "200": { "description": "Successful operation", "headers": { "x-request-id": { "schema": { "type": "string" }, "description": "The ID of the request" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MapperSetListResponse" }, "examples": { "example": { "value": { "data": [ { "mapperSetId": "ms_123456", "displayName": "User Mapper Set", "description": null, "linkedSources": [] }, { "mapperSetId": "ms_789012", "displayName": "Employee Mapper Set", "description": "Mapper set for employee identities", "linkedSources": [] }, { "mapperSetId": "ms_345678", "displayName": "Contractor Mapper Set", "description": null, "linkedSources": [] }, { "mapperSetId": "ms_901234", "displayName": "Partner Mapper Set", "description": "Mapper set for partner identities", "linkedSources": [] } ] } } } } } }, "401": { "description": "Unauthorized", "headers": { "x-request-id": { "schema": { "type": "string" }, "description": "The ID of the request" } } }, "403": { "description": "Forbidden", "headers": { "x-request-id": { "schema": { "type": "string" }, "description": "The ID of the request" } } }, "404": { "description": "Object not found", "headers": { "x-request-id": { "schema": { "type": "string" }, "description": "The ID of the request" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "validationError": { "$ref": "#/components/examples/TemplateMapperSetNotFoundError" } } } } }, "500": { "description": "Internal Server Error", "headers": { "x-request-id": { "schema": { "type": "string" }, "description": "The ID of the request" } } } } } } }, "components": { "schemas": { "MapperSetListResponse": { "type": "object", "description": "Response payload for Mapper Sets list", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MapperSet" } }, "meta": { "$ref": "#/components/schemas/meta" } } }, "ErrorResponse": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "string" } } }, "MapperSet": { "type": "object", "description": "Mapper Set", "required": [ "mapperSetId", "displayName", "linkedSources" ], "properties": { "mapperSetId": { "type": "string", "description": "Identity Mapper Set Unique Identifier." }, "displayName": { "type": "string", "description": "Display name for the Mapper Set" }, "description": { "type": "string", "nullable": "true", "description": "Description of the Mapper Set", "maxLength": "200" }, "linkedSources": { "type": "array", "description": "List of linked sources for the Mapper Set", "items": { "type": "object", "required": [ "sourceId", "sourceUsedAs", "mappers" ], "properties": { "sourceId": { "type": "string", "description": "Source identifier. This can be found in the relevant Source in your Identities Workspace Settings." }, "sourceUsedAs": { "type": "string", "enum": [ "BASE", "MAIN", "AUX", "CONTEXT" ], "description": "How the source is used in the mapping" }, "additionalProps": { "type": "object", "description": "Additional properties for the source", "properties": { "cacheDuration": { "type": "integer", "description": "Cache duration in minutes" }, "isValidateUser": { "type": "boolean", "description": "Whether to validate the user in MAIN source only" } } }, "mappers": { "type": "array", "description": "List of Mappers for the Source", "items": { "type": "object", "required": [ "type", "mappings" ], "properties": { "type": { "type": "string", "enum": [ "IDENTITY_ATTRIBUTES", "CORRELATION", "CONTEXT_FILTERS" ], "description": "Type of mapper" }, "mappings": { "type": "array", "description": "List of Attribute mappings", "items": { "type": "object", "properties": { "origin": { "type": "string", "description": "Origin Attribute or expression" }, "target": { "type": "string", "description": "Target Attribute" }, "operator": { "type": "string", "description": "Operator for correlation (for correlation mappers)" }, "originMapper": { "type": "string", "description": "Origin mapper expression (for context filters mappers)" }, "isRequired": { "type": "boolean", "description": "If the Mapping is required (for context filters mappers)" }, "isExcludedFromCache": { "type": "boolean", "description": "Exclude from cache (for context filters mappers)" } } } } } } } } } } } }, "meta": { "type": "object", "description": "Response Meta", "properties": { "total": { "type": "integer", "description": "Total number of records" }, "limit": { "type": "integer", "description": "Limit the number of records returned" }, "offset": { "type": "integer", "description": "The starting point for return of records" } } } }, "examples": { "TemplateMapperSetNotFoundError": { "value": { "errors": [ { "code": "EMTMS-001", "id": "EQ7CMX", "status": "404", "name": "TemplateMapperSetNotFoundError", "message": "Template Mapper Set: [TMS] not found, Hint: did you mean [User, Target]" } ] } } }, "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "description": " For more details about Administration API Authentication, check out the Authentication APIs documentation