Class UsersApi

Hierarchy

  • UsersApi
    • UsersApi

Constructors

constructor

Properties

basePath axios configuration

Methods

getSignableRegistration getSignableRegistrationOffchain getUsers registerPassportUser registerPassportUserV2 registerUser

Constructors

constructor

  • new UsersApi(configuration?, basePath?, axios?): UsersApi

  • Parameters

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

    Returns UsersApi

Properties

ProtectedbasePath

basePath: string

Protectedaxios

axios: AxiosInstance

Protectedconfiguration

configuration: undefined | Configuration

Methods

getSignableRegistration

  • getSignableRegistration(requestParameters, options?): Promise<AxiosResponse<GetSignableRegistrationResponse, any>>

  • 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>>

    Summary

    Get operator signature to allow clients to register the user

    Throws

    Memberof

    UsersApi

getSignableRegistrationOffchain

  • getSignableRegistrationOffchain(requestParameters, options?): Promise<AxiosResponse<GetSignableRegistrationOffchainResponse, any>>

  • 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>>

    Summary

    Get encoded details to allow clients to register the user offchain

    Throws

    Memberof

    UsersApi

getUsers

  • getUsers(requestParameters, options?): Promise<AxiosResponse<GetUsersApiResponse, any>>

  • Get stark keys for a registered user

    Parameters

    • requestParameters: UsersApiGetUsersRequest

      Request parameters.

    • Optionaloptions: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<GetUsersApiResponse, any>>

    Summary

    Get stark keys for a registered user

    Throws

    Memberof

    UsersApi

registerPassportUser

  • registerPassportUser(requestParameters, options?): Promise<AxiosResponse<RegisterPassportUserResult, any>>

  • Registers a passport user

    Parameters

    • requestParameters: UsersApiRegisterPassportUserRequest

      Request parameters.

    • Optionaloptions: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<RegisterPassportUserResult, any>>

    Summary

    Registers a passport user

    Throws

    Memberof

    UsersApi

registerPassportUserV2

  • registerPassportUserV2(requestParameters, options?): Promise<AxiosResponse<RegisterPassportUserResult, any>>

  • Registers a passport user

    Parameters

    • requestParameters: UsersApiRegisterPassportUserV2Request

      Request parameters.

    • Optionaloptions: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<RegisterPassportUserResult, any>>

    Summary

    Registers a passport user

    Throws

    Memberof

    UsersApi

registerUser

  • registerUser(requestParameters, options?): Promise<AxiosResponse<RegisterUserResponse, any>>

  • Registers a user

    Parameters

    • requestParameters: UsersApiRegisterUserRequest

      Request parameters.

    • Optionaloptions: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<RegisterUserResponse, any>>

    Summary

    Registers a user

    Throws

    Memberof

    UsersApi

Settings

Member Visibility

On This Page

Constructors
Properties
Methods