---
updatedAt: 2026-05-21T16:41:02.000Z
---

# Retrieve the global configuration for attribute mapping that can be overridden in individual identity providers.

The REST interface to retrieve all the configuration for attribute mapping. <br><br>Entitlements required: <b>tenantadmin or readIdentitySources</b>

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "version": "1.0.0",
    "description": "Federation",
    "title": "Federation"
  },
  "servers": [
    {
      "url": "https://{tenanturl}",
      "variables": {
        "tenanturl": {
          "default": "{tenant_url}",
          "description": "URL of your IBM Security Verify tenant"
        }
      }
    }
  ],
  "tags": [
    {
      "name": "Identity Provider Attribute Mappings"
    }
  ],
  "paths": {
    "/v1.0/config/identitysources/attributemappings": {
      "get": {
        "tags": [
          "Identity Provider Attribute Mappings"
        ],
        "summary": "Retrieve the global configuration for attribute mapping that can be overridden in individual identity providers.",
        "description": "The REST interface to retrieve all the configuration for attribute mapping. <br><br>Entitlements required: <b>tenantadmin or readIdentitySources</b>",
        "operationId": "getAttributeMappingsGlobalConfig",
        "responses": {
          "200": {
            "description": "Success. Configuration was reterived.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/IdentitySourceAttributeMappings"
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MessageResponse"
                }
              }
            }
          },
          "500": {
            "description": "The update failed because of an unexpected internal service error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InternalServiceError"
                }
              }
            }
          }
        },
        "x-category": "Federation",
        "x-publicAPI": "true"
      }
    }
  },
  "components": {
    "schemas": {
      "InternalServiceError": {
        "required": [
          "messageDescription",
          "messageId"
        ],
        "type": "object",
        "properties": {
          "messageId": {
            "type": "string",
            "description": "The message key identifier.",
            "example": "CSIAG5401E"
          },
          "messageDescription": {
            "type": "string",
            "description": "A requester locale-specific descriptive message.",
            "example": "CSIAH0601E An internal error occurred in the AuthBroker Service."
          }
        }
      },
      "MessageResponse": {
        "required": [
          "messageDescription",
          "messageId"
        ],
        "type": "object",
        "properties": {
          "messageId": {
            "type": "string",
            "description": "The message key identifier.",
            "example": "CSIAG5401E"
          },
          "messageDescription": {
            "type": "string",
            "description": "A requester locale-specific descriptive message.",
            "example": "CSIAG5401E The access token included in the request is not valid."
          }
        }
      },
      "GroupSource": {
        "type": "object",
        "properties": {
          "option": {
            "type": "string",
            "description": "Is the authoritative source of all group memberships. This can be Cloud Directory (CD) or an identity source (IDS) or a combination of both (CDIDS). This may also be a custom rule (custom).",
            "example": "CDIDS"
          },
          "custom": {
            "type": "string",
            "description": "The custom rule that will be referenced if the 'option' field is set to 'custom'. This is a script that can be authored to filter, say, certain groups like admin but more or less works like CDIDS."
          }
        }
      },
      "IdentitySourceAttributeMappings": {
        "required": [
          "attributeMappings"
        ],
        "type": "object",
        "properties": {
          "attributeMappings": {
            "type": "array",
            "description": "The list of attribute mapping objects.",
            "items": {
              "$ref": "#/components/schemas/AttributeMapping_0"
            }
          },
          "groupSource": {
            "$ref": "#/components/schemas/GroupSource"
          }
        }
      },
      "PostEval": {
        "required": [
          "custom",
          "id"
        ],
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "A valid attribute function. This will tranform the attribute mapping. Only one of 'id' or 'custom' can be set on an attribute mapping.",
            "example": "uppercase"
          },
          "custom": {
            "type": "string",
            "description": "A custom rule for transforming. This will tranform the attribute mapping. Only one of 'id' or 'custom' can be set on an attribute mapping."
          }
        }
      },
      "AttributeMapping_0": {
        "required": [
          "attrId",
          "idsAttrName",
          "jitpOption"
        ],
        "type": "object",
        "properties": {
          "attrId": {
            "type": "string",
            "description": "The IBM Security Verify Cloud Directory attribute identifier.",
            "example": "12"
          },
          "jitpOption": {
            "type": "string",
            "description": "The IBM Security Verify Cloud Directory attribute identifier.",
            "example": "ALWAYS",
            "enum": [
              "ALWAYS",
              "CREATE",
              "DISABLED",
              "NONE"
            ]
          },
          "idsAttrName": {
            "type": "string",
            "description": "The external identity source attribute name. Only required if identity source is not Cloud Directory.",
            "example": "dept"
          },
          "postEval": {
            "$ref": "#/components/schemas/PostEval"
          }
        }
      }
    }
  },
  "x-original-swagger-version": "2.0",
  "x-explorer-enabled": false
}
```