External module "src/helpers/authorization"

Index

Functions

Functions

Const can

can(user: User | string | ApiKeyResponse | AccessTokenResponse, action: Authorizations | OrgScopes | UserScopes, targetType: "user" | "organization" | "membership" | "general", target?: User | Organization | Membership | string): Promise<boolean>

- Defined in src/helpers/authorization.ts:233
Whether a user has authorization to perform an action

Parameters
- user: User | string | ApiKeyResponse | AccessTokenResponse
- action: Authorizations | OrgScopes | UserScopes
- targetType: "user" | "organization" | "membership" | "general"
- Optional target: User | Organization | Membership | string
Returns Promise<boolean>

Const canAccessTokenUser

canAccessTokenUser(accessToken: AccessTokenResponse, action: Authorizations | UserScopes, target: Organization): boolean

- Defined in src/helpers/authorization.ts:66
Whether an API key can perform an action for an organization

Parameters
- accessToken: AccessTokenResponse
- action: Authorizations | UserScopes
- target: Organization
Returns boolean

Const canApiKeyOrganization

canApiKeyOrganization(apiKey: ApiKeyResponse, action: Authorizations | OrgScopes, target: Organization): boolean

- Defined in src/helpers/authorization.ts:199
Whether an API key can perform an action for an organization

Parameters
- apiKey: ApiKeyResponse
- action: Authorizations | OrgScopes
- target: Organization
Returns boolean

Const canUserGeneral

canUserGeneral(user: User, action: Authorizations | OrgScopes): Promise<boolean>

- Defined in src/helpers/authorization.ts:186
Whether a user can perform an action for the backend

Parameters
- user: User
- action: Authorizations | OrgScopes
Returns Promise<boolean>

Const canUserMembership

canUserMembership(user: User, action: Authorizations | OrgScopes, target: Membership): Promise<boolean>

- Defined in src/helpers/authorization.ts:147
Whether a user can perform an action on a membership

Parameters
- user: User
- action: Authorizations | OrgScopes
- target: Membership
Returns Promise<boolean>

Const canUserOrganization

canUserOrganization(user: User, action: Authorizations | OrgScopes, target: Organization): Promise<boolean>

- Defined in src/helpers/authorization.ts:83
Whether a user can perform an action on an organization

Parameters
- user: User
- action: Authorizations | OrgScopes
- target: Organization
Returns Promise<boolean>

Const canUserUser

canUserUser(user: User, action: Authorizations | UserScopes, target: User): Promise<boolean>

- Defined in src/helpers/authorization.ts:21
Whether a user can perform an action on another user

Parameters
- user: User
- action: Authorizations | UserScopes
- target: User
Returns Promise<boolean>

Generated using TypeDoc