Logo DataHubClient

UsersApi Type

Client for the GitLab Users API used by DataHubs. See the .

Constructors

Constructor Description

UsersApi(baseUrl, auth, http)

Full Usage: UsersApi(baseUrl, auth, http)

Parameters:
Returns: UsersApi
baseUrl : string
auth : Authentication
http : IHttpClient
Returns: UsersApi

Instance members

Instance member Description

this.GetAsync

Full Usage: this.GetAsync

Parameters:
    userId : int - The user's unique, instance-wide numeric identifier.

Returns: Async<User>

Gets a user by numeric identifier.

userId : int

The user's unique, instance-wide numeric identifier.

Returns: Async<User>

this.GetCurrentAsync

Full Usage: this.GetCurrentAsync

Returns: Async<User>

Gets the user the configured credential authenticates as, from GitLab's GET /user endpoint.

This is the only endpoint that populates User.Email; users embedded in issues, merge requests, notes, and commits never carry it. Useful for attributing an action to whoever supplied the token.

Returns: Async<User>

Type something to start searching.