Roles

Use scalekitClient.roles() to define organization roles and list role assignments.

Create roles and permissions for authorization after you have organizations and users.

createRole

clientRoleshttps://github.com/scalekit-inc/scalekit-sdk-java/blob/main/src/main/java/com/scalekit/api/RoleClient.java

#asynccreateRole

Runs createRole and returns the result.

paramrequestCreateRoleRequest

Request payload.

returnslevel role management CreateRoleResponse

level role management CreateRoleResponse

import com.scalekit.grpc.scalekit.v1.roles.CreateRoleRequest;

CreateRoleRequest req = CreateRoleRequest.newBuilder().build();
scalekitClient.roles().createRole(req);

getRole

clientRoleshttps://github.com/scalekit-inc/scalekit-sdk-java/blob/main/src/main/java/com/scalekit/api/RoleClient.java

#asyncgetRole

Runs getRole and returns the result.

paramroleNameString

Role name.

returnsGetRoleResponse

The response payload for this operation.

scalekitClient.roles().getRole("admin");

listRoles

clientRoleshttps://github.com/scalekit-inc/scalekit-sdk-java/blob/main/src/main/java/com/scalekit/api/RoleClient.java

#asynclistRoles

Runs listRoles and returns the result.

returnsListRolesResponse

Paginated results.

scalekitClient.roles().listRoles();

updateRole

clientRoleshttps://github.com/scalekit-inc/scalekit-sdk-java/blob/main/src/main/java/com/scalekit/api/RoleClient.java

#asyncupdateRole

Runs updateRole and returns the result.

paramroleNameString

Role name.

paramrequestUpdateRoleRequest

Request payload.

returnsUpdateRoleResponse

The updated resource.

import com.scalekit.grpc.scalekit.v1.roles.UpdateRoleRequest;

UpdateRoleRequest req = UpdateRoleRequest.newBuilder().build();
scalekitClient.roles().updateRole("admin", req);

deleteRole

clientRoleshttps://github.com/scalekit-inc/scalekit-sdk-java/blob/main/src/main/java/com/scalekit/api/RoleClient.java

#asyncdeleteRole

Runs deleteRole and returns the result.

paramroleNameString

Role name.

paramreassignRoleNameString

Reassign role name.

returnsvoid

No return value

scalekitClient.roles().deleteRole("old_role", "new_role");

getRoleUsersCount

clientRoleshttps://github.com/scalekit-inc/scalekit-sdk-java/blob/main/src/main/java/com/scalekit/api/RoleClient.java

#asyncgetRoleUsersCount

Runs getRoleUsersCount and returns the result.

paramroleNameString

Role name.

returnsGetRoleUsersCountResponse

The response payload for this operation.

scalekitClient.roles().getRoleUsersCount("admin");

createOrganizationRole

clientRoleshttps://github.com/scalekit-inc/scalekit-sdk-java/blob/main/src/main/java/com/scalekit/api/RoleClient.java

#asynccreateOrganizationRole

Runs createOrganizationRole and returns the result.

paramorgIdString

Org id.

paramrequestCreateOrganizationRoleRequest

Request payload.

returnslevel role management CreateOrganizationRoleResponse

level role management CreateOrganizationRoleResponse

import com.scalekit.grpc.scalekit.v1.roles.CreateOrganizationRoleRequest;

CreateOrganizationRoleRequest req = CreateOrganizationRoleRequest.newBuilder().build();
scalekitClient.roles().createOrganizationRole("org_123", req);

getOrganizationRole

clientRoleshttps://github.com/scalekit-inc/scalekit-sdk-java/blob/main/src/main/java/com/scalekit/api/RoleClient.java

#asyncgetOrganizationRole

Runs getOrganizationRole and returns the result.

paramorgIdString

Org id.

paramroleNameString

Role name.

returnsGetOrganizationRoleResponse

The response payload for this operation.

scalekitClient.roles().getOrganizationRole("org_123", "org_admin");

listOrganizationRoles

clientRoleshttps://github.com/scalekit-inc/scalekit-sdk-java/blob/main/src/main/java/com/scalekit/api/RoleClient.java

#asynclistOrganizationRoles

Runs listOrganizationRoles and returns the result.

paramorgIdString

Org id.

returnsListOrganizationRolesResponse

Paginated results.

scalekitClient.roles().listOrganizationRoles("org_123");

updateOrganizationRole

clientRoleshttps://github.com/scalekit-inc/scalekit-sdk-java/blob/main/src/main/java/com/scalekit/api/RoleClient.java

#asyncupdateOrganizationRole

Runs updateOrganizationRole and returns the result.

paramorgIdString

Org id.

paramroleNameString

Role name.

paramrequestUpdateOrganizationRoleRequest

Request payload.

returnsUpdateOrganizationRoleResponse

The updated resource.

import com.scalekit.grpc.scalekit.v1.roles.UpdateOrganizationRoleRequest;

UpdateOrganizationRoleRequest req = UpdateOrganizationRoleRequest.newBuilder().build();
scalekitClient.roles().updateOrganizationRole("org_123", "org_admin", req);

deleteOrganizationRole

clientRoleshttps://github.com/scalekit-inc/scalekit-sdk-java/blob/main/src/main/java/com/scalekit/api/RoleClient.java

#asyncdeleteOrganizationRole

Runs deleteOrganizationRole and returns the result.

paramorgIdString

Org id.

paramroleNameString

Role name.

paramreassignRoleNameString

Reassign role name.

returnsvoid

No return value

scalekitClient.roles().deleteOrganizationRole("org_123", "old_role", "new_role");

getOrganizationRoleUsersCount

clientRoleshttps://github.com/scalekit-inc/scalekit-sdk-java/blob/main/src/main/java/com/scalekit/api/RoleClient.java

#asyncgetOrganizationRoleUsersCount

Runs getOrganizationRoleUsersCount and returns the result.

paramorgIdString

Org id.

paramroleNameString

Role name.

returnsGetOrganizationRoleUsersCountResponse

The response payload for this operation.

updateDefaultOrganizationRoles

clientRoleshttps://github.com/scalekit-inc/scalekit-sdk-java/blob/main/src/main/java/com/scalekit/api/RoleClient.java

#asyncupdateDefaultOrganizationRoles

Runs updateDefaultOrganizationRoles and returns the result.

paramorgIdString

Org id.

paramrequestUpdateDefaultOrganizationRolesRequest

Request payload.

returnsUpdateDefaultOrganizationRolesResponse

The updated resource.

import com.scalekit.grpc.scalekit.v1.roles.UpdateDefaultOrganizationRolesRequest;

UpdateDefaultOrganizationRolesRequest req = UpdateDefaultOrganizationRolesRequest.newBuilder().build();
scalekitClient.roles().updateDefaultOrganizationRoles("org_123", req);

updateDefaultRoles

clientRoleshttps://github.com/scalekit-inc/scalekit-sdk-java/blob/main/src/main/java/com/scalekit/api/RoleClient.java

#asyncupdateDefaultRoles

Runs updateDefaultRoles and returns the result.

paramrequestUpdateDefaultRolesRequest

Request payload.

returnsUpdateDefaultRolesResponse

The updated resource.

listDependentRoles

clientRoleshttps://github.com/scalekit-inc/scalekit-sdk-java/blob/main/src/main/java/com/scalekit/api/RoleClient.java

#asynclistDependentRoles

Runs listDependentRoles and returns the result.

paramroleNameString

Role name.

returnsListDependentRolesResponse

Paginated results.

deleteRoleBase

clientRoleshttps://github.com/scalekit-inc/scalekit-sdk-java/blob/main/src/main/java/com/scalekit/api/RoleClient.java

#asyncdeleteRoleBase

Runs deleteRoleBase and returns the result.

paramroleNameString

Role name.

returnsDeprecated void

Deprecated void

scalekitClient.roles().deleteRoleBase("admin");

deleteOrganizationRoleBase

clientRoleshttps://github.com/scalekit-inc/scalekit-sdk-java/blob/main/src/main/java/com/scalekit/api/RoleClient.java

#asyncdeleteOrganizationRoleBase

Runs deleteOrganizationRoleBase and returns the result.

paramorgIdString

Org id.

paramroleNameString

Role name.

returnsvoid

No return value