Class UsersApi

Hierarchy

  • UsersApi
    • UsersApi

Constructors

  • Parameters

    • Optionalconfiguration: Configuration
    • OptionalbasePath: string
    • Optionalaxios: AxiosInstance

    Returns UsersApi

Properties

basePath: string
axios: AxiosInstance
configuration: undefined | Configuration

Methods

  • Get operator signature to allow clients to register the user

    Parameters

    • requestParameters: UsersApiGetSignableRegistrationRequest

      Request parameters.

    • Optionaloptions: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<GetSignableRegistrationResponse, any>>

    Get operator signature to allow clients to register the user

    UsersApi

  • Get encoded details to allow clients to register the user offchain

    Parameters

    • requestParameters: UsersApiGetSignableRegistrationOffchainRequest

      Request parameters.

    • Optionaloptions: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<GetSignableRegistrationOffchainResponse, any>>

    Get encoded details to allow clients to register the user offchain

    UsersApi

  • Get stark keys for a registered user

    Parameters

    • requestParameters: UsersApiGetUsersRequest

      Request parameters.

    • Optionaloptions: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<GetUsersApiResponse, any>>

    Get stark keys for a registered user

    UsersApi

  • Registers a passport user

    Parameters

    • requestParameters: UsersApiRegisterPassportUserRequest

      Request parameters.

    • Optionaloptions: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<RegisterPassportUserResult, any>>

    Registers a passport user

    UsersApi

  • Registers a passport user

    Parameters

    • requestParameters: UsersApiRegisterPassportUserV2Request

      Request parameters.

    • Optionaloptions: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<RegisterPassportUserResult, any>>

    Registers a passport user

    UsersApi

  • Registers a user

    Parameters

    • requestParameters: UsersApiRegisterUserRequest

      Request parameters.

    • Optionaloptions: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<RegisterUserResponse, any>>

    Registers a user

    UsersApi