Qodex.ai

Identity Propagation Store Metadata (Zoom)

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

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

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

Prerequisites

RESPONSES

status: OK

{"information":{"imageUrl":"Image URL","key":"Zoom","version":"1.0.0.0-SNAPSHOT","displayName":"Zoom Connector","identityProvider":false,"baseURLRequired":false,"connectionInformationRequired":false},"connectionProfiles":[{"name":"JWT Bearer Token","description":"Authentication Scheme using the JWT Bearer Token Standard (Deprecated)","connectionAttributes":[{"key":"SCIM_URL","displayLabel":"SCIM Url","description":"SCIM Url","required":true,"sensitive":false},{"key":"AUTHENTICATION_METHOD","displayLabel":"Authentication Method","description":"Authentication Method","required":true,"sensitive":false,"possibleValues":["JWT Bearer Token","OAuth Bearer Token"]},{"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":"API_KEY","displayLabel":"API Key","description":"API Key","required":true,"sensitive":true},{"key":"API_SECRET","displayLabel":"API Secret","description":"API Secret","required":true,"sensitive":true}],"specUrl":"","documentationUrl":"","primary":false},{"name":"OAuth Bearer Token","description":"Authentication Scheme using OAuth 2 Standard","connectionAttributes":[{"key":"SCIM_URL","displayLabel":"SCIM Url","description":"SCIM Url","required":true,"sensitive":false},{"key":"AUTHENTICATION_METHOD","displayLabel":"Authentication Method","description":"Authentication Method","required":true,"sensitive":false,"possibleValues":["JWT Bearer Token","OAuth Bearer Token"]},{"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":"OAUTH_TOKEN_URL","displayLabel":"OAuth Token Url","description":"OAuth Token Url","required":true,"sensitive":false},{"key":"OAUTH_ACCOUNT_ID","displayLabel":"OAuth Account Id","description":"OAuth Account Id","required":true,"sensitive":false},{"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}],"specUrl":"","documentationUrl":"","primary":false}],"attributeMetadata":{"capabilities":[{"type":"DELETE_USERS","maxResources":1},{"type":"GET_CONNECTION_PROFILES","maxResources":1},{"type":"GET_ALL_USERS","maxResources":1},{"type":"UPDATE_USERS","maxResources":1},{"type":"CREATE_USERS","maxResources":1},{"type":"CHECK_CONNECTION","maxResources":1},{"type":"GET_ATTRIBUTES","maxResources":1},{"type":"GET_INFO","maxResources":1},{"type":"GET_USERS","maxResources":1}],"enhancements":["MEMBERSHIP_AS_GROUP_ATTRIBUTE"],"userAttributes":{"roles":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":true,"unique":false,"sensitive":false,"displayName":"Roles","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":100,"minNumberOfValues":0,"ordered":false,"key":"roles","caseSensitive":false,"maxLength":50,"minLength":1},"givenName":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":true,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":false,"unique":false,"sensitive":false,"displayName":"Given Name","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":1,"ordered":false,"key":"givenName","caseSensitive":false,"maxLength":65,"minLength":1,"referenceAttribute":["given_name"]},"active":{"type":"BOOLEAN","attributeType":"BOOLEAN","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":true,"nillable":false,"unique":false,"sensitive":false,"displayName":"Active","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":1,"ordered":false,"key":"active","defaultValue":true},"locale":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":true,"unique":false,"sensitive":false,"displayName":"Locale","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"locale","caseSensitive":true,"maxLength":512,"minLength":0,"referenceAttribute":["locale"]},"title":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":true,"unique":false,"sensitive":false,"displayName":"Title","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"title","caseSensitive":true,"maxLength":128,"minLength":0,"referenceAttribute":["title"]},"userName":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":true,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":false,"unique":true,"sensitive":false,"displayName":"Username","requiredOnUpdate":false,"requiredOnCreate":true,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":1,"ordered":false,"key":"userName","caseSensitive":false,"maxLength":254,"minLength":1,"referenceAttribute":["work_email"]},"familyName":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":true,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":false,"unique":false,"sensitive":false,"displayName":"Family Name","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":1,"ordered":false,"key":"familyName","caseSensitive":false,"maxLength":64,"minLength":1,"referenceAttribute":["family_name"]},"organization":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":true,"unique":false,"sensitive":false,"displayName":"Organization","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"organization","caseSensitive":true,"maxLength":255,"minLength":0,"referenceAttribute":["organization"]},"workPhone":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":true,"unique":false,"sensitive":false,"displayName":"Phone","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"workPhone","caseSensitive":true,"maxLength":100,"minLength":0,"referenceAttribute":["work_phone"]},"id":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":true,"creatable":true,"updateable":false,"defaultedOnCreate":false,"nillable":false,"unique":true,"sensitive":false,"displayName":"Id","requiredOnUpdate":true,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":1,"ordered":false,"key":"id","caseSensitive":false,"maxLength":255,"minLength":0,"referenceAttribute":["id"]},"userType":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":true,"unique":false,"sensitive":false,"displayName":"User Type","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"userType","caseSensitive":true,"maxLength":100,"minLength":0,"referenceAttribute":["user_type"]},"department":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":true,"unique":false,"sensitive":false,"displayName":"Department","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"department","caseSensitive":true,"maxLength":129,"minLength":0,"referenceAttribute":["department"]},"email":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":true,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":false,"unique":true,"sensitive":false,"displayName":"Email","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":1,"ordered":false,"key":"email","caseSensitive":true,"maxLength":254,"minLength":1,"referenceAttribute":["work_email"]}}},"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/storeMetadata/Zoom"}}}