UnifiedRoleDefinition の更新Update unifiedRoleDefinition

重要

Microsoft Graph の/betaバージョンの api は変更される可能性があります。APIs under the /beta version in Microsoft Graph are subject to change. 実稼働アプリケーションでは、これらの API の使用はサポートされていません。Use of these APIs in production applications is not supported.

UnifiedRoleDefinitionオブジェクトのプロパティを更新します。Update the properties of a unifiedRoleDefinition object.

アクセス許可Permissions

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

アクセス許可の種類Permission type アクセス許可 (特権の小さいものから大きいものへ)Permissions (from least to most privileged)
委任 (職場または学校のアカウント)Delegated (work or school account) RoleManagement、RoleManagement、またはディレクトリRoleManagement.Read.Directory, RoleManagement.ReadWrite.Directory
委任 (個人用 Microsoft アカウント)Delegated (personal Microsoft account) サポートされていません。Not supported.
アプリケーションApplication RoleManagement、RoleManagement、またはディレクトリRoleManagement.Read.Directory, RoleManagement.ReadWrite.Directory

HTTP 要求HTTP request

PATCH /roleManagement/directory/roleDefinitions/{id}

要求ヘッダーRequest headers

名前Name 説明Description
AuthorizationAuthorization ベアラー {トークン}Bearer {token}

要求本文Request body

要求本文で、更新する関連フィールドの値を指定します。In the request body, supply the values for relevant fields that should be updated. 要求本文に含まれない既存のプロパティは、以前の値のままになるか、他のプロパティ値の変化に基づいて再計算されます。Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. 最適なパフォーマンスを得るために、変更されていない既存の値を含めないでください。For best performance, don't include existing values that haven't changed.

プロパティProperty Type 説明Description
descriptiondescription StringString ロール定義の説明。The description for the role definition. IsBuiltIn が true の場合は、値の取得のみ可能です。Read-only when isBuiltIn is true.
displayNamedisplayName StringString ロール定義の表示名。The display name for the role definition. IsBuiltIn が true の場合は、値の取得のみ可能です。Read-only when isBuiltIn is true. 必須。Required.
idid 文字列String ロール定義の一意識別子。The unique identifier for the role definition. キー。 null 許容ではありません。読み取り専用です。Key, not nullable, Read-only.
isBuiltInisBuiltIn BooleanBoolean ロール定義が product または custom に含まれる既定のセットの一部であるかどうかを示すフラグ。Flag indicating if the role definition is part of the default set included with the product or custom. 読み取り専用。Read-only.
isEnabledisEnabled BooleanBoolean 役割が割り当てに対して有効になっているかどうかを示すフラグ。Flag indicating if the role is enabled for assignment. False の場合、役割は割り当てに使用できません。If false the role is not available for assignment. IsBuiltIn が true の場合は、値の取得のみ可能です。Read-only when isBuiltIn is true.
resourceScopesresourceScopes String コレクションString collection ロール定義によって付与される範囲のアクセス許可の一覧が適用されます。List of scopes permissions granted by the role definition apply to. 現時点では "/" のみがサポートされています。Currently only "/" is supported. IsBuiltIn が true の場合は、値の取得のみ可能です。Read-only when isBuiltIn is true.
rolePermissionsrolePermissions unifiedRolePermissionコレクションunifiedRolePermission collection 役割に含まれるアクセス許可の一覧。List of permissions included in the role. IsBuiltIn が true の場合は、値の取得のみ可能です。Read-only when isBuiltIn is true. 必須です。Required.
templateIdtemplateId StringString IsBuiltIn が false のときに設定できるカスタムテンプレート識別子。Custom template identifier that can be set when isBuiltIn is false. この識別子は、通常、異なるディレクトリ間で識別子を同じにする必要がある場合に使用されます。This identifier is typically used if one needs an identifier to be the same across different directories. IsBuiltIn が true の場合は、値の取得のみ可能です。Read-only when isBuiltIn is true.
versionversion StringString ロール定義のバージョンを示します。Indicates version of the role definition. IsBuiltIn が true の場合は、値の取得のみ可能です。Read-only when isBuiltIn is true.

応答Response

成功した場合、このメソッド200 OKは応答コードと、応答本文で更新されたunifiedRoleDefinitionオブジェクトを返します。If successful, this method returns a 200 OK response code and an updated unifiedRoleDefinition object in the response body.

Example

要求Request

要求の例を次に示します。The following is an example of the request.

PATCH https://graph.microsoft.com/beta/roleManagement/directory/roleDefinitions/0d55728d-3e24-4309-9b1b-5ac09921475a
Content-type: application/json

{
  "description": "Update basic properties of application registrations",
  "displayName": "Application Registration Support Administrator",
  "rolePermissions":
    [
        {
            "allowedResourceActions": 
            [
                "microsoft.directory/applications/basic/read"
            ]
        }
    ]
}

応答Response

応答の例を次に示します。The following is an example of the response.

注: 読みやすくするために、ここに示す応答オブジェクトは短縮されている場合があります。実際の呼び出しからは、すべてのプロパティが返されます。Note: The response object shown here might be shortened for readability. All the properties will be returned from an actual call.

HTTP/1.1 204 OK
Content-type: application/json