Update API Mapper ID

Prev Next
Patch
/api/1.0/api-mapper-sets/{envId}/{apiMapperSetId}/mappers/{mapperId}

Updates the mapperId of an existing API Mapper.

Notice

Accessing the API call 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.


    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 cURL sample before pasting into your API tool.

    Headers

    *Required
    Header Value cURL Line
    Accept `application/json` `-H "Accept:application/json"`
    Content-Type `application/json` `-H "Content-Type: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.

    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.

    apiMapperSetId
    stringRequired

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

    mapperId
    stringRequired

    API Mapper Unique Identifier. This can be found in the relevant Application's Mapper section.

    Body parameters

    JSON Patch array to update the mapperId.

    example
    [
      {
        "op": "replace",
        "path": "/mapperId",
        "value": "newMapperId"
      }
    ]
    Array of object
    object
    op
    string Required
    Valid values[ "replace" ]
    path
    string Required
    Valid values[ "/state" ]
    value
    boolean Required
    Defaulttrue
    Responses
    204

    No Content

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

    Bad Request

    Headers
    x-request-id
    string
    The ID of the request
    Expand All
    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

    Not Found

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

    Payload Validation Error

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

    Internal Server Error

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