doc_out/AuthorizationApi.html.md in purecloud-0.67.1 vs doc_out/AuthorizationApi.html.md in purecloud-0.68.1

- old
+ new

@@ -4,39 +4,42 @@ ## PureCloud::AuthorizationApi All URIs are relative to *https://api.mypurecloud.com* -Method | HTTP request | Description +Method | Description ------------- | ------------- | ------------- -|[**delete_roles_role_id**](AuthorizationApi.html#delete_roles_role_id) | **DELETE** /api/v2/authorization/roles/{roleId} | Delete an organization role.| -|[**delete_user_id_roles**](AuthorizationApi.html#delete_user_id_roles) | **DELETE** /api/v2/users/{userId}/roles | Removes all the roles from the user.| -|[**get_permissions**](AuthorizationApi.html#get_permissions) | **GET** /api/v2/authorization/permissions | Get all permissions.| -|[**get_products**](AuthorizationApi.html#get_products) | **GET** /api/v2/authorization/products | Get the list of enabled products| -|[**get_roles**](AuthorizationApi.html#get_roles) | **GET** /api/v2/authorization/roles | Retrieve a list of all roles defined for the organization| -|[**get_roles_leftrole_id_comparedefault_rightrole_id**](AuthorizationApi.html#get_roles_leftrole_id_comparedefault_rightrole_id) | **GET** /api/v2/authorization/roles/{leftRoleId}/comparedefault/{rightRoleId} | Get an org role to default role comparison comparison| -|[**get_roles_role_id**](AuthorizationApi.html#get_roles_role_id) | **GET** /api/v2/authorization/roles/{roleId} | Get a single organization role.| -|[**get_user_id_roles**](AuthorizationApi.html#get_user_id_roles) | **GET** /api/v2/users/{userId}/roles | Returns a listing of roles and permissions for a user.| -|[**patch_roles_role_id**](AuthorizationApi.html#patch_roles_role_id) | **PATCH** /api/v2/authorization/roles/{roleId} | Patch Organization Role for needsUpdate Field| -|[**post_roles**](AuthorizationApi.html#post_roles) | **POST** /api/v2/authorization/roles | Create an organization role.| -|[**post_roles_default**](AuthorizationApi.html#post_roles_default) | **POST** /api/v2/authorization/roles/default | Restores all default roles| -|[**post_roles_leftrole_id_comparedefault_rightrole_id**](AuthorizationApi.html#post_roles_leftrole_id_comparedefault_rightrole_id) | **POST** /api/v2/authorization/roles/{leftRoleId}/comparedefault/{rightRoleId} | Get an unsaved org role to default role comparison| -|[**put_roles_default**](AuthorizationApi.html#put_roles_default) | **PUT** /api/v2/authorization/roles/default | Restore specified default roles| -|[**put_roles_role_id**](AuthorizationApi.html#put_roles_role_id) | **PUT** /api/v2/authorization/roles/{roleId} | Update an organization role.| -|[**put_roles_role_id_users_add**](AuthorizationApi.html#put_roles_role_id_users_add) | **PUT** /api/v2/authorization/roles/{roleId}/users/add | Sets the users for the role| -|[**put_roles_role_id_users_remove**](AuthorizationApi.html#put_roles_role_id_users_remove) | **PUT** /api/v2/authorization/roles/{roleId}/users/remove | Removes the users from the role| -|[**put_user_id_roles**](AuthorizationApi.html#put_user_id_roles) | **PUT** /api/v2/users/{userId}/roles | Sets the user&#39;s roles| +[**delete_roles_role_id**](AuthorizationApi.html#delete_roles_role_id) | Delete an organization role. +[**delete_user_id_roles**](AuthorizationApi.html#delete_user_id_roles) | Removes all the roles from the user. +[**get_permissions**](AuthorizationApi.html#get_permissions) | Get all permissions. +[**get_products**](AuthorizationApi.html#get_products) | Get the list of enabled products +[**get_roles**](AuthorizationApi.html#get_roles) | Retrieve a list of all roles defined for the organization +[**get_roles_leftrole_id_comparedefault_rightrole_id**](AuthorizationApi.html#get_roles_leftrole_id_comparedefault_rightrole_id) | Get an org role to default role comparison comparison +[**get_roles_role_id**](AuthorizationApi.html#get_roles_role_id) | Get a single organization role. +[**get_user_id_roles**](AuthorizationApi.html#get_user_id_roles) | Returns a listing of roles and permissions for a user. +[**patch_roles_role_id**](AuthorizationApi.html#patch_roles_role_id) | Patch Organization Role for needsUpdate Field +[**post_roles**](AuthorizationApi.html#post_roles) | Create an organization role. +[**post_roles_default**](AuthorizationApi.html#post_roles_default) | Restores all default roles +[**post_roles_leftrole_id_comparedefault_rightrole_id**](AuthorizationApi.html#post_roles_leftrole_id_comparedefault_rightrole_id) | Get an unsaved org role to default role comparison +[**put_roles_default**](AuthorizationApi.html#put_roles_default) | Restore specified default roles +[**put_roles_role_id**](AuthorizationApi.html#put_roles_role_id) | Update an organization role. +[**put_roles_role_id_users_add**](AuthorizationApi.html#put_roles_role_id_users_add) | Sets the users for the role +[**put_roles_role_id_users_remove**](AuthorizationApi.html#put_roles_role_id_users_remove) | Removes the users from the role +[**put_user_id_roles**](AuthorizationApi.html#put_user_id_roles) | Sets the user&#39;s roles {: class="table table-striped"} <a name="delete_roles_role_id"></a> ## - delete_roles_role_id(role_id) Delete an organization role. +Wraps DELETE /api/v2/authorization/roles/{roleId} + + ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @@ -88,10 +91,13 @@ Removes all the roles from the user. +Wraps DELETE /api/v2/users/{userId}/roles + + ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @@ -143,10 +149,13 @@ Get all permissions. Retrieve a list of all permission defined in the system. +Wraps GET /api/v2/authorization/permissions + + ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @@ -202,10 +211,13 @@ 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 + + ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @@ -252,10 +264,13 @@ Retrieve a list of all roles defined for the organization +Wraps GET /api/v2/authorization/roles + + ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @@ -323,10 +338,13 @@ 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} + + ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @@ -382,10 +400,13 @@ Get a single organization role. Get the organization role specified by its ID. +Wraps GET /api/v2/authorization/roles/{roleId} + + ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @@ -438,10 +459,13 @@ Returns a listing of roles and permissions for a user. +Wraps GET /api/v2/users/{userId}/roles + + ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @@ -494,10 +518,13 @@ Patch Organization Role for needsUpdate Field Patch Organization Role for needsUpdate Field +Wraps PATCH /api/v2/authorization/roles/{roleId} + + ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @@ -553,10 +580,13 @@ Create an organization role. +Wraps POST /api/v2/authorization/roles + + ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @@ -609,10 +639,13 @@ 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 + + ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @@ -666,10 +699,13 @@ 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} + + ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @@ -728,10 +764,13 @@ Restore specified default roles +Wraps PUT /api/v2/authorization/roles/default + + ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @@ -784,10 +823,13 @@ Update an organization role. Update +Wraps PUT /api/v2/authorization/roles/{roleId} + + ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @@ -843,10 +885,13 @@ Sets the users for the role +Wraps PUT /api/v2/authorization/roles/{roleId}/users/add + + ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @@ -902,10 +947,13 @@ Removes the users from the role +Wraps PUT /api/v2/authorization/roles/{roleId}/users/remove + + ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @@ -959,9 +1007,12 @@ ## -[**UserAuthorization**](UserAuthorization.html) put_user_id_roles(user_id, body) Sets the user's roles + + +Wraps PUT /api/v2/users/{userId}/roles ### Example ~~~ruby # load the gem