Interface ISecurityRolesApi

interface ISecurityRolesApi {
    baseUrl: string;
    http: HttpClient;
    rest: RestClient;
    userAgent: string;
    vsoClient: VsoClient;
    createAcceptHeader(type: string, apiVersion?: string): string;
    createRequestOptions(type: string, apiVersion?: string): IRequestOptions;
    formatResponse(
        data: any,
        responseTypeMetadata: any,
        isCollection: boolean,
    ): any;
    getRoleAssignments(
        scopeId: string,
        resourceId: string,
    ): Promise<RoleAssignment[]>;
    getRoleDefinitions(scopeId: string): Promise<SecurityRole[]>;
    removeRoleAssignment(
        scopeId: string,
        resourceId: string,
        identityId: string,
    ): Promise<void>;
    removeRoleAssignments(
        identityIds: string[],
        scopeId: string,
        resourceId: string,
    ): Promise<void>;
    setRoleAssignment(
        roleAssignment: UserRoleAssignmentRef,
        scopeId: string,
        resourceId: string,
        identityId: string,
    ): Promise<RoleAssignment>;
    setRoleAssignments(
        roleAssignments: UserRoleAssignmentRef[],
        scopeId: string,
        resourceId: string,
    ): Promise<RoleAssignment[]>;
}

Hierarchy (View Summary)

Implemented by

Properties

baseUrl http rest userAgent vsoClient

Methods

createAcceptHeader createRequestOptions formatResponse getRoleAssignments getRoleDefinitions removeRoleAssignment removeRoleAssignments setRoleAssignment setRoleAssignments

Properties

baseUrl

baseUrl: string

http

http: HttpClient

rest

rest: RestClient

userAgent

userAgent: string

vsoClient

vsoClient: VsoClient

Methods

createAcceptHeader

createRequestOptions

formatResponse

getRoleAssignments

getRoleDefinitions

removeRoleAssignment

removeRoleAssignments

setRoleAssignment

setRoleAssignments

Settings

Member Visibility

On This Page

Properties
Methods