doc_out/AuthorizationApi.html.md in purecloud-0.37.1 vs doc_out/AuthorizationApi.html.md in purecloud-0.38.1

- old
+ new

@@ -8,10 +8,11 @@ Method | HTTP request | 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_objects_object_id**](AuthorizationApi.html#get_objects_object_id) | **GET** /api/v2/authorization/objects/{objectId} | Returns a permission-protected object, showing the permission contexts it belongs to.| |[**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.| @@ -127,9 +128,65 @@ ### Return type nil (empty response body) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +<a name="get_objects_object_id"></a> + +## -[**AuthzObject**](AuthzObject.html) get_objects_object_id(object_id) + +Returns a permission-protected object, showing the permission contexts it belongs to. + + + +### Example +~~~ruby +# load the gem +require 'purecloud' +# setup authorization +@secret = ENV['PURECLOUD_SECRET'] +@id = ENV['PURECLOUD_CLIENT_ID'] +environment = "mypurecloud.com" + +@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment + +PureCloud.configure do |config| + config.access_token = @authToken +end + +api_instance = PureCloud::AuthorizationApi.new + +object_id = "object_id_example" # String | Object ID + + +begin + #Returns a permission-protected object, showing the permission contexts it belongs to. + result = api_instance.get_objects_object_id(object_id) + p result +rescue PureCloud::ApiError => e + puts "Exception when calling AuthorizationApi->get_objects_object_id: #{e}" +end +~~~ + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **object_id** | **String**| Object ID | +{: class="table table-striped"} + + +### Return type + +[**AuthzObject**](AuthzObject.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json