Update an IDP Configuration

put

https://helios.cohesity.com/v2/mcm/identity-providers/{idpId}

Update the specified Identity Provider Configuration. Please note that though this is a PUT call, we will be disabling updating certain fields such as signonProtocol, issuerId, etc.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

idpId

int64

required

Specifies the ID of the IDP configuration.

Body Params

Specifies the parameters to update IDP configuration.

providerName

string | null

required

Specifies the name of the vendor providing IDP service.

domain

string | null

required

Specifies a unique domain name for this IDP configuration. For Example: 'cohesity.com', 'internal.mysite.com'

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.

signonProtocol

string | null

enum

required

Specifies the sign on protocol which will be used for autheticating SSO users with IDP.

Allowed:

defaultRoles

array of strings | null

Specifies a list of default roles assigned to an IDP user if group Id is not assigned to IDP user.

defaultRoles

defaultClusters

array of strings | null

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

defaultClusters

openIdConnectParams

object | null

Specifies the parameters for configuring Open ID Connect (OIDC) sign on protocol.

Responses

200Success

defaultError