Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UserEntitlementsApi

Hierarchy

  • UserEntitlementsApi

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected basePath

basePath: string = "https://dev.azure.com/"

defaultHeaders

defaultHeaders: any

Methods

addUserEntitlement

  • Add a user, assign license and extensions and make them a member of a project group in an account.

    Parameters

    • params: object
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<UserEntitlementsPostResponse>

deleteUserEntitlement

  • deleteUserEntitlement(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<__type>

  • Delete a user from the account. The delete operation includes unassigning Extensions and Licenses and removing the user from all project memberships. The user would continue to have access to the account if she is member of an AAD group, that is added directly to the account.

    Parameters

    • params: object
      • apiVersion: string
      • organization: string
      • userId: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<__type>

getUserEntitlement

  • getUserEntitlement(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<UserEntitlement>

  • Get User Entitlement for a user.

    Parameters

    • params: object
      • apiVersion: string
      • organization: string
      • userId: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<UserEntitlement>

getUserEntitlements

  • getUserEntitlements(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<PagedGraphMemberList>

  • Get a paged set of user entitlements matching the filter criteria. If no filter is is passed, a page from all the account users is returned.

    Parameters

    • params: object
      • apiVersion: string
      • Optional filter?: string
      • organization: string
      • Optional skip?: number
      • Optional sortOption?: string
      • Optional top?: number
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<PagedGraphMemberList>

updateUserEntitlement

  • Edit the entitlements (License, Extensions, Projects, Teams etc) for a user.

    Parameters

    • params: object
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<UserEntitlementsPatchResponse>

updateUserEntitlements

  • Edit the entitlements (License, Extensions, Projects, Teams etc) for one or more users.

    Parameters

    • params: object
      • apiVersion: string
      • body: JsonPatchDocument
      • Optional doNotSendInviteForNewUsers?: boolean
      • organization: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<UserEntitlementOperationReference>

Generated using TypeDoc