Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "api/user"

Index

Functions

Functions

getUser

  • getUser(username: string, token: string, jenkinsHost: string, user?: undefined | string): Promise<UserResponse>
  • Get user details

    Parameters

    • username: string

      The username of a Jenkins user

    • token: string

      The Jenkins API token associated with the user

    • jenkinsHost: string

      The hostname of the Jenkins instance

    • Optional user: undefined | string

      The username of a Jenkins user about which information should be returned. Defaults to the authenticating username

    Returns Promise<UserResponse>

Generated using TypeDoc