Qodex.ai

Identity Propagation Store Metadata (GoogleApps)

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

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

A request body is required but should be empty. Any content is ignored. GoogleApps does not support dynamic metadata.

Prerequisites

RESPONSES

status: OK

{"information":{"imageUrl":"http://res.cloudinary.com/ping-identity/image/upload/c_scale,w_1000/v1462211741/google.png","key":"GoogleApps","version":"3.2","displayName":"Google Workspace Connector","identityProvider":true,"baseURLRequired":false,"connectionInformationRequired":false},"connectionProfiles":[{"name":"OAuth Bearer Token","description":"Authentication Scheme using the OAuth Bearer Token Standard","connectionAttributes":[{"key":"OAUTH_CLIENT_ID","displayLabel":"OAuth Client ID","description":"OAuth Client ID","required":true,"sensitive":false},{"key":"OAUTH_CLIENT_SECRET","displayLabel":"OAuth Client Secret","description":"OAuth Client Secret","required":true,"sensitive":true},{"key":"OAUTH_ACCESS_TOKEN","displayLabel":"OAuth Access Token","description":"OAuth Access Token","required":true,"sensitive":true},{"key":"OAUTH_REFRESH_TOKEN","displayLabel":"OAuth Refresh Token","description":"OAuth Refresh Token","required":true,"sensitive":true},{"key":"APPLICATION_NAME","displayLabel":"Application Name","description":"Application Name","required":true,"sensitive":false},{"key":"DOMAIN","displayLabel":"Domain","description":"Domain","required":true,"sensitive":false},{"key":"CREATE_USERS_PROV_OPT","displayLabel":"User Create","description":"User Create","required":false,"typeBoolean":true,"sensitive":false},{"key":"UPDATE_USERS_PROV_OPT","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":"REMOVE_ACTION","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":"https://developers.google.com/admin-sdk/directory/v1/guides/authorizing","primary":false}],"attributeMetadata":{"capabilities":[{"type":"GET_USERS","maxResources":1},{"type":"GET_MEMBERSHIPS","maxResources":1},{"type":"CREATE_USERS","maxResources":1},{"type":"GET_CONNECTION_PROFILES","maxResources":1},{"type":"GET_ALL_GROUPS","maxResources":1},{"type":"CREATE_MEMBERSHIPS","maxResources":1},{"type":"CHECK_CONNECTION","maxResources":1},{"type":"UPDATE_USERS","maxResources":1},{"type":"CREATE_GROUPS","maxResources":1},{"type":"GET_GROUPS","maxResources":1},{"type":"DELETE_GROUPS","maxResources":1},{"type":"GET_ALL_USERS","maxResources":1},{"type":"GET_ATTRIBUTES","maxResources":1},{"type":"GET_MEMBERS_OF_GROUP","maxResources":1},{"type":"GET_INFO","maxResources":1},{"type":"UPDATE_GROUPS","maxResources":1},{"type":"DELETE_MEMBERSHIPS","maxResources":1}],"userAttributes":{"orgUnitPath":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":true,"unique":false,"sensitive":false,"displayName":"orgUnitPath","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"orgUnitPath","caseSensitive":false,"minLength":0},"ipWhitelisted":{"type":"BOOLEAN","attributeType":"BOOLEAN","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":true,"nillable":false,"unique":false,"sensitive":false,"displayName":"ipWhitelisted","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":1,"ordered":false,"key":"ipWhitelisted","defaultValue":false},"aliases":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":true,"unique":true,"sensitive":false,"displayName":"aliases","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1024,"minNumberOfValues":0,"ordered":false,"key":"aliases","caseSensitive":false,"maxLength":85,"minLength":0},"orgSymbol":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":true,"unique":false,"sensitive":false,"displayName":"orgSymbol","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"orgSymbol","caseSensitive":false,"minLength":0},"addressPostalCode":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":true,"unique":false,"sensitive":false,"displayName":"addressPostalCode","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"addressPostalCode","caseSensitive":false,"minLength":0,"referenceAttribute":["work_postal_code"]},"workPager":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":true,"unique":false,"sensitive":false,"displayName":"workPager","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"workPager","caseSensitive":false,"minLength":0,"referenceAttribute":["pager_phone"]},"password":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":false,"unique":false,"sensitive":true,"displayName":"password","requiredOnUpdate":false,"requiredOnCreate":true,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":1,"ordered":false,"key":"password","caseSensitive":true,"maxLength":100,"minLength":8,"referenceAttribute":["password"]},"addressPoBox":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":true,"unique":false,"sensitive":false,"displayName":"addressPoBox","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"addressPoBox","caseSensitive":false,"minLength":0},"addressExtended":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":true,"unique":false,"sensitive":false,"displayName":"addressExtended","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"addressExtended","caseSensitive":false,"minLength":0},"addressCountryCode":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":true,"unique":false,"sensitive":false,"displayName":"addressCountryCode","requiredOnUpdate":false,"requiredOnCreate":false,"standard":"ISO 3166-1","derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"addressCountryCode","caseSensitive":false,"maxLength":2,"minLength":0},"familyName":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":false,"unique":false,"sensitive":false,"displayName":"familyName","requiredOnUpdate":true,"requiredOnCreate":true,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":1,"ordered":false,"key":"familyName","caseSensitive":false,"maxLength":60,"minLength":1,"referenceAttribute":["family_name"]},"changePasswordAtNextLogin":{"type":"BOOLEAN","attributeType":"BOOLEAN","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":true,"nillable":false,"unique":false,"sensitive":false,"displayName":"changePasswordAtNextLogin","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":1,"ordered":false,"key":"changePasswordAtNextLogin","defaultValue":false},"id":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":true,"creatable":false,"updateable":false,"defaultedOnCreate":true,"nillable":false,"unique":true,"sensitive":false,"displayName":"id","requiredOnUpdate":true,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":1,"ordered":false,"key":"id","caseSensitive":true,"referenceAttribute":["id"]},"addressLocality":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":true,"unique":false,"sensitive":false,"displayName":"addressLocality","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"addressLocality","caseSensitive":false,"minLength":0,"referenceAttribute":["locale"]},"addressFormatted":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":true,"unique":false,"sensitive":false,"displayName":"addressFormatted","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"addressFormatted","caseSensitive":false,"minLength":0,"referenceAttribute":["work_formatted_address"]},"addressRegion":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":true,"unique":false,"sensitive":false,"displayName":"addressRegion","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"addressRegion","caseSensitive":false,"minLength":0,"referenceAttribute":["work_region"]},"primaryEmail":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":true,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":false,"unique":true,"sensitive":false,"displayName":"primaryEmail","requiredOnUpdate":false,"requiredOnCreate":true,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":1,"ordered":false,"key":"primaryEmail","caseSensitive":false,"maxLength":85,"minLength":1,"referenceAttribute":["work_email"]},"includeInGlobalAddressList":{"type":"BOOLEAN","attributeType":"BOOLEAN","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":true,"nillable":false,"unique":false,"sensitive":false,"displayName":"includeInGlobalAddressList","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":1,"ordered":false,"key":"includeInGlobalAddressList","defaultValue":true},"addressCountry":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":true,"unique":false,"sensitive":false,"displayName":"addressCountry","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"addressCountry","caseSensitive":false,"minLength":0,"referenceAttribute":["work_country"]},"orgDept":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":true,"unique":false,"sensitive":false,"displayName":"orgDept","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"orgDept","caseSensitive":false,"minLength":0,"referenceAttribute":["department"]},"orgName":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":true,"unique":false,"sensitive":false,"displayName":"orgName","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"orgName","caseSensitive":false,"minLength":0,"referenceAttribute":["organization"]},"orgCostCenter":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":true,"unique":false,"sensitive":false,"displayName":"orgCostCenter","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"orgCostCenter","caseSensitive":false,"minLength":0,"referenceAttribute":["cost_center"]},"orgDescription":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":true,"unique":false,"sensitive":false,"displayName":"orgDescription","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"orgDescription","caseSensitive":false,"minLength":0},"orgDomain":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":true,"unique":false,"sensitive":false,"displayName":"orgDomain","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"orgDomain","caseSensitive":false,"minLength":0},"givenName":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":false,"unique":false,"sensitive":false,"displayName":"givenName","requiredOnUpdate":true,"requiredOnCreate":true,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":1,"ordered":false,"key":"givenName","caseSensitive":false,"maxLength":60,"minLength":1,"referenceAttribute":["given_name"]},"orgTitle":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":true,"unique":false,"sensitive":false,"displayName":"orgTitle","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"orgTitle","caseSensitive":false,"minLength":0,"referenceAttribute":["title"]},"orgLocation":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":true,"unique":false,"sensitive":false,"displayName":"orgLocation","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"orgLocation","caseSensitive":false,"minLength":0},"isAdmin":{"type":"BOOLEAN","attributeType":"BOOLEAN","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":true,"nillable":false,"unique":false,"sensitive":false,"displayName":"isAdmin","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":1,"ordered":false,"key":"isAdmin","defaultValue":false},"workFax":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":true,"unique":false,"sensitive":false,"displayName":"workFax","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"workFax","caseSensitive":false,"minLength":0,"referenceAttribute":["fax_phone"]},"passwordHashFunction":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":true,"unique":false,"picklistValues":["SHA-1","MD5","CRYPT"],"sensitive":true,"displayName":"passwordHashFunction","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"passwordHashFunction","caseSensitive":false,"maxLength":5,"minLength":0},"workMobile":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":true,"unique":false,"sensitive":false,"displayName":"workMobile","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"workMobile","caseSensitive":false,"minLength":0,"referenceAttribute":["mobile_phone"]},"suspended":{"type":"BOOLEAN","attributeType":"BOOLEAN","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":true,"nillable":false,"unique":false,"sensitive":false,"displayName":"suspended","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":1,"ordered":false,"key":"suspended","defaultValue":false,"referenceAttribute":["active"]},"primaryPhone":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":true,"unique":false,"picklistValues":["work_mobile","work_fax","work_pager","work"],"sensitive":false,"displayName":"primaryPhone","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"primaryPhone","caseSensitive":false,"minLength":0},"addressStreet":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":true,"unique":false,"sensitive":false,"displayName":"addressStreet","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"addressStreet","caseSensitive":false,"minLength":0,"referenceAttribute":["work_street_address"]},"workPhone":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":true,"unique":false,"sensitive":false,"displayName":"workPhone","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"workPhone","caseSensitive":false,"minLength":0,"referenceAttribute":["work_phone"]}}},"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/storeMetadata/GoogleApps"}}}