REST Resource: customers.v2.ResourceTypes

资源:ResourceType

摘自 RFC 7643 第 6 节。指定有关资源类型的元数据。

JSON 表示法
{
  "schemas": [
    string
  ],
  "schemaExtensions": [
    {
      object (SchemaExtension)
    }
  ],
  "name": string,
  "id": string,
  "description": string,
  "endpoint": string,
  "schema": string,
  "meta": {
    object (Meta)
  }
}
字段
schemas[]

string

仅限输出。schemas 属性包含用于指明 SCIM 架构命名空间的 URI,这些 SCIM 架构定义了当前 JSON 结构中存在的属性。

schemaExtensions[]

object (SchemaExtension)

仅限输出。相应资源类型的架构扩展列表。

name

string

仅限输出。资源类型名称。例如 UserGroup

id

string

标识符。资源类型的唯一 ID。此值与 name 属性的值相同。

description

string

仅限输出。资源类型的人类可读说明。

endpoint

string

仅限输出。资源类型相对于基本网址的 HTTP 可寻址端点。

schema

string

仅限输出。资源类型的主架构/基本架构 URI。

meta

object (Meta)

仅限输出。服务提供商分配的资源元数据。

SchemaExtension

摘自 RFC 7643 第 6 节。定义 SCIM 资源类型支持或必需的架构扩展。

JSON 表示法
{
  "schema": string,
  "required": boolean
}
字段
schema

string

必需。扩展架构的 URI,例如 urn:edu:2.0:Staff。此值必须与 Schema 资源的 id 属性相同。

required

boolean

必需。指定资源类型是否需要架构扩展。如果值为 true,则相应类型的资源必须包含此架构扩展,还必须包含此架构扩展中声明为必需的任何属性。如果为 false,则相应类型的资源可以省略此架构扩展。

方法

get

检索特定资源类型。

list

检索所有资源类型。