Jump to

• Request
• Response

Get Essbase Roles

get

/essbase/rest/v1/roles

Returns the roles available in Essbase. Valid type values are application and server. If type is empty, then both application and server roles are returned.

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

Query Parameters

• type(optional): string

  Valid type values are application and server.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

Returns roles for the specified type.

Body ()

Root Schema : Roles

Type: object

Show Source

• count(optional): integer(int64)
• hasMore(optional): boolean
• items(optional): array items
• limit(optional): integer(int64)
• offset(optional): integer(int64)
• properties(optional): object properties
  Additional Properties Allowed: additionalProperties
• totalResults(optional): integer(int64)

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/RoleBean"
            }
        },
        "totalResults":{
            "type":"integer",
            "format":"int64"
        },
        "hasMore":{
            "type":"boolean"
        },
        "count":{
            "type":"integer",
            "format":"int64"
        },
        "limit":{
            "type":"integer",
            "format":"int64"
        },
        "properties":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "offset":{
            "type":"integer",
            "format":"int64"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object RoleBean

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

Nested Schema : properties

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : RoleBean

Type: object

Show Source

• defaultRole(optional): string
• roles(optional): array roles
• type(optional): string

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "roles":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "defaultRole":{
            "type":"string"
        }
    }
}

Nested Schema : roles

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top