移動先

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

セッションの取得

get

/essbase/rest/v1/session

ログインしているユーザーの情報を返します。

リクエスト

問合せパラメータ

• token: boolean

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

ログイン・ユーザー情報が正常に返されました。

本体()

ルート・スキーマ : User

型: object

ソースの表示

• email: string
• groups: array groups

  このユーザーに関連付けられているグループ名のカンマ区切りリスト。

• id: string

  ユーザーID。

• links: array links
• name: string

  ユーザー名。256文字以内で入力してください。特殊文字; , = + * ? [ ] | < > \ " ' / スペース タブは使用できません。また、ピリオド(.)はグループ名で使用できません。

• password: string

  ユーザーのパスワード。

• role: string

  ユーザーの役割。有効な役割は、ユーザー、パワー・ユーザーおよびサービス管理者です。

• token: string

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "token":{
            "type":"string"
        },
        "email":{
            "type":"string"
        },
        "groups":{
            "type":"array",
            "description":"<p>Comma-separated list of group names associated with this user.</p>",
            "items":{
                "type":"string"
            }
        },
        "role":{
            "type":"string",
            "description":"<p>The user role. Valid roles: <b>User</b>, <b>Power User</b>, and <b>Service Administrator</b>.</p>"
        },
        "password":{
            "type":"string",
            "description":"<p>Password for the user.</p>"
        },
        "id":{
            "type":"string",
            "description":"<p>The user ID.</p>"
        },
        "name":{
            "type":"string",
            "description":"<p>The user name. Limit 256 characters. The following special characters are not permitted: <code>; , = + * ? [ ] | < > \\ \" ' / Space Tab</code>. Additionally, a period (<code>.</code>) is not permitted in group names.</p>"
        }
    },
    "xml":{
        "name":"User"
    }
}

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

型: array

このユーザーに関連付けられているグループ名のカンマ区切りリスト。

ソースの表示

• 配列: string

{
    "type":"array",
    "description":"<p>Comma-separated list of group names associated with this user.</p>",
    "items":{
        "type":"string"
    }
}

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

型: array

ソースの表示

• 配列: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

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

型: object

ソースの表示

• href: string
• method: string
• rel: string
• type: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "method":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

400 レスポンス

不正なリクエスト

ユーザー情報の取得に失敗しました。

先頭に戻る