機械翻訳について

移動

• リクエスト
• レスポンス

認証されたユーザーに関する詳細の取得

get

/system/api/v1/me

アイデンティティProvider(IdP)から認証済ユーザーの詳細を取得します。##認証済ユーザーは、IdPから詳細をリクエストできます。

リクエスト

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

• application/json

問合せパラメータ

• customAttributes(optional): 文字列
  UserInfoレスポンスで返されるIDCSカスタム属性の名前を指定する、カンマ区切り文字列および大文字/小文字を区別しない文字列。 デフォルトでは、レスポンスには、事前定義のユーザー属性がほとんど含まれていません。 リクエストでこの問合せパラメータが指定されている場合、レスポンスには、この問合せパラメータが指定する属性と、事前定義されたユーザー属性が含まれます。 問合せパラメータで使用できるカスタム属性の最大数は20です。
• includeGroupMembership(optional): boolean
  ブール問合せパラメータ。trueに設定すると、ユーザーが属しているすべてのIDCS groups(Group's DisplayName and GUID)がレスポンスに含まれます。
• includeIDCSAppRoles(optional): boolean
  ブール問合せパラメータ。trueに設定すると、ユーザーが割り当てられているサービス固有のIDCSアプリケーション・ロールがレスポンスに含まれます。
• includeRealmUserGUID(optional): boolean
  ブール問合せパラメータ。trueに設定すると、レスポンスにレルムからのユーザーGUIDが含まれます。

トップに戻る

レスポンス

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

• application/json

200レスポンス

OK

本文()

ルート・スキーマ : UserInfo

型: object

Self-Management details.

Show Source

• customAttributes(optional): object customAttributes
  指定されたカスタム属性とその値を含むオブジェクト。
• email: string
  ユーザーの主要Eメール・アドレス

  例: [e-mail]
• firstName(optional): string
  ユーザーの名。

  例: Joe
• idcsappRoles(optional): array idcsappRoles
  IDCSアプリケーション・ロールの配列。ユーザーはその一部です。
• lastName: string
  ユーザーの姓。

  例: Janesen
• links: array links
  このリソースの関連リソースおよびアクションへのリンク。 リソースの正規表現へのリンクを含む自己リンクを少なくとも1つ含める必要があります。
• locale(optional): string
  ユーザー・ロケール。

  例: en
• membershipGroupsList(optional): array membershipGroupsList
  ユーザーが属するIDCSグループの配列。 各グループ・エントリにはグループDisplayNameが含まれ、IDCS IDです。
• middleName(optional): string
  ユーザーのミドル・ネーム。

  例: Jane
• realmUserGUID(optional): string
  レルムからのユーザーGUID

  例: 26e1a1b236b8415e97f1b44a60639ba8
• timezone(optional): string
  ユーザーのタイムゾーン

  例: America/Los_Angeles
• userName: string
  ユーザー名。

  例: [e-mail]

{
    "type":"object",
    "properties":{
        "realmUserGUID":{
            "type":"string",
            "example":"26e1a1b236b8415e97f1b44a60639ba8",
            "description":"User's GUID from realm"
        },
        "userName":{
            "type":"string",
            "example":"[e-mail]",
            "description":"User name."
        },
        "firstName":{
            "type":"string",
            "example":"Joe",
            "description":"User's first name."
        },
        "middleName":{
            "type":"string",
            "example":"Jane",
            "description":"User's middle name."
        },
        "lastName":{
            "type":"string",
            "example":"Janesen",
            "description":"User's last name."
        },
        "email":{
            "type":"string",
            "example":"[e-mail]",
            "description":"User's primary email address."
        },
        "locale":{
            "type":"string",
            "example":"en",
            "description":"User's locale."
        },
        "timezone":{
            "type":"string",
            "example":"America/Los_Angeles",
            "description":"User's timezone."
        },
        "links":{
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "customAttributes":{
            "type":"object",
            "description":"Object containing specified custom attributes and their values."
        },
        "membershipGroupsList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Group"
            },
            "description":"Array of IDCS groups the user is part of. Each group entry contains group's DisplayName and it's IDCS ID."
        },
        "idcsappRoles":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"Array of IDCS Application roles, the user is part of."
        }
    },
    "description":"Self-Management details.",
    "required":[
        "userName",
        "lastName",
        "email",
        "links"
    ]
}

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

型: object

指定されたカスタム属性とその値を含むオブジェクト。

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

型: array

IDCSアプリケーション・ロールの配列。ユーザーはその一部です。

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"Array of IDCS Application roles, the user is part of."
}

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

型: array

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

Show Source

• Array of: object Link
  RESTリンクおよび関連メタデータ。 レスポンスがリンクを提供する場合(リソース自体への`self`リンクなど)、提供されたリンクには、このリンク構造で定義された1つ以上のプロパティが含まれます。

{
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

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

型: array

ユーザーが属するIDCSグループの配列。 各グループ・エントリにはグループDisplayNameが含まれ、IDCS IDです。

Show Source

• Array of: object Group
  ユーザーが属するIDCSグループ。

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Group"
    },
    "description":"Array of IDCS groups the user is part of. Each group entry contains group's DisplayName and it's IDCS ID."
}

ネストされたスキーマ : リンク

型: object

RESTリンクおよび関連メタデータ。 レスポンスがリンクを提供する場合(リソース自体への`self`リンクなど)、提供されたリンクには、このリンク構造で定義された1つ以上のプロパティが含まれます。

Show Source

• href(optional): string
  ターゲット・リソースのURI URI *RFC3986*またはURIテンプレート*RFC6570*。 値がURIテンプレートに設定されている場合、`templated`プロパティを`true`に設定する必要があります。
• mediaType(optional): string
  リンク・ターゲット。 メディア・タイプ。RFC 2046で定義され、リンク・ターゲットを記述します。
• method(optional): string
  ターゲットHTTPメソッドをリンクします。 リンクのターゲットをリクエストするためのHTTPメソッド。* `none` - 有効な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
  リンク・メタデータのロケーション。 ターゲット・リソースを参照解除するときにリソースを指定するJSONスキーマなどのリソースのメタデータへのリンク。
• rel(optional): string
  リンク関係。 リンクの詳細を取得するために使用できるリンク・リレーションの名前。
• templated(optional): boolean
  hrefテンプレートのリンク・フラグ。 `href`プロパティを指定するブール・フラグは、URIまたはURIテンプレートです。 プロパティが存在しない場合、このプロパティは`false`と想定できます。

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Link relation. Name of the link relation that, in addition to the type property, can be used to retrieve link details."
        },
        "href":{
            "type":"string",
            "description":"The target resource URI. URI *RFC3986* or URI Template *RFC6570*. If the value is set to URI Template, then the `templated` property must be set to `true`."
        },
        "templated":{
            "type":"boolean",
            "description":"Link href template flag. Boolean flag that specifies the `href` property is a URI or URI Template. The property can be assumed to be `false` if the property is not present."
        },
        "mediaType":{
            "type":"string",
            "description":"Link target. Media type, as defined by RFC 2046, describing the link target."
        },
        "method":{
            "type":"string",
            "description":"Link target HTTP method. HTTP method for requesting the target of the link.  *  `none` - Indicates no valid HTTP method *  `OPTIONS` - HTTP OPTIONS *  `HEAD` - HTTP HEAD *  `GET` - HTTP GET *  `POST` - HTTP POST *  `PUT` - HTTP PUT *  `PATCH` - HTTP PATCH *  `DELETE` - HTTP DELETE"
        },
        "profile":{
            "type":"string",
            "description":"Link meta data location. Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource."
        }
    },
    "description":"REST link and related meta data.  If responses provide links (e.g. a `self` link to the resource itself) the links provided will include one or more of the properties defined on this link structure."
}

ネストされたスキーマ : グループ

型: object

ユーザーが属するIDCSグループ。

Show Source

• DisplayName: string
  IDCSグループdisplayName。
• ID: string
  IDCSグループID。

{
    "type":"object",
    "properties":{
        "DisplayName":{
            "type":"string",
            "description":"IDCS group's displayName."
        },
        "ID":{
            "type":"string",
            "description":"IDCS group's ID."
        }
    },
    "required":[
        "DisplayName",
        "ID"
    ],
    "description":"IDCS group, the user is part of."
}

304レスポンス

Not Modified

本文()

ルート・スキーマ : ExceptionDetail

型: object

RESTリクエストのエラー詳細。 HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 このような場合は、エラー・レスポンス本文に追加情報が含まれている必要があります。 追加情報はオプションですが、指定すると、例外詳細の形式になります。

Show Source

• detail(optional): string
  この問題の発生に固有の説明。 人間が判読できる、場合によっては複数行の詳細で、問題を詳細に説明しています。
• instance(optional): string
  エラーの詳細を提供するURIをリンクに追加します。
• o:errorCode(optional): string
  アプリケーション・エラー・コード。HTTPエラー・コードとは異なります。
• o:errorDetails(optional): array o:errorDetails
  階層構造に複数のエラーがある場合もあります。
• o:errorPath(optional): string
  エラーが発生した場所を示すXPathまたはJSONパス。
• status(optional): integer(int32)
  HTTPステータス・コード。 例外に対応するHTTPステータス・コード。 リソースが存在しない場合の例外として、HTTPステータスは`404`になります。
• title(optional): string
  問題の短く、判読可能なサマリー。 ページをローカライズする場合を除いて、問題の後続の出現時にはサマリー**を変更しないでください。
• type(optional): string
  問題のタイプを識別する絶対URI。 このURIが参照解除されると、**は、HTMLページなどの問題の判読可能なサマリーを提供するものとなります。

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"Absolute URI that identifies the problem type. When this URI dereferenced, it **should** provide a human-readable summary of the problem, for example, as a HTML page."
        },
        "title":{
            "type":"string",
            "description":"Short, human-readable summary of the problem. The summary **should not** change for subsequent occurrences of the problem, except for purposes of localization."
        },
        "status":{
            "type":"integer",
            "format":"int32",
            "description":"HTTP status code. The corresponding HTTP status code for the exception. For exception that includes a resource does not exist would have a HTTP status of `404`."
        },
        "detail":{
            "type":"string",
            "description":"Description specific to this occurrence of the problem. The human readable, potentially multi-line details describing the problem in more details."
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error."
        },
        "o:errorCode":{
            "type":"string",
            "description":"Application error code, which is different from HTTP error code."
        },
        "o:errorPath":{
            "type":"string",
            "description":"XPath or JSON path to indicate where the error occurs."
        },
        "o:errorDetails":{
            "type":"array",
            "description":"Multiple errors can be organized in a hierarchical structure.",
            "items":{
                "$ref":"#/definitions/ExceptionDetail"
            }
        }
    },
    "description":"Error details for a REST request.  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 these cases, the additional information must be included in the error response body. The additional information is optional, but if provided, it will be in the form of exception detail."
}

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

型: array

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

Show Source

• Array of: object ExceptionDetail
  RESTリクエストのエラー詳細。 HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 このような場合は、エラー・レスポンス本文に追加情報が含まれている必要があります。 追加情報はオプションですが、指定すると、例外詳細の形式になります。

{
    "type":"array",
    "description":"Multiple errors can be organized in a hierarchical structure.",
    "items":{
        "$ref":"#/definitions/ExceptionDetail"
    }
}

400レスポンス

不正リクエスト

本文()

ルート・スキーマ : ExceptionDetail

型: object

RESTリクエストのエラー詳細。 HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 このような場合は、エラー・レスポンス本文に追加情報が含まれている必要があります。 追加情報はオプションですが、指定すると、例外詳細の形式になります。

Show Source

• detail(optional): string
  この問題の発生に固有の説明。 人間が判読できる、場合によっては複数行の詳細で、問題を詳細に説明しています。
• instance(optional): string
  エラーの詳細を提供するURIをリンクに追加します。
• o:errorCode(optional): string
  アプリケーション・エラー・コード。HTTPエラー・コードとは異なります。
• o:errorDetails(optional): array o:errorDetails
  階層構造に複数のエラーがある場合もあります。
• o:errorPath(optional): string
  エラーが発生した場所を示すXPathまたはJSONパス。
• status(optional): integer(int32)
  HTTPステータス・コード。 例外に対応するHTTPステータス・コード。 リソースが存在しない場合の例外として、HTTPステータスは`404`になります。
• title(optional): string
  問題の短く、判読可能なサマリー。 ページをローカライズする場合を除いて、問題の後続の出現時にはサマリー**を変更しないでください。
• type(optional): string
  問題のタイプを識別する絶対URI。 このURIが参照解除されると、**は、HTMLページなどの問題の判読可能なサマリーを提供するものとなります。

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"Absolute URI that identifies the problem type. When this URI dereferenced, it **should** provide a human-readable summary of the problem, for example, as a HTML page."
        },
        "title":{
            "type":"string",
            "description":"Short, human-readable summary of the problem. The summary **should not** change for subsequent occurrences of the problem, except for purposes of localization."
        },
        "status":{
            "type":"integer",
            "format":"int32",
            "description":"HTTP status code. The corresponding HTTP status code for the exception. For exception that includes a resource does not exist would have a HTTP status of `404`."
        },
        "detail":{
            "type":"string",
            "description":"Description specific to this occurrence of the problem. The human readable, potentially multi-line details describing the problem in more details."
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error."
        },
        "o:errorCode":{
            "type":"string",
            "description":"Application error code, which is different from HTTP error code."
        },
        "o:errorPath":{
            "type":"string",
            "description":"XPath or JSON path to indicate where the error occurs."
        },
        "o:errorDetails":{
            "type":"array",
            "description":"Multiple errors can be organized in a hierarchical structure.",
            "items":{
                "$ref":"#/definitions/ExceptionDetail"
            }
        }
    },
    "description":"Error details for a REST request.  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 these cases, the additional information must be included in the error response body. The additional information is optional, but if provided, it will be in the form of exception detail."
}

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

型: array

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

Show Source

• Array of: object ExceptionDetail
  RESTリクエストのエラー詳細。 HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 このような場合は、エラー・レスポンス本文に追加情報が含まれている必要があります。 追加情報はオプションですが、指定すると、例外詳細の形式になります。

{
    "type":"array",
    "description":"Multiple errors can be organized in a hierarchical structure.",
    "items":{
        "$ref":"#/definitions/ExceptionDetail"
    }
}

404レスポンス

Not Found

本文()

ルート・スキーマ : ExceptionDetail

型: object

RESTリクエストのエラー詳細。 HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 このような場合は、エラー・レスポンス本文に追加情報が含まれている必要があります。 追加情報はオプションですが、指定すると、例外詳細の形式になります。

Show Source

• detail(optional): string
  この問題の発生に固有の説明。 人間が判読できる、場合によっては複数行の詳細で、問題を詳細に説明しています。
• instance(optional): string
  エラーの詳細を提供するURIをリンクに追加します。
• o:errorCode(optional): string
  アプリケーション・エラー・コード。HTTPエラー・コードとは異なります。
• o:errorDetails(optional): array o:errorDetails
  階層構造に複数のエラーがある場合もあります。
• o:errorPath(optional): string
  エラーが発生した場所を示すXPathまたはJSONパス。
• status(optional): integer(int32)
  HTTPステータス・コード。 例外に対応するHTTPステータス・コード。 リソースが存在しない場合の例外として、HTTPステータスは`404`になります。
• title(optional): string
  問題の短く、判読可能なサマリー。 ページをローカライズする場合を除いて、問題の後続の出現時にはサマリー**を変更しないでください。
• type(optional): string
  問題のタイプを識別する絶対URI。 このURIが参照解除されると、**は、HTMLページなどの問題の判読可能なサマリーを提供するものとなります。

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"Absolute URI that identifies the problem type. When this URI dereferenced, it **should** provide a human-readable summary of the problem, for example, as a HTML page."
        },
        "title":{
            "type":"string",
            "description":"Short, human-readable summary of the problem. The summary **should not** change for subsequent occurrences of the problem, except for purposes of localization."
        },
        "status":{
            "type":"integer",
            "format":"int32",
            "description":"HTTP status code. The corresponding HTTP status code for the exception. For exception that includes a resource does not exist would have a HTTP status of `404`."
        },
        "detail":{
            "type":"string",
            "description":"Description specific to this occurrence of the problem. The human readable, potentially multi-line details describing the problem in more details."
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error."
        },
        "o:errorCode":{
            "type":"string",
            "description":"Application error code, which is different from HTTP error code."
        },
        "o:errorPath":{
            "type":"string",
            "description":"XPath or JSON path to indicate where the error occurs."
        },
        "o:errorDetails":{
            "type":"array",
            "description":"Multiple errors can be organized in a hierarchical structure.",
            "items":{
                "$ref":"#/definitions/ExceptionDetail"
            }
        }
    },
    "description":"Error details for a REST request.  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 these cases, the additional information must be included in the error response body. The additional information is optional, but if provided, it will be in the form of exception detail."
}

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

型: array

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

Show Source

• Array of: object ExceptionDetail
  RESTリクエストのエラー詳細。 HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 このような場合は、エラー・レスポンス本文に追加情報が含まれている必要があります。 追加情報はオプションですが、指定すると、例外詳細の形式になります。

{
    "type":"array",
    "description":"Multiple errors can be organized in a hierarchical structure.",
    "items":{
        "$ref":"#/definitions/ExceptionDetail"
    }
}

500レスポンス

内部サーバー・エラー

本文()

ルート・スキーマ : ExceptionDetail

型: object

RESTリクエストのエラー詳細。 HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 このような場合は、エラー・レスポンス本文に追加情報が含まれている必要があります。 追加情報はオプションですが、指定すると、例外詳細の形式になります。

Show Source

• detail(optional): string
  この問題の発生に固有の説明。 人間が判読できる、場合によっては複数行の詳細で、問題を詳細に説明しています。
• instance(optional): string
  エラーの詳細を提供するURIをリンクに追加します。
• o:errorCode(optional): string
  アプリケーション・エラー・コード。HTTPエラー・コードとは異なります。
• o:errorDetails(optional): array o:errorDetails
  階層構造に複数のエラーがある場合もあります。
• o:errorPath(optional): string
  エラーが発生した場所を示すXPathまたはJSONパス。
• status(optional): integer(int32)
  HTTPステータス・コード。 例外に対応するHTTPステータス・コード。 リソースが存在しない場合の例外として、HTTPステータスは`404`になります。
• title(optional): string
  問題の短く、判読可能なサマリー。 ページをローカライズする場合を除いて、問題の後続の出現時にはサマリー**を変更しないでください。
• type(optional): string
  問題のタイプを識別する絶対URI。 このURIが参照解除されると、**は、HTMLページなどの問題の判読可能なサマリーを提供するものとなります。

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"Absolute URI that identifies the problem type. When this URI dereferenced, it **should** provide a human-readable summary of the problem, for example, as a HTML page."
        },
        "title":{
            "type":"string",
            "description":"Short, human-readable summary of the problem. The summary **should not** change for subsequent occurrences of the problem, except for purposes of localization."
        },
        "status":{
            "type":"integer",
            "format":"int32",
            "description":"HTTP status code. The corresponding HTTP status code for the exception. For exception that includes a resource does not exist would have a HTTP status of `404`."
        },
        "detail":{
            "type":"string",
            "description":"Description specific to this occurrence of the problem. The human readable, potentially multi-line details describing the problem in more details."
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error."
        },
        "o:errorCode":{
            "type":"string",
            "description":"Application error code, which is different from HTTP error code."
        },
        "o:errorPath":{
            "type":"string",
            "description":"XPath or JSON path to indicate where the error occurs."
        },
        "o:errorDetails":{
            "type":"array",
            "description":"Multiple errors can be organized in a hierarchical structure.",
            "items":{
                "$ref":"#/definitions/ExceptionDetail"
            }
        }
    },
    "description":"Error details for a REST request.  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 these cases, the additional information must be included in the error response body. The additional information is optional, but if provided, it will be in the form of exception detail."
}

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

型: array

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

Show Source

• Array of: object ExceptionDetail
  RESTリクエストのエラー詳細。 HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 このような場合は、エラー・レスポンス本文に追加情報が含まれている必要があります。 追加情報はオプションですが、指定すると、例外詳細の形式になります。

{
    "type":"array",
    "description":"Multiple errors can be organized in a hierarchical structure.",
    "items":{
        "$ref":"#/definitions/ExceptionDetail"
    }
}

トップに戻る