Endpoints - Get Service Endpoints With Refreshed Authentication
Pobiera punkty końcowe usługi i popraw nowe parametry autoryzacji
POST https://dev.azure.com/{organization}/{project}/_apis/serviceendpoint/endpoints?endpointIds={endpointIds}&api-version=7.1-preview.4Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
organization
|
path | True |
string |
Nazwa organizacji usługi Azure DevOps. |
|
project
|
path | True |
string |
Identyfikator projektu lub nazwa projektu |
|
api-version
|
query | True |
string |
Wersja interfejsu API do użycia. Ta wersja interfejsu API powinna być ustawiona na wartość "7.1-preview.4". |
|
endpoint
|
query | True |
string array (uuid) |
Identyfikatory punktów końcowych usługi. |
Treść żądania
| Nazwa | Typ | Opis |
|---|---|---|
| body |
Zakres, ważność żądanego tokenu. |
Odpowiedzi
| Nazwa | Typ | Opis |
|---|---|---|
| 200 OK |
operacja zakończona powodzeniem |
Zabezpieczenia
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
| Nazwa | Opis |
|---|---|
| vso.serviceendpoint_manage | Umożliwia odczytywanie punktów końcowych usługi, wykonywanie zapytań i zarządzanie nimi. |
Definicje
| Nazwa | Opis |
|---|---|
|
Endpoint |
Reprezentuje autoryzację używaną dla punktu końcowego usługi. |
|
Identity |
|
| JObject |
Reprezentuje obiekt JSON. |
| JToken |
Reprezentuje abstrakcyjny token JSON. |
|
Project |
|
|
Reference |
Klasa reprezentująca kolekcję linków referencyjnych REST. |
|
Refresh |
Określ właściwości odświeżania obiektu uwierzytelniania punktu końcowego, którego dotyczy zapytanie |
|
Service |
Reprezentuje punkt końcowy, który może być używany przez zadanie orkiestracji. |
|
Service |
EndpointAuthorization
Reprezentuje autoryzację używaną dla punktu końcowego usługi.
| Nazwa | Typ | Opis |
|---|---|---|
| parameters |
object |
Pobiera lub ustawia parametry dla wybranego schematu autoryzacji. |
| scheme |
string |
Pobiera lub ustawia schemat używany do uwierzytelniania punktu końcowego usługi. |
IdentityRef
| Nazwa | Typ | Opis |
|---|---|---|
| _links |
To pole zawiera zero lub więcej interesujących linków dotyczących tematu grafu. Te linki mogą być wywoływane w celu uzyskania dodatkowych relacji lub bardziej szczegółowych informacji na temat tego tematu grafu. |
|
| descriptor |
string |
Deskryptor jest podstawowym sposobem odwołowania się do tematu grafu podczas działania systemu. To pole będzie jednoznacznie identyfikować ten sam temat grafu zarówno w ramach kont, jak i organizacji. |
| directoryAlias |
string |
Przestarzałe — można pobrać, wysyłając zapytanie do użytkownika programu Graph przywoływanego w wpisie "self" słownika IdentityRef "_links" |
| displayName |
string |
Jest to unikatowa nazwa wyświetlana tematu grafu. Aby zmienić to pole, musisz zmienić jego wartość u dostawcy źródłowego. |
| id |
string |
|
| imageUrl |
string |
Przestarzałe — dostępne w wpisie "avatar" słownika IdentityRef "_links" |
| inactive |
boolean |
Przestarzałe — można pobrać, wysyłając zapytanie do stanu członkostwa programu Graph, do których odwołuje się wpis "membershipState" słownika GraphUser "_links" |
| isAadIdentity |
boolean |
Przestarzałe — można wywnioskować z typu podmiotu deskryptora (Descriptor.IsAadUserType/Descriptor.IsAadGroupType) |
| isContainer |
boolean |
Przestarzałe — można wywnioskować z typu podmiotu deskryptora (Descriptor.IsGroupType) |
| isDeletedInOrigin |
boolean |
|
| profileUrl |
string |
Przestarzałe — nie jest używane w większości istniejących implementacji toIdentityRef |
| uniqueName |
string |
Przestarzałe — zamiast tego użyj nazwy Domain+PrincipalName |
| url |
string |
Ten adres URL jest pełną trasą do zasobu źródłowego tego tematu grafu. |
JObject
Reprezentuje obiekt JSON.
| Nazwa | Typ | Opis |
|---|---|---|
| item |
Reprezentuje abstrakcyjny token JSON. |
|
| type |
string |
Pobiera typ węzła dla tego zestawu JToken. |
JToken
Reprezentuje abstrakcyjny token JSON.
| Nazwa | Typ | Opis |
|---|---|---|
| first |
Pobierz pierwszy token podrzędny tego tokenu. |
|
| hasValues |
boolean |
Pobiera wartość wskazującą, czy ten token ma tokeny podrzędne. |
| item |
Reprezentuje abstrakcyjny token JSON. |
|
| last |
Pobierz ostatni token podrzędny tego tokenu. |
|
| next |
Pobiera następny token równorzędny tego węzła. |
|
| parent |
string |
Pobiera lub ustawia element nadrzędny. |
| path |
string |
Pobiera ścieżkę tokenu JSON. |
| previous |
Pobiera poprzedni token równorzędny tego węzła. |
|
| root |
Pobiera główny zestaw JToken tego zestawu JToken. |
|
| type |
string |
Pobiera typ węzła dla tego zestawu JToken. |
ProjectReference
| Nazwa | Typ | Opis |
|---|---|---|
| id |
string |
|
| name |
string |
ReferenceLinks
Klasa reprezentująca kolekcję linków referencyjnych REST.
| Nazwa | Typ | Opis |
|---|---|---|
| links |
object |
Czytelny widok linków. Ponieważ linki referencyjne są czytelne, chcemy uwidocznić je tylko jako tylko do odczytu. |
RefreshAuthenticationParameters
Określ właściwości odświeżania obiektu uwierzytelniania punktu końcowego, którego dotyczy zapytanie
| Nazwa | Typ | Opis |
|---|---|---|
| endpointId |
string |
EndpointId, który wymaga nowych parametrów uwierzytelniania |
| scope |
integer[] |
Zakres żądanego tokenu. W przypadku aplikacji z witryny Marketplace w witrynie GitHub zakres zawiera identyfikatory repozytorium |
| tokenValidityInMinutes |
integer |
Żądane uwierzytelnianie punktu końcowego powinno być prawidłowe przez _ minuty. Parametry uwierzytelniania nie zostaną odświeżone, jeśli token zawarty w punkcie końcowym ma już aktywny token. |
ServiceEndpoint
Reprezentuje punkt końcowy, który może być używany przez zadanie orkiestracji.
| Nazwa | Typ | Opis |
|---|---|---|
| administratorsGroup |
Jest to przestarzałe pole. |
|
| authorization |
Pobiera lub ustawia dane autoryzacji na potrzeby rozmowy z punktem końcowym. |
|
| createdBy |
Pobiera lub ustawia odwołanie do tożsamości użytkownika, który utworzył punkt końcowy usługi. |
|
| data |
object |
|
| description |
string |
Pobiera lub ustawia opis punktu końcowego. |
| groupScopeId |
string |
Jest to przestarzałe pole. |
| id |
string |
Pobiera lub ustawia identyfikator tego punktu końcowego. |
| isReady |
boolean |
Wskaźnik stanu punktu końcowego |
| isShared |
boolean |
Wskazuje, czy punkt końcowy usługi jest współużytkowany z innymi projektami, czy nie. |
| name |
string |
Pobiera lub ustawia przyjazną nazwę punktu końcowego. |
| operationStatus |
Komunikat o błędzie podczas tworzenia/usuwania punktu końcowego |
|
| owner |
string |
Właściciel obsługiwanych wartości punktu końcowego to "biblioteka", "agentcloud" |
| readersGroup |
Pobiera lub ustawia odwołanie do tożsamości dla grupy czytelników punktu końcowego usługi. |
|
| serviceEndpointProjectReferences |
Wszystkie inne odwołania do projektu, w którym jest współużytkowany punkt końcowy usługi. |
|
| type |
string |
Pobiera lub ustawia typ punktu końcowego. |
| url |
string |
Pobiera lub ustawia adres URL punktu końcowego. |
ServiceEndpointProjectReference
| Nazwa | Typ | Opis |
|---|---|---|
| description |
string |
Pobiera lub ustawia opis punktu końcowego usługi. |
| name |
string |
Pobiera lub ustawia nazwę punktu końcowego usługi. |
| projectReference |
Pobiera lub ustawia odwołanie do projektu punktu końcowego usługi. |