Jump to

• Request
• Response
• Examples

Provision User or Group

put

/essbase/rest/v1/applications/{app}/permissions/{id}

Provisions a single user or group on the specified application.

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

• app: string

  Application name.

• id: string

  User or group ID.

Body ()

User or group provisioning information.

Root Schema : permission

Type: object

Show Source

• group(optional): boolean
• id(optional): string
• links(optional): array links
• name(optional): string
• role(optional): string

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "role":{
            "type":"string"
        },
        "group":{
            "type":"boolean"
        }
    },
    "xml":{
        "name":"permission"
    }
}

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

Back to Top

Response

Supported Media Types

• application/json
• application/xml

204 Response

OK

Provisioned successfully.

400 Response

Bad Request

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

500 Response

Internal Server Error.

Back to Top

Examples

The following example shows how to provision one user or group's access to an application, using cURL to call 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

call properties.bat
curl -X PUT "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/permissions/User001" -H "accept: application/json" -H "Content-Type: application/json" -d '{"id": "User001", "role": "db_access", "group": false}' -u %User%:%Password%

Back to Top