Permissions Report - Create

Reference

Service:: Permissions Report

API Version:: 7.2-preview.1

Request a permissions report to be created asyncronously

POST https://dev.azure.com/{organization}/_apis/permissionsreport?api-version=7.2-preview.1

URI Parameters

Name	In	Required	Type	Description
organization	path	True	string	The name of the Azure DevOps organization.
api-version	query	True	string	Version of the API to use. This should be set to '7.2-preview.1' to use this version of the api.

Request Body

Name	Type	Description
descriptors	string[]	List of groups and users to fetch permissions on. An empty list will fetch all groups and users in the organization
reportName	string	Name of the report to create, make it unique
resources	PermissionsReportResource[]	List of resources to fetch permisions on

Responses

Name	Type	Description
200 OK	ReferenceLinks	successful operation

Security

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Scopes

Name	Description
vso.security_manage	Grants the ability to read, write, and manage security permissions.

Definitions

Name	Description
PermissionsReportRequest	Details for creating a permissions report
PermissionsReportResource	Specifics of the resource for the permissions report
ReferenceLinks	The class to represent a collection of REST reference links.
ResourceType	Specify the type of resource to report permissions on

PermissionsReportRequest

Details for creating a permissions report

Name	Type	Description
descriptors	string[]	List of groups and users to fetch permissions on. An empty list will fetch all groups and users in the organization
reportName	string	Name of the report to create, make it unique
resources	PermissionsReportResource[]	List of resources to fetch permisions on

PermissionsReportResource

Specifics of the resource for the permissions report

Name	Type	Description
resourceId	string	GUID, Name, or ref for the specified resource type
resourceName	string	For repo resource type, resource name is the repo name
resourceType	ResourceType	Specify the type of resource to report permissions on

ReferenceLinks

The class to represent a collection of REST reference links.

Name	Type	Description
links	object	The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.

ResourceType

Specify the type of resource to report permissions on

Name	Type	Description
projectGit	string	Use for the "Git repositories" root node
ref	string	Use repo/branch nodes using the ref format eg. RepoGuid/Refs/head/master, ProjectName/RepoName/Refs/head/master, ProjectGuid/RepoGuid/Refs/tags
release	string	Use for the Release permission. eg. ProjectGuid, ProjectGuid/Path
repo	string	Permissions for the primary repo node. The resource ID should be RepoGuid, ProjectId/RepoGuid, or ProjectId/RepoName
tfvc	string	Use for the Team Foundation Version Control permission using the item path, eg. $/test tfvc

Share via