{ "opencollection": "1.0.0", "info": { "name": "PureCloud Platform Agent Assistants Organization Authorization API", "version": "v2" }, "items": [ { "info": { "name": "Organization Authorization", "type": "folder" }, "items": [ { "info": { "name": "Get Org Trustee Audits", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/orgauthorization/trustees/audits", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" } ] }, "docs": "Get Org Trustee Audits" }, { "info": { "name": "Get Customer Care organization ids.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/orgauthorization/trustees/care" }, "docs": "Get Customer Care organization ids." }, { "info": { "name": "Create a new organization authorization trust with Customer Care. This is required to grant your regional Customer Care organization access to your organization.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/orgauthorization/trustees/care", "params": [ { "name": "assignDefaultRole", "value": "", "type": "query", "description": "Assign Admin role to default pairing with Customer Care" }, { "name": "autoExpire", "value": "", "type": "query", "description": "Automatically expire pairing after 30 days" }, { "name": "assignFullAccess", "value": "", "type": "query", "description": "Grant Customer Care full access to the organization" }, { "name": "allowTrustedUserAccess", "value": "", "type": "query", "description": "Make Customer Care a Trusted User" } ] }, "docs": "Create a new organization authorization trust with Customer Care. This is required to grant your regional Customer Care organization access to your organization." }, { "info": { "name": "Get Cloned User", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/orgauthorization/trustors/:trustorOrgId/clonedusers/:trusteeUserId", "params": [ { "name": "trustorOrgId", "value": "", "type": "path", "description": "Trustor Organization Id" }, { "name": "trusteeUserId", "value": "", "type": "path", "description": "Trustee User Id" } ] }, "docs": "Get Cloned User" }, { "info": { "name": "Creates a clone of the trustee user in the trustor org.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/orgauthorization/trustors/:trustorOrgId/clonedusers/:trusteeUserId", "params": [ { "name": "trustorOrgId", "value": "", "type": "path", "description": "Trustor Organization Id" }, { "name": "trusteeUserId", "value": "", "type": "path", "description": "Trustee User Id" } ] }, "docs": "Creates a clone of the trustee user in the trustor org." }, { "info": { "name": "Delete Cloned User", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/orgauthorization/trustors/:trustorOrgId/clonedusers/:trusteeUserId", "params": [ { "name": "trustorOrgId", "value": "", "type": "path", "description": "Trustor Organization Id" }, { "name": "trusteeUserId", "value": "", "type": "path", "description": "Trustee User Id" } ] }, "docs": "Delete Cloned User" }, { "info": { "name": "The list of cloned users in the trustor organization (i.e. users with a native user record).", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/orgauthorization/trustors/:trustorOrgId/clonedusers", "params": [ { "name": "trustorOrgId", "value": "", "type": "path", "description": "Trustor Organization Id" } ] }, "docs": "The list of cloned users in the trustor organization (i.e. users with a native user record)." }, { "info": { "name": "Get organization authorization trust with Customer Care, if one exists.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/orgauthorization/trustees/default" }, "docs": "Get organization authorization trust with Customer Care, if one exists." }, { "info": { "name": "Create a new organization authorization trust with Customer Care. This is required to grant your regional Customer Care organization access to your organization.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/orgauthorization/trustees/default", "params": [ { "name": "assignDefaultRole", "value": "", "type": "query", "description": "Assign Admin role to default pairing with Customer Care" }, { "name": "autoExpire", "value": "", "type": "query", "description": "Automatically expire pairing after 30 days" } ] }, "docs": "Create a new organization authorization trust with Customer Care. This is required to grant your regional Customer Care organization access to your organization." }, { "info": { "name": "Get Pairing Info", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/orgauthorization/pairings/:pairingId", "params": [ { "name": "pairingId", "value": "", "type": "path", "description": "Pairing Id" } ] }, "docs": "Get Pairing Info" }, { "info": { "name": "A pairing id is created by the trustee and given to the trustor to create a trust.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/orgauthorization/pairings" }, "docs": "A pairing id is created by the trustee and given to the trustor to create a trust." }, { "info": { "name": "Get Trustee Group", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/orgauthorization/trustees/:trusteeOrgId/groups/:trusteeGroupId", "params": [ { "name": "trusteeOrgId", "value": "", "type": "path", "description": "Trustee Organization Id" }, { "name": "trusteeGroupId", "value": "", "type": "path", "description": "Trustee Group Id" } ] }, "docs": "Get Trustee Group" }, { "info": { "name": "Delete Trustee Group", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/orgauthorization/trustees/:trusteeOrgId/groups/:trusteeGroupId", "params": [ { "name": "trusteeOrgId", "value": "", "type": "path", "description": "Trustee Organization Id" }, { "name": "trusteeGroupId", "value": "", "type": "path", "description": "Trustee Group Id" } ] }, "docs": "Delete Trustee Group" }, { "info": { "name": "Update Trustee Group Roles", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/orgauthorization/trustees/:trusteeOrgId/groups/:trusteeGroupId/roledivisions", "params": [ { "name": "trusteeOrgId", "value": "", "type": "path", "description": "Trustee Organization Id" }, { "name": "trusteeGroupId", "value": "", "type": "path", "description": "Trustee Group Id" } ] }, "docs": "Update Trustee Group Roles" }, { "info": { "name": "Get Trustee Group Roles", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/orgauthorization/trustees/:trusteeOrgId/groups/:trusteeGroupId/roles", "params": [ { "name": "trusteeOrgId", "value": "", "type": "path", "description": "Trustee Organization Id" }, { "name": "trusteeGroupId", "value": "", "type": "path", "description": "Trustee Group Id" } ] }, "docs": "Get Trustee Group Roles" }, { "info": { "name": "Update Trustee Group Roles", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/orgauthorization/trustees/:trusteeOrgId/groups/:trusteeGroupId/roles", "params": [ { "name": "trusteeOrgId", "value": "", "type": "path", "description": "Trustee Organization Id" }, { "name": "trusteeGroupId", "value": "", "type": "path", "description": "Trustee Group Id" } ] }, "docs": "Update Trustee Group Roles" }, { "info": { "name": "Delete Trustee Group Roles", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/orgauthorization/trustees/:trusteeOrgId/groups/:trusteeGroupId/roles", "params": [ { "name": "trusteeOrgId", "value": "", "type": "path", "description": "Trustee Organization Id" }, { "name": "trusteeGroupId", "value": "", "type": "path", "description": "Trustee Group Id" } ] }, "docs": "Delete Trustee Group Roles" }, { "info": { "name": "The list of trustee groups for this organization (i.e. groups granted access to this organization).", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/orgauthorization/trustees/:trusteeOrgId/groups", "params": [ { "name": "trusteeOrgId", "value": "", "type": "path", "description": "Trustee Organization Id" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" } ] }, "docs": "The list of trustee groups for this organization (i.e. groups granted access to this organization)." }, { "info": { "name": "Add a group to the trust.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/orgauthorization/trustees/:trusteeOrgId/groups", "params": [ { "name": "trusteeOrgId", "value": "", "type": "path", "description": "Trustee Organization Id" } ] }, "docs": "Add a group to the trust." }, { "info": { "name": "Get Org Trust", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/orgauthorization/trustees/:trusteeOrgId", "params": [ { "name": "trusteeOrgId", "value": "", "type": "path", "description": "Trustee Organization Id" } ] }, "docs": "Get Org Trust" }, { "info": { "name": "Update Org Trust", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/orgauthorization/trustees/:trusteeOrgId", "params": [ { "name": "trusteeOrgId", "value": "", "type": "path", "description": "Trustee Organization Id" } ] }, "docs": "Update Org Trust" }, { "info": { "name": "Delete Org Trust", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/orgauthorization/trustees/:trusteeOrgId", "params": [ { "name": "trusteeOrgId", "value": "", "type": "path", "description": "Trustee Organization Id" } ] }, "docs": "Delete Org Trust" }, { "info": { "name": "Get Trustee User", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/orgauthorization/trustees/:trusteeOrgId/users/:trusteeUserId", "params": [ { "name": "trusteeOrgId", "value": "", "type": "path", "description": "Trustee Organization Id" }, { "name": "trusteeUserId", "value": "", "type": "path", "description": "Trustee User Id" } ] }, "docs": "Get Trustee User" }, { "info": { "name": "Delete Trustee User", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/orgauthorization/trustees/:trusteeOrgId/users/:trusteeUserId", "params": [ { "name": "trusteeOrgId", "value": "", "type": "path", "description": "Trustee Organization Id" }, { "name": "trusteeUserId", "value": "", "type": "path", "description": "Trustee User Id" } ] }, "docs": "Delete Trustee User" }, { "info": { "name": "Update Trustee User Roles", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/orgauthorization/trustees/:trusteeOrgId/users/:trusteeUserId/roledivisions", "params": [ { "name": "trusteeOrgId", "value": "", "type": "path", "description": "Trustee Organization Id" }, { "name": "trusteeUserId", "value": "", "type": "path", "description": "Trustee User Id" } ] }, "docs": "Update Trustee User Roles" }, { "info": { "name": "Get Trustee User Roles", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/orgauthorization/trustees/:trusteeOrgId/users/:trusteeUserId/roles", "params": [ { "name": "trusteeOrgId", "value": "", "type": "path", "description": "Trustee Organization Id" }, { "name": "trusteeUserId", "value": "", "type": "path", "description": "Trustee User Id" } ] }, "docs": "Get Trustee User Roles" }, { "info": { "name": "Update Trustee User Roles", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/orgauthorization/trustees/:trusteeOrgId/users/:trusteeUserId/roles", "params": [ { "name": "trusteeOrgId", "value": "", "type": "path", "description": "Trustee Organization Id" }, { "name": "trusteeUserId", "value": "", "type": "path", "description": "Trustee User Id" } ] }, "docs": "Update Trustee User Roles" }, { "info": { "name": "Delete Trustee User Roles", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/orgauthorization/trustees/:trusteeOrgId/users/:trusteeUserId/roles", "params": [ { "name": "trusteeOrgId", "value": "", "type": "path", "description": "Trustee Organization Id" }, { "name": "trusteeUserId", "value": "", "type": "path", "description": "Trustee User Id" } ] }, "docs": "Delete Trustee User Roles" }, { "info": { "name": "The list of trustee users for this organization (i.e. users granted access to this organization).", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/orgauthorization/trustees/:trusteeOrgId/users", "params": [ { "name": "trusteeOrgId", "value": "", "type": "path", "description": "Trustee Organization Id" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" } ] }, "docs": "The list of trustee users for this organization (i.e. users granted access to this organization)." }, { "info": { "name": "Add a user to the trust.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/orgauthorization/trustees/:trusteeOrgId/users", "params": [ { "name": "trusteeOrgId", "value": "", "type": "path", "description": "Trustee Organization Id" } ] }, "docs": "Add a user to the trust." }, { "info": { "name": "The list of cloned users from the trustee organization (i.e. users with a native user record).", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/orgauthorization/trustees/:trusteeOrgId/clonedusers", "params": [ { "name": "trusteeOrgId", "value": "", "type": "path", "description": "Trustee Organization Id" } ] }, "docs": "There can be no more than 5 cloned users per organization, so results are represented as simple list and not paged" }, { "info": { "name": "Deletes cloned user", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/orgauthorization/trustees/:trusteeOrgId/clonedusers/:trusteeUserId", "params": [ { "name": "trusteeOrgId", "value": "", "type": "path", "description": "Trustee Organization Id" }, { "name": "trusteeUserId", "value": "", "type": "path", "description": "Id of the cloned user to delete" } ] }, "docs": "Deletes cloned user" }, { "info": { "name": "Get Org Trustor Audits", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/orgauthorization/trustor/audits", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" } ] }, "docs": "Get Org Trustor Audits" }, { "info": { "name": "Get Trustee Group", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/orgauthorization/trustors/:trustorOrgId/groups/:trustorGroupId", "params": [ { "name": "trustorOrgId", "value": "", "type": "path", "description": "Trustor Organization Id" }, { "name": "trustorGroupId", "value": "", "type": "path", "description": "Trustor Group Id" } ] }, "docs": "Get Trustee Group" }, { "info": { "name": "Add a Trustee Group to the trust.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/orgauthorization/trustors/:trustorOrgId/groups/:trustorGroupId", "params": [ { "name": "trustorOrgId", "value": "", "type": "path", "description": "Trustor Organization Id" }, { "name": "trustorGroupId", "value": "", "type": "path", "description": "Trustor Group Id" } ] }, "docs": "Add a Trustee Group to the trust." }, { "info": { "name": "Delete Trustee Group", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/orgauthorization/trustors/:trustorOrgId/groups/:trustorGroupId", "params": [ { "name": "trustorOrgId", "value": "", "type": "path", "description": "Trustor Organization Id" }, { "name": "trustorGroupId", "value": "", "type": "path", "description": "Trustor Group Id" } ] }, "docs": "Delete Trustee Group" }, { "info": { "name": "The list of groups in the trustor organization (i.e. groups granted access).", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/orgauthorization/trustors/:trustorOrgId/groups", "params": [ { "name": "trustorOrgId", "value": "", "type": "path", "description": "Trustee Organization Id" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" } ] }, "docs": "The list of groups in the trustor organization (i.e. groups granted access)." }, { "info": { "name": "Get Org Trust", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/orgauthorization/trustors/:trustorOrgId", "params": [ { "name": "trustorOrgId", "value": "", "type": "path", "description": "Trustor Organization Id" } ] }, "docs": "Get Org Trust" }, { "info": { "name": "Delete Org Trust", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/orgauthorization/trustors/:trustorOrgId", "params": [ { "name": "trustorOrgId", "value": "", "type": "path", "description": "Trustor Organization Id" } ] }, "docs": "Delete Org Trust" }, { "info": { "name": "Get Trustee User", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/orgauthorization/trustors/:trustorOrgId/users/:trusteeUserId", "params": [ { "name": "trustorOrgId", "value": "", "type": "path", "description": "Trustor Organization Id" }, { "name": "trusteeUserId", "value": "", "type": "path", "description": "Trustee User Id" } ] }, "docs": "Get Trustee User" }, { "info": { "name": "Add a Trustee user to the trust.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/orgauthorization/trustors/:trustorOrgId/users/:trusteeUserId", "params": [ { "name": "trustorOrgId", "value": "", "type": "path", "description": "Trustor Organization Id" }, { "name": "trusteeUserId", "value": "", "type": "path", "description": "Trustee User Id" } ] }, "docs": "Add a Trustee user to the trust." }, { "info": { "name": "Delete Trustee User", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/orgauthorization/trustors/:trustorOrgId/users/:trusteeUserId", "params": [ { "name": "trustorOrgId", "value": "", "type": "path", "description": "Trustor Organization Id" }, { "name": "trusteeUserId", "value": "", "type": "path", "description": "Trustee User Id" } ] }, "docs": "Delete Trustee User" }, { "info": { "name": "The list of users in the trustor organization (i.e. users granted access).", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/orgauthorization/trustors/:trustorOrgId/users", "params": [ { "name": "trustorOrgId", "value": "", "type": "path", "description": "Trustee Organization Id" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" } ] }, "docs": "The list of users in the trustor organization (i.e. users granted access)." }, { "info": { "name": "The list of organizations that have authorized/trusted your organization.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/orgauthorization/trustors", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" } ] }, "docs": "The list of organizations that have authorized/trusted your organization." }, { "info": { "name": "The list of trustees for this organization (i.e. organizations granted access to this organization).", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/orgauthorization/trustees", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" } ] }, "docs": "The list of trustees for this organization (i.e. organizations granted access to this organization)." }, { "info": { "name": "Create a new organization authorization trust. This is required to grant other organizations access to your organization.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/orgauthorization/trustees" }, "docs": "Create a new organization authorization trust. This is required to grant other organizations access to your organization." } ] } ], "bundled": true }