info/auth.proto

Table of Contents

• info/auth.proto

  • Account

  • AddAccountRequest

  • AddAccountResponse

  • GenerateTokenRequest

  • GenerateTokenResponse

  • Permission

  • RemoveAccountRequest

  • RemoveAccountResponse

  • Token

  • UpdateAccountPermissionsRequest

  • UpdateAccountPermissionsResponse

  • AuthProvider

• Scalar Value Types

Top

info/auth.proto

Account

Represents an account which has access to this system

Field	Type	Label	Description
name	string		The account identifier
title	string		A descriptive name for this account
token	Token		The current token for this account
permissions	Permission	repeated	The set of permissions granted to the token bearer

AddAccountRequest

Field	Type	Label	Description
name	string
title	string
permissions	Permission	repeated

AddAccountResponse

Field	Type	Label	Description
account	Account

GenerateTokenRequest

Field	Type	Label	Description
account_name	string

GenerateTokenResponse

Field	Type	Label	Description
token	Token

Permission

Describes a permission level for a particular device-trait

Field	Type	Label	Description
device_name	string		The fully qualified name of the device this permission represents, or '*' for all devices
trait_name	string		The fully qualified name of the trait on the specified device this permission represents (in package.Service format), or '*' for all traits
read	bool		Whether to allow read calls for this device-trait
write	bool		Whether to allow write calls for this device-trait
observe	bool		Whether to allow observe calls (i.e. Pull requests) for this device-trait

RemoveAccountRequest

Field	Type	Label	Description
name	string

RemoveAccountResponse

Token

Represents a token that can be granted against an Account for

Field	Type	Label	Description
id	string		The token ID string
expires_at	google.protobuf.Timestamp		A time the token expires

UpdateAccountPermissionsRequest

Field	Type	Label	Description
change_type	smartcore.types.ChangeType
permissions	Permission	repeated

UpdateAccountPermissionsResponse

AuthProvider

The auth provider service enables granular control of security permissions for a particular Smart Core controller or system. It does this using the concept of 'Accounts', each of which has a certain set of permissions for which device(s) and/or trait(s)/service(s) they are allowed to access.

Method Name	Request Type	Response Type	Description
AddAccount	AddAccountRequest	AddAccountResponse
RemoveAccount	RemoveAccountRequest	RemoveAccountResponse
UpdateAccountPermissions	UpdateAccountPermissionsRequest	UpdateAccountPermissionsResponse
GenerateToken	GenerateTokenRequest	GenerateTokenResponse

Scalar Value Types

.proto Type	Notes	C++	Java	Python	Go	C#	PHP	Ruby
double		double	double	float	float64	double	float	Float
float		float	float	float	float32	float	float	Float
int32	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
int64	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.	int64	long	int/long	int64	long	integer/string	Bignum
uint32	Uses variable-length encoding.	uint32	int	int/long	uint32	uint	integer	Bignum or Fixnum (as required)
uint64	Uses variable-length encoding.	uint64	long	int/long	uint64	ulong	integer/string	Bignum or Fixnum (as required)
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int64	long	int/long	int64	long	integer/string	Bignum
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	uint32	int	int	uint32	uint	integer	Bignum or Fixnum (as required)
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	uint64	long	int/long	uint64	ulong	integer/string	Bignum
sfixed32	Always four bytes.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sfixed64	Always eight bytes.	int64	long	int/long	int64	long	integer/string	Bignum
bool		bool	boolean	boolean	bool	bool	boolean	TrueClass/FalseClass
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	string	String	str/unicode	string	string	string	String (UTF-8)
bytes	May contain any arbitrary sequence of bytes.	string	ByteString	str	[]byte	ByteString	string	String (ASCII-8BIT)