Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MembershipsApi

Hierarchy

  • MembershipsApi

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

addMembership

  • addMembership(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<GraphMembership>

  • Create a new membership between a container and subject.

    Parameters

    • params: object
      • apiVersion: string
      • containerDescriptor: string
      • organization: string
      • subjectDescriptor: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<GraphMembership>

checkMembershipExistence

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

  • Check to see if a membership relationship between a container and subject exists.

    Parameters

    • params: object
      • apiVersion: string
      • containerDescriptor: string
      • organization: string
      • subjectDescriptor: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<__type>

getMembership

  • getMembership(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<GraphMembership>

  • Get a membership relationship between a container and subject.

    Parameters

    • params: object
      • apiVersion: string
      • containerDescriptor: string
      • organization: string
      • subjectDescriptor: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<GraphMembership>

listMemberships

  • Get all the memberships where this descriptor is a member in the relationship. The default value for direction is 'up' meaning return all memberships where the subject is a member (e.g. all groups the subject is a member of). Alternatively, passing the direction as 'down' will return all memberships where the subject is a container (e.g. all members of the subject group).

    Parameters

    • params: object
      • apiVersion: string
      • Optional depth?: number
      • Optional direction?: string
      • organization: string
      • subjectDescriptor: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ArrayWrapper<GraphMembership>>

removeMembership

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

  • Deletes a membership between a container and subject.

    Parameters

    • params: object
      • apiVersion: string
      • containerDescriptor: string
      • organization: string
      • subjectDescriptor: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<__type>

Generated using TypeDoc