docs/AuthorizationApi.md in purecloudplatformclientv2-34.0.0 vs docs/AuthorizationApi.md in purecloudplatformclientv2-35.0.0
- old
+ new
@@ -29,17 +29,23 @@
<a name="delete_authorization_role"></a>
## - delete_authorization_role(role_id)
+
+
Delete an organization role.
Wraps DELETE /api/v2/authorization/roles/{roleId}
+Requires ANY permissions:
+* admin* role_manager* authorization:role:delete
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -87,17 +93,23 @@
<a name="delete_user_roles"></a>
## - delete_user_roles(user_id)
+
+
Removes all the roles from the user.
Wraps DELETE /api/v2/users/{userId}/roles
+Requires ANY permissions:
+* admin* role_manager* authorization:grant:delete
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -145,17 +157,23 @@
<a name="get_authorization_permissions"></a>
## -[**PermissionCollectionEntityListing**](PermissionCollectionEntityListing.html) get_authorization_permissions(opts)
+
+
Get all permissions.
Retrieve a list of all permission defined in the system.
Wraps GET /api/v2/authorization/permissions
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -207,17 +225,23 @@
<a name="get_authorization_products"></a>
## -[**OrganizationProductEntityListing**](OrganizationProductEntityListing.html) get_authorization_products
+
+
Get the list of enabled products
Gets the list of enabled products. Some example product names are: collaborateFree, collaboratePro, communicate, and engage.
Wraps GET /api/v2/authorization/products
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -260,17 +284,23 @@
<a name="get_authorization_role"></a>
## -[**DomainOrganizationRole**](DomainOrganizationRole.html) get_authorization_role(role_id)
+
+
Get a single organization role.
Get the organization role specified by its ID.
Wraps GET /api/v2/authorization/roles/{roleId}
+Requires ANY permissions:
+* authorization:role:view
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -319,17 +349,23 @@
<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)
+
+
Get an org role to default role comparison comparison
Compares any organization role to a default role id and show differences
Wraps GET /api/v2/authorization/roles/{leftRoleId}/comparedefault/{rightRoleId}
+Requires ANY permissions:
+* authorization:role:view
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -381,17 +417,23 @@
<a name="get_authorization_roles"></a>
## -[**OrganizationRoleEntityListing**](OrganizationRoleEntityListing.html) get_authorization_roles(opts)
+
+
Retrieve a list of all roles defined for the organization
Wraps GET /api/v2/authorization/roles
+Requires ANY permissions:
+* authorization:role:view
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -461,17 +503,23 @@
<a name="get_user_roles"></a>
## -[**UserAuthorization**](UserAuthorization.html) get_user_roles(user_id)
+
+
Returns a listing of roles and permissions for a user.
Wraps GET /api/v2/users/{userId}/roles
+Requires ANY permissions:
+* authorization:grant:view
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -520,17 +568,23 @@
<a name="patch_authorization_role"></a>
## -[**DomainOrganizationRole**](DomainOrganizationRole.html) patch_authorization_role(role_id, body)
+
+
Patch Organization Role for needsUpdate Field
Patch Organization Role for needsUpdate Field
Wraps PATCH /api/v2/authorization/roles/{roleId}
+Requires ANY permissions:
+* admin* role_manager* authorization:role:edit
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -582,17 +636,23 @@
<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)
+
+
Get an unsaved org role to default role comparison
Allows users to compare their existing roles in an unsaved state to its default role
Wraps POST /api/v2/authorization/roles/{leftRoleId}/comparedefault/{rightRoleId}
+Requires ANY permissions:
+* authorization:role:view
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -647,17 +707,23 @@
<a name="post_authorization_roles"></a>
## -[**DomainOrganizationRole**](DomainOrganizationRole.html) post_authorization_roles(body)
+
+
Create an organization role.
Wraps POST /api/v2/authorization/roles
+Requires ANY permissions:
+* authorization:role:add
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -706,17 +772,23 @@
<a name="post_authorization_roles_default"></a>
## -[**OrganizationRoleEntityListing**](OrganizationRoleEntityListing.html) post_authorization_roles_default(opts)
+
+
Restores all default roles
This endpoint serves several purposes. 1. It provides the org with default roles. This is important for default roles that will be added after go-live (they can retroactively add the new default-role). Note: When not using a query param of force=true, it only adds the default roles not configured for the org; it does not overwrite roles. 2. Using the query param force=true, you can restore all default roles. Note: This does not have an effect on custom roles.
Wraps POST /api/v2/authorization/roles/default
+Requires ANY permissions:
+* authorization:role:edit
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -766,17 +838,23 @@
<a name="put_authorization_role"></a>
## -[**DomainOrganizationRole**](DomainOrganizationRole.html) put_authorization_role(role_id, body)
+
+
Update an organization role.
Update
Wraps PUT /api/v2/authorization/roles/{roleId}
+Requires ANY permissions:
+* admin* role_manager* authorization:role:edit
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -828,17 +906,23 @@
<a name="put_authorization_role_users_add"></a>
## -Array<String>** put_authorization_role_users_add(role_id, body)
+
+
Sets the users for the role
Wraps PUT /api/v2/authorization/roles/{roleId}/users/add
+Requires ANY permissions:
+* authorization:grant:add
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -890,17 +974,23 @@
<a name="put_authorization_role_users_remove"></a>
## -Array<String>** put_authorization_role_users_remove(role_id, body)
+
+
Removes the users from the role
Wraps PUT /api/v2/authorization/roles/{roleId}/users/remove
+Requires ANY permissions:
+* authorization:grant:delete
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -952,17 +1042,23 @@
<a name="put_authorization_roles_default"></a>
## -[**OrganizationRoleEntityListing**](OrganizationRoleEntityListing.html) put_authorization_roles_default(body)
+
+
Restore specified default roles
Wraps PUT /api/v2/authorization/roles/default
+Requires ANY permissions:
+* authorization:role:edit
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -1011,14 +1107,20 @@
<a name="put_user_roles"></a>
## -[**UserAuthorization**](UserAuthorization.html) put_user_roles(user_id, body)
+
+
Sets the user's roles
Wraps PUT /api/v2/users/{userId}/roles
+
+Requires ANY permissions:
+
+* admin* role_manager* authorization:grant:add
### Example
~~~ruby
# load the gem