docs/UsersApi.md in purecloudplatformclientv2-34.0.0 vs docs/UsersApi.md in purecloudplatformclientv2-35.0.0
- old
+ new
@@ -64,17 +64,23 @@
<a name="delete_user"></a>
## -[**Empty**](Empty.html) delete_user(user_id)
+
+
Delete user
Wraps DELETE /api/v2/users/{userId}
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -123,17 +129,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
@@ -181,17 +193,23 @@
<a name="delete_user_routinglanguage"></a>
## - delete_user_routinglanguage(user_id, language_id)
+
+
Remove routing language from user
Wraps DELETE /api/v2/users/{userId}/routinglanguages/{languageId}
+Requires ANY permissions:
+* routing:skill:assign* admin
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -242,17 +260,23 @@
<a name="delete_user_routingskill"></a>
## - delete_user_routingskill(user_id, skill_id)
+
+
Remove routing skill from user
Wraps DELETE /api/v2/users/{userId}/routingskills/{skillId}
+Requires ANY permissions:
+* routing:skill:assign* admin
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -303,17 +327,23 @@
<a name="delete_user_station_associatedstation"></a>
## - delete_user_station_associatedstation(user_id)
+
+
Clear associated station
Wraps DELETE /api/v2/users/{userId}/station/associatedstation
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -361,17 +391,23 @@
<a name="delete_user_station_defaultstation"></a>
## - delete_user_station_defaultstation(user_id)
+
+
Clear default station
Wraps DELETE /api/v2/users/{userId}/station/defaultstation
+Requires ANY permissions:
+* telephony:plugin:all* telephony:phone:assign
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -419,17 +455,23 @@
<a name="get_fieldconfig"></a>
## -[**FieldConfig**](FieldConfig.html) get_fieldconfig(type)
+
+
Fetch field config for an entity type
Wraps GET /api/v2/fieldconfig
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -478,17 +520,23 @@
<a name="get_profiles_users"></a>
## -[**UserProfileEntityListing**](UserProfileEntityListing.html) get_profiles_users(opts)
+
+
Get a user profile listing
Wraps GET /api/v2/profiles/users
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -550,17 +598,23 @@
<a name="get_user"></a>
## -[**User**](User.html) get_user(user_id, opts)
+
+
Get user.
Wraps GET /api/v2/users/{userId}
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -615,17 +669,23 @@
<a name="get_user_adjacents"></a>
## -[**Adjacents**](Adjacents.html) get_user_adjacents(user_id, opts)
+
+
Get adjacents
Wraps GET /api/v2/users/{userId}/adjacents
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -678,17 +738,23 @@
<a name="get_user_callforwarding"></a>
## -[**CallForwarding**](CallForwarding.html) get_user_callforwarding(user_id)
+
+
Get a user's CallForwarding
Wraps GET /api/v2/users/{userId}/callforwarding
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -737,17 +803,23 @@
<a name="get_user_directreports"></a>
## -[**Array<User>**](User.html) get_user_directreports(user_id, opts)
+
+
Get direct reports
Wraps GET /api/v2/users/{userId}/directreports
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -800,17 +872,23 @@
<a name="get_user_favorites"></a>
## -[**UserEntityListing**](UserEntityListing.html) get_user_favorites(user_id, opts)
+
+
Get favorites
Wraps GET /api/v2/users/{userId}/favorites
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -869,17 +947,23 @@
<a name="get_user_geolocation"></a>
## -[**Geolocation**](Geolocation.html) get_user_geolocation(user_id, client_id)
+
+
Get a user's Geolocation
Wraps GET /api/v2/users/{userId}/geolocations/{clientId}
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -931,17 +1015,23 @@
<a name="get_user_outofoffice"></a>
## -[**OutOfOffice**](OutOfOffice.html) get_user_outofoffice(user_id)
+
+
Get a OutOfOffice
Wraps GET /api/v2/users/{userId}/outofoffice
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -990,17 +1080,23 @@
<a name="get_user_profile"></a>
## -[**UserProfile**](UserProfile.html) get_user_profile(user_id, opts)
+
+
Get user profile
Wraps GET /api/v2/users/{userId}/profile
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -1053,17 +1149,23 @@
<a name="get_user_profileskills"></a>
## -Array<String>** get_user_profileskills(user_id)
+
+
List profile skills for a user
Wraps GET /api/v2/users/{userId}/profileskills
+Requires ANY permissions:
+* directory:userProfile:view
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -1112,17 +1214,23 @@
<a name="get_user_queues"></a>
## -[**UserQueueEntityListing**](UserQueueEntityListing.html) get_user_queues(user_id, opts)
+
+
Get queues for user
Wraps GET /api/v2/users/{userId}/queues
+Requires ANY permissions:
+* routing:queue:view
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -1141,11 +1249,12 @@
user_id = "user_id_example" # String | User ID
opts = {
page_size: 25, # Integer | Page size
page_number: 1, # Integer | Page number
- joined: true # BOOLEAN | Is joined to the queue
+ joined: true, # BOOLEAN | Is joined to the queue
+ division_id: ["division_id_example"] # Array<String> | Division ID(s)
}
begin
#Get queues for user
result = api_instance.get_user_queues(user_id, opts)
@@ -1161,10 +1270,11 @@
------------- | ------------- | ------------- | -------------
**user_id** | **String**| User ID | |
**page_size** | **Integer**| Page size | [optional] [default to 25] |
**page_number** | **Integer**| Page number | [optional] [default to 1] |
**joined** | **BOOLEAN**| Is joined to the queue | [optional] [default to true] |
+ **division_id** | [**Array<String>**](String.html)| Division ID(s) | [optional] |
{: class="table table-striped"}
### Return type
@@ -1179,17 +1289,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
@@ -1238,17 +1354,23 @@
<a name="get_user_routinglanguages"></a>
## -[**UserLanguageEntityListing**](UserLanguageEntityListing.html) get_user_routinglanguages(user_id, opts)
+
+
List routing language for user
Wraps GET /api/v2/users/{userId}/routinglanguages
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -1305,17 +1427,23 @@
<a name="get_user_routingskills"></a>
## -[**UserSkillEntityListing**](UserSkillEntityListing.html) get_user_routingskills(user_id, opts)
+
+
List routing skills for user
Wraps GET /api/v2/users/{userId}/routingskills
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -1372,17 +1500,23 @@
<a name="get_user_routingstatus"></a>
## -[**RoutingStatus**](RoutingStatus.html) get_user_routingstatus(user_id)
+
+
Fetch the routing status of a user
Wraps GET /api/v2/users/{userId}/routingstatus
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -1431,17 +1565,23 @@
<a name="get_user_station"></a>
## -[**UserStations**](UserStations.html) get_user_station(user_id)
+
+
Get station information for user
Wraps GET /api/v2/users/{userId}/station
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -1490,17 +1630,23 @@
<a name="get_user_superiors"></a>
## -[**Array<User>**](User.html) get_user_superiors(user_id, opts)
+
+
Get superiors
Wraps GET /api/v2/users/{userId}/superiors
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -1553,17 +1699,23 @@
<a name="get_user_trustors"></a>
## -[**TrustorEntityListing**](TrustorEntityListing.html) get_user_trustors(user_id, opts)
+
+
List the organizations that have authorized/trusted the user.
Wraps GET /api/v2/users/{userId}/trustors
+Requires ANY permissions:
+* authorization:orgTrustor:view
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -1618,17 +1770,23 @@
<a name="get_users"></a>
## -[**UserEntityListing**](UserEntityListing.html) get_users(opts)
+
+
Get the list of available users.
Wraps GET /api/v2/users
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -1688,17 +1846,23 @@
<a name="get_users_me"></a>
## -[**UserMe**](UserMe.html) get_users_me(opts)
+
+
Get current user details.
This request is not valid when using the Client Credentials OAuth grant.
Wraps GET /api/v2/users/me
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -1748,17 +1912,23 @@
<a name="get_users_search"></a>
## -[**UsersSearchResponse**](UsersSearchResponse.html) get_users_search(q64, opts)
+
+
Search users using the q64 value returned from a previous search
Wraps GET /api/v2/users/search
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -1811,17 +1981,23 @@
<a name="patch_user"></a>
## -[**User**](User.html) patch_user(user_id, body)
+
+
Update user
Wraps PATCH /api/v2/users/{userId}
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -1873,17 +2049,23 @@
<a name="patch_user_callforwarding"></a>
## -[**CallForwarding**](CallForwarding.html) patch_user_callforwarding(user_id, body)
+
+
Patch a user's CallForwarding
Wraps PATCH /api/v2/users/{userId}/callforwarding
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -1935,17 +2117,23 @@
<a name="patch_user_geolocation"></a>
## -[**Geolocation**](Geolocation.html) patch_user_geolocation(user_id, client_id, body)
+
+
Patch a user's Geolocation
The geolocation object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the client as the user's primary geolocation source. Option 2: Provide the 'latitude' and 'longitude' values. This will enqueue an asynchronous update of the 'city', 'region', and 'country', generating a notification. A subsequent GET operation will include the new values for 'city', 'region' and 'country'. Option 3: Provide the 'city', 'region', 'country' values. Option 1 can be combined with Option 2 or Option 3. For example, update the client as primary and provide latitude and longitude values.
Wraps PATCH /api/v2/users/{userId}/geolocations/{clientId}
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -2000,17 +2188,23 @@
<a name="patch_user_queue"></a>
## -[**UserQueue**](UserQueue.html) patch_user_queue(queue_id, user_id, body)
+
+
Join or unjoin a queue for a user
Wraps PATCH /api/v2/users/{userId}/queues/{queueId}
+Requires ANY permissions:
+* routing:queue:join
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -2063,19 +2257,25 @@
<a name="patch_user_queues"></a>
-## -[**UserQueueEntityListing**](UserQueueEntityListing.html) patch_user_queues(user_id, body)
+## -[**UserQueueEntityListing**](UserQueueEntityListing.html) patch_user_queues(user_id, body, opts)
+
+
Join or unjoin a set of queues for a user
Wraps PATCH /api/v2/users/{userId}/queues
+Requires ANY permissions:
+* routing:queue:join
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -2093,14 +2293,17 @@
user_id = "user_id_example" # String | User ID
body = [PureCloud::UserQueue.new] # Array<UserQueue> | User Queues
+opts = {
+ division_id: ["division_id_example"] # Array<String> | Division ID(s)
+}
begin
#Join or unjoin a set of queues for a user
- result = api_instance.patch_user_queues(user_id, body)
+ result = api_instance.patch_user_queues(user_id, body, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->patch_user_queues: #{e}"
end
~~~
@@ -2109,10 +2312,11 @@
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**user_id** | **String**| User ID | |
**body** | [**Array<UserQueue>**](UserQueue.html)| User Queues | |
+ **division_id** | [**Array<String>**](String.html)| Division ID(s) | [optional] |
{: class="table table-striped"}
### Return type
@@ -2127,17 +2331,23 @@
<a name="patch_user_routinglanguage"></a>
## -[**UserRoutingLanguage**](UserRoutingLanguage.html) patch_user_routinglanguage(user_id, language_id, body)
+
+
Update routing language proficiency or state.
Wraps PATCH /api/v2/users/{userId}/routinglanguages/{languageId}
+Requires ANY permissions:
+* routing:skill:assign* admin
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -2192,17 +2402,23 @@
<a name="post_analytics_users_aggregates_query"></a>
## -[**PresenceQueryResponse**](PresenceQueryResponse.html) post_analytics_users_aggregates_query(body)
+
+
Query for user aggregates
Wraps POST /api/v2/analytics/users/aggregates/query
+Requires ANY permissions:
+* analytics:userAggregate:view
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -2251,17 +2467,23 @@
<a name="post_analytics_users_details_query"></a>
## -[**AnalyticsUserDetailsQueryResponse**](AnalyticsUserDetailsQueryResponse.html) post_analytics_users_details_query(body)
+
+
Query for user details
Wraps POST /api/v2/analytics/users/details/query
+Requires ANY permissions:
+* analytics:userObservation:view
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -2310,17 +2532,23 @@
<a name="post_analytics_users_observations_query"></a>
## -[**ObservationQueryResponse**](ObservationQueryResponse.html) post_analytics_users_observations_query(body)
+
+
Query for user observations
Wraps POST /api/v2/analytics/users/observations/query
+Requires ANY permissions:
+* analytics:userObservation:view
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -2369,17 +2597,23 @@
<a name="post_user_invite"></a>
## - post_user_invite(user_id, opts)
+
+
Send an activation email to the user
Wraps POST /api/v2/users/{userId}/invite
+Requires ANY permissions:
+* directory:user:add* user_manager* user_administration
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -2431,17 +2665,23 @@
<a name="post_user_password"></a>
## - post_user_password(user_id, body)
+
+
Change a users password
Wraps POST /api/v2/users/{userId}/password
+Requires ANY permissions:
+* user_administration* directory:userPassword:edit
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -2492,17 +2732,23 @@
<a name="post_user_routinglanguages"></a>
## -[**UserRoutingLanguage**](UserRoutingLanguage.html) post_user_routinglanguages(user_id, body)
+
+
Add routing language to user
Wraps POST /api/v2/users/{userId}/routinglanguages
+Requires ANY permissions:
+* routing:skill:assign* admin
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -2554,17 +2800,23 @@
<a name="post_user_routingskills"></a>
## -[**UserRoutingSkill**](UserRoutingSkill.html) post_user_routingskills(user_id, body)
+
+
Add routing skill to user
Wraps POST /api/v2/users/{userId}/routingskills
+Requires ANY permissions:
+* routing:skill:assign* admin
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -2616,17 +2868,23 @@
<a name="post_users"></a>
## -[**User**](User.html) post_users(body)
+
+
Create user
Wraps POST /api/v2/users
+Requires ANY permissions:
+* directory:user:add
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -2675,17 +2933,23 @@
<a name="post_users_me_password"></a>
## - post_users_me_password(body)
+
+
Change your password
Wraps POST /api/v2/users/me/password
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -2733,17 +2997,23 @@
<a name="post_users_search"></a>
## -[**UsersSearchResponse**](UsersSearchResponse.html) post_users_search(body)
+
+
Search users
Wraps POST /api/v2/users/search
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -2792,17 +3062,23 @@
<a name="put_user_callforwarding"></a>
## -[**CallForwarding**](CallForwarding.html) put_user_callforwarding(user_id, body)
+
+
Update a user's CallForwarding
Wraps PUT /api/v2/users/{userId}/callforwarding
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -2854,17 +3130,23 @@
<a name="put_user_outofoffice"></a>
## -[**OutOfOffice**](OutOfOffice.html) put_user_outofoffice(user_id, body)
+
+
Update an OutOfOffice
Wraps PUT /api/v2/users/{userId}/outofoffice
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -2916,17 +3198,23 @@
<a name="put_user_profileskills"></a>
## -Array<String>** put_user_profileskills(user_id, opts)
+
+
Update profile skills for a user
Wraps PUT /api/v2/users/{userId}/profileskills
+Requires ANY permissions:
+* directory:userProfile:edit* admin* user_manager* user_administration
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -2979,17 +3267,23 @@
<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
require 'purecloudplatformclientv2'
# setup authorization
@@ -3041,17 +3335,23 @@
<a name="put_user_routingskill"></a>
## -[**UserRoutingSkill**](UserRoutingSkill.html) put_user_routingskill(user_id, skill_id, body)
+
+
Update routing skill proficiency or state.
Wraps PUT /api/v2/users/{userId}/routingskills/{skillId}
+Requires ANY permissions:
+* routing:skill:assign* admin
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -3106,17 +3406,23 @@
<a name="put_user_routingstatus"></a>
## -[**RoutingStatus**](RoutingStatus.html) put_user_routingstatus(user_id, body)
+
+
Update the routing status of a user
Wraps PUT /api/v2/users/{userId}/routingstatus
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -3168,17 +3474,23 @@
<a name="put_user_station_associatedstation_station_id"></a>
## - put_user_station_associatedstation_station_id(user_id, station_id)
+
+
Set associated station
Wraps PUT /api/v2/users/{userId}/station/associatedstation/{stationId}
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -3229,14 +3541,20 @@
<a name="put_user_station_defaultstation_station_id"></a>
## - put_user_station_defaultstation_station_id(user_id, station_id)
+
+
Set default station
Wraps PUT /api/v2/users/{userId}/station/defaultstation/{stationId}
+
+Requires ANY permissions:
+
+* telephony:plugin:all* telephony:phone:assign
### Example
~~~ruby
# load the gem