Endpoints - Get Service Endpoints With Refreshed Authentication
サービス エンドポイントを取得し、新しい承認パラメーターにパッチを適用します
POST https://dev.azure.com/{organization}/{project}/_apis/serviceendpoint/endpoints?endpointIds={endpointIds}&api-version=7.1-preview.4URI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
organization
|
path | True |
string |
Azure DevOps 組織の名前です。 |
|
project
|
path | True |
string |
プロジェクト ID またはプロジェクト名 |
|
api-version
|
query | True |
string |
使う API のバージョン。 このバージョンの API を使用するには、これを '7.1-preview.4' に設定する必要があります。 |
|
endpoint
|
query | True |
string array (uuid) |
サービス エンドポイントの ID。 |
要求本文
| 名前 | 型 | 説明 |
|---|---|---|
| body |
スコープ、要求されたトークンの有効性。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK |
成功した操作 |
セキュリティ
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
| 名前 | 説明 |
|---|---|
| vso.serviceendpoint_manage | サービス エンドポイントの読み取り、クエリ、管理を行う機能を付与します。 |
定義
| 名前 | 説明 |
|---|---|
|
Endpoint |
サービス エンドポイントに使用される承認を表します。 |
|
Identity |
|
| JObject |
JSON オブジェクトを表します。 |
| JToken |
抽象 JSON トークンを表します。 |
|
Project |
|
|
Reference |
REST 参照リンクのコレクションを表す クラス。 |
|
Refresh |
クエリ対象のエンドポイント認証オブジェクトを更新するためのプロパティを指定する |
|
Service |
オーケストレーション ジョブで使用できるエンドポイントを表します。 |
|
Service |
EndpointAuthorization
サービス エンドポイントに使用される承認を表します。
| 名前 | 型 | 説明 |
|---|---|---|
| parameters |
object |
選択した承認スキームのパラメーターを取得または設定します。 |
| scheme |
string |
サービス エンドポイント認証に使用されるスキームを取得または設定します。 |
IdentityRef
| 名前 | 型 | 説明 |
|---|---|---|
| _links |
このフィールドには、グラフの件名に関する 0 個以上の興味深いリンクが含まれています。 これらのリンクを呼び出して、このグラフの件名に関する追加のリレーションシップまたは詳細情報を取得できます。 |
|
| descriptor |
string |
記述子は、システムの実行中にグラフの件名を参照する主な方法です。 このフィールドは、アカウントと組織の両方で同じグラフの件名を一意に識別します。 |
| directoryAlias |
string |
非推奨 - IdentityRef "_links" ディクショナリの "self" エントリで参照されている Graph ユーザーに対してクエリを実行することで取得できます |
| displayName |
string |
これは、グラフの件名の一意でない表示名です。 このフィールドを変更するには、ソース プロバイダーでその値を変更する必要があります。 |
| id |
string |
|
| imageUrl |
string |
非推奨 - IdentityRef "_links" 辞書の "アバター" エントリで使用できます |
| inactive |
boolean |
非推奨 - GraphUser "_links" ディクショナリの "membershipState" エントリで参照されている Graph メンバーシップの状態を照会することで取得できます |
| isAadIdentity |
boolean |
非推奨 - 記述子のサブジェクト型 (Descriptor.IsAadUserType/Descriptor.IsAadGroupType) から推論できます |
| isContainer |
boolean |
非推奨 - 記述子のサブジェクト型 (Descriptor.IsGroupType) から推論できます |
| isDeletedInOrigin |
boolean |
|
| profileUrl |
string |
非推奨 - ToIdentityRef の既存のほとんどの実装では使用されていません |
| uniqueName |
string |
非推奨 - 代わりに Domain+PrincipalName を使用する |
| url |
string |
この URL は、このグラフの件名のソース リソースへの完全なルートです。 |
JObject
JSON オブジェクトを表します。
| 名前 | 型 | 説明 |
|---|---|---|
| item |
抽象 JSON トークンを表します。 |
|
| type |
string |
この JToken のノードの種類を取得します。 |
JToken
抽象 JSON トークンを表します。
| 名前 | 型 | 説明 |
|---|---|---|
| first |
このトークンの最初の子トークンを取得します。 |
|
| hasValues |
boolean |
このトークンに子トークンがあるかどうかを示す値を取得します。 |
| item |
抽象 JSON トークンを表します。 |
|
| last |
このトークンの最後の子トークンを取得します。 |
|
| next |
このノードの次の兄弟トークンを取得します。 |
|
| parent |
string |
親を取得または設定します。 |
| path |
string |
JSON トークンのパスを取得します。 |
| previous |
このノードの前の兄弟トークンを取得します。 |
|
| root |
この JToken のルート JToken を取得します。 |
|
| type |
string |
この JToken のノードの種類を取得します。 |
ProjectReference
| 名前 | 型 | 説明 |
|---|---|---|
| id |
string |
|
| name |
string |
ReferenceLinks
REST 参照リンクのコレクションを表す クラス。
| 名前 | 型 | 説明 |
|---|---|---|
| links |
object |
リンクの読み取り専用ビュー。 参照リンクは読み取り専用であるため、参照リンクは読み取り専用として公開する必要があります。 |
RefreshAuthenticationParameters
クエリ対象のエンドポイント認証オブジェクトを更新するためのプロパティを指定する
| 名前 | 型 | 説明 |
|---|---|---|
| endpointId |
string |
新しい認証パラメーターが必要な EndpointId |
| scope |
integer[] |
要求されたトークンのスコープ。 GitHub Marketplace アプリの場合、スコープにはリポジトリ ID が含まれます |
| tokenValidityInMinutes |
integer |
要求されたエンドポイント認証は_ 分有効である必要があります。 エンドポイントに含まれるトークンに既にアクティブなトークンがある場合、認証パラメーターは更新されません。 |
ServiceEndpoint
オーケストレーション ジョブで使用できるエンドポイントを表します。
| 名前 | 型 | 説明 |
|---|---|---|
| administratorsGroup |
これは非推奨のフィールドです。 |
|
| authorization |
エンドポイントと通信するための承認データを取得または設定します。 |
|
| createdBy |
サービス エンドポイントを作成したユーザーの ID 参照を取得または設定します。 |
|
| data |
object |
|
| description |
string |
エンドポイントの説明を取得または設定します。 |
| groupScopeId |
string |
これは非推奨のフィールドです。 |
| id |
string |
このエンドポイントの識別子を取得または設定します。 |
| isReady |
boolean |
EndPoint 状態インジケーター |
| isShared |
boolean |
サービス エンドポイントが他のプロジェクトと共有されているかどうかを示します。 |
| name |
string |
エンドポイントのフレンドリ名を取得または設定します。 |
| operationStatus |
エンドポイントの作成/削除中のエラー メッセージ |
|
| owner |
string |
エンドポイントの所有者 サポートされている値は、"library"、"agentcloud" です |
| readersGroup |
サービス エンドポイントの閲覧者グループの ID 参照を取得または設定します。 |
|
| serviceEndpointProjectReferences |
サービス エンドポイントが共有されている他のすべてのプロジェクト参照。 |
|
| type |
string |
エンドポイントの種類を取得します。値の設定も可能です。 |
| url |
string |
エンドポイントの URL を取得または設定します。 |
ServiceEndpointProjectReference
| 名前 | 型 | 説明 |
|---|---|---|
| description |
string |
サービス エンドポイントの説明を取得または設定します。 |
| name |
string |
サービス エンドポイントの名前を取得または設定します。 |
| projectReference |
サービス エンドポイントのプロジェクト参照を取得または設定します。 |