Organization
    Cookie Security Configuration
    Organization - Declarative APIs
    Organization - Entity APIs
    Options
    CSP Directives
    JWKS
    Notification Channels
    Identity Providers
      Get all Identity ProvidersgetPost Identity ProviderspostGet Identity ProvidergetPut Identity ProviderputDelete Identity ProviderdeletePatch Identity ProviderpatchGet all identity providers layoutgetSet all identity providersput
Users and User Groups
Permissions
Data Source
Workspaces
Logical Data Model
Analytical Objects
Reporting
Export & Automations
Other
Schemas
powered by Zudoku
OpenAPI definition

Identity Providers (3.50)

Endpoint:/

Get all Identity Providers

GET
/api/v1/entities/identityProviders

Get all Identity Providers › query Parameters

  • filterstring

    Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

  • pageinteger

    Zero-based page index (0..N)

    Default: 0
  • sizeinteger

    The size of the page to be returned

    Default: 20
  • sortstring[]

    Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

  • metaIncludestring[] · unique · style: form

    Include Meta objects.

    Included meta objects

    Enum values:
    page
    all
    ALL

Get all Identity Providers › Responses

Request successfully processed

  • dataobject[] · unique · required
  • linksobject
  • metaobject
GET /api/v1/entities/identityProviders

Post Identity Providers

POST
/api/v1/entities/identityProviders

Post Identity Providers › Request Body

  • dataobject · required

    JSON:API representation of identityProvider entity.

Post Identity Providers › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of identityProvider entity.

  • linksobject
POST /api/v1/entities/identityProviders

Get Identity Provider

GET
/api/v1/entities/identityProviders/{id}

Get Identity Provider › path Parameters

  • idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required

Get Identity Provider › query Parameters

  • filterstring

    Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

Get Identity Provider › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of identityProvider entity.

  • linksobject
GET /api/v1/entities/identityProviders/{id}

Put Identity Provider

PUT
/api/v1/entities/identityProviders/{id}

Put Identity Provider › path Parameters

  • idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required

Put Identity Provider › query Parameters

  • filterstring

    Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

Put Identity Provider › Request Body

  • dataobject · required

    JSON:API representation of identityProvider entity.

Put Identity Provider › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of identityProvider entity.

  • linksobject
PUT /api/v1/entities/identityProviders/{id}

Delete Identity Provider

DELETE
/api/v1/entities/identityProviders/{id}

Delete Identity Provider › path Parameters

  • idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required

Delete Identity Provider › query Parameters

  • filterstring

    Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

Delete Identity Provider › Responses

Successfully deleted

No data returned
DELETE /api/v1/entities/identityProviders/{id}

Patch Identity Provider

PATCH
/api/v1/entities/identityProviders/{id}

Patch Identity Provider › path Parameters

  • idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required

Patch Identity Provider › query Parameters

  • filterstring

    Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

Patch Identity Provider › Request Body

  • dataobject · required

    JSON:API representation of patching identityProvider entity.

Patch Identity Provider › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of identityProvider entity.

  • linksobject
PATCH /api/v1/entities/identityProviders/{id}

Get all identity providers layout

GET
/api/v1/layout/identityProviders

Gets complete layout of identity providers.

Get all identity providers layout › Responses

Retrieved layout of all identity providers.

  • idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required

    FilterView object ID.

    Example: filterView-1
  • customClaimMappingobject · maxLength: 10000

    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.

  • 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.

    Example: ["gooddata.com"]
  • idpTypestring · enum

    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.

    Enum values:
    MANAGED_IDP
    FIM_IDP
    DEX_IDP
    CUSTOM_IDP
  • oauthClientIdstring · maxLength: 255

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

  • oauthClientSecretstring · maxLength: 255

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

  • oauthCustomAuthAttributesobject · maxLength: 10000

    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.

  • oauthCustomScopesarray | null

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

  • oauthIssuerIdstring · maxLength: 255

    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.

    Example: myOidcProvider
  • oauthIssuerLocationstring · maxLength: 255

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

  • oauthSubjectIdClaimstring · maxLength: 255

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

    Example: oid
  • samlMetadatastring · maxLength: 15000

    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.

GET /api/v1/layout/identityProviders

Set all identity providers

PUT
/api/v1/layout/identityProviders

Sets identity providers in organization.

Set all identity providers › Request Body

  • idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required

    FilterView object ID.

    Example: filterView-1
  • customClaimMappingobject · maxLength: 10000

    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.

  • 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.

    Example: ["gooddata.com"]
  • idpTypestring · enum

    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.

    Enum values:
    MANAGED_IDP
    FIM_IDP
    DEX_IDP
    CUSTOM_IDP
  • oauthClientIdstring · maxLength: 255

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

  • oauthClientSecretstring · maxLength: 255

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

  • oauthCustomAuthAttributesobject · maxLength: 10000

    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.

  • oauthCustomScopesarray | null

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

  • oauthIssuerIdstring · maxLength: 255

    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.

    Example: myOidcProvider
  • oauthIssuerLocationstring · maxLength: 255

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

  • oauthSubjectIdClaimstring · maxLength: 255

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

    Example: oid
  • samlMetadatastring · maxLength: 15000

    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.

Set all identity providers › Responses

All identity providers set.

No data returned
PUT /api/v1/layout/identityProviders
Notification ChannelsAPI tokens