docs/AuthorizationApi.md in purecloudplatformclientv2-49.0.0 vs docs/AuthorizationApi.md in purecloudplatformclientv2-49.0.1
- old
+ new
@@ -44,11 +44,11 @@
[**put_user_roles**](AuthorizationApi.html#put_user_roles) | Sets the user's roles
{: class="table table-striped"}
<a name="delete_authorization_division"></a>
-## - delete_authorization_division(division_id)
+## delete_authorization_division(division_id)
Delete a division.
@@ -60,11 +60,11 @@
* authorization:division:delete
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -85,11 +85,11 @@
#Delete a division.
api_instance.delete_authorization_division(division_id)
rescue PureCloud::ApiError => e
puts "Exception when calling AuthorizationApi->delete_authorization_division: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -108,11 +108,11 @@
<a name="delete_authorization_role"></a>
-## - delete_authorization_role(role_id)
+## delete_authorization_role(role_id)
Delete an organization role.
@@ -126,11 +126,11 @@
* role_manager
* authorization:role:delete
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -151,11 +151,11 @@
#Delete an organization role.
api_instance.delete_authorization_role(role_id)
rescue PureCloud::ApiError => e
puts "Exception when calling AuthorizationApi->delete_authorization_role: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -174,11 +174,11 @@
<a name="delete_authorization_subject_division_role"></a>
-## - delete_authorization_subject_division_role(subject_id, division_id, role_id)
+## delete_authorization_subject_division_role(subject_id, division_id, role_id)
Delete a grant of a role in a division
@@ -190,11 +190,11 @@
* authorization:grant:delete
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -219,11 +219,11 @@
#Delete a grant of a role in a division
api_instance.delete_authorization_subject_division_role(subject_id, division_id, role_id)
rescue PureCloud::ApiError => e
puts "Exception when calling AuthorizationApi->delete_authorization_subject_division_role: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -244,11 +244,11 @@
<a name="delete_user_roles"></a>
-## - delete_user_roles(user_id)
+## delete_user_roles(user_id)
Removes all the roles from the user.
@@ -262,11 +262,11 @@
* role_manager
* authorization:grant:delete
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -287,11 +287,11 @@
#Removes all the roles from the user.
api_instance.delete_user_roles(user_id)
rescue PureCloud::ApiError => e
puts "Exception when calling AuthorizationApi->delete_user_roles: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -310,11 +310,11 @@
<a name="get_authorization_division"></a>
-## -[**AuthzDivision**](AuthzDivision.html) get_authorization_division(division_id, opts)
+## [**AuthzDivision**](AuthzDivision.html) get_authorization_division(division_id, opts)
Returns an authorization division.
@@ -325,11 +325,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -354,11 +354,11 @@
result = api_instance.get_authorization_division(division_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling AuthorizationApi->get_authorization_division: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -378,11 +378,11 @@
<a name="get_authorization_divisions"></a>
-## -[**AuthzDivisionEntityListing**](AuthzDivisionEntityListing.html) get_authorization_divisions(opts)
+## [**AuthzDivisionEntityListing**](AuthzDivisionEntityListing.html) get_authorization_divisions(opts)
Retrieve a list of all divisions defined for the organization
@@ -393,11 +393,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -428,11 +428,11 @@
result = api_instance.get_authorization_divisions(opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling AuthorizationApi->get_authorization_divisions: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -459,11 +459,11 @@
<a name="get_authorization_divisions_home"></a>
-## -[**AuthzDivision**](AuthzDivision.html) get_authorization_divisions_home
+## [**AuthzDivision**](AuthzDivision.html) get_authorization_divisions_home
Retrieve the home division for the organization.
@@ -474,11 +474,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -497,11 +497,11 @@
result = api_instance.get_authorization_divisions_home
p result
rescue PureCloud::ApiError => e
puts "Exception when calling AuthorizationApi->get_authorization_divisions_home: #{e}"
end
-~~~
+```
### Parameters
This endpoint does not need any parameter.
{: class="table table-striped"}
@@ -517,11 +517,11 @@
<a name="get_authorization_divisions_limit"></a>
-## -Integer** get_authorization_divisions_limit
+## Integer** get_authorization_divisions_limit
Returns the maximum allowed number of divisions.
@@ -532,11 +532,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -555,11 +555,11 @@
result = api_instance.get_authorization_divisions_limit
p result
rescue PureCloud::ApiError => e
puts "Exception when calling AuthorizationApi->get_authorization_divisions_limit: #{e}"
end
-~~~
+```
### Parameters
This endpoint does not need any parameter.
{: class="table table-striped"}
@@ -575,11 +575,11 @@
<a name="get_authorization_divisionspermitted_me"></a>
-## -[**Array<AuthzDivision>**](AuthzDivision.html) get_authorization_divisionspermitted_me(permission, opts)
+## [**Array<AuthzDivision>**](AuthzDivision.html) get_authorization_divisionspermitted_me(permission, opts)
Returns whether or not current user can perform the specified action(s).
@@ -590,11 +590,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -619,11 +619,11 @@
result = api_instance.get_authorization_divisionspermitted_me(permission, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling AuthorizationApi->get_authorization_divisionspermitted_me: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -643,11 +643,11 @@
<a name="get_authorization_divisionspermitted_subject_id"></a>
-## -[**Array<AuthzDivision>**](AuthzDivision.html) get_authorization_divisionspermitted_subject_id(subject_id, permission, opts)
+## [**Array<AuthzDivision>**](AuthzDivision.html) get_authorization_divisionspermitted_subject_id(subject_id, permission, opts)
Returns whether or not specified user can perform the specified action(s).
@@ -658,11 +658,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -689,11 +689,11 @@
result = api_instance.get_authorization_divisionspermitted_subject_id(subject_id, permission, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling AuthorizationApi->get_authorization_divisionspermitted_subject_id: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -714,11 +714,11 @@
<a name="get_authorization_permissions"></a>
-## -[**PermissionCollectionEntityListing**](PermissionCollectionEntityListing.html) get_authorization_permissions(opts)
+## [**PermissionCollectionEntityListing**](PermissionCollectionEntityListing.html) get_authorization_permissions(opts)
Get all permissions.
@@ -729,11 +729,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -757,11 +757,11 @@
result = api_instance.get_authorization_permissions(opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling AuthorizationApi->get_authorization_permissions: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -781,11 +781,11 @@
<a name="get_authorization_products"></a>
-## -[**OrganizationProductEntityListing**](OrganizationProductEntityListing.html) get_authorization_products
+## [**OrganizationProductEntityListing**](OrganizationProductEntityListing.html) get_authorization_products
Get the list of enabled products
@@ -796,11 +796,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -819,11 +819,11 @@
result = api_instance.get_authorization_products
p result
rescue PureCloud::ApiError => e
puts "Exception when calling AuthorizationApi->get_authorization_products: #{e}"
end
-~~~
+```
### Parameters
This endpoint does not need any parameter.
{: class="table table-striped"}
@@ -839,11 +839,11 @@
<a name="get_authorization_role"></a>
-## -[**DomainOrganizationRole**](DomainOrganizationRole.html) get_authorization_role(role_id)
+## [**DomainOrganizationRole**](DomainOrganizationRole.html) get_authorization_role(role_id)
Get a single organization role.
@@ -855,11 +855,11 @@
* authorization:role:view
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -881,11 +881,11 @@
result = api_instance.get_authorization_role(role_id)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling AuthorizationApi->get_authorization_role: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -904,11 +904,11 @@
<a name="get_authorization_role_comparedefault_right_role_id"></a>
-## -[**DomainOrgRoleDifference**](DomainOrgRoleDifference.html) get_authorization_role_comparedefault_right_role_id(left_role_id, right_role_id)
+## [**DomainOrgRoleDifference**](DomainOrgRoleDifference.html) get_authorization_role_comparedefault_right_role_id(left_role_id, right_role_id)
Get an org role to default role comparison
@@ -920,11 +920,11 @@
* authorization:role:view
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -948,11 +948,11 @@
result = api_instance.get_authorization_role_comparedefault_right_role_id(left_role_id, right_role_id)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling AuthorizationApi->get_authorization_role_comparedefault_right_role_id: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -972,11 +972,11 @@
<a name="get_authorization_role_subjectgrants"></a>
-## -[**SubjectDivisionGrantsEntityListing**](SubjectDivisionGrantsEntityListing.html) get_authorization_role_subjectgrants(role_id, opts)
+## [**SubjectDivisionGrantsEntityListing**](SubjectDivisionGrantsEntityListing.html) get_authorization_role_subjectgrants(role_id, opts)
Get the subjects' granted divisions in the specified role.
@@ -988,11 +988,11 @@
* authorization:role:view
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1022,11 +1022,11 @@
result = api_instance.get_authorization_role_subjectgrants(role_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling AuthorizationApi->get_authorization_role_subjectgrants: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1051,11 +1051,11 @@
<a name="get_authorization_role_users"></a>
-## -[**UserEntityListing**](UserEntityListing.html) get_authorization_role_users(role_id, opts)
+## [**UserEntityListing**](UserEntityListing.html) get_authorization_role_users(role_id, opts)
Get a list of the users in a specified role.
@@ -1066,11 +1066,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1096,11 +1096,11 @@
result = api_instance.get_authorization_role_users(role_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling AuthorizationApi->get_authorization_role_users: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1121,11 +1121,11 @@
<a name="get_authorization_roles"></a>
-## -[**OrganizationRoleEntityListing**](OrganizationRoleEntityListing.html) get_authorization_roles(opts)
+## [**OrganizationRoleEntityListing**](OrganizationRoleEntityListing.html) get_authorization_roles(opts)
Retrieve a list of all roles defined for the organization
@@ -1137,11 +1137,11 @@
* authorization:role:view
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1174,11 +1174,11 @@
result = api_instance.get_authorization_roles(opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling AuthorizationApi->get_authorization_roles: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1207,11 +1207,11 @@
<a name="get_authorization_subject"></a>
-## -[**AuthzSubject**](AuthzSubject.html) get_authorization_subject(subject_id)
+## [**AuthzSubject**](AuthzSubject.html) get_authorization_subject(subject_id)
Returns a listing of roles and permissions for a user.
@@ -1223,11 +1223,11 @@
* authorization:grant:view
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1249,11 +1249,11 @@
result = api_instance.get_authorization_subject(subject_id)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling AuthorizationApi->get_authorization_subject: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1272,11 +1272,11 @@
<a name="get_authorization_subjects_me"></a>
-## -[**AuthzSubject**](AuthzSubject.html) get_authorization_subjects_me
+## [**AuthzSubject**](AuthzSubject.html) get_authorization_subjects_me
Returns a listing of roles and permissions for the currently authenticated user.
@@ -1287,11 +1287,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1310,11 +1310,11 @@
result = api_instance.get_authorization_subjects_me
p result
rescue PureCloud::ApiError => e
puts "Exception when calling AuthorizationApi->get_authorization_subjects_me: #{e}"
end
-~~~
+```
### Parameters
This endpoint does not need any parameter.
{: class="table table-striped"}
@@ -1330,11 +1330,11 @@
<a name="get_user_roles"></a>
-## -[**UserAuthorization**](UserAuthorization.html) get_user_roles(user_id)
+## [**UserAuthorization**](UserAuthorization.html) get_user_roles(user_id)
Returns a listing of roles and permissions for a user.
@@ -1346,11 +1346,11 @@
* authorization:grant:view
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1372,11 +1372,11 @@
result = api_instance.get_user_roles(user_id)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling AuthorizationApi->get_user_roles: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1395,11 +1395,11 @@
<a name="patch_authorization_role"></a>
-## -[**DomainOrganizationRole**](DomainOrganizationRole.html) patch_authorization_role(role_id, body)
+## [**DomainOrganizationRole**](DomainOrganizationRole.html) patch_authorization_role(role_id, body)
Patch Organization Role for needsUpdate Field
@@ -1413,11 +1413,11 @@
* role_manager
* authorization:role:edit
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1441,11 +1441,11 @@
result = api_instance.patch_authorization_role(role_id, body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling AuthorizationApi->patch_authorization_role: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1465,11 +1465,11 @@
<a name="post_authorization_division_object"></a>
-## - post_authorization_division_object(division_id, object_type, body)
+## post_authorization_division_object(division_id, object_type, body)
Assign a list of objects to a division
@@ -1480,11 +1480,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1509,11 +1509,11 @@
#Assign a list of objects to a division
api_instance.post_authorization_division_object(division_id, object_type, body)
rescue PureCloud::ApiError => e
puts "Exception when calling AuthorizationApi->post_authorization_division_object: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1534,11 +1534,11 @@
<a name="post_authorization_divisions"></a>
-## -[**AuthzDivision**](AuthzDivision.html) post_authorization_divisions(body)
+## [**AuthzDivision**](AuthzDivision.html) post_authorization_divisions(body)
Create a division.
@@ -1551,11 +1551,11 @@
* authorization:division:add
* authorization:grant:add
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1577,11 +1577,11 @@
result = api_instance.post_authorization_divisions(body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling AuthorizationApi->post_authorization_divisions: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1600,11 +1600,11 @@
<a name="post_authorization_role"></a>
-## - post_authorization_role(role_id, body, opts)
+## post_authorization_role(role_id, body, opts)
Bulk-grant subjects and divisions with an organization role.
@@ -1616,11 +1616,11 @@
* authorization:grant:add
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1646,11 +1646,11 @@
#Bulk-grant subjects and divisions with an organization role.
api_instance.post_authorization_role(role_id, body, opts)
rescue PureCloud::ApiError => e
puts "Exception when calling AuthorizationApi->post_authorization_role: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1671,11 +1671,11 @@
<a name="post_authorization_role_comparedefault_right_role_id"></a>
-## -[**DomainOrgRoleDifference**](DomainOrgRoleDifference.html) post_authorization_role_comparedefault_right_role_id(left_role_id, right_role_id, body)
+## [**DomainOrgRoleDifference**](DomainOrgRoleDifference.html) post_authorization_role_comparedefault_right_role_id(left_role_id, right_role_id, body)
Get an unsaved org role to default role comparison
@@ -1687,11 +1687,11 @@
* authorization:role:view
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1717,11 +1717,11 @@
result = api_instance.post_authorization_role_comparedefault_right_role_id(left_role_id, right_role_id, body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling AuthorizationApi->post_authorization_role_comparedefault_right_role_id: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1742,11 +1742,11 @@
<a name="post_authorization_roles"></a>
-## -[**DomainOrganizationRole**](DomainOrganizationRole.html) post_authorization_roles(body)
+## [**DomainOrganizationRole**](DomainOrganizationRole.html) post_authorization_roles(body)
Create an organization role.
@@ -1758,11 +1758,11 @@
* authorization:role:add
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1784,11 +1784,11 @@
result = api_instance.post_authorization_roles(body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling AuthorizationApi->post_authorization_roles: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1807,11 +1807,11 @@
<a name="post_authorization_roles_default"></a>
-## -[**OrganizationRoleEntityListing**](OrganizationRoleEntityListing.html) post_authorization_roles_default(opts)
+## [**OrganizationRoleEntityListing**](OrganizationRoleEntityListing.html) post_authorization_roles_default(opts)
Restores all default roles
@@ -1823,11 +1823,11 @@
* authorization:role:edit
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1850,11 +1850,11 @@
result = api_instance.post_authorization_roles_default(opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling AuthorizationApi->post_authorization_roles_default: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1873,11 +1873,11 @@
<a name="post_authorization_subject_division_role"></a>
-## - post_authorization_subject_division_role(subject_id, division_id, role_id, opts)
+## post_authorization_subject_division_role(subject_id, division_id, role_id, opts)
Make a grant of a role in a division
@@ -1889,11 +1889,11 @@
* authorization:grant:add
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1921,11 +1921,11 @@
#Make a grant of a role in a division
api_instance.post_authorization_subject_division_role(subject_id, division_id, role_id, opts)
rescue PureCloud::ApiError => e
puts "Exception when calling AuthorizationApi->post_authorization_subject_division_role: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1947,11 +1947,11 @@
<a name="put_authorization_division"></a>
-## -[**AuthzDivision**](AuthzDivision.html) put_authorization_division(division_id, body)
+## [**AuthzDivision**](AuthzDivision.html) put_authorization_division(division_id, body)
Update a division.
@@ -1963,11 +1963,11 @@
* authorization:division:edit
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1991,11 +1991,11 @@
result = api_instance.put_authorization_division(division_id, body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling AuthorizationApi->put_authorization_division: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -2015,11 +2015,11 @@
<a name="put_authorization_role"></a>
-## -[**DomainOrganizationRole**](DomainOrganizationRole.html) put_authorization_role(role_id, body)
+## [**DomainOrganizationRole**](DomainOrganizationRole.html) put_authorization_role(role_id, body)
Update an organization role.
@@ -2033,11 +2033,11 @@
* role_manager
* authorization:role:edit
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -2061,11 +2061,11 @@
result = api_instance.put_authorization_role(role_id, body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling AuthorizationApi->put_authorization_role: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -2085,11 +2085,11 @@
<a name="put_authorization_role_users_add"></a>
-## -Array<String>** put_authorization_role_users_add(role_id, body)
+## Array<String>** put_authorization_role_users_add(role_id, body)
Sets the users for the role
@@ -2101,11 +2101,11 @@
* authorization:grant:add
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -2129,11 +2129,11 @@
result = api_instance.put_authorization_role_users_add(role_id, body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling AuthorizationApi->put_authorization_role_users_add: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -2153,11 +2153,11 @@
<a name="put_authorization_role_users_remove"></a>
-## -Array<String>** put_authorization_role_users_remove(role_id, body)
+## Array<String>** put_authorization_role_users_remove(role_id, body)
Removes the users from the role
@@ -2169,11 +2169,11 @@
* authorization:grant:delete
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -2197,11 +2197,11 @@
result = api_instance.put_authorization_role_users_remove(role_id, body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling AuthorizationApi->put_authorization_role_users_remove: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -2221,11 +2221,11 @@
<a name="put_authorization_roles_default"></a>
-## -[**OrganizationRoleEntityListing**](OrganizationRoleEntityListing.html) put_authorization_roles_default(body)
+## [**OrganizationRoleEntityListing**](OrganizationRoleEntityListing.html) put_authorization_roles_default(body)
Restore specified default roles
@@ -2237,11 +2237,11 @@
* authorization:role:edit
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -2263,11 +2263,11 @@
result = api_instance.put_authorization_roles_default(body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling AuthorizationApi->put_authorization_roles_default: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -2286,11 +2286,11 @@
<a name="put_user_roles"></a>
-## -[**UserAuthorization**](UserAuthorization.html) put_user_roles(user_id, body)
+## [**UserAuthorization**](UserAuthorization.html) put_user_roles(user_id, body)
Sets the user's roles
@@ -2304,11 +2304,11 @@
* role_manager
* authorization:grant:add
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -2332,10 +2332,10 @@
result = api_instance.put_user_roles(user_id, body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling AuthorizationApi->put_user_roles: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------