Endpoints - Get Service Endpoints With Refreshed Authentication
Obtém os pontos de extremidade de serviço e corrija novos parâmetros de autorização
POST https://dev.azure.com/{organization}/{project}/_apis/serviceendpoint/endpoints?endpointIds={endpointIds}&api-version=7.1-preview.4Parâmetros de URI
| Nome | Em | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
organization
|
path | True |
string |
O nome da organização do Azure DevOps. |
|
project
|
path | True |
string |
ID do projeto ou nome do projeto |
|
api-version
|
query | True |
string |
Versão da API a ser usada. Isso deve ser definido como '7.1-preview.4' para usar essa versão da api. |
|
endpoint
|
query | True |
string array (uuid) |
IDs dos pontos de extremidade de serviço. |
Corpo da solicitação
| Nome | Tipo | Description |
|---|---|---|
| body |
Escopo, validade do token solicitado. |
Respostas
| Nome | Tipo | Description |
|---|---|---|
| 200 OK |
operação bem-sucedida |
Segurança
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
| Nome | Description |
|---|---|
| vso.serviceendpoint_manage | Concede a capacidade de ler, consultar e gerenciar pontos de extremidade de serviço. |
Definições
| Nome | Description |
|---|---|
|
Endpoint |
Representa a autorização usada para o ponto de extremidade de serviço. |
|
Identity |
|
| JObject |
Representa um objeto JSON. |
| JToken |
Representa um token JSON abstrato. |
|
Project |
|
|
Reference |
A classe para representar uma coleção de links de referência REST. |
|
Refresh |
Especifique as propriedades para atualizar o objeto de autenticação de ponto de extremidade que está sendo consultado |
|
Service |
Representa um ponto de extremidade que pode ser usado por um trabalho de orquestração. |
|
Service |
EndpointAuthorization
Representa a autorização usada para o ponto de extremidade de serviço.
| Nome | Tipo | Description |
|---|---|---|
| parameters |
object |
Obtém ou define os parâmetros para o esquema de autorização selecionado. |
| scheme |
string |
Obtém ou define o esquema usado para autenticação de ponto de extremidade de serviço. |
IdentityRef
| Nome | Tipo | Description |
|---|---|---|
| _links |
Esse campo contém zero ou mais links interessantes sobre o assunto do grafo. Esses links podem ser invocados para obter relações adicionais ou informações mais detalhadas sobre esse assunto do grafo. |
|
| descriptor |
string |
O descritor é a principal maneira de referenciar o assunto do grafo enquanto o sistema está em execução. Esse campo identificará exclusivamente o mesmo assunto de grafo entre contas e organizações. |
| directoryAlias |
string |
Preterido – pode ser recuperado consultando o usuário do Graph referenciado na entrada "self" do dicionário IdentityRef "_links" |
| displayName |
string |
Esse é o nome de exibição não exclusivo do assunto do grafo. Para alterar esse campo, você deve alterar seu valor no provedor de origem. |
| id |
string |
|
| imageUrl |
string |
Preterido – Disponível na entrada "avatar" do dicionário IdentityRef "_links" |
| inactive |
boolean |
Preterido – pode ser recuperado consultando o estado de associação do Graph referenciado na entrada "membershipState" do dicionário "_links" do GraphUser |
| isAadIdentity |
boolean |
Preterido – pode ser inferido do tipo de assunto do descritor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType) |
| isContainer |
boolean |
Preterido – pode ser inferido do tipo de assunto do descritor (Descriptor.IsGroupType) |
| isDeletedInOrigin |
boolean |
|
| profileUrl |
string |
Preterido – não em uso na maioria das implementações preexistir de ToIdentityRef |
| uniqueName |
string |
Preterido – use Domain+PrincipalName em vez disso |
| url |
string |
Essa URL é a rota completa para o recurso de origem desta entidade de grafo. |
JObject
Representa um objeto JSON.
| Nome | Tipo | Description |
|---|---|---|
| item |
Representa um token JSON abstrato. |
|
| type |
string |
Obtém o tipo de nó para este JToken. |
JToken
Representa um token JSON abstrato.
| Nome | Tipo | Description |
|---|---|---|
| first |
Obtenha o primeiro token filho desse token. |
|
| hasValues |
boolean |
Obtém um valor que indica se esse token tem tokens filho. |
| item |
Representa um token JSON abstrato. |
|
| last |
Obtenha o último token filho desse token. |
|
| next |
Obtém o próximo token irmão desse nó. |
|
| parent |
string |
Obtém ou define o pai. |
| path |
string |
Obtém o caminho do token JSON. |
| previous |
Obtém o token irmão anterior desse nó. |
|
| root |
Obtém o JToken raiz deste JToken. |
|
| type |
string |
Obtém o tipo de nó para este JToken. |
ProjectReference
| Nome | Tipo | Description |
|---|---|---|
| id |
string |
|
| name |
string |
ReferenceLinks
A classe para representar uma coleção de links de referência REST.
| Nome | Tipo | Description |
|---|---|---|
| links |
object |
A exibição somente leitura dos links. Como os links de referência são somente leitura, só queremos expô-los como somente leitura. |
RefreshAuthenticationParameters
Especifique as propriedades para atualizar o objeto de autenticação de ponto de extremidade que está sendo consultado
| Nome | Tipo | Description |
|---|---|---|
| endpointId |
string |
EndpointId que precisa de novos parâmetros de autenticação |
| scope |
integer[] |
Escopo do token solicitado. Para aplicativos do Marketplace do GitHub, o escopo contém IDs do repositório |
| tokenValidityInMinutes |
integer |
A autenticação de ponto de extremidade solicitada deve ser válida para _ minutos. Os parâmetros de autenticação não serão atualizados se o token contido no ponto de extremidade já tiver um token ativo. |
ServiceEndpoint
Representa um ponto de extremidade que pode ser usado por um trabalho de orquestração.
| Nome | Tipo | Description |
|---|---|---|
| administratorsGroup |
Este é um campo preterido. |
|
| authorization |
Obtém ou define os dados de autorização para falar com o ponto de extremidade. |
|
| createdBy |
Obtém ou define a referência de identidade para o usuário que criou o ponto de extremidade de serviço. |
|
| data |
object |
|
| description |
string |
Obtém ou define a descrição do ponto de extremidade. |
| groupScopeId |
string |
Este é um campo preterido. |
| id |
string |
Obtém ou define o identificador desse ponto de extremidade. |
| isReady |
boolean |
Indicador de estado do EndPoint |
| isShared |
boolean |
Indica se o ponto de extremidade de serviço é compartilhado com outros projetos ou não. |
| name |
string |
Obtém ou define o nome amigável do ponto de extremidade. |
| operationStatus |
Mensagem de erro durante a criação/exclusão do ponto de extremidade |
|
| owner |
string |
Proprietário dos valores com suporte do ponto de extremidade são "library", "agentcloud" |
| readersGroup |
Obtém ou define a referência de identidade para o grupo de leitores do ponto de extremidade de serviço. |
|
| serviceEndpointProjectReferences |
Todas as outras referências de projeto em que o ponto de extremidade de serviço é compartilhado. |
|
| type |
string |
Obtém ou define o tipo do ponto de extremidade. |
| url |
string |
Obtém ou define a URL do ponto de extremidade. |
ServiceEndpointProjectReference
| Nome | Tipo | Description |
|---|---|---|
| description |
string |
Obtém ou define a descrição do ponto de extremidade de serviço. |
| name |
string |
Obtém ou define o nome do ponto de extremidade de serviço. |
| projectReference |
Obtém ou define a referência de projeto do ponto de extremidade de serviço. |