Documentation ¶
Index ¶
- Variables
- type Actor
- func (*Actor) Descriptor() ([]byte, []int)deprecated
- func (x *Actor) GetAuthenticated() *AuthenticatedActor
- func (x *Actor) GetNamed() *Actor_NamedActor
- func (m *Actor) GetType() isActor_Type
- func (*Actor) ProtoMessage()
- func (x *Actor) ProtoReflect() protoreflect.Message
- func (x *Actor) Reset()
- func (x *Actor) String() string
- type ActorType
- func (*ActorType) Descriptor() ([]byte, []int)deprecated
- func (x *ActorType) GetApiClient() *ActorType_ApiClient
- func (m *ActorType) GetType() isActorType_Type
- func (x *ActorType) GetUserAgent() *ActorType_UserAgent
- func (*ActorType) ProtoMessage()
- func (x *ActorType) ProtoReflect() protoreflect.Message
- func (x *ActorType) Reset()
- func (x *ActorType) String() string
- type ActorType_ApiClient
- func (*ActorType_ApiClient) Descriptor() ([]byte, []int)deprecated
- func (x *ActorType_ApiClient) GetClientAuth() *ClientAuthType
- func (x *ActorType_ApiClient) GetIpAddress() string
- func (*ActorType_ApiClient) ProtoMessage()
- func (x *ActorType_ApiClient) ProtoReflect() protoreflect.Message
- func (x *ActorType_ApiClient) Reset()
- func (x *ActorType_ApiClient) String() string
- type ActorType_ApiClient_
- type ActorType_UserAgent
- func (*ActorType_UserAgent) Descriptor() ([]byte, []int)deprecated
- func (x *ActorType_UserAgent) GetClientAuth() *ClientAuthType
- func (x *ActorType_UserAgent) GetIpAddress() string
- func (x *ActorType_UserAgent) GetUserAgent() string
- func (*ActorType_UserAgent) ProtoMessage()
- func (x *ActorType_UserAgent) ProtoReflect() protoreflect.Message
- func (x *ActorType_UserAgent) Reset()
- func (x *ActorType_UserAgent) String() string
- type ActorType_UserAgent_
- type Actor_Authenticated
- type Actor_Named
- type Actor_NamedActor
- type AuthMethodJWTBearer
- func (*AuthMethodJWTBearer) Descriptor() ([]byte, []int)deprecated
- func (x *AuthMethodJWTBearer) GetRequiredScopes() []string
- func (*AuthMethodJWTBearer) ProtoMessage()
- func (x *AuthMethodJWTBearer) ProtoReflect() protoreflect.Message
- func (x *AuthMethodJWTBearer) Reset()
- func (x *AuthMethodJWTBearer) String() string
- type AuthMethodNone
- type AuthMethodOptions
- func (*AuthMethodOptions) Descriptor() ([]byte, []int)deprecated
- func (m *AuthMethodOptions) GetAuthMethod() isAuthMethodOptions_AuthMethod
- func (x *AuthMethodOptions) GetJwtBearer() *AuthMethodJWTBearer
- func (x *AuthMethodOptions) GetNone() *AuthMethodNone
- func (*AuthMethodOptions) ProtoMessage()
- func (x *AuthMethodOptions) ProtoReflect() protoreflect.Message
- func (x *AuthMethodOptions) Reset()
- func (x *AuthMethodOptions) String() string
- type AuthMethodOptions_JwtBearer
- type AuthMethodOptions_None
- type AuthenticatedActor
- func (*AuthenticatedActor) Descriptor() ([]byte, []int)deprecated
- func (x *AuthenticatedActor) GetActorTags() map[string]string
- func (x *AuthenticatedActor) GetClaim() *Claim
- func (x *AuthenticatedActor) GetId() string
- func (x *AuthenticatedActor) GetType() *ActorType
- func (*AuthenticatedActor) ProtoMessage()
- func (x *AuthenticatedActor) ProtoReflect() protoreflect.Message
- func (x *AuthenticatedActor) Reset()
- func (x *AuthenticatedActor) String() string
- type Claim
- type ClientAuthType
- func (*ClientAuthType) Descriptor() ([]byte, []int)deprecated
- func (x *ClientAuthType) GetJwt() *ClientAuthType_JWTAuth
- func (x *ClientAuthType) GetSession() *ClientAuthType_SessionAuth
- func (m *ClientAuthType) GetType() isClientAuthType_Type
- func (*ClientAuthType) ProtoMessage()
- func (x *ClientAuthType) ProtoReflect() protoreflect.Message
- func (x *ClientAuthType) Reset()
- func (x *ClientAuthType) String() string
- type ClientAuthType_JWTAuth
- func (*ClientAuthType_JWTAuth) Descriptor() ([]byte, []int)deprecated
- func (x *ClientAuthType_JWTAuth) GetIssuedAt() *timestamppb.Timestamp
- func (x *ClientAuthType_JWTAuth) GetIssuer() string
- func (x *ClientAuthType_JWTAuth) GetJwtId() string
- func (*ClientAuthType_JWTAuth) ProtoMessage()
- func (x *ClientAuthType_JWTAuth) ProtoReflect() protoreflect.Message
- func (x *ClientAuthType_JWTAuth) Reset()
- func (x *ClientAuthType_JWTAuth) String() string
- type ClientAuthType_Jwt
- type ClientAuthType_Session
- type ClientAuthType_SessionAuth
- func (*ClientAuthType_SessionAuth) Descriptor() ([]byte, []int)deprecated
- func (x *ClientAuthType_SessionAuth) GetAuthenticatedAt() *timestamppb.Timestamp
- func (x *ClientAuthType_SessionAuth) GetSessionId() string
- func (x *ClientAuthType_SessionAuth) GetSessionManager() string
- func (x *ClientAuthType_SessionAuth) GetVerifiedAt() *timestamppb.Timestamp
- func (*ClientAuthType_SessionAuth) ProtoMessage()
- func (x *ClientAuthType_SessionAuth) ProtoReflect() protoreflect.Message
- func (x *ClientAuthType_SessionAuth) Reset()
- func (x *ClientAuthType_SessionAuth) String() string
Constants ¶
This section is empty.
Variables ¶
var (
// optional o5.auth.v1.AuthMethodOptions auth = 58960757;
E_Auth = &file_o5_auth_v1_annotations_proto_extTypes[0]
)
Extension fields to descriptorpb.MethodOptions.
var ( // Default // // optional o5.auth.v1.AuthMethodOptions default_auth = 58960757; E_DefaultAuth = &file_o5_auth_v1_annotations_proto_extTypes[1] )
Extension fields to descriptorpb.ServiceOptions.
var File_o5_auth_v1_actor_proto protoreflect.FileDescriptor
var File_o5_auth_v1_annotations_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type Actor ¶
type Actor struct { // Types that are assignable to Type: // // *Actor_Authenticated // *Actor_Named Type isActor_Type `protobuf_oneof:"type"` // contains filtered or unexported fields }
func (*Actor) GetAuthenticated ¶
func (x *Actor) GetAuthenticated() *AuthenticatedActor
func (*Actor) GetNamed ¶
func (x *Actor) GetNamed() *Actor_NamedActor
func (*Actor) ProtoReflect ¶
func (x *Actor) ProtoReflect() protoreflect.Message
type ActorType ¶
type ActorType struct { // Types that are assignable to Type: // // *ActorType_UserAgent_ // *ActorType_ApiClient_ Type isActorType_Type `protobuf_oneof:"type"` // contains filtered or unexported fields }
func (*ActorType) GetApiClient ¶
func (x *ActorType) GetApiClient() *ActorType_ApiClient
func (*ActorType) GetUserAgent ¶
func (x *ActorType) GetUserAgent() *ActorType_UserAgent
func (*ActorType) ProtoReflect ¶
func (x *ActorType) ProtoReflect() protoreflect.Message
type ActorType_ApiClient ¶
type ActorType_ApiClient struct { ClientAuth *ClientAuthType `protobuf:"bytes,1,opt,name=client_auth,json=clientAuth,proto3" json:"client_auth,omitempty"` // The IP address of the client as best as can be determined IpAddress string `protobuf:"bytes,2,opt,name=ip_address,json=ipAddress,proto3" json:"ip_address,omitempty"` // contains filtered or unexported fields }
func (*ActorType_ApiClient) Descriptor
deprecated
func (*ActorType_ApiClient) Descriptor() ([]byte, []int)
Deprecated: Use ActorType_ApiClient.ProtoReflect.Descriptor instead.
func (*ActorType_ApiClient) GetClientAuth ¶
func (x *ActorType_ApiClient) GetClientAuth() *ClientAuthType
func (*ActorType_ApiClient) GetIpAddress ¶
func (x *ActorType_ApiClient) GetIpAddress() string
func (*ActorType_ApiClient) ProtoMessage ¶
func (*ActorType_ApiClient) ProtoMessage()
func (*ActorType_ApiClient) ProtoReflect ¶
func (x *ActorType_ApiClient) ProtoReflect() protoreflect.Message
func (*ActorType_ApiClient) Reset ¶
func (x *ActorType_ApiClient) Reset()
func (*ActorType_ApiClient) String ¶
func (x *ActorType_ApiClient) String() string
type ActorType_ApiClient_ ¶
type ActorType_ApiClient_ struct {
ApiClient *ActorType_ApiClient `protobuf:"bytes,2,opt,name=api_client,json=apiClient,proto3,oneof"`
}
type ActorType_UserAgent ¶
type ActorType_UserAgent struct { ClientAuth *ClientAuthType `protobuf:"bytes,1,opt,name=client_auth,json=clientAuth,proto3" json:"client_auth,omitempty"` // The provided user agent string of the client. UserAgent string `protobuf:"bytes,2,opt,name=user_agent,json=userAgent,proto3" json:"user_agent,omitempty"` // The IP address of the client as best as can be determined IpAddress string `protobuf:"bytes,3,opt,name=ip_address,json=ipAddress,proto3" json:"ip_address,omitempty"` // contains filtered or unexported fields }
A (presumably) human user using a web browser or mobile app.
func (*ActorType_UserAgent) Descriptor
deprecated
func (*ActorType_UserAgent) Descriptor() ([]byte, []int)
Deprecated: Use ActorType_UserAgent.ProtoReflect.Descriptor instead.
func (*ActorType_UserAgent) GetClientAuth ¶
func (x *ActorType_UserAgent) GetClientAuth() *ClientAuthType
func (*ActorType_UserAgent) GetIpAddress ¶
func (x *ActorType_UserAgent) GetIpAddress() string
func (*ActorType_UserAgent) GetUserAgent ¶
func (x *ActorType_UserAgent) GetUserAgent() string
func (*ActorType_UserAgent) ProtoMessage ¶
func (*ActorType_UserAgent) ProtoMessage()
func (*ActorType_UserAgent) ProtoReflect ¶
func (x *ActorType_UserAgent) ProtoReflect() protoreflect.Message
func (*ActorType_UserAgent) Reset ¶
func (x *ActorType_UserAgent) Reset()
func (*ActorType_UserAgent) String ¶
func (x *ActorType_UserAgent) String() string
type ActorType_UserAgent_ ¶
type ActorType_UserAgent_ struct {
UserAgent *ActorType_UserAgent `protobuf:"bytes,1,opt,name=user_agent,json=userAgent,proto3,oneof"`
}
type Actor_Authenticated ¶
type Actor_Authenticated struct {
Authenticated *AuthenticatedActor `protobuf:"bytes,1,opt,name=authenticated,proto3,oneof"`
}
type Actor_Named ¶
type Actor_Named struct {
Named *Actor_NamedActor `protobuf:"bytes,2,opt,name=named,proto3,oneof"`
}
type Actor_NamedActor ¶
type Actor_NamedActor struct { Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // contains filtered or unexported fields }
func (*Actor_NamedActor) Descriptor
deprecated
func (*Actor_NamedActor) Descriptor() ([]byte, []int)
Deprecated: Use Actor_NamedActor.ProtoReflect.Descriptor instead.
func (*Actor_NamedActor) GetName ¶
func (x *Actor_NamedActor) GetName() string
func (*Actor_NamedActor) ProtoMessage ¶
func (*Actor_NamedActor) ProtoMessage()
func (*Actor_NamedActor) ProtoReflect ¶
func (x *Actor_NamedActor) ProtoReflect() protoreflect.Message
func (*Actor_NamedActor) Reset ¶
func (x *Actor_NamedActor) Reset()
func (*Actor_NamedActor) String ¶
func (x *Actor_NamedActor) String() string
type AuthMethodJWTBearer ¶
type AuthMethodJWTBearer struct { RequiredScopes []string `protobuf:"bytes,1,rep,name=required_scopes,json=requiredScopes,proto3" json:"required_scopes,omitempty"` // contains filtered or unexported fields }
func (*AuthMethodJWTBearer) Descriptor
deprecated
func (*AuthMethodJWTBearer) Descriptor() ([]byte, []int)
Deprecated: Use AuthMethodJWTBearer.ProtoReflect.Descriptor instead.
func (*AuthMethodJWTBearer) GetRequiredScopes ¶
func (x *AuthMethodJWTBearer) GetRequiredScopes() []string
func (*AuthMethodJWTBearer) ProtoMessage ¶
func (*AuthMethodJWTBearer) ProtoMessage()
func (*AuthMethodJWTBearer) ProtoReflect ¶
func (x *AuthMethodJWTBearer) ProtoReflect() protoreflect.Message
func (*AuthMethodJWTBearer) Reset ¶
func (x *AuthMethodJWTBearer) Reset()
func (*AuthMethodJWTBearer) String ¶
func (x *AuthMethodJWTBearer) String() string
type AuthMethodNone ¶
type AuthMethodNone struct { PassThroughHeaders []string `protobuf:"bytes,1,rep,name=pass_through_headers,json=passThroughHeaders,proto3" json:"pass_through_headers,omitempty"` // contains filtered or unexported fields }
func (*AuthMethodNone) Descriptor
deprecated
func (*AuthMethodNone) Descriptor() ([]byte, []int)
Deprecated: Use AuthMethodNone.ProtoReflect.Descriptor instead.
func (*AuthMethodNone) GetPassThroughHeaders ¶
func (x *AuthMethodNone) GetPassThroughHeaders() []string
func (*AuthMethodNone) ProtoMessage ¶
func (*AuthMethodNone) ProtoMessage()
func (*AuthMethodNone) ProtoReflect ¶
func (x *AuthMethodNone) ProtoReflect() protoreflect.Message
func (*AuthMethodNone) Reset ¶
func (x *AuthMethodNone) Reset()
func (*AuthMethodNone) String ¶
func (x *AuthMethodNone) String() string
type AuthMethodOptions ¶
type AuthMethodOptions struct { // Types that are assignable to AuthMethod: // // *AuthMethodOptions_JwtBearer // *AuthMethodOptions_None AuthMethod isAuthMethodOptions_AuthMethod `protobuf_oneof:"auth_method"` // contains filtered or unexported fields }
func (*AuthMethodOptions) Descriptor
deprecated
func (*AuthMethodOptions) Descriptor() ([]byte, []int)
Deprecated: Use AuthMethodOptions.ProtoReflect.Descriptor instead.
func (*AuthMethodOptions) GetAuthMethod ¶
func (m *AuthMethodOptions) GetAuthMethod() isAuthMethodOptions_AuthMethod
func (*AuthMethodOptions) GetJwtBearer ¶
func (x *AuthMethodOptions) GetJwtBearer() *AuthMethodJWTBearer
func (*AuthMethodOptions) GetNone ¶
func (x *AuthMethodOptions) GetNone() *AuthMethodNone
func (*AuthMethodOptions) ProtoMessage ¶
func (*AuthMethodOptions) ProtoMessage()
func (*AuthMethodOptions) ProtoReflect ¶
func (x *AuthMethodOptions) ProtoReflect() protoreflect.Message
func (*AuthMethodOptions) Reset ¶
func (x *AuthMethodOptions) Reset()
func (*AuthMethodOptions) String ¶
func (x *AuthMethodOptions) String() string
type AuthMethodOptions_JwtBearer ¶
type AuthMethodOptions_JwtBearer struct {
JwtBearer *AuthMethodJWTBearer `protobuf:"bytes,10,opt,name=jwt_bearer,json=jwtBearer,proto3,oneof"`
}
type AuthMethodOptions_None ¶
type AuthMethodOptions_None struct {
None *AuthMethodNone `protobuf:"bytes,11,opt,name=none,proto3,oneof"`
}
type AuthenticatedActor ¶
type AuthenticatedActor struct { // The unique identifier of the actor, derived from the various actor type // methods. Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` Type *ActorType `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"` Claim *Claim `protobuf:"bytes,3,opt,name=claim,proto3" json:"claim,omitempty"` // Arbitrary tags that are defined by the authorizing system to quickly // identify the user e.g. the user's email address, API Key Name, etc. // Must not be used in authorization logic, and should not be used as a // the primary source of the actor's identity. ActorTags map[string]string `` /* 176-byte string literal not displayed */ // contains filtered or unexported fields }
func (*AuthenticatedActor) Descriptor
deprecated
func (*AuthenticatedActor) Descriptor() ([]byte, []int)
Deprecated: Use AuthenticatedActor.ProtoReflect.Descriptor instead.
func (*AuthenticatedActor) GetActorTags ¶
func (x *AuthenticatedActor) GetActorTags() map[string]string
func (*AuthenticatedActor) GetClaim ¶
func (x *AuthenticatedActor) GetClaim() *Claim
func (*AuthenticatedActor) GetId ¶
func (x *AuthenticatedActor) GetId() string
func (*AuthenticatedActor) GetType ¶
func (x *AuthenticatedActor) GetType() *ActorType
func (*AuthenticatedActor) ProtoMessage ¶
func (*AuthenticatedActor) ProtoMessage()
func (*AuthenticatedActor) ProtoReflect ¶
func (x *AuthenticatedActor) ProtoReflect() protoreflect.Message
func (*AuthenticatedActor) Reset ¶
func (x *AuthenticatedActor) Reset()
func (*AuthenticatedActor) String ¶
func (x *AuthenticatedActor) String() string
type Claim ¶
type Claim struct { // The actor is only authorized to view and access resources which // match **ALL** of the filters. // Keys are globally unique, values are UUIDs. TenantFilter map[string]string `` /* 185-byte string literal not displayed */ Scopes []string `protobuf:"bytes,2,rep,name=scopes,proto3" json:"scopes,omitempty"` // contains filtered or unexported fields }
func (*Claim) ProtoReflect ¶
func (x *Claim) ProtoReflect() protoreflect.Message
type ClientAuthType ¶
type ClientAuthType struct { // Types that are assignable to Type: // // *ClientAuthType_Jwt // *ClientAuthType_Session Type isClientAuthType_Type `protobuf_oneof:"type"` // contains filtered or unexported fields }
func (*ClientAuthType) Descriptor
deprecated
func (*ClientAuthType) Descriptor() ([]byte, []int)
Deprecated: Use ClientAuthType.ProtoReflect.Descriptor instead.
func (*ClientAuthType) GetJwt ¶
func (x *ClientAuthType) GetJwt() *ClientAuthType_JWTAuth
func (*ClientAuthType) GetSession ¶
func (x *ClientAuthType) GetSession() *ClientAuthType_SessionAuth
func (*ClientAuthType) GetType ¶
func (m *ClientAuthType) GetType() isClientAuthType_Type
func (*ClientAuthType) ProtoMessage ¶
func (*ClientAuthType) ProtoMessage()
func (*ClientAuthType) ProtoReflect ¶
func (x *ClientAuthType) ProtoReflect() protoreflect.Message
func (*ClientAuthType) Reset ¶
func (x *ClientAuthType) Reset()
func (*ClientAuthType) String ¶
func (x *ClientAuthType) String() string
type ClientAuthType_JWTAuth ¶
type ClientAuthType_JWTAuth struct { JwtId string `protobuf:"bytes,1,opt,name=jwt_id,json=jwtId,proto3" json:"jwt_id,omitempty"` Issuer string `protobuf:"bytes,2,opt,name=issuer,proto3" json:"issuer,omitempty"` IssuedAt *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=issued_at,json=issuedAt,proto3" json:"issued_at,omitempty"` // contains filtered or unexported fields }
func (*ClientAuthType_JWTAuth) Descriptor
deprecated
func (*ClientAuthType_JWTAuth) Descriptor() ([]byte, []int)
Deprecated: Use ClientAuthType_JWTAuth.ProtoReflect.Descriptor instead.
func (*ClientAuthType_JWTAuth) GetIssuedAt ¶
func (x *ClientAuthType_JWTAuth) GetIssuedAt() *timestamppb.Timestamp
func (*ClientAuthType_JWTAuth) GetIssuer ¶
func (x *ClientAuthType_JWTAuth) GetIssuer() string
func (*ClientAuthType_JWTAuth) GetJwtId ¶
func (x *ClientAuthType_JWTAuth) GetJwtId() string
func (*ClientAuthType_JWTAuth) ProtoMessage ¶
func (*ClientAuthType_JWTAuth) ProtoMessage()
func (*ClientAuthType_JWTAuth) ProtoReflect ¶
func (x *ClientAuthType_JWTAuth) ProtoReflect() protoreflect.Message
func (*ClientAuthType_JWTAuth) Reset ¶
func (x *ClientAuthType_JWTAuth) Reset()
func (*ClientAuthType_JWTAuth) String ¶
func (x *ClientAuthType_JWTAuth) String() string
type ClientAuthType_Jwt ¶
type ClientAuthType_Jwt struct {
Jwt *ClientAuthType_JWTAuth `protobuf:"bytes,1,opt,name=jwt,proto3,oneof"`
}
type ClientAuthType_Session ¶
type ClientAuthType_Session struct {
Session *ClientAuthType_SessionAuth `protobuf:"bytes,2,opt,name=session,proto3,oneof"`
}
type ClientAuthType_SessionAuth ¶
type ClientAuthType_SessionAuth struct { // The identity of the system which stored and evaluated the session. SessionManager string `protobuf:"bytes,1,opt,name=session_manager,json=sessionManager,proto3" json:"session_manager,omitempty"` // The session ID as defined by the session manager SessionId string `protobuf:"bytes,2,opt,name=session_id,json=sessionId,proto3" json:"session_id,omitempty"` // The time at which the session was verified by the session manager. VerifiedAt *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=verified_at,json=verifiedAt,proto3" json:"verified_at,omitempty"` // The time at which the session began at the session manager. (e.g. the // time a refresh token was used to create a new session) AuthenticatedAt *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=authenticated_at,json=authenticatedAt,proto3" json:"authenticated_at,omitempty"` // contains filtered or unexported fields }
func (*ClientAuthType_SessionAuth) Descriptor
deprecated
func (*ClientAuthType_SessionAuth) Descriptor() ([]byte, []int)
Deprecated: Use ClientAuthType_SessionAuth.ProtoReflect.Descriptor instead.
func (*ClientAuthType_SessionAuth) GetAuthenticatedAt ¶
func (x *ClientAuthType_SessionAuth) GetAuthenticatedAt() *timestamppb.Timestamp
func (*ClientAuthType_SessionAuth) GetSessionId ¶
func (x *ClientAuthType_SessionAuth) GetSessionId() string
func (*ClientAuthType_SessionAuth) GetSessionManager ¶
func (x *ClientAuthType_SessionAuth) GetSessionManager() string
func (*ClientAuthType_SessionAuth) GetVerifiedAt ¶
func (x *ClientAuthType_SessionAuth) GetVerifiedAt() *timestamppb.Timestamp
func (*ClientAuthType_SessionAuth) ProtoMessage ¶
func (*ClientAuthType_SessionAuth) ProtoMessage()
func (*ClientAuthType_SessionAuth) ProtoReflect ¶
func (x *ClientAuthType_SessionAuth) ProtoReflect() protoreflect.Message
func (*ClientAuthType_SessionAuth) Reset ¶
func (x *ClientAuthType_SessionAuth) Reset()
func (*ClientAuthType_SessionAuth) String ¶
func (x *ClientAuthType_SessionAuth) String() string