Permissions Report - List

Service:

Permissions Report

API Version:

7.1-preview.1

Get a list of permissions reports

GET https://dev.azure.com/{organization}/_apis/permissionsreport?api-version=7.1-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.1-preview.1' to use this version of the api.

Responses

Name	Type	Description
200 OK	PermissionsReport[]	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
PermissionsReport	Detailed report of permissions for a set of groups and users over a set of security namespaces
PermissionsReportStatus

PermissionsReport

Detailed report of permissions for a set of groups and users over a set of security namespaces

Name	Type	Description
error	string	Error if the report creation failed or empty if successful
id	string
reportName	string	Name of the report which typically includes the requestor's display name
reportStatus	PermissionsReportStatus
reportStatusLastUpdatedTime	string
requestedTime	string
requestor	string	User who requested the report be created

PermissionsReportStatus

Name	Type	Description
completedSuccessfully	string	Ready to download
completedWithErrors	string	Completed but with errors. Check the PermissionsReport error field
created	string	Request created but not started
deleted	string	Has been deleted
inProgress	string	Request started