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: 属性はいつでも更新できます。属性値は返されません（値が保存されたハッシュであるためなど）。注: mutability が writeOnly の属性には、通常、returned 設定も never になります。
returned

string

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

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

string

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

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

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

メソッド

get

 Schema を取得します。

list

 すべての Schema を取得します。