Help us shape the future of Go! Take the 2026 Go Developer Survey

Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

permio-go

module

Go to main page

Versions in this module

v0

v0.1.0

Oct 26, 2026

Changes in this version

+ const APIKeyLength

+ const DefaultEndpoint

+ const DefaultTimeout

+ const DevEndpoint

+ const EnvAPIKey

+ const GroupPrefix

+ const MaxBatch

+ const MaxPageSize

+ const MaxResourceURILength

+ const ScopeExact

+ const ScopePattern

+ const ScopeSubtree

+ const ScopeUnknown

+ const WildcardSegment

+ var ErrAlreadyExists error = KindAlreadyExists

+ var ErrAuth error = KindAuth

+ var ErrConfig error = KindConfig

+ var ErrDenied error = KindDenied

+ var ErrNotFound error = KindNotFound

+ var ErrPermission error = KindPermission

+ var ErrRateLimited error = KindRateLimited

+ var ErrTimeout error = KindTimeout

+ var ErrUnavailable error = KindUnavailable

+ var ErrValidation error = KindValidation

+ func Collect[T any](seq iter.Seq2[T, error]) ([]T, error)

+ func EncodeSegment(segment string) string

+ func GroupPrincipal(slug string) string

+ func IsIdempotent(fullMethod string) bool

+ func IsNotFound(err error) bool

+ func MustResource(segments ...string) string

+ func Resource(segments ...string) (string, error)

+ func ValidateGroupName(slug string) error

+ func ValidateResourceURI(uri string) error

+ type APIKeyAccess string

+ const APIKeyAccessCheck

+ const APIKeyAccessFull

+ const APIKeyAccessUnknown

+ type APIKeyKind string

+ const APIKeyJWT

+ const APIKeyOpaque

+ func ValidateAPIKey(key string) (APIKeyKind, error)

+ type AccessEntry struct

+ IsGroup bool

+ Principal string

+ Via []AccessVia

+ ViaGroup string

+ type AccessScope struct

+ Kind string

+ URI string

+ type AccessScopes struct

+ CoversAll bool

+ Scopes []AccessScope

+ Under string

+ func (a *AccessScopes) Allows(uri string) bool

+ func (a *AccessScopes) Exact() []string

+ func (a *AccessScopes) HasPatterns() bool

+ func (a *AccessScopes) IsEmpty() bool

+ func (a *AccessScopes) Patterns() []string

+ func (a *AccessScopes) Prefixes() []string

+ func (a *AccessScopes) Regexp() *regexp.Regexp

+ func (a *AccessScopes) RegexpSource() string

+ type AccessVia struct

+ Inherited bool

+ Match string

+ Resource string

+ RoleID string

+ RoleName string

+ Source string

+ type BatchResult struct

+ Allowed bool

+ Missing []string

+ Resource string

+ type CheckRequest struct

+ Permissions []string

+ Principal string

+ Resources []string

+ type CheckResult struct

+ Allowed bool

+ Missing []MissingPermission

+ type Client struct

+ func New(opts Options) (*Client, error)

+ func (c *Client) APIKeyKind() APIKeyKind

+ func (c *Client) Assert(ctx context.Context, principal, permission, resource string) error

+ func (c *Client) AssertAll(ctx context.Context, req CheckRequest) error

+ func (c *Client) BatchCheck(ctx context.Context, principal string, permissions []string, ...) (map[string]bool, error)

+ func (c *Client) BatchCheckDetailed(ctx context.Context, principal string, permissions []string, ...) ([]BatchResult, error)

+ func (c *Client) Check(ctx context.Context, principal, permission, resource string) (bool, error)

+ func (c *Client) CheckAll(ctx context.Context, principal string, permissions []string, resource string) (bool, error)

+ func (c *Client) CheckAny(ctx context.Context, principal string, permissions []string, resource string) (bool, error)

+ func (c *Client) CheckDetailed(ctx context.Context, req CheckRequest) (*CheckResult, error)

+ func (c *Client) Close() error

+ func (c *Client) Conn() grpc.ClientConnInterface

+ func (c *Client) CreatePermission(ctx context.Context, name, description string) (*Permission, error)

+ func (c *Client) CreateRole(ctx context.Context, name, description string, permissions []string) (*Role, error)

+ func (c *Client) DeletePermission(ctx context.Context, name string) error

+ func (c *Client) DeleteRole(ctx context.Context, id string) error

+ func (c *Client) GetGrant(ctx context.Context, principal, resource string) (*Grant, error)

+ func (c *Client) GetPermission(ctx context.Context, name string) (*Permission, error)

+ func (c *Client) GetRole(ctx context.Context, id string) (*Role, error)

+ func (c *Client) Grant(ctx context.Context, req GrantRequest) error

+ func (c *Client) Groups() *Groups

+ func (c *Client) ListAccess(ctx context.Context, principal, permission, under string) (*AccessScopes, error)

+ func (c *Client) ListAssignments(ctx context.Context, principal string, opts *ListOptions) iter.Seq2[Grant, error]

+ func (c *Client) ListPermissions(ctx context.Context, opts *ListOptions) iter.Seq2[Permission, error]

+ func (c *Client) ListPrincipals(ctx context.Context, opts *ListOptions) iter.Seq2[string, error]

+ func (c *Client) ListRoles(ctx context.Context, opts *ListOptions) iter.Seq2[Role, error]

+ func (c *Client) Organisations() organisationv1.OrganisationServiceClient

+ func (c *Client) Permissions() permissionsv1.PermissionsServiceClient

+ func (c *Client) Project() string

+ func (c *Client) Revoke(ctx context.Context, req GrantRequest) error

+ func (c *Client) UpdatePermission(ctx context.Context, name, newName, description string) (*Permission, error)

+ func (c *Client) UpdateRole(ctx context.Context, id, name, description string, permissions []string) (*Role, error)

+ func (c *Client) WhoAmI(ctx context.Context) (*Identity, error)

+ func (c *Client) WhoHasAccess(ctx context.Context, resource string, opts *WhoHasAccessOptions) ([]AccessEntry, error)

+ func (c *Client) WithProject(project string) *Client

+ type Error struct

+ Code codes.Code

+ Kind Kind

+ Message string

+ Metadata metadata.MD

+ Missing []MissingPermission

+ Principal string

+ RetryAfter time.Duration

+ func (e *Error) Error() string

+ func (e *Error) GRPCStatus() *status.Status

+ func (e *Error) Is(target error) bool

+ func (e *Error) Unwrap() error

+ type Grant struct

+ Permissions []string

+ Principal string

+ Resource string

+ Roles []RoleRef

+ type GrantRequest struct

+ Permissions []string

+ Principal string

+ Resource string

+ Roles []string

+ type Group struct

+ CreatedAt *time.Time

+ Description string

+ Name string

+ PrincipalID string

+ UpdatedAt *time.Time

+ type GroupMember struct

+ CreatedAt *time.Time

+ PrincipalID string

+ type Groups struct

+ func (g *Groups) AddMembers(ctx context.Context, name string, principals []string) (*MembershipChange, error)

+ func (g *Groups) Create(ctx context.Context, name, description string) (*Group, error)

+ func (g *Groups) Delete(ctx context.Context, name string) error

+ func (g *Groups) Get(ctx context.Context, name string) (*Group, error)

+ func (g *Groups) List(ctx context.Context, opts *ListOptions) iter.Seq2[Group, error]

+ func (g *Groups) ListForPrincipal(ctx context.Context, principal string, opts *ListOptions) iter.Seq2[Group, error]

+ func (g *Groups) ListMembers(ctx context.Context, name string, opts *ListOptions) iter.Seq2[GroupMember, error]

+ func (g *Groups) RemoveMembers(ctx context.Context, name string, principals []string) (*MembershipChange, error)

+ func (g *Groups) Update(ctx context.Context, name, description string) (*Group, error)

+ type Identity struct

+ APIKeyAccess APIKeyAccess

+ Email string

+ Kind PrincipalKind

+ OrganisationID string

+ PrincipalID string

+ Project string

+ type Kind string

+ const KindAlreadyExists

+ const KindAuth

+ const KindConfig

+ const KindDenied

+ const KindNotFound

+ const KindOther

+ const KindPermission

+ const KindRateLimited

+ const KindTimeout

+ const KindUnavailable

+ const KindValidation

+ func KindOf(err error) Kind

+ func (k Kind) Error() string

+ type ListOptions struct

+ PageSize int

+ Search string

+ type MembershipChange struct

+ Changed []string

+ Unchanged []string

+ type MissingPermission struct

+ Permissions []string

+ Resource string

+ func ParseMissingPermissions(msg string) []MissingPermission

+ type Options struct

+ APIKey string

+ Conn grpc.ClientConnInterface

+ DialOptions []grpc.DialOption

+ Endpoint string

+ Insecure bool

+ Project string

+ Retry RetryOptions

+ Timeout time.Duration

+ UserAgent string

+ type Permission struct

+ Description string

+ Name string

+ type PrincipalKind string

+ const PrincipalAPIKey

+ const PrincipalServiceAccount

+ const PrincipalUnknown

+ const PrincipalUser

+ type RetryOptions struct

+ BaseDelay time.Duration

+ MaxDelay time.Duration

+ MaxRetries int

+ type Role struct

+ Description string

+ ID string

+ Name string

+ Permissions []string

+ type RoleRef struct

+ ID string

+ Name string

+ type WhoHasAccessOptions struct

+ ExpandGroups bool

+ Permission string

v0.0.18

Oct 26, 2026

retracted

v0.0.16

Oct 17, 2026

retracted

v0.0.15

Feb 7, 2026

retracted

v0.0.12

Dec 6, 2025

retracted

v0.0.11

Aug 23, 2025

retracted

v0.0.10

Aug 23, 2025

retracted

v0.0.9

Jul 19, 2025

retracted

v0.0.8

Jun 11, 2025

retracted

v0.0.7

Jun 7, 2025

retracted

v0.0.6

Jun 4, 2025

retracted

v0.0.5

Jun 4, 2025

retracted

v0.0.4

May 25, 2025

retracted

v0.0.3

May 25, 2025

retracted

v0.0.2

May 25, 2025

retracted

v0.0.1

May 25, 2025

retracted