Class CredentialRequests

Class providing methods for working with credential requests

Index

Constructors

Methods

create createAction createByCredentials declineCredential delete deleteCredential extendConnection get getDetail list listAppModulesWithCredentials

Constructors

constructor

new CredentialRequests(fetch: FetchFunction): CredentialRequests
Parameters
- fetch: FetchFunction
Returns CredentialRequests
- Defined in src/endpoints/credential-requests.ts:245

Methods

create

create(body: CreateCredentialRequestBody): Promise<CredentialRequest>
Create a new credential request
Parameters
- body: CreateCredentialRequestBody
Returns Promise<CredentialRequest>
- Defined in src/endpoints/credential-requests.ts:289

createAction

createAction(
body: CreateCredentialActionBody,
): Promise<{ publicUri: string; request: CredentialRequest }>
Create a new action for credential creation (connection or key)
Parameters
- body: CreateCredentialActionBody
Returns Promise<{ publicUri: string; request: CredentialRequest }>
- Defined in src/endpoints/credential-requests.ts:362

createByCredentials

createByCredentials(
    body: CreateByCredentialsBody,
): Promise<
    {
        credentials: Credential[];
        publicUri: string;
        request: CredentialRequest;
    },
>
Create a credential request by connection/key types. Use this when you know the exact connection or key types needed.
Parameters
- body: CreateByCredentialsBody
Returns Promise<
    {
        credentials: Credential[];
        publicUri: string;
        request: CredentialRequest;
    },
>
- Defined in src/endpoints/credential-requests.ts:376

declineCredential

declineCredential(credentialId: string, reason?: string): Promise<Credential>
Decline a credential by ID
Parameters
- credentialId: string
- Optionalreason: string
Returns Promise<Credential>
- Defined in src/endpoints/credential-requests.ts:337

delete

delete(requestId: string): Promise<void>
Delete a credential request and all associated credentials (connections and keys) by ID
Parameters
- requestId: string
  The ID of the credential request to delete
Returns Promise<void>
- Defined in src/endpoints/credential-requests.ts:325

deleteCredential

deleteCredential(credentialId: string): Promise<Credential>
Delete a credential and reset its state to pending
Parameters
- credentialId: string
Returns Promise<Credential>
- Defined in src/endpoints/credential-requests.ts:351

extendConnection

extendConnection(
body: ExtendConnectionBody,
): Promise<{ publicUri: string; request: CredentialRequest }>
Extend an existing connection's OAuth scopes. Creates a credential request that the end-user must authorize to grant additional scopes.
Parameters
- body: ExtendConnectionBody
Returns Promise<{ publicUri: string; request: CredentialRequest }>
- Defined in src/endpoints/credential-requests.ts:392

get

get<C extends keyof CredentialRequest = never>(
requestId: string,
options?: GetCredentialRequestOptions<C>,
): Promise<PickColumns<CredentialRequest, C>>
Get a credential request by ID
Type Parameters
- C extends keyof CredentialRequest = never
Parameters
- requestId: string
- options: GetCredentialRequestOptions<C> = {}
Returns Promise<PickColumns<CredentialRequest, C>>
- Defined in src/endpoints/credential-requests.ts:300

getDetail

getDetail(requestId: string): Promise<CredentialRequestDetail>
Get full detail of a credential request including associated credentials
Parameters
- requestId: string
Returns Promise<CredentialRequestDetail>
- Defined in src/endpoints/credential-requests.ts:314

list

list<C extends keyof CredentialRequest = never>(
teamId: number,
options?: ListCredentialRequestsOptions<C>,
): Promise<PickColumns<CredentialRequest, C>[]>
List credential requests for a given team, with optional additional filtering and pagination.
Type Parameters
- C extends keyof CredentialRequest = never
Parameters
- teamId: number
  The team to list credential requests for.
- Optionaloptions: ListCredentialRequestsOptions<C>
  Optional filters (user, provider, status, name) and pagination.
Returns Promise<PickColumns<CredentialRequest, C>[]>
- Defined in src/endpoints/credential-requests.ts:255
list<C extends keyof CredentialRequest = never>(
options: ListCredentialRequestsOptions<C> & { teamId: number },
): Promise<PickColumns<CredentialRequest, C>[]>
Type Parameters
- C extends keyof CredentialRequest = never
Parameters
- options: ListCredentialRequestsOptions<C> & { teamId: number }
Returns Promise<PickColumns<CredentialRequest, C>[]>
Deprecated
Pass teamId as the first argument: list(teamId, options?).
- Defined in src/endpoints/credential-requests.ts:263

listAppModulesWithCredentials

listAppModulesWithCredentials(
appName: string,
appVersion: number | "latest",
): Promise<AppModuleWithCredentials[]>
List all modules of an app that require credentials, along with the required credential type and OAuth scopes. Useful for populating CredentialSelection.appModules when creating a credential request.

For SDK/custom apps, prefix appName with app# — the SDK URL-encodes it.
Parameters
- appName: string
  The app name (e.g. slack, or app#my-custom-app for SDK apps).
- appVersion: number | "latest"
  App major version number, or 'latest' for the most recent version.
Returns Promise<AppModuleWithCredentials[]>
- Defined in src/endpoints/credential-requests.ts:412

Class CredentialRequests

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CredentialRequests

Methods

create

Parameters

Returns Promise<CredentialRequest>

createAction

Parameters

Returns Promise<{ publicUri: string; request: CredentialRequest }>

createByCredentials

Parameters

Returns Promise< { credentials: Credential[]; publicUri: string; request: CredentialRequest; },>

declineCredential

Parameters

Returns Promise<Credential>

delete

Parameters

Returns Promise<void>

deleteCredential

Parameters

Returns Promise<Credential>

extendConnection

Parameters

Returns Promise<{ publicUri: string; request: CredentialRequest }>

get

Type Parameters

Parameters

Returns Promise<PickColumns<CredentialRequest, C>>

getDetail

Parameters

Returns Promise<CredentialRequestDetail>

list

Type Parameters

Parameters

Returns Promise<PickColumns<CredentialRequest, C>[]>

Type Parameters

Parameters

Returns Promise<PickColumns<CredentialRequest, C>[]>

Deprecated

listAppModulesWithCredentials

Parameters

Returns Promise<AppModuleWithCredentials[]>

Settings

On This Page

Returns Promise<
{
credentials: Credential[];
publicUri: string;
request: CredentialRequest;
},
>