Permissions

Use scalekitClient.permissions() to define fine-grained permissions that roles can grant.

Model permissions for resources in your app, then attach them to roles.

createPermission

clientPermissionshttps://github.com/scalekit-inc/scalekit-sdk-java/blob/main/src/main/java/com/scalekit/api/PermissionClient.java

#asynccreatePermission

Runs createPermission and returns the result.

paramrequestCreatePermissionRequest

Request payload.

returnsCreatePermissionResponse

Permission management CreatePermissionResponse

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

CreatePermissionRequest req = CreatePermissionRequest.newBuilder().build();
scalekitClient.permissions().createPermission(req);

getPermission

clientPermissionshttps://github.com/scalekit-inc/scalekit-sdk-java/blob/main/src/main/java/com/scalekit/api/PermissionClient.java

#asyncgetPermission

Runs getPermission and returns the result.

parampermissionNameString

Permission name.

returnsGetPermissionResponse

The response payload for this operation.

scalekitClient.permissions().getPermission("read:documents");

listPermissions

clientPermissionshttps://github.com/scalekit-inc/scalekit-sdk-java/blob/main/src/main/java/com/scalekit/api/PermissionClient.java

#asynclistPermissions

Runs listPermissions and returns the result.

parampageTokenString

Page token.

returnsListPermissionsResponse

Deprecated ListPermissionsResponse

scalekitClient.permissions().listPermissions("next_page_token");

updatePermission

clientPermissionshttps://github.com/scalekit-inc/scalekit-sdk-java/blob/main/src/main/java/com/scalekit/api/PermissionClient.java

#asyncupdatePermission

Runs updatePermission and returns the result.

parampermissionNameString

Permission name.

paramrequestUpdatePermissionRequest

Request payload.

returnsUpdatePermissionResponse

The updated resource.

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

UpdatePermissionRequest req = UpdatePermissionRequest.newBuilder().build();
scalekitClient.permissions().updatePermission("read:documents", req);

deletePermission

clientPermissionshttps://github.com/scalekit-inc/scalekit-sdk-java/blob/main/src/main/java/com/scalekit/api/PermissionClient.java

#asyncdeletePermission

Runs deletePermission and returns the result.

parampermissionNameString

Permission name.

returnsvoid

No return value

scalekitClient.permissions().deletePermission("read:documents");

listRolePermissions

clientPermissionshttps://github.com/scalekit-inc/scalekit-sdk-java/blob/main/src/main/java/com/scalekit/api/PermissionClient.java

#asynclistRolePermissions

Runs listRolePermissions and returns the result.

paramroleNameString

Role name.

returnsListRolePermissionsResponse

Permission relationships ListRolePermissionsResponse

scalekitClient.permissions().listRolePermissions("admin");

addPermissionsToRole

clientPermissionshttps://github.com/scalekit-inc/scalekit-sdk-java/blob/main/src/main/java/com/scalekit/api/PermissionClient.java

#asyncaddPermissionsToRole

Runs addPermissionsToRole and returns the result.

paramroleNameString

Role name.

paramrequestAddPermissionsToRoleRequest

Request payload.

returnsAddPermissionsToRoleResponse

The created resource.

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

AddPermissionsToRoleRequest req = AddPermissionsToRoleRequest.newBuilder().build();
scalekitClient.permissions().addPermissionsToRole("admin", req);

removePermissionFromRole

clientPermissionshttps://github.com/scalekit-inc/scalekit-sdk-java/blob/main/src/main/java/com/scalekit/api/PermissionClient.java

#asyncremovePermissionFromRole

Runs removePermissionFromRole and returns the result.

paramroleNameString

Role name.

parampermissionNameString

Permission name.

returnsvoid

No return value

scalekitClient.permissions().removePermissionFromRole("admin", "read:documents");

listEffectiveRolePermissions

clientPermissionshttps://github.com/scalekit-inc/scalekit-sdk-java/blob/main/src/main/java/com/scalekit/api/PermissionClient.java

#asynclistEffectiveRolePermissions

Runs listEffectiveRolePermissions and returns the result.

paramroleNameString

Role name.

returnsListEffectiveRolePermissionsResponse

Paginated results.

scalekitClient.permissions().listEffectiveRolePermissions("admin");