REST Resource: customers.policySchemas

リソース: PolicySchema

ポリシー スキーマを表すリソース。

JSON 表現 
{
  "name": string,
  "policyDescription": string,
  "additionalTargetKeyNames": [
    {
      object (AdditionalTargetKeyName)
    }
  ],
  "definition": {
    object (FileDescriptorProto)
  },
  "fieldDescriptions": [
    {
      object (PolicySchemaFieldDescription)
    }
  ],
  "accessRestrictions": [
    string
  ],
  "notices": [
    {
      object (PolicySchemaNoticeDescription)
    }
  ],
  "supportUri": string,
  "schemaName": string,
  "validTargetResources": [
    enum (TargetResource)
  ],
  "policyApiLifecycle": {
    object (PolicyApiLifecycle)
  },
  "categoryTitle": string
}
フィールド
name

string

形式: name=customers/{customer}/policySchemas/{schema_namespace}
policyDescription

string

出力のみ。ユーザーが使用するポリシー スキーマの説明。
additionalTargetKeyNames[]

object (AdditionalTargetKeyName)

出力のみ。ポリシー値のターゲットを識別するために使用される追加のキー名。policyTargetKey を指定する場合、ここで指定する各追加キーは additionalTargetKeys マップに含める必要があります。
definition

object (FileDescriptorProto)

proto 記述子を使用したスキーマ定義。
fieldDescriptions[]

object (PolicySchemaFieldDescription)

出力のみ。スキーマを構成する各フィールドの詳細な説明。
accessRestrictions[]

string

出力のみ。このポリシーに関連する特定のアクセス制限。
notices[]

object (PolicySchemaNoticeDescription)

出力のみ。スキーマの特定のフィールドに特定の値を設定することに関する特別な通知メッセージ。
supportUri

string

出力のみ。このスキーマの関連サポート記事への URI。
schemaName

string

出力のみ。ポリシー スキーマの完全修飾名。この値は、orgunits.batchInherit orgunits.batchModify groups.batchModify または groups.batchDelete を呼び出すときに、PolicyValue のフィールド policySchema に入力するために使用されます。
validTargetResources[]

enum (TargetResource)

出力のみ。ポリシーに適用可能なターゲット リソースに関する情報。
policyApiLifecycle

object (PolicyApiLifecycle)

出力のみ。現在のライフサイクル情報。
categoryTitle

string

設定が属するカテゴリのタイトル。

追加のターゲットキー名

ポリシー値のターゲットを識別するために使用される追加のキー名。

JSON 表現 
{
  "key": string,
  "keyDescription": string
}
フィールド
key

string

鍵名。
keyDescription

string

鍵の説明。

FileDescriptorProto

完全な .proto ファイルを記述します。

JSON 表現 
{
  "name": string,
  "package": string,
  "messageType": [
    {
      object (DescriptorProto)
    }
  ],
  "enumType": [
    {
      object (EnumDescriptorProto)
    }
  ],
  "syntax": string
}
フィールド
name

string

ファイル名（ソースツリーのルートからの相対パス）
package

string

例: "foo"、"foo.bar" など
messageType[]

object (DescriptorProto)

このファイルのすべての最上位定義。
enumType[]

object (EnumDescriptorProto)
syntax

string

proto ファイルの構文。指定できる値は「proto2」、「proto3」、「editions」です。

edition が存在する場合、この値は「editions」にする必要があります。

DescriptorProto

メッセージのタイプを記述します。

JSON 表現 
{
  "name": string,
  "field": [
    {
      object (FieldDescriptorProto)
    }
  ],
  "nestedType": [
    {
      object (DescriptorProto)
    }
  ],
  "enumType": [
    {
      object (EnumDescriptorProto)
    }
  ],
  "oneofDecl": [
    {
      object (OneofDescriptorProto)
    }
  ]
}
フィールド
name

string
field[]

object (FieldDescriptorProto)
nestedType[]

object (DescriptorProto)
enumType[]

object (EnumDescriptorProto)
oneofDecl[]

object (OneofDescriptorProto)

FieldDescriptorProto

メッセージ内のフィールドを記述します。

JSON 表現 
{
  "name": string,
  "number": integer,
  "label": enum (Label),
  "type": enum (Type),
  "typeName": string,
  "defaultValue": string,
  "oneofIndex": integer,
  "jsonName": string,
  "proto3Optional": boolean
}
フィールド
name

string
number

integer
label

enum (Label)
type

enum (Type)

typeName が設定されている場合は、この値を設定する必要はありません。これと typeName の両方が設定されている場合、これは TYPE_ENUM、TYPE_MESSAGE、TYPE_GROUP のいずれかにする必要があります。
typeName

string

メッセージ型と列挙型の場合、これは型の名前です。名前が「.」で始まる場合は完全修飾名です。それ以外の場合、C++ のようなスコープルールを使用して型を検索します（つまり、最初にこのメッセージに含まれるネストされた型を、親の内部でルート名前空間まで検索します）。
defaultValue

string

数値型の場合、値の元のテキスト表現が含まれます。ブール値の場合は、「true」または「false」。文字列の場合、デフォルトのテキスト コンテンツが含まれます（エスケープなし）。バイトの場合、C エスケープ値が含まれます。128 バイト以上はエスケープされます。
oneofIndex

integer

設定すると、含まれる型の oneofDecl リストにある one のインデックスが与えられます。このフィールドはそのメンバーです。
jsonName

string

このフィールドの JSON 名。値はプロトコル コンパイラで設定します。このフィールドに「jsonName」オプションが設定されている場合、そのオプションの値が使用されます。それ以外の場合は、このフィールドをキャメルケースに変換することで、フィールドの名前から推測されます。
proto3Optional

boolean

true の場合、proto3 は「オプション」です。proto3 フィールドがオプションの場合、フィールド タイプに関係なくプレゼンスを追跡します。

proto3Optional が true の場合、このフィールドには、このフィールドのプレゼンスがトラッキングされていることを古い proto3 クライアントに伝えるために、いずれかに属している必要があります。これを「合成合成」と呼びます。このフィールドは唯一のメンバーでなければなりません（各 proto3 のオプション フィールドは独自の合成 Oneof を備えています）。合成 Oneofs は記述子内にのみ存在し、API を生成しません。合成オフェンスは、すべての「現実」のものの後に並べる必要があります。

メッセージ フィールドの場合、proto3Additional はセマンティックな変更を行いません。繰り返しでないメッセージ フィールドは常にプレゼンスを追跡するためです。ただし、ユーザーが「任意」と書いたかどうかに関するセマンティックな詳細はまだ示されています。これは、.proto ファイルを往復する場合に役立ちます。一貫性を保つために、メッセージ フィールドも合成フィールドになっていますが、プレゼンスをトラッキングする必要はありません。これが特に重要なのは、パーサーではフィールドがメッセージか列挙型かを判断できないため、常に合成フィールドを作成する必要があります。

Proto2 のオプション フィールドでは、LABEL_OPTIONAL ですでにオプションを指定しているため、このフラグは設定されません。

ラベル

列挙型
LABEL_OPTIONAL 0 はエラー用に予約されています
LABEL_REQUIRED
LABEL_REPEATED

タイプ

列挙型
TYPE_DOUBLE 0 はエラー用に予約されています。注文が変わっているのは、歴史上の理由からです。
TYPE_FLOAT
TYPE_INT64 ジグザグ エンコードではありません。負の数値は 10 バイトです。負の可能性がある場合は TYPE_SINT64 を使用します。
TYPE_UINT64
TYPE_INT32 ジグザグ エンコードではありません。負の数値は 10 バイトです。負の可能性がある場合は TYPE_SINT32 を使用します。
TYPE_FIXED64
TYPE_FIXED32
TYPE_BOOL
TYPE_STRING
TYPE_GROUP タグ区切りの集計。グループタイプはサポートが終了しており、proto3 ではサポートされていません。ただし、Proto3 実装では、グループ転送形式を解析し、グループ フィールドを不明なフィールドとして扱う必要があります。
TYPE_MESSAGE 長さ区切りの集計データ。
TYPE_BYTES バージョン 2 の新機能。
TYPE_UINT32
TYPE_ENUM
TYPE_SFIXED32
TYPE_SFIXED64
TYPE_SINT32 ジグザグ エンコードを使用します。
TYPE_SINT64 ジグザグ エンコードを使用します。

EnumDescriptorProto

列挙型を記述します。

JSON 表現 
{
  "name": string,
  "value": [
    {
      object (EnumValueDescriptorProto)
    }
  ]
}
フィールド
name

string
value[]

object (EnumValueDescriptorProto)

EnumValueDescriptorProto

列挙型の値を記述します。

JSON 表現 
{
  "name": string,
  "number": integer
}
フィールド
name

string
number

integer

OneofDescriptorProto

次のいずれかを表します。

JSON 表現 
{
  "name": string
}
フィールド
name

string

PolicySchemaField の説明

PolicySchema の一部である特定のフィールドの詳細情報を提供します。

JSON 表現 
{
  "field": string,
  "description": string,
  "inputConstraint": string,
  "knownValueDescriptions": [
    {
      object (PolicySchemaFieldKnownValueDescription)
    }
  ],
  "nestedFieldDescriptions": [
    {
      object (PolicySchemaFieldDescription)
    }
  ],
  "fieldDependencies": [
    {
      object (PolicySchemaFieldDependencies)
    }
  ],
  "requiredItems": [
    {
      object (PolicySchemaRequiredItems)
    }
  ],
  "defaultValue": value,
  "name": string,
  "fieldDescription": string,
  "fieldConstraints": {
    object (FieldConstraints)
  }
}
フィールド
field

string

出力のみ。この説明に関連付けるフィールドの名前。
description
(deprecated)

string

非推奨です。代わりに name と fieldDescription を使用してください。フィールドの説明。
inputConstraint

string

出力のみ。フィールドの値に関連付けられている入力制約。
knownValueDescriptions[]

object (PolicySchemaFieldKnownValueDescription)

出力のみ。フィールドに既知の値のセットがある場合、このフィールドにはそれらの値の説明が表示されます。
nestedFieldDescriptions[]

object (PolicySchemaFieldDescription)

出力のみ。このフィールドがネストされた場合に、複数のフィールドを定義するメッセージ タイプである場合のフィールドの説明。
fieldDependencies[]

object (PolicySchemaFieldDependencies)

出力のみ。フィールドと値の一覧を示します。このフィールドを設定できるようにするには、少なくとも 1 つのフィールドに対応する値が必要です。
requiredItems[]

object (PolicySchemaRequiredItems)

出力のみ。このフィールドに特定の値がある場合に設定する必要があるフィールドのリストを示します。
defaultValue

value (Value format)

出力のみ。ポリシーが設定されていない場合はクライアントのデフォルト。
name

string

出力のみ。フィールドの名前。
fieldDescription

string

出力のみ。フィールドの説明。
fieldConstraints

object (FieldConstraints)

出力のみ。フィールドの値に関連付けられている入力制約に関する情報。

PolicySchemaFieldKnownValueDescription

PolicySchema の特定のフィールドで許可される既知の値に関する詳細情報を提供します。

JSON 表現 
{
  "value": string,
  "description": string
}
フィールド
value

string

出力のみ。フィールドに設定可能な値の文字列の再利用。
description

string

出力のみ。この値に関するその他の説明です。

PolicySchemaField の依存関係

別のフィールドを設定できるようにするには、このフィールドと値は必須です。

JSON 表現 
{
  "sourceField": string,
  "sourceFieldValue": string
}
フィールド
sourceField

string

このフィールドが依存するソース フィールド。
sourceFieldValue

string

このフィールドを設定できるようにソース フィールドで必要な値。

PolicySchemaRequiredItems

このフィールドの値に基づいて必須になるフィールド。

JSON 表現 
{
  "fieldConditions": [
    string
  ],
  "requiredFields": [
    string
  ]
}
フィールド
fieldConditions[]

string

必要なフィールドの適用を誘発したフィールドの値。空の fieldConditions は、このフィールドに割り当てられた値によって必須フィールドの適用がトリガーされることを意味します。
requiredFields[]

string

フィールド条件の結果として必須のフィールド。

フィールド制約

任意の範囲の制約に関する情報。

JSON 表現 
{
  "numericRangeConstraint": {
    object (NumericRangeConstraint)
  }
}
フィールド
numericRangeConstraint

object (NumericRangeConstraint)

数値フィールドで使用できる範囲。

NumericRangeConstraint

上限または下限の制限。少なくとも 1 つが設定されます。

JSON 表現 
{
  "minimum": string,
  "maximum": string
}
フィールド
minimum

string (int64 format)

最小値。
maximum

string (int64 format)

最大値

PolicySchemaNoticeDescription

PolicySchema の一部であるフィールドの特定の値に関連する特別な通知メッセージを提供します。

JSON 表現 
{
  "field": string,
  "noticeValue": string,
  "noticeMessage": string,
  "acknowledgementRequired": boolean
}
フィールド
field

string

出力のみ。通知に関連付けられたフィールド名。
noticeValue

string

出力のみ。通知があるフィールドの値。このフィールドに値を設定する際、通知メッセージの確認応答をユーザーに求める場合があります。
noticeMessage

string

出力のみ。この通知メッセージは、フィールドの値と関連付けられます。
acknowledgementRequired

boolean

出力のみ。値を設定する前にユーザーが通知メッセージを確認する必要があるかどうか。

ターゲット リソース

ターゲットのリソースタイプ

列挙型
TARGET_RESOURCE_UNSPECIFIED ターゲット リソースが指定されていません。
ORG_UNIT 組織部門のターゲット リソース。
GROUP グループ ターゲット リソース。

PolicyApiLifecycle

JSON 表現 
{
  "policyApiLifecycleStage": enum (PolicyApiLifecycleEnum),
  "description": string,
  "endSupport": {
    object (Date)
  },
  "deprecatedInFavorOf": [
    string
  ]
}
フィールド
policyApiLifecycleStage

enum (PolicyApiLifecycleEnum)

Policy API の現在のライフサイクル ステージを示します。
description

string

現在のライフサイクルに関する説明。
endSupport

object (Date)

現在のポリシーのサポート終了日。
deprecatedInFavorOf[]

string

このポリシーのサポートを終了して別のポリシーに置き換えた場合、PolicyAPI で表示される新しいポリシーの完全修飾名前空間を使用します。

PolicyApiLifecycleEnum

列挙型
API_UNSPECIFIED 指定されていません。
API_PREVIEW ポリシーはまだ機能していませんが、デベロッパーにフォーマットを求めましょう。このステージは API_DEVELOPEMNT または API_CURRENT に移行できます。
API_DEVELOPMENT ポリシーは、下位互換性のない方法で形式を変更できます（互換性を破る変更）。このステージは API_CURRENT または API_DEPRECATED に移行できます。TT にのみリリースするポリシーや、緊急に使用するために一部のお客様にリリースするポリシーに使用できます。
API_CURRENT 正式な形式のポリシー。ポリシーには下位互換性のある形式（互換性を破らない変更）が含まれる場合があります。例: このポリシーでは、フィールド マスクを適切に利用することで、互換性を破らない変更と見なされる新しいフィールドを導入できます。このステージは API_DEPRECATED に移行できます。
API_DEPRECATED このポリシーの使用を停止してください。このポリシーのサポートは終了しており、今後削除される可能性があります。ほとんどの場合、このポリシーに代わって新しいポリシーが導入されました。

日付

カレンダーの日付全体または日付の一部（誕生日など）を表します。時刻とタイムゾーンが別の場所で指定されているか、重要でない。日付は、グレゴリオ カレンダーの相対日付です。これは、次のいずれかを表します。

  • ゼロ以外の年、月、日の値を含む完全な日付。
  • 年と 0 年の年（記念日など）。
  • 1 年目も 0 か月と 0 日の日数がゼロです。
  • 年と月（ゼロの日付など）（クレジット カードの有効期限など）。

関連の種類:

JSON 表現 
{
  "year": integer,
  "month": integer,
  "day": integer
}
フィールド
year

integer

日付の年。1 ～ 9999、または 0（年のない日付）を指定します。
month

integer

月（月）。月と日のない年を指定するには、1 ～ 12、または 0 にする必要があります。
day

integer

月の特定の日。1 から 31 までの範囲で年と月に対して有効です。年を限定する場合は自身を 0 とするか、日付が重要でない年と月を 0 と指定します。

Methods

get

 リソース名ごとに、お客様の特定のポリシー スキーマを取得します。

list

 特定の顧客の指定したフィルタ値に一致するポリシー スキーマのリストを取得します。