serviceaccount.v1

Top

arista/serviceaccount.v1/serviceaccount.proto

Account

Account describes a service account.

Field NameTypeDescription
keyAccountKey

key uniquely identifies the service account.

statusAccountStatus

status determines whether the service account is enabled or disabled.

descriptiongoogle.protobuf.StringValue

description is a comment describing the service account.

groupsfmp.RepeatedString

groups is a list of roles that the service account inherits permissions from.

created_bygoogle.protobuf.StringValue

created_by is the name of the entity that created the service account.

last_accessgoogle.protobuf.Timestamp

last_access is the time when the service account was last fetched.

AccountConfig

AccountConfig holds the configuration for a service account.

Field NameTypeDescription
keyAccountKey

key contains the name of the service account.

statusAccountStatus

status determines if the service account is enabled or disabled. New service accounts are

enabled by default.

descriptiongoogle.protobuf.StringValue

description is a comment describing the service account.

groupsfmp.RepeatedString

groups is a list of roles that the service account inherits permissions from.

AccountKey

AccountKey contains the name of the service account.

Field NameTypeDescription
namegoogle.protobuf.StringValue

name is the unique identifier of the service account.

Token

Token describes a service account token.

Field NameTypeDescription
keyTokenKey

key uniquely identifies the service account token.

usergoogle.protobuf.StringValue

user is the name of the service account that the token is generated for.

descriptiongoogle.protobuf.StringValue

description is a short name or comment used to identify the service account token.

valid_untilgoogle.protobuf.Timestamp

valid_until is the time that the service account token will be valid until.

created_bygoogle.protobuf.StringValue

created_by is the name of the entity that created the service account token.

last_usedgoogle.protobuf.Timestamp

last_used is the time when the service account token was last used to authenticate.

TokenConfig

TokenConfig holds the configuration for a service account token. The token is a signed JWT which can be used as a credential for REST and WRPC endpoints.

Field NameTypeDescription
keyTokenKey

key uniquely identifies the service account token.

usergoogle.protobuf.StringValue

user is the name of the service account that the token is generated for.

descriptiongoogle.protobuf.StringValue

description is a short name or comment used to identify the service account token.

valid_forgoogle.protobuf.Duration

valid_for determines the duration that the service account token will be valid for.

tokengoogle.protobuf.StringValue

token is the JWT token generated for a service account token.

It is only populated in Set response.

TokenKey

TokenKey contains service account token ID.

Field NameTypeDescription
idgoogle.protobuf.StringValue

id is the unique identifier of the service account token.

AccountStatus

AccountStatus determines whether an service account is enabled or disabled.

NameNumberDescription
ACCOUNT_STATUS_UNSPECIFIED0

ACCOUNT_STATUS_UNSPECIFIED indicates the service account status is unspecified.

ACCOUNT_STATUS_ENABLED1

ACCOUNT_STATUS_ENABLED indicates the service account is enabled.

ACCOUNT_STATUS_DISABLED2

ACCOUNT_STATUS_DISABLED indicates the service account is disabled.

Top

arista/serviceaccount.v1/services.gen.proto

AccountConfigDeleteAllRequest

AccountConfigDeleteAllResponse

Field NameTypeDescription
typefmp.DeleteError

This describes the class of delete error.

errorgoogle.protobuf.StringValue

This indicates the error message from the delete failure.

keyAccountKey

This is the key of the AccountConfig instance that failed to be deleted.

timegoogle.protobuf.Timestamp

Time indicates the (UTC) timestamp when the key was being deleted.

AccountConfigDeleteRequest

Field NameTypeDescription
keyAccountKey

Key indicates which AccountConfig instance to remove.

This field must always be set.

AccountConfigDeleteResponse

Field NameTypeDescription
keyAccountKey

Key echoes back the key of the deleted AccountConfig instance.

timegoogle.protobuf.Timestamp

Time indicates the (UTC) timestamp at which the system recognizes the

deletion. The only guarantees made about this timestamp are:

- it is after the time the request was received

- a time-ranged query with StartTime==DeletedAt will not include this instance.

AccountConfigDeleteSomeRequest

Field NameTypeDescription
keysAccountKey[…]

key contains a list of AccountConfig keys to delete

AccountConfigDeleteSomeResponse

AccountConfigDeleteSomeResponse is only sent when there is an error.

Field NameTypeDescription
keyAccountKey

errorstring

AccountConfigRequest

Field NameTypeDescription
keyAccountKey

Key uniquely identifies a AccountConfig instance to retrieve.

This value must be populated.

timegoogle.protobuf.Timestamp

Time indicates the time for which you are interested in the data.

If no time is given, the server will use the time at which it makes the request.

AccountConfigResponse

Field NameTypeDescription
valueAccountConfig

Value is the value requested.

This structure will be fully-populated as it exists in the datastore. If

optional fields were not given at creation, these fields will be empty or

set to default values.

timegoogle.protobuf.Timestamp

Time carries the (UTC) timestamp of the last-modification of the

AccountConfig instance in this response.

AccountConfigSetRequest

Field NameTypeDescription
valueAccountConfig

AccountConfig carries the value to set into the datastore.

See the documentation on the AccountConfig struct for which fields are required.

AccountConfigSetResponse

Field NameTypeDescription
valueAccountConfig

Value carries all the values given in the AccountConfigSetRequest as well

as any server-generated values.

timegoogle.protobuf.Timestamp

Time indicates the (UTC) timestamp at which the system recognizes the

creation. The only guarantees made about this timestamp are:

- it is after the time the request was received

- a time-ranged query with StartTime==CreatedAt will include this instance.

AccountConfigSetSomeRequest

Field NameTypeDescription
valuesAccountConfig[…]

value contains a list of AccountConfig values to write.

It is possible to provide more values than can fit within either:

- the maxiumum send size of the client

- the maximum receive size of the server

If this error occurs you must reduce the number of values sent.

See gRPC “maximum message size” documentation for more information.

AccountConfigSetSomeResponse

Field NameTypeDescription
keyAccountKey

errorstring

AccountConfigSomeRequest

Field NameTypeDescription
keysAccountKey[…]

timegoogle.protobuf.Timestamp

Time indicates the time for which you are interested in the data.

If no time is given, the server will use the time at which it makes the request.

AccountConfigSomeResponse

Field NameTypeDescription
valueAccountConfig

Value is the value requested.

This structure will be fully-populated as it exists in the datastore. If

optional fields were not given at creation, these fields will be empty or

set to default values.

errorgoogle.protobuf.StringValue

Error is an optional field.

It should be filled when there is an error in the GetSome process.

timegoogle.protobuf.Timestamp

AccountConfigStreamRequest

Field NameTypeDescription
partial_eq_filterAccountConfig[…]

PartialEqFilter provides a way to server-side filter a GetAll/Subscribe.

This requires all provided fields to be equal to the response.

While transparent to users, this field also allows services to optimize internal

subscriptions if filter(s) are sufficiently specific.

timearista.time.TimeBounds

TimeRange allows limiting response data to within a specified time window.

If this field is populated, at least one of the two time fields are required.

For GetAll, the fields start and end can be used as follows:

* end: Returns the state of each AccountConfig at end.

* Each AccountConfig response is fully-specified (all fields set).

* start: Returns the state of each AccountConfig at start, followed by updates until now.

* Each AccountConfig response at start is fully-specified, but updates may be partial.

* start and end: Returns the state of each AccountConfig at start, followed by updates

until end.

* Each AccountConfig response at start is fully-specified, but updates until end may

be partial.

This field is not allowed in the Subscribe RPC.

AccountConfigStreamResponse

Field NameTypeDescription
valueAccountConfig

Value is a value deemed relevant to the initiating request.

This structure will always have its key-field populated. Which other fields are

populated, and why, depends on the value of Operation and what triggered this notification.

timegoogle.protobuf.Timestamp

Time holds the timestamp of this AccountConfig’s last modification.

typearista.subscriptions.Operation

Operation indicates how the AccountConfig value in this response should be considered.

Under non-subscribe requests, this value should always be INITIAL. In a subscription,

once all initial data is streamed and the client begins to receive modification updates,

you should not see INITIAL again.

AccountRequest

Field NameTypeDescription
keyAccountKey

Key uniquely identifies a Account instance to retrieve.

This value must be populated.

timegoogle.protobuf.Timestamp

Time indicates the time for which you are interested in the data.

If no time is given, the server will use the time at which it makes the request.

AccountResponse

Field NameTypeDescription
valueAccount

Value is the value requested.

This structure will be fully-populated as it exists in the datastore. If

optional fields were not given at creation, these fields will be empty or

set to default values.

timegoogle.protobuf.Timestamp

Time carries the (UTC) timestamp of the last-modification of the

Account instance in this response.

AccountSomeRequest

Field NameTypeDescription
keysAccountKey[…]

timegoogle.protobuf.Timestamp

Time indicates the time for which you are interested in the data.

If no time is given, the server will use the time at which it makes the request.

AccountSomeResponse

Field NameTypeDescription
valueAccount

Value is the value requested.

This structure will be fully-populated as it exists in the datastore. If

optional fields were not given at creation, these fields will be empty or

set to default values.

errorgoogle.protobuf.StringValue

Error is an optional field.

It should be filled when there is an error in the GetSome process.

timegoogle.protobuf.Timestamp

AccountStreamRequest

Field NameTypeDescription
partial_eq_filterAccount[…]

PartialEqFilter provides a way to server-side filter a GetAll/Subscribe.

This requires all provided fields to be equal to the response.

While transparent to users, this field also allows services to optimize internal

subscriptions if filter(s) are sufficiently specific.

timearista.time.TimeBounds

TimeRange allows limiting response data to within a specified time window.

If this field is populated, at least one of the two time fields are required.

For GetAll, the fields start and end can be used as follows:

* end: Returns the state of each Account at end.

* Each Account response is fully-specified (all fields set).

* start: Returns the state of each Account at start, followed by updates until now.

* Each Account response at start is fully-specified, but updates may be partial.

* start and end: Returns the state of each Account at start, followed by updates

until end.

* Each Account response at start is fully-specified, but updates until end may

be partial.

This field is not allowed in the Subscribe RPC.

AccountStreamResponse

Field NameTypeDescription
valueAccount

Value is a value deemed relevant to the initiating request.

This structure will always have its key-field populated. Which other fields are

populated, and why, depends on the value of Operation and what triggered this notification.

timegoogle.protobuf.Timestamp

Time holds the timestamp of this Account’s last modification.

typearista.subscriptions.Operation

Operation indicates how the Account value in this response should be considered.

Under non-subscribe requests, this value should always be INITIAL. In a subscription,

once all initial data is streamed and the client begins to receive modification updates,

you should not see INITIAL again.

MetaResponse

Field NameTypeDescription
timegoogle.protobuf.Timestamp

Time holds the timestamp of the last item included in the metadata calculation.

typearista.subscriptions.Operation

Operation indicates how the value in this response should be considered.

Under non-subscribe requests, this value should always be INITIAL. In a subscription,

once all initial data is streamed and the client begins to receive modification updates,

you should not see INITIAL again.

countgoogle.protobuf.UInt32Value

Count is the number of items present under the conditions of the request.

TokenConfigDeleteAllRequest

TokenConfigDeleteAllResponse

Field NameTypeDescription
typefmp.DeleteError

This describes the class of delete error.

errorgoogle.protobuf.StringValue

This indicates the error message from the delete failure.

keyTokenKey

This is the key of the TokenConfig instance that failed to be deleted.

timegoogle.protobuf.Timestamp

Time indicates the (UTC) timestamp when the key was being deleted.

TokenConfigDeleteRequest

Field NameTypeDescription
keyTokenKey

Key indicates which TokenConfig instance to remove.

This field must always be set.

TokenConfigDeleteResponse

Field NameTypeDescription
keyTokenKey

Key echoes back the key of the deleted TokenConfig instance.

timegoogle.protobuf.Timestamp

Time indicates the (UTC) timestamp at which the system recognizes the

deletion. The only guarantees made about this timestamp are:

- it is after the time the request was received

- a time-ranged query with StartTime==DeletedAt will not include this instance.

TokenConfigDeleteSomeRequest

Field NameTypeDescription
keysTokenKey[…]

key contains a list of TokenConfig keys to delete

TokenConfigDeleteSomeResponse

TokenConfigDeleteSomeResponse is only sent when there is an error.

Field NameTypeDescription
keyTokenKey

errorstring

TokenConfigRequest

Field NameTypeDescription
keyTokenKey

Key uniquely identifies a TokenConfig instance to retrieve.

This value must be populated.

timegoogle.protobuf.Timestamp

Time indicates the time for which you are interested in the data.

If no time is given, the server will use the time at which it makes the request.

TokenConfigResponse

Field NameTypeDescription
valueTokenConfig

Value is the value requested.

This structure will be fully-populated as it exists in the datastore. If

optional fields were not given at creation, these fields will be empty or

set to default values.

timegoogle.protobuf.Timestamp

Time carries the (UTC) timestamp of the last-modification of the

TokenConfig instance in this response.

TokenConfigSetRequest

Field NameTypeDescription
valueTokenConfig

TokenConfig carries the value to set into the datastore.

See the documentation on the TokenConfig struct for which fields are required.

TokenConfigSetResponse

Field NameTypeDescription
valueTokenConfig

Value carries all the values given in the TokenConfigSetRequest as well

as any server-generated values.

timegoogle.protobuf.Timestamp

Time indicates the (UTC) timestamp at which the system recognizes the

creation. The only guarantees made about this timestamp are:

- it is after the time the request was received

- a time-ranged query with StartTime==CreatedAt will include this instance.

TokenConfigSetSomeRequest

Field NameTypeDescription
valuesTokenConfig[…]

value contains a list of TokenConfig values to write.

It is possible to provide more values than can fit within either:

- the maxiumum send size of the client

- the maximum receive size of the server

If this error occurs you must reduce the number of values sent.

See gRPC “maximum message size” documentation for more information.

TokenConfigSetSomeResponse

Field NameTypeDescription
keyTokenKey

errorstring

TokenConfigSomeRequest

Field NameTypeDescription
keysTokenKey[…]

timegoogle.protobuf.Timestamp

Time indicates the time for which you are interested in the data.

If no time is given, the server will use the time at which it makes the request.

TokenConfigSomeResponse

Field NameTypeDescription
valueTokenConfig

Value is the value requested.

This structure will be fully-populated as it exists in the datastore. If

optional fields were not given at creation, these fields will be empty or

set to default values.

errorgoogle.protobuf.StringValue

Error is an optional field.

It should be filled when there is an error in the GetSome process.

timegoogle.protobuf.Timestamp

TokenConfigStreamRequest

Field NameTypeDescription
partial_eq_filterTokenConfig[…]

PartialEqFilter provides a way to server-side filter a GetAll/Subscribe.

This requires all provided fields to be equal to the response.

While transparent to users, this field also allows services to optimize internal

subscriptions if filter(s) are sufficiently specific.

timearista.time.TimeBounds

TimeRange allows limiting response data to within a specified time window.

If this field is populated, at least one of the two time fields are required.

For GetAll, the fields start and end can be used as follows:

* end: Returns the state of each TokenConfig at end.

* Each TokenConfig response is fully-specified (all fields set).

* start: Returns the state of each TokenConfig at start, followed by updates until now.

* Each TokenConfig response at start is fully-specified, but updates may be partial.

* start and end: Returns the state of each TokenConfig at start, followed by updates

until end.

* Each TokenConfig response at start is fully-specified, but updates until end may

be partial.

This field is not allowed in the Subscribe RPC.

TokenConfigStreamResponse

Field NameTypeDescription
valueTokenConfig

Value is a value deemed relevant to the initiating request.

This structure will always have its key-field populated. Which other fields are

populated, and why, depends on the value of Operation and what triggered this notification.

timegoogle.protobuf.Timestamp

Time holds the timestamp of this TokenConfig’s last modification.

typearista.subscriptions.Operation

Operation indicates how the TokenConfig value in this response should be considered.

Under non-subscribe requests, this value should always be INITIAL. In a subscription,

once all initial data is streamed and the client begins to receive modification updates,

you should not see INITIAL again.

TokenRequest

Field NameTypeDescription
keyTokenKey

Key uniquely identifies a Token instance to retrieve.

This value must be populated.

timegoogle.protobuf.Timestamp

Time indicates the time for which you are interested in the data.

If no time is given, the server will use the time at which it makes the request.

TokenResponse

Field NameTypeDescription
valueToken

Value is the value requested.

This structure will be fully-populated as it exists in the datastore. If

optional fields were not given at creation, these fields will be empty or

set to default values.

timegoogle.protobuf.Timestamp

Time carries the (UTC) timestamp of the last-modification of the

Token instance in this response.

TokenSomeRequest

Field NameTypeDescription
keysTokenKey[…]

timegoogle.protobuf.Timestamp

Time indicates the time for which you are interested in the data.

If no time is given, the server will use the time at which it makes the request.

TokenSomeResponse

Field NameTypeDescription
valueToken

Value is the value requested.

This structure will be fully-populated as it exists in the datastore. If

optional fields were not given at creation, these fields will be empty or

set to default values.

errorgoogle.protobuf.StringValue

Error is an optional field.

It should be filled when there is an error in the GetSome process.

timegoogle.protobuf.Timestamp

TokenStreamRequest

Field NameTypeDescription
partial_eq_filterToken[…]

PartialEqFilter provides a way to server-side filter a GetAll/Subscribe.

This requires all provided fields to be equal to the response.

While transparent to users, this field also allows services to optimize internal

subscriptions if filter(s) are sufficiently specific.

timearista.time.TimeBounds

TimeRange allows limiting response data to within a specified time window.

If this field is populated, at least one of the two time fields are required.

For GetAll, the fields start and end can be used as follows:

* end: Returns the state of each Token at end.

* Each Token response is fully-specified (all fields set).

* start: Returns the state of each Token at start, followed by updates until now.

* Each Token response at start is fully-specified, but updates may be partial.

* start and end: Returns the state of each Token at start, followed by updates

until end.

* Each Token response at start is fully-specified, but updates until end may

be partial.

This field is not allowed in the Subscribe RPC.

TokenStreamResponse

Field NameTypeDescription
valueToken

Value is a value deemed relevant to the initiating request.

This structure will always have its key-field populated. Which other fields are

populated, and why, depends on the value of Operation and what triggered this notification.

timegoogle.protobuf.Timestamp

Time holds the timestamp of this Token’s last modification.

typearista.subscriptions.Operation

Operation indicates how the Token value in this response should be considered.

Under non-subscribe requests, this value should always be INITIAL. In a subscription,

once all initial data is streamed and the client begins to receive modification updates,

you should not see INITIAL again.

AccountConfigService

Method NameRequest TypeResponse TypeDescription
GetOneAccountConfigRequestAccountConfigResponse

GetSomeAccountConfigSomeRequestAccountConfigSomeResponse stream

GetAllAccountConfigStreamRequestAccountConfigStreamResponse stream

SubscribeAccountConfigStreamRequestAccountConfigStreamResponse stream

GetMetaAccountConfigStreamRequestMetaResponse

SubscribeMetaAccountConfigStreamRequestMetaResponse stream

SetAccountConfigSetRequestAccountConfigSetResponse

SetSomeAccountConfigSetSomeRequestAccountConfigSetSomeResponse stream

DeleteAccountConfigDeleteRequestAccountConfigDeleteResponse

DeleteSomeAccountConfigDeleteSomeRequestAccountConfigDeleteSomeResponse stream

DeleteAllAccountConfigDeleteAllRequestAccountConfigDeleteAllResponse stream

AccountService

Method NameRequest TypeResponse TypeDescription
GetOneAccountRequestAccountResponse

GetSomeAccountSomeRequestAccountSomeResponse stream

GetAllAccountStreamRequestAccountStreamResponse stream

SubscribeAccountStreamRequestAccountStreamResponse stream

GetMetaAccountStreamRequestMetaResponse

SubscribeMetaAccountStreamRequestMetaResponse stream

TokenConfigService

Method NameRequest TypeResponse TypeDescription
GetOneTokenConfigRequestTokenConfigResponse

GetSomeTokenConfigSomeRequestTokenConfigSomeResponse stream

GetAllTokenConfigStreamRequestTokenConfigStreamResponse stream

SubscribeTokenConfigStreamRequestTokenConfigStreamResponse stream

GetMetaTokenConfigStreamRequestMetaResponse

SubscribeMetaTokenConfigStreamRequestMetaResponse stream

SetTokenConfigSetRequestTokenConfigSetResponse

SetSomeTokenConfigSetSomeRequestTokenConfigSetSomeResponse stream

DeleteTokenConfigDeleteRequestTokenConfigDeleteResponse

DeleteSomeTokenConfigDeleteSomeRequestTokenConfigDeleteSomeResponse stream

DeleteAllTokenConfigDeleteAllRequestTokenConfigDeleteAllResponse stream

TokenService

Method NameRequest TypeResponse TypeDescription
GetOneTokenRequestTokenResponse

GetSomeTokenSomeRequestTokenSomeResponse stream

GetAllTokenStreamRequestTokenStreamResponse stream

SubscribeTokenStreamRequestTokenStreamResponse stream

GetMetaTokenStreamRequestMetaResponse

SubscribeMetaTokenStreamRequestMetaResponse stream