Update Identity Mapper Set ID

New
  • Published on Dec 14, 2025
  • 1 minute(s) read
Prev Next
Patch
/api/1.0/identity-templates/{envId}/{identityTemplateId}/mapper-sets/{identityMapperSetId}

Update Mapper Set for a specific Template in the indicated Environment. This API is designed to support PATCH operations for Mapper Set.

Notice

Accessing the APIs is through a dedicated domain/URL, according to your PlainID Tenant Location
  • United States (US) - `https://api.us1.plainid.io`
  • Canada (CA) - `https://api.ca1.plainid.io`
  • Europe (EU) - `https://api.eu1.plainid.io`

    • Using 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.


    '
    Security
    HTTP
    Type bearer

    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

    Path parameters
    envId
    string (uuid) Required

    The Environment ID can be found under the Details Tab in the Environment Settings.

    identityTemplateId
    stringRequired

    The Identity Template ID. This can be found in the Details tab in the Identity Workspace Settings.

    identityMapperSetId
    stringRequired

    The Mapper Set ID. This can be found in the Identity Workspace Settings under the relevent Mapper Set.

    Body parameters
    Switch Mapper Set ID
    [
  {
    "op": "replace",
    "path": "/mapperSetId",
    "value": "ms_456"
  }
]
    Array of object
    object
    op
    string Required
    Valid values[ "replace" ]
    path
    string Required
    Valid values[ "/mapperSetId" ]
    value
    boolean Required
    Defaulttrue
    Responses
    204

    Success - No Content

    400

    Validation Error

    Headers
    x-request-id
    string
    The ID of the request
    Expand All
    object

    Response object

    errors
    Array of object (Error)
    object
    code
    string
    id
    string
    status
    integer
    name
    string
    message
    string
    args
    object
    path
    string
    401

    Unauthorized

    Headers
    x-request-id
    string
    The ID of the request
    403

    Forbidden

    Headers
    x-request-id
    string
    The ID of the request
    404

    Object not found

    Headers
    x-request-id
    string
    The ID of the request
    validationError
    {
  "errors": [
    {
      "code": "EMTMS-001",
      "id": "EQ7CMX",
      "status": "404",
      "name": "TemplateMapperSetNotFoundError",
      "message": "Template Mapper Set: [TMS] not found, Hint: did you mean [User, Target]"
    }
  ]
}
    Expand All
    object

    Response object

    errors
    Array of object (Error)
    object
    code
    string
    id
    string
    status
    integer
    name
    string
    message
    string
    args
    object
    path
    string
    500

    Internal Server Error

    Headers
    x-request-id
    string
    The ID of the request