Class TenantIdentityProvider

A tenant identity provider.

Hierarchy (View Summary)

Entity<TenantIdentityProviderData>
- TenantIdentityProvider

Index

Constructors

Properties

Accessors

autoGrantRoles clientId data displayName id idpRef isActive isDeleted issuer lifecycleStatus providerConfig providerType scopes tenantId zitadelProviderId

Methods

delete reload setAutoGrant

Constructors

constructor

new TenantIdentityProvider(
options: EntityOptions<TenantIdentityProviderData>,
): TenantIdentityProvider
Parameters
- options: EntityOptions<TenantIdentityProviderData>
  The client, path, backing data, and delete state.
Returns TenantIdentityProvider
Inherited from Entity.constructor
- Defined in entity.ts:46

Properties

`Protected` `Readonly`client

client: AdminClient

The client used to issue requests for this entity.

`Protected` `Readonly`path

path: string

The client-relative path of this resource.

Accessors

autoGrantRoles

get autoGrantRoles(): boolean
Whether roles are auto-granted.

Returns boolean
- Defined in identity-providers/entity.ts:91

clientId

get clientId(): string | null | undefined
The OAuth client id.

Returns string | null | undefined
- Defined in identity-providers/entity.ts:76

data

get data(): D
The raw wire record backing this entity.

Returns D
Inherited from Entity.data
- Defined in entity.ts:58

displayName

get displayName(): string
Human-readable name.

Returns string
- Defined in identity-providers/entity.ts:56

id

get id(): string
Identity-provider identifier.

Returns string
- Defined in identity-providers/entity.ts:41

idpRef

get idpRef(): string
Immutable idp reference.

Returns string
- Defined in identity-providers/entity.ts:51

isActive

get isActive(): boolean
Whether the provider is active.

Returns boolean
- Defined in identity-providers/entity.ts:96

isDeleted

get isDeleted(): boolean
Whether this entity has been deleted through this instance.

Local state only; not authoritative server state.

Returns boolean
Inherited from Entity.isDeleted
- Defined in entity.ts:69

issuer

get issuer(): string | null | undefined
The OIDC/JWT issuer.

Returns string | null | undefined
- Defined in identity-providers/entity.ts:71

lifecycleStatus

get lifecycleStatus(): IdentityProviderLifecycleStatus
Lifecycle status.

Returns IdentityProviderLifecycleStatus
- Defined in identity-providers/entity.ts:101

providerConfig

get providerConfig(): Readonly<Record<string, unknown>>
Free-form provider configuration.

Returns Readonly<Record<string, unknown>>
- Defined in identity-providers/entity.ts:86

providerType

get providerType(): IdentityProviderType
Provider kind.

Returns IdentityProviderType
- Defined in identity-providers/entity.ts:61

scopes

get scopes(): readonly string[]
The configured scopes.

Returns readonly string[]
- Defined in identity-providers/entity.ts:81

tenantId

get tenantId(): string
Owning tenant identifier.

Returns string
- Defined in identity-providers/entity.ts:46

zitadelProviderId

get zitadelProviderId(): string | null | undefined
The ZITADEL provider identifier.

Returns string | null | undefined
- Defined in identity-providers/entity.ts:66

Methods

delete

delete(): Promise<boolean>
Deletes this resource.

Idempotent per instance: once this instance has deleted the resource, further calls are a local no-op.

Returns Promise<boolean>
true once the resource has been deleted through this instance.

Throws
ApiException When the control plane returns a non-success status.
Inherited from Entity.delete
- Defined in entity.ts:84

reload

reload(options?: RequestOptions): Promise<TenantIdentityProvider>
Re-fetches this provider.
Parameters
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<TenantIdentityProvider>
A fresh snapshot.
- Defined in identity-providers/entity.ts:113

setAutoGrant

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