Documentation

Mistake on this page? Email us

SubtenantIdentityProvider repository

Hierarchy

Index

Constructors

constructor

Properties

client

client: Client

The repository client instance

config

config: Config

The repository configuration class

Methods

create

  • create

    Parameters

    • request: SubtenantIdentityProviderCreateRequest

      The entity to perform action on.

    • accountId: string

      The ID of the account the identity provider belongs to.

    • Optional discovery: boolean

      Indicates that the OpenID Connect endpoints and keys should be set using the OpenID Connect Discovery mechanism. The following parameters are set automatically: * authorization_endpoint * token_endpoint * userinfo_endpoint * revocation_endpoint * jwks_uri * keys

    Returns Promise<SubtenantIdentityProvider>

delete

  • delete(accountId: string, id: string): Promise<void>
  • delete

    Parameters

    • accountId: string

      Account ID.

    • id: string

      The ID of the identity provider to delete.

    Returns Promise<void>

deleteServiceProviderCertificate

  • deleteServiceProviderCertificate

    Parameters

    • accountId: string

      The ID of the account the identity provider belongs to.

    • id: string

      Entity ID.

    Returns Promise<SubtenantIdentityProvider>

generateServiceProviderCertificate

list

read

  • read

    Parameters

    • accountId: string

      The ID of the account the identity provider belongs to.

    • id: string

      Entity ID.

    Returns Promise<SubtenantIdentityProvider>

refreshTokens

  • refreshTokens

    Parameters

    • accountId: string

      The ID of the account the identity provider belongs to.

    • id: string

      Entity ID.

    Returns Promise<SubtenantIdentityProvider>

update

  • update

    Parameters

    • request: SubtenantIdentityProviderUpdateRequest

      The entity to perform action on.

    • accountId: string

      The ID of the account the identity provider belongs to.

    • id: string

      Entity ID.

    • Optional discovery: boolean

      Indicates that the OpenID Connect endpoints and keys should be set using the OpenID Connect Discovery mechanism. The following parameters are set automatically: * authorization_endpoint * token_endpoint * userinfo_endpoint * revocation_endpoint * jwks_uri * keys

    Returns Promise<SubtenantIdentityProvider>