Skip to content

docs: Document permissionship enum values #154

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ivanauth wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Document permissionship enum values #154

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions authzed/api/v1/permission_service.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -511,9 +511,22 @@ message CheckPermissionRequest {

message CheckPermissionResponse {
enum Permissionship {
// PERMISSIONSHIP_UNSPECIFIED is the default value and should not be used or
// relied upon. Servers should not return this value.
PERMISSIONSHIP_UNSPECIFIED = 0;

// PERMISSIONSHIP_NO_PERMISSION indicates that the subject does not have the
// requested permission on the resource.
PERMISSIONSHIP_NO_PERMISSION = 1;

// PERMISSIONSHIP_HAS_PERMISSION indicates that the subject has the requested
// permission on the resource.
PERMISSIONSHIP_HAS_PERMISSION = 2;

// PERMISSIONSHIP_CONDITIONAL_PERMISSION indicates that the subject has the
// requested permission on the resource, but only if a caveat condition is met.
// The `partial_caveat_info` field in the response should contain the missing
// context fields that must be provided to fully evaluate the caveat.
PERMISSIONSHIP_CONDITIONAL_PERMISSION = 3;
}

Expand Down Expand Up @@ -742,8 +755,18 @@ message LookupResourcesRequest {

// LookupPermissionship represents whether a Lookup response was partially evaluated or not
enum LookupPermissionship {
// LOOKUP_PERMISSIONSHIP_UNSPECIFIED is the default value and should not be used or
// relied upon. Servers should not return this value.
LOOKUP_PERMISSIONSHIP_UNSPECIFIED = 0;

// LOOKUP_PERMISSIONSHIP_HAS_PERMISSION indicates that the subject has permission
// on the resource with no missing caveat context.
LOOKUP_PERMISSIONSHIP_HAS_PERMISSION = 1;

// LOOKUP_PERMISSIONSHIP_CONDITIONAL_PERMISSION indicates that the subject has
// permission on the resource, but only if a caveat condition is met. The
// `partial_caveat_info` field in the response should contain the missing context
// fields that must be provided to fully evaluate the caveat.
LOOKUP_PERMISSIONSHIP_CONDITIONAL_PERMISSION = 2;
}

Expand Down