REST API for Oracle Essbase

Get Group Users

get

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

Gets user members of a group.

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

Path Parameters

id(required): string

ID of group.

Response

Supported Media Types

application/json
application/xml

200 Response

Group member list returned successfully.

Root Schema : Users

Type: object

Show Source

count: integer(int64)
hasMore: boolean
items: array items
limit: integer(int64)
offset: integer(int64)
properties: object properties

Additional Properties Allowed: additionalProperties
totalResults: 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/UserBean"
            }
        },
        "hasMore":{
            "type":"boolean"
        },
        "properties":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

Array of: object User

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

Nested Schema : properties

Type: object

Additional Properties Allowed

Show Source

string

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

Nested Schema : User

Type: object

Show Source

email: string
groups: array groups

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

The user ID.
links: array links
name: 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: string

Password for the user.
role: string

The user role. Valid roles: User, Power User, and Service Administrator.
token: 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: string
method: string
rel: string
type: string

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

400 Response

Bad Request

Logged in user may not have appropriate permissions.

500 Response

Internal Server Error.

Examples

The following examples show how to retrieve a list of users belonging to a group.

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

The following example requests which users are a member of the group id sample_appmgrs.

call properties.bat
curl -X GET "https://myserver.example.com:9001/essbase/rest/v1/groups/sample_appmgrs/members/users?links=none" -H "Accept:application/json" -u %User%:%Password%

Example of Response Body

Aisha and Fred are the members of the group.

{
  "items" : [ {
    "id" : "user4",
    "name" : "Aisha",
    "email" : ""
  }, {
    "id" : "user8",
    "name" : "Fred",
    "email" : ""
  } ]
}