Jump to

• Request
• Response

Search Provision

get

/essbase/rest/v1/permissions

Search for provisioning information.

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

• filter(optional): string

  Search filter. Values available: all/group/user. Default value is all, so if this query parameter is not specified, then all users and groups having some role will be returned.

  Default Value: all
• id(optional): string

  User or group ID wildcard pattern. if specified, returns users and groups matching the pattern, if not specified, returns all the users and groups having some role. Users or groups having no role are not returned.

  Default Value: *
• role(optional): string

  Input may include all, none, or a comma-separated list of roles (for example, service_administrator, power_user, or user). Default value is all, so if this query parameter is not specified, all users and groups having some role are returned. If none is specified, only users and groups having no role will be returned. If named roles are specified, then only users and groups having any of the named roles are returned.

  Default Value: all

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

User and group provisioning results returned successfully.

Body ()

Root Schema : result

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":{
        "totalResults":{
            "type":"integer",
            "format":"int64"
        },
        "count":{
            "type":"integer",
            "format":"int64"
        },
        "limit":{
            "type":"integer",
            "format":"int64"
        },
        "offset":{
            "type":"integer",
            "format":"int64"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserGroupProvisionInfo"
            }
        },
        "hasMore":{
            "type":"boolean"
        },
        "properties":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        }
    },
    "xml":{
        "name":"result"
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object permission

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

Nested Schema : properties

Type: object

Additional Properties Allowed

Show Source

• string

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

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

400 Response

Bad Request

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

500 Response

Internal Server Error.

Back to Top