Get Customer Grants

Overview

Use this API to allow users to get the grants of a customer based on customer ID. The response will have all the grants.

Permissions

Actor Permission
User All of the following are required:
  • 'View Agent Console' action.
  • If "customer departmentalization" setting is enabled in the application, the customer specified through ID must belong to either the user's home department, or to a department where the user is a foreign user.
Client Application No additional permission is required.
SecurityoAuthUser or oAuthClient
Request
path Parameters
id
required
string <= 255 characters

id of object

Example: 1001
header Parameters
Accept
required
string
Default: application/json

Content type accepted by client.

Enum: "application/json" "application/xml"
Accept-Language
required
string
Default: en-US

Language locale accepted by client (used for locale specific fields in resource representation and in error responses).

Enum: "en-US" "es-ES" "fr-FR" "it-IT" "de-DE" "nl-NL" "pt-BR" "pt-PT" "da-DK" "ru-RU" "fr-CA" "zh-CN" "ja-JP" "ko-KR" "sv-SE"
Responses
200

Response for get grants operation

204

No content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

406

Not Acceptable

500

Internal server error

get/customer/{id}/grants
Request samples
Response samples
application/json

GET /core/customermgr/v3/customer/1003/grants

{
  • "grantsOn": {
    },
  • "grantsTo": {
    }
}