Package com.okta.sdk.resource.api

Class RoleAssignmentClientApi

java.lang.Object

com.okta.sdk.resource.api.RoleAssignmentClientApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-09-23T08:35:59.300824-05:00[America/Chicago]",
           comments="Generator version: 7.8.0")
public class RoleAssignmentClientApi
extends Object

Constructor Summary

Constructors

Constructor	Description
RoleAssignmentClientApi()
RoleAssignmentClientApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ListGroupAssignedRoles200ResponseInner	assignRoleToClient(String clientId, AssignRoleToGroupRequest assignRoleToGroupRequest)	Assign a Client Role Assigns a [standard role](/openapi/okta-management/guides/roles/#standard-roles) to a Client Application.
ListGroupAssignedRoles200ResponseInner	assignRoleToClient(String clientId, AssignRoleToGroupRequest assignRoleToGroupRequest, Map<String,String> additionalHeaders)	Assign a Client Role Assigns a [standard role](/openapi/okta-management/guides/roles/#standard-roles) to a Client Application.
void	deleteRoleFromClient(String clientId, String roleAssignmentId)	Unassign a Client Role Unassigns a Role Assignment (identified by `roleAssignmentId`) from a Client Application (identified by `clientId`)
void	deleteRoleFromClient(String clientId, String roleAssignmentId, Map<String,String> additionalHeaders)	Unassign a Client Role Unassigns a Role Assignment (identified by `roleAssignmentId`) from a Client Application (identified by `clientId`)
ApiClient	getApiClient()
protected static com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
ListGroupAssignedRoles200ResponseInner	listRolesForClient(String clientId)	List all Client Role Assignments Lists all roles assigned to a Client Application identified by `clientId`
ListGroupAssignedRoles200ResponseInner	listRolesForClient(String clientId, Map<String,String> additionalHeaders)	List all Client Role Assignments Lists all roles assigned to a Client Application identified by `clientId`
ListGroupAssignedRoles200ResponseInner	retrieveClientRole(String clientId, String roleAssignmentId)	Retrieve a Client Role Retrieves a Role Assignment (identified by `roleAssignmentId`) for a Client Application (identified by `clientId`)
ListGroupAssignedRoles200ResponseInner	retrieveClientRole(String clientId, String roleAssignmentId, Map<String,String> additionalHeaders)	Retrieve a Client Role Retrieves a Role Assignment (identified by `roleAssignmentId`) for a Client Application (identified by `clientId`)
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Details

RoleAssignmentClientApi

public RoleAssignmentClientApi()

RoleAssignmentClientApi

public RoleAssignmentClientApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

assignRoleToClient

public ListGroupAssignedRoles200ResponseInner assignRoleToClient(String clientId,
 AssignRoleToGroupRequest assignRoleToGroupRequest)
                                                          throws ApiException

Assign a Client Role Assigns a [standard role](/openapi/okta-management/guides/roles/#standard-roles) to a Client Application. You can also assign a custom role to a Client Application, but the preferred method to assign a custom role to a client is to create a binding between the Custom Role, the Resource Set, and the Client Application. See [Create a Role Resource Set Binding](/openapi/okta-management/management/tag/RoleDResourceSetBinding/#tag/RoleDResourceSetBinding/operation/createResourceSetBinding). > **Notes:** > * The request payload is different for standard and custom role assignments. > * For IAM-based standard role assignments, use the request payload for standard roles. However, the response payload for IAM-based role assignments is similar to the custom role's assignment response.

Parameters:

clientId - `client_id` of the app (required)

assignRoleToGroupRequest - (required)

Returns:

ListGroupAssignedRoles200ResponseInner

Throws:

ApiException - if fails to make API call

assignRoleToClient

public ListGroupAssignedRoles200ResponseInner assignRoleToClient(String clientId,
 AssignRoleToGroupRequest assignRoleToGroupRequest,
 Map<String,String> additionalHeaders)
                                                          throws ApiException

Assign a Client Role Assigns a [standard role](/openapi/okta-management/guides/roles/#standard-roles) to a Client Application. You can also assign a custom role to a Client Application, but the preferred method to assign a custom role to a client is to create a binding between the Custom Role, the Resource Set, and the Client Application. See [Create a Role Resource Set Binding](/openapi/okta-management/management/tag/RoleDResourceSetBinding/#tag/RoleDResourceSetBinding/operation/createResourceSetBinding). > **Notes:** > * The request payload is different for standard and custom role assignments. > * For IAM-based standard role assignments, use the request payload for standard roles. However, the response payload for IAM-based role assignments is similar to the custom role's assignment response.

Parameters:

clientId - `client_id` of the app (required)

assignRoleToGroupRequest - (required)

additionalHeaders - additionalHeaders for this call

Returns:

ListGroupAssignedRoles200ResponseInner

Throws:

ApiException - if fails to make API call

deleteRoleFromClient

public void deleteRoleFromClient(String clientId,
 String roleAssignmentId)
                          throws ApiException

Unassign a Client Role Unassigns a Role Assignment (identified by `roleAssignmentId`) from a Client Application (identified by `clientId`)

Parameters:

clientId - `client_id` of the app (required)

roleAssignmentId - The `id` of the Role Assignment (required)

Throws:

ApiException - if fails to make API call

deleteRoleFromClient

public void deleteRoleFromClient(String clientId,
 String roleAssignmentId,
 Map<String,String> additionalHeaders)
                          throws ApiException

Unassign a Client Role Unassigns a Role Assignment (identified by `roleAssignmentId`) from a Client Application (identified by `clientId`)

Parameters:

clientId - `client_id` of the app (required)

roleAssignmentId - The `id` of the Role Assignment (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

listRolesForClient

public ListGroupAssignedRoles200ResponseInner listRolesForClient(String clientId)
                                                          throws ApiException

List all Client Role Assignments Lists all roles assigned to a Client Application identified by `clientId`

Parameters:

clientId - `client_id` of the app (required)

Returns:

ListGroupAssignedRoles200ResponseInner

Throws:

ApiException - if fails to make API call

listRolesForClient

public ListGroupAssignedRoles200ResponseInner listRolesForClient(String clientId,
 Map<String,String> additionalHeaders)
                                                          throws ApiException

List all Client Role Assignments Lists all roles assigned to a Client Application identified by `clientId`

Parameters:

clientId - `client_id` of the app (required)

additionalHeaders - additionalHeaders for this call

Returns:

ListGroupAssignedRoles200ResponseInner

Throws:

ApiException - if fails to make API call

retrieveClientRole

public ListGroupAssignedRoles200ResponseInner retrieveClientRole(String clientId,
 String roleAssignmentId)
                                                          throws ApiException

Retrieve a Client Role Retrieves a Role Assignment (identified by `roleAssignmentId`) for a Client Application (identified by `clientId`)

Parameters:

clientId - `client_id` of the app (required)

roleAssignmentId - The `id` of the Role Assignment (required)

Returns:

ListGroupAssignedRoles200ResponseInner

Throws:

ApiException - if fails to make API call

retrieveClientRole

public ListGroupAssignedRoles200ResponseInner retrieveClientRole(String clientId,
 String roleAssignmentId,
 Map<String,String> additionalHeaders)
                                                          throws ApiException

Retrieve a Client Role Retrieves a Role Assignment (identified by `roleAssignmentId`) for a Client Application (identified by `clientId`)

Parameters:

clientId - `client_id` of the app (required)

roleAssignmentId - The `id` of the Role Assignment (required)

additionalHeaders - additionalHeaders for this call

Returns:

ListGroupAssignedRoles200ResponseInner

Throws:

ApiException - if fails to make API call

getObjectMapper

protected static com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()