Class AdminUsers

Hierarchy

AdminUsers

Index

Properties

impersonating

Methods

As Create Delete Get List Patch RevokeUserTokens Save UnlockUserAccount

Properties

`Private` impersonating

impersonating: boolean = false

Methods

As

As(): AdminUsers
Description
enables impersonation by calling the subsequent method with the stored impersonation token

Example
```
AdminUsers.As().List() // lists AdminUsers using the impersonated users' token
```
Returns AdminUsers
- Defined in api/AdminUsers.ts:212

Create

Create<TUser>(user: User<any>, requestOptions?: RequestOptions): Promise<RequiredDeep<TUser>>
Create a new admin user. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. Check out the docs for more info
Type Parameters
- TUser extends User<any, TUser>
Parameters
- user: User<any>
  
  Required fields: Username, FirstName, LastName, Email, Active
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TUser>>
- Defined in api/AdminUsers.ts:65

Delete

Delete(userID: string, requestOptions?: RequestOptions): Promise<void>
Delete an admin user. Check out the docs for more info
Parameters
- userID: string
  
  ID of the user.
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/AdminUsers.ts:129

Get

Get<TUser>(userID: string, requestOptions?: RequestOptions): Promise<RequiredDeep<TUser>>
Get a single admin user. Check out the docs for more info
Type Parameters
- TUser extends User<any, TUser>
Parameters
- userID: string
  
  ID of the user.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TUser>>
- Defined in api/AdminUsers.ts:86

List

List<TUser>(listOptions?: {
    filters?: Filters;
    page?: number;
    pageSize?: number;
    search?: string;
    searchOn?: ("ID" | "LastName" | "FirstName" | "Username" | "Email")[];
    sortBy?: ("ID" | "LastName" | "FirstName" | "Username" | "Email" | "DateCreated" | "!ID" | "!DateCreated" | "!FirstName" | "!LastName" | "PasswordLastSetDate" | "!Username" | "!Email" | "!PasswordLastSetDate")[];
}, requestOptions?: RequestOptions): Promise<RequiredObjectDeep<ListPage<TUser>>>
Get a list of admin users. Check out the docs for more info
Type Parameters
- TUser extends User<any, TUser>
Parameters
- listOptions: {
      filters?: Filters;
      page?: number;
      pageSize?: number;
      search?: string;
      searchOn?: ("ID" | "LastName" | "FirstName" | "Username" | "Email")[];
      sortBy?: ("ID" | "LastName" | "FirstName" | "Username" | "Email" | "DateCreated" | "!ID" | "!DateCreated" | "!FirstName" | "!LastName" | "PasswordLastSetDate" | "!Username" | "!Email" | "!PasswordLastSetDate")[];
  } = {}
  - Optional filters?: Filters
    
    An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'
  - Optional page?: number
    
    Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
  - Optional pageSize?: number
    
    Number of results to return per page. Default: 20, max: 100.
  - Optional search?: string
    
    Word or phrase to search for.
  - Optional searchOn?: ("ID" | "LastName" | "FirstName" | "Username" | "Email")[]
    
    Comma-delimited list of fields to search on.
  - Optional sortBy?: ("ID" | "LastName" | "FirstName" | "Username" | "Email" | "DateCreated" | "!ID" | "!DateCreated" | "!FirstName" | "!LastName" | "PasswordLastSetDate" | "!Username" | "!Email" | "!PasswordLastSetDate")[]
    
    Comma-delimited list of fields to sort by.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredObjectDeep<ListPage<TUser>>>
- Defined in api/AdminUsers.ts:44

Patch

Patch<TUser>(userID: string, user: PartialObjectDeep<User<any>>, requestOptions?: RequestOptions): Promise<RequiredDeep<TUser>>
Partially update an admin user. Check out the docs for more info
Type Parameters
- TUser extends User<any, TUser>
Parameters
- userID: string
  
  ID of the user.
- user: PartialObjectDeep<User<any>>
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TUser>>
- Defined in api/AdminUsers.ts:151

RevokeUserTokens

RevokeUserTokens(userID: string, requestOptions?: RequestOptions): Promise<void>
Revoke a user tokens. Revokes all security tokens of specified user. Check out the docs for more info
Parameters
- userID: string
  
  ID of the user.
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/AdminUsers.ts:172

Save

Save<TUser>(userID: string, user: User<any>, requestOptions?: RequestOptions): Promise<RequiredDeep<TUser>>
Create or update an admin user. If an object with the same ID already exists, it will be overwritten. Check out the docs for more info
Type Parameters
- TUser extends User<any, TUser>
Parameters
- userID: string
  
  ID of the user.
- user: User<any>
  
  Required fields: Username, FirstName, LastName, Email, Active
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TUser>>
- Defined in api/AdminUsers.ts:108

UnlockUserAccount

UnlockUserAccount(userID: string, requestOptions?: RequestOptions): Promise<void>
Unlock a user account. Check out the docs for more info
Parameters
- userID: string
  
  ID of the user.
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/AdminUsers.ts:193

Class AdminUsers

Hierarchy

Index

Properties

Methods

Properties

Private impersonating

Methods

As

Description

Example

Returns AdminUsers

Create

Type Parameters

TUser extends User<any, TUser>

Parameters

user: User<any>

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TUser>>

Delete

Parameters

userID: string

requestOptions: RequestOptions = {}

Returns Promise<void>

Get

Type Parameters

TUser extends User<any, TUser>

Parameters

userID: string

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TUser>>

List

Type Parameters

TUser extends User<any, TUser>

Parameters

Optional filters?: Filters

Optional page?: number

Optional pageSize?: number

Optional search?: string

Optional searchOn?: ("ID" | "LastName" | "FirstName" | "Username" | "Email")[]

Optional sortBy?: ("ID" | "LastName" | "FirstName" | "Username" | "Email" | "DateCreated" | "!ID" | "!DateCreated" | "!FirstName" | "!LastName" | "PasswordLastSetDate" | "!Username" | "!Email" | "!PasswordLastSetDate")[]

requestOptions: RequestOptions = {}

Returns Promise<RequiredObjectDeep<ListPage<TUser>>>

Patch

Type Parameters

TUser extends User<any, TUser>

Parameters

userID: string

user: PartialObjectDeep<User<any>>

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TUser>>

RevokeUserTokens

Parameters

userID: string

requestOptions: RequestOptions = {}

Returns Promise<void>

Save

Type Parameters

TUser extends User<any, TUser>

Parameters

userID: string

user: User<any>

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TUser>>

UnlockUserAccount

Parameters

userID: string

requestOptions: RequestOptions = {}

Returns Promise<void>

Settings

Member Visibility

Theme

`Private` impersonating

`Optional` filters?: Filters

`Optional` page?: number

`Optional` pageSize?: number

`Optional` search?: string

`Optional` searchOn?: ("ID" | "LastName" | "FirstName" | "Username" | "Email")[]

`Optional` sortBy?: ("ID" | "LastName" | "FirstName" | "Username" | "Email" | "DateCreated" | "!ID" | "!DateCreated" | "!FirstName" | "!LastName" | "PasswordLastSetDate" | "!Username" | "!Email" | "!PasswordLastSetDate")[]