サイト管理用のREST API

メンバーのユーザーまたはアプリケーションの詳細の取得

get

/sites/management/api/v1/sites/{id}/members/{memberId}/user

RELATION

メンバーのユーザーまたはクライアント・アプリケーションの詳細。メンバーのタイプがuserの場合にのみ使用できます。メンバーは、ユーザー、クライアント・アプリケーションまたはグループにすることができます。ユーザーとクライアント・アプリケーションの両方の詳細を読むことができます。

リリース19.4.1.での導入。

認可

この操作を起動するには、認証されたユーザーまたはクライアント・アプリケーションがリソースと共有され、次のいずれかの「共有」ロールを持っている必要があります:

所有者
マネージャ
貢献者
ダウンロード実行者
ビューア

成功したレスポンスの例

この操作は、次の成功(2xx)のレスポンスで応答します。レスポンスHTTPステータス・コードとサンプル本体の完全なリストは、この操作の「レスポンス」に関する項を参照してください。

200OK - User

リクエスト

GET https://api.example.com/sites/management/api/v1/sites/{id}/members/{memberId}/user

レスポンス本文

{
  "type": "user",
  "id": "1234",
  "name": "value",
  "displayName": "John Smith",
  "roles": [
      "CECServiceAdministrator"
  ],
  "userName": "jsmith",
  "email": "jsmith@example.com"
}

200 OK - クライアント・アプリケーション

リクエスト

GET https://api.example.com/sites/management/api/v1/sites/{id}/members/{memberId}/user

レスポンス本文

{
  "type": "application",
  "id": "1234",
  "name": "value",
  "displayName": "John Smith",
  "roles": [
      "CECServiceAdministrator"
  ]
}

200 OK - サービス

リクエスト

GET https://api.example.com/sites/management/api/v1/sites/{id}/members/{memberId}/user

レスポンス本文

{
  "type": "service",
  "id": "1234",
  "name": "value",
  "displayName": "John Smith",
  "roles": [
      "CECServiceAdministrator"
  ]
}

200 OK - 不明な証明書です

リクエスト

GET https://api.example.com/sites/management/api/v1/sites/{id}/members/{memberId}/user

レスポンス本文

{
  "type": "unknown",
  "id": "1234",
  "name": "value",
  "displayName": "John Smith",
  "roles": [
      "CECServiceAdministrator"
  ],
  "userName": "jsmith"
}

クライアント・エラー・レスポンスの例

この操作は、レスポンス本文に例外の詳細が含まれている次のクライアント・エラー(4xx)レスポンスで応答します。レスポンスHTTPステータス・コードとサンプル本体の完全なリストは、この操作の「レスポンス」に関する項を参照してください。

404Not Found - Member Not Found

ユーザー、クライアント・アプリケーションまたはグループがメンバーではありません。

エラー・コード

OCE-IDS-001003

例外詳細フィールド

このエラー・タイプでは、レスポンスに次のフィールド/値が含まれます:

フィールド名	説明
`member`	メンバーではないユーザー、アプリケーションまたはグループ。

この例外の詳細タイプの詳細は、swaggerドキュメントの定義セクションのMemberNotFoundExceptionDetailスキーマを参照してください。

レスポンス本文の例

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Member Not Found",
  "status": "404",
  "detail": "User, application or group '{member.id}' is not a member'.",
  "o:errorCode": "OCE-IDS-001003",
  "member": {
    "id": "user:jsmith"
  }
}

リリース19.3.1.での導入。

404Not Found - Relationship Not Found

関係が存在しないため、関係を読み取ろうとしましたが失敗しました。関係が存在しなくなった場合、または認証されたアイデンティティが関係の詳細の読取りを承認されていない場合に、関係の読取りが失敗する可能性があります。

エラー・コード

PAAS-005027

レスポンス本文の例

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Relationship Not Found",
  "status": "404",
  "detail": "Relationship resource not found. There is a relationship to a resource, but the resource at the end of the relationship does not exist, or the authenticated identity cannot see the resource.",
  "o:errorCode": "PAAS-005027"
}

このリソースは、サイト・メンバーとアイデンティティ・リソースの関係を表します。サイト・メンバーに関連付けられているアイデンティティがない場合、レスポンス・ステータス・コードは204 No Contentになります。アイデンティティが削除されているか、認証されたユーザーがリソースの読取りを承認されていない場合、レスポンス・ステータス・コードは「404見つかりません」になり、レスポンス本文に「関係が見つかりません」エラーが返されます。

リクエスト

パス・パラメータ

id: string

サイトの不変の識別子。
memberId: string

ユーザー、クライアント・アプリケーションまたはグループ・メンバーの識別子。

問合せパラメータ

excludeFields(optional): string

レスポンスに含めないフィールド名のカンマ区切り文字列。
excludeLinks(optional): string

レスポンスからexcludeへのリンク関係名のカンマ区切りリスト。
fields(optional): string

レスポンスに含めるフィールド名のカンマ区切りの文字列。フィールド名を区切るには、ドットを使用してネストされたフィールドを特定できます。フィールド名は大文字と小文字を区別します。フィールドが存在しない場合、フィールド名は無視されます。

links(optional): string

レスポンス内のincludeへのリンク関係名のカンマ区切りリスト。デフォルトでは、すべてのリンクが返されます。

次のリンクは、このリソースにより提供されます:

リンク関係	説明
`parent`	親リソースが読取り可能な場所を示します。このリンクは`up`リンクに相当し、親リソース(単数形のリソースを含むコレクション・リソースなど)へのリンクを提供します。
`self`	リソースの現在の戻り表現を示します。リソース自体を表すリンクに使用されます。たとえば、リソースがコレクションの一部として戻された場合、自己リンクは個々のリソースのURLパスを提供します。
`canonical`	リクエストされたリソースの優先表現を示します。リソースの標準的な形式を表すリンクに使用されます。たとえば、リソースがコレクションの一部として返される場合、正規リンクは個々のリソースの正規の形式のURLパスを提供します。
`describedBy`	リソースに関するメタデータ情報を提供するスキーマ・リソースが記述されます。スキーマ・リソースがリソースを説明する場所を示すために、コレクション・リソース、単数形およびリレーション・リソースで使用されます。

return(optional): string

レスポンス・フィールドおよびリンクの制御に使用するリソース表現を指定します。表現が指定されない場合、fields、excludeFields、links、excludeLinksおよびexpand問合せパラメータの値に基づいて、クライアント定義の表現が戻されます。

次の表現は、return問合せパラメータでサポートされています:

表現	説明
`representation`	フル・リソース表示には、すべてのプロパティとリンクが含まれ、大部分の関係が拡張されます。
`default`	デフォルトのリソース表示には、ほとんどのプロパティとリンクが含まれます。
`basic`	基本的なリソース表現には、いくつかのプロパティといくつかのリンクが含まれます。
`minimal`	最小リソース表現。必須プロパティとリンクなしが含まれます。

トップに戻る

レスポンス

サポートされているメディア・タイプ

application/json
application/vnd.oracle.resource+json;type=singular

200レスポンス

ヘッダー

Cache-Control: string

キャッシュ・メカニズムのディレクティブ。
Content-Length: string

レスポンス本文のサイズ。
Content-Type: string

レスポンスのコンテンツ・タイプ。

ルート・スキーマ: schema

すべてに一致

ソースを表示

allOf 「アイデンティティ」

識別子: type

ユーザーまたはクライアント・アプリケーションを表すアイデンティティ。アイデンティティには、アイデンティティ識別子、一意の名前、表示名などの共通情報が含まれます。
リリース20.3.1で導入されました。

{
    "allOf":[
        {
            "$ref":"#/definitions/Identity"
        }
    ]
}

ネストされたスキーマ: Identity

識別子: type

ユーザーまたはクライアント・アプリケーションを表すアイデンティティ。アイデンティティには、アイデンティティ識別子、一意の名前、表示名などの共通情報が含まれます。

リリース20.3.1で導入されました。

すべてに一致

ソースを表示

object SingularResource

すべての単数形のリソースには、特異なリソース定義のプロパティが含まれます。単一のリソースには、他のリソースとの関係を提供するリンク、またはリソース自体をselfがリンクするリンク先のリストが含まれます。
object Identity-allOf[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"
                    }
                }
            }
        }
    ]
}

ネストされたスキーマ : SingularResource

型: object

すべての単数形のリソースには、特異なリソース定義のプロパティが含まれます。単一のリソースには、他のリソースとの関係を提供するリンク、またはリソース自体をselfがリンクするリンク先のリストが含まれます。

ソースを表示

links(optional): array links

このリソースに対する関連リソースおよびアクションへのHATEOSリンク。リソースの正規表現へのリンクを含む自己リンクを少なくとも1つ含める必要があります。

{
    "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"
                    }
                ]
            }
        }
    }
}

ネストされたスキーマ : 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"
            }
        }
    }
}

ネストされたスキーマ: links

型: array

このリソースに対する関連リソースおよびアクションへのHATEOSリンク。リソースの正規表現へのリンクを含む自己リンクを少なくとも1つ含める必要があります。

ソースを表示

Array of: items

{
    "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つ以上のプロパティが含まれます。

ソースを表示

href(optional): string

ターゲット・リソースのURI URI RFC3986またはURIテンプレートRFC6570。値がURIテンプレートに設定されている場合、templatedプロパティをtrueに設定する必要があります。
mediaType(optional): string

メディア・タイプ。RFC 2046で定義され、リンク・ターゲットを記述します。
method(optional): string
リンクのターゲットをリクエストするためのHTTPメソッド。
有効な値は次のとおりです。
- OPTIONS - HTTP OPTIONS
- HEAD - HTTP HEAD
- GET - HTTP GET
- POST - HTTP POST
- PUT - HTTP PUT
- PATCH - HTTP PATCH
- DELETE - HTTP DELETE
profile(optional): string(uri)

ターゲット・リソースを参照解除するときにリソースを指定するJSONスキーマなどのリソースのメタデータへのリンク。
rel(optional): string

リンクの詳細を取得するために使用できるリンク・リレーションの名前。
templated(optional): boolean

hrefプロパティを指定するブール・フラグは、URIまたはURIテンプレートです。プロパティが存在しない場合、falseとみなすことができます。

{
    "description":"<p>REST HATEOAS link and related metadata. If responses provide links (for example, a <code>self</code> link to the resource itself) the links provided will include one or more of the properties defined on this link structure.</p>",
    "properties":{
        "rel":{
            "description":"<p>Name of the link relation that, in addition to the type property, can be used to retrieve link details.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "href":{
            "description":"<p>The target resource URI. URI <em>RFC3986</em> or URI Template <em>RFC6570</em>. If the value is set to URI Template, then the <code>templated</code> property must be set to <code>true</code>.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "templated":{
            "description":"<p>Boolean flag that specifies the <code>href</code> property is a URI or URI Template. The property can be assumed to be <code>false</code> if the property is not present.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "mediaType":{
            "description":"<p>Media type, as defined by RFC 2046, describing the link target.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "method":{
            "description":"<p>HTTP method for requesting the target of the link.</p><p>Valid values are:\n<ul><li> <code>OPTIONS</code> - HTTP OPTIONS</li><li> <code>HEAD</code> - HTTP HEAD</li><li> <code>GET</code> - HTTP GET</li><li> <code>POST</code> - HTTP POST</li><li> <code>PUT</code> - HTTP PUT</li><li> <code>PATCH</code> - HTTP PATCH</li><li> <code>DELETE</code> - HTTP DELETE</li></p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "profile":{
            "description":"<p>Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"uri"
        }
    }
}

ネストされたスキーマ: roles

型: array

ロール

有効な値は次のとおりです。

CECServiceAdministrator - サービス管理者

ユーザー列挙の割当
ユーザーのパスワードおよびチャレンジ質問の変更
サービス・インスタンスの構成、モニターおよび管理
CECSitesAdministrator - サイト管理者

サイト、テンプレート、テーマまたはコンポーネントの作成
CECRepositoryAdministrator - リポジトリ管理者
CECDeveloperUser - 開発者ユーザー
CECContentAdministrator - コンテンツ管理者

新規コンテンツ・タイプの作成およびアイテムの公開
CECStandardUser - 標準ユーザー

コンテンツの管理(ドキュメントの表示、アップロードおよび編集)
他のユーザーとのコンテンツおよびサイトの共有
会話によるコラボレーション(トピックのディスカッション、他のユーザーへのメッセージの送信、他のユーザーへのフラグの割当て、ドキュメントへの注釈の追加)
ユーザーのフォロー
サイトの作成、編集および公開
サイトのテーマの管理および公開
カスタム・サイト・コンポーネントの作成、登録、エクスポートおよびインポート
サイト・テンプレートの作成、編集、エクスポートおよびインポート
サイト内のコンテンツの表示および操作
カスタム・プロパティの管理と表示、および値の編集
CECEnterpriseUser - エンタープライズ・ユーザー

コンテンツの管理(ドキュメントの表示、アップロードおよび編集)
他のユーザーとのコンテンツおよびサイトの共有
会話によるコラボレーション(トピックのディスカッション、他のユーザーへのメッセージの送信、他のユーザーへのフラグの割当て、ドキュメントへの注釈の追加)
ユーザーのフォロー
デジタル・アセット
コンテンツ・アイテム(エディトリアル・コンテンツ管理)
コンテンツ・アイテムの作成、管理、表示および操作
コレクション
サイトの作成、編集および公開
サイトのテーマの管理および公開
カスタム・サイト・コンポーネントの作成、登録、エクスポートおよびインポート
サイト・テンプレートの作成、編集、エクスポートおよびインポート
カスタム・プロパティの管理と表示、および値の編集
CECExternalUser - 外部ユーザー

将来使用するために予約済

CECIntegrationUser - 統合ユーザー

Collaboration REST APIのソーシャルRESTエンドポイントを介して操作を実行しながら、別のユーザーを偽装するために使用されます。

CECSitesVisitor - サイト・ビジター

サイトへのアクセスはビジターに制限されます。

リリース21.10.2で導入されました。

ソースを表示

Array of: string

{
    "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"
    }
}

レスポンスの例(ユーザー)

{
    "type":"user",
    "id":"1234",
    "name":"value",
    "displayName":"John Smith",
    "roles":[
        "CECServiceAdministrator"
    ],
    "userName":"jsmith",
    "email":"jsmith@example.com"
}

400レスポンス

不正なリクエスト

401レスポンス

未認可

403レスポンス

禁止

404レスポンス

見つかりません

ヘッダー

Cache-Control: string

キャッシュ・メカニズムのディレクティブ。
Content-Length: string

レスポンス本文のサイズ。
Content-Type: string

レスポンスのコンテンツ・タイプ。

ルート・スキーマ: schema

すべてに一致

ソースを表示

allOf MemberNotFoundExceptionDetail

リリース19.3.1.での導入。

{
    "allOf":[
        {
            "$ref":"#/definitions/MemberNotFoundExceptionDetail"
        }
    ]
}

ネストされたスキーマ : MemberNotFoundExceptionDetail

リリース19.3.1.での導入。

すべてに一致

ソースを表示

object ExceptionDetail

HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。その場合、追加情報がレスポンス本文に含まれます。
object MemberNotFoundExceptionDetail-allOf[1]

{
    "description":"<small>Introduced in release 19.3.1.</small>",
    "allOf":[
        {
            "$ref":"#/definitions/ExceptionDetail"
        },
        {
            "properties":{
                "member":{
                    "description":"<p>User, application or group that is not a member.</p><small>Introduced in release 19.3.1.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                }
            }
        }
    ]
}

ネストされたスキーマ : ExceptionDetail

型: object

HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。その場合、追加情報がレスポンス本文に含まれます。

ソースを表示

detail(optional): string

この問題の発生に固有の説明。人間が判読できる、場合によっては複数行の詳細で問題を説明しています。
instance(optional): string(uri)

エラーに関する詳細を提供するリンクへのURI。
o:errorCode(optional): string

アプリケーション・エラー・コード。HTTPエラー・コードとは異なります。このコードは、titleやdetailなどのフィールドを比較するのではなく、特定のエラーをチェックするために使用する必要があります。
o:errorDetails(optional): array o:errorDetails

階層構造に複数のエラーがある場合もあります。
o:errorPath(optional): string

エラーが発生した場所を示すXPathまたはJSONパス。
status(optional): integer(int32)

エラーに対応するHTTPステータス・コード。
title(optional): string

問題の短く、判読可能なサマリー。タイトルは、特定のエラーをチェックする方法としては使用しないでください。そのためにはo:errorCodeを使用してください。
type(optional): string(uri)

問題のタイプを識別する絶対URI。このURIが参照解除されると、「推奨」は、HTMLページなどの問題の判読可能なサマリーを提供します。

{
    "description":"<p>In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such cases, the additional information will be included in the response body.</p>",
    "properties":{
        "type":{
            "description":"<p>Absolute URI that identifies the problem type. When this URI dereferenced, it <strong>should</strong> provide a human-readable summary of the problem, for example, as a HTML page.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"uri"
        },
        "title":{
            "description":"<p>Short, human-readable summary of the problem. It is not advisable to use the title as a way of checking for specific errors, use the <code>o:errorCode</code> for this purpose.</p>",
            "x-multiLingual":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "status":{
            "description":"<p>Corresponding HTTP status code for the error.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"integer",
            "format":"int32"
        },
        "detail":{
            "description":"<p>Description specific to this occurrence of the problem. The human-readable, potentially multi-line details describing the problem in more details.</p>",
            "x-multiLingual":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "instance":{
            "description":"<p>URI to the link that provides more detail about the error.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"uri"
        },
        "o:errorCode":{
            "description":"<p>Application error code, which is different from HTTP error code. This code should be used to check for specific errors, rather than comparing fields such as the <code>title</code> or <code>detail</code>.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "o:errorPath":{
            "description":"<p>XPath or JSON path to indicate where the error occurs.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "o:errorDetails":{
            "description":"<p>Multiple errors can be organized in a hierarchical structure.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/ExceptionDetail"
                    }
                ]
            }
        }
    }
}

ネストされたスキーマ : MemberNotFoundExceptionDetail-allOf[1]

型: object

ソースを表示

member(optional): string

メンバーではないユーザー、アプリケーションまたはグループ。
リリース19.3.1.での導入。

{
    "properties":{
        "member":{
            "description":"<p>User, application or group that is not a member.</p><small>Introduced in release 19.3.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        }
    }
}

ネストされたスキーマ: o:errorDetails

型: array

階層構造に複数のエラーがある場合もあります。

ソースを表示

Array of: items

{
    "description":"<p>Multiple errors can be organized in a hierarchical structure.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/ExceptionDetail"
            }
        ]
    }
}

ネストされたスキーマ: items

すべてに一致

ソースを表示

object ExceptionDetail

HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。その場合、追加情報がレスポンス本文に含まれます。

{
    "allOf":[
        {
            "$ref":"#/definitions/ExceptionDetail"
        }
    ]
}

レスポンスの例(メンバーが見つかりません)

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Member Not Found",
    "status":"404",
    "detail":"User, application or group '{member.id}' is not a member'.",
    "o:errorCode":"OCE-IDS-001003",
    "member":{
        "id":"user:jsmith"
    }
}

レスポンスの例 (関係が見つかりません)

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Relationship Not Found",
    "status":"404",
    "detail":"Relationship resource not found. There is a relationship to a resource, but the resource at the end of the relationship does not exist, or the authenticated identity cannot see the resource.",
    "o:errorCode":"PAAS-005027"
}

406レスポンス

受入れられない

416 レスポンス

範囲を満たすことはできません

429 レスポンス

リクエストが多すぎます

500レスポンス

内部サーバー・エラー

501レスポンス

実装されていない

502 レスポンス

ゲートウェイが不良

503レスポンス

サービス使用不可

504レスポンス

ゲートウェイがタイムアウト

先頭に戻る