Class ApiKeyAuth

Authentication provider where users identify using an API-key.

Index

Methods

create delete disable enable fetch fetchAll

Methods

create

create(keyName): Promise<SecretApiKey>
Creates an API key that can be used to authenticate as the current user.
Parameters
- keyName: string
  the name of the API key to be created.
Returns Promise<SecretApiKey>
- Defined in packages/realm/src/app-services/ApiKeyAuth.ts:70

delete

delete(keyId): Promise<void>
Deletes an API key associated with the current user.
Parameters
- keyId: string
  the ID of the API key to delete
Returns Promise<void>
- Defined in packages/realm/src/app-services/ApiKeyAuth.ts:97

disable

disable(keyId): Promise<void>
Disable an API key associated with the current user.
Parameters
- keyId: string
  the ID of the API key to disable
Returns Promise<void>
- Defined in packages/realm/src/app-services/ApiKeyAuth.ts:113

enable

enable(keyId): Promise<void>
Enables an API key associated with the current user.
Parameters
- keyId: string
  the ID of the API key to enable
Returns Promise<void>
- Defined in packages/realm/src/app-services/ApiKeyAuth.ts:105

fetch

fetch(keyId): Promise<ApiKey>
Fetches an API key associated with the current user.
Parameters
- keyId: string
  the id of the API key to fetch.
Returns Promise<ApiKey>
- Defined in packages/realm/src/app-services/ApiKeyAuth.ts:80

fetchAll

fetchAll(): Promise<ApiKey[]>
Fetches the API keys associated with the current user.

Returns Promise<ApiKey[]>
- Defined in packages/realm/src/app-services/ApiKeyAuth.ts:88

Generated using TypeDoc