Update an IdP configuration.

put

https://cluster.ip.address/irisservices/api/v1/public/idps/{id}

Privileges: PRINCIPAL_MODIFY

Returns the updated IdP configuration.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int64

required

Specifies the Id assigned for the IdP Service by the Cluster.

Body Params

Request to update an Idp Configuration.

Specifies the parameters of an IdP configuration to be updated.

allowLocalAuthentication

boolean | null

Specifies whether to allow local authentication. 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.

certificate

string | null

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.

certificateFilename

string | null

Specifies the filename used to upload the certificate.

enable

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. When an IdP service is created, it is set to true.

issuerId

string | null

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

roles

array of strings | null

Specifies a list of roles assigned to an IdP user if samlAttributeName is
not given.

roles

samlAttributeName

string | null

Specifies the SAML attribute name that contains a comma separated list
of Cluster roles. 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

Specifies the SSO URL of the IdP service for the customer. This is the
URL given by IdP when the customer created an account. Customers may use
this for several clusters that are registered with on IdP site.
For example, dev-332534.oktapreview.com

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

defaultError