docs/AuthorizationApi.md in purecloudplatformclientv2-62.0.0 vs docs/AuthorizationApi.md in purecloudplatformclientv2-63.0.0
- old
+ new
@@ -871,11 +871,11 @@
api_instance = PureCloud::AuthorizationApi.new
role_id = "role_id_example" # String | Role ID
opts = {
- expand: ["expand_example"] # Array<String> | Which fields, if any, to expand.
+ expand: ["expand_example"] # Array<String> | Which fields, if any, to expand. \"unusedPermissions\" returns the permissions not used for the role
}
begin
#Get a single organization role.
result = api_instance.get_authorization_role(role_id, opts)
@@ -888,11 +888,11 @@
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**role_id** | **String**| Role ID | |
- **expand** | [**Array<String>**](String.html)| Which fields, if any, to expand. | [optional] <br />**Values**: unusedPermissions |
+ **expand** | [**Array<String>**](String.html)| Which fields, if any, to expand. \"unusedPermissions\" returns the permissions not used for the role | [optional] <br />**Values**: unusedPermissions |
{: class="table table-striped"}
### Return type
@@ -1581,11 +1581,11 @@
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**division_id** | **String**| Division ID | |
- **object_type** | **String**| The type of the objects. Must be one of the valid object types | <br />**Values**: QUEUE, CAMPAIGN, CONTACTLIST, DNCLIST, MANAGEMENTUNIT, BUSINESSUNIT, FLOW, USER |
+ **object_type** | **String**| The type of the objects. Must be one of the valid object types | <br />**Values**: QUEUE, CAMPAIGN, CONTACTLIST, DNCLIST, MESSAGINGCAMPAIGN, MANAGEMENTUNIT, BUSINESSUNIT, FLOW, USER |
**body** | **Array<String>**| Object Id List | |
{: class="table table-striped"}
### Return type
@@ -1702,11 +1702,11 @@
role_id = "role_id_example" # String | Role ID
body = PureCloud::SubjectDivisions.new # SubjectDivisions | Subjects and Divisions
opts = {
- subject_type: "PC_USER" # String | what the type of the subject is, PC_GROUP or PC_USER
+ subject_type: "PC_USER" # String | what the type of the subjects are (PC_GROUP, PC_USER or PC_OAUTH_CLIENT)
}
begin
#Bulk-grant subjects and divisions with an organization role.
api_instance.post_authorization_role(role_id, body, opts)
@@ -1719,11 +1719,11 @@
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**role_id** | **String**| Role ID | |
**body** | [**SubjectDivisions**](SubjectDivisions.html)| Subjects and Divisions | |
- **subject_type** | **String**| what the type of the subject is, PC_GROUP or PC_USER | [optional] [default to PC_USER] |
+ **subject_type** | **String**| what the type of the subjects are (PC_GROUP, PC_USER or PC_OAUTH_CLIENT) | [optional] [default to PC_USER] |
{: class="table table-striped"}
### Return type
@@ -1977,11 +1977,11 @@
division_id = "division_id_example" # String | the id of the division to which to make the grant
role_id = "role_id_example" # String | the id of the role to grant
opts = {
- subject_type: "PC_USER" # String | what the type of the subject is, PC_GROUP or PC_USER
+ subject_type: "PC_USER" # String | what the type of the subject is: PC_GROUP, PC_USER or PC_OAUTH_CLIENT (note: for cross-org authorization, please use the Organization Authorization endpoints)
}
begin
#Make a grant of a role in a division
api_instance.post_authorization_subject_division_role(subject_id, division_id, role_id, opts)
@@ -1995,10 +1995,10 @@
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**subject_id** | **String**| Subject ID (user or group) | |
**division_id** | **String**| the id of the division to which to make the grant | |
**role_id** | **String**| the id of the role to grant | |
- **subject_type** | **String**| what the type of the subject is, PC_GROUP or PC_USER | [optional] [default to PC_USER] |
+ **subject_type** | **String**| what the type of the subject is: PC_GROUP, PC_USER or PC_OAUTH_CLIENT (note: for cross-org authorization, please use the Organization Authorization endpoints) | [optional] [default to PC_USER] |
{: class="table table-striped"}
### Return type