docs/OrganizationAuthorizationApi.md in purecloudplatformclientv2-34.0.0 vs docs/OrganizationAuthorizationApi.md in purecloudplatformclientv2-35.0.0
- old
+ new
@@ -35,17 +35,23 @@
<a name="delete_orgauthorization_trustee"></a>
## - delete_orgauthorization_trustee(trustee_org_id)
+
+
Delete Org Trust
Wraps DELETE /api/v2/orgauthorization/trustees/{trusteeOrgId}
+Requires ANY permissions:
+* authorization:orgTrustee:delete
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -93,17 +99,23 @@
<a name="delete_orgauthorization_trustee_user"></a>
## - delete_orgauthorization_trustee_user(trustee_org_id, trustee_user_id)
+
+
Delete Trustee User
Wraps DELETE /api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}
+Requires ANY permissions:
+* authorization:orgTrusteeUser:delete* admin* role_manager
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -154,17 +166,23 @@
<a name="delete_orgauthorization_trustee_user_roles"></a>
## - delete_orgauthorization_trustee_user_roles(trustee_org_id, trustee_user_id)
+
+
Delete Trustee User Roles
Wraps DELETE /api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}/roles
+Requires ANY permissions:
+* authorization:orgTrusteeUser:delete* admin* role_manager
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -215,17 +233,23 @@
<a name="delete_orgauthorization_trustor"></a>
## - delete_orgauthorization_trustor(trustor_org_id)
+
+
Delete Org Trust
Wraps DELETE /api/v2/orgauthorization/trustors/{trustorOrgId}
+Requires ANY permissions:
+* authorization:orgTrustor:delete
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -273,17 +297,23 @@
<a name="delete_orgauthorization_trustor_user"></a>
## - delete_orgauthorization_trustor_user(trustor_org_id, trustee_user_id)
+
+
Delete Trustee User
Wraps DELETE /api/v2/orgauthorization/trustors/{trustorOrgId}/users/{trusteeUserId}
+Requires ANY permissions:
+* authorization:orgTrusteeUser:delete
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -334,17 +364,23 @@
<a name="get_orgauthorization_pairing"></a>
## -[**TrustRequest**](TrustRequest.html) get_orgauthorization_pairing(pairing_id)
+
+
Get Pairing Info
Wraps GET /api/v2/orgauthorization/pairings/{pairingId}
+Requires ANY permissions:
+* authorization:orgTrustee:view* authorization:orgTrustor:view
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -393,17 +429,23 @@
<a name="get_orgauthorization_trustee"></a>
## -[**Trustee**](Trustee.html) get_orgauthorization_trustee(trustee_org_id)
+
+
Get Org Trust
Wraps GET /api/v2/orgauthorization/trustees/{trusteeOrgId}
+Requires ANY permissions:
+* authorization:orgTrustee:view
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -452,17 +494,23 @@
<a name="get_orgauthorization_trustee_user"></a>
## -[**TrustUser**](TrustUser.html) get_orgauthorization_trustee_user(trustee_org_id, trustee_user_id)
+
+
Get Trustee User
Wraps GET /api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}
+Requires ANY permissions:
+* authorization:orgTrusteeUser:view
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -514,17 +562,23 @@
<a name="get_orgauthorization_trustee_user_roles"></a>
## -[**UserAuthorization**](UserAuthorization.html) get_orgauthorization_trustee_user_roles(trustee_org_id, trustee_user_id)
+
+
Get Trustee User Roles
Wraps GET /api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}/roles
+Requires ANY permissions:
+* authorization:orgTrusteeUser:view
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -576,17 +630,23 @@
<a name="get_orgauthorization_trustee_users"></a>
## -[**TrustUserEntityListing**](TrustUserEntityListing.html) get_orgauthorization_trustee_users(trustee_org_id, opts)
+
+
The list of trustee users for this organization (i.e. users granted access to this organization).
Wraps GET /api/v2/orgauthorization/trustees/{trusteeOrgId}/users
+Requires ANY permissions:
+* authorization:orgTrusteeUser:view
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -641,17 +701,23 @@
<a name="get_orgauthorization_trustees"></a>
## -[**TrustEntityListing**](TrustEntityListing.html) get_orgauthorization_trustees(opts)
+
+
The list of trustees for this organization (i.e. organizations granted access to this organization).
Wraps GET /api/v2/orgauthorization/trustees
+Requires ANY permissions:
+* authorization:orgTrustee:view
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -703,17 +769,23 @@
<a name="get_orgauthorization_trustor"></a>
## -[**Trustor**](Trustor.html) get_orgauthorization_trustor(trustor_org_id)
+
+
Get Org Trust
Wraps GET /api/v2/orgauthorization/trustors/{trustorOrgId}
+Requires ANY permissions:
+* authorization:orgTrustor:view
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -762,17 +834,23 @@
<a name="get_orgauthorization_trustor_user"></a>
## -[**TrustUser**](TrustUser.html) get_orgauthorization_trustor_user(trustor_org_id, trustee_user_id)
+
+
Get Trustee User
Wraps GET /api/v2/orgauthorization/trustors/{trustorOrgId}/users/{trusteeUserId}
+Requires ANY permissions:
+* authorization:orgTrusteeUser:view
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -824,17 +902,23 @@
<a name="get_orgauthorization_trustor_users"></a>
## -[**TrustUserEntityListing**](TrustUserEntityListing.html) get_orgauthorization_trustor_users(trustor_org_id, opts)
+
+
The list of users in the trustor organization (i.e. users granted access).
Wraps GET /api/v2/orgauthorization/trustors/{trustorOrgId}/users
+Requires ANY permissions:
+* authorization:orgTrusteeUser:view
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -889,17 +973,23 @@
<a name="get_orgauthorization_trustors"></a>
## -[**TrustorEntityListing**](TrustorEntityListing.html) get_orgauthorization_trustors(opts)
+
+
The list of organizations that have authorized/trusted your organization.
Wraps GET /api/v2/orgauthorization/trustors
+Requires ANY permissions:
+* authorization:orgTrustor:view
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -951,17 +1041,23 @@
<a name="post_orgauthorization_pairings"></a>
## -[**TrustRequest**](TrustRequest.html) post_orgauthorization_pairings(body)
+
+
A pairing id is created by the trustee and given to the trustor to create a trust.
Wraps POST /api/v2/orgauthorization/pairings
+Requires ANY permissions:
+* authorization:orgTrustee:add
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -1010,17 +1106,23 @@
<a name="post_orgauthorization_trustee_users"></a>
## -[**TrustUser**](TrustUser.html) post_orgauthorization_trustee_users(trustee_org_id, body)
+
+
Add a user to the trust.
Wraps POST /api/v2/orgauthorization/trustees/{trusteeOrgId}/users
+Requires ALL permissions:
+* authorization:orgTrusteeUser:add* admin* role_manager
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -1072,17 +1174,23 @@
<a name="post_orgauthorization_trustees"></a>
## -[**Trustee**](Trustee.html) post_orgauthorization_trustees(body)
+
+
Create a new organization authorization trust. This is required to grant other organizations access to your organization.
Wraps POST /api/v2/orgauthorization/trustees
+Requires ALL permissions:
+* authorization:orgTrustee:add* authorization:orgTrusteeUser:add
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -1131,17 +1239,23 @@
<a name="post_orgauthorization_trustees_audits"></a>
## -[**AuditQueryResponse**](AuditQueryResponse.html) post_orgauthorization_trustees_audits(body, opts)
+
+
Get Org Trustee Audits
Wraps POST /api/v2/orgauthorization/trustees/audits
+Requires ANY permissions:
+* authorization:audit:view
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -1200,17 +1314,23 @@
<a name="post_orgauthorization_trustor_audits"></a>
## -[**AuditQueryResponse**](AuditQueryResponse.html) post_orgauthorization_trustor_audits(body, opts)
+
+
Get Org Trustor Audits
Wraps POST /api/v2/orgauthorization/trustor/audits
+Requires ANY permissions:
+* authorization:audit:view
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -1269,17 +1389,23 @@
<a name="put_orgauthorization_trustee"></a>
## -[**Trustee**](Trustee.html) put_orgauthorization_trustee(trustee_org_id, body)
+
+
Update Org Trust
Wraps PUT /api/v2/orgauthorization/trustees/{trusteeOrgId}
+Requires ANY permissions:
+* authorization:orgTrustee:edit
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -1331,17 +1457,23 @@
<a name="put_orgauthorization_trustee_user_roles"></a>
## -[**UserAuthorization**](UserAuthorization.html) put_orgauthorization_trustee_user_roles(trustee_org_id, trustee_user_id, body)
+
+
Update Trustee User Roles
Wraps PUT /api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}/roles
+Requires ANY permissions:
+* authorization:orgTrusteeUser:edit* admin* role_manager
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -1396,14 +1528,20 @@
<a name="put_orgauthorization_trustor_user"></a>
## -[**TrustUser**](TrustUser.html) put_orgauthorization_trustor_user(trustor_org_id, trustee_user_id)
+
+
Add a Trustee user to the trust.
Wraps PUT /api/v2/orgauthorization/trustors/{trustorOrgId}/users/{trusteeUserId}
+
+Requires ALL permissions:
+
+* authorization:orgTrusteeUser:add
### Example
~~~ruby
# load the gem