AuthorizedWRDAPIUser | WebHare Platform SDK

Type Alias AuthorizedWRDAPIUser

Describes a WRD API user authenticated by verifyWRDAPIUser

type AuthorizedWRDAPIUser = {
    accountStatus: WRDAuthAccountStatus | null;
    scopes: string[];
    tokenId: number;
    userId: number;
    wrdSchema: string;
}

Index

Properties

accountStatus scopes tokenId userId wrdSchema

Properties

accountStatus

accountStatus: WRDAuthAccountStatus | null

Entity account status if available

scopes

scopes: string[]

Scopes granted to this API key

tokenId

tokenId: number

ID of the wrd.tokens row the user authenticatd with

userId

userId: number

Authenticated WRD entity#

wrdSchema

wrdSchema: string

WRD schema we've authenticated to