org.openapitools.client.api

Class RoleApi

java.lang.Object

org.openapitools.client.api.RoleApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-01-18T04:14:02.238-06:00[America/Chicago]")
 @Component(value="org.openapitools.client.api.RoleApi")
public class RoleApi
extends Object

Constructor Summary

Constructors

Constructor and Description
RoleApi()
RoleApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
<T> T	createRole(Class<?> T, IamRole instance) Create a Role Creates a new role
IamRole	createRole(IamRole instance) Create a Role Creates a new role
void	createRolePermission(String roleIdOrLabel, String permissionType) Create a Permission Creates a permission specified by `permissionType` to the role
PagedList	createRoleWithPaginationInfo(IamRole instance) Create a Role Creates a new role
void	deleteRole(String roleIdOrLabel) Delete a Role Deletes a role by `roleIdOrLabel`
void	deleteRolePermission(String roleIdOrLabel, String permissionType) Delete a Permission Deletes a permission from a role by `permissionType`
ApiClient	getApiClient()
IamRole	getRole(String roleIdOrLabel) Retrieve a Role Retrieves a role by `roleIdOrLabel`
Permission	getRolePermission(String roleIdOrLabel, String permissionType) Retrieve a Permission Retrieves a permission by `permissionType`
PagedList	getRolePermissionWithPaginationInfo(String roleIdOrLabel, String permissionType) Retrieve a Permission Retrieves a permission by `permissionType`
PagedList	getRoleWithPaginationInfo(String roleIdOrLabel) Retrieve a Role Retrieves a role by `roleIdOrLabel`
Permissions	listRolePermissions(String roleIdOrLabel) List all Permissions Lists all permissions of the role by `roleIdOrLabel`
PagedList	listRolePermissionsWithPaginationInfo(String roleIdOrLabel) List all Permissions Lists all permissions of the role by `roleIdOrLabel`
IamRoles	listRoles(String after) List all Roles Lists all roles with pagination support
PagedList	listRolesWithPaginationInfo(String after) List all Roles Lists all roles with pagination support
<T> T	replaceRole(Class<?> T, String roleIdOrLabel, IamRole instance) Replace a Role Replaces a role by `roleIdOrLabel`
IamRole	replaceRole(String roleIdOrLabel, IamRole instance) Replace a Role Replaces a role by `roleIdOrLabel`
PagedList	replaceRoleWithPaginationInfo(String roleIdOrLabel, IamRole instance) Replace a Role Replaces a role by `roleIdOrLabel`
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RoleApi

public RoleApi()

RoleApi

@Autowired
public RoleApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createRole

public IamRole createRole(IamRole instance)
                   throws org.springframework.web.client.RestClientException

Create a Role Creates a new role

200 - Success

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

instance - (required)

Returns:

IamRole

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

createRole

public <T> T createRole(Class<?> T,
                        IamRole instance)
                 throws org.springframework.web.client.RestClientException

Create a Role Creates a new role

200 - Success

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

instance - (required)

Returns:

T instance

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

createRoleWithPaginationInfo

public PagedList createRoleWithPaginationInfo(IamRole instance)
                                       throws org.springframework.web.client.RestClientException

Create a Role Creates a new role

200 - Success

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

instance - (required)

Returns:

ResponseEntity<IamRole>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

createRolePermission

public void createRolePermission(String roleIdOrLabel,
                                 String permissionType)
                          throws org.springframework.web.client.RestClientException

Create a Permission Creates a permission specified by `permissionType` to the role

204 - No Content

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

roleIdOrLabel - `id` or `label` of the role (required)

permissionType - An okta permission type (required)

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

deleteRole

public void deleteRole(String roleIdOrLabel)
                throws org.springframework.web.client.RestClientException

Delete a Role Deletes a role by `roleIdOrLabel`

204 - No Content

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

roleIdOrLabel - `id` or `label` of the role (required)

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

deleteRolePermission

public void deleteRolePermission(String roleIdOrLabel,
                                 String permissionType)
                          throws org.springframework.web.client.RestClientException

Delete a Permission Deletes a permission from a role by `permissionType`

204 - No Content

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

roleIdOrLabel - `id` or `label` of the role (required)

permissionType - An okta permission type (required)

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getRole

public IamRole getRole(String roleIdOrLabel)
                throws org.springframework.web.client.RestClientException

Retrieve a Role Retrieves a role by `roleIdOrLabel`

200 - OK

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

roleIdOrLabel - `id` or `label` of the role (required)

Returns:

IamRole

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getRoleWithPaginationInfo

public PagedList getRoleWithPaginationInfo(String roleIdOrLabel)
                                    throws org.springframework.web.client.RestClientException

Retrieve a Role Retrieves a role by `roleIdOrLabel`

200 - OK

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

roleIdOrLabel - `id` or `label` of the role (required)

Returns:

ResponseEntity<IamRole>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getRolePermission

public Permission getRolePermission(String roleIdOrLabel,
                                    String permissionType)
                             throws org.springframework.web.client.RestClientException

Retrieve a Permission Retrieves a permission by `permissionType`

200 - OK

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

roleIdOrLabel - `id` or `label` of the role (required)

permissionType - An okta permission type (required)

Returns:

Permission

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getRolePermissionWithPaginationInfo

public PagedList getRolePermissionWithPaginationInfo(String roleIdOrLabel,
                                                     String permissionType)
                                              throws org.springframework.web.client.RestClientException

Retrieve a Permission Retrieves a permission by `permissionType`

200 - OK

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

roleIdOrLabel - `id` or `label` of the role (required)

permissionType - An okta permission type (required)

Returns:

ResponseEntity<Permission>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listRolePermissions

public Permissions listRolePermissions(String roleIdOrLabel)
                                throws org.springframework.web.client.RestClientException

List all Permissions Lists all permissions of the role by `roleIdOrLabel`

200 - OK

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

roleIdOrLabel - `id` or `label` of the role (required)

Returns:

Permissions

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listRolePermissionsWithPaginationInfo

public PagedList listRolePermissionsWithPaginationInfo(String roleIdOrLabel)
                                                throws org.springframework.web.client.RestClientException

List all Permissions Lists all permissions of the role by `roleIdOrLabel`

200 - OK

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

roleIdOrLabel - `id` or `label` of the role (required)

Returns:

ResponseEntity<Permissions>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listRoles

public IamRoles listRoles(String after)
                   throws org.springframework.web.client.RestClientException

List all Roles Lists all roles with pagination support

200 - OK

403 - Forbidden

429 - Too Many Requests

Parameters:

after - The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](/#pagination) for more information. (optional)

Returns:

IamRoles

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listRolesWithPaginationInfo

public PagedList listRolesWithPaginationInfo(String after)
                                      throws org.springframework.web.client.RestClientException

List all Roles Lists all roles with pagination support

200 - OK

403 - Forbidden

429 - Too Many Requests

Parameters:

after - The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](/#pagination) for more information. (optional)

Returns:

ResponseEntity<IamRoles>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

replaceRole

public IamRole replaceRole(String roleIdOrLabel,
                           IamRole instance)
                    throws org.springframework.web.client.RestClientException

Replace a Role Replaces a role by `roleIdOrLabel`

200 - OK

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

roleIdOrLabel - `id` or `label` of the role (required)

instance - (required)

Returns:

IamRole

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

replaceRole

public <T> T replaceRole(Class<?> T,
                         String roleIdOrLabel,
                         IamRole instance)
                  throws org.springframework.web.client.RestClientException

Replace a Role Replaces a role by `roleIdOrLabel`

200 - OK

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

roleIdOrLabel - `id` or `label` of the role (required)

instance - (required)

Returns:

T instance

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

replaceRoleWithPaginationInfo

public PagedList replaceRoleWithPaginationInfo(String roleIdOrLabel,
                                               IamRole instance)
                                        throws org.springframework.web.client.RestClientException

Replace a Role Replaces a role by `roleIdOrLabel`

200 - OK

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

roleIdOrLabel - `id` or `label` of the role (required)

instance - (required)

Returns:

ResponseEntity<IamRole>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API