Update Identity Provider

put

https://cluster.ip.address/v2/identity-providers/{id}

Privileges: PRINCIPAL_MODIFY

Update Identity Provider on the cluster. Currently this API only supports Open ID based SSO providers, but it will be expanded in the future to support SAML SSO providers.

Path Params

int64

required

Specifies id of identity provider configuration

Body Params

Specifies parameters to update identity provider configuration

domain

string | null

required

Specifies domain of idp configuration

identityProviderType

string | null

enum

required

Specifies the type of identity provider.

Allowed:

isEnabled

boolean | null

Defaults to true

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. By defaut idp is enabled i.e the value is true.

lastModifiedTimestampUsecs

int64 | null

Specifies the last time this configuration was modified in microseconds since the epoch. This is may be specified for PUT operations to prevent stale requests from being written. If it is specified during a PUT operation then the request will be rejected if the specified time does not match the actual last modified time.

oAuth2Params

object

OAuth 2 provider

openIdConnectParams

object

Open ID provider

tenantId

string | null

Specifies the tenant id if the idp is configured for a tenant. If this is not set, this idp configuration is used for the cluster level users and for all users of tenants not having an idp configuration.

Responses

200Success

defaultError