Endpoints - Get Service Endpoints With Refreshed Authentication
Gets the service endpoints and patch new authorization parameters
POST https://dev.azure.com/{organization}/{project}/_apis/serviceendpoint/endpoints?endpointIds={endpointIds}&api-version=7.1URI 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.1' to use this version of the api. |
|
endpoint
|
query | True |
string array (uuid) |
Ids of the service endpoints. |
Request Body
| Name | Type | Description |
|---|---|---|
| body |
Scope, Validity of Token requested. |
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.serviceendpoint_manage | Grants the ability to read, query and manage service endpoints. |
Definitions
| Name | Description |
|---|---|
|
Endpoint |
Represents the authorization used for service endpoint. |
|
Identity |
|
| JObject |
Represents a JSON object. |
| JToken |
Represents an abstract JSON token. |
|
Project |
|
|
Reference |
The class to represent a collection of REST reference links. |
|
Refresh |
Specify the properties for refreshing the endpoint authentication object being queried |
|
Service |
Represents an endpoint which may be used by an orchestration job. |
|
Service |
EndpointAuthorization
Represents the authorization used for service endpoint.
| Name | Type | Description |
|---|---|---|
| parameters |
object |
Gets or sets the parameters for the selected authorization scheme. |
| scheme |
string |
Gets or sets the scheme used for service endpoint authentication. |
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 |
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. |
JObject
Represents a JSON object.
| Name | Type | Description |
|---|---|---|
| item |
Represents an abstract JSON token. |
|
| type |
string |
Gets the node type for this JToken. |
JToken
Represents an abstract JSON token.
| Name | Type | Description |
|---|---|---|
| first |
Get the first child token of this token. |
|
| hasValues |
boolean |
Gets a value indicating whether this token has child tokens. |
| item |
Represents an abstract JSON token. |
|
| last |
Get the last child token of this token. |
|
| next |
Gets the next sibling token of this node. |
|
| parent |
string |
Gets or sets the parent. |
| path |
string |
Gets the path of the JSON token. |
| previous |
Gets the previous sibling token of this node. |
|
| root |
Gets the root JToken of this JToken. |
|
| type |
string |
Gets the node type for this JToken. |
ProjectReference
| Name | Type | Description |
|---|---|---|
| id |
string |
|
| name |
string |
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. |
RefreshAuthenticationParameters
Specify the properties for refreshing the endpoint authentication object being queried
| Name | Type | Description |
|---|---|---|
| endpointId |
string |
EndpointId which needs new authentication params |
| scope |
integer[] |
Scope of the token requested. For GitHub marketplace apps, scope contains repository Ids |
| tokenValidityInMinutes |
integer |
The requested endpoint authentication should be valid for _ minutes. Authentication params will not be refreshed if the token contained in endpoint already has active token. |
ServiceEndpoint
Represents an endpoint which may be used by an orchestration job.
| Name | Type | Description |
|---|---|---|
| administratorsGroup |
This is a deprecated field. |
|
| authorization |
Gets or sets the authorization data for talking to the endpoint. |
|
| createdBy |
Gets or sets the identity reference for the user who created the Service endpoint. |
|
| data |
object |
|
| description |
string |
Gets or sets the description of endpoint. |
| groupScopeId |
string |
This is a deprecated field. |
| id |
string |
Gets or sets the identifier of this endpoint. |
| isReady |
boolean |
EndPoint state indicator |
| isShared |
boolean |
Indicates whether service endpoint is shared with other projects or not. |
| name |
string |
Gets or sets the friendly name of the endpoint. |
| operationStatus |
Error message during creation/deletion of endpoint |
|
| owner |
string |
Owner of the endpoint Supported values are "library", "agentcloud" |
| readersGroup |
Gets or sets the identity reference for the readers group of the service endpoint. |
|
| serviceEndpointProjectReferences |
All other project references where the service endpoint is shared. |
|
| type |
string |
Gets or sets the type of the endpoint. |
| url |
string |
Gets or sets the url of the endpoint. |
ServiceEndpointProjectReference
| Name | Type | Description |
|---|---|---|
| description |
string |
Gets or sets description of the service endpoint. |
| name |
string |
Gets or sets name of the service endpoint. |
| projectReference |
Gets or sets project reference of the service endpoint. |