Class AuthorizationProvider

Base class shared by all TypeScript SDK provider implementations.

Hierarchy (View Summary)

ProviderBase
- AuthorizationProvider

Constructors

constructor

new AuthorizationProvider(
options: AuthorizationProviderOptions,
): AuthorizationProvider
Parameters
- options: AuthorizationProviderOptions
Returns AuthorizationProvider
Overrides ProviderBase.constructor

Properties

name

name: string

`Readonly`displayName

displayName: string

`Readonly`description

description: string

`Readonly`version

version: string

`Readonly`kind

kind: "authorization" = ...

Methods

resolveName

resolveName(fallback: string): void
Parameters
- fallback: string
Returns void
Inherited from ProviderBase.resolveName

providerMetadata

providerMetadata(): ProviderMetadata
Returns ProviderMetadata
Inherited from ProviderBase.providerMetadata

configureProvider

configureProvider(name: string, config: Record<string, unknown>): Promise<void>
Parameters
- name: string
- config: Record<string, unknown>
Returns Promise<void>
Inherited from ProviderBase.configureProvider

supportsHealthCheck

supportsHealthCheck(): boolean
Returns boolean
Inherited from ProviderBase.supportsHealthCheck

healthCheck

healthCheck(): Promise<void>
Returns Promise<void>
Inherited from ProviderBase.healthCheck

startProvider

startProvider(): Promise<void>
Returns Promise<void>
Inherited from ProviderBase.startProvider

warnings

warnings(): Promise<string[]>
Returns Promise<string[]>
Inherited from ProviderBase.warnings

closeProvider

closeProvider(): Promise<void>
Returns Promise<void>
Inherited from ProviderBase.closeProvider

checkAccess

checkAccess(request: CheckAccessRequest): Promise<CheckAccessResponse>
Parameters
- request: CheckAccessRequest
Returns Promise<CheckAccessResponse>

checkAccessMany

checkAccessMany(
request: CheckAccessManyRequest,
): Promise<CheckAccessManyResponse>
Parameters
- request: CheckAccessManyRequest
Returns Promise<CheckAccessManyResponse>

listRelationships

listRelationships(
request: ListRelationshipsRequest,
): Promise<ListRelationshipsResponse>
Parameters
- request: ListRelationshipsRequest
Returns Promise<ListRelationshipsResponse>

addRelationship

addRelationship(
request: AddRelationshipRequest,
): Promise<AddRelationshipResponse>
Parameters
- request: AddRelationshipRequest
Returns Promise<AddRelationshipResponse>

deleteRelationship

deleteRelationship(
request: DeleteRelationshipRequest,
): Promise<void | DeleteRelationshipResponse>
Parameters
- request: DeleteRelationshipRequest
Returns Promise<void | DeleteRelationshipResponse>

setAuthorizationState

setAuthorizationState(
request: SetAuthorizationStateRequest,
): Promise<SetAuthorizationStateResponse>
Parameters
- request: SetAuthorizationStateRequest
Returns Promise<SetAuthorizationStateResponse>

getActiveModelRef

getActiveModelRef(): Promise<GetActiveModelRefResponse>
Returns Promise<GetActiveModelRefResponse>

setActiveModel

setActiveModel(request: SetActiveModelRequest): Promise<SetActiveModelResponse>
Parameters
- request: SetActiveModelRequest
Returns Promise<SetActiveModelResponse>

listActiveModelResourceTypes

listActiveModelResourceTypes(
request: ListActiveModelResourceTypesRequest,
): Promise<ListActiveModelResourceTypesResponse>
Parameters
- request: ListActiveModelResourceTypesRequest
Returns Promise<ListActiveModelResourceTypesResponse>