GOgooddata
Identity Providers

Set all identity providers

Sets identity providers in organization.

put/api/v1/layout/identityProviders

Request

  • Base URL
    https://www.gooddata.ai
  • Auth
    none declared

Request body

customClaimMappingobject

Map of custom claim overrides. To be used when your Idp does not provide default claims (sub, email, name, given_name, family_name, urn.gooddata.user_groups [optional]). Define the key pair for the claim you wish to override, where the key is the default name of the attribute and the value is your custom name for the given attribute.

idstring required

FilterView object ID.

identifiersstring[]

List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP.

idpType'MANAGED_IDP' | 'FIM_IDP' | 'DEX_IDP' | 'CUSTOM_IDP'

Type of IdP for management purposes. MANAGED_IDP represents a GoodData managed IdP used in single OIDC setup, which is protected from altering/deletion. FIM_IDP represents a GoodData managed IdP used in federated identity management setup, which is protected from altering/deletion. CUSTOM_IDP represents customer's own IdP, protected from deletion if currently used by org for authentication, deletable otherwise.

oauthClientIdstring

The OAuth client id of your OIDC provider. This field is mandatory for OIDC IdP.

oauthClientSecretstring

The OAuth client secret of your OIDC provider. This field is mandatory for OIDC IdP.

oauthCustomAuthAttributesobject

Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.

oauthCustomScopesstring[] nullable

List of additional OAuth scopes which may be required by other providers (e.g. Snowflake)

oauthIssuerIdstring

Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.

oauthIssuerLocationstring

The location of your OIDC provider. This field is mandatory for OIDC IdP.

oauthSubjectIdClaimstring

Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'.

samlMetadatastring

Base64 encoded xml document with SAML metadata. This document is issued by your SAML provider. It includes the issuer's name, expiration information, and keys that can be used to validate the response from the identity provider. This field is mandatory for SAML IdP.

Example request

[
  {
    "id": "filterView-1",
    "identifiers": [
      "gooddata.com"
    ],
    "oauthIssuerId": "myOidcProvider",
    "oauthSubjectIdClaim": "oid"
  }
]

Response

All identity providers set.

Changes

No recorded changes to this operation across all 1 revision of this API.