--- updatedAt: 2026-06-04T14:00:57.000Z --- # Get an IDP directory Gets the specified IDP directory. # 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/idpdirectory/{idpdirectory_id}": { "get": { "description": "Gets the specified IDP directory.", "externalDocs": { "description": "See documentation for this operation in Akamai's Enterprise Application Access API", "url": "https://techdocs.akamai.com/eaa-api/reference/get-idp-directory" }, "operationId": "get-idp-directory", "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": { "admin_user": null, "agents": [], "api_key": null, "attribute_map": { "user.countryCode": "cloud.US", "user.email": "cloud.asmith@tech.com", "user.firstName": "cloud.anne", "user.lastName": "cloud.smith", "user.netbios": "cloud.netbios", "user.persistentId": "cloud.uuid", "user.phoneNumber": "cloud.8005551213", "user.samAccountName": "cloud.annesmith", "user.userPrincipleName": "cloud.annesmith" }, "auth_request_signed": false, "auth_response_encrypt": false, "chase_referral": false, "cname": null, "company_id": null, "conf_state": 1, "created_at": "2017-01-04T14:58:29.884927", "description": null, "dialin_sni": null, "directory_status": 3, "directory_type": 1, "domains": [], "global_catalog": false, "group_base_dn": null, "group_count": 11, "group_members": "asmith", "group_name": "cn", "group_object_classes": [ "group", "groupOfNames" ], "group_search_filter": "(objectClass=group)", "group_token": "primaryGroupToken", "host": null, "kerb_realms": [], "last_sync": "2017-01-04T14:58:29.885037", "logout_url": null, "metadata": null, "mfa": "off", "modified_at": "2018-05-18T04:37:13.487706", "name": "Cloud Directory", "nameidformat": null, "ou_attr": null, "ou_filter": null, "ou_object_classes": [ "organizationalUnit" ], "password_change_allow": false, "password_change_threshold": 0, "password_complexity_message": null, "password_expire_warn_threshold": 0, "password_filter": { "min-char-groups": 2, "min-lower": 1, "min-num": 2, "min-other": 0, "min-special": 1, "min-upper": 1, "name-check": true, "uid-check": true }, "password_policy_default": "", "password_reset_allow": false, "port": 636, "resource": "directories", "resource_uri": { "groups": "/api/v1/directories/U59wJq3dQNuanDH8VMc1Gg/groups/", "href": "/api/v1/directories/U59wJq3dQNuanDH8VMc1Gg", "users": "/api/v1/directories/U59wJq3dQNuanDH8VMc1Gg/users/" }, "root_dn": null, "schema_attributes": "{}", "server_cert_validate": true, "service": 6, "signed_request": false, "ssl": true, "status": 1, "sync_interval": 21600, "sync_state": 1, "user_base_dn": null, "user_count": 11, "user_display_name": "Anne Smith", "user_email": "asmith@tech.com", "user_fname": "Anne", "user_lname": "smith", "user_memberof": "US_IT", "user_memberuid": "asmith", "user_object_classes": [ "person", "organizationalPerson", "user", "inetOrgPerson" ], "user_phone_num": "8005551213", "user_principal": "asmith", "user_samaccountname": "asmith", "user_search_filter": "(&(objectClass=user)(objectClass=person))", "user_upn": "asmith", "uuid_url": "U59wJq3dQNuanDH8VMc1Gg" }, "schema": { "additionalProperties": false, "description": "Enterprise Access IDP directory information.", "properties": { "admin_pwd": { "description": "The administrator user password for the IDP directory.", "minLength": 0, "nullable": true, "type": "string" }, "admin_user": { "description": "The administrator user account for the IDP directory.", "minLength": 0, "nullable": true, "type": "string" }, "agents": { "description": "Connectors assigned to this IDP directory.", "items": { "additionalProperties": false, "properties": { "agent_infra_type": { "default": 1, "description": "The type of connector. Either `1` for VM, `2` for IPSEC, or `3` for GRE.", "enum": [ 1, 2, 3 ], "type": "integer" }, "created_at": { "description": "__Read-only__ ISO 8601 timestamp marking the connector's creation.", "readOnly": true, "type": "string" }, "name": { "description": "The name of the connector.", "minLength": 1, "type": "string" }, "package": { "description": "Type of package for the connector. Refer to [Connector package types](https://techdocs.akamai.com/eaa-api/reference/connector-package-types) for available values.", "enum": [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11 ], "type": "integer" }, "reach": { "default": 1, "description": "Connector reachability status. Either `0` for unreachable or `1` for reachable.", "enum": [ 0, 1 ], "type": "integer" }, "state": { "default": 0, "description": "State of the connector. Either `0` for not created, `1` for created, `2` for not installed, `3` for not verified, `4` for verified, `5` for unenrolled, `6` for enrolled, `7` for not configured, or `8` for configured.", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8 ], "type": "integer" }, "status": { "description": "Status of the connector. Either `0` for disabled or `1` for enabled.", "enum": [ 0, 1 ], "type": "integer" }, "uuid_url": { "description": "A unique identifier for the connector.", "minLength": 1, "type": "string" } }, "required": [ "name", "uuid_url" ], "type": "object" }, "minItems": 0, "type": "array" }, "api_key": { "description": "The API key of the IDP directory.", "minLength": 0, "nullable": true, "type": "string" }, "attribute_map": { "additionalProperties": false, "description": "The attribute mapping for the IDP directory.", "properties": { "eaa.demo": { "description": "The user's EAA demo name.", "type": "string" }, "eaa.test": { "description": "The user's EAA test name.", "type": "string" }, "user.countryCode": { "description": "The user's country code.", "minLength": 1, "type": "string" }, "user.email": { "description": "The user's email address.", "type": "string" }, "user.firstName": { "description": "The user's first name.", "minLength": 1, "type": "string" }, "user.groups": { "description": "The groups the user belongs to.", "type": "string" }, "user.lastName": { "description": "The user's last name.", "minLength": 1, "type": "string" }, "user.netbios": { "description": "The user's NetBIOS name.", "minLength": 0, "type": "string" }, "user.persistentId": { "description": "The user persistent ID.", "minLength": 1, "type": "string" }, "user.phoneNumber": { "description": "The user's phone number.", "minLength": 1, "type": "string" }, "user.samAccountName": { "description": "The user's Security Account Manager (SAM) account name.", "minLength": 1, "type": "string" }, "user.userName": { "description": "The username.", "type": "string" }, "user.userPrincipleName": { "description": "The user's principle name.", "minLength": 1, "type": "string" } }, "required": [ "user.countryCode", "user.email", "user.firstName", "user.lastName", "user.netbios", "user.persistentId", "user.phoneNumber", "user.samAccountName", "user.userPrincipleName" ], "type": "object" }, "auth_request_signed": { "description": "Indicates a signed authentication request.", "type": "boolean" }, "auth_response_encrypt": { "description": "Enables authentication response encryption.", "type": "boolean" }, "chase_referral": { "description": "Enables referral chasing.", "type": "boolean" }, "cname": { "description": "The IDP directory cname.", "minLength": 0, "nullable": true, "type": "string" }, "company_id": { "description": "The company ID of the IDP directory.", "minLength": 0, "nullable": true, "type": "string" }, "conf_state": { "description": "The configuration state of the IDP directory. Either `0` for not configured or `1` for configured.", "enum": [ 0, 1 ], "type": "integer" }, "created_at": { "description": "ISO 8601 timestamp marking the IDP directory object's creation.", "nullable": true, "type": "string" }, "description": { "description": "A description of the directory object.", "nullable": true, "type": "string" }, "dialin_sni": { "description": "The dial-in SNI for the IDP directory.", "minLength": 0, "nullable": true, "type": "string" }, "directories": { "description": "The unique IDs of the directories for the IDP.", "items": { "type": "string" }, "type": "array" }, "directory_status": { "description": "The status of the directory. Either `1` for not added, `2` for added, `3` for no agent, `4` for pending, `5` for unreachable, or `6` for okay.", "enum": [ 1, 2, 3, 4, 5, 6 ], "type": "integer" }, "directory_type": { "default": 2, "description": "The type of directory. Either `1` for cloud, `2` for enterprise, `3` for third party, `4` for Akamai, or `5` for Akamai MSP.", "enum": [ 1, 2, 3, 4, 5 ], "type": "integer" }, "domains": { "description": "The directory's domains.", "items": { "additionalProperties": false, "properties": { "name": { "description": "The domain name.", "type": "string" } }, "type": "object" }, "type": "array" }, "global_catalog": { "description": "Enables global catalog.", "type": "boolean" }, "group_base_dn": { "description": "The base Distinguished Name (DN) that identifies the group entry in an IDP directory. A series of comma-delimited pairs formed as `key=value`.", "minLength": 0, "nullable": true, "type": "string" }, "group_count": { "description": "The number of groups for the IDP directory.", "minimum": 0, "type": "integer" }, "group_members": { "description": "The members of the group.", "minLength": 1, "type": "string" }, "group_name": { "description": "The name of the group.", "minLength": 1, "type": "string" }, "group_object_classes": { "description": "Group object classes that define custom LDAP mappings of users and groups.", "items": { "minLength": 0, "type": "string" }, "type": "array" }, "group_search_filter": { "description": "The search filter for the group, such as `(objectClass=group)`.", "minLength": 1, "type": "string" }, "group_token": { "description": "The primary group token.", "minLength": 1, "type": "string" }, "host": { "description": "The IDP directory host.", "minLength": 0, "nullable": true, "type": "string" }, "idp": { "description": "The unique ID of the IDP to assign to the directory.", "type": "string" }, "kerb_realms": { "description": "Kerberos realms for the IDP directory.", "items": { "additionalProperties": false, "properties": { "kdclist": { "additionalProperties": false, "description": "Kerberos Key Distribution Centers (KDC) information.", "properties": { "ip": { "description": "The IP address of the KDC.", "type": "string" }, "port": { "description": "The port number of the KDC.", "minimum": 0, "type": "integer" } }, "required": [ "ip", "port" ], "type": "object" }, "realm": { "description": "The kerberos realm.", "minLength": 1, "type": "string" } }, "required": [ "kdclist", "realm" ], "type": "object" }, "minItems": 0, "type": "array" }, "last_sync": { "description": "ISO 8601 timestamp marking the IDP directory's last synchronization.", "type": "string" }, "logout_url": { "description": "The logout URL for the directory.", "minLength": 0, "nullable": true, "type": "string" }, "metadata": { "description": "The IDP directory metadata.", "minLength": 0, "nullable": true, "type": "string" }, "mfa": { "description": "Enables multifactor authentication. Either an `on` or `off` string.", "enum": [ "on", "off" ], "type": "string" }, "modified_at": { "description": "ISO 8601 timestamp marking the directory's last modification.", "type": "string" }, "name": { "description": "The name of the IDP directory.", "minLength": 1, "type": "string" }, "nameidformat": { "description": "The name ID format.", "minLength": 0, "nullable": true, "type": "string" }, "ou_attr": { "description": "The organization unit's attributes.", "minLength": 0, "nullable": true, "type": "string" }, "ou_filter": { "description": "The organization unit to filter by. Specify `null` if you want to provide this later.", "minLength": 0, "nullable": true, "type": "string" }, "ou_object_classes": { "description": "The organization unit's object classes.", "items": { "minLength": 1, "type": "string" }, "minItems": 1, "type": "array" }, "password_change_allow": { "description": "Allows password changes.", "type": "boolean" }, "password_change_threshold": { "description": "The password change threshold in seconds.", "minimum": 0, "type": "integer" }, "password_complexity_message": { "description": "The password complexity message.", "minLength": 0, "nullable": true, "type": "string" }, "password_expire_warn_threshold": { "description": "The password expiration warning threshold in seconds.", "minimum": 0, "type": "integer" }, "password_filter": { "additionalProperties": false, "description": "The password format requirement filters.", "properties": { "min-char-groups": { "description": "Minimum number of character groups for the password.", "minimum": 2, "type": "integer" }, "min-lower": { "description": "Minimum number of lowercase characters for the password.", "minimum": 1, "type": "integer" }, "min-num": { "description": "Minimum number of digits for the password.", "minimum": 2, "type": "integer" }, "min-other": { "description": "Minimum number of other characters for the password.", "minimum": 0, "type": "integer" }, "min-special": { "description": "Minimum number of special characters for the password.", "minimum": 1, "type": "integer" }, "min-upper": { "description": "Minimum number of uppercase characters for the password.", "minimum": 1, "type": "integer" }, "name-check": { "description": "Checks whether the password contains the user's name.", "type": "boolean" }, "uid-check": { "description": "Checks whether the password contains the user ID.", "type": "boolean" } }, "type": "object" }, "password_policy_default": { "description": "The default password policy for the IDP directory.", "minLength": 0, "type": "string" }, "password_reset_allow": { "description": "Whether to allow password reset.", "type": "boolean" }, "port": { "description": "The port number of the IDP directory.", "minimum": 0, "type": "integer" }, "resource": { "description": "The IDP directory resource name.", "minLength": 1, "type": "string" }, "resource_uri": { "additionalProperties": false, "description": "Specifies the location of various IDP directory resources.", "properties": { "groups": { "description": "The URL for group details.", "minLength": 1, "type": "string" }, "href": { "description": "The URL for IDP directory details.", "minLength": 1, "type": "string" }, "idp": { "description": "The URL for the IDP.", "minLength": 1, "type": "string" }, "users": { "description": "The URL for the list of users.", "minLength": 1, "type": "string" } }, "required": [ "groups", "href", "users" ], "type": "object" }, "root_dn": { "description": "The root distinguished name of the IDP directory. A series of comma-delimited pairs formed as `key=value`.", "minLength": 0, "nullable": true, "type": "string" }, "schema_attributes": { "description": "The directory schema attributes.", "minLength": 1, "type": "string" }, "server_cert_validate": { "description": "Whether to validate server certificates.", "type": "boolean" }, "service": { "description": "The type of directory service. Refer to [Directory service configuration](https://techdocs.akamai.com/eaa-api/reference/directory-configuration) for available values.", "enum": [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11 ], "type": "integer" }, "signed_request": { "description": "Whether the request is signed.", "type": "boolean" }, "ssl": { "description": "Enables SSL.", "type": "boolean" }, "status": { "description": "The directory status. Either `0` for disabled or `1` for enabled.", "enum": [ 0, 1 ], "type": "integer" }, "sync_interval": { "description": "The synchronization interval of the IDP directory in seconds.", "minimum": 0, "type": "integer" }, "sync_state": { "description": "The IDP directory synchronization state. Refer to [Directory service configuration](https://techdocs.akamai.com/eaa-api/reference/directory-configuration) for available values.", "enum": [ 1, 2, 3, 4, 5, 6 ], "type": "integer" }, "user_base_dn": { "description": "The base distinguished name of a user. A series of comma-delimited pairs formed as `key=value`.", "minLength": 0, "nullable": true, "type": "string" }, "user_count": { "description": "The total count of users in the IDP directory.", "minimum": 0, "type": "integer" }, "user_display_name": { "description": "The display name of a user.", "minLength": 1, "type": "string" }, "user_email": { "description": "The email of a user.", "type": "string" }, "user_fname": { "description": "The first name of a user.", "minLength": 1, "type": "string" }, "user_lname": { "description": "The last name of a user.", "minLength": 1, "type": "string" }, "user_memberof": { "description": "The member status of a user.", "minLength": 1, "type": "string" }, "user_memberuid": { "description": "The member UID of a user.", "minLength": 1, "type": "string" }, "user_object_classes": { "description": "The user's object class.", "items": { "minLength": 1, "type": "string" }, "minItems": 1, "type": "array" }, "user_phone_num": { "description": "The phone number of a user.", "minLength": 1, "type": "string" }, "user_principal": { "description": "The login of a user.", "minLength": 1, "type": "string" }, "user_samaccountname": { "description": "The kerberos client principal name.", "minLength": 1, "type": "string" }, "user_search_filter": { "description": "The search filter for a user.", "minLength": 1, "type": "string" }, "user_upn": { "description": "The principal name of a user.", "minLength": 1, "type": "string" }, "uuid_url": { "description": "A unique identifier for the directory.", "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/idpdirectory.yaml" } } } }, "description": "Successful operation." } }, "summary": "Get an IDP directory", "tags": [ "IDP directories" ] }, "parameters": [ { "description": "A unique identifier for each IDP directory.", "in": "path", "name": "idpdirectory_id", "required": true, "schema": { "example": "xz_Hq325SNeSno6Wss9Phg", "type": "string" }, "x-akamai": { "file-path": "parameters/idpdirectory-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/idp-directory.yaml", "path-info": "/mgmt-pop/idpdirectory/{idpdirectory_id}" } } }, "servers": [ { "url": "https://{hostname}/crux/v1" } ], "tags": [ { "description": "Manage identity provider directories.", "name": "IDP directories" } ], "x-akamai": { "auth-type": "EDGE_GRID", "file-path": "01-idp.yaml" }, "x-readme": { "explorer-enabled": false, "samples-languages": [ "curl", "python", "node" ] } } ``` # Sibling pages * [Create an IDP directory](https://techdocs.akamai.com/eaa-api/reference/post-idp-directory-1.md) * [List IDP directories](https://techdocs.akamai.com/eaa-api/reference/get-idp-directories-1.md) * [Modify an IDP directory](https://techdocs.akamai.com/eaa-api/reference/put-idp-directory-1.md) * [Delete an IDP directory](https://techdocs.akamai.com/eaa-api/reference/delete-idp-directory-1.md)