docs/UsersApi.md in purecloudplatformclientv2-68.0.0 vs docs/UsersApi.md in purecloudplatformclientv2-69.0.0

- old
+ new

@@ -8,11 +8,10 @@ Method | Description ------------- | ------------- | ------------- [**delete_authorization_subject_division_role**](UsersApi.html#delete_authorization_subject_division_role) | Delete a grant of a role in a division [**delete_user**](UsersApi.html#delete_user) | Delete user -[**delete_user_externalid_authority_name_external_key**](UsersApi.html#delete_user_externalid_authority_name_external_key) | Delete the external identifier for user. [**delete_user_roles**](UsersApi.html#delete_user_roles) | Removes all the roles from the user. [**delete_user_routinglanguage**](UsersApi.html#delete_user_routinglanguage) | Remove routing language from user [**delete_user_routingskill**](UsersApi.html#delete_user_routingskill) | Remove routing skill from user [**delete_user_station_associatedstation**](UsersApi.html#delete_user_station_associatedstation) | Clear associated station [**delete_user_station_defaultstation**](UsersApi.html#delete_user_station_defaultstation) | Clear default station @@ -24,12 +23,10 @@ [**get_profiles_users**](UsersApi.html#get_profiles_users) | Get a user profile listing [**get_user**](UsersApi.html#get_user) | Get user. [**get_user_adjacents**](UsersApi.html#get_user_adjacents) | Get adjacents [**get_user_callforwarding**](UsersApi.html#get_user_callforwarding) | Get a user&#39;s CallForwarding [**get_user_directreports**](UsersApi.html#get_user_directreports) | Get direct reports -[**get_user_externalid**](UsersApi.html#get_user_externalid) | Get the external identifiers for a user. -[**get_user_externalid_authority_name**](UsersApi.html#get_user_externalid_authority_name) | Get the external identifier of user for an authority. [**get_user_favorites**](UsersApi.html#get_user_favorites) | Get favorites [**get_user_geolocation**](UsersApi.html#get_user_geolocation) | Get a user&#39;s Geolocation [**get_user_outofoffice**](UsersApi.html#get_user_outofoffice) | Get a OutOfOffice [**get_user_profile**](UsersApi.html#get_user_profile) | Get user profile [**get_user_profileskills**](UsersApi.html#get_user_profileskills) | List profile skills for a user @@ -40,11 +37,10 @@ [**get_user_routingstatus**](UsersApi.html#get_user_routingstatus) | Fetch the routing status of a user [**get_user_station**](UsersApi.html#get_user_station) | Get station information for user [**get_user_superiors**](UsersApi.html#get_user_superiors) | Get superiors [**get_user_trustors**](UsersApi.html#get_user_trustors) | List the organizations that have authorized/trusted the user. [**get_users**](UsersApi.html#get_users) | Get the list of available users. -[**get_users_externalid_authority_name_external_key**](UsersApi.html#get_users_externalid_authority_name_external_key) | Get the user associated with external identifier. [**get_users_me**](UsersApi.html#get_users_me) | Get current user details. [**get_users_search**](UsersApi.html#get_users_search) | Search users using the q64 value returned from a previous search [**patch_user**](UsersApi.html#patch_user) | Update user [**patch_user_callforwarding**](UsersApi.html#patch_user_callforwarding) | Patch a user&#39;s CallForwarding [**patch_user_geolocation**](UsersApi.html#patch_user_geolocation) | Patch a user&#39;s Geolocation @@ -58,11 +54,10 @@ [**post_analytics_users_details_query**](UsersApi.html#post_analytics_users_details_query) | Query for user details [**post_analytics_users_observations_query**](UsersApi.html#post_analytics_users_observations_query) | Query for user observations [**post_authorization_subject_bulkadd**](UsersApi.html#post_authorization_subject_bulkadd) | Bulk-grant roles and divisions to a subject. [**post_authorization_subject_bulkremove**](UsersApi.html#post_authorization_subject_bulkremove) | Bulk-remove grants from a subject. [**post_authorization_subject_division_role**](UsersApi.html#post_authorization_subject_division_role) | Make a grant of a role in a division -[**post_user_externalid**](UsersApi.html#post_user_externalid) | Create mapping between external identifier and user. Limit 100 per entity. [**post_user_invite**](UsersApi.html#post_user_invite) | Send an activation email to the user [**post_user_password**](UsersApi.html#post_user_password) | Change a users password [**post_user_routinglanguages**](UsersApi.html#post_user_routinglanguages) | Add routing language to user [**post_user_routingskills**](UsersApi.html#post_user_routingskills) | Add routing skill to user [**post_users**](UsersApi.html#post_users) | Create user @@ -212,80 +207,10 @@ - **Content-Type**: application/json - **Accept**: application/json -<a name="delete_user_externalid_authority_name_external_key"></a> - -## delete_user_externalid_authority_name_external_key(user_id, authority_name, external_key) - - - -Delete the external identifier for user. - - - -Wraps DELETE /api/v2/users/{userId}/externalid/{authorityName}/{externalKey} - -Requires ANY permissions: - -* directory:user:edit - - -### Example -```{"language":"ruby"} -# load the gem -require 'purecloudplatformclientv2' -# 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::UsersApi.new - -user_id = "user_id_example" # String | User ID - -authority_name = "authority_name_example" # String | Authority Name - -external_key = "external_key_example" # String | External Key - - -begin - #Delete the external identifier for user. - api_instance.delete_user_externalid_authority_name_external_key(user_id, authority_name, external_key) -rescue PureCloud::ApiError => e - puts "Exception when calling UsersApi->delete_user_externalid_authority_name_external_key: #{e}" -end -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **user_id** | **String**| User ID | | - **authority_name** | **String**| Authority Name | | - **external_key** | **String**| External Key | | -{: class="table table-striped"} - - -### Return type - -nil (empty response body) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - - <a name="delete_user_roles"></a> ## delete_user_roles(user_id) @@ -1280,141 +1205,10 @@ - **Content-Type**: application/json - **Accept**: application/json -<a name="get_user_externalid"></a> - -## [**Array&lt;UserExternalIdentifier&gt;**](UserExternalIdentifier.html) get_user_externalid(user_id) - - - -Get the external identifiers for a user. - - - -Wraps GET /api/v2/users/{userId}/externalid - -Requires NO permissions: - - - -### Example -```{"language":"ruby"} -# load the gem -require 'purecloudplatformclientv2' -# 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::UsersApi.new - -user_id = "user_id_example" # String | User ID - - -begin - #Get the external identifiers for a user. - result = api_instance.get_user_externalid(user_id) - p result -rescue PureCloud::ApiError => e - puts "Exception when calling UsersApi->get_user_externalid: #{e}" -end -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **user_id** | **String**| User ID | | -{: class="table table-striped"} - - -### Return type - -[**Array&lt;UserExternalIdentifier&gt;**](UserExternalIdentifier.html) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - - -<a name="get_user_externalid_authority_name"></a> - -## [**UserExternalIdentifier**](UserExternalIdentifier.html) get_user_externalid_authority_name(user_id, authority_name) - - - -Get the external identifier of user for an authority. - -Authority name and external key are case sensitive. - -Wraps GET /api/v2/users/{userId}/externalid/{authorityName} - -Requires NO permissions: - - - -### Example -```{"language":"ruby"} -# load the gem -require 'purecloudplatformclientv2' -# 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::UsersApi.new - -user_id = "user_id_example" # String | User ID - -authority_name = "authority_name_example" # String | Authority Name - - -begin - #Get the external identifier of user for an authority. - result = api_instance.get_user_externalid_authority_name(user_id, authority_name) - p result -rescue PureCloud::ApiError => e - puts "Exception when calling UsersApi->get_user_externalid_authority_name: #{e}" -end -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **user_id** | **String**| User ID | | - **authority_name** | **String**| Authority Name | | -{: class="table table-striped"} - - -### Return type - -[**UserExternalIdentifier**](UserExternalIdentifier.html) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - - <a name="get_user_favorites"></a> ## [**UserEntityListing**](UserEntityListing.html) get_user_favorites(user_id, opts) @@ -2378,81 +2172,10 @@ - **Content-Type**: application/json - **Accept**: application/json -<a name="get_users_externalid_authority_name_external_key"></a> - -## [**User**](User.html) get_users_externalid_authority_name_external_key(authority_name, external_key, opts) - - - -Get the user associated with external identifier. - -Authority name and external key are case sensitive. - -Wraps GET /api/v2/users/externalid/{authorityName}/{externalKey} - -Requires NO permissions: - - - -### Example -```{"language":"ruby"} -# load the gem -require 'purecloudplatformclientv2' -# 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::UsersApi.new - -authority_name = "authority_name_example" # String | Authority Name - -external_key = "external_key_example" # String | External Key - -opts = { - expand: ["expand_example"] # Array<String> | Which fields, if any, to expand -} - -begin - #Get the user associated with external identifier. - result = api_instance.get_users_externalid_authority_name_external_key(authority_name, external_key, opts) - p result -rescue PureCloud::ApiError => e - puts "Exception when calling UsersApi->get_users_externalid_authority_name_external_key: #{e}" -end -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **authority_name** | **String**| Authority Name | | - **external_key** | **String**| External Key | | - **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, authorization.unusedRoles, profileSkills, certifications, locations, groups, skills, languages, languagePreference, employerInfo, biography | -{: class="table table-striped"} - - -### Return type - -[**User**](User.html) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - - <a name="get_users_me"></a> ## [**UserMe**](UserMe.html) get_users_me(opts) @@ -3604,77 +3327,9 @@ ### Return type nil (empty response body) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - - -<a name="post_user_externalid"></a> - -## [**Array&lt;UserExternalIdentifier&gt;**](UserExternalIdentifier.html) post_user_externalid(user_id, body) - - - -Create mapping between external identifier and user. Limit 100 per entity. - -Authority Name and External key are case sensitive. - -Wraps POST /api/v2/users/{userId}/externalid - -Requires ANY permissions: - -* directory:user:edit - - -### Example -```{"language":"ruby"} -# load the gem -require 'purecloudplatformclientv2' -# 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::UsersApi.new - -user_id = "user_id_example" # String | User ID - -body = PureCloud::UserExternalIdentifier.new # UserExternalIdentifier | - - -begin - #Create mapping between external identifier and user. Limit 100 per entity. - result = api_instance.post_user_externalid(user_id, body) - p result -rescue PureCloud::ApiError => e - puts "Exception when calling UsersApi->post_user_externalid: #{e}" -end -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **user_id** | **String**| User ID | | - **body** | [**UserExternalIdentifier**](UserExternalIdentifier.html)| | | -{: class="table table-striped"} - - -### Return type - -[**Array&lt;UserExternalIdentifier&gt;**](UserExternalIdentifier.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json