---
updatedAt: 2026-06-15T13:51:20.000Z
agentTools:
  siteIndex: https://developer.jamf.com/llms.txt
  projectIndex: https://developer.jamf.com/jamf-pro/llms.txt
---

# Get mappings configurations for Cloud Identity Providers server configuration.

Get all mappings configurations for Cloud Identity Providers server configuration.

> 📋 **Required privilege:** Read LDAP Servers

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Jamf Pro API",
    "termsOfService": "https://www.jamf.com/developer-resources/api-license-agreement",
    "version": "11.33.0"
  },
  "servers": [
    {
      "url": "https://yourServer.jamfcloud.com/api"
    }
  ],
  "x-readme": {
    "samples-languages": [
      "curl",
      "swift",
      "ruby",
      "python"
    ],
    "explorer-enabled": false
  },
  "security": [
    {
      "Bearer": []
    },
    {
      "ApiClient": []
    },
    {
      "BasicAuth": [
        "/v1/auth/token"
      ]
    }
  ],
  "paths": {
    "/v2/cloud-ldaps/{id}/mappings": {
      "get": {
        "tags": [
          "cloud-ldap"
        ],
        "summary": "Get mappings configurations for Cloud Identity Providers server configuration.",
        "description": "Get all mappings configurations for Cloud Identity Providers server configuration.\n\n> 📋 **Required privilege:** Read LDAP Servers",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "Cloud Identity Provider identifier",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Cloud Identity Provider mappings configuration returned.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CloudLdapMappingsResponse"
                }
              }
            }
          },
          "400": {
            "description": "Id can only be a number.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "404": {
            "description": "Specified mappings settings for Cloud Identity Provider configuration do not exist.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          }
        },
        "x-required-privileges": [
          "Read LDAP Servers"
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "ApiError": {
        "type": "object",
        "properties": {
          "httpStatus": {
            "type": "integer",
            "description": "HTTP status of the response",
            "example": 400
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ApiErrorCause"
            }
          }
        }
      },
      "ApiErrorCause": {
        "required": [
          "field"
        ],
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "description": "Error-specific code that can be used to identify localization string, etc.",
            "example": "8675309"
          },
          "field": {
            "type": "string",
            "description": "Name of the field that caused the error.",
            "example": "Name"
          },
          "description": {
            "type": "string",
            "description": "A general description of error for troubleshooting/debugging. Generally this text should not be displayed to a user; instead refer to errorCode and it's localized text",
            "example": "I've just picked up a fault in the AE35 unit. It's going to go 100% failure in 72 hours"
          },
          "id": {
            "type": "string",
            "description": "id of object with error. Optional.",
            "nullable": true,
            "example": "3"
          }
        }
      },
      "CloudLdapMappingsResponse": {
        "type": "object",
        "properties": {
          "userMappings": {
            "$ref": "#/components/schemas/UserMappings"
          },
          "groupMappings": {
            "$ref": "#/components/schemas/GroupMappings"
          },
          "membershipMappings": {
            "$ref": "#/components/schemas/MembershipMappings"
          }
        },
        "description": "Mappings configuration response for Ldap Cloud Identity Provider configuration"
      },
      "GroupMappings": {
        "required": [
          "groupID",
          "groupName",
          "groupUuid",
          "objectClassLimitation",
          "objectClasses",
          "searchBase",
          "searchScope"
        ],
        "type": "object",
        "properties": {
          "objectClassLimitation": {
            "type": "string",
            "example": "ANY_OBJECT_CLASSES",
            "enum": [
              "ANY_OBJECT_CLASSES",
              "ALL_OBJECT_CLASSES"
            ]
          },
          "objectClasses": {
            "type": "string",
            "example": "groupOfNames"
          },
          "searchBase": {
            "type": "string",
            "example": "ou=Groups"
          },
          "searchScope": {
            "type": "string",
            "example": "ALL_SUBTREES",
            "enum": [
              "ALL_SUBTREES",
              "FIRST_LEVEL_ONLY"
            ]
          },
          "groupID": {
            "type": "string",
            "example": "cn"
          },
          "groupName": {
            "type": "string",
            "example": "cn"
          },
          "groupUuid": {
            "type": "string",
            "example": "gidNumber"
          }
        },
        "description": "Cloud Identity Provider user group mappings configuration"
      },
      "MembershipMappings": {
        "required": [
          "groupMembershipMapping"
        ],
        "type": "object",
        "properties": {
          "groupMembershipMapping": {
            "type": "string",
            "example": "memberOf"
          }
        },
        "description": "Cloud Identity Provider user group membership mappings configuration"
      },
      "UserMappings": {
        "required": [
          "building",
          "department",
          "emailAddress",
          "objectClassLimitation",
          "objectClasses",
          "phone",
          "position",
          "realName",
          "room",
          "searchBase",
          "searchScope",
          "userID",
          "userUuid",
          "username"
        ],
        "type": "object",
        "properties": {
          "objectClassLimitation": {
            "type": "string",
            "example": "ANY_OBJECT_CLASSES",
            "enum": [
              "ANY_OBJECT_CLASSES",
              "ALL_OBJECT_CLASSES"
            ]
          },
          "objectClasses": {
            "type": "string",
            "example": "inetOrgPerson"
          },
          "searchBase": {
            "type": "string",
            "example": "ou=Users"
          },
          "searchScope": {
            "type": "string",
            "example": "ALL_SUBTREES",
            "enum": [
              "ALL_SUBTREES",
              "FIRST_LEVEL_ONLY"
            ]
          },
          "additionalSearchBase": {
            "type": "string",
            "default": ""
          },
          "userID": {
            "type": "string",
            "example": "mail"
          },
          "username": {
            "type": "string",
            "example": "uid"
          },
          "realName": {
            "type": "string",
            "example": "displayName"
          },
          "emailAddress": {
            "type": "string",
            "example": "mail"
          },
          "department": {
            "type": "string",
            "example": "departmentNumber"
          },
          "building": {
            "type": "string",
            "default": ""
          },
          "room": {
            "type": "string",
            "default": ""
          },
          "phone": {
            "type": "string",
            "default": ""
          },
          "position": {
            "type": "string",
            "example": "title"
          },
          "userUuid": {
            "type": "string",
            "example": "uid"
          }
        },
        "description": "Cloud Identity Provider user mappings configuration"
      }
    },
    "securitySchemes": {
      "Bearer": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      },
      "BasicAuth": {
        "type": "http",
        "description": "Basic auth is used only for obtaining bearer tokens from the /v1/auth/token endpoint",
        "scheme": "basic"
      },
      "ApiClient": {
        "type": "oauth2",
        "description": "Jamf Pro API Roles and Clients provide a client ID and secret for obtaining access tokens using the OAuth2 client_credentials grant type",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "/api/v1/oauth/token",
            "scopes": {}
          }
        }
      }
    }
  }
}
```