Roleassignments - Set Role Assignments

リファレンス

Service:: Security Roles

API Version:: 7.1-preview.1

リソースにロールの割り当てを設定する

PUT https://dev.azure.com/{organization}/_apis/securityroles/scopes/{scopeId}/roleassignments/resources/{resourceId}?api-version=7.1-preview.1

With optional parameters:

PUT https://dev.azure.com/{organization}/_apis/securityroles/scopes/{scopeId}/roleassignments/resources/{resourceId}?limitToCallerIdentityDomain={limitToCallerIdentityDomain}&api-version=7.1-preview.1

URI パラメーター

名前	/	必須	型	説明
resourceId	path	True	string	ロールが割り当てられるリソースの ID
scopeId	path	True	string	割り当てられたスコープの ID
organization	path		string	Azure DevOps 組織の名前です。
api-version	query	True	string	使う API のバージョン。このバージョンの API を使用するには、これを '7.1-preview.1' に設定する必要があります。
limitToCallerIdentityDomain	query		boolean

要求本文

名前	型	説明
body	UserRoleAssignmentRef[]	割り当てられるロール

応答

名前	型	説明
200 OK	RoleAssignment[]	正常な操作

セキュリティ

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.security_manage	セキュリティアクセス許可の読み取り、書き込み、管理を行う機能を付与します。

例

Set Role assignments

Sample Request

HTTP

PUT https://dev.azure.com/_apis/securityroles/scopes/{scopeId}/roleassignments/resources/{resourceId}?api-version=7.1-preview.1

[
  {
    "roleName": "Administrator",
    "userId": "4189bd2b-de9c-45de-a886-4e3d9c03f1f9"
  }
]

Sample Response

Status code:: 200

{
  "count": 1,
  "value": [
    {
      "identity": {
        "displayName": "Your Identity Name",
        "id": "cbb1d8ac-cee5-47c1-878a-e75c0e94ac89",
        "uniqueName": "Your Identity Unique Name"
      },
      "role": {
        "displayName": "Administrator",
        "name": "Administrator",
        "allowPermissions": 3,
        "denyPermissions": 0,
        "identifier": "distributedtask.serviceendpointrole.Administrator",
        "description": "Administrator can use and manage the service connection.",
        "scope": "distributedtask.serviceendpointrole"
      },
      "access": "assigned",
      "accessDisplayName": "Assigned"
    }
  ]
}

定義

名前	説明
IdentityRef
ReferenceLinks	REST 参照リンクのコレクションを表すクラス。
RoleAccess	明示的に割り当てられたロールまたは継承されたロールを指定します。
RoleAssignment
SecurityRole
UserRoleAssignmentRef

IdentityRef

名前	型	説明
_links	ReferenceLinks	このフィールドには、グラフの件名に関する 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 は、このグラフの件名のソースリソースへの完全なルートです。

ReferenceLinks

REST 参照リンクのコレクションを表すクラス。

名前	型	説明
links	object	リンクの読み取り時ビュー。参照リンクは読み取り専用であるため、参照リンクは読み取り専用として公開する必要があります。

RoleAccess

明示的に割り当てられたロールまたは継承されたロールを指定します。

名前	型	説明
assigned	string	アクセスが明示的に設定されています。
inherited	string	アクセスは、より高いスコープから継承されています。

RoleAssignment

名前	型	説明
access	RoleAccess	明示的に割り当てられたロールまたは継承されたロールを指定します。
accessDisplayName	string	アクセスの割り当てのわかりやすい説明。
identity	IdentityRef	ロールが割り当てられているユーザー。
role	SecurityRole	ユーザーに割り当てられたロール。

SecurityRole

名前	型	説明
allowPermissions	integer	ロールが許可されているアクセス許可。
denyPermissions	integer	ロールが拒否されたアクセス許可。
description	string	ロールによって定義されたユーザーアクセスの説明
displayName	string	ロールのユーザーフレンドリ名。
identifier	string	ロールのグローバル一意識別子。
name	string	スコープ内のロールの一意の名前。
scope	string	ParentScope の ID を返します。

UserRoleAssignmentRef

名前	型	説明
roleName	string	割り当てられたロールの名前。
uniqueName	string	ロールの割り当てが与えられたユーザーの識別子。
userId	string	ロールの割り当てが与えられたユーザーの一意の ID。

次の方法で共有