Class SecurityRolesApi

Hierarchy (View Summary)

ClientApiBase
- SecurityRolesApi

Implements

ISecurityRolesApi

Index

Constructors

Properties

baseUrl http rest userAgent vsoClient

Methods

createAcceptHeader createRequestOptions formatResponse getRoleAssignments getRoleDefinitions removeRoleAssignment removeRoleAssignments setRoleAssignment setRoleAssignments

Constructors

constructor

new SecurityRolesApi(
    baseUrl: string,
    handlers: IRequestHandler[],
    options?: IRequestOptions,
): SecurityRolesApi
Parameters
- baseUrl: string
- handlers: IRequestHandler[]
- Optionaloptions: IRequestOptions
Returns SecurityRolesApi
Overrides ClientApiBase.constructor
- Defined in repos/azure-devops-node-api/api/SecurityRolesApi.ts:31

Properties

baseUrl

baseUrl: string

http

http: HttpClient

rest

rest: RestClient

userAgent

userAgent: string

vsoClient

vsoClient: VsoClient

Methods

createAcceptHeader

createAcceptHeader(type: string, apiVersion?: string): string
Parameters
- type: string
- OptionalapiVersion: string
Returns string
Implementation of ISecurityRolesApi.createAcceptHeader
Inherited from ClientApiBase.createAcceptHeader
- Defined in repos/azure-devops-node-api/api/ClientApiBases.ts:30

createRequestOptions

createRequestOptions(type: string, apiVersion?: string): IRequestOptions
Parameters
- type: string
- OptionalapiVersion: string
Returns IRequestOptions
Implementation of ISecurityRolesApi.createRequestOptions
Inherited from ClientApiBase.createRequestOptions
- Defined in repos/azure-devops-node-api/api/ClientApiBases.ts:34

formatResponse

formatResponse(data: any, responseTypeMetadata: any, isCollection: boolean): any
Parameters
- data: any
- responseTypeMetadata: any
- isCollection: boolean
Returns any
Implementation of ISecurityRolesApi.formatResponse
Inherited from ClientApiBase.formatResponse
- Defined in repos/azure-devops-node-api/api/ClientApiBases.ts:40

getRoleAssignments

getRoleAssignments(
scopeId: string,
resourceId: string,
): Promise<RoleAssignment[]>
Parameters
- scopeId: string
- resourceId: string
Returns Promise<RoleAssignment[]>
Implementation of ISecurityRolesApi.getRoleAssignments
- Defined in repos/azure-devops-node-api/api/SecurityRolesApi.ts:39

getRoleDefinitions

getRoleDefinitions(scopeId: string): Promise<SecurityRole[]>
Parameters
- scopeId: string
Returns Promise<SecurityRole[]>
Implementation of ISecurityRolesApi.getRoleDefinitions
- Defined in repos/azure-devops-node-api/api/SecurityRolesApi.ts:260

removeRoleAssignment

removeRoleAssignment(
    scopeId: string,
    resourceId: string,
    identityId: string,
): Promise<void>
Parameters
- scopeId: string
- resourceId: string
- identityId: string
Returns Promise<void>
Implementation of ISecurityRolesApi.removeRoleAssignment
- Defined in repos/azure-devops-node-api/api/SecurityRolesApi.ts:82

removeRoleAssignments

removeRoleAssignments(
    identityIds: string[],
    scopeId: string,
    resourceId: string,
): Promise<void>
Parameters
- identityIds: string[]
- scopeId: string
- resourceId: string
Returns Promise<void>
Implementation of ISecurityRolesApi.removeRoleAssignments
- Defined in repos/azure-devops-node-api/api/SecurityRolesApi.ts:127

setRoleAssignment

setRoleAssignment(
    roleAssignment: UserRoleAssignmentRef,
    scopeId: string,
    resourceId: string,
    identityId: string,
): Promise<RoleAssignment>
Parameters
- roleAssignment: UserRoleAssignmentRef
- scopeId: string
- resourceId: string
- identityId: string
Returns Promise<RoleAssignment>
Implementation of ISecurityRolesApi.setRoleAssignment
- Defined in repos/azure-devops-node-api/api/SecurityRolesApi.ts:172

setRoleAssignments

setRoleAssignments(
    roleAssignments: UserRoleAssignmentRef[],
    scopeId: string,
    resourceId: string,
): Promise<RoleAssignment[]>
Parameters
- roleAssignments: UserRoleAssignmentRef[]
- scopeId: string
- resourceId: string
Returns Promise<RoleAssignment[]>
Implementation of ISecurityRolesApi.setRoleAssignments
- Defined in repos/azure-devops-node-api/api/SecurityRolesApi.ts:218