REST Resource: customers.v2.Schemas

リソース: Schema

RFC 7643 セクション 7 から。スキーマに関するメタデータを指定します。

JSON 表現 
{
  "attributes": [
    {
      object (Attribute)
    }
  ],
  "id": string,
  "name": string,
  "description": string
}
フィールド
attributes[]

object (Attribute)

必須。スキーマの属性のリスト。
id

string

必須。スキーマの一意の URI。該当する場合、サービス プロバイダは URI（例: urn:ietf:params:scim:schemas:core:2.0:User）を指定する必要があります。ほとんどのスキーマでは id に何らかのグローバル一意識別子（GUID）を使用しますが、このスキーマの id は URI であるため、登録が可能で、異なるサービス プロバイダとクライアント間で移植できます。
name

string

省略可。スキーマの人間が読める形式の名前。該当する場合、サービス プロバイダは名前（User や Group など）を指定する必要があります。
description

string

省略可。スキーマの人が読める形式の説明。該当する場合、サービス プロバイダは説明を指定する必要があります。

属性

RFC 7643 セクション 7 から。属性の特性を定義します。

JSON 表現 
{
  "subAttributes": [
    {
      object (Attribute)
    }
  ],
  "canonicalValues": [
    string
  ],
  "referenceTypes": [
    string
  ],
  "name": string,
  "type": string,
  "multiValued": boolean,
  "description": string,
  "required": boolean,
  "caseExact": boolean,
  "mutability": string,
  "returned": string,
  "uniqueness": string
}
フィールド
subAttributes[]

object (Attribute)

属性の型が complex の場合、subAttributes はサブ属性のセットを定義します。subAttributes に attributes と同じスキーマ サブ属性がある。
canonicalValues[]

string

省略可。使用できる推奨正規値のコレクション（work や home など）。サービス プロバイダは、サポートされていない値を無視する場合があります。
referenceTypes[]

string

参照可能な SCIM リソースタイプを示す JSON 文字列の複数値配列。有効な値は次のとおりです。

  • SCIM リソースタイプ（User、Group など）。
  • external - リソースが外部リソース（写真など）であることを示すか、
  • uri - 参照がサービス エンドポイントまたは識別子（スキーマ URN など）であることを示します。

この属性は、タイプ reference の属性（セクション 2.3.7）にのみ適用されます。
name

string

属性の名前。
type

string

属性のデータ型。有効な値は string、boolean、decimal、integer、dateTime、reference、complex です。属性の型が complex の場合、対応するスキーマ属性 subAttributes が定義され、属性のサブ属性がリストされている必要があります。
multiValued

boolean

属性の複数形を示します。
description

string

属性の説明（人が読める形式）。該当する場合、サービス プロバイダは説明を指定する必要があります。
required

boolean

属性が必須かどうかを指定します。
caseExact

boolean

文字列属性で大文字と小文字が区別されるかどうかを指定します。サーバーは、フィルタを評価するときに大文字と小文字を区別します。大文字と小文字が区別される属性の場合、サーバーは送信された値の大文字と小文字を保持します。属性で大文字と小文字が区別されない場合、サーバーは送信された値の大文字と小文字を変更することがあります。大文字と小文字の区別は、属性値とフィルタ値の比較方法にも影響します（RFC 7644 セクション 3.4.2.2 を参照）。

RFC 7643 セクション 2.3.6 と RFC 7643 セクション 2.3.7 に従って、binary 型と reference 型は caseExact です。
mutability

string

属性の値を（再）定義できる状況を示す単一のキーワード:

  • readOnly: 属性は変更できません。
  • readWrite: デフォルト。属性はいつでも更新および読み取りできます。
  • immutable: この属性は、リソースの作成時（POST など）またはリクエストによるレコードの置換時（PUT など）に定義できます。属性は、最初の定義後に変更できません。
  • writeOnly: 属性はいつでも更新できます。属性値が返されません（値が保存されたハッシュであるなど）。注: 通常、変更可能性が writeOnly の属性には、返される設定も never になります。
returned

string

GET リクエストへのレスポンス、または PUT、POST、PATCH リクエストへのレスポンスで、属性と関連する値が返されるタイミングを示す単一のキーワード。有効なキーワードは次のとおりです。

  • always: attributes パラメータの内容に関係なく、属性は常に返されます。たとえば、SCIM リソースを識別するために常に id が返されます。
  • never: 属性は返されません。これは、元の属性値（ハッシュ値など）がサービス プロバイダによって保持されていないことが原因である可能性があります。サービス プロバイダは、属性を検索フィルタで使用できるようにすることができます。
  • default: デフォルト。この属性は、属性値が返されるすべての SCIM オペレーション レスポンスでデフォルトで返されます。GET リクエストの attributes パラメータが指定されている場合、属性が attributes パラメータで指定されている場合にのみ、属性値が返されます。
  • request: 属性がクライアントによって指定された場合（属性が変更された場合など）、PUT、POST、PATCH オペレーションのレスポンスで属性が返されます。この属性は、attributes パラメータで指定されている場合にのみ、SCIM クエリ オペレーションで返されます。
uniqueness

string

サービス プロバイダが属性値の一意性をどのように適用するかを指定する単一のキーワード値。サーバーは、一意性に基づいて無効な値を拒否し、HTTP レスポンス コード 400 Bad Request を返すことがあります。クライアントは、サービス プロバイダが強制するよりも高いレベルでクライアント側で一意性を強制できます。たとえば、クライアントは値を一意にできますが、サーバーは none の一意性を持つことができます。有効なキーワードは次のとおりです。

  • none: デフォルト。値は一意であることを意図していません。
  • server: 値は現在の SCIM エンドポイント（またはテナンシー）のコンテキスト内で一意である必要があります。また、グローバルに一意である場合もあります（ユーザー名、メールアドレス、サーバー生成キー、カウンタなど）。同じサーバー上の 2 つのリソースが同じ値を持つことはできません。
  • global: 値はグローバルに一意である必要があります（メールアドレス、GUID など）。サーバー上の 2 つのリソースが同じ値を持つことはありません。

RFC 7643 のセクション 2.3 で指定されているように、Boolean、DateTime、Binary、Complex のデータ型には一意性がありません。

メソッド

get

 スキーマを取得します。

list

 すべてのスキーマを取得します。