Update Store

PUT {{apiPath}}/environments/{{envID}}/propagation/stores/{{storeID}}

The PUT /environments/{{envID}}/propagation/stores/{{storeID}} operation updates the property values of the identified identity store resource.

Prerequisites

See Identity Propagation (Provisioning) for important overview information.

Base request model

See Propagation store base data model for full property descriptions.

Property	Type	Required?
`description`	String	Optional
`image.href`	String	Optional
`managed`	Boolean	Optional
`name`	String	Required
`status`	String	Optional
`type`	String	Required

Aquera configuration request model

See Propagation store Aquera configuration data model for full property descriptions.

Property	Type	Required?
`configuration.ACCESS_TOKEN`	String	Optional
`configuration.AUTHENTICATION_METHOD`	String	Required
`configuration.BASIC_AUTH_PASSWORD`	String	Required
`configuration.BASIC_AUTH_USER`	String	Required
`configuration.CREATE_USERS`	Boolean	Optional
`configuration.createNewUsers` (Deprecated)	Boolean	Optional
`configuration.DISABLE_USERS`	Boolean	Optional
`configuration.disableNewUsers` (Deprecated)	Boolean	Optional
`configuration.GROUP_NAME_SOURCE`	String	Optional
`configuration.REMOVE_ACTION`	String	Optional
`configuration.SCIM_URL`	String	Required
`configuration.UPDATE_USERS`	Boolean	Optional
`configuration.updateNewUsers` (Deprecated)	Boolean	Optional

Azure Active Directory SAML V2.0 configuration request model

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

Property	Type	Required?
`configuration.ClientId`	String	Required
`configuration.ClientSecret`	String	Required
`configuration.CREATE_NEW_USERS` (Deprecated)	Boolean	Optional
`configuration.CREATE_USERS`	Boolean	Optional
`configuration.DEPROVISION_USER_ACTION_PROV_OPT` (Deprecated)	Boolean	Optional
`configuration.DISABLE_USERS`	Boolean	Optional
`configuration.PROVISION_DISABLED_USERS_PROV_OPT`	Boolean	Optional
`configuration.REMOVE_ACTION`	String	Optional
`configuration.REMOVE_USERS_PROV_OPT` (Deprecated)	Boolean	Optional
`configuration.RemoveLicensesWhenSkuIdEmpty`	Boolean	Required
`configuration.TenantDomain`	String	Required
`configuration.UPDATE_NEW_USERS` (Deprecated)	Boolean	Optional
`configuration.UPDATE_USERS`	Boolean	Optional

directory configuration request model

An identity propagation store of type directory has no configuration data model.

GoogleApps configuration request model

See Propagation store GoogleApps configuration data model for full property descriptions.

Property	Type	Required?
`configuration.APPLICATION_NAME`	String	Required
`configuration.CREATE_USERS`	Boolean	Optional
`configuration.DEPROVISION_USERS`	Boolean	Optional
`configuration.DISABLE_USERS`	Boolean	Optional
`configuration.DOMAIN`	String	Required
`configuration.OAUTH_ACCESS_TOKEN`	String	Required
`configuration.OAUTH_CLIENT_ID`	String	Required
`configuration.OAUTH_CLIENT_SECRET`	String	Required
`configuration.OAUTH_REFRESH_TOKEN`	String	Required
`configuration.PROVISION_DISABLED_USERS_PROV_OPT`	Boolean	Optional
`configuration.REMOVE_ACTION`	String	Optional
`configuration.UPDATE_USERS`	Boolean	Optional

LdapGateway configuration request model

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

Property	Type	Required?
`configuration.ATTRIBUTE_METADATA`	String	Optional
`configuration.CLIENT_ID`	String	Required
`configuration.CLIENT_SECRET`	String	Required
`configuration.CREATE_USERS`	Boolean	Optional
`configuration.DELETE_USERS`	Boolean	Optional
`configuration.ENVIRONMENT_ID`	String	Required
`configuration.GATEWAY_BASE_URL`	String	Required
`configuration.GATEWAY_ID`	String	Required
`configuration.LDAP_TYPE`	String	Required
`configuration.OAUTH_URL`	String	Required
`configuration.UPDATE_USERS`	Boolean	Optional

PingOne configuration request model

See Propagation store PingOne configuration data model for full property descriptions.

Property	Type	Required?
`configuration.CLIENT_ID`	String	Optional
`configuration.CLIENT_SECRET`	String	Optional
`configuration.CREATE_USERS_PROV_OPT` (Deprecated)	Boolean	Optional
`configuration.CREATE_USERS`	Boolean	Optional
`configuration.DEFAULT_AUTH_METHOD`	String	Optional
`configuration.DISABLE_USERS`	Boolean	Optional
`configuration.ENVIRONMENT_ID`	Sring	Required
`configuration.MFA_USER_DEVICE_MANAGEMENT`	String	Optional
`configuration.PROVISION_DISABLED_USERS_PROV_OPT`	Boolean	Optional
`configuration.REGION`	String	Required
`configuration.REMOVE_ACTION`	String	Optional
`configuration.REMOVE_USERS_PROV_OPT` (Deprecated)	Boolean	Optional
`configuration.UPDATE_USERS_PROV_OPT` (Deprecated)	Boolean	Optional
`configuration.UPDATE_USERS`	Boolean	Optional

Salesforce configuration request model

See Propagation store Salesforce configuration data model for full property descriptions.

Property	Type	Required?
`configuration.ACCOUNT_ID`	String	Optional
`configuration.CLIENT_ID`	String	Required
`configuration.CLIENT_SECRET`	String	Required
`configuration.CREATE_NEW_USERS` (Deprecated)	Boolean	Optional
`configuration.CREATE_USERS`	Boolean	Optional
`configuration.DISABLE_USERS`	Boolean	Optional
`configuration.ENABLE_COMMUNITIES`	Boolean	Required
`configuration.FREEZE_USER_FLAG`	Boolean	Required
`configuration.OAUTH_ACCESS_TOKEN`	String	Required
`configuration.OAUTH_REFRESH_TOKEN`	String	Required
`configuration.PERMISSION_SET_MANAGEMENT`	String	Required
`configuration.PROFILE_ID`	String	Optional
`configuration.PROVISION_DISABLED_USERS`	Boolean	Optional
`configuration.SALESFORCE_DOMAIN`	String	Required
`configuration.UPDATE_NEW_USERS` (Deprecated)	Boolean	Optional
`configuration.UPDATE_USERS`	Boolean	Optional

SalesforceContacts configuration request model

See Propagation store SalesforceContacts configuration data model for full property descriptions.

Property	Type	Required?
`configuration.ACCOUNT_ID`	String	Optional
`configuration.CLIENT_ID`	String	Required
`configuration.CLIENT_SECRET`	String	Required
`configuration.CREATE_NEW_USERS` (Deprecated)	Boolean	Optional
`configuration.CREATE_USERS`	Boolean	Optional
`configuration.DISABLE_USERS`	Boolean	Optional
`configuration.ENABLE_COMMUNITIES`	Boolean	Required
`configuration.FREEZE_USER_FLAG`	Boolean	Required
`configuration.OAUTH_ACCESS_TOKEN`	String	Required
`configuration.OAUTH_REFRESH_TOKEN`	String	Required
`configuration.PERMISSION_SET_MANAGEMENT`	String	Required
`configuration.PROFILE_ID`	String	Optional
`configuration.PROVISION_DISABLED_USERS`	Boolean	Optional
`configuration.RECORD_TYPE`	String	Required
`configuration.SALESFORCE_DOMAIN`	String	Required
`configuration.UPDATE_NEW_USERS` (Deprecated)	Boolean	Optional
`configuration.UPDATE_USERS`	Boolean	Optional

SCIM configuration request model

See Propagation store SCIM configuration data model for full property descriptions.

Property	Type	Required?
`configuration.AUTHENTICATION_METHOD`	String	Required
`configuration.AUTHORIZATION_TYPE`	String	Required
`configuration.BASIC_AUTH_PASSWORD`	String	Required
`configuration.BASIC_AUTH_USER`	String	Required
`configuration.CREATE_USERS`	Boolean	Optional
`configuration.createNewUsers` (Deprecated)	Boolean	Optional
`configuration.DISABLE_USERS`	Boolean	Optional
`configuration.disableNewUsers` (Deprecated)	Boolean	Optional
`configuration.GROUP_NAME_SOURCE`	String	Optional
`configuration.GROUPS_RESOURCE`	String	Optional
`configuration.OAUTH_ACCESS_TOKEN`	String	Optional
`configuration.OAUTH_CLIENT_ID`	String	Optional
`configuration.OAUTH_CLIENT_SECRET`	String	Optional
`configuration.OAUTH_TOKEN_REQUEST`	String	Optional
`configuration.REMOVE_ACTION`	String	Optional
`configuration.SCIM_URL`	String	Required
`configuration.SCIM_VERSION`	String	Required
`configuration.UNIQUE_USER_IDENTIFIER`	String	Required
`configuration.UPDATE_USERS`	Boolean	Optional
`configuration.updateNewUsers` (Deprecated)	Boolean	Optional
`configuration.USER_FILTER`	String	Required
`configuration.USERS_RESOURCE`	String	Required

ServiceNow configuration request model

See Propagation store ServiceNow configuration data model for full property descriptions.

Property	Type	Required?
`configuration.Administrator_Password`	String	Required
`configuration.Administrator_Username`	String	Required
`configuration.CREATE_USERS`	Boolean	Optional
`configuration.createNewUsers` (Deprecated)	Boolean	Optional
`configuration.DEPROVISION_USERS`	Boolean	Optional
`configuration.DISABLE_USERS`	Boolean	Optional
`configuration.disableNewUsers` (Deprecated)	Boolean	Optional
`configuration.REMOVE_ACTION`	String	Optional
`configuration.ServiceNow_Instance_Name` (Deprecated)	String	Optional
`configuration.ServiceNow_Url`	String	Required
`configuration.UPDATE_USERS`	Boolean	Optional
`configuration.updateNewUsers` (Deprecated)	Boolean	Optional

Slack configuration request model

See Propagation store Slack configuration data model for full property descriptions.

Property	Type	Required?
`configuration.CREATE_USERS_PROV_OPT` (Deprecated)	Boolean	Optional
`configuration.CREATE_USERS`	Boolean	Optional
`configuration.DEPROVISION_USERS`	Boolean	Optional
`configuration.DISABLE_USERS`	Boolean	Optional
`configuration.OAUTH_ACCESS_TOKEN`	String	Required
`configuration.REMOVE_ACTION`	String	Optional
`configuration.REMOVE_USERS_PROV_OPT` (Deprecated)	Boolean	Optional
`configuration.UNIQUE_USER_IDENTIFIER`	String	Required
`configuration.UPDATE_USERS_PROV_OPT` (Deprecated)	Boolean	Optional
`configuration.UPDATE_USERS`	Boolean	Optional

Workday configuration request model

See Propagation store Workday configuration data model for full property descriptions.

Property	Type	Required?
`configuration.excludeContingentWorkers`	Boolean	Optional
`configuration.excludeEmployees`	Boolean	Optional
`configuration.excludeInactiveWorkers`	Boolean	Optional
`configuration.host`	String	Optional
`configuration.password`	String	Required
`configuration.tenantId`	String	Required
`configuration.username`	String	Required

Zoom configuration request model

See Propagation store Zoom configuration data model for full property descriptions.

Property	Type	Required?
`configuration.API_KEY` (Deprecated)	String	Required
`configuration.API_SECRET` (Deprecated)	String	Required
`configuration.CREATE_USERS_PROV_OPT` (Deprecated)	Boolean	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.REMOVE_USERS_PROV_OPT` (Deprecated)	Boolean	Optional
`configuration.SCIM_URL`	String	Required
`configuration.UPDATE_USERS_PROV_OPT` (Deprecated)	Boolean	Optional
`configuration.UPDATE_USERS`	Boolean	Optional

Request Body

{"type"=>"scim", "name"=>"scim", "description"=>"Update a scim connection", "configuration"=>{"AUTHENTICATION_METHOD"=>"Basic Authentication", "SCIM_URL"=>"https://scim.url", "USERS_RESOURCE"=>"/users", "SCIM_VERSION"=>"1.1", "AUTHORIZATION_TYPE"=>"Basic", "BASIC_AUTH_USER"=>"{{basicAuthUsername}}", "BASIC_AUTH_PASSWORD"=>"{{basicAuthPassword}}"}, "image"=>{"href"=>"https://d1oekt4jpdthse.cloudfront.net/branding/market/cb933bfe-8282-405a-a780-0a19b97edc02.png"}}

RESPONSES

status: OK

{&quot;id&quot;:&quot;a7115f69-136d-4b5d-8b24-5c1c218147f5&quot;,&quot;environment&quot;:{&quot;id&quot;:&quot;abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6&quot;},&quot;createdAt&quot;:&quot;2022-01-10T17:32:21.502Z&quot;,&quot;updatedAt&quot;:&quot;2022-01-10T20:29:55.593Z&quot;,&quot;image&quot;:{&quot;href&quot;:&quot;https://d1oekt4jpdthse.cloudfront.net/branding/market/cb933bfe-8282-405a-a780-0a19b97edc02.png&quot;},&quot;description&quot;:&quot;Update a scim connection&quot;,&quot;type&quot;:&quot;scim&quot;,&quot;configuration&quot;:{&quot;AUTHENTICATION_METHOD&quot;:&quot;Basic Authentication&quot;,&quot;SCIM_URL&quot;:&quot;https://scim.url&quot;,&quot;USERS_RESOURCE&quot;:&quot;/users&quot;,&quot;SCIM_VERSION&quot;:&quot;1.1&quot;,&quot;AUTHORIZATION_TYPE&quot;:&quot;Basic&quot;,&quot;BASIC_AUTH_USER&quot;:&quot;basicUserName&quot;,&quot;BASIC_AUTH_PASSWORD&quot;:&quot;$3cr3t_p@55w0rd&quot;},&quot;name&quot;:&quot;scim&quot;,&quot;_links&quot;:{&quot;self&quot;:{&quot;href&quot;:&quot;https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/stores/a7115f69-136d-4b5d-8b24-5c1c218147f5&quot;},&quot;update&quot;:{&quot;href&quot;:&quot;https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/stores/a7115f69-136d-4b5d-8b24-5c1c218147f5&quot;},&quot;delete&quot;:{&quot;href&quot;:&quot;https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/stores/a7115f69-136d-4b5d-8b24-5c1c218147f5&quot;}}}