Update IDP Configuration.

put

https://helios.cohesity.com/v2/mcm/idps/{id}

Update the specified Identity Provider Configuration.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int64

required

Specifies the id of the IDP configuration.

Body Params

Specifies the parameters to update IDP configuration.

allowDsoModify

boolean | null

Specifies whether DSO (Data Security) user modification is allowed. When set to true, DSO user's modifications are permitted. When set to false or not specified, DSO user's modifications are not allowed.

certificate

string | null

required

Specifies the certificate generated for the app by the IDP service when the Helios is registered as an app. This is required to verify the SAML response.

defaultClusters

array of strings | null

Specifies a list of default clusterIds assigned to an IDP user if clustersSamlAttributeName is not given. 'All' must be specified to give access to all clusters.

defaultClusters

defaultRegions

array of strings | null

Specifies a list of default regionIds assigned to an IDP user if regionsSamlAttributeName is not given. 'All' must be specified to give access to all DataProtect as a Service regions.

defaultRegions

defaultRoles

array of strings | null

Specifies a list of default roles assigned to an IDP user if rolesSamlAttributeName is not given.

defaultRoles

domain

string | null

required

Specifies a unique name for this IDP configuration.

isEnabled

boolean | null

Specifies a flag to enable or disable this IDP service. When it is set to true, IDP service is enabled. When it is set to false, IDP service is disabled. Default value is true.

issuerId

string | null

required

Specifies the IDP provided Issuer ID for the app. For example, exkh1aov1nhHrgFhN0h7.

name

string | null

required

Specifies the name of the vendor providing IDP service.

sendUniqueAcsUrl

boolean | null

Specifies whether or not a unique ACS URL should be sent. If this is set to true, then in the AuthNReq, we will send 'https://helios.cohesity.com/v2/mcm/idp/:id/authenticate', instead of 'https://helios.cohesity.com/v2/mcm/idp/authenticate'. ':id' denotes an integer identifier which is assigned to your IdP configuration in Helios.

signRequest

boolean | null

Specifies whether to sign the SAML request or not. When it is set to true, SAML request will be signed. When it is set to false, SAML request is not signed. Default is false. Set this flag to true if the IDP site is configured to expect the SAML request from Helios signed. If this is set to true, users must get the Helios certificate and upload it on the IDP site.

ssoUrl

string | null

required

Specifies the SSO URL of the IDP service for the customer. This is the URL given by IDP when the customer created an account. For example, dev-332534.oktapreview.com.

Responses

200Success

defaultError