Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PermissionsApi

Hierarchy

  • PermissionsApi

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

hasPermissions

  • hasPermissions(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ArrayWrapper<boolean>>

  • Evaluates whether the caller has the specified permissions on the specified set of security tokens.

    Parameters

    • params: object
      • Optional alwaysAllowAdministrators?: boolean
      • apiVersion: string
      • Optional delimiter?: string
      • organization: string
      • permissions: number
      • securityNamespaceId: string
      • Optional tokens?: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ArrayWrapper<boolean>>

hasPermissionsBatch

  • Evaluates multiple permissions for the calling user. Note: This method does not aggregate the results, nor does it short-circuit if one of the permissions evaluates to false.

    Parameters

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

    Returns Promise<PermissionEvaluationBatch>

removePermission

  • removePermission(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<AccessControlEntry>

  • Removes the specified permissions on a security token for a user or group.

    Parameters

    • params: object
      • apiVersion: string
      • descriptor: string
      • organization: string
      • permissions: number
      • securityNamespaceId: string
      • Optional token?: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<AccessControlEntry>

Generated using TypeDoc