API

Update an IDP configuration

put
https://api.linode.com//iam/idp-configs/

Beta Updates the external identity provider (IDP) configuration for the account. Top-level properties can be passed individually or together. When included, you need to provide the entire IDP config object and it will overwrite existing values. This operation triggers an update_idp_config event.

📘

This operation is in Beta and available from the v4beta URL.

Permissions and scopes

To call this operation, you need the following:

  • Identity and access permissions. Your user needs a role with these permissions assigned. Learn more.
    • Permissions: update_idp_config
Path Params
string
enum
required

Enum Call the v4beta URL for operations still only in beta.

Allowed:
uuid
required

The unique identifier of the external identity provider configuration. This is the id value returned by the List IDP configurations operation.

Body Params
boolean

Whether this IDP configuration is active.

boolean

Enforces the IDP authentication for all users except those in the excluded list. When false, only users in the included list are required to use SSO.

string

The unique IDP configuration's label.

saml
object

The SAML configuration settings. When included, you need to provide the entire IDP config object and it will overwrite existing values.

Responses

Updated about 1 month ago

Language
Credentials
Bearer
LoadingLoading…
Response
Choose an example:
application/json

Updated about 1 month ago