Class UsersResource

Users management resource

Hierarchy

BaseResource
- UsersResource

Constructors

constructor

new UsersResource(client: TenantosClient): UsersResource
Parameters
- client: TenantosClient
Returns UsersResource
Inherited from BaseResource.constructor
- Defined in resources.ts:85

Properties

`Protected` `Readonly`client

client: TenantosClient

`Readonly`sshKeys

sshKeys: {
    create: (user: number, data: Partial<SSHKey>) => Promise<SSHKey>;
    delete: (user: number, id: number) => Promise<void>;
    get: (user: number, id: number) => Promise<SSHKey>;
    list: (user: number) => Promise<SSHKey[]>;
    update: (
        user: number,
        id: number,
        data: Partial<SSHKey>,
    ) => Promise<SSHKey>;
} = ...

`Readonly`tokens

tokens: {
    create: (user: number, data: Partial<UserToken>) => Promise<UserToken>;
    delete: (user: number, id: number) => Promise<void>;
    get: (user: number, id: number) => Promise<UserToken>;
    list: (user: number) => Promise<UserToken[]>;
    update: (
        user: number,
        id: number,
        data: Partial<UserToken>,
    ) => Promise<UserToken>;
} = ...

`Readonly`twoFactor

twoFactor: {
disable: (user: number) => Promise<void>;
enable: (user: number, data: any) => Promise<void>;
} = ...

Methods

addAdditionalUserInformation

addAdditionalUserInformation(data: any): Promise<void>
Parameters
- data: any
Returns Promise<void>
- Defined in resources.ts:1342

create

create(
    data: {
        accountstatus?: string;
        allowedHosts?: string[];
        darkmode?: string;
        datetimeFormat?: string;
        description?: string;
        email?: string;
        language?: string;
        name: string;
        password: string;
        role_id?: number;
        root_owner?: number;
        sessionTimeout?: string;
        timezone?: string;
        username: string;
    },
): Promise<User>
Parameters
- data: {
      accountstatus?: string;
      allowedHosts?: string[];
      darkmode?: string;
      datetimeFormat?: string;
      description?: string;
      email?: string;
      language?: string;
      name: string;
      password: string;
      role_id?: number;
      root_owner?: number;
      sessionTimeout?: string;
      timezone?: string;
      username: string;
  }
  - Optionalaccountstatus?: string
    Description
    Must be one of enabled or disabled.
    
    Example
    disabled
  - OptionalallowedHosts?: string[]
    Description
    Must be an array of valid IP addresses. Login will be restricted to the specified IPs. Leave empty to allow all IPs.
    
    Example
    [ "consectetur" ]
  - Optionaldarkmode?: string
    Description
    Must be one of 0 or 1.
    
    Example
    0
  - OptionaldatetimeFormat?: string
    Example
    nisi
  - Optionaldescription?: string
    Example
    nam
  - Optionalemail?: string
    Description
    Must be a valid email address.
    
    Example
    ismael59@example.org
  - Optionallanguage?: string
    Example
    qui
  - name: string
    Example
    iste
  - password: string
    Example
    similique
  - Optionalrole_id?: number
    Example
    14
  - Optionalroot_owner?: number
    Example
    10
  - OptionalsessionTimeout?: string
    Example
    null
  - Optionaltimezone?: string
    Description
    Must be a valid time zone, such as Africa/Accra.
    
    Example
    Asia/Macau
  - username: string
    Description
    Must not be greater than 255 characters.
    
    Example
    zuskpxhvdkxhnytwumiwzhnehokvxqrvqifveopjgfzjrmiriskpczuxlmajdotbnipbctcgnxqzrcwpmgdywkfmvhklmesbcvlqjwcnhhmlfnmnypcaohmomdfngoygyagnsbydmyradyhilvsypjztyovlielivlfdwnughxsklnxknyxwgtipjqobulrrdexsibcprbapnriekmgcjbcccbmdrnyemduvyalhmflehwbufxgzajreawcqxch
Returns Promise<User>
- Defined in resources.ts:1251

delete

delete(id: number): Promise<void>
Parameters
- id: number
Returns Promise<void>
- Defined in resources.ts:1281

generateSsoToken

generateSsoToken(user: number): Promise<string>
Parameters
- user: number
Returns Promise<string>
- Defined in resources.ts:1350

get

get(id: number): Promise<User>
Parameters
- id: number
Returns Promise<User>
- Defined in resources.ts:1236

getAccessLog

getAccessLog(userId: number): Promise<any[]>
Parameters
- userId: number
Returns Promise<any[]>
- Defined in resources.ts:1314

getCurrentUser

getCurrentUser(): Promise<User>
Returns Promise<User>
- Defined in resources.ts:1290

getLoginHistory

getLoginHistory(userId: number): Promise<any[]>
Parameters
- userId: number
Returns Promise<any[]>
- Defined in resources.ts:1303

list

list(options?: ListOptions<UserFilters>): Promise<User[]>
Parameters
- options: ListOptions<UserFilters> = {}
Returns Promise<User[]>
- Defined in resources.ts:1224

`Protected`request

request<T>(config: RequestConfig): Promise<ApiResponse<T>>
Make a request to the API with automatic error handling
Type Parameters
- T
Parameters
- config: RequestConfig
Returns Promise<ApiResponse<T>>
Inherited from BaseResource.request
- Defined in resources.ts:90

startImpersonation

startImpersonation(impersonateUserId: number): Promise<void>
Parameters
- impersonateUserId: number
Returns Promise<void>
- Defined in resources.ts:1362

stopImpersonation

stopImpersonation(impersonateUserId: number): Promise<void>
Parameters
- impersonateUserId: number
Returns Promise<void>
- Defined in resources.ts:1371

testLoginDetails

testLoginDetails(data: any): Promise<OperationResult<unknown>>
Parameters
- data: any
Returns Promise<OperationResult<unknown>>
- Defined in resources.ts:1325

update

update(id: number, data: Partial<CreateUserRequest>): Promise<User>
Parameters
- id: number
- data: Partial<CreateUserRequest>
Returns Promise<User>
- Defined in resources.ts:1265

`Protected`validateId

validateId(id: number, resourceName?: string): void
Validate that an ID is a positive integer
Parameters
- id: number
- resourceName: string = 'Resource'
Returns void
Inherited from BaseResource.validateId
- Defined in resources.ts:97

`Protected`validateRequiredString

validateRequiredString(value: string, fieldName: string): void
Validate required string field
Parameters
- value: string
- fieldName: string
Returns void
Inherited from BaseResource.validateRequiredString
- Defined in resources.ts:106

Class UsersResource

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns UsersResource

Properties

Protected Readonlyclient

ReadonlysshKeys

Readonlytokens

ReadonlytwoFactor

Methods

addAdditionalUserInformation

Parameters

Returns Promise<void>

create

Parameters

Optionalaccountstatus?: string

Description

Example

OptionalallowedHosts?: string[]

Description

Example

Optionaldarkmode?: string

Description

Example

OptionaldatetimeFormat?: string

Example

Optionaldescription?: string

Example

Optionalemail?: string

Description

Example

Optionallanguage?: string

Example

name: string

Example

password: string

Example

Optionalrole_id?: number

Example

Optionalroot_owner?: number

Example

OptionalsessionTimeout?: string

Example

Optionaltimezone?: string

Description

Example

username: string

Description

Example

Returns Promise<User>

delete

Parameters

Returns Promise<void>

generateSsoToken

Parameters

Returns Promise<string>

get

Parameters

Returns Promise<User>

getAccessLog

Parameters

Returns Promise<any[]>

getCurrentUser

Returns Promise<User>

getLoginHistory

Parameters

Returns Promise<any[]>

list

Parameters

Returns Promise<User[]>

Protectedrequest

Type Parameters

Parameters

Returns Promise<ApiResponse<T>>

`Protected` `Readonly`client

`Readonly`sshKeys

`Readonly`tokens

`Readonly`twoFactor

`Optional`accountstatus?: string

`Optional`allowedHosts?: string[]

`Optional`darkmode?: string

`Optional`datetimeFormat?: string

`Optional`description?: string

`Optional`email?: string

`Optional`language?: string

`Optional`role_id?: number

`Optional`root_owner?: number

`Optional`sessionTimeout?: string

`Optional`timezone?: string

`Protected`request

`Protected`validateId

`Protected`validateRequiredString