ルート・スキーマ: schema
すべてに一致
ソースを表示
- allOf Policy
ポリシーは、サイト関連の操作を実行するリクエストの承認方法と、その操作を実行する際に適用する特定の制限またはデフォルトがあるかどうかを制御します。
ポリシーはリソースに関連付けられています。たとえば、「サイト作成」ポリシーはサイト・テンプレートに関連付けることができます。 たとえば、サイト作成ポリシーでは、サイト管理者の承認が特定のサイト・テンプレートからのサイトの作成に必要であり、そのサイト・テンプレートのドメイン・ユーザーのセキュリティ・レベルのみが割り当てられることを指定できます。
ポリシーはinactiveとしてマークできます。これにより、操作の実行またはリクエストを防止できます。
{
"allOf":[
{
"$ref":"#/definitions/Policy"
}
]
}
ネストされたスキーマ: Policy
ポリシーは、サイト関連の操作を実行するリクエストの承認方法と、その操作を実行する際に適用する特定の制限またはデフォルトがあるかどうかを制御します。
ポリシーはリソースに関連付けられています。たとえば、「サイト作成」ポリシーはサイト・テンプレートに関連付けることができます。 たとえば、サイト作成ポリシーでは、サイト管理者の承認が特定のサイト・テンプレートからのサイトの作成に必要であり、そのサイト・テンプレートのドメイン・ユーザーのセキュリティ・レベルのみが割り当てられることを指定できます。
ポリシーはinactiveとしてマークできます。これにより、操作の実行またはリクエストを防止できます。
すべてに一致
ソースを表示
{
"description":"<p>A policy controls how a request to perform a site-related operation is approved and whether there are any particular restrictions or defaults to apply when that operation is performed.</p><p>A policy is associated with a resource, for example a <em>site creation</em> policy can be associated with a site template. A site creation policy, for example, could specify that site administrator approval is required to create a site from a particular site template and that site template has a security level of domain users only.</p><p>A policy can be marked as <em>inactive</em> which prevents the operation from being performed or requested.</p>",
"allOf":[
{
"$ref":"#/definitions/SingularResource"
},
{
"properties":{
"id":{
"description":"<p>Globally unique identifier for a policy.</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>",
"x-queryable":true,
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"minimal",
"basic"
],
"type":"string"
},
"status":{
"description":"<p>The policy status specifies whether the policy can be used to perform the operation associated with the policy. If the policy status is <em>inactive</em> then the operation cannot be performed. If the policy status is <em>active</em> then the operation can be performed. For example, for a policy associated with a site template, a status of <em>active</em> means that users can create sites from that site template.</p><p>Valid values are:\n<ul><li> <code>inactive</code> - Policy that is marked as inactive means the associated operation <strong>cannot</strong> be requested</li><li> <code>active</code> - Policy that is marked as active means the associated operation <strong>can</strong> be requested</li></p>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default"
],
"type":"string"
},
"approvalType":{
"description":"<p>When a request is made that is associated with this policy, the request will require the type of approval defined by the policy. If the type of approval is automatic then the request will not require manual approval.</p><p>Valid values are:\n<ul><li> <code>automatic</code> - A request will automatically be approved without any human approval process involved</li><li> <code>admin</code> - Any user with the <strong>site administrator</strong> role can approve the associated request</li><li> <code>named</code> - Site creation will require approval from one user that is a member of the approvers list associated with the policy</li></p>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default"
],
"type":"string"
},
"approvers":{
"description":"<p>List of users and groups who have the ability to approve any request associated with the policy. For example, the list of users and groups who can approve creating a site from a template. The approval list is only used if the approval type is set to <em>named approvers</em>.</p><small>Introduced in release 19.3.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default"
],
"x-expandedIn":[
"representation"
],
"type":"object",
"allOf":[
{
"$ref":"#/definitions/CollectionResource"
}
],
"properties":{
"items":{
"description":"<p>Collection of <em>Policy Approvers Member</em> elements.</p><small>Introduced in release 19.3.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"array",
"items":{
"type":"object",
"properties":{
"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.3.3.</small>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"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.3.3.</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.3.3.</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.3.3.</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.3.3.</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.3.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Group"
}
]
}
},
"required":[
"id",
"type",
"name"
]
}
}
},
"required":[
"items"
]
},
"accessType":{
"description":"<p>Determines whether the policy is applicable to everyone, or to just the users that are part of the access list.</p><p>Valid values are:\n<ul><li> <code>everyone</code> - Policy, when active, is applicable to everyone</li><li> <code>restricted</code> - Policy, when active, is applicable to users that are part of the access list</li></p><small>Introduced in release 19.3.1.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default"
],
"type":"string"
},
"access":{
"description":"<p>List of users and groups who have the ability to perform the operation associated with the policy. For example, the list of users and groups who can create a site from a template. If the access list is empty all users can perform the policy operation. The access list is only used if the <code>accessType</code> of the policy is set to <code>restricted</code>.</p><small>Introduced in release 19.3.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default"
],
"x-expandedIn":[
"representation"
],
"type":"object",
"allOf":[
{
"$ref":"#/definitions/CollectionResource"
}
],
"properties":{
"items":{
"description":"<p>Collection of <em>Policy Access Member</em> elements.</p><small>Introduced in release 19.3.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"array",
"items":{
"type":"object",
"properties":{
"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.3.1.</small>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"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.3.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.3.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.3.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.3.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.3.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Group"
}
]
}
},
"required":[
"id",
"type",
"name"
]
}
}
},
"required":[
"items"
]
},
"security":{
"description":"<p>Security policy for site creation policies. The security policy specifies the minimum level of security a site can have.</p>",
"x-returnedIn":[
"representation",
"default"
],
"allOf":[
{
"$ref":"#/definitions/SecurityPolicy"
}
]
},
"repository":{
"description":"<p>When a policy is created, or edited, the policy can be associated with an asset repository. When a new site is requested, the site will be associated with the policy-defined asset repository. The user cannot specify a repository when creating a new a site if the repository is set on the policy. If there is no asset repository associated with the policy, then an asset repository can be specified when the user creates a new site. An asset repository can be only associated with a policy if the policy is associated with an enterprise template. Standard sites do not get associated with an asset repository.</p><small>Introduced in release 19.2.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Repository"
}
]
},
"localizationPolicyAllowed":{
"description":"<p>If a localization policy is not allowed, then the requester will not be permitted to specify a localization policy at the time of requesting a site. The localization policy associated with the template will be used. If a localization policy is allowed, then the requester must specify one at the time of requesting a site. This property can be set only when the template associated with the policy is an enterprise templates.</p><small>Introduced in release 19.2.3.</small>",
"x-returnedIn":[
"representation",
"default"
],
"type":"boolean"
},
"sitePrefixAllowed":{
"description":"<p>If <code>true</code>, a request for a new site can include an explicit site prefix. If <code>false</code>, then a site prefix must not be provided and will be generated automatically. This property can be set only when the template associated with the policy is an enterprise templates.</p><small>Introduced in release 19.2.3.</small>",
"x-returnedIn":[
"representation",
"default"
],
"type":"boolean"
},
"expiration":{
"description":"<p>When a site is created an expiration date can be set on the site if the policy associated with the site template has a site expiration period set. When a site has expired the site cannot be activated unless the expiration period is extended.</p><small>Introduced in release 19.4.1.</small>",
"x-returnedIn":[
"representation",
"default"
],
"allOf":[
{
"$ref":"#/definitions/SiteExpirationPeriod"
}
]
},
"revision":{
"description":"<p>Every time a policy is edited, the revision number is incremented. Revision numbers start at zero. The revision number can be used to see if a policy has changed since it was last requested as the revision is also used as the strong <code>ETag</code> value for this resource.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"integer",
"format":"int64"
}
}
}
]
}
ネストされたスキーマ : 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"
}
]
}
}
}
}
ネストされたスキーマ : Policy-allOf[1]
型: object
ソースを表示
- access(optional): object access
ポリシーに関連付けられた操作を実行できるユーザーおよびグループのリスト。 たとえば、テンプレートからサイトを作成できるユーザーおよびグループのリストです。 アクセス・リストが空の場合、すべてのユーザーがポリシー操作を実行できます。 アクセス・リストは、ポリシーのaccessType
がrestricted
に設定されている場合にのみ使用されます。
リリース19.3.1.での導入。
- accessType(optional): string
ポリシーをすべてのユーザーに適用するか、アクセス・リストに含まれるユーザーにのみ適用するかを決定します。
有効な値は次のとおりです。
-
everyone
- ポリシー(アクティブな場合)は全員に適用されます -
restricted
- ポリシーは、アクティブな場合、アクセス・リストに含まれるユーザーに適用可能です
リリース19.3.1.での導入。
- approvalType(optional): string
このポリシーに関連付けられたリクエストが作成される場合、そのリクエストにはポリシーで定義された承認のタイプが必要です。 承認のタイプが自動の場合、リクエストには手動での承認は必要ありません。
有効な値は次のとおりです。
-
automatic
- リクエストは、ユーザーの承認プロセスなしで自動的に承認されます -
admin
- 「サイト管理者」のロールを持つユーザーは、関連するリクエストを承認できます。 -
named
- サイトの作成では、ポリシーに関連付けられた承認者リストのメンバーであるユーザーの承認が必要です
- approvers(optional): object approvers
ポリシーに関連付けられたリクエストを承認する権限を持つユーザーおよびグループのリスト。 たとえば、テンプレートからのサイトの作成を承認できるユーザーおよびグループのリストです。 承認リストは、承認タイプが「指定された承認者」に設定されている場合にのみ使用されます。
リリース19.3.3.での導入。
- expiration(optional): 有効期限
サイトが作成されたとき、サイト・テンプレートに関連付けられたポリシーにサイト有効期限が設定されている場合、有効期限をサイトに設定できます。 サイトの有効期限が切れている場合、有効期限が延長されないかぎりサイトをアクティブ化できません。
リリース19.4.1.での導入。
- id(optional): string
ポリシーのグローバル一意識別子。
フィールドの内容は想定しないでください。フィールドはopaque値として扱われる必要があります。
- localizationPolicyAllowed(optional): boolean
ローカリゼーション・ポリシーが許可されていない場合、リクエスタはサイトのリクエスト時にローカリゼーション・ポリシーの指定を許可されません。 テンプレートに関連付けられているローカリゼーション・ポリシーが使用されます。 ローカリゼーション・ポリシーが許可されている場合、リクエスタはサイトのリクエスト時に1つ指定する必要があります。 このプロパティは、ポリシーに関連付けられているテンプレートがエンタープライズ・テンプレートの場合にのみ設定できます。
リリース19.2.3.での導入。
- repository(optional): repository
ポリシーを作成または編集する場合、そのポリシーをアセット・リポジトリに関連付けることができます。 新規サイトがリクエストされると、サイトはポリシー定義済アセット・リポジトリに関連付けられます。 リポジトリがポリシーに設定されている場合、ユーザーは新規サイトの作成時にリポジトリを指定できません。 ポリシーに関連付けられたアセット・リポジトリがない場合、ユーザーが新規サイトを作成するときにアセット・リポジトリを指定できます。 アセット・リポジトリは、ポリシーがエンタープライズ・テンプレートに関連付けられている場合にのみポリシーに関連付けることができます。 Standardサイトはアセット・リポジトリに関連付けられません。
リリース19.2.3.での導入。
- revision(optional): integer(int64)
ポリシーが編集されるたびに、リビジョン番号が増分されます。 改訂番号はゼロから開始します。 リビジョン番号は、リビジョンがこのリソースの強力なETag
値としても使用されるため、最後のリクエスト以降にポリシーが変更されたかどうかを確認するために使用できます。
- security(optional): security
サイト作成ポリシーのセキュリティ・ポリシー。 セキュリティ・ポリシーでは、サイトに許可される最小限のセキュリティ・レベルを指定します。
- sitePrefixAllowed(optional): boolean
true
の場合、新規サイトに対するリクエストには、明示的なサイト・プレフィクスを含めることができます。 false
の場合、サイト・プレフィクスを指定しないと、自動的に生成されます。 このプロパティは、ポリシーに関連付けられているテンプレートがエンタープライズ・テンプレートの場合にのみ設定できます。
リリース19.2.3.での導入。
- status(optional): string
ポリシー・ステータスは、ポリシーに関連付けられた操作の実行にポリシーを使用できるかどうかを指定します。 ポリシー・ステータスがinactiveの場合、操作は実行できません。 ポリシー・ステータスが「アクティブ」の場合は、操作を実行できます。 たとえば、サイト・テンプレートに関連付けられたポリシーの場合、「アクティブ」のステータスは、ユーザーがサイト・テンプレートからサイトを作成できることを意味します。
有効な値は次のとおりです。
-
inactive
- 非アクティブとしてマークされているポリシーは、関連する操作をリクエストできないことを意味 -
active
- アクティブとしてマークされているポリシーは、関連する操作がリクエスト可能であることを意味
{
"properties":{
"id":{
"description":"<p>Globally unique identifier for a policy.</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>",
"x-queryable":true,
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"minimal",
"basic"
],
"type":"string"
},
"status":{
"description":"<p>The policy status specifies whether the policy can be used to perform the operation associated with the policy. If the policy status is <em>inactive</em> then the operation cannot be performed. If the policy status is <em>active</em> then the operation can be performed. For example, for a policy associated with a site template, a status of <em>active</em> means that users can create sites from that site template.</p><p>Valid values are:\n<ul><li> <code>inactive</code> - Policy that is marked as inactive means the associated operation <strong>cannot</strong> be requested</li><li> <code>active</code> - Policy that is marked as active means the associated operation <strong>can</strong> be requested</li></p>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default"
],
"type":"string"
},
"approvalType":{
"description":"<p>When a request is made that is associated with this policy, the request will require the type of approval defined by the policy. If the type of approval is automatic then the request will not require manual approval.</p><p>Valid values are:\n<ul><li> <code>automatic</code> - A request will automatically be approved without any human approval process involved</li><li> <code>admin</code> - Any user with the <strong>site administrator</strong> role can approve the associated request</li><li> <code>named</code> - Site creation will require approval from one user that is a member of the approvers list associated with the policy</li></p>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default"
],
"type":"string"
},
"approvers":{
"description":"<p>List of users and groups who have the ability to approve any request associated with the policy. For example, the list of users and groups who can approve creating a site from a template. The approval list is only used if the approval type is set to <em>named approvers</em>.</p><small>Introduced in release 19.3.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default"
],
"x-expandedIn":[
"representation"
],
"type":"object",
"allOf":[
{
"$ref":"#/definitions/CollectionResource"
}
],
"properties":{
"items":{
"description":"<p>Collection of <em>Policy Approvers Member</em> elements.</p><small>Introduced in release 19.3.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"array",
"items":{
"type":"object",
"properties":{
"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.3.3.</small>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"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.3.3.</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.3.3.</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.3.3.</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.3.3.</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.3.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Group"
}
]
}
},
"required":[
"id",
"type",
"name"
]
}
}
},
"required":[
"items"
]
},
"accessType":{
"description":"<p>Determines whether the policy is applicable to everyone, or to just the users that are part of the access list.</p><p>Valid values are:\n<ul><li> <code>everyone</code> - Policy, when active, is applicable to everyone</li><li> <code>restricted</code> - Policy, when active, is applicable to users that are part of the access list</li></p><small>Introduced in release 19.3.1.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default"
],
"type":"string"
},
"access":{
"description":"<p>List of users and groups who have the ability to perform the operation associated with the policy. For example, the list of users and groups who can create a site from a template. If the access list is empty all users can perform the policy operation. The access list is only used if the <code>accessType</code> of the policy is set to <code>restricted</code>.</p><small>Introduced in release 19.3.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default"
],
"x-expandedIn":[
"representation"
],
"type":"object",
"allOf":[
{
"$ref":"#/definitions/CollectionResource"
}
],
"properties":{
"items":{
"description":"<p>Collection of <em>Policy Access Member</em> elements.</p><small>Introduced in release 19.3.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"array",
"items":{
"type":"object",
"properties":{
"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.3.1.</small>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"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.3.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.3.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.3.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.3.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.3.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Group"
}
]
}
},
"required":[
"id",
"type",
"name"
]
}
}
},
"required":[
"items"
]
},
"security":{
"description":"<p>Security policy for site creation policies. The security policy specifies the minimum level of security a site can have.</p>",
"x-returnedIn":[
"representation",
"default"
],
"allOf":[
{
"$ref":"#/definitions/SecurityPolicy"
}
]
},
"repository":{
"description":"<p>When a policy is created, or edited, the policy can be associated with an asset repository. When a new site is requested, the site will be associated with the policy-defined asset repository. The user cannot specify a repository when creating a new a site if the repository is set on the policy. If there is no asset repository associated with the policy, then an asset repository can be specified when the user creates a new site. An asset repository can be only associated with a policy if the policy is associated with an enterprise template. Standard sites do not get associated with an asset repository.</p><small>Introduced in release 19.2.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Repository"
}
]
},
"localizationPolicyAllowed":{
"description":"<p>If a localization policy is not allowed, then the requester will not be permitted to specify a localization policy at the time of requesting a site. The localization policy associated with the template will be used. If a localization policy is allowed, then the requester must specify one at the time of requesting a site. This property can be set only when the template associated with the policy is an enterprise templates.</p><small>Introduced in release 19.2.3.</small>",
"x-returnedIn":[
"representation",
"default"
],
"type":"boolean"
},
"sitePrefixAllowed":{
"description":"<p>If <code>true</code>, a request for a new site can include an explicit site prefix. If <code>false</code>, then a site prefix must not be provided and will be generated automatically. This property can be set only when the template associated with the policy is an enterprise templates.</p><small>Introduced in release 19.2.3.</small>",
"x-returnedIn":[
"representation",
"default"
],
"type":"boolean"
},
"expiration":{
"description":"<p>When a site is created an expiration date can be set on the site if the policy associated with the site template has a site expiration period set. When a site has expired the site cannot be activated unless the expiration period is extended.</p><small>Introduced in release 19.4.1.</small>",
"x-returnedIn":[
"representation",
"default"
],
"allOf":[
{
"$ref":"#/definitions/SiteExpirationPeriod"
}
]
},
"revision":{
"description":"<p>Every time a policy is edited, the revision number is incremented. Revision numbers start at zero. The revision number can be used to see if a policy has changed since it was last requested as the revision is also used as the strong <code>ETag</code> value for this resource.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"integer",
"format":"int64"
}
}
}
ネストされたスキーマ: 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"
}
}
}
ネストされたスキーマ : アクセス
型: object
ポリシーに関連付けられた操作を実行できるユーザーおよびグループのリスト。 たとえば、テンプレートからサイトを作成できるユーザーおよびグループのリストです。 アクセス・リストが空の場合、すべてのユーザーがポリシー操作を実行できます。 アクセス・リストは、ポリシーのaccessType
がrestricted
に設定されている場合にのみ使用されます。
リリース19.3.1.での導入。
ソースを表示
{
"description":"<p>List of users and groups who have the ability to perform the operation associated with the policy. For example, the list of users and groups who can create a site from a template. If the access list is empty all users can perform the policy operation. The access list is only used if the <code>accessType</code> of the policy is set to <code>restricted</code>.</p><small>Introduced in release 19.3.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default"
],
"x-expandedIn":[
"representation"
],
"type":"object",
"allOf":[
{
"$ref":"#/definitions/CollectionResource"
}
],
"properties":{
"items":{
"description":"<p>Collection of <em>Policy Access Member</em> elements.</p><small>Introduced in release 19.3.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"array",
"items":{
"type":"object",
"properties":{
"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.3.1.</small>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"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.3.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.3.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.3.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.3.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.3.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Group"
}
]
}
},
"required":[
"id",
"type",
"name"
]
}
}
},
"required":[
"items"
]
}
すべてに一致
ソースを表示
- allOf CollectionResource
REST APIによって返されるすべてのコレクションは、標準のコレクション定義を拡張します。 この定義では、品目の合計数、返される品目のオフセットおよび制限の詳細、品目の数、および使用可能な品目が他にもあるかどうかを示すインジケータに関する情報を提供します。
{
"description":"<p>List of users and groups who have the ability to perform the operation associated with the policy. For example, the list of users and groups who can create a site from a template. If the access list is empty all users can perform the policy operation. The access list is only used if the <code>accessType</code> of the policy is set to <code>restricted</code>.</p><small>Introduced in release 19.3.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default"
],
"x-expandedIn":[
"representation"
],
"type":"object",
"allOf":[
{
"$ref":"#/definitions/CollectionResource"
}
],
"properties":{
"items":{
"description":"<p>Collection of <em>Policy Access Member</em> elements.</p><small>Introduced in release 19.3.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"array",
"items":{
"type":"object",
"properties":{
"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.3.1.</small>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"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.3.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.3.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.3.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.3.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.3.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Group"
}
]
}
},
"required":[
"id",
"type",
"name"
]
}
}
},
"required":[
"items"
]
}
ネストされたスキーマ : 承認者
型: object
ポリシーに関連付けられたリクエストを承認する権限を持つユーザーおよびグループのリスト。 たとえば、テンプレートからのサイトの作成を承認できるユーザーおよびグループのリストです。 承認リストは、承認タイプが「指定された承認者」に設定されている場合にのみ使用されます。
リリース19.3.3.での導入。
ソースを表示
{
"description":"<p>List of users and groups who have the ability to approve any request associated with the policy. For example, the list of users and groups who can approve creating a site from a template. The approval list is only used if the approval type is set to <em>named approvers</em>.</p><small>Introduced in release 19.3.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default"
],
"x-expandedIn":[
"representation"
],
"type":"object",
"allOf":[
{
"$ref":"#/definitions/CollectionResource"
}
],
"properties":{
"items":{
"description":"<p>Collection of <em>Policy Approvers Member</em> elements.</p><small>Introduced in release 19.3.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"array",
"items":{
"type":"object",
"properties":{
"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.3.3.</small>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"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.3.3.</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.3.3.</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.3.3.</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.3.3.</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.3.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Group"
}
]
}
},
"required":[
"id",
"type",
"name"
]
}
}
},
"required":[
"items"
]
}
すべてに一致
ソースを表示
- allOf CollectionResource
REST APIによって返されるすべてのコレクションは、標準のコレクション定義を拡張します。 この定義では、品目の合計数、返される品目のオフセットおよび制限の詳細、品目の数、および使用可能な品目が他にもあるかどうかを示すインジケータに関する情報を提供します。
{
"description":"<p>List of users and groups who have the ability to approve any request associated with the policy. For example, the list of users and groups who can approve creating a site from a template. The approval list is only used if the approval type is set to <em>named approvers</em>.</p><small>Introduced in release 19.3.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default"
],
"x-expandedIn":[
"representation"
],
"type":"object",
"allOf":[
{
"$ref":"#/definitions/CollectionResource"
}
],
"properties":{
"items":{
"description":"<p>Collection of <em>Policy Approvers Member</em> elements.</p><small>Introduced in release 19.3.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"array",
"items":{
"type":"object",
"properties":{
"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.3.3.</small>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"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.3.3.</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.3.3.</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.3.3.</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.3.3.</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.3.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Group"
}
]
}
},
"required":[
"id",
"type",
"name"
]
}
}
},
"required":[
"items"
]
}
ネストされたスキーマ : 有効期限
サイトが作成されたとき、サイト・テンプレートに関連付けられたポリシーにサイト有効期限が設定されている場合、有効期限をサイトに設定できます。 サイトの有効期限が切れている場合、有効期限が延長されないかぎりサイトをアクティブ化できません。
リリース19.4.1.での導入。
すべてに一致
ソースを表示
{
"description":"<p>When a site is created an expiration date can be set on the site if the policy associated with the site template has a site expiration period set. When a site has expired the site cannot be activated unless the expiration period is extended.</p><small>Introduced in release 19.4.1.</small>",
"x-returnedIn":[
"representation",
"default"
],
"allOf":[
{
"$ref":"#/definitions/SiteExpirationPeriod"
}
]
}
ネストされたスキーマ : repository
ポリシーを作成または編集する場合、そのポリシーをアセット・リポジトリに関連付けることができます。 新規サイトがリクエストされると、サイトはポリシー定義済アセット・リポジトリに関連付けられます。 リポジトリがポリシーに設定されている場合、ユーザーは新規サイトの作成時にリポジトリを指定できません。 ポリシーに関連付けられたアセット・リポジトリがない場合、ユーザーが新規サイトを作成するときにアセット・リポジトリを指定できます。 アセット・リポジトリは、ポリシーがエンタープライズ・テンプレートに関連付けられている場合にのみポリシーに関連付けることができます。 Standardサイトはアセット・リポジトリに関連付けられません。
リリース19.2.3.での導入。
すべてに一致
ソースを表示
- allOf Repository
リポジトリは、テキストとイメージの両方のファイルのストレージ・ロケーションです。 リポジトリ管理者は、リポジトリに対して指定されたチャネル・ポリシーおよびローカリゼーション・ポリシーを使用してリポジトリを作成できます。 様々なマーケティング・ニーズに対応するために、複数のリポジトリを作成できます。
リポジトリを使用すると、必要なすべてのアセットを1箇所で管理できます。 たとえば、会社でコンピュータ機器を販売するとします。 デスクトップ・コンピュータに関連するファイルを処理するために、1つのリポジトリを設定できます。 タブレットには別のリポジトリを使用できます。 各リポジトリには、様々な種類のコンピュータに関する写真、グラフィックおよびコンテンツを含めることができます。 各リポジトリのアセットは、リポジトリに割り当てるポリシーによって制御されます。
{
"description":"<p>When a policy is created, or edited, the policy can be associated with an asset repository. When a new site is requested, the site will be associated with the policy-defined asset repository. The user cannot specify a repository when creating a new a site if the repository is set on the policy. If there is no asset repository associated with the policy, then an asset repository can be specified when the user creates a new site. An asset repository can be only associated with a policy if the policy is associated with an enterprise template. Standard sites do not get associated with an asset repository.</p><small>Introduced in release 19.2.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Repository"
}
]
}
ネストされたスキーマ: security
サイト作成ポリシーのセキュリティ・ポリシー。 セキュリティ・ポリシーでは、サイトに許可される最小限のセキュリティ・レベルを指定します。
すべてに一致
ソースを表示
- object SecurityPolicy
セキュリティ・ポリシーでは、サイトに許可されるセキュリティ・レベルの最小レベルを指定します。 サイトはこの最小レベルで作成されます。サイト・マネージャ/所有者は必要に応じてサイトでより制限的なセキュリティ・レベルを設定できます。 マネージャ/所有者は、サイト・セキュリティ・ポリシーで指定された値よりも安全性が低いセキュリティ・レベルは選択できません。
{
"description":"<p>Security policy for site creation policies. The security policy specifies the minimum level of security a site can have.</p>",
"x-returnedIn":[
"representation",
"default"
],
"allOf":[
{
"$ref":"#/definitions/SecurityPolicy"
}
]
}
ネストされたスキーマ: items
型: array
「ポリシー・アクセス・メンバー」要素のコレクション。
リリース19.3.1.での導入。
ソースを表示
{
"description":"<p>Collection of <em>Policy Access Member</em> elements.</p><small>Introduced in release 19.3.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"array",
"items":{
"type":"object",
"properties":{
"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.3.1.</small>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"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.3.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.3.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.3.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.3.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.3.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Group"
}
]
}
},
"required":[
"id",
"type",
"name"
]
}
}
ネストされたスキーマ : CollectionResource
REST APIによって返されるすべてのコレクションは、標準のコレクション定義を拡張します。 この定義では、品目の合計数、返される品目のオフセットおよび制限の詳細、品目の数、および使用可能な品目が他にもあるかどうかを示すインジケータに関する情報を提供します。
すべてに一致
ソースを表示
{
"description":"<p>All collections returned by REST APIs extend the standard collection definition. The definition provides information about the total number of items, the offset and limit details for the items returned, the number of items and an indicator to whether there are more items available.</p>",
"allOf":[
{
"$ref":"#/definitions/SingularResource"
},
{
"properties":{
"totalResults":{
"description":"<p>Total number of resources that match the request. If provided, this is the total number of available items. If not specified the total is not known, or is not viable to return. Paging limits or offsets are ignored when calculating this value. Only returned if the <code>totalResults</code> parameter is supported and is set to <code>true</code> by the client.</p>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"integer",
"format":"int64"
},
"limit":{
"description":"<p>Actual response size limit used. If the request specifies too large a limit, or does not specify a limit then the response will specify the limit used.</p>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"integer",
"format":"int32"
},
"count":{
"description":"<p>Total number of resources in the response.</p>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"integer",
"format":"int32"
},
"hasMore":{
"description":"<p>Collection has more elements that match the request. Indicates whether there are more items to be returned when a paged request is made and the page was not big enough to return all elements.</p>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"boolean"
},
"offset":{
"description":"<p>Actual response offset used. If the request specifies no offset then the actual offset is provided in the response.</p>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"integer",
"format":"int64"
}
}
}
]
}
ネストされたスキーマ : CollectionResource-allOf[1]
型: object
ソースを表示
{
"properties":{
"totalResults":{
"description":"<p>Total number of resources that match the request. If provided, this is the total number of available items. If not specified the total is not known, or is not viable to return. Paging limits or offsets are ignored when calculating this value. Only returned if the <code>totalResults</code> parameter is supported and is set to <code>true</code> by the client.</p>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"integer",
"format":"int64"
},
"limit":{
"description":"<p>Actual response size limit used. If the request specifies too large a limit, or does not specify a limit then the response will specify the limit used.</p>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"integer",
"format":"int32"
},
"count":{
"description":"<p>Total number of resources in the response.</p>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"integer",
"format":"int32"
},
"hasMore":{
"description":"<p>Collection has more elements that match the request. Indicates whether there are more items to be returned when a paged request is made and the page was not big enough to return all elements.</p>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"boolean"
},
"offset":{
"description":"<p>Actual response offset used. If the request specifies no offset then the actual offset is provided in the response.</p>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"integer",
"format":"int64"
}
}
}
ネストされたスキーマ: items
型: object
ソースを表示
- displayName(optional): string
ユーザー、クライアント・アプリケーションまたはグループの表示名。
リリース19.3.1.での導入。
- group(optional): グループ
メンバーのグループ詳細。 メンバーのタイプが「グループ」の場合にのみ使用できます。
リリース19.3.1.での導入。
- groupType(optional): string
メンバーがグループの場合、グループのタイプが指定されます。 メンバーがユーザーの場合、このフィールドは存在しません。
有効な値は次のとおりです。
-
oce
- コンテンツ管理グループ -
idp
- アイデンティティ・プロバイダ・グループ
リリース20.1.1で導入されました。
- id: string
ユーザー、クライアント・アプリケーションまたはグループ・メンバーの識別子。
フィールドの内容は想定しないでください。フィールドはopaque値として扱われる必要があります。
リリース19.3.1.での導入。
- isExternalUser(optional): boolean
関連するユーザーまたはクライアント・アプリケーションに外部ユーザー・ロールのみがある場合、trueに設定されます。
リリース21.10.2で導入されました。
- name: string
ユーザー、クライアント・アプリケーションまたはグループの一意の名前。 メンバーがユーザーの場合、名前はユーザー名です。 メンバーがグループの場合、名前はグループ名です。
リリース19.3.1.での導入。
- type: string
メンバーがユーザー、クライアント・アプリケーションまたはグループであることを示します。
有効な値は次のとおりです。
-
user
- メンバーはユーザーまたはクライアント・アプリケーションです。 ユーザーまたはメンバー間で区別されません
クライアント・アプリケーションであるメンバー。
リリース19.3.1.での導入。
- user(optional): user
メンバーのユーザーまたはクライアント・アプリケーションの詳細。 メンバーのタイプがuserの場合にのみ使用できます。 メンバーは、ユーザー、クライアント・アプリケーションまたはグループにすることができます。 ユーザーとクライアント・アプリケーションの両方の詳細を読むことができます。
リリース19.3.1.での導入。
{
"type":"object",
"properties":{
"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.3.1.</small>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"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.3.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.3.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.3.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.3.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.3.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Group"
}
]
}
},
"required":[
"id",
"type",
"name"
]
}
ネストされたスキーマ : グループ
メンバーのグループ詳細。 メンバーのタイプが「グループ」の場合にのみ使用できます。
リリース19.3.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.3.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Group"
}
]
}
ネストされたスキーマ: user
メンバーのユーザーまたはクライアント・アプリケーションの詳細。 メンバーのタイプがuserの場合にのみ使用できます。 メンバーは、ユーザー、クライアント・アプリケーションまたはグループにすることができます。 ユーザーとクライアント・アプリケーションの両方の詳細を読むことができます。
リリース19.3.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.3.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"
}
}
}
}
]
}
ネストされたスキーマ : 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"
}
}
}
}
ネストされたスキーマ: 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"
}
}
ネストされたスキーマ: 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"
}
}
ネストされたスキーマ: items
型: array
「ポリシー承認者メンバー」要素のコレクション。
リリース19.3.3.での導入。
ソースを表示
{
"description":"<p>Collection of <em>Policy Approvers Member</em> elements.</p><small>Introduced in release 19.3.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"array",
"items":{
"type":"object",
"properties":{
"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.3.3.</small>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"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.3.3.</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.3.3.</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.3.3.</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.3.3.</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.3.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Group"
}
]
}
},
"required":[
"id",
"type",
"name"
]
}
}
ネストされたスキーマ: items
型: object
ソースを表示
- displayName(optional): string
ユーザー、クライアント・アプリケーションまたはグループの表示名。
リリース19.3.3.での導入。
- group(optional): グループ
メンバーのグループ詳細。 メンバーのタイプが「グループ」の場合にのみ使用できます。
リリース19.3.3.での導入。
- groupType(optional): string
メンバーがグループの場合、グループのタイプが指定されます。 メンバーがユーザーの場合、このフィールドは存在しません。
有効な値は次のとおりです。
-
oce
- コンテンツ管理グループ -
idp
- アイデンティティ・プロバイダ・グループ
リリース20.1.1で導入されました。
- id: string
ユーザー、クライアント・アプリケーションまたはグループ・メンバーの識別子。
フィールドの内容は想定しないでください。フィールドはopaque値として扱われる必要があります。
リリース19.3.3.での導入。
- isExternalUser(optional): boolean
関連するユーザーまたはクライアント・アプリケーションに外部ユーザー・ロールのみがある場合、trueに設定されます。
リリース21.10.2で導入されました。
- name: string
ユーザー、クライアント・アプリケーションまたはグループの一意の名前。 メンバーがユーザーの場合、名前はユーザー名です。 メンバーがグループの場合、名前はグループ名です。
リリース19.3.3.での導入。
- type: string
メンバーがユーザー、クライアント・アプリケーションまたはグループであることを示します。
有効な値は次のとおりです。
-
user
- メンバーはユーザーまたはクライアント・アプリケーションです。 ユーザーまたはメンバー間で区別されません
クライアント・アプリケーションであるメンバー。
リリース19.3.3.での導入。
- user(optional): user
メンバーのユーザーまたはクライアント・アプリケーションの詳細。 メンバーのタイプがuserの場合にのみ使用できます。 メンバーは、ユーザー、クライアント・アプリケーションまたはグループにすることができます。 ユーザーとクライアント・アプリケーションの両方の詳細を読むことができます。
リリース19.3.3.での導入。
{
"type":"object",
"properties":{
"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.3.3.</small>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"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.3.3.</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.3.3.</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.3.3.</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.3.3.</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.3.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Group"
}
]
}
},
"required":[
"id",
"type",
"name"
]
}
ネストされたスキーマ : グループ
メンバーのグループ詳細。 メンバーのタイプが「グループ」の場合にのみ使用できます。
リリース19.3.3.での導入。
すべてに一致
ソースを表示
- 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.3.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Group"
}
]
}
ネストされたスキーマ: user
メンバーのユーザーまたはクライアント・アプリケーションの詳細。 メンバーのタイプがuserの場合にのみ使用できます。 メンバーは、ユーザー、クライアント・アプリケーションまたはグループにすることができます。 ユーザーとクライアント・アプリケーションの両方の詳細を読むことができます。
リリース19.3.3.での導入。
すべてに一致
ソースを表示
- 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.3.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
}
ネストされたスキーマ : SiteExpirationPeriod
型: object
サイトの有効期限は、時間と時間の単位で表されます。 たとえば、サイトが作成された後、2か月後にサイトを失効させます。
リリース19.4.1.での導入。
ソースを表示
{
"description":"<p>Site expiration is expressed as a unit of time and and an amount. For example, expire a site two months after the site is created.</p><small>Introduced in release 19.4.1.</small>",
"properties":{
"amount":{
"description":"<p>Amount of time used to measure site expiration.</p><small>Introduced in release 19.4.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"integer",
"format":"int32"
},
"unit":{
"description":"<p>Unit of time used to measure site expiration.</p><p>Valid values are:\n<ul><li> <code>months</code> - Expiration expressed in the number of months</li><li> <code>years</code> - Expiration expressed in the number of years</li></p><small>Introduced in release 19.4.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
}
}
}
ネストされたスキーマ : リポジトリ
リポジトリは、テキストとイメージの両方のファイルのストレージ・ロケーションです。 リポジトリ管理者は、リポジトリに対して指定されたチャネル・ポリシーおよびローカリゼーション・ポリシーを使用してリポジトリを作成できます。 様々なマーケティング・ニーズに対応するために、複数のリポジトリを作成できます。
リポジトリを使用すると、必要なすべてのアセットを1箇所で管理できます。 たとえば、会社でコンピュータ機器を販売するとします。 デスクトップ・コンピュータに関連するファイルを処理するために、1つのリポジトリを設定できます。 タブレットには別のリポジトリを使用できます。 各リポジトリには、様々な種類のコンピュータに関する写真、グラフィックおよびコンテンツを含めることができます。 各リポジトリのアセットは、リポジトリに割り当てるポリシーによって制御されます。
すべてに一致
ソースを表示
{
"description":"<p>Repositories are a storage location for files, both text and images. Repository administrators can create a repository with channel policies and localization policies designated for the repository. Multiple repositories can be created to handle different marketing needs.</p><p>A repository can be used to manage all the assets you need in one place. For example, perhaps your company sells computer equipment. One repository could be set up to handle the files related to desktop computers. Another repository could be used for tablets. Each repository might contain photos, graphics, and content about the different kinds of computers. The assets in each repository are controlled by the policies you allocate to the repository.</p>",
"allOf":[
{
"$ref":"#/definitions/SingularResource"
},
{
"properties":{
"id":{
"description":"<p>Unique identifier for the repository.</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>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"minimal",
"basic",
"default"
],
"type":"string"
},
"name":{
"description":"<p>Short human-readable name to identify the repository.</p>",
"x-returnedIn":[
"representation",
"basic",
"default"
],
"type":"string"
},
"description":{
"description":"<p>Human-readable description of the repository to give consumers an idea of what content this repository contains.</p>",
"x-returnedIn":[
"representation",
"default"
],
"type":"string"
},
"createdBy":{
"description":"<p>User that created the repository.</p>",
"x-returnedIn":[
"representation",
"default"
],
"type":"string"
},
"createdDate":{
"description":"<p>Date and time the repository was created.</p>",
"x-returnedIn":[
"representation",
"default"
],
"allOf":[
{
"$ref":"#/definitions/DateTimeZone"
}
]
},
"updatedBy":{
"description":"<p>User that last updated the repository. If the repository has not been updated the updated by will be the user that created the repository.</p>",
"x-returnedIn":[
"representation",
"default"
],
"type":"string"
},
"updatedDate":{
"description":"<p>Date and time the repository was last updated.</p>",
"x-returnedIn":[
"representation",
"default"
],
"allOf":[
{
"$ref":"#/definitions/DateTimeZone"
}
]
},
"autoTagEnabled":{
"description":"<p>Whether auto tagging is enabled for the repository.</p>",
"x-returnedIn":[
"representation",
"default"
],
"type":"boolean"
},
"contentTypes":{
"description":"<p>Content types associated with the repository.</p>",
"x-returnedIn":[
"representation",
"default"
],
"type":"array",
"items":{
"allOf":[
{
"$ref":"#/definitions/ContentTypeId"
}
]
}
},
"channels":{
"description":"<p>Channels associated with the repository.</p>",
"x-returnedIn":[
"representation",
"default"
],
"type":"array",
"items":{
"allOf":[
{
"$ref":"#/definitions/ChannelId"
}
]
}
},
"defaultLanguage":{
"description":"<p>Default language of the repository.</p>",
"x-returnedIn":[
"representation",
"default"
],
"type":"string"
},
"languageOptions":{
"description":"<p>Language options for the repository.</p>",
"x-returnedIn":[
"representation",
"default"
],
"type":"array",
"items":{
"type":"string"
}
},
"roleName":{
"description":"<p>The role the authenticated user has within the repository.</p><p>Valid values are:\n<ul><li> <code>owner</code> - Owner of the resource</li><li> <code>custom</code> - Custom role</li><li> <code>manager</code> - Manager role</li><li> <code>contributor</code> - Contributor role</li><li> <code>downloader</code> - Downloader role</li><li> <code>viewer</code> - Viewer role</li></p>",
"x-returnedIn":[
"representation",
"default"
],
"type":"string"
}
}
}
]
}
ネストされたスキーマ : Repository-allOf[1]
型: object
ソースを表示
{
"properties":{
"id":{
"description":"<p>Unique identifier for the repository.</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>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"minimal",
"basic",
"default"
],
"type":"string"
},
"name":{
"description":"<p>Short human-readable name to identify the repository.</p>",
"x-returnedIn":[
"representation",
"basic",
"default"
],
"type":"string"
},
"description":{
"description":"<p>Human-readable description of the repository to give consumers an idea of what content this repository contains.</p>",
"x-returnedIn":[
"representation",
"default"
],
"type":"string"
},
"createdBy":{
"description":"<p>User that created the repository.</p>",
"x-returnedIn":[
"representation",
"default"
],
"type":"string"
},
"createdDate":{
"description":"<p>Date and time the repository was created.</p>",
"x-returnedIn":[
"representation",
"default"
],
"allOf":[
{
"$ref":"#/definitions/DateTimeZone"
}
]
},
"updatedBy":{
"description":"<p>User that last updated the repository. If the repository has not been updated the updated by will be the user that created the repository.</p>",
"x-returnedIn":[
"representation",
"default"
],
"type":"string"
},
"updatedDate":{
"description":"<p>Date and time the repository was last updated.</p>",
"x-returnedIn":[
"representation",
"default"
],
"allOf":[
{
"$ref":"#/definitions/DateTimeZone"
}
]
},
"autoTagEnabled":{
"description":"<p>Whether auto tagging is enabled for the repository.</p>",
"x-returnedIn":[
"representation",
"default"
],
"type":"boolean"
},
"contentTypes":{
"description":"<p>Content types associated with the repository.</p>",
"x-returnedIn":[
"representation",
"default"
],
"type":"array",
"items":{
"allOf":[
{
"$ref":"#/definitions/ContentTypeId"
}
]
}
},
"channels":{
"description":"<p>Channels associated with the repository.</p>",
"x-returnedIn":[
"representation",
"default"
],
"type":"array",
"items":{
"allOf":[
{
"$ref":"#/definitions/ChannelId"
}
]
}
},
"defaultLanguage":{
"description":"<p>Default language of the repository.</p>",
"x-returnedIn":[
"representation",
"default"
],
"type":"string"
},
"languageOptions":{
"description":"<p>Language options for the repository.</p>",
"x-returnedIn":[
"representation",
"default"
],
"type":"array",
"items":{
"type":"string"
}
},
"roleName":{
"description":"<p>The role the authenticated user has within the repository.</p><p>Valid values are:\n<ul><li> <code>owner</code> - Owner of the resource</li><li> <code>custom</code> - Custom role</li><li> <code>manager</code> - Manager role</li><li> <code>contributor</code> - Contributor role</li><li> <code>downloader</code> - Downloader role</li><li> <code>viewer</code> - Viewer role</li></p>",
"x-returnedIn":[
"representation",
"default"
],
"type":"string"
}
}
}
ネストされたスキーマ : channels
型: array
ソースを表示
{
"description":"<p>Channels associated with the repository.</p>",
"x-returnedIn":[
"representation",
"default"
],
"type":"array",
"items":{
"allOf":[
{
"$ref":"#/definitions/ChannelId"
}
]
}
}
ネストされたスキーマ : contentTypes
型: array
ソースを表示
{
"description":"<p>Content types associated with the repository.</p>",
"x-returnedIn":[
"representation",
"default"
],
"type":"array",
"items":{
"allOf":[
{
"$ref":"#/definitions/ContentTypeId"
}
]
}
}
ネストされたスキーマ : createdDate
すべてに一致
ソースを表示
{
"description":"<p>Date and time the repository was created.</p>",
"x-returnedIn":[
"representation",
"default"
],
"allOf":[
{
"$ref":"#/definitions/DateTimeZone"
}
]
}
ネストされたスキーマ : languageOptions
型: array
ソースを表示
{
"description":"<p>Language options for the repository.</p>",
"x-returnedIn":[
"representation",
"default"
],
"type":"array",
"items":{
"type":"string"
}
}
ネストされたスキーマ : updatedDate
すべてに一致
ソースを表示
{
"description":"<p>Date and time the repository was last updated.</p>",
"x-returnedIn":[
"representation",
"default"
],
"allOf":[
{
"$ref":"#/definitions/DateTimeZone"
}
]
}
ネストされたスキーマ: items
すべてに一致
ソースを表示
{
"allOf":[
{
"$ref":"#/definitions/ChannelId"
}
]
}
ネストされたスキーマ : ChannelId
型: object
ソースを表示
{
"description":"<p>Channel identifier.</p>",
"properties":{
"id":{
"description":"<p>Unique identifier for the repository.</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>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"name":{
"description":"<p>Short unique human-readable name to identify the channel.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
}
}
}
ネストされたスキーマ: items
すべてに一致
ソースを表示
{
"allOf":[
{
"$ref":"#/definitions/ContentTypeId"
}
]
}
ネストされたスキーマ : ContentTypeId
型: object
ソースを表示
{
"description":"<p>Content type identifier.</p>",
"properties":{
"name":{
"description":"<p>Content type name.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
}
}
}
ネストされたスキーマ : DateTimeZone
型: object
ソースを表示
{
"description":"<p>Date, time and time zone.</p>",
"properties":{
"value":{
"description":"<p>Date in ISO 8601 format. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"format":"date-time"
},
"timezone":{
"description":"<p>Timezone in Olson database format.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"description":{
"description":"<p>Description of the date, time and time zone information.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
}
}
}
ネストされたスキーマ : SecurityPolicy
型: object
セキュリティ・ポリシーでは、サイトに許可されるセキュリティ・レベルの最小レベルを指定します。 サイトはこの最小レベルで作成されます。サイト・マネージャ/所有者は必要に応じてサイトでより制限的なセキュリティ・レベルを設定できます。 マネージャ/所有者は、サイト・セキュリティ・ポリシーで指定された値よりも安全性が低いセキュリティ・レベルは選択できません。
ソースを表示
- appliesTo(optional): string
サイトにアクセス可能なユーザーのタイプを定義します。 すべてのユーザーを含めることも、指定ユーザーのみに制限することもできます。
有効な値は次のとおりです。
-
named
- 指定されたレベル内の指定ユーザーのみがアクセスできます -
all
- 指定されたレベル内のすべてのユーザーがアクセスできます
- level(optional): string
サイトに設定できる最大オープン・セキュリティ・レベル。
有効な値は次のとおりです。
-
service
- サービス・ユーザーのみ -
cloud
- ドメインにサインインできるクラウド・ユーザーのみ -
everyone
- サインインせずに誰でも
{
"description":"<p>The security policy specifies the minimum level of security level a site will be allowed to have. The site will be created with this minimum level, and the site manager/owner can then set a more restrictive security level on the site if they wish. The manager/owner cannot select a security level that is less secure than the values specified on the sites security policy.</p>",
"properties":{
"level":{
"description":"<p>Maximum open security level that can be set on a site.</p><p>Valid values are:\n<ul><li> <code>service</code> - Only service users</li><li> <code>cloud</code> - Only cloud users who can sign in to your domain</li><li> <code>everyone</code> - Anyone without signing in</li></p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"appliesTo":{
"description":"<p>Define which types of users may access a site. Can include all users or be restricted to named users only.</p><p>Valid values are:\n<ul><li> <code>named</code> - Only named users within a specified level can access</li><li> <code>all</code> - All users within a specified level can access</li></p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
}
}
}