Create Store (Zoom)
POST {{apiPath}}/environments/{{envID}}/propagation/stores
The POST /environments/{{envID}}/propagation/stores
operation adds a new identity store resource to the specified environment resource.
Prerequisites
- See Identity Propagation (Provisioning) for important overview information.
See Propagation store base data model and Propagation store Zoom configuration data model for full property descriptions.
Property | Type | Required? |
---|---|---|
configuration.API_KEY (Deprecated) | String | Required/Optional |
configuration.API_SECRET (Deprecated) | String | Required/Optional |
configuration.AUTHENTICATION_METHOD | String | Optional |
configuration.CREATE_USERS | Boolean | Optional |
configuration.DEPROVISION_USERS | Boolean | Optional |
configuration.DISABLE_USERS | Boolean | Optional |
configuration.OAUTH_ACCOUNT_ID | String | Required/Optional |
configuration.OAUTH_CLIENT_ID | String | Required/Optional |
configuration.OAUTH_CLIENT_SECRET | String | Required/Optional |
configuration.OAUTH_TOKEN_URL | String | Required/Optional |
configuration.REMOVE_ACTION | String | Optional |
configuration.SCIM_URL | String | Required |
configuration.UPDATE_USERS | Boolean | Optional |
description | String | Optional |
image.href | String | Optional |
managed | Boolean | Optional |
name | String | Required |
status | String | Optional |
type | String | Required |
This operation sends and returns the connection properties for an identity store with "type":"Zoom"
. For information on the available and required keys in the configuration
object of the request body, review connectionProfiles\[\].connectionAttributes\[\]
and attributeMetadata.capabilities\[\]
in the response to POST Identity Propagation Store Metadata (Zoom).
Request Body
{"type"=>"Zoom", "name"=>"zoom connection", "status"=>"ACTIVE", "configuration"=>{"AUTHENTICATION_METHOD"=>"OAuth Bearer Token", "CREATE_USERS"=>true, "UPDATE_USERS"=>true, "DEPROVISION_USERS"=>true, "DISABLE_USERS"=>true, "SCIM_URL"=>"https://api.zoom.us/scim2", "OAUTH_TOKEN_URL"=>"https://zoom.us/oauth/token", "OAUTH_ACCOUNT_ID"=>"{{oauthAccountId}}", "OAUTH_CLIENT_ID"=>"{{oauthClientId}}", "OAUTH_CLIENT_SECRET"=>"{{oauthClientSecret}}", "REMOVE_ACTION"=>"Delete"}, "managed"=>true}
RESPONSES
status: Created
{"id":"da166d8e-eaa7-4251-8480-85448e095bc3","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"createdAt":"2023-12-05T17:38:42.947Z","updatedAt":"2023-12-05T17:38:42.947Z","image":{},"type":"Zoom","status":"ACTIVE","configuration":{"AUTHENTICATION_METHOD":"OAuth Bearer Token","CREATE_USERS":true,"UPDATE_USERS":true,"DEPROVISION_USERS":true,"DISABLE_USERS":true,"SCIM_URL":"https://api.zoom.us/scim2","OAUTH_TOKEN_URL":"https://zoom.us/oauth/token","OAUTH_ACCOUNT_ID":"OAUTH_ACCOUNT_ID","OAUTH_CLIENT_ID":"OAUTH_CLIENT_ID","OAUTH_CLIENT_SECRET":"OAUTH_CLIENT_SECRET","REMOVE_ACTION":"Delete"},"name":"zoom connection","managed":true,"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/stores/da166d8e-eaa7-4251-8480-85448e095bc3"},"update":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/stores/da166d8e-eaa7-4251-8480-85448e095bc3"},"delete":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/stores/da166d8e-eaa7-4251-8480-85448e095bc3"}}}