REST API for Oracle Essbase

Update User

put

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

Updates a user.

If you are using EPM Shared Services security mode, this operation is not available. Instead, manage users, groups, and permissions in the Shared Services Console.

Request

Supported Media Types

application/json
application/xml

Path Parameters

id: string

ID of user.

Updated user.

Root Schema : User

Type: object

Show Source

email(optional): string
groups(optional): array groups

Comma-separated list of group names associated with this user.
id(optional): string

The user ID.
links(optional): array links
name(optional): string

The user name. Limit 256 characters. The following special characters are not permitted: ; , = + * ? [ ] | < > \ " ' / Space Tab. Additionally, a period (.) is not permitted in group names.
password(optional): string

Password for the user.
role(optional): string

The user role. Valid roles: User, Power User, and Service Administrator.
token(optional): 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"
    }
}

Nested Schema : groups

Type: array

Comma-separated list of group names associated with this user.

Show Source

Array of: string

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

Nested Schema : links

Type: array

Show Source

Array of: object Link

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

Nested Schema : Link

Type: object

Show Source

href(optional): string
method(optional): string
rel(optional): string
type(optional): string

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

Response

Supported Media Types

application/json
application/xml

200 Response

User updated successfully.

Root Schema : User

Type: object

Show Source

email(optional): string
groups(optional): array groups

Comma-separated list of group names associated with this user.
id(optional): string

The user ID.
links(optional): array links
name(optional): string

The user name. Limit 256 characters. The following special characters are not permitted: ; , = + * ? [ ] | < > \ " ' / Space Tab. Additionally, a period (.) is not permitted in group names.
password(optional): string

Password for the user.
role(optional): string

The user role. Valid roles: User, Power User, and Service Administrator.
token(optional): 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"
    }
}

Nested Schema : groups

Type: array

Comma-separated list of group names associated with this user.

Show Source

Array of: string

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

Nested Schema : links

Type: array

Show Source

Array of: object Link

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

Nested Schema : Link

Type: object

Show Source

href(optional): string
method(optional): string
rel(optional): string
type(optional): string

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

400 Response

Bad Request

The logged in user may not have the appropriate service role.

500 Response

Internal Server Error.

Examples

The following example shows how to update an Essbase user.

This example uses cURL to access the REST API from a Windows shell script. The calling user's ID and password are variables whose values are set in properties.bat.

Script with cURL Command

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%

Sample JSON Payload

The input file to the cURL command has the following contents:

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

Example of Response Body

The following example shows the contents of the response body in JSON format:

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