Class ScuteAdminApi

Hierarchy

ScuteBaseHttp
- ScuteAdminApi

Index

Constructors

constructor

new ScuteAdminApi(config): ScuteAdminApi
Parameters
- config: ScuteAdminApiConfig
Returns ScuteAdminApi
Overrides ScuteBaseHttp.constructor
- Defined in packages/auth/core/src/ScuteAdminApi.ts:21

Properties

`Protected` appId

appId: UniqueIdentifier

`Protected` `Optional` secretKey

secretKey?: string

`Protected` wretcher

wretcher: Wretch<unknown, unknown, undefined>

Accessors

`Private` _appsPath

get _appsPath(): `/v1/apps/${string}` | `/v1/apps/${number}`
Returns `/v1/apps/${string}` | `/v1/apps/${number}`
- Defined in packages/auth/core/src/ScuteAdminApi.ts:293

`Private` _authPath

get _authPath(): `/v1/auth/${string}` | `/v1/auth/${number}`
Returns `/v1/auth/${string}` | `/v1/auth/${number}`
- Defined in packages/auth/core/src/ScuteAdminApi.ts:297

`Private` _authorizationHeader

get _authorizationHeader(): HeadersInit
Private
Get authorization header for admin (management) API.

Returns HeadersInit
- Defined in packages/auth/core/src/ScuteAdminApi.ts:281

`Private` _v1Path

get _v1Path(): `/v1/${string}` | `/v1/${number}`
Returns `/v1/${string}` | `/v1/${number}`
- Defined in packages/auth/core/src/ScuteAdminApi.ts:289

Methods

activateUser

activateUser(id): Promise<{
    data: null;
    error: BaseHttpError;
} | {
    data: {
        user: ScuteUserData;
    };
    error: null;
}>
Activate a user.
Parameters
- id: UniqueIdentifier
  
  User ID
Returns Promise<{
    data: null;
    error: BaseHttpError;
} | {
    data: {
        user: ScuteUserData;
    };
    error: null;
}>
- Defined in packages/auth/core/src/ScuteAdminApi.ts:160

createUser

createUser(identifier, meta?): Promise<{
    data: null;
    error: BaseHttpError;
} | {
    data: {
        user: ScuteUser;
    };
    error: null;
}>
Create a user (with optional user metadata).
Parameters
- identifier: string
  
  {ScuteIdentifier}
- Optional meta: Metadata
  
  {UserMeta} - User meta
Returns Promise<{
    data: null;
    error: BaseHttpError;
} | {
    data: {
        user: ScuteUser;
    };
    error: null;
}>
- Defined in packages/auth/core/src/ScuteAdminApi.ts:132

deactivateUser

deactivateUser(id): Promise<{
    data: null;
    error: BaseHttpError;
} | {
    data: {
        user: ScuteUserData;
    };
    error: null;
}>
Deactivate a user (a deactivated user will not be able to log in).
Parameters
- id: UniqueIdentifier
  
  User ID
Returns Promise<{
    data: null;
    error: BaseHttpError;
} | {
    data: {
        user: ScuteUserData;
    };
    error: null;
}>
- Defined in packages/auth/core/src/ScuteAdminApi.ts:172

`Protected` delete

delete(url, headers?): BaseResponse<any, BaseHttpError>
Parameters
- url: string
- Optional headers: HeadersInit
Returns BaseResponse<any, BaseHttpError>
Inherited from ScuteBaseHttp.delete
- Defined in packages/auth/core/src/lib/ScuteBaseHttp.ts:91

deleteUser

deleteUser(id): Promise<{
    data: null;
    error: BaseHttpError;
} | {
    data: any;
    error: null;
}>
Delete a user.
Parameters
- id: UniqueIdentifier
  
  User ID
Returns Promise<{
    data: null;
    error: BaseHttpError;
} | {
    data: any;
    error: null;
}>
- Defined in packages/auth/core/src/ScuteAdminApi.ts:202

forceRefresh

forceRefresh(refreshToken): Promise<{
    data: null;
    error: BaseHttpError;
} | {
    data: any;
    error: null;
}>
Generates new access_token with refresh_token
Parameters
- refreshToken: string
  
  JWT refresh_token
Returns Promise<{
    data: null;
    error: BaseHttpError;
} | {
    data: any;
    error: null;
}>
- Defined in packages/auth/core/src/ScuteAdminApi.ts:243

`Protected` get

get<T>(url, headers?): BaseResponse<T, BaseHttpError>
Type Parameters
- T
Parameters
- url: string
- Optional headers: HeadersInit
Returns BaseResponse<T, BaseHttpError>
Inherited from ScuteBaseHttp.get
- Defined in packages/auth/core/src/lib/ScuteBaseHttp.ts:26

getAppData

getAppData(): Promise<{
    data: null;
    error: BaseHttpError;
} | {
    data: ScuteAppData;
    error: null;
}>
Get app config data.

Returns Promise<{
    data: null;
    error: BaseHttpError;
} | {
    data: ScuteAppData;
    error: null;
}>
- Defined in packages/auth/core/src/ScuteAdminApi.ts:57

getUser

getUser(id): Promise<{
    data: null;
    error: BaseHttpError;
} | {
    data: {
        user: null | ScuteUserData;
    };
    error: null;
}>
Get a user's information (including any defined user metadata).
Parameters
- id: UniqueIdentifier
  
  User ID
Returns Promise<{
    data: null;
    error: BaseHttpError;
} | {
    data: {
        user: null | ScuteUserData;
    };
    error: null;
}>
- Defined in packages/auth/core/src/ScuteAdminApi.ts:98

getUserByIdentifier

getUserByIdentifier(identifier): Promise<{
    data: null;
    error: BaseHttpError;
} | {
    data: {
        user: null | ScuteUser;
    };
    error: null;
}>
Get user's basic information by identifier.
- Unauthenticated
Parameters
- identifier: string
  
  {ScuteIdentifier}
Returns Promise<{
    data: null;
    error: BaseHttpError;
} | {
    data: {
        user: null | ScuteUser;
    };
    error: null;
}>
- Defined in packages/auth/core/src/ScuteAdminApi.ts:110

getUserByUserId

getUserByUserId(userId): Promise<{
    data: null;
    error: BaseHttpError;
} | {
    data: {
        user: null | ScuteUser;
    };
    error: null;
}>
Get user's basic information by user id.
- Unauthenticated
Parameters
- userId: UniqueIdentifier
  
  {UniqueIdentifier}
Returns Promise<{
    data: null;
    error: BaseHttpError;
} | {
    data: {
        user: null | ScuteUser;
    };
    error: null;
}>
- Defined in packages/auth/core/src/ScuteAdminApi.ts:121

inviteUser

inviteUser(identifier, meta?): Promise<{
    data: null;
    error: BaseHttpError;
} | {
    data: {
        user: ScuteUserData;
        user_meta_errors?: any;
    };
    error: null;
}>
Create a user with pending status and send invitation. (a pending user will not be able to log in).
Parameters
- identifier: string
  
  {ScuteIdentifier}
- Optional meta: Metadata
  
  {UserMeta} - User meta
Returns Promise<{
    data: null;
    error: BaseHttpError;
} | {
    data: {
        user: ScuteUserData;
        user_meta_errors?: any;
    };
    error: null;
}>
- Defined in packages/auth/core/src/ScuteAdminApi.ts:186

listUserSessions

listUserSessions(id): Promise<{
    data: null;
    error: BaseHttpError;
} | {
    data: ScuteUserSession[];
    error: null;
}>
List all sessions for a user.
Parameters
- id: UniqueIdentifier
  
  User ID
Returns Promise<{
    data: null;
    error: BaseHttpError;
} | {
    data: ScuteUserSession[];
    error: null;
}>
- Defined in packages/auth/core/src/ScuteAdminApi.ts:254

listUsers

listUsers(params?): Promise<{
    data: null;
    error: BaseHttpError;
} | {
    data: {
        pagination: {
            current_page: number;
            next_page: null | number;
            per_page: number;
            prev_page: null | number;
            total_pages: number;
        };
        users: ScuteUserData[];
    };
    error: null;
}>
Get a list of users.
Parameters
- Optional params: ListUsersRequestParams
Returns Promise<{
    data: null;
    error: BaseHttpError;
} | {
    data: {
        pagination: {
            current_page: number;
            next_page: null | number;
            per_page: number;
            prev_page: null | number;
            total_pages: number;
        };
        users: ScuteUserData[];
    };
    error: null;
}>
- Defined in packages/auth/core/src/ScuteAdminApi.ts:64

`Protected` patch

patch<T>(url, data, headers?): BaseResponse<T, BaseHttpError>
Type Parameters
- T
Parameters
- url: string
- data: any
- Optional headers: HeadersInit
Returns BaseResponse<T, BaseHttpError>
Inherited from ScuteBaseHttp.patch
- Defined in packages/auth/core/src/lib/ScuteBaseHttp.ts:74

`Protected` post

post<T>(url, data, headers?): BaseResponse<T, BaseHttpError>
Type Parameters
- T
Parameters
- url: string
- data: any
- Optional headers: HeadersInit
Returns BaseResponse<T, BaseHttpError>
Inherited from ScuteBaseHttp.post
- Defined in packages/auth/core/src/lib/ScuteBaseHttp.ts:40

`Protected` put

put<T>(url, data, headers?): BaseResponse<T, BaseHttpError>
Type Parameters
- T
Parameters
- url: string
- data: any
- Optional headers: HeadersInit
Returns BaseResponse<T, BaseHttpError>
Inherited from ScuteBaseHttp.put
- Defined in packages/auth/core/src/lib/ScuteBaseHttp.ts:57

refresh

refresh(refreshToken): Promise<{
    data: null;
    error: BaseHttpError;
} | {
    data: any;
    error: null;
}>
Refresh
Parameters
- refreshToken: string
  
  JWT refresh_token
Returns Promise<{
    data: null;
    error: BaseHttpError;
} | {
    data: any;
    error: null;
}>
- Defined in packages/auth/core/src/ScuteAdminApi.ts:222

refreshWithAccess

refreshWithAccess(accessToken): Promise<{
    data: null;
    error: BaseHttpError;
} | {
    data: any;
    error: null;
}>
Refresh with access_token
Parameters
- accessToken: string
  
  JWT access_token
Returns Promise<{
    data: null;
    error: BaseHttpError;
} | {
    data: any;
    error: null;
}>
- Defined in packages/auth/core/src/ScuteAdminApi.ts:232

revokeUserSession

revokeUserSession(userId, sessionId): Promise<{
    data: null;
    error: BaseHttpError;
} | {
    data: any;
    error: null;
}>
Revoke a particular session from a user.
Parameters
- userId: UniqueIdentifier
  
  User ID
- sessionId: UniqueIdentifier
  
  Session ID
Returns Promise<{
    data: null;
    error: BaseHttpError;
} | {
    data: any;
    error: null;
}>
- Defined in packages/auth/core/src/ScuteAdminApi.ts:268

setSecretKey

setSecretKey(secretKey): Promise<void>
Set secret key for admin (management) API.
Parameters
- secretKey: string
  
  Secret Key
Returns Promise<void>
- Defined in packages/auth/core/src/ScuteAdminApi.ts:44

signOut

signOut(accessToken): Promise<{
    data: null;
    error: BaseHttpError;
} | {
    data: any;
    error: null;
}>
Sign out
Parameters
- accessToken: string
  
  JWT access_token
Returns Promise<{
    data: null;
    error: BaseHttpError;
} | {
    data: any;
    error: null;
}>
- Defined in packages/auth/core/src/ScuteAdminApi.ts:212

updateUser

updateUser(id, data): Promise<{
    data: null;
    error: BaseHttpError;
} | {
    data: {
        user: ScuteUserData;
    };
    error: null;
}>
Update a user's information (email address or phone number).
Parameters
- id: UniqueIdentifier
  
  User ID
- data: any
  
  any
Returns Promise<{
    data: null;
    error: BaseHttpError;
} | {
    data: {
        user: ScuteUserData;
    };
    error: null;
}>
- Defined in packages/auth/core/src/ScuteAdminApi.ts:148

Class ScuteAdminApi

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

config: ScuteAdminApiConfig

Returns ScuteAdminApi

Properties

Protected appId

Protected Optional secretKey

Protected wretcher

Accessors

Private _appsPath

Returns `/v1/apps/${string}` | `/v1/apps/${number}`

Private _authPath

Returns `/v1/auth/${string}` | `/v1/auth/${number}`

Private _authorizationHeader

Returns HeadersInit

Private _v1Path

Returns `/v1/${string}` | `/v1/${number}`

Methods

activateUser

Parameters

id: UniqueIdentifier

Returns Promise<{ data: null; error: BaseHttpError; } | { data: { user: ScuteUserData; }; error: null; }>

createUser

Parameters

identifier: string

Optional meta: Metadata

Returns Promise<{ data: null; error: BaseHttpError; } | { data: { user: ScuteUser; }; error: null; }>

deactivateUser

Parameters

id: UniqueIdentifier

Returns Promise<{ data: null; error: BaseHttpError; } | { data: { user: ScuteUserData; }; error: null; }>

Protected delete

Parameters

url: string

Optional headers: HeadersInit

Returns BaseResponse<any, BaseHttpError>

deleteUser

Parameters

id: UniqueIdentifier

Returns Promise<{ data: null; error: BaseHttpError; } | { data: any; error: null; }>

forceRefresh

Parameters

refreshToken: string

Returns Promise<{ data: null; error: BaseHttpError; } | { data: any; error: null; }>

Protected get

Type Parameters

T

Parameters

url: string

Optional headers: HeadersInit

Returns BaseResponse<T, BaseHttpError>

getAppData

Returns Promise<{ data: null; error: BaseHttpError; } | { data: ScuteAppData; error: null; }>

getUser

Parameters

id: UniqueIdentifier

Returns Promise<{ data: null; error: BaseHttpError; } | { data: { user: null | ScuteUserData; }; error: null; }>

getUserByIdentifier

Parameters

identifier: string

Returns Promise<{ data: null; error: BaseHttpError; } | { data: { user: null | ScuteUser; }; error: null; }>

getUserByUserId

Parameters

userId: UniqueIdentifier

Returns Promise<{ data: null; error: BaseHttpError; } | { data: { user: null | ScuteUser; }; error: null; }>

inviteUser

Parameters

identifier: string

Optional meta: Metadata

Returns Promise<{ data: null; error: BaseHttpError; } | { data: { user: ScuteUserData; user_meta_errors?: any; }; error: null; }>

listUserSessions

Parameters

`Protected` appId

`Protected` `Optional` secretKey

`Protected` wretcher

`Private` _appsPath

`Private` _authPath

`Private` _authorizationHeader

`Private` _v1Path

Returns Promise<{
data: null;
error: BaseHttpError;
} | {
data: {
user: ScuteUserData;
};
error: null;
}>

`Optional` meta: Metadata

Returns Promise<{
data: null;
error: BaseHttpError;
} | {
data: {
user: ScuteUser;
};
error: null;
}>

Returns Promise<{
data: null;
error: BaseHttpError;
} | {
data: {
user: ScuteUserData;
};
error: null;
}>

`Protected` delete

`Optional` headers: HeadersInit

Returns Promise<{
data: null;
error: BaseHttpError;
} | {
data: any;
error: null;
}>

Returns Promise<{
data: null;
error: BaseHttpError;
} | {
data: any;
error: null;
}>

`Protected` get

`Optional` headers: HeadersInit

Returns Promise<{
data: null;
error: BaseHttpError;
} | {
data: ScuteAppData;
error: null;
}>

Returns Promise<{
data: null;
error: BaseHttpError;
} | {
data: {
user: null | ScuteUserData;
};
error: null;
}>

Returns Promise<{
data: null;
error: BaseHttpError;
} | {
data: {
user: null | ScuteUser;
};
error: null;
}>

Returns Promise<{
data: null;
error: BaseHttpError;
} | {
data: {
user: null | ScuteUser;
};
error: null;
}>

`Optional` meta: Metadata

Returns Promise<{
data: null;
error: BaseHttpError;
} | {
data: {
user: ScuteUserData;
user_meta_errors?: any;
};
error: null;
}>

Returns Promise<{
data: null;
error: BaseHttpError;
} | {
data: ScuteUserSession[];
error: null;
}>

`Optional` params: ListUsersRequestParams

Returns Promise<{
data: null;
error: BaseHttpError;
} | {
data: {
pagination: {
current_page: number;
next_page: null | number;
per_page: number;
prev_page: null | number;
total_pages: number;
};
users: ScuteUserData[];
};
error: null;
}>

`Protected` patch

`Optional` headers: HeadersInit

`Protected` post

`Optional` headers: HeadersInit

`Protected` put

`Optional` headers: HeadersInit

Returns Promise<{
data: null;
error: BaseHttpError;
} | {
data: any;
error: null;
}>

Returns Promise<{
data: null;
error: BaseHttpError;
} | {
data: any;
error: null;
}>

Returns Promise<{
data: null;
error: BaseHttpError;
} | {
data: any;
error: null;
}>

Returns Promise<{
data: null;
error: BaseHttpError;
} | {
data: any;
error: null;
}>

Returns Promise<{
data: null;
error: BaseHttpError;
} | {
data: {
user: ScuteUserData;
};
error: null;
}>