Create an IDP configuration

Beta Creates an external identity provider (IDP) configuration for the account. You can have only one configuration per account. To learn more about the single sing-on for Akamai Cloud, including emergency access accounts setup, see Single Sign-On.

Prerequisite

You need to have IDP metadata from your identity provider.

To create the IDP configuration:

  1. Provide a unique label for the configuration.

  2. To activate the SSO, set enabled to true.

  3. Enforce SSO for all users of your account with enforce set to true. The enforcement doesn't apply to excluded users.

    📘

    Set the enforcement to false, if you want to test SSO on a small subset of users. After you create this configuration, add the included users and test the login flow. If the test is successful, enforce the SSO login for all users with the Update an IDP configuration operation.

  4. Specify the SAML configuration settings with details from the IDP metadata you got from the identity provider.

👍

There's a tutorial

We offer an example API workflow you can follow to create an IDP configuration, test it, and configure an account with emergency access.

📘

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: create_idp_config
Path Params
string
enum
required

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

Allowed:
Body Params
boolean
Defaults to false

Activates the IDP configuration. When false, SSO is not enforced even if enforce is set to true. Defaults to false.

boolean
Defaults to false

Enforces 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
required

The unique IDP configuration's label.

saml
object
required

The SAML configuration settings provided by an identity provider.

Responses

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