Oracle Essbase REST API

ユーザーの更新

put

/essbase/rest/v1/users/{id}

1人のユーザーを更新します。

EPM共有サービス・セキュリティ・モードを使用している場合、この操作は実行できません。かわりに、共有サービス・コンソールでユーザー、グループおよび権限を管理します。

リクエスト

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

application/json
application/xml

パス・パラメータ

id(required): string

ユーザーのID。

更新後のユーザー。

ルート・スキーマ : 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"
        }
    }
}

先頭に戻る

レスポンス

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

application/json
application/xml

200 レスポンス

ユーザーが正常に更新されました。

ルート・スキーマ : 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 レスポンス

不正なリクエスト

ログインしているユーザーに、適切なサービス役割がない可能性があります。

500 レスポンス

サーバーの内部エラーです。

先頭に戻る

例

次の例では、Essbaseユーザーを更新する方法を示します。

この例では、cURLを使用して、Windowsシェル・スクリプトからREST APIにアクセスします。呼出し元ユーザーのIDおよびパスワードは変数であり、properties.bat内でその変数値が設定されています。

cURLコマンドを含むスクリプト

curl -X PUT "https://myserver.example.com:9001/essbase/rest/v1/users/jenp" -H "accept: application/json" -H "Content-Type: application/json" --data "@./userinfo.json" -u %User%:%Password%

サンプルのJSONペイロード

cURLコマンドへの入力ファイルの内容は次のとおりです。

{
  "role": "Power User",  
  "email": "jen.x.power@example.com",
  "id": "jenp",
  "name": "Jen Power"
}

レスポンス本体の例

次の例では、レスポンス本体の内容をJSON形式で示します。

{
  "id": "jenp",
  "name": "Jen Power",
  "email": "jen.x.power@example.com",
  "role": "Power User",
  "links": [
    {
      "rel": "get",
      "href": "https://myserver.example.com:9001/essbase/rest/v1/users/jenp",
      "method": "GET"
    },
    {
      "rel": "edit",
      "href": "https://myserver.example.com:9001/essbase/rest/v1/users/jenp",
      "method": "PUT"
    },
    {
      "rel": "delete",
      "href": "https://myserver.example.com:9001/essbase/rest/v1/users/jenp",
      "method": "DELETE"
    },
    {
      "rel": "provisionReport",
      "href": "https://myserver.example.com:9001/essbase/rest/v1/users/jenp/provisionReport",
      "method": "GET"
    }
  ]
}

先頭に戻る