Github Connections - Get Github Connections

Reference

Service:: Work Item Tracking

API Version:: 7.2-preview.1

Gets a list of github connections

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

Responses

Name	Type	Description
200 OK	GitHubConnectionModel[]	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.githubconnections	Grants the ability to read github connections and github repositories data

Examples

Get github connections list

Sample request

HTTP

GET https://dev.azure.com/{organization}/{project}/_apis/githubconnections?api-version=7.2-preview.1

Sample response

Status code:: 200

{
  "count": 1,
  "value": [
    {
      "id": "7c1c7cc4-3fc4-4d4c-a414-65f05f969de5",
      "name": "githubconnection1",
      "authorizationType": "PersonalAccessToken",
      "createdBy": {
        "displayName": "Administrator",
        "url": "https://dev.azure.com/fabrikam/_apis/Identities/bd5125a6-9acb-493a-a153-8235f37d1eb3",
        "_links": {
          "avatar": {
            "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/win.Uy0xLTUtMjEtMTUwNDY3OTk1OC02NDAyOTk0MTEtMzkzOTM1Nzc2NS01MDA"
          }
        },
        "id": "bd5125a6-9acb-493a-a153-8235f37d1eb3",
        "uniqueName": "N202\\Administrator",
        "imageUrl": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/win.Uy0xLTUtMjEtMTUwNDY3OTk1OC02NDAyOTk0MTEtMzkzOTM1Nzc2NS01MDA",
        "descriptor": "win.Uy0xLTUtMjEtMTUwNDY3OTk1OC02NDAyOTk0MTEtMzkzOTM1Nzc2NS01MDA"
      },
      "isConnectionValid": true
    }
  ]
}

Definitions

Name	Description
GitHubConnectionModel	Describes Github connection.
IdentityRef
ReferenceLinks	The class to represent a collection of REST reference links.

GitHubConnectionModel

Describes Github connection.

Name	Type	Description
authorizationType	string	Github connection authorization type (f. e. PAT, OAuth)
createdBy	IdentityRef	Github connection created by
id	string	Github connection id
isConnectionValid	boolean	Whether current Github connection is valid or not
name	string	Github connection name (should contain organization/user name)

IdentityRef

Name	Type	Description
_links	ReferenceLinks	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	Deprecated - Can be retrieved by querying the Graph user referenced in the "self" entry of the IdentityRef "_links" dictionary
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	Deprecated - Available in the "avatar" entry of the IdentityRef "_links" dictionary
inactive	boolean	Deprecated - Can be retrieved by querying the Graph membership state referenced in the "membershipState" entry of the GraphUser "_links" dictionary
isAadIdentity	boolean	Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Deprecated - not in use in most preexisting implementations of ToIdentityRef
uniqueName	string	Deprecated - use Domain+PrincipalName instead
url	string	This url is the full route to the source resource of this graph subject.

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.

Compartilhar via