ルート・スキーマ: schema
型: object
ソースを表示
- displayName(optional): string
ユーザー、クライアント・アプリケーションまたはグループの表示名。
リリース19.4.1.での導入。
- group(optional): グループ
メンバーのグループ詳細。 メンバーのタイプが「グループ」の場合にのみ使用できます。
リリース19.4.1.での導入。
- groupType(optional): string
メンバーがグループの場合、グループのタイプが指定されます。 メンバーがユーザーの場合、このフィールドは存在しません。
有効な値は次のとおりです。
-
oce - コンテンツ管理グループ -
idp - アイデンティティ・プロバイダ・グループ
リリース20.1.1で導入されました。
- id: string
ユーザー、クライアント・アプリケーションまたはグループ・メンバーの識別子。
フィールドの内容は想定しないでください。フィールドはopaque値として扱われる必要があります。
リリース19.4.1.での導入。
- isExternalUser(optional): boolean
関連するユーザーまたはクライアント・アプリケーションに外部ユーザー・ロールのみがある場合、trueに設定されます。
リリース21.10.2で導入されました。
- links(optional): array links
このリソースに対する関連リソースおよびアクションへのHATEOSリンク。 リソースの正規表現へのリンクを含む自己リンクを少なくとも1つ含める必要があります。
- name: string
ユーザー、クライアント・アプリケーションまたはグループの一意の名前。 メンバーがユーザーの場合、名前はユーザー名です。 メンバーがグループの場合、名前はグループ名です。
リリース19.4.1.での導入。
- role: string
ユーザー、クライアント・アプリケーションまたはグループが与えられた共有ロール。
有効な値は次のとおりです。
-
owner - ユーザーが所有者です。 -
manager - ユーザーにマネージャ・ロールがあります -
contributor - ユーザーにコントリビュータ・ロールがあります -
downloader - ユーザーにはダウンロード実行者ロールがあります -
viewer - ユーザーの参照者のロール
リリース19.4.1.での導入。
- type: string
メンバーがユーザー、クライアント・アプリケーションまたはグループであることを示します。
有効な値は次のとおりです。
-
user - メンバーはユーザーまたはクライアント・アプリケーションです。 ユーザーまたはメンバー間で区別されません
クライアント・アプリケーションであるメンバー。
リリース19.4.1.での導入。
- user(optional): user
メンバーのユーザーまたはクライアント・アプリケーションの詳細。 メンバーのタイプがuserの場合にのみ使用できます。 メンバーは、ユーザー、クライアント・アプリケーションまたはグループにすることができます。 ユーザーとクライアント・アプリケーションの両方の詳細を読むことができます。
リリース19.4.1.での導入。
{
"type":"object",
"properties":{
"links":{
"description":"<p>HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"allOf":[
{
"$ref":"#/definitions/Link"
}
]
}
},
"id":{
"description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.4.1.</small>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"role":{
"description":"<p>Sharing role that the user, client application or group has been given.</p><p>Valid values are:\n<ul><li> <code>owner</code> - User is the owner</li><li> <code>manager</code> - User has Manager role</li><li> <code>contributor</code> - User has Contributor role</li><li> <code>downloader</code> - User has Downloader role</li><li> <code>viewer</code> - User has Viewer role</li></p><small>Introduced in release 19.4.1.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"type":{
"description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.4.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"groupType":{
"description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"name":{
"description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.4.1.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"displayName":{
"description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.4.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"isExternalUser":{
"description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"user":{
"description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.4.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
},
"group":{
"description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.4.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Group"
}
]
}
},
"required":[
"id",
"role",
"type",
"name"
]
}
ネストされたスキーマ : グループ
メンバーのグループ詳細。 メンバーのタイプが「グループ」の場合にのみ使用できます。
リリース19.4.1.での導入。すべてに一致
ソースを表示
- allOf Group
グループとは、ユーザーおよびグループの集合です。 グループには、ユーザーが読取り可能なグループ名があります。
リリース19.3.1.での導入。
{
"description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.4.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Group"
}
]
}
ネストされたスキーマ: links
型: array
このリソースに対する関連リソースおよびアクションへのHATEOSリンク。 リソースの正規表現へのリンクを含む自己リンクを少なくとも1つ含める必要があります。
{
"description":"<p>HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"allOf":[
{
"$ref":"#/definitions/Link"
}
]
}
}
ネストされたスキーマ: user
メンバーのユーザーまたはクライアント・アプリケーションの詳細。 メンバーのタイプがuserの場合にのみ使用できます。 メンバーは、ユーザー、クライアント・アプリケーションまたはグループにすることができます。 ユーザーとクライアント・アプリケーションの両方の詳細を読むことができます。
リリース19.4.1.での導入。すべてに一致
ソースを表示
- allOf 「アイデンティティ」
識別子: type
ユーザーまたはクライアント・アプリケーションを表すアイデンティティ。 アイデンティティには、アイデンティティ識別子、一意の名前、表示名などの共通情報が含まれます。
リリース20.3.1で導入されました。
{
"description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.4.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
}
ネストされたスキーマ: Group
グループとは、ユーザーおよびグループの集合です。 グループには、ユーザーが読取り可能なグループ名があります。
リリース19.3.1.での導入。すべてに一致
ソースを表示
{
"description":"<p>A group is a collection of users and groups. A group has a human readable group name.</p><small>Introduced in release 19.3.1.</small>",
"allOf":[
{
"$ref":"#/definitions/SingularResource"
},
{
"properties":{
"id":{
"description":"<p>Unique identifer for the group.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.1.</small>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"type":{
"description":"<p>Type of the group.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 19.3.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"groupName":{
"description":"<p>Group name that is unique within the service instance.</p><small>Introduced in release 19.3.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"displayName":{
"description":"<p>Human-readable name for the group.</p><small>Introduced in release 19.3.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"roles":{
"description":"<p>Roles.</p><p>Valid values are:\n<ul><li> <code>CECServiceAdministrator</code> - Service Administrator</li></ul>\n<ul><li> Assign user enumerates</li><li> Change user passwords and challenge questions</li><li> Configure, monitor, and manage service instances</li><li> <code>CECSitesAdministrator</code> - Sites Administrator</li></ul>\n<ul><li> Create sites, templates, themes or components</li><li> <code>CECRepositoryAdministrator</code> - Repository Administrator</li><li> <code>CECDeveloperUser</code> - Developer User</li><li> <code>CECContentAdministrator</code> - Content Administrator</li></ul>\n<ul><li> Create new content types and publish items</li><li> <code>CECStandardUser</code> - Standard User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> View and interact with content items in sites</li><li> Manage and view custom properties and edit values</li><li> <code>CECEnterpriseUser</code> - Enterprise User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Digital Assets</li><li> Content Items (editorial content management)</li><li> Create, manage, view, and interact with content items</li><li> Collections</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> Manage and view custom properties and edit values</li><li> <code>CECExternalUser</code> - External User</li></ul>\nReserved for future use.\n<ul><li> <code>CECIntegrationUser</code> - Integration User</li></ul>\nUsed to impersonate another user while performing operations through the Social REST endpoints of the REST API for Collaboration.\n<ul><li> <code>CECSitesVisitor</code> - Sites Visitor</li></ul>\nAccess sites restricted to visitors.\n</p><small>Introduced in release 21.10.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"type":"string"
}
}
}
}
]
}
ネストされたスキーマ : SingularResource
型: object
すべての単数形のリソースには、特異なリソース定義のプロパティが含まれます。 単一のリソースには、他のリソースとの関係を提供するリンク、またはリソース自体をselfがリンクするリンク先のリストが含まれます。
{
"description":"<p>All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the <em>self</em> link the resource itself.</p>",
"properties":{
"links":{
"description":"<p>HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"allOf":[
{
"$ref":"#/definitions/Link"
}
]
}
}
}
}
ネストされたスキーマ : Group-allOf[1]
型: object
ソースを表示
- displayName(optional): string
グループに対する、人間が読み取り可能な名前。
リリース19.3.1.での導入。
- groupName(optional): string
サービス・インスタンス内で一意のグループ名。
リリース19.3.1.での導入。
- id(optional): string
グループの一意の識別子。
フィールドの内容は想定しないでください。フィールドはopaque値として扱われる必要があります。
リリース19.3.1.での導入。
- roles(optional): array roles
ロール
有効な値は次のとおりです。
-
CECServiceAdministrator - サービス管理者
- ユーザー列挙の割当
- ユーザーのパスワードおよびチャレンジ質問の変更
- サービス・インスタンスの構成、モニターおよび管理
-
CECSitesAdministrator - サイト管理者
- サイト、テンプレート、テーマまたはコンポーネントの作成
-
CECRepositoryAdministrator - リポジトリ管理者 -
CECDeveloperUser - 開発者ユーザー -
CECContentAdministrator - コンテンツ管理者
- 新規コンテンツ・タイプの作成およびアイテムの公開
-
CECStandardUser - 標準ユーザー
- コンテンツの管理(ドキュメントの表示、アップロードおよび編集)
- 他のユーザーとのコンテンツおよびサイトの共有
- 会話によるコラボレーション(トピックのディスカッション、他のユーザーへのメッセージの送信、他のユーザーへのフラグの割当て、ドキュメントへの注釈の追加)
- ユーザーのフォロー
- サイトの作成、編集および公開
- サイトのテーマの管理および公開
- カスタム・サイト・コンポーネントの作成、登録、エクスポートおよびインポート
- サイト・テンプレートの作成、編集、エクスポートおよびインポート
- サイト内のコンテンツの表示および操作
- カスタム・プロパティの管理と表示、および値の編集
-
CECEnterpriseUser - エンタープライズ・ユーザー
- コンテンツの管理(ドキュメントの表示、アップロードおよび編集)
- 他のユーザーとのコンテンツおよびサイトの共有
- 会話によるコラボレーション(トピックのディスカッション、他のユーザーへのメッセージの送信、他のユーザーへのフラグの割当て、ドキュメントへの注釈の追加)
- ユーザーのフォロー
- デジタル・アセット
- コンテンツ・アイテム(エディトリアル・コンテンツ管理)
- コンテンツ・アイテムの作成、管理、表示および操作
- コレクション
- サイトの作成、編集および公開
- サイトのテーマの管理および公開
- カスタム・サイト・コンポーネントの作成、登録、エクスポートおよびインポート
- サイト・テンプレートの作成、編集、エクスポートおよびインポート
- カスタム・プロパティの管理と表示、および値の編集
-
CECExternalUser - 外部ユーザー
将来使用するために予約済
-
CECIntegrationUser - 統合ユーザー
Collaboration REST APIのソーシャルRESTエンドポイントを介して操作を実行しながら、別のユーザーを偽装するために使用されます。
-
CECSitesVisitor - サイト・ビジター
サイトへのアクセスはビジターに制限されます。
リリース21.10.2で導入されました。
- type(optional): string
グループのタイプ。
有効な値は次のとおりです。
-
oce - コンテンツ管理グループ -
idp - アイデンティティ・プロバイダ・グループ
リリース19.3.1.での導入。
{
"properties":{
"id":{
"description":"<p>Unique identifer for the group.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.1.</small>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"type":{
"description":"<p>Type of the group.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 19.3.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"groupName":{
"description":"<p>Group name that is unique within the service instance.</p><small>Introduced in release 19.3.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"displayName":{
"description":"<p>Human-readable name for the group.</p><small>Introduced in release 19.3.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"roles":{
"description":"<p>Roles.</p><p>Valid values are:\n<ul><li> <code>CECServiceAdministrator</code> - Service Administrator</li></ul>\n<ul><li> Assign user enumerates</li><li> Change user passwords and challenge questions</li><li> Configure, monitor, and manage service instances</li><li> <code>CECSitesAdministrator</code> - Sites Administrator</li></ul>\n<ul><li> Create sites, templates, themes or components</li><li> <code>CECRepositoryAdministrator</code> - Repository Administrator</li><li> <code>CECDeveloperUser</code> - Developer User</li><li> <code>CECContentAdministrator</code> - Content Administrator</li></ul>\n<ul><li> Create new content types and publish items</li><li> <code>CECStandardUser</code> - Standard User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> View and interact with content items in sites</li><li> Manage and view custom properties and edit values</li><li> <code>CECEnterpriseUser</code> - Enterprise User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Digital Assets</li><li> Content Items (editorial content management)</li><li> Create, manage, view, and interact with content items</li><li> Collections</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> Manage and view custom properties and edit values</li><li> <code>CECExternalUser</code> - External User</li></ul>\nReserved for future use.\n<ul><li> <code>CECIntegrationUser</code> - Integration User</li></ul>\nUsed to impersonate another user while performing operations through the Social REST endpoints of the REST API for Collaboration.\n<ul><li> <code>CECSitesVisitor</code> - Sites Visitor</li></ul>\nAccess sites restricted to visitors.\n</p><small>Introduced in release 21.10.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"type":"string"
}
}
}
}
ネストされたスキーマ: links
型: array
このリソースに対する関連リソースおよびアクションへのHATEOSリンク。 リソースの正規表現へのリンクを含む自己リンクを少なくとも1つ含める必要があります。
{
"description":"<p>HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"allOf":[
{
"$ref":"#/definitions/Link"
}
]
}
}
ネストされたスキーマ: items
すべてに一致
ソースを表示
- object 「リンク」
REST HATEOASリンクおよび関連メタデータ。 レスポンスがリンクを提供する場合(リソース自体へのselfリンクなど)、提供されるリンクには、このリンク構造で定義された1つ以上のプロパティが含まれます。
{
"allOf":[
{
"$ref":"#/definitions/Link"
}
]
}
ネストされたスキーマ: Link
型: object
REST HATEOASリンクおよび関連メタデータ。 レスポンスがリンクを提供する場合(リソース自体へのselfリンクなど)、提供されるリンクには、このリンク構造で定義された1つ以上のプロパティが含まれます。
{
"description":"<p>REST HATEOAS link and related metadata. If responses provide links (for example, a <code>self</code> link to the resource itself) the links provided will include one or more of the properties defined on this link structure.</p>",
"properties":{
"rel":{
"description":"<p>Name of the link relation that, in addition to the type property, can be used to retrieve link details.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"href":{
"description":"<p>The target resource URI. URI <em>RFC3986</em> or URI Template <em>RFC6570</em>. If the value is set to URI Template, then the <code>templated</code> property must be set to <code>true</code>.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"templated":{
"description":"<p>Boolean flag that specifies the <code>href</code> property is a URI or URI Template. The property can be assumed to be <code>false</code> if the property is not present.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"mediaType":{
"description":"<p>Media type, as defined by RFC 2046, describing the link target.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"method":{
"description":"<p>HTTP method for requesting the target of the link.</p><p>Valid values are:\n<ul><li> <code>OPTIONS</code> - HTTP OPTIONS</li><li> <code>HEAD</code> - HTTP HEAD</li><li> <code>GET</code> - HTTP GET</li><li> <code>POST</code> - HTTP POST</li><li> <code>PUT</code> - HTTP PUT</li><li> <code>PATCH</code> - HTTP PATCH</li><li> <code>DELETE</code> - HTTP DELETE</li></p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"profile":{
"description":"<p>Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"format":"uri"
}
}
}
ネストされたスキーマ: roles
型: array
ロール
有効な値は次のとおりです。
-
CECServiceAdministrator - サービス管理者
- ユーザー列挙の割当
- ユーザーのパスワードおよびチャレンジ質問の変更
- サービス・インスタンスの構成、モニターおよび管理
-
CECSitesAdministrator - サイト管理者
- サイト、テンプレート、テーマまたはコンポーネントの作成
-
CECRepositoryAdministrator - リポジトリ管理者 -
CECDeveloperUser - 開発者ユーザー -
CECContentAdministrator - コンテンツ管理者
- 新規コンテンツ・タイプの作成およびアイテムの公開
-
CECStandardUser - 標準ユーザー
- コンテンツの管理(ドキュメントの表示、アップロードおよび編集)
- 他のユーザーとのコンテンツおよびサイトの共有
- 会話によるコラボレーション(トピックのディスカッション、他のユーザーへのメッセージの送信、他のユーザーへのフラグの割当て、ドキュメントへの注釈の追加)
- ユーザーのフォロー
- サイトの作成、編集および公開
- サイトのテーマの管理および公開
- カスタム・サイト・コンポーネントの作成、登録、エクスポートおよびインポート
- サイト・テンプレートの作成、編集、エクスポートおよびインポート
- サイト内のコンテンツの表示および操作
- カスタム・プロパティの管理と表示、および値の編集
-
CECEnterpriseUser - エンタープライズ・ユーザー
- コンテンツの管理(ドキュメントの表示、アップロードおよび編集)
- 他のユーザーとのコンテンツおよびサイトの共有
- 会話によるコラボレーション(トピックのディスカッション、他のユーザーへのメッセージの送信、他のユーザーへのフラグの割当て、ドキュメントへの注釈の追加)
- ユーザーのフォロー
- デジタル・アセット
- コンテンツ・アイテム(エディトリアル・コンテンツ管理)
- コンテンツ・アイテムの作成、管理、表示および操作
- コレクション
- サイトの作成、編集および公開
- サイトのテーマの管理および公開
- カスタム・サイト・コンポーネントの作成、登録、エクスポートおよびインポート
- サイト・テンプレートの作成、編集、エクスポートおよびインポート
- カスタム・プロパティの管理と表示、および値の編集
-
CECExternalUser - 外部ユーザー
将来使用するために予約済
-
CECIntegrationUser - 統合ユーザー
Collaboration REST APIのソーシャルRESTエンドポイントを介して操作を実行しながら、別のユーザーを偽装するために使用されます。
-
CECSitesVisitor - サイト・ビジター
サイトへのアクセスはビジターに制限されます。
リリース21.10.2で導入されました。{
"description":"<p>Roles.</p><p>Valid values are:\n<ul><li> <code>CECServiceAdministrator</code> - Service Administrator</li></ul>\n<ul><li> Assign user enumerates</li><li> Change user passwords and challenge questions</li><li> Configure, monitor, and manage service instances</li><li> <code>CECSitesAdministrator</code> - Sites Administrator</li></ul>\n<ul><li> Create sites, templates, themes or components</li><li> <code>CECRepositoryAdministrator</code> - Repository Administrator</li><li> <code>CECDeveloperUser</code> - Developer User</li><li> <code>CECContentAdministrator</code> - Content Administrator</li></ul>\n<ul><li> Create new content types and publish items</li><li> <code>CECStandardUser</code> - Standard User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> View and interact with content items in sites</li><li> Manage and view custom properties and edit values</li><li> <code>CECEnterpriseUser</code> - Enterprise User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Digital Assets</li><li> Content Items (editorial content management)</li><li> Create, manage, view, and interact with content items</li><li> Collections</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> Manage and view custom properties and edit values</li><li> <code>CECExternalUser</code> - External User</li></ul>\nReserved for future use.\n<ul><li> <code>CECIntegrationUser</code> - Integration User</li></ul>\nUsed to impersonate another user while performing operations through the Social REST endpoints of the REST API for Collaboration.\n<ul><li> <code>CECSitesVisitor</code> - Sites Visitor</li></ul>\nAccess sites restricted to visitors.\n</p><small>Introduced in release 21.10.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"type":"string"
}
}
ネストされたスキーマ: items
すべてに一致
ソースを表示
- object 「リンク」
REST HATEOASリンクおよび関連メタデータ。 レスポンスがリンクを提供する場合(リソース自体へのselfリンクなど)、提供されるリンクには、このリンク構造で定義された1つ以上のプロパティが含まれます。
{
"allOf":[
{
"$ref":"#/definitions/Link"
}
]
}
ネストされたスキーマ: Identity
識別子: type
ユーザーまたはクライアント・アプリケーションを表すアイデンティティ。 アイデンティティには、アイデンティティ識別子、一意の名前、表示名などの共通情報が含まれます。
リリース20.3.1で導入されました。すべてに一致
ソースを表示
{
"description":"<p>Identity representing a user or client application. The identity contains the common information such as the identity identifier, unique name and display name.</p><small>Introduced in release 20.3.1.</small>",
"discriminator":"type",
"allOf":[
{
"$ref":"#/definitions/SingularResource"
},
{
"properties":{
"type":{
"description":"<p>Type of <em>Identity</em>. Valid values are: <code>user</code>, <code>service</code>, <code>application</code>, <code>unknown</code>.</p><small>Introduced in release 20.3.1.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default"
],
"type":"string"
},
"id":{
"description":"<p>An identifier value allocated by CEC for the user or client application. The identifier is unique within the scope of the service.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 20.3.1.</small>",
"x-queryable":true,
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"name":{
"description":"<p>Unique name, such as the user name or client application name.</p><small>Introduced in release 20.3.1.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"displayName":{
"description":"<p>Human-readable display name.</p><small>Introduced in release 20.3.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"roles":{
"description":"<p>Roles.</p><p>Valid values are:\n<ul><li> <code>CECServiceAdministrator</code> - Service Administrator</li></ul>\n<ul><li> Assign user enumerates</li><li> Change user passwords and challenge questions</li><li> Configure, monitor, and manage service instances</li><li> <code>CECSitesAdministrator</code> - Sites Administrator</li></ul>\n<ul><li> Create sites, templates, themes or components</li><li> <code>CECRepositoryAdministrator</code> - Repository Administrator</li><li> <code>CECDeveloperUser</code> - Developer User</li><li> <code>CECContentAdministrator</code> - Content Administrator</li></ul>\n<ul><li> Create new content types and publish items</li><li> <code>CECStandardUser</code> - Standard User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> View and interact with content items in sites</li><li> Manage and view custom properties and edit values</li><li> <code>CECEnterpriseUser</code> - Enterprise User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Digital Assets</li><li> Content Items (editorial content management)</li><li> Create, manage, view, and interact with content items</li><li> Collections</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> Manage and view custom properties and edit values</li><li> <code>CECExternalUser</code> - External User</li></ul>\nReserved for future use.\n<ul><li> <code>CECIntegrationUser</code> - Integration User</li></ul>\nUsed to impersonate another user while performing operations through the Social REST endpoints of the REST API for Collaboration.\n<ul><li> <code>CECSitesVisitor</code> - Sites Visitor</li></ul>\nAccess sites restricted to visitors.\n</p><small>Introduced in release 21.10.2.</small>",
"x-returnedIn":[
"representation",
"default"
],
"type":"array",
"items":{
"type":"string"
}
}
}
}
]
}
ネストされたスキーマ : Identity-allOf[1]
型: object
ソースを表示
- displayName(optional): string
人間が判読できる表示名。
リリース20.3.1で導入されました。
- id(optional): string
ユーザーまたはクライアント・アプリケーションに対してCECによって割り当てられる識別子値。 識別子はサービスのスコープ内で一意です。
フィールドの内容は想定しないでください。フィールドはopaque値として扱われる必要があります。
リリース20.3.1で導入されました。
- name(optional): string
ユーザー名やクライアント・アプリケーション名などの一意の名前。
リリース20.3.1で導入されました。
- roles(optional): array roles
ロール
有効な値は次のとおりです。
-
CECServiceAdministrator - サービス管理者
- ユーザー列挙の割当
- ユーザーのパスワードおよびチャレンジ質問の変更
- サービス・インスタンスの構成、モニターおよび管理
-
CECSitesAdministrator - サイト管理者
- サイト、テンプレート、テーマまたはコンポーネントの作成
-
CECRepositoryAdministrator - リポジトリ管理者 -
CECDeveloperUser - 開発者ユーザー -
CECContentAdministrator - コンテンツ管理者
- 新規コンテンツ・タイプの作成およびアイテムの公開
-
CECStandardUser - 標準ユーザー
- コンテンツの管理(ドキュメントの表示、アップロードおよび編集)
- 他のユーザーとのコンテンツおよびサイトの共有
- 会話によるコラボレーション(トピックのディスカッション、他のユーザーへのメッセージの送信、他のユーザーへのフラグの割当て、ドキュメントへの注釈の追加)
- ユーザーのフォロー
- サイトの作成、編集および公開
- サイトのテーマの管理および公開
- カスタム・サイト・コンポーネントの作成、登録、エクスポートおよびインポート
- サイト・テンプレートの作成、編集、エクスポートおよびインポート
- サイト内のコンテンツの表示および操作
- カスタム・プロパティの管理と表示、および値の編集
-
CECEnterpriseUser - エンタープライズ・ユーザー
- コンテンツの管理(ドキュメントの表示、アップロードおよび編集)
- 他のユーザーとのコンテンツおよびサイトの共有
- 会話によるコラボレーション(トピックのディスカッション、他のユーザーへのメッセージの送信、他のユーザーへのフラグの割当て、ドキュメントへの注釈の追加)
- ユーザーのフォロー
- デジタル・アセット
- コンテンツ・アイテム(エディトリアル・コンテンツ管理)
- コンテンツ・アイテムの作成、管理、表示および操作
- コレクション
- サイトの作成、編集および公開
- サイトのテーマの管理および公開
- カスタム・サイト・コンポーネントの作成、登録、エクスポートおよびインポート
- サイト・テンプレートの作成、編集、エクスポートおよびインポート
- カスタム・プロパティの管理と表示、および値の編集
-
CECExternalUser - 外部ユーザー
将来使用するために予約済
-
CECIntegrationUser - 統合ユーザー
Collaboration REST APIのソーシャルRESTエンドポイントを介して操作を実行しながら、別のユーザーを偽装するために使用されます。
-
CECSitesVisitor - サイト・ビジター
サイトへのアクセスはビジターに制限されます。
リリース21.10.2で導入されました。
- type(optional): string
「アイデンティティ」のタイプ。 有効な値は次のとおりです: user, service, application, unknown。
リリース20.3.1で導入されました。
{
"properties":{
"type":{
"description":"<p>Type of <em>Identity</em>. Valid values are: <code>user</code>, <code>service</code>, <code>application</code>, <code>unknown</code>.</p><small>Introduced in release 20.3.1.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default"
],
"type":"string"
},
"id":{
"description":"<p>An identifier value allocated by CEC for the user or client application. The identifier is unique within the scope of the service.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 20.3.1.</small>",
"x-queryable":true,
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"name":{
"description":"<p>Unique name, such as the user name or client application name.</p><small>Introduced in release 20.3.1.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"displayName":{
"description":"<p>Human-readable display name.</p><small>Introduced in release 20.3.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"roles":{
"description":"<p>Roles.</p><p>Valid values are:\n<ul><li> <code>CECServiceAdministrator</code> - Service Administrator</li></ul>\n<ul><li> Assign user enumerates</li><li> Change user passwords and challenge questions</li><li> Configure, monitor, and manage service instances</li><li> <code>CECSitesAdministrator</code> - Sites Administrator</li></ul>\n<ul><li> Create sites, templates, themes or components</li><li> <code>CECRepositoryAdministrator</code> - Repository Administrator</li><li> <code>CECDeveloperUser</code> - Developer User</li><li> <code>CECContentAdministrator</code> - Content Administrator</li></ul>\n<ul><li> Create new content types and publish items</li><li> <code>CECStandardUser</code> - Standard User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> View and interact with content items in sites</li><li> Manage and view custom properties and edit values</li><li> <code>CECEnterpriseUser</code> - Enterprise User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Digital Assets</li><li> Content Items (editorial content management)</li><li> Create, manage, view, and interact with content items</li><li> Collections</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> Manage and view custom properties and edit values</li><li> <code>CECExternalUser</code> - External User</li></ul>\nReserved for future use.\n<ul><li> <code>CECIntegrationUser</code> - Integration User</li></ul>\nUsed to impersonate another user while performing operations through the Social REST endpoints of the REST API for Collaboration.\n<ul><li> <code>CECSitesVisitor</code> - Sites Visitor</li></ul>\nAccess sites restricted to visitors.\n</p><small>Introduced in release 21.10.2.</small>",
"x-returnedIn":[
"representation",
"default"
],
"type":"array",
"items":{
"type":"string"
}
}
}
}
ネストされたスキーマ: roles
型: array
ロール
有効な値は次のとおりです。
-
CECServiceAdministrator - サービス管理者
- ユーザー列挙の割当
- ユーザーのパスワードおよびチャレンジ質問の変更
- サービス・インスタンスの構成、モニターおよび管理
-
CECSitesAdministrator - サイト管理者
- サイト、テンプレート、テーマまたはコンポーネントの作成
-
CECRepositoryAdministrator - リポジトリ管理者 -
CECDeveloperUser - 開発者ユーザー -
CECContentAdministrator - コンテンツ管理者
- 新規コンテンツ・タイプの作成およびアイテムの公開
-
CECStandardUser - 標準ユーザー
- コンテンツの管理(ドキュメントの表示、アップロードおよび編集)
- 他のユーザーとのコンテンツおよびサイトの共有
- 会話によるコラボレーション(トピックのディスカッション、他のユーザーへのメッセージの送信、他のユーザーへのフラグの割当て、ドキュメントへの注釈の追加)
- ユーザーのフォロー
- サイトの作成、編集および公開
- サイトのテーマの管理および公開
- カスタム・サイト・コンポーネントの作成、登録、エクスポートおよびインポート
- サイト・テンプレートの作成、編集、エクスポートおよびインポート
- サイト内のコンテンツの表示および操作
- カスタム・プロパティの管理と表示、および値の編集
-
CECEnterpriseUser - エンタープライズ・ユーザー
- コンテンツの管理(ドキュメントの表示、アップロードおよび編集)
- 他のユーザーとのコンテンツおよびサイトの共有
- 会話によるコラボレーション(トピックのディスカッション、他のユーザーへのメッセージの送信、他のユーザーへのフラグの割当て、ドキュメントへの注釈の追加)
- ユーザーのフォロー
- デジタル・アセット
- コンテンツ・アイテム(エディトリアル・コンテンツ管理)
- コンテンツ・アイテムの作成、管理、表示および操作
- コレクション
- サイトの作成、編集および公開
- サイトのテーマの管理および公開
- カスタム・サイト・コンポーネントの作成、登録、エクスポートおよびインポート
- サイト・テンプレートの作成、編集、エクスポートおよびインポート
- カスタム・プロパティの管理と表示、および値の編集
-
CECExternalUser - 外部ユーザー
将来使用するために予約済
-
CECIntegrationUser - 統合ユーザー
Collaboration REST APIのソーシャルRESTエンドポイントを介して操作を実行しながら、別のユーザーを偽装するために使用されます。
-
CECSitesVisitor - サイト・ビジター
サイトへのアクセスはビジターに制限されます。
リリース21.10.2で導入されました。{
"description":"<p>Roles.</p><p>Valid values are:\n<ul><li> <code>CECServiceAdministrator</code> - Service Administrator</li></ul>\n<ul><li> Assign user enumerates</li><li> Change user passwords and challenge questions</li><li> Configure, monitor, and manage service instances</li><li> <code>CECSitesAdministrator</code> - Sites Administrator</li></ul>\n<ul><li> Create sites, templates, themes or components</li><li> <code>CECRepositoryAdministrator</code> - Repository Administrator</li><li> <code>CECDeveloperUser</code> - Developer User</li><li> <code>CECContentAdministrator</code> - Content Administrator</li></ul>\n<ul><li> Create new content types and publish items</li><li> <code>CECStandardUser</code> - Standard User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> View and interact with content items in sites</li><li> Manage and view custom properties and edit values</li><li> <code>CECEnterpriseUser</code> - Enterprise User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Digital Assets</li><li> Content Items (editorial content management)</li><li> Create, manage, view, and interact with content items</li><li> Collections</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> Manage and view custom properties and edit values</li><li> <code>CECExternalUser</code> - External User</li></ul>\nReserved for future use.\n<ul><li> <code>CECIntegrationUser</code> - Integration User</li></ul>\nUsed to impersonate another user while performing operations through the Social REST endpoints of the REST API for Collaboration.\n<ul><li> <code>CECSitesVisitor</code> - Sites Visitor</li></ul>\nAccess sites restricted to visitors.\n</p><small>Introduced in release 21.10.2.</small>",
"x-returnedIn":[
"representation",
"default"
],
"type":"array",
"items":{
"type":"string"
}
}