Update Identity Source ID

New
  • Published on Dec 14, 2025
  • 2 minute(s) read
Prev Next
Patch
/api/1.0/identity-templates/{envId}/{identityTemplateId}/identity-sources/{identitySourceId}

Update the ID of a specific Identity Source for an Identity Template in the indicated Environment. This API is designed to support UPDATE operations for Identity Source IDs only. Only the sourceId field can be modified using this endpoint.

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.


    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"`
    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.

    identityTemplateId
    stringRequired

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

    identitySourceId
    stringRequired

    The Identity Source ID

    Body parameters

    Fields to patch in the Identity Source. Only sourceId can be updated.

    example
    [
  {
    "op": "replace",
    "path": "/sourceId",
    "value": "ds_users_updated"
  }
]
    Array of object

    Identity Source patch - only supports updating source ID

    object
    op
    string Required
    Valid values[ "replace" ]
    path
    string Required

    Only sourceId can be updated

    Valid values[ "/sourceId" ]
    value
    string Required

    New source ID value

    Responses
    204

    Successful operation

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

    Validation Error

    Headers
    x-request-id
    string
    The ID of the request
    uneditableSourceFieldError
    {
  "errors": [
    {
      "code": "EMIS-001",
      "id": "EQ7CMX",
      "status": "400",
      "name": "UnimportableSourceTypeError",
      "message": "Cannot import or modify source of unimportable type: [REQUEST_INPUT]"
    }
  ]
}
    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
    environmentNotFoundError
    {
  "errors": [
    {
      "code": "EMIT-003",
      "id": "EQ7CMX",
      "status": "404",
      "name": "EnvironmentNotFoundError",
      "message": "Environment: [2d4a0591-dfe4-45fb-8a69-d183f5c75c0d] doesn't exist"
    }
  ]
}
    identityTemplateNotFoundError
    {
  "errors": [
    {
      "code": "EMIT-002",
      "id": "EQ7CMX",
      "status": "404",
      "name": "IdentityTemplateNotFoundError",
      "message": "Identity Template: [User1] not found in Environment: [848aa1dd-3516-4dbe-b1bb-c32454302dc4], Hint: did you mean [User, Target]"
    }
  ]
}
    identitySourceNotFoundError
    {
  "errors": [
    {
      "code": "EMIS-007",
      "id": "EQ7CMX",
      "status": "404",
      "name": "IdentityTemplateEntityNotFoundError",
      "message": "Identity Source: [CALC] not found, Hint: did you mean: [REQUEST_INPUT, CALC0, ACCS-EXTERNAL]"
    }
  ]
}
    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
    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