IamUsers | @tillhub/javascript-sdk

Hierarchy

ThBaseHandler
- IamUsers

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new IamUsers(options: IamUsersOptions, http: Client): IamUsers

Overrides ThBaseHandler.constructor
- Defined in src/v0/iam_users.ts:76
Parameters
- options: IamUsersOptions
- http: Client
Returns IamUsers

Properties

endpoint

endpoint: string

http

http: Client

options

options: IamUsersOptions

uriHelper

uriHelper: UriHelper

Static baseEndpoint

baseEndpoint: string = '/api/v0/iam/users'

Methods

acknowledgeFirstLogin

acknowledgeFirstLogin(tenantId: string): Promise<IamUserResponse>

- Defined in src/v0/iam_users.ts:331
Parameters
- tenantId: string
Returns Promise<IamUserResponse>

create

create(iamUser: IamUser): Promise<IamUserResponse>

- Defined in src/v0/iam_users.ts:191
Parameters
- iamUser: IamUser
Returns Promise<IamUserResponse>

delete

delete(iamUserId: string): Promise<IamUserResponse>

- Defined in src/v0/iam_users.ts:211
Parameters
- iamUserId: string
Returns Promise<IamUserResponse>

deleteGuestConnection

deleteGuestConnection(iamUserId: string): Promise<IamUserResponse>

- Defined in src/v0/iam_users.ts:231
Parameters
- iamUserId: string
Returns Promise<IamUserResponse>

get

get(iamUserId: string): Promise<IamUserResponse>

- Defined in src/v0/iam_users.ts:131
Parameters
- iamUserId: string
Returns Promise<IamUserResponse>

getAll

getAll(query?: IamUsersQueryHandler): Promise<IamUsersResponse>

- Defined in src/v0/iam_users.ts:88
Parameters
- Optional query: IamUsersQueryHandler
Returns Promise<IamUsersResponse>

meta

meta(query?: IamUsersQueryHandler): Promise<IamUsersResponse>

- Defined in src/v0/iam_users.ts:113
Parameters
- Optional query: IamUsersQueryHandler
Returns Promise<IamUsersResponse>

profile

profile(iamUserId: string): Promise<IamUserResponse>

- Defined in src/v0/iam_users.ts:151
Parameters
- iamUserId: string
Returns Promise<IamUserResponse>

put

put(iamUserId: string, iamUser: IamUser): Promise<IamUserResponse>

- Defined in src/v0/iam_users.ts:171
Parameters
- iamUserId: string
- iamUser: IamUser
Returns Promise<IamUserResponse>

resendInvite

resendInvite(iamUserId: string): Promise<IamUserResponse>

- Defined in src/v0/iam_users.ts:311
Parameters
- iamUserId: string
Returns Promise<IamUserResponse>

reset2fa

reset2fa(iamUserId: string): Promise<IamUserResponse>

- Defined in src/v0/iam_users.ts:271
Parameters
- iamUserId: string
Returns Promise<IamUserResponse>

sendBackupCodesRegenerationEmail

sendBackupCodesRegenerationEmail(iamUserId: string): Promise<IamUserResponse>

- Defined in src/v0/iam_users.ts:291
Parameters
- iamUserId: string
Returns Promise<IamUserResponse>

updateGuestConnection

updateGuestConnection(iamUserId: string, iamUser: IamUser): Promise<IamUserResponse>

- Defined in src/v0/iam_users.ts:251
Parameters
- iamUserId: string
- iamUser: IamUser
Returns Promise<IamUserResponse>

Generated using TypeDoc