Configure identity provider

post

https://cluster.ip.address/v2/idps

Configure identity provider on the cluster

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Specifies parameters to configure identity provider

allowLocalUserLogin

boolean | null

Specifies if local user login is allowed. When idp is configured, only idp users are allowed to login to the cluster, local login is disabled except for users with admin role. If this flag is set to true, local (non-idp) logins are allowed for all local and AD users. Local or AD users with admin role can login always independent of this flag's setting. By default there is no local authentication i.e the value is false.

certificate

string | null

required

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

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

issuerId

string | null

required

Specifies identity provider issuer id

roles

array of strings | null

Specifies the default roles assined for all SSO users

roles

samlAttributeName

string | null

Specifies the SAML attribute name that contains a comma separated list of cluster roles. This sets the default roles for all SSO users. Either this field or roles must be set, this field takes higher precedence than the roles field.

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 the Cluster signed. If this is set to true, users must get the cluster's certificate and upload it on the idp site.

ssoUrl

string | null

required

Specifies the identity provider SSO url

domain

string | null

required

Specifies domain of idp configuration

name

string | null

required

Specifies name of the vendor providing idp service

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

201Success

defaultError