Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsersApi

UsersApi - object-oriented interface

export

Hierarchy

Index

Constructors

constructor

Properties

Protected basePath

basePath: string

Protected configuration

configuration: Configuration

Protected fetch

fetch: FetchAPI

Methods

createUser

deleteUser

  • Delete a user from an organization.

    summary

    Delete User

    throws

    {RequiredError}

    memberof

    UsersApi

    Parameters

    • user: string

      user email

    • Optional options: any

    Returns Promise<DeleteUserResponse>

getCurrentUser

  • getCurrentUser(options?: any): Promise<User>
  • Retrieve currently authenticated user.

    summary

    Get Current User

    throws

    {RequiredError}

    memberof

    UsersApi

    Parameters

    • Optional options: any

    Returns Promise<User>

getCurrentUserInviteState

  • getCurrentUserInviteState(options?: any): Promise<InviteState>
  • summary

    Get invite_state for current user's org_membership.

    throws

    {RequiredError}

    memberof

    UsersApi

    Parameters

    • Optional options: any

    Returns Promise<InviteState>

getCurrentUserNux

  • getCurrentUserNux(options?: any): Promise<UserNux>
  • Retrieve currently active user's nux values.

    summary

    Get Current User's Nux Values

    throws

    {RequiredError}

    memberof

    UsersApi

    Parameters

    • Optional options: any

    Returns Promise<UserNux>

getCurrentUserState

  • getCurrentUserState(options?: any): Promise<UserState>
  • summary

    Get state value for user.

    throws

    {RequiredError}

    memberof

    UsersApi

    Parameters

    • Optional options: any

    Returns Promise<UserState>

getCurrentUserTos

getCurrentUserUnchecked

  • getCurrentUserUnchecked(options?: any): Promise<User>
  • Functional in public API server's only - used to bootstrap Console

    summary

    Get Current User

    throws

    {RequiredError}

    memberof

    UsersApi

    Parameters

    • Optional options: any

    Returns Promise<User>

getUserQueryHistory

listUsers

  • Retrieve all users for an organization.

    summary

    List Users

    throws

    {RequiredError}

    memberof

    UsersApi

    Parameters

    • Optional options: any

    Returns Promise<ListUsersResponse>

setCurrentUserInviteState

  • summary

    Set invite_state for current user's org_membership.

    throws

    {RequiredError}

    memberof

    UsersApi

    Parameters

    Returns Promise<InviteState>

setCurrentUserState

  • setCurrentUserState(options?: any): Promise<UserState>
  • summary

    Update state value for user.

    throws

    {RequiredError}

    memberof

    UsersApi

    Parameters

    • Optional options: any

    Returns Promise<UserState>

setCurrentUserTos

  • setCurrentUserTos(options?: any): Promise<Response>
  • summary

    Set accepted_ToS value to true for user.

    throws

    {RequiredError}

    memberof

    UsersApi

    Parameters

    • Optional options: any

    Returns Promise<Response>

updateCurrentUser

  • Update currently active user.

    summary

    Update Current User

    throws

    {RequiredError}

    memberof

    UsersApi

    Parameters

    Returns Promise<User>

updateCurrentUserNux

Generated using TypeDoc