Identity Propagation Store Metadata (LdapGateway)

POST {{apiPath}}/environments/{{envID}}/propagation/storeMetadata/LdapGateway

The POST /environments/{{envID}}/propagation/storeMetadata/LdapGateway endpoint returns metadata from the specified LDAP Gateway identity store.

A request body is required but should contain only the type of LDAP gateway. Any other content is ignored. LDAP gateways do not support dynamic metadata.

See the configuration object of Propagation store LDAP Gateway data model for full property descriptions.

Note: Currently, the only valid LDAP_TYPE values are PingDirectory and Microsoft Active Directory.

Request Body

{"LDAP_TYPE"=>"Microsoft Active Directory"}

RESPONSES

status: OK

{"information":{"imageUrl":"","key":"LdapGateway","version":"1.0","displayName":"LDAP Gateway Connector","identityProvider":false,"baseURLRequired":false,"connectionInformationRequired":false},"connectionProfiles":[{"connectionAttributes":[{"key":"GATEWAY_BASE_URL","displayLabel":"PingOne gateway service base URL","description":"PingOne gateway service base URL","required":true,"sensitive":false},{"key":"ENVIRONMENT_ID","displayLabel":"Environment ID","description":"Environment ID","required":true,"sensitive":false},{"key":"GATEWAY_ID","displayLabel":"Gateway ID","description":"Gateway ID","required":true,"sensitive":false},{"key":"OAUTH_URL","displayLabel":"OAuth URL","description":"OAuth URL","required":true,"sensitive":false},{"key":"CLIENT_ID","displayLabel":"Client ID","description":"Client ID","required":true,"sensitive":false},{"key":"CLIENT_SECRET","displayLabel":"Client secret","description":"Client secret","required":true,"sensitive":false},{"key":"LDAP_TYPE","displayLabel":"LDAP type","description":"LDAP type","required":true,"sensitive":false},{"key":"BASE_DN","displayLabel":"Base DN","description":"Base DN","required":true,"sensitive":false},{"key":"RDN_ATTRIBUTE","displayLabel":"Naming attribute for user DN","description":"Naming attribute for user DN","required":true,"sensitive":false},{"key":"ATTRIBUTE_METADATA","displayLabel":"User-defined attribute metadata","description":"User-defined attribute metadata","required":false,"sensitive":false}],"primary":false}],"attributeMetadata":{"capabilities":[{"type":"DELETE_USERS","maxResources":1},{"type":"CHECK_CONNECTION","maxResources":1},{"type":"CREATE_USERS","maxResources":1},{"type":"GET_CONNECTION_PROFILES","maxResources":1},{"type":"UPDATE_USERS","maxResources":1},{"type":"GET_USERS","maxResources":1},{"type":"GET_INFO","maxResources":1},{"type":"GET_ATTRIBUTES","maxResources":1}],"userAttributes":{"st":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"displayName":"st","key":"st"},"preferredLanguage":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"displayName":"Preferred Language","key":"preferredLanguage"},"telephoneNumber":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"displayName":"Telephone Number","key":"telephoneNumber"},"mail":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"displayName":"Mail","key":"mail"},"givenName":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"displayName":"Given Name","key":"givenName"},"postalCode":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"displayName":"Postal Code","key":"postalCode"},"mobile":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"displayName":"Mobile Phone","key":"mobile"},"active":{"type":"BOOLEAN","attributeType":"BOOLEAN","distinguishingAttribute":false,"creatable":true,"updateable":true,"displayName":"Active","key":"active","defaultValue":false},"cn":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"displayName":"cn","key":"cn"},"title":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"displayName":"Title","key":"title"},"l":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"displayName":"l","key":"l"},"uid":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":true,"creatable":true,"updateable":true,"displayName":"uid","key":"uid"},"street":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"displayName":"Street Address","key":"street"},"sn":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"displayName":"sn","key":"sn"}}},"_links":{"self":{"href":"https://api.pingone.com/v1/environments/envID/propagation/storeMetadata/LdapGateway"}}}