REST Resource: customers.v2.ResourceTypes

Resource: ResourceType

From RFC 7643 section 6. Specifies the metadata about a resource type.

JSON representation 
{
  "schemas": [
    string
  ],
  "schemaExtensions": [
    {
      object (SchemaExtension)
    }
  ],
  "name": string,
  "id": string,
  "description": string,
  "endpoint": string,
  "schema": string,
  "meta": {
    object (Meta)
  }
}
Fields
schemas[]

string

Output only. The schemas attribute contains URIs that are used to indicate the namespaces of the SCIM schemas that define the attributes present in the current JSON structure.
schemaExtensions[]

object (SchemaExtension)

Output only. A list of schema extensions for this resource type.
name

string

Output only. The resource type name. For example, User or Group.
id

string

Identifier. The resource type's unique ID. This is the same value as the name attribute.
description

string

Output only. The resource type's human-readable description.
endpoint

string

Output only. The resource type's HTTP-addressable endpoint relative to the base URL.
schema

string

Output only. The resource type's primary/base schema URI.
meta

object (Meta)

Output only. Resource metadata assigned by the service provider.

SchemaExtension

From RFC 7643 Section 6. Defines a schema extension supported or required for a SCIM resource type.

JSON representation 
{
  "schema": string,
  "required": boolean
}
Fields
schema

string

Required. The URI of an extended schema, for example, urn:edu:2.0:Staff. This must be equal to the id attribute of a Schema resource.
required

boolean

Required. Specifies whether or not the schema extension is required for the resource type. If true, a resource of this type must include this schema extension and also include any attributes declared as required in this schema extension. If false, a resource of this type may omit this schema extension.

Methods

get

 Retrieves a specific resource type.

list

 Retrieves all resource types.