Configure Identity Provider

post

https://helios.cohesity.com/v2/identity-providers

Configure Identity Provider on the cluster. Currently this API is only for Open ID providers, but will be expanded to include SAML providers in the future.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Specifies parameters to configure Identity

domain

string | null

required

Specifies domain of idp configuration

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.

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.

identityProviderType

string | null

enum

required

Specifies the type of identity provider.

Allowed:

openIdConnectParams

object

Open ID provider

oAuth2Params

object

OAuth 2 provider

Headers

accessClusterId

int64

This field uniquely represents a Cohesity Cluster and is used for making on-prem calls from Helios.

Responses

201Success

defaultError