---
updatedAt: 2026-06-04T14:00:57.000Z
---

# Get an IdP directory membership

Retrieves associated directory membership of an IdP.

# OpenAPI definition

```json
{
  "externalDocs": {
    "description": "See documentation for Akamai's Enterprise Application Access API",
    "url": "https://techdocs.akamai.com/eaa-api/reference"
  },
  "info": {
    "license": {
      "name": "Apache 2.0",
      "url": "https://www.apache.org/licenses/LICENSE-2.0.html"
    },
    "title": "Identity providers (IDPs)",
    "version": "v1"
  },
  "openapi": "3.0.0",
  "paths": {
    "/mgmt-pop/idp/{idp_id}/directories_membership": {
      "get": {
        "description": "Retrieves associated directory membership of an IdP.",
        "externalDocs": {
          "description": "See documentation for this operation in Akamai's Enterprise Application Access API",
          "url": "https://techdocs.akamai.com/eaa-api/reference/get-idp-directories-membership"
        },
        "operationId": "get-idp-directories-membership",
        "parameters": [
          {
            "description": "The Akamai contract identifier for your Enterprise Application Access product.",
            "in": "query",
            "name": "contractId",
            "required": true,
            "schema": {
              "example": "K-0N7RAK7",
              "type": "string"
            },
            "x-akamai": {
              "file-path": "parameters/contract-id-query.yaml"
            }
          },
          {
            "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).",
            "in": "query",
            "name": "accountSwitchKey",
            "required": false,
            "schema": {
              "example": "1-5C0YLB:1-8BYUX",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "example": {
                  "meta": {
                    "limit": 20,
                    "next": null,
                    "offset": 0,
                    "previous": null,
                    "total_count": 1
                  },
                  "objects": [
                    {
                      "directory": {
                        "directory_uuid_url": "GbIfrXwtTKaqBrXD0ZkGBA",
                        "name": "Cloud Directory"
                      },
                      "idp": {
                        "idp_uuid_url": "6IlO8WcjS3iOgWYi55bMOw",
                        "name": "regv3ds"
                      },
                      "resource": "idpdirectory",
                      "resource_uri": {
                        "directory": "/api/v1/directory/GbIfrXwtTKaqBrXD0ZkGBA",
                        "href": "/api/v1/idpdirectory/hp7EQTGxThCzRmWFNsd-1A",
                        "idp": "/api/v1/idp/6IlO8WcjS3iOgWYi55bMOw"
                      },
                      "uuid_url": "hp7EQTGxThCzRmWFNsd-1A"
                    }
                  ]
                },
                "schema": {
                  "additionalProperties": false,
                  "description": "IdP directory memberships.",
                  "properties": {
                    "ListView": {
                      "additionalProperties": false,
                      "description": "List view properties.",
                      "properties": {
                        "meta": {
                          "description": "Paging properties.",
                          "type": "string"
                        },
                        "objects": {
                          "description": "IdP directory properties.",
                          "type": "string"
                        }
                      },
                      "type": "object"
                    },
                    "meta": {
                      "additionalProperties": false,
                      "description": "Paging properties.",
                      "properties": {
                        "limit": {
                          "description": "Used for pagination. The total number of list members after the offset in the request.",
                          "type": "integer"
                        },
                        "next": {
                          "description": "URI of the next page relative to the current page settings.",
                          "nullable": true,
                          "type": "string"
                        },
                        "offset": {
                          "description": "Used for pagination. Indicates the first member of the underlying object list in the request.",
                          "type": "integer"
                        },
                        "previous": {
                          "description": "URI of the previous page relative to the current page settings.",
                          "nullable": true,
                          "type": "string"
                        },
                        "total_count": {
                          "description": "Total item count for the collection.",
                          "type": "integer"
                        }
                      },
                      "type": "object"
                    },
                    "objects": {
                      "description": "Directory memberships.",
                      "items": {
                        "additionalProperties": false,
                        "description": "IdP associated directories.",
                        "properties": {
                          "directory": {
                            "additionalProperties": false,
                            "description": "IdP directory properties.",
                            "properties": {
                              "directory_uuid_url": {
                                "description": "The directory's unique ID.",
                                "type": "string"
                              },
                              "name": {
                                "description": "The directory name.",
                                "type": "string"
                              }
                            },
                            "type": "object"
                          },
                          "idp": {
                            "additionalProperties": false,
                            "description": "IdP properties.",
                            "properties": {
                              "idp_uuid_url": {
                                "description": "The unique IdP ID.",
                                "type": "string"
                              },
                              "name": {
                                "description": "The IdP name.",
                                "type": "string"
                              }
                            },
                            "type": "object"
                          },
                          "resource": {
                            "description": "The resource name.",
                            "type": "string"
                          },
                          "resource_uri": {
                            "additionalProperties": false,
                            "description": "Resource URIs for the IdP.",
                            "properties": {
                              "directory": {
                                "description": "The directory's resource ID.",
                                "type": "string"
                              },
                              "href": {
                                "description": "The resource's URL.",
                                "type": "string"
                              },
                              "idp": {
                                "description": "The IdP's resource ID.",
                                "type": "string"
                              }
                            },
                            "type": "object"
                          },
                          "uuid_url": {
                            "description": "The resource ID.",
                            "type": "string"
                          }
                        },
                        "type": "object",
                        "x-akamai": {
                          "file-path": "schemas/idp-directories-membership.yaml"
                        }
                      },
                      "type": "array"
                    }
                  },
                  "type": "object",
                  "x-akamai": {
                    "file-path": "schemas/idp-directories-memberships.yaml"
                  }
                }
              }
            },
            "description": "Successful response."
          }
        },
        "summary": "Get an IdP directory membership",
        "tags": [
          "Directory membership"
        ]
      },
      "parameters": [
        {
          "description": "A unique identifier for the IdP.",
          "in": "path",
          "name": "idp_id",
          "required": true,
          "schema": {
            "example": "ojxkXzwyQZiBkoRee0XcnA",
            "type": "string"
          },
          "x-akamai": {
            "file-path": "parameters/idp-id-path.yaml"
          }
        }
      ],
      "x-akamai": {
        "file-path": "paths/directories-membership.yaml",
        "path-info": "/mgmt-pop/idp/{idp_id}/directories_membership"
      }
    }
  },
  "servers": [
    {
      "url": "https://{hostname}/crux/v1"
    }
  ],
  "tags": [
    {
      "description": "Manage group membership within a directory.",
      "name": "Directory membership"
    }
  ],
  "x-akamai": {
    "auth-type": "EDGE_GRID",
    "file-path": "01-idp.yaml"
  },
  "x-readme": {
    "explorer-enabled": false,
    "samples-languages": [
      "curl",
      "python",
      "node"
    ]
  }
}
```