Jump to

• Request
• Response
• Examples

Provision Service Role

put

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

Provisions a single user or group for an Essbase service role. Service roles include Service Administrator, Power User, and 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(required): string

  User or group ID.

Body ()

User or group provisioning information.

Root Schema : permission

Type: object

Show Source

• group: boolean

  true or false. Whether the id refers to a group.

• id: string
• links: array links
• name: string
• role: string

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "role":{
            "type":"string"
        },
        "group":{
            "type":"boolean",
            "description":"<p><b>true</b> or <b>false</b>. Whether the <b>id</b> refers to a group.</p>"
        }
    },
    "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: string
• method: string
• rel: string
• type: 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

User or group provisioned successfully.

400 Response

Bad Request

The logged in user may not have the required service administrator role.

409 Response

Conflict

The user/group being provisioned is stale and it has been removed from identity store

500 Response

Internal Server Error.

Back to Top

Examples

The following example shows how to provision a single user or group for a service role.

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

call properties.bat
curl -X PUT "https://myserver.example.com:9001/essbase/rest/v1/permissions/user1" -H "accept: application/json" -H "Content-Type: application/json" -d '{"links": [ {"rel": "string", "href": "string", "method": "string", "type": "string"} ], "id": "user1", "name": "user1", "role": "service_administrator", "group": false}' -u %User%:%Password%

cURL Sample Template for MSAD Provisioning

To provision a Microsoft Active Directory user named user1 with service_administrator role, issue the request below as the WebLogic Administrator account. Replace <weblogic_admin_user>, <weblogic_admin_password>, <Essbase_Host>, <Essbase_Managed_Server_Port>, and <user1> with appropriate values.

curl -X PUT -u <weblogic_admin_user>:<weblogic_admin_password> "https://<Essbase_Host>:<Essbase_Managed_Server_Port>/essbase/rest/v1/permissions/user1" -H "accept: application/json" -H "Content-Type: application/json" -d '{"links": [ {"rel": "string", "href": "string", "method": "string", "type": "string"} ], "id": "user1", "name": "user1", "role": "service_administrator", "group": false}'

Back to Top