Identity Propagation Store Metadata (AzureActiveDirectorySAML2)

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

The POST /environments/{{envID}}/propagation/storeMetadata/AzureActiveDirectorySAML2 endpoint returns metadata from the specified Azure Active Directory SAML2 identity store.

Prerequisites

• See Identity Propagation (Provisioning) for important overview information.

See the Propagation store Azure Active Directory SAML V2.0 configuration data model for full property descriptions.

Use the current or proposed configuration in the body to return static and dynamic metadata, or an empty body ({}) to retrieve only static metadata.

RESPONSES

status: OK

{"information":{"imageUrl":"Image URL","key":"AzureActiveDirectorySAML2","version":"2.2","displayName":"Office 365 Connector","identityProvider":true,"baseURLRequired":false,"connectionInformationRequired":true},"connectionProfiles":[{"name":"OAuth Bearer Token","description":"Authentication Scheme using the OAuth Bearer Token Standard","connectionAttributes":[{"key":"ClientId","displayLabel":"Application ID","description":"Application ID","required":true,"typeBoolean":false,"sensitive":true},{"key":"ClientSecret","displayLabel":"Application Secret","description":"Application Secret","required":true,"typeBoolean":false,"sensitive":true},{"key":"TenantDomain","displayLabel":"Tenant Domain","description":"Tenant Domain","required":true,"typeBoolean":false,"sensitive":false},{"key":"DoBase64Conversion","displayLabel":"Do a base64 conversion on ImmutableId (assumes it is mapped to a hex number)","description":"Do a base64 conversion on ImmutableId (assumes it is mapped to a hex number)","required":false,"typeBoolean":true,"sensitive":false},{"key":"RemoveLicensesWhenSkuIdEmpty","displayLabel":"Remove licenses from user when skuId is empty","description":"Remove licenses from user when skuId is empty","required":false,"typeBoolean":true,"sensitive":false},{"key":"DefaultPassword","displayLabel":"Global default password","description":"Global default password","required":true,"typeBoolean":false,"sensitive":true},{"key":"CREATE_NEW_USERS","displayLabel":"User Create","description":"User Create","required":false,"typeBoolean":true,"sensitive":false},{"key":"UPDATE_NEW_USERS","displayLabel":"User Update","description":"User Update","required":false,"typeBoolean":true,"sensitive":false},{"key":"REMOVE_USERS_PROV_OPT","displayLabel":"User Disable / Delete","description":"User Disable / Delete","required":false,"typeBoolean":true,"sensitive":false},{"key":"PROVISION_DISABLED_USERS_PROV_OPT","displayLabel":"Provision Disabled Users","description":"Provision Disabled Users","required":false,"typeBoolean":true,"sensitive":false},{"key":"DEPROVISION_USER_ACTION_PROV_OPT","displayLabel":"Remove User Action","description":"Remove User Action","required":false,"typeBoolean":false,"sensitive":false,"possibleValues":["Disable","Delete"]}],"specUrl":"http://tools.ietf.org/html/draft-ietf-oauth-v2-bearer-01","documentationUrl":"http://example.com/help/oauth.html","primary":false}],"attributeMetadata":{"capabilities":[{"type":"CREATE_MEMBERSHIPS","maxResources":1},{"type":"UPDATE_GROUPS","maxResources":1},{"type":"DELETE_MEMBERSHIPS","maxResources":1},{"type":"CREATE_USERS","maxResources":1},{"type":"UPDATE_USERS","maxResources":1},{"type":"DELETE_GROUPS","maxResources":1},{"type":"CREATE_GROUPS","maxResources":1},{"type":"GET_INFO","maxResources":1},{"type":"GET_GROUPS","maxResources":1},{"type":"CHECK_CONNECTION","maxResources":1},{"type":"GET_MEMBERS_OF_GROUP","maxResources":1},{"type":"GET_ALL_GROUPS","maxResources":1},{"type":"GET_CONNECTION_PROFILES","maxResources":1},{"type":"GET_ATTRIBUTES","maxResources":1},{"type":"GET_USERS","maxResources":1},{"type":"GET_MEMBERSHIPS","maxResources":1},{"type":"DELETE_USERS","maxResources":1}],"userAttributes":{"country":{"type":"STRING","attributeType":"STRING","creatable":true,"updateable":true,"unique":false,"sensitive":false,"displayName":"country","requiredOnUpdate":false,"requiredOnCreate":false,"key":"country","referenceAttribute":["work_country"]},"resetPassword":{"type":"BOOLEAN","attributeType":"BOOLEAN","creatable":true,"updateable":true,"defaultedOnCreate":true,"unique":false,"sensitive":false,"displayName":"resetPassword","requiredOnUpdate":false,"requiredOnCreate":true,"key":"resetPassword","defaultValue":true},"preferredLanguage":{"type":"STRING","attributeType":"STRING","creatable":true,"updateable":true,"unique":false,"sensitive":false,"displayName":"preferredLanguage","requiredOnUpdate":false,"requiredOnCreate":false,"key":"preferredLanguage","referenceAttribute":["language"]},"telephoneNumber":{"type":"STRING","attributeType":"STRING","creatable":true,"updateable":true,"unique":false,"sensitive":false,"displayName":"telephoneNumber","requiredOnUpdate":false,"requiredOnCreate":false,"key":"telephoneNumber","referenceAttribute":["work_phone"]},"city":{"type":"STRING","attributeType":"STRING","creatable":true,"updateable":true,"unique":false,"sensitive":false,"displayName":"city","requiredOnUpdate":false,"requiredOnCreate":false,"key":"city","referenceAttribute":["work_city"]},"displayName":{"type":"STRING","attributeType":"STRING","creatable":true,"updateable":true,"nillable":false,"unique":false,"sensitive":false,"displayName":"displayName","requiredOnUpdate":false,"requiredOnCreate":true,"key":"displayName","referenceAttribute":["display_name"]},"jobTitle":{"type":"STRING","attributeType":"STRING","creatable":true,"updateable":true,"unique":false,"sensitive":false,"displayName":"jobTitle","requiredOnUpdate":false,"requiredOnCreate":false,"key":"jobTitle","referenceAttribute":["title"]},"postalCode":{"type":"STRING","attributeType":"STRING","creatable":true,"updateable":true,"unique":false,"sensitive":false,"displayName":"postalCode","requiredOnUpdate":false,"requiredOnCreate":false,"key":"postalCode","referenceAttribute":["work_postal_code"]},"accountEnabled":{"type":"BOOLEAN","attributeType":"BOOLEAN","creatable":true,"updateable":true,"defaultedOnCreate":true,"unique":false,"sensitive":false,"displayName":"accountEnabled","requiredOnUpdate":true,"requiredOnCreate":true,"key":"accountEnabled","defaultValue":true,"referenceAttribute":["active"]},"password":{"type":"STRING","attributeType":"STRING","creatable":true,"updateable":false,"unique":false,"sensitive":true,"displayName":"password","requiredOnUpdate":false,"requiredOnCreate":false,"key":"password","referenceAttribute":["password"]},"surname":{"type":"STRING","attributeType":"STRING","creatable":true,"updateable":true,"unique":false,"sensitive":false,"displayName":"surname","requiredOnUpdate":false,"requiredOnCreate":false,"key":"surname","referenceAttribute":["family_name"]},"state":{"type":"STRING","attributeType":"STRING","creatable":true,"updateable":true,"unique":false,"sensitive":false,"displayName":"state","requiredOnUpdate":false,"requiredOnCreate":false,"key":"state","referenceAttribute":["work_region"]},"memberOf":{"type":"STRING","attributeType":"STRING","creatable":false,"updateable":false,"unique":false,"sensitive":false,"displayName":"memberOf","requiredOnUpdate":false,"requiredOnCreate":false,"key":"memberOf"},"department":{"type":"STRING","attributeType":"STRING","creatable":true,"updateable":true,"unique":false,"sensitive":false,"displayName":"department","requiredOnUpdate":false,"requiredOnCreate":false,"key":"department","referenceAttribute":["department"]},"userPrincipalName":{"type":"STRING","attributeType":"STRING","creatable":true,"updateable":true,"unique":true,"sensitive":false,"displayName":"userPrincipalName","requiredOnUpdate":false,"requiredOnCreate":true,"key":"userPrincipalName","referenceAttribute":["userPrincipalName"]},"skuId":{"type":"STRING","attributeType":"STRING","creatable":true,"updateable":true,"unique":false,"sensitive":false,"displayName":"skuId","requiredOnUpdate":false,"requiredOnCreate":false,"maxNumberOfValues":2147483647,"key":"skuId","maxLength":2147483647,"minLength":1},"mailNickname":{"type":"STRING","attributeType":"STRING","creatable":true,"updateable":true,"unique":false,"sensitive":false,"displayName":"mailNickname","requiredOnUpdate":false,"requiredOnCreate":true,"key":"mailNickname","referenceAttribute":["username"]},"physicalDeliveryOfficeName":{"type":"STRING","attributeType":"STRING","creatable":true,"updateable":true,"unique":false,"sensitive":false,"displayName":"physicalDeliveryOfficeName","requiredOnUpdate":false,"requiredOnCreate":false,"key":"physicalDeliveryOfficeName"},"manager":{"type":"STRING","attributeType":"STRING","creatable":true,"updateable":true,"unique":false,"sensitive":false,"displayName":"manager","requiredOnUpdate":false,"requiredOnCreate":false,"key":"manager","referenceAttribute":["manager_display_name"]},"givenName":{"type":"STRING","attributeType":"STRING","creatable":true,"updateable":true,"unique":false,"sensitive":false,"displayName":"givenName","requiredOnUpdate":false,"requiredOnCreate":false,"key":"givenName","referenceAttribute":["given_name"]},"mobile":{"type":"STRING","attributeType":"STRING","creatable":true,"updateable":true,"unique":false,"sensitive":false,"displayName":"mobile","requiredOnUpdate":false,"requiredOnCreate":false,"key":"mobile","referenceAttribute":["mobile_phone"]},"facsimileTelephoneNumber":{"type":"STRING","attributeType":"STRING","creatable":true,"updateable":true,"unique":false,"sensitive":false,"displayName":"facsimileTelephoneNumber","requiredOnUpdate":false,"requiredOnCreate":false,"key":"facsimileTelephoneNumber","referenceAttribute":["fax_phone"]},"disabledPlans":{"type":"STRING","attributeType":"STRING","creatable":true,"updateable":true,"unique":false,"sensitive":false,"displayName":"disabledPlans","requiredOnUpdate":false,"requiredOnCreate":false,"maxNumberOfValues":2147483647,"key":"disabledPlans","maxLength":2147483647,"minLength":1},"otherMails":{"type":"STRING","attributeType":"STRING","creatable":true,"updateable":true,"unique":false,"sensitive":false,"displayName":"otherMails","requiredOnUpdate":false,"requiredOnCreate":false,"maxNumberOfValues":2147483647,"key":"otherMails","maxLength":2147483647,"minLength":1},"immutableId":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":true,"creatable":true,"updateable":false,"unique":true,"sensitive":false,"displayName":"immutableId","requiredOnUpdate":false,"requiredOnCreate":true,"key":"immutableId","referenceAttribute":["external_id"]},"streetAddress":{"type":"STRING","attributeType":"STRING","creatable":true,"updateable":true,"unique":false,"sensitive":false,"displayName":"streetAddress","requiredOnUpdate":false,"requiredOnCreate":false,"key":"streetAddress","referenceAttribute":["work_street_address"]},"pingSourceDN":{"type":"STRING","attributeType":"STRING","creatable":true,"updateable":true,"unique":true,"sensitive":false,"displayName":"pingSourceDN","requiredOnUpdate":false,"requiredOnCreate":false,"key":"pingSourceDN","referenceAttribute":["manager_id"]},"usageLocation":{"type":"STRING","attributeType":"STRING","creatable":true,"updateable":true,"nillable":false,"unique":false,"sensitive":false,"displayName":"usageLocation","requiredOnUpdate":false,"requiredOnCreate":false,"key":"usageLocation","referenceAttribute":["locale"]},"userType":{"type":"STRING","attributeType":"STRING","creatable":true,"updateable":true,"unique":false,"sensitive":false,"displayName":"userType","requiredOnUpdate":false,"requiredOnCreate":false,"key":"userType","referenceAttribute":["user_type"]}},"groupAttributes":{"displayName":{"type":"STRING","attributeType":"STRING","creatable":true,"updateable":true,"unique":false,"sensitive":false,"displayName":"displayName","requiredOnUpdate":true,"requiredOnCreate":true,"key":"displayName","referenceAttribute":["display_name"]}}},"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/storeMetadata/AzureActiveDirectorySAML2"}}}