Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
com.mypurecloud.sdk.api.AuthorizationApi Maven / Gradle / Ivy
The official Java SDK for the PureCloud Platform API SDK
package com.mypurecloud.sdk.api;
import com.fasterxml.jackson.core.type.TypeReference;
import com.mypurecloud.sdk.ApiException;
import com.mypurecloud.sdk.ApiClient;
import com.mypurecloud.sdk.ApiResponse;
import com.mypurecloud.sdk.Configuration;
import com.mypurecloud.sdk.model.*;
import com.mypurecloud.sdk.Pair;
import com.mypurecloud.sdk.model.ErrorBody;
import com.mypurecloud.sdk.model.PermissionCollectionEntityListing;
import com.mypurecloud.sdk.model.OrganizationProductEntityListing;
import com.mypurecloud.sdk.model.OrganizationRoleEntityListing;
import com.mypurecloud.sdk.model.DomainOrgRoleDifference;
import com.mypurecloud.sdk.model.DomainOrganizationRole;
import com.mypurecloud.sdk.model.UserAuthorization;
import com.mypurecloud.sdk.model.DomainOrganizationRoleCreate;
import com.mypurecloud.sdk.model.DomainOrganizationRoleUpdate;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
public class AuthorizationApi {
private ApiClient pcapiClient;
public AuthorizationApi() {
this(Configuration.getDefaultApiClient());
}
public AuthorizationApi(ApiClient apiClient) {
this.pcapiClient = apiClient;
}
public ApiClient getApiClient() {
return pcapiClient;
}
public void setApiClient(ApiClient apiClient) {
this.pcapiClient = apiClient;
}
/**
* Delete an organization role.
*
* @param roleId Role ID (required)
* @throws ApiException if fails to make API call
*/
public void deleteRolesRoleId(String roleId) throws ApiException {
deleteRolesRoleIdWithHttpInfo(roleId);
}
/**
* Delete an organization role.
*
* @param roleId Role ID (required)
* @throws ApiException if fails to make API call
*/
public ApiResponse deleteRolesRoleIdWithHttpInfo(String roleId) throws ApiException {
Object pclocalVarPostBody = null;
// verify the required parameter 'roleId' is set
if (roleId == null) {
throw new ApiException(400, "Missing the required parameter 'roleId' when calling deleteRolesRoleId");
}
// create path and map variables
String pclocalVarPath = "/api/v2/authorization/roles/{roleId}".replaceAll("\\{format\\}","json")
.replaceAll("\\{" + "roleId" + "\\}", pcapiClient.escapeString(roleId.toString()));
// query params
List pclocalVarQueryParams = new ArrayList();
Map pclocalVarHeaderParams = new HashMap();
Map pclocalVarFormParams = new HashMap();
final String[] pclocalVarAccepts = {
"application/json"
};
final String pclocalVarAccept = pcapiClient.selectHeaderAccept(pclocalVarAccepts);
final String[] pclocalVarContentTypes = {
"application/json"
};
final String pclocalVarContentType = pcapiClient.selectHeaderContentType(pclocalVarContentTypes);
String[] pclocalVarAuthNames = new String[] { "PureCloud Auth" };
return pcapiClient.invokeAPIVerbose(pclocalVarPath, "DELETE", pclocalVarQueryParams, pclocalVarPostBody, pclocalVarHeaderParams, pclocalVarFormParams, pclocalVarAccept, pclocalVarContentType, pclocalVarAuthNames, null);
}
/**
* Removes all the roles from the user.
*
* @param userId User ID (required)
* @throws ApiException if fails to make API call
*/
public void deleteUserIdRoles(String userId) throws ApiException {
deleteUserIdRolesWithHttpInfo(userId);
}
/**
* Removes all the roles from the user.
*
* @param userId User ID (required)
* @throws ApiException if fails to make API call
*/
public ApiResponse deleteUserIdRolesWithHttpInfo(String userId) throws ApiException {
Object pclocalVarPostBody = null;
// verify the required parameter 'userId' is set
if (userId == null) {
throw new ApiException(400, "Missing the required parameter 'userId' when calling deleteUserIdRoles");
}
// create path and map variables
String pclocalVarPath = "/api/v2/users/{userId}/roles".replaceAll("\\{format\\}","json")
.replaceAll("\\{" + "userId" + "\\}", pcapiClient.escapeString(userId.toString()));
// query params
List pclocalVarQueryParams = new ArrayList();
Map pclocalVarHeaderParams = new HashMap();
Map pclocalVarFormParams = new HashMap();
final String[] pclocalVarAccepts = {
"application/json"
};
final String pclocalVarAccept = pcapiClient.selectHeaderAccept(pclocalVarAccepts);
final String[] pclocalVarContentTypes = {
"application/json"
};
final String pclocalVarContentType = pcapiClient.selectHeaderContentType(pclocalVarContentTypes);
String[] pclocalVarAuthNames = new String[] { "PureCloud Auth" };
return pcapiClient.invokeAPIVerbose(pclocalVarPath, "DELETE", pclocalVarQueryParams, pclocalVarPostBody, pclocalVarHeaderParams, pclocalVarFormParams, pclocalVarAccept, pclocalVarContentType, pclocalVarAuthNames, null);
}
/**
* Get all permissions.
* Retrieve a list of all permission defined in the system.
* @param pageSize Page size (optional, default to 25)
* @param pageNumber Page number (optional, default to 1)
* @return PermissionCollectionEntityListing
* @throws ApiException if fails to make API call
*/
public PermissionCollectionEntityListing getPermissions(Integer pageSize, Integer pageNumber) throws ApiException {
return getPermissionsWithHttpInfo(pageSize, pageNumber).getResponseObject();
}
/**
* Get all permissions.
* Retrieve a list of all permission defined in the system.
* @param pageSize Page size (optional, default to 25)
* @param pageNumber Page number (optional, default to 1)
* @return PermissionCollectionEntityListing
* @throws ApiException if fails to make API call
*/
public ApiResponse getPermissionsWithHttpInfo(Integer pageSize, Integer pageNumber) throws ApiException {
Object pclocalVarPostBody = null;
// create path and map variables
String pclocalVarPath = "/api/v2/authorization/permissions".replaceAll("\\{format\\}","json");
// query params
List pclocalVarQueryParams = new ArrayList();
Map pclocalVarHeaderParams = new HashMap();
Map pclocalVarFormParams = new HashMap();
pclocalVarQueryParams.addAll(pcapiClient.parameterToPairs("", "pageSize", pageSize));
pclocalVarQueryParams.addAll(pcapiClient.parameterToPairs("", "pageNumber", pageNumber));
final String[] pclocalVarAccepts = {
"application/json"
};
final String pclocalVarAccept = pcapiClient.selectHeaderAccept(pclocalVarAccepts);
final String[] pclocalVarContentTypes = {
"application/json"
};
final String pclocalVarContentType = pcapiClient.selectHeaderContentType(pclocalVarContentTypes);
String[] pclocalVarAuthNames = new String[] { "PureCloud Auth" };
return pcapiClient.invokeAPIVerbose(pclocalVarPath, "GET", pclocalVarQueryParams, pclocalVarPostBody, pclocalVarHeaderParams, pclocalVarFormParams, pclocalVarAccept, pclocalVarContentType, pclocalVarAuthNames, new TypeReference() {});
}
/**
* Get the list of enabled products
* Gets the list of enabled products. Some example product names are: collaborateFree, collaboratePro, communicate, and engage.
* @return OrganizationProductEntityListing
* @throws ApiException if fails to make API call
*/
public OrganizationProductEntityListing getProducts() throws ApiException {
return getProductsWithHttpInfo().getResponseObject();
}
/**
* Get the list of enabled products
* Gets the list of enabled products. Some example product names are: collaborateFree, collaboratePro, communicate, and engage.
* @return OrganizationProductEntityListing
* @throws ApiException if fails to make API call
*/
public ApiResponse getProductsWithHttpInfo() throws ApiException {
Object pclocalVarPostBody = null;
// create path and map variables
String pclocalVarPath = "/api/v2/authorization/products".replaceAll("\\{format\\}","json");
// query params
List pclocalVarQueryParams = new ArrayList();
Map pclocalVarHeaderParams = new HashMap();
Map pclocalVarFormParams = new HashMap();
final String[] pclocalVarAccepts = {
"application/json"
};
final String pclocalVarAccept = pcapiClient.selectHeaderAccept(pclocalVarAccepts);
final String[] pclocalVarContentTypes = {
"application/json"
};
final String pclocalVarContentType = pcapiClient.selectHeaderContentType(pclocalVarContentTypes);
String[] pclocalVarAuthNames = new String[] { "PureCloud Auth" };
return pcapiClient.invokeAPIVerbose(pclocalVarPath, "GET", pclocalVarQueryParams, pclocalVarPostBody, pclocalVarHeaderParams, pclocalVarFormParams, pclocalVarAccept, pclocalVarContentType, pclocalVarAuthNames, new TypeReference() {});
}
/**
* Retrieve a list of all roles defined for the organization
*
* @param pageSize The total page size requested (optional, default to 25)
* @param pageNumber The page number requested (optional, default to 1)
* @param sortBy variable name requested to sort by (optional)
* @param expand variable name requested by expand list (optional)
* @param nextPage next page token (optional)
* @param previousPage Previous page token (optional)
* @param permission (optional)
* @param userCount (optional, default to true)
* @return OrganizationRoleEntityListing
* @throws ApiException if fails to make API call
*/
public OrganizationRoleEntityListing getRoles(Integer pageSize, Integer pageNumber, String sortBy, List expand, String nextPage, String previousPage, List permission, Boolean userCount) throws ApiException {
return getRolesWithHttpInfo(pageSize, pageNumber, sortBy, expand, nextPage, previousPage, permission, userCount).getResponseObject();
}
/**
* Retrieve a list of all roles defined for the organization
*
* @param pageSize The total page size requested (optional, default to 25)
* @param pageNumber The page number requested (optional, default to 1)
* @param sortBy variable name requested to sort by (optional)
* @param expand variable name requested by expand list (optional)
* @param nextPage next page token (optional)
* @param previousPage Previous page token (optional)
* @param permission (optional)
* @param userCount (optional, default to true)
* @return OrganizationRoleEntityListing
* @throws ApiException if fails to make API call
*/
public ApiResponse getRolesWithHttpInfo(Integer pageSize, Integer pageNumber, String sortBy, List expand, String nextPage, String previousPage, List permission, Boolean userCount) throws ApiException {
Object pclocalVarPostBody = null;
// create path and map variables
String pclocalVarPath = "/api/v2/authorization/roles".replaceAll("\\{format\\}","json");
// query params
List pclocalVarQueryParams = new ArrayList();
Map pclocalVarHeaderParams = new HashMap();
Map pclocalVarFormParams = new HashMap();
pclocalVarQueryParams.addAll(pcapiClient.parameterToPairs("", "pageSize", pageSize));
pclocalVarQueryParams.addAll(pcapiClient.parameterToPairs("", "pageNumber", pageNumber));
pclocalVarQueryParams.addAll(pcapiClient.parameterToPairs("", "sortBy", sortBy));
pclocalVarQueryParams.addAll(pcapiClient.parameterToPairs("multi", "expand", expand));
pclocalVarQueryParams.addAll(pcapiClient.parameterToPairs("", "nextPage", nextPage));
pclocalVarQueryParams.addAll(pcapiClient.parameterToPairs("", "previousPage", previousPage));
pclocalVarQueryParams.addAll(pcapiClient.parameterToPairs("multi", "permission", permission));
pclocalVarQueryParams.addAll(pcapiClient.parameterToPairs("", "userCount", userCount));
final String[] pclocalVarAccepts = {
"application/json"
};
final String pclocalVarAccept = pcapiClient.selectHeaderAccept(pclocalVarAccepts);
final String[] pclocalVarContentTypes = {
"application/json"
};
final String pclocalVarContentType = pcapiClient.selectHeaderContentType(pclocalVarContentTypes);
String[] pclocalVarAuthNames = new String[] { "PureCloud Auth" };
return pcapiClient.invokeAPIVerbose(pclocalVarPath, "GET", pclocalVarQueryParams, pclocalVarPostBody, pclocalVarHeaderParams, pclocalVarFormParams, pclocalVarAccept, pclocalVarContentType, pclocalVarAuthNames, new TypeReference() {});
}
/**
* Get an org role to default role comparison comparison
* Compares any organization role to a default role id and show differences
* @param leftRoleId Left Role ID (required)
* @param rightRoleId Right Role id (required)
* @return DomainOrgRoleDifference
* @throws ApiException if fails to make API call
*/
public DomainOrgRoleDifference getRolesLeftroleIdComparedefaultRightroleId(String leftRoleId, String rightRoleId) throws ApiException {
return getRolesLeftroleIdComparedefaultRightroleIdWithHttpInfo(leftRoleId, rightRoleId).getResponseObject();
}
/**
* Get an org role to default role comparison comparison
* Compares any organization role to a default role id and show differences
* @param leftRoleId Left Role ID (required)
* @param rightRoleId Right Role id (required)
* @return DomainOrgRoleDifference
* @throws ApiException if fails to make API call
*/
public ApiResponse getRolesLeftroleIdComparedefaultRightroleIdWithHttpInfo(String leftRoleId, String rightRoleId) throws ApiException {
Object pclocalVarPostBody = null;
// verify the required parameter 'leftRoleId' is set
if (leftRoleId == null) {
throw new ApiException(400, "Missing the required parameter 'leftRoleId' when calling getRolesLeftroleIdComparedefaultRightroleId");
}
// verify the required parameter 'rightRoleId' is set
if (rightRoleId == null) {
throw new ApiException(400, "Missing the required parameter 'rightRoleId' when calling getRolesLeftroleIdComparedefaultRightroleId");
}
// create path and map variables
String pclocalVarPath = "/api/v2/authorization/roles/{leftRoleId}/comparedefault/{rightRoleId}".replaceAll("\\{format\\}","json")
.replaceAll("\\{" + "leftRoleId" + "\\}", pcapiClient.escapeString(leftRoleId.toString()))
.replaceAll("\\{" + "rightRoleId" + "\\}", pcapiClient.escapeString(rightRoleId.toString()));
// query params
List pclocalVarQueryParams = new ArrayList();
Map pclocalVarHeaderParams = new HashMap();
Map pclocalVarFormParams = new HashMap();
final String[] pclocalVarAccepts = {
"application/json"
};
final String pclocalVarAccept = pcapiClient.selectHeaderAccept(pclocalVarAccepts);
final String[] pclocalVarContentTypes = {
"application/json"
};
final String pclocalVarContentType = pcapiClient.selectHeaderContentType(pclocalVarContentTypes);
String[] pclocalVarAuthNames = new String[] { "PureCloud Auth" };
return pcapiClient.invokeAPIVerbose(pclocalVarPath, "GET", pclocalVarQueryParams, pclocalVarPostBody, pclocalVarHeaderParams, pclocalVarFormParams, pclocalVarAccept, pclocalVarContentType, pclocalVarAuthNames, new TypeReference() {});
}
/**
* Get a single organization role.
* Get the organization role specified by its ID.
* @param roleId Role ID (required)
* @return DomainOrganizationRole
* @throws ApiException if fails to make API call
*/
public DomainOrganizationRole getRolesRoleId(String roleId) throws ApiException {
return getRolesRoleIdWithHttpInfo(roleId).getResponseObject();
}
/**
* Get a single organization role.
* Get the organization role specified by its ID.
* @param roleId Role ID (required)
* @return DomainOrganizationRole
* @throws ApiException if fails to make API call
*/
public ApiResponse getRolesRoleIdWithHttpInfo(String roleId) throws ApiException {
Object pclocalVarPostBody = null;
// verify the required parameter 'roleId' is set
if (roleId == null) {
throw new ApiException(400, "Missing the required parameter 'roleId' when calling getRolesRoleId");
}
// create path and map variables
String pclocalVarPath = "/api/v2/authorization/roles/{roleId}".replaceAll("\\{format\\}","json")
.replaceAll("\\{" + "roleId" + "\\}", pcapiClient.escapeString(roleId.toString()));
// query params
List pclocalVarQueryParams = new ArrayList();
Map pclocalVarHeaderParams = new HashMap();
Map pclocalVarFormParams = new HashMap();
final String[] pclocalVarAccepts = {
"application/json"
};
final String pclocalVarAccept = pcapiClient.selectHeaderAccept(pclocalVarAccepts);
final String[] pclocalVarContentTypes = {
"application/json"
};
final String pclocalVarContentType = pcapiClient.selectHeaderContentType(pclocalVarContentTypes);
String[] pclocalVarAuthNames = new String[] { "PureCloud Auth" };
return pcapiClient.invokeAPIVerbose(pclocalVarPath, "GET", pclocalVarQueryParams, pclocalVarPostBody, pclocalVarHeaderParams, pclocalVarFormParams, pclocalVarAccept, pclocalVarContentType, pclocalVarAuthNames, new TypeReference() {});
}
/**
* Returns a listing of roles and permissions for a user.
*
* @param userId User ID (required)
* @return UserAuthorization
* @throws ApiException if fails to make API call
*/
public UserAuthorization getUserIdRoles(String userId) throws ApiException {
return getUserIdRolesWithHttpInfo(userId).getResponseObject();
}
/**
* Returns a listing of roles and permissions for a user.
*
* @param userId User ID (required)
* @return UserAuthorization
* @throws ApiException if fails to make API call
*/
public ApiResponse getUserIdRolesWithHttpInfo(String userId) throws ApiException {
Object pclocalVarPostBody = null;
// verify the required parameter 'userId' is set
if (userId == null) {
throw new ApiException(400, "Missing the required parameter 'userId' when calling getUserIdRoles");
}
// create path and map variables
String pclocalVarPath = "/api/v2/users/{userId}/roles".replaceAll("\\{format\\}","json")
.replaceAll("\\{" + "userId" + "\\}", pcapiClient.escapeString(userId.toString()));
// query params
List pclocalVarQueryParams = new ArrayList();
Map pclocalVarHeaderParams = new HashMap();
Map pclocalVarFormParams = new HashMap();
final String[] pclocalVarAccepts = {
"application/json"
};
final String pclocalVarAccept = pcapiClient.selectHeaderAccept(pclocalVarAccepts);
final String[] pclocalVarContentTypes = {
"application/json"
};
final String pclocalVarContentType = pcapiClient.selectHeaderContentType(pclocalVarContentTypes);
String[] pclocalVarAuthNames = new String[] { "PureCloud Auth" };
return pcapiClient.invokeAPIVerbose(pclocalVarPath, "GET", pclocalVarQueryParams, pclocalVarPostBody, pclocalVarHeaderParams, pclocalVarFormParams, pclocalVarAccept, pclocalVarContentType, pclocalVarAuthNames, new TypeReference() {});
}
/**
* Patch Organization Role for needsUpdate Field
* Patch Organization Role for needsUpdate Field
* @param roleId Role ID (required)
* @param body Organization role (required)
* @return DomainOrganizationRole
* @throws ApiException if fails to make API call
*/
public DomainOrganizationRole patchRolesRoleId(String roleId, DomainOrganizationRole body) throws ApiException {
return patchRolesRoleIdWithHttpInfo(roleId, body).getResponseObject();
}
/**
* Patch Organization Role for needsUpdate Field
* Patch Organization Role for needsUpdate Field
* @param roleId Role ID (required)
* @param body Organization role (required)
* @return DomainOrganizationRole
* @throws ApiException if fails to make API call
*/
public ApiResponse patchRolesRoleIdWithHttpInfo(String roleId, DomainOrganizationRole body) throws ApiException {
Object pclocalVarPostBody = body;
// verify the required parameter 'roleId' is set
if (roleId == null) {
throw new ApiException(400, "Missing the required parameter 'roleId' when calling patchRolesRoleId");
}
// verify the required parameter 'body' is set
if (body == null) {
throw new ApiException(400, "Missing the required parameter 'body' when calling patchRolesRoleId");
}
// create path and map variables
String pclocalVarPath = "/api/v2/authorization/roles/{roleId}".replaceAll("\\{format\\}","json")
.replaceAll("\\{" + "roleId" + "\\}", pcapiClient.escapeString(roleId.toString()));
// query params
List pclocalVarQueryParams = new ArrayList();
Map pclocalVarHeaderParams = new HashMap();
Map pclocalVarFormParams = new HashMap();
final String[] pclocalVarAccepts = {
"application/json"
};
final String pclocalVarAccept = pcapiClient.selectHeaderAccept(pclocalVarAccepts);
final String[] pclocalVarContentTypes = {
"application/json"
};
final String pclocalVarContentType = pcapiClient.selectHeaderContentType(pclocalVarContentTypes);
String[] pclocalVarAuthNames = new String[] { "PureCloud Auth" };
return pcapiClient.invokeAPIVerbose(pclocalVarPath, "PATCH", pclocalVarQueryParams, pclocalVarPostBody, pclocalVarHeaderParams, pclocalVarFormParams, pclocalVarAccept, pclocalVarContentType, pclocalVarAuthNames, new TypeReference() {});
}
/**
* Create an organization role.
*
* @param body Organization role (required)
* @return DomainOrganizationRole
* @throws ApiException if fails to make API call
*/
public DomainOrganizationRole postRoles(DomainOrganizationRoleCreate body) throws ApiException {
return postRolesWithHttpInfo(body).getResponseObject();
}
/**
* Create an organization role.
*
* @param body Organization role (required)
* @return DomainOrganizationRole
* @throws ApiException if fails to make API call
*/
public ApiResponse postRolesWithHttpInfo(DomainOrganizationRoleCreate body) throws ApiException {
Object pclocalVarPostBody = body;
// verify the required parameter 'body' is set
if (body == null) {
throw new ApiException(400, "Missing the required parameter 'body' when calling postRoles");
}
// create path and map variables
String pclocalVarPath = "/api/v2/authorization/roles".replaceAll("\\{format\\}","json");
// query params
List pclocalVarQueryParams = new ArrayList();
Map pclocalVarHeaderParams = new HashMap();
Map pclocalVarFormParams = new HashMap();
final String[] pclocalVarAccepts = {
"application/json"
};
final String pclocalVarAccept = pcapiClient.selectHeaderAccept(pclocalVarAccepts);
final String[] pclocalVarContentTypes = {
"application/json"
};
final String pclocalVarContentType = pcapiClient.selectHeaderContentType(pclocalVarContentTypes);
String[] pclocalVarAuthNames = new String[] { "PureCloud Auth" };
return pcapiClient.invokeAPIVerbose(pclocalVarPath, "POST", pclocalVarQueryParams, pclocalVarPostBody, pclocalVarHeaderParams, pclocalVarFormParams, pclocalVarAccept, pclocalVarContentType, pclocalVarAuthNames, new TypeReference() {});
}
/**
* Restores all default roles
* This endpoint serves several purposes. 1. It provides the org with default roles. This is important for default roles that will be added after go-live (they can retroactively add the new default-role). Note: When not using a query param of force=true, it only adds the default roles not configured for the org; it does not overwrite roles. 2. Using the query param force=true, you can restore all default roles. Note: This does not have an effect on custom roles.
* @param force Restore default roles (optional, default to false)
* @return OrganizationRoleEntityListing
* @throws ApiException if fails to make API call
*/
public OrganizationRoleEntityListing postRolesDefault(Boolean force) throws ApiException {
return postRolesDefaultWithHttpInfo(force).getResponseObject();
}
/**
* Restores all default roles
* This endpoint serves several purposes. 1. It provides the org with default roles. This is important for default roles that will be added after go-live (they can retroactively add the new default-role). Note: When not using a query param of force=true, it only adds the default roles not configured for the org; it does not overwrite roles. 2. Using the query param force=true, you can restore all default roles. Note: This does not have an effect on custom roles.
* @param force Restore default roles (optional, default to false)
* @return OrganizationRoleEntityListing
* @throws ApiException if fails to make API call
*/
public ApiResponse postRolesDefaultWithHttpInfo(Boolean force) throws ApiException {
Object pclocalVarPostBody = null;
// create path and map variables
String pclocalVarPath = "/api/v2/authorization/roles/default".replaceAll("\\{format\\}","json");
// query params
List pclocalVarQueryParams = new ArrayList();
Map pclocalVarHeaderParams = new HashMap();
Map pclocalVarFormParams = new HashMap();
pclocalVarQueryParams.addAll(pcapiClient.parameterToPairs("", "force", force));
final String[] pclocalVarAccepts = {
"application/json"
};
final String pclocalVarAccept = pcapiClient.selectHeaderAccept(pclocalVarAccepts);
final String[] pclocalVarContentTypes = {
"application/json"
};
final String pclocalVarContentType = pcapiClient.selectHeaderContentType(pclocalVarContentTypes);
String[] pclocalVarAuthNames = new String[] { "PureCloud Auth" };
return pcapiClient.invokeAPIVerbose(pclocalVarPath, "POST", pclocalVarQueryParams, pclocalVarPostBody, pclocalVarHeaderParams, pclocalVarFormParams, pclocalVarAccept, pclocalVarContentType, pclocalVarAuthNames, new TypeReference() {});
}
/**
* Get an unsaved org role to default role comparison
* Allows users to compare their existing roles in an unsaved state to its default role
* @param leftRoleId Left Role ID (required)
* @param rightRoleId Right Role id (required)
* @param body Organization role (required)
* @return DomainOrgRoleDifference
* @throws ApiException if fails to make API call
*/
public DomainOrgRoleDifference postRolesLeftroleIdComparedefaultRightroleId(String leftRoleId, String rightRoleId, DomainOrganizationRole body) throws ApiException {
return postRolesLeftroleIdComparedefaultRightroleIdWithHttpInfo(leftRoleId, rightRoleId, body).getResponseObject();
}
/**
* Get an unsaved org role to default role comparison
* Allows users to compare their existing roles in an unsaved state to its default role
* @param leftRoleId Left Role ID (required)
* @param rightRoleId Right Role id (required)
* @param body Organization role (required)
* @return DomainOrgRoleDifference
* @throws ApiException if fails to make API call
*/
public ApiResponse postRolesLeftroleIdComparedefaultRightroleIdWithHttpInfo(String leftRoleId, String rightRoleId, DomainOrganizationRole body) throws ApiException {
Object pclocalVarPostBody = body;
// verify the required parameter 'leftRoleId' is set
if (leftRoleId == null) {
throw new ApiException(400, "Missing the required parameter 'leftRoleId' when calling postRolesLeftroleIdComparedefaultRightroleId");
}
// verify the required parameter 'rightRoleId' is set
if (rightRoleId == null) {
throw new ApiException(400, "Missing the required parameter 'rightRoleId' when calling postRolesLeftroleIdComparedefaultRightroleId");
}
// verify the required parameter 'body' is set
if (body == null) {
throw new ApiException(400, "Missing the required parameter 'body' when calling postRolesLeftroleIdComparedefaultRightroleId");
}
// create path and map variables
String pclocalVarPath = "/api/v2/authorization/roles/{leftRoleId}/comparedefault/{rightRoleId}".replaceAll("\\{format\\}","json")
.replaceAll("\\{" + "leftRoleId" + "\\}", pcapiClient.escapeString(leftRoleId.toString()))
.replaceAll("\\{" + "rightRoleId" + "\\}", pcapiClient.escapeString(rightRoleId.toString()));
// query params
List pclocalVarQueryParams = new ArrayList();
Map pclocalVarHeaderParams = new HashMap();
Map pclocalVarFormParams = new HashMap();
final String[] pclocalVarAccepts = {
"application/json"
};
final String pclocalVarAccept = pcapiClient.selectHeaderAccept(pclocalVarAccepts);
final String[] pclocalVarContentTypes = {
"application/json"
};
final String pclocalVarContentType = pcapiClient.selectHeaderContentType(pclocalVarContentTypes);
String[] pclocalVarAuthNames = new String[] { "PureCloud Auth" };
return pcapiClient.invokeAPIVerbose(pclocalVarPath, "POST", pclocalVarQueryParams, pclocalVarPostBody, pclocalVarHeaderParams, pclocalVarFormParams, pclocalVarAccept, pclocalVarContentType, pclocalVarAuthNames, new TypeReference() {});
}
/**
* Restore specified default roles
*
* @param body Organization roles list (required)
* @return OrganizationRoleEntityListing
* @throws ApiException if fails to make API call
*/
public OrganizationRoleEntityListing putRolesDefault(List body) throws ApiException {
return putRolesDefaultWithHttpInfo(body).getResponseObject();
}
/**
* Restore specified default roles
*
* @param body Organization roles list (required)
* @return OrganizationRoleEntityListing
* @throws ApiException if fails to make API call
*/
public ApiResponse putRolesDefaultWithHttpInfo(List body) throws ApiException {
Object pclocalVarPostBody = body;
// verify the required parameter 'body' is set
if (body == null) {
throw new ApiException(400, "Missing the required parameter 'body' when calling putRolesDefault");
}
// create path and map variables
String pclocalVarPath = "/api/v2/authorization/roles/default".replaceAll("\\{format\\}","json");
// query params
List pclocalVarQueryParams = new ArrayList();
Map pclocalVarHeaderParams = new HashMap();
Map pclocalVarFormParams = new HashMap();
final String[] pclocalVarAccepts = {
"application/json"
};
final String pclocalVarAccept = pcapiClient.selectHeaderAccept(pclocalVarAccepts);
final String[] pclocalVarContentTypes = {
"application/json"
};
final String pclocalVarContentType = pcapiClient.selectHeaderContentType(pclocalVarContentTypes);
String[] pclocalVarAuthNames = new String[] { "PureCloud Auth" };
return pcapiClient.invokeAPIVerbose(pclocalVarPath, "PUT", pclocalVarQueryParams, pclocalVarPostBody, pclocalVarHeaderParams, pclocalVarFormParams, pclocalVarAccept, pclocalVarContentType, pclocalVarAuthNames, new TypeReference() {});
}
/**
* Update an organization role.
* Update
* @param roleId Role ID (required)
* @param body Organization role (required)
* @return DomainOrganizationRole
* @throws ApiException if fails to make API call
*/
public DomainOrganizationRole putRolesRoleId(String roleId, DomainOrganizationRoleUpdate body) throws ApiException {
return putRolesRoleIdWithHttpInfo(roleId, body).getResponseObject();
}
/**
* Update an organization role.
* Update
* @param roleId Role ID (required)
* @param body Organization role (required)
* @return DomainOrganizationRole
* @throws ApiException if fails to make API call
*/
public ApiResponse putRolesRoleIdWithHttpInfo(String roleId, DomainOrganizationRoleUpdate body) throws ApiException {
Object pclocalVarPostBody = body;
// verify the required parameter 'roleId' is set
if (roleId == null) {
throw new ApiException(400, "Missing the required parameter 'roleId' when calling putRolesRoleId");
}
// verify the required parameter 'body' is set
if (body == null) {
throw new ApiException(400, "Missing the required parameter 'body' when calling putRolesRoleId");
}
// create path and map variables
String pclocalVarPath = "/api/v2/authorization/roles/{roleId}".replaceAll("\\{format\\}","json")
.replaceAll("\\{" + "roleId" + "\\}", pcapiClient.escapeString(roleId.toString()));
// query params
List pclocalVarQueryParams = new ArrayList();
Map pclocalVarHeaderParams = new HashMap();
Map pclocalVarFormParams = new HashMap();
final String[] pclocalVarAccepts = {
"application/json"
};
final String pclocalVarAccept = pcapiClient.selectHeaderAccept(pclocalVarAccepts);
final String[] pclocalVarContentTypes = {
"application/json"
};
final String pclocalVarContentType = pcapiClient.selectHeaderContentType(pclocalVarContentTypes);
String[] pclocalVarAuthNames = new String[] { "PureCloud Auth" };
return pcapiClient.invokeAPIVerbose(pclocalVarPath, "PUT", pclocalVarQueryParams, pclocalVarPostBody, pclocalVarHeaderParams, pclocalVarFormParams, pclocalVarAccept, pclocalVarContentType, pclocalVarAuthNames, new TypeReference() {});
}
/**
* Sets the users for the role
*
* @param roleId Role ID (required)
* @param body List of user IDs (required)
* @return List
* @throws ApiException if fails to make API call
*/
public List putRolesRoleIdUsersAdd(String roleId, List body) throws ApiException {
return putRolesRoleIdUsersAddWithHttpInfo(roleId, body).getResponseObject();
}
/**
* Sets the users for the role
*
* @param roleId Role ID (required)
* @param body List of user IDs (required)
* @return List
* @throws ApiException if fails to make API call
*/
public ApiResponse> putRolesRoleIdUsersAddWithHttpInfo(String roleId, List body) throws ApiException {
Object pclocalVarPostBody = body;
// verify the required parameter 'roleId' is set
if (roleId == null) {
throw new ApiException(400, "Missing the required parameter 'roleId' when calling putRolesRoleIdUsersAdd");
}
// verify the required parameter 'body' is set
if (body == null) {
throw new ApiException(400, "Missing the required parameter 'body' when calling putRolesRoleIdUsersAdd");
}
// create path and map variables
String pclocalVarPath = "/api/v2/authorization/roles/{roleId}/users/add".replaceAll("\\{format\\}","json")
.replaceAll("\\{" + "roleId" + "\\}", pcapiClient.escapeString(roleId.toString()));
// query params
List pclocalVarQueryParams = new ArrayList();
Map pclocalVarHeaderParams = new HashMap();
Map pclocalVarFormParams = new HashMap();
final String[] pclocalVarAccepts = {
"application/json"
};
final String pclocalVarAccept = pcapiClient.selectHeaderAccept(pclocalVarAccepts);
final String[] pclocalVarContentTypes = {
"application/json"
};
final String pclocalVarContentType = pcapiClient.selectHeaderContentType(pclocalVarContentTypes);
String[] pclocalVarAuthNames = new String[] { "PureCloud Auth" };
return pcapiClient.invokeAPIVerbose(pclocalVarPath, "PUT", pclocalVarQueryParams, pclocalVarPostBody, pclocalVarHeaderParams, pclocalVarFormParams, pclocalVarAccept, pclocalVarContentType, pclocalVarAuthNames, new TypeReference>() {});
}
/**
* Removes the users from the role
*
* @param roleId Role ID (required)
* @param body List of user IDs (required)
* @return List
* @throws ApiException if fails to make API call
*/
public List putRolesRoleIdUsersRemove(String roleId, List body) throws ApiException {
return putRolesRoleIdUsersRemoveWithHttpInfo(roleId, body).getResponseObject();
}
/**
* Removes the users from the role
*
* @param roleId Role ID (required)
* @param body List of user IDs (required)
* @return List
* @throws ApiException if fails to make API call
*/
public ApiResponse> putRolesRoleIdUsersRemoveWithHttpInfo(String roleId, List body) throws ApiException {
Object pclocalVarPostBody = body;
// verify the required parameter 'roleId' is set
if (roleId == null) {
throw new ApiException(400, "Missing the required parameter 'roleId' when calling putRolesRoleIdUsersRemove");
}
// verify the required parameter 'body' is set
if (body == null) {
throw new ApiException(400, "Missing the required parameter 'body' when calling putRolesRoleIdUsersRemove");
}
// create path and map variables
String pclocalVarPath = "/api/v2/authorization/roles/{roleId}/users/remove".replaceAll("\\{format\\}","json")
.replaceAll("\\{" + "roleId" + "\\}", pcapiClient.escapeString(roleId.toString()));
// query params
List pclocalVarQueryParams = new ArrayList();
Map pclocalVarHeaderParams = new HashMap();
Map pclocalVarFormParams = new HashMap();
final String[] pclocalVarAccepts = {
"application/json"
};
final String pclocalVarAccept = pcapiClient.selectHeaderAccept(pclocalVarAccepts);
final String[] pclocalVarContentTypes = {
"application/json"
};
final String pclocalVarContentType = pcapiClient.selectHeaderContentType(pclocalVarContentTypes);
String[] pclocalVarAuthNames = new String[] { "PureCloud Auth" };
return pcapiClient.invokeAPIVerbose(pclocalVarPath, "PUT", pclocalVarQueryParams, pclocalVarPostBody, pclocalVarHeaderParams, pclocalVarFormParams, pclocalVarAccept, pclocalVarContentType, pclocalVarAuthNames, new TypeReference>() {});
}
/**
* Sets the user's roles
*
* @param userId User ID (required)
* @param body List of roles (required)
* @return UserAuthorization
* @throws ApiException if fails to make API call
*/
public UserAuthorization putUserIdRoles(String userId, List body) throws ApiException {
return putUserIdRolesWithHttpInfo(userId, body).getResponseObject();
}
/**
* Sets the user's roles
*
* @param userId User ID (required)
* @param body List of roles (required)
* @return UserAuthorization
* @throws ApiException if fails to make API call
*/
public ApiResponse putUserIdRolesWithHttpInfo(String userId, List body) throws ApiException {
Object pclocalVarPostBody = body;
// verify the required parameter 'userId' is set
if (userId == null) {
throw new ApiException(400, "Missing the required parameter 'userId' when calling putUserIdRoles");
}
// verify the required parameter 'body' is set
if (body == null) {
throw new ApiException(400, "Missing the required parameter 'body' when calling putUserIdRoles");
}
// create path and map variables
String pclocalVarPath = "/api/v2/users/{userId}/roles".replaceAll("\\{format\\}","json")
.replaceAll("\\{" + "userId" + "\\}", pcapiClient.escapeString(userId.toString()));
// query params
List pclocalVarQueryParams = new ArrayList();
Map pclocalVarHeaderParams = new HashMap();
Map pclocalVarFormParams = new HashMap();
final String[] pclocalVarAccepts = {
"application/json"
};
final String pclocalVarAccept = pcapiClient.selectHeaderAccept(pclocalVarAccepts);
final String[] pclocalVarContentTypes = {
"application/json"
};
final String pclocalVarContentType = pcapiClient.selectHeaderContentType(pclocalVarContentTypes);
String[] pclocalVarAuthNames = new String[] { "PureCloud Auth" };
return pcapiClient.invokeAPIVerbose(pclocalVarPath, "PUT", pclocalVarQueryParams, pclocalVarPostBody, pclocalVarHeaderParams, pclocalVarFormParams, pclocalVarAccept, pclocalVarContentType, pclocalVarAuthNames, new TypeReference() {});
}
}
