Class IdentityProvidersClient

Tenant identity-provider collection.

Constructors

constructor

new IdentityProvidersClient(
options: IdentityProvidersClientOptions,
): IdentityProvidersClient
Parameters
- options: IdentityProvidersClientOptions
  The underlying admin client and tenant slug.
Returns IdentityProvidersClient
- Defined in identity-providers/client.ts:88

Methods

claimAccess

claimAccess(options?: RequestOptions): Promise<IdentityAccessClaim>
Claims identity access for the caller.
Parameters
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<IdentityAccessClaim>
The claim result.
- Defined in identity-providers/client.ts:453

create

create(
request: CreateTenantIdentityProviderRequest,
options?: RequestOptions,
): Promise<TenantIdentityProvider>
Creates an OIDC identity provider.
Parameters
- request: CreateTenantIdentityProviderRequest
  The provider fields.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<TenantIdentityProvider>
The created provider.
- Defined in identity-providers/client.ts:146

createApple

createApple(
request: CreateTenantAppleIdentityProviderRequest,
options?: RequestOptions,
): Promise<TenantIdentityProvider>
Creates an Apple identity provider.
Parameters
- request: CreateTenantAppleIdentityProviderRequest
  The provider fields.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<TenantIdentityProvider>
The created provider.
- Defined in identity-providers/client.ts:394

createAzureAd

createAzureAd(
request: CreateTenantAzureAdIdentityProviderRequest,
options?: RequestOptions,
): Promise<TenantIdentityProvider>
Creates a Microsoft Entra ID identity provider.
Parameters
- request: CreateTenantAzureAdIdentityProviderRequest
  The provider fields.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<TenantIdentityProvider>
The created provider.
- Defined in identity-providers/client.ts:294

createGitHub

createGitHub(
request: CreateTenantGitHubIdentityProviderRequest,
options?: RequestOptions,
): Promise<TenantIdentityProvider>
Creates a GitHub identity provider.
Parameters
- request: CreateTenantGitHubIdentityProviderRequest
  The provider fields.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<TenantIdentityProvider>
The created provider.
- Defined in identity-providers/client.ts:316

createGitHubEnterpriseServer

createGitHubEnterpriseServer(
request: CreateTenantGitHubEnterpriseServerIdentityProviderRequest,
options?: RequestOptions,
): Promise<TenantIdentityProvider>
Creates a GitHub Enterprise Server identity provider.
Parameters
- request: CreateTenantGitHubEnterpriseServerIdentityProviderRequest
  The provider fields.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<TenantIdentityProvider>
The created provider.
- Defined in identity-providers/client.ts:332

createGitLab

createGitLab(
request: CreateTenantGitLabIdentityProviderRequest,
options?: RequestOptions,
): Promise<TenantIdentityProvider>
Creates a GitLab identity provider.
Parameters
- request: CreateTenantGitLabIdentityProviderRequest
  The provider fields.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<TenantIdentityProvider>
The created provider.
- Defined in identity-providers/client.ts:356

createGitLabSelfHosted

createGitLabSelfHosted(
request: CreateTenantGitLabSelfHostedIdentityProviderRequest,
options?: RequestOptions,
): Promise<TenantIdentityProvider>
Creates a self-hosted GitLab identity provider.
Parameters
- request: CreateTenantGitLabSelfHostedIdentityProviderRequest
  The provider fields.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<TenantIdentityProvider>
The created provider.
- Defined in identity-providers/client.ts:372

createGoogle

createGoogle(
request: CreateTenantGoogleIdentityProviderRequest,
options?: RequestOptions,
): Promise<TenantIdentityProvider>
Creates a Google identity provider.
Parameters
- request: CreateTenantGoogleIdentityProviderRequest
  The provider fields.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<TenantIdentityProvider>
The created provider.
- Defined in identity-providers/client.ts:273

createJwt

createJwt(
request: CreateTenantJwtIdentityProviderRequest,
options?: RequestOptions,
): Promise<TenantIdentityProvider>
Creates a JWT identity provider.
Parameters
- request: CreateTenantJwtIdentityProviderRequest
  The provider fields.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<TenantIdentityProvider>
The created provider.
- Defined in identity-providers/client.ts:193

createLdap

createLdap(
request: CreateTenantLdapIdentityProviderRequest,
options?: RequestOptions,
): Promise<TenantIdentityProvider>
Creates an LDAP identity provider.
Parameters
- request: CreateTenantLdapIdentityProviderRequest
  The provider fields.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<TenantIdentityProvider>
The created provider.
- Defined in identity-providers/client.ts:237

createOAuth

createOAuth(
request: CreateTenantOAuthIdentityProviderRequest,
options?: RequestOptions,
): Promise<TenantIdentityProvider>
Creates a generic OAuth identity provider.
Parameters
- request: CreateTenantOAuthIdentityProviderRequest
  The provider fields.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<TenantIdentityProvider>
The created provider.
- Defined in identity-providers/client.ts:168

createSaml

createSaml(
request: CreateTenantSamlIdentityProviderRequest,
options?: RequestOptions,
): Promise<TenantIdentityProvider>
Creates a SAML identity provider.
Parameters
- request: CreateTenantSamlIdentityProviderRequest
  The provider fields.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<TenantIdentityProvider>
The created provider.
- Defined in identity-providers/client.ts:216

get

get(idpId: string, options?: RequestOptions): Promise<TenantIdentityProvider>
Gets an identity provider by identifier.
Parameters
- idpId: string
  The identity-provider identifier.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<TenantIdentityProvider>
The hydrated provider.

Throws
NotFoundException When the provider is not visible.
- Defined in identity-providers/client.ts:127

getProvisioning

getProvisioning(options?: RequestOptions): Promise<IdentityProvisioning>
Reads the identity-provisioning settings.
Parameters
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<IdentityProvisioning>
The provisioning settings.
- Defined in identity-providers/client.ts:416

list

list(
options?: ListIdentityProvidersOptions,
): Promise<Paged<TenantIdentityProvider>>
Lists identity providers.
Parameters
- options: ListIdentityProvidersOptions = {}
  Optional filters, pagination, and cancellation signal.
Returns Promise<Paged<TenantIdentityProvider>>
A lazily paginating collection of providers.

Throws
ApiException When the control plane returns a non-success status.
- Defined in identity-providers/client.ts:102

setAutoGrant

setAutoGrant(
    idpId: string,
    enabled: boolean,
    options?: RequestOptions,
): Promise<TenantIdentityProvider>
Enables or disables auto-granting of roles for a provider.
Parameters
- idpId: string
  The identity-provider identifier.
- enabled: boolean
  Whether roles should be auto-granted.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<TenantIdentityProvider>
The updated provider.
- Defined in identity-providers/client.ts:473

updateProvisioning

updateProvisioning(
request: UpdateIdentityProvisioningRequest,
options?: RequestOptions,
): Promise<IdentityProvisioning>
Replaces the identity-provisioning roles.
Parameters
- request: UpdateIdentityProvisioningRequest
  The roles, at most 64.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<IdentityProvisioning>
The updated provisioning settings.

Throws
Error When more than 64 roles are supplied.
- Defined in identity-providers/client.ts:432

Class IdentityProvidersClient

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns IdentityProvidersClient

Methods

claimAccess

Parameters

Returns Promise<IdentityAccessClaim>

create

Parameters

Returns Promise<TenantIdentityProvider>

createApple

Parameters

Returns Promise<TenantIdentityProvider>

createAzureAd

Parameters

Returns Promise<TenantIdentityProvider>

createGitHub

Parameters

Returns Promise<TenantIdentityProvider>

createGitHubEnterpriseServer

Parameters

Returns Promise<TenantIdentityProvider>

createGitLab

Parameters

Returns Promise<TenantIdentityProvider>

createGitLabSelfHosted

Parameters

Returns Promise<TenantIdentityProvider>

createGoogle

Parameters

Returns Promise<TenantIdentityProvider>

createJwt

Parameters

Returns Promise<TenantIdentityProvider>

createLdap

Parameters

Returns Promise<TenantIdentityProvider>

createOAuth

Parameters

Returns Promise<TenantIdentityProvider>

createSaml

Parameters

Returns Promise<TenantIdentityProvider>

get

Parameters

Returns Promise<TenantIdentityProvider>

Throws

getProvisioning

Parameters

Returns Promise<IdentityProvisioning>

list

Parameters

Returns Promise<Paged<TenantIdentityProvider>>

Throws

setAutoGrant

Parameters

Returns Promise<TenantIdentityProvider>

updateProvisioning

Parameters

Returns Promise<IdentityProvisioning>

Throws

Settings

On This Page