Policy Configurations - List
Retrieve a list of policy configurations by a given set of scope/filtering criteria.
Below is a short description of how all of the query parameters interact with each other:
- repositoryId set, refName set: returns all policy configurations that apply to a particular branch in a repository
- repositoryId set, refName unset: returns all policy configurations that apply to a particular repository
- repositoryId unset, refName unset: returns all policy configurations that are defined at the project level
- repositoryId unset, refName set: returns all project-level branch policies, plus the project level configurations For all of the examples above, when policyType is set, it'll restrict results to the given policy type
GET https://dev.azure.com/{organization}/{project}/_apis/git/policy/configurations?api-version=5.0-preview.1
GET https://dev.azure.com/{organization}/{project}/_apis/git/policy/configurations?repositoryId={repositoryId}&refName={refName}&policyType={policyType}&api-version=5.0-preview.1
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
organization
|
path | True |
string |
The name of the Azure DevOps organization. |
project
|
path | True |
string |
Project ID or project name |
api-version
|
query | True |
string |
Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api. |
policy
|
query |
string (uuid) |
The policy type filter. |
|
ref
|
query |
string |
The fully-qualified Git ref name (e.g. refs/heads/master). |
|
repository
|
query |
string (uuid) |
The repository id. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
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.code | Grants the ability to read source code and metadata about commits, changesets, branches, and other version control artifacts. Also grants the ability to search code and get notified about version control events via service hooks. |
Definitions
Name | Description |
---|---|
Identity |
|
Policy |
The full policy configuration with settings. |
Policy |
Policy type reference. |
Reference |
The class to represent a collection of REST reference links. |
IdentityRef
Name | Type | Description |
---|---|---|
_links |
This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject. |
|
descriptor |
string |
The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations. |
directoryAlias |
string |
|
displayName |
string |
This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider. |
id |
string |
|
imageUrl |
string |
|
inactive |
boolean |
|
isAadIdentity |
boolean |
|
isContainer |
boolean |
|
isDeletedInOrigin |
boolean |
|
profileUrl |
string |
|
uniqueName |
string |
|
url |
string |
This url is the full route to the source resource of this graph subject. |
PolicyConfiguration
The full policy configuration with settings.
Name | Type | Description |
---|---|---|
_links |
The links to other objects related to this object. |
|
createdBy |
A reference to the identity that created the policy. |
|
createdDate |
string (date-time) |
The date and time when the policy was created. |
id |
integer (int32) |
The policy configuration ID. |
isBlocking |
boolean |
Indicates whether the policy is blocking. |
isDeleted |
boolean |
Indicates whether the policy has been (soft) deleted. |
isEnabled |
boolean |
Indicates whether the policy is enabled. |
revision |
integer (int32) |
The policy configuration revision ID. |
settings |
string (JObject) |
The policy configuration settings. |
type |
The policy configuration type. |
|
url |
string |
The URL where the policy configuration can be retrieved. |
PolicyTypeRef
Policy type reference.
Name | Type | Description |
---|---|---|
displayName |
string |
Display name of the policy type. |
id |
string (uuid) |
The policy type ID. |
url |
string |
The URL where the policy type can be retrieved. |
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. |