viam.proto.rpc.auth

@generated by Viam. Do not edit manually!

Module Contents

Classes

AuthServiceBase	Helper class that provides a standard way to create an ABC using
AuthServiceStub
ExternalAuthServiceBase	Helper class that provides a standard way to create an ABC using
ExternalAuthServiceStub
AuthenticateRequest	An AuthenticateRequest contains the credentials used to authenticate.
AuthenticateResponse	An AuthenticateResponse is returned after successful authentication.
AuthenticateToRequest	An AuthenticateToRequest contains the entity to authenticate to.
AuthenticateToResponse	An AuthenticateResponse is returned after successful authentication.
Credentials	Abstract base class for protocol messages.

class viam.proto.rpc.auth.AuthServiceBase

Bases: abc.ABC

Helper class that provides a standard way to create an ABC using inheritance.

abstract async Authenticate(stream: grpclib.server.Stream[proto.rpc.v1.auth_pb2.AuthenticateRequest, proto.rpc.v1.auth_pb2.AuthenticateResponse]) → None

__mapping__() → Dict[str, grpclib.const.Handler]

class viam.proto.rpc.auth.AuthServiceStub(channel: grpclib.client.Channel)

class viam.proto.rpc.auth.ExternalAuthServiceBase

Bases: abc.ABC

Helper class that provides a standard way to create an ABC using inheritance.

abstract async AuthenticateTo(stream: grpclib.server.Stream[proto.rpc.v1.auth_pb2.AuthenticateToRequest, proto.rpc.v1.auth_pb2.AuthenticateToResponse]) → None

__mapping__() → Dict[str, grpclib.const.Handler]

class viam.proto.rpc.auth.ExternalAuthServiceStub(channel: grpclib.client.Channel)

class viam.proto.rpc.auth.AuthenticateRequest(*, entity: str = ..., credentials: global___Credentials | None = ...)

Bases: google.protobuf.message.Message

An AuthenticateRequest contains the credentials used to authenticate.

property credentials: global___Credentials

entity: str

HasField(field_name: Literal[credentials, b'credentials']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.rpc.auth.AuthenticateResponse(*, access_token: str = ...)

Bases: google.protobuf.message.Message

An AuthenticateResponse is returned after successful authentication.

access_token: str

access_token is a JWT where only the expiration should be deemed important. Future(erd): maybe a refresh_token

class viam.proto.rpc.auth.AuthenticateToRequest(*, entity: str = ...)

Bases: google.protobuf.message.Message

An AuthenticateToRequest contains the entity to authenticate to.

entity: str

class viam.proto.rpc.auth.AuthenticateToResponse(*, access_token: str = ...)

Bases: google.protobuf.message.Message

An AuthenticateResponse is returned after successful authentication.

access_token: str

access_token is a JWT where only the expiration should be deemed important. Future(erd): maybe a refresh_token

class viam.proto.rpc.auth.Credentials(*, type: str = ..., payload: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

type: str

type is the type of credentials being used.

payload: str

payload is an opaque string used that are of the given type above.