Jump to

• Request
• Response
• Examples

List Dashboard Privileges

get

/serviceapi/dashboardModel/privilege/dashboards/{dashboardId}

Get all users and their privileges for the dashboard with assigned dashboard Id.

Request

Path Parameters

• dashboardId: string(BigInteger)
  The id of the dashboard. The id of a dashboard is displayed as a query parameter in the URL while using Oracle Management Cloud through the user interface.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : SuccessfulOperation

Type: object

Describes the status of a successful dashboard privilege job.

Show Source

• dashboardId: string(BigInteger)
  The dashboard id.

  Example: 1234
• id: string(BigInteger)
  The id of this privilege.

  Example: 1111
• privilegeType: integer(int32)

  The type of privilege this user has.

  0 = VIEW

  1 = MANAGE

  Example: 1
• sharePublic: integer(int32)
  This value determines if this privilege is available to the public. Values: 0 - Not shared to public | 1 - Shared to public

  Example: 0
• userName: string
  The name of the user.

  Example: demouser

{
    "type":"object",
    "required":[
        "dashboardId",
        "id",
        "privilegeType",
        "sharePublic",
        "userName"
    ],
    "properties":{
        "dashboardId":{
            "type":"string",
            "format":"BigInteger",
            "example":"1234",
            "description":"The dashboard id."
        },
        "id":{
            "type":"string",
            "format":"BigInteger",
            "example":"1111",
            "description":"The id of this privilege."
        },
        "privilegeType":{
            "type":"integer",
            "format":"int32",
            "example":"1",
            "description":"<p>The type of privilege this user has.\n</p><p>0 = VIEW</p><p>1 = MANAGE</p>"
        },
        "sharePublic":{
            "type":"integer",
            "format":"int32",
            "example":"0",
            "description":"This value determines if this privilege is available to the public. Values: 0 - Not shared to public | 1 - Shared to public"
        },
        "userName":{
            "type":"string",
            "example":"demouser",
            "description":"The name of the user."
        }
    },
    "description":"<p>Describes the status of a successful dashboard privilege job.</p>"
}

Back to Top

Examples

This cURL call will get all privileges for the dashboard with dashboardId: 5432361245:

curl -u ${OMC_USERNAME}:${PASSWORD} -X PUT -H "Content-Type:application/json" "https://{OMC_URL}/serviceapi/dashboardModel/privilege/dashboards/5432361245

Example of Response

The following shows an example of the response body.

{
  "dashboardId": "5432361245",
  "id": "10",
  "privilegeType": 0,
  "sharePublic": 0,
  "userName": "demouser"
}

Back to Top