Account describes a service account.
Field Name | Type | Description |
---|---|---|
key | AccountKey | key uniquely identifies the service account. |
status | AccountStatus | status determines whether the service account is enabled or disabled. |
description | google.protobuf.StringValue | description is a comment describing the service account. |
groups | fmp.RepeatedString | groups is a list of roles that the service account inherits permissions from. |
created_by | google.protobuf.StringValue | created_by is the name of the entity that created the service account. |
last_access | google.protobuf.Timestamp | last_access is the time when the service account was last fetched. |
AccountConfig holds the configuration for a service account.
Field Name | Type | Description |
---|---|---|
key | AccountKey | key contains the name of the service account. |
status | AccountStatus | status determines if the service account is enabled or disabled. New service accounts are enabled by default. |
description | google.protobuf.StringValue | description is a comment describing the service account. |
groups | fmp.RepeatedString | groups is a list of roles that the service account inherits permissions from. |
AccountKey contains the name of the service account.
Field Name | Type | Description |
---|---|---|
name | google.protobuf.StringValue | name is the unique identifier of the service account. |
Token describes a service account token.
Field Name | Type | Description |
---|---|---|
key | TokenKey | key uniquely identifies the service account token. |
user | google.protobuf.StringValue | user is the name of the service account that the token is generated for. |
description | google.protobuf.StringValue | description is a short name or comment used to identify the service account token. |
valid_until | google.protobuf.Timestamp | valid_until is the time that the service account token will be valid until. |
created_by | google.protobuf.StringValue | created_by is the name of the entity that created the service account token. |
last_used | google.protobuf.Timestamp | last_used is the time when the service account token was last used to authenticate. |
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 Name | Type | Description |
---|---|---|
key | TokenKey | key uniquely identifies the service account token. |
user | google.protobuf.StringValue | user is the name of the service account that the token is generated for. |
description | google.protobuf.StringValue | description is a short name or comment used to identify the service account token. |
valid_for | google.protobuf.Duration | valid_for determines the duration that the service account token will be valid for. |
token | google.protobuf.StringValue | token is the JWT token generated for a service account token. It is only populated in Set response. |
TokenKey contains service account token ID.
Field Name | Type | Description |
---|---|---|
id | google.protobuf.StringValue | id is the unique identifier of the service account token. |
AccountStatus determines whether an service account is enabled or disabled.
Name | Number | Description |
---|---|---|
ACCOUNT_STATUS_UNSPECIFIED | 0 | ACCOUNT_STATUS_UNSPECIFIED indicates the service account status is unspecified. |
ACCOUNT_STATUS_ENABLED | 1 | ACCOUNT_STATUS_ENABLED indicates the service account is enabled. |
ACCOUNT_STATUS_DISABLED | 2 | ACCOUNT_STATUS_DISABLED indicates the service account is disabled. |
Field Name | Type | Description |
---|---|---|
type | fmp.DeleteError | This describes the class of delete error. |
error | google.protobuf.StringValue | This indicates the error message from the delete failure. |
key | AccountKey | This is the key of the AccountConfig instance that failed to be deleted. |
time | google.protobuf.Timestamp | Time indicates the (UTC) timestamp when the key was being deleted. |
Field Name | Type | Description |
---|---|---|
key | AccountKey | Key indicates which AccountConfig instance to remove. This field must always be set. |
Field Name | Type | Description |
---|---|---|
key | AccountKey | Key echoes back the key of the deleted AccountConfig instance. |
time | google.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. |
Field Name | Type | Description |
---|---|---|
keys | AccountKey[…] | key contains a list of AccountConfig keys to delete |
AccountConfigDeleteSomeResponse is only sent when there is an error.
Field Name | Type | Description |
---|---|---|
key | AccountKey | |
error | string |
Field Name | Type | Description |
---|---|---|
key | AccountKey | Key uniquely identifies a AccountConfig instance to retrieve. This value must be populated. |
time | google.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. |
Field Name | Type | Description |
---|---|---|
value | AccountConfig | 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. |
time | google.protobuf.Timestamp | Time carries the (UTC) timestamp of the last-modification of the AccountConfig instance in this response. |
Field Name | Type | Description |
---|---|---|
value | AccountConfig | AccountConfig carries the value to set into the datastore. See the documentation on the AccountConfig struct for which fields are required. |
Field Name | Type | Description |
---|---|---|
value | AccountConfig | Value carries all the values given in the AccountConfigSetRequest as well as any server-generated values. |
time | google.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. |
Field Name | Type | Description |
---|---|---|
values | AccountConfig[…] | 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. |
Field Name | Type | Description |
---|---|---|
key | AccountKey | |
error | string |
Field Name | Type | Description |
---|---|---|
keys | AccountKey[…] | |
time | google.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. |
Field Name | Type | Description |
---|---|---|
value | AccountConfig | 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. |
error | google.protobuf.StringValue | Error is an optional field. It should be filled when there is an error in the GetSome process. |
time | google.protobuf.Timestamp |
Field Name | Type | Description |
---|---|---|
partial_eq_filter | AccountConfig[…] | 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. |
time | arista.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. |
Field Name | Type | Description |
---|---|---|
value | AccountConfig | 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. |
time | google.protobuf.Timestamp | Time holds the timestamp of this AccountConfig’s last modification. |
type | arista.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. |
Field Name | Type | Description |
---|---|---|
key | AccountKey | Key uniquely identifies a Account instance to retrieve. This value must be populated. |
time | google.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. |
Field Name | Type | Description |
---|---|---|
value | Account | 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. |
time | google.protobuf.Timestamp | Time carries the (UTC) timestamp of the last-modification of the Account instance in this response. |
Field Name | Type | Description |
---|---|---|
keys | AccountKey[…] | |
time | google.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. |
Field Name | Type | Description |
---|---|---|
value | Account | 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. |
error | google.protobuf.StringValue | Error is an optional field. It should be filled when there is an error in the GetSome process. |
time | google.protobuf.Timestamp |
Field Name | Type | Description |
---|---|---|
partial_eq_filter | Account[…] | 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. |
time | arista.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. |
Field Name | Type | Description |
---|---|---|
value | Account | 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. |
time | google.protobuf.Timestamp | Time holds the timestamp of this Account’s last modification. |
type | arista.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. |
Field Name | Type | Description |
---|---|---|
time | google.protobuf.Timestamp | Time holds the timestamp of the last item included in the metadata calculation. |
type | arista.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. |
count | google.protobuf.UInt32Value | Count is the number of items present under the conditions of the request. |
Field Name | Type | Description |
---|---|---|
type | fmp.DeleteError | This describes the class of delete error. |
error | google.protobuf.StringValue | This indicates the error message from the delete failure. |
key | TokenKey | This is the key of the TokenConfig instance that failed to be deleted. |
time | google.protobuf.Timestamp | Time indicates the (UTC) timestamp when the key was being deleted. |
Field Name | Type | Description |
---|---|---|
key | TokenKey | Key indicates which TokenConfig instance to remove. This field must always be set. |
Field Name | Type | Description |
---|---|---|
key | TokenKey | Key echoes back the key of the deleted TokenConfig instance. |
time | google.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. |
Field Name | Type | Description |
---|---|---|
keys | TokenKey[…] | key contains a list of TokenConfig keys to delete |
TokenConfigDeleteSomeResponse is only sent when there is an error.
Field Name | Type | Description |
---|---|---|
key | TokenKey | |
error | string |
Field Name | Type | Description |
---|---|---|
key | TokenKey | Key uniquely identifies a TokenConfig instance to retrieve. This value must be populated. |
time | google.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. |
Field Name | Type | Description |
---|---|---|
value | TokenConfig | 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. |
time | google.protobuf.Timestamp | Time carries the (UTC) timestamp of the last-modification of the TokenConfig instance in this response. |
Field Name | Type | Description |
---|---|---|
value | TokenConfig | TokenConfig carries the value to set into the datastore. See the documentation on the TokenConfig struct for which fields are required. |
Field Name | Type | Description |
---|---|---|
value | TokenConfig | Value carries all the values given in the TokenConfigSetRequest as well as any server-generated values. |
time | google.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. |
Field Name | Type | Description |
---|---|---|
values | TokenConfig[…] | 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. |
Field Name | Type | Description |
---|---|---|
key | TokenKey | |
error | string |
Field Name | Type | Description |
---|---|---|
keys | TokenKey[…] | |
time | google.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. |
Field Name | Type | Description |
---|---|---|
value | TokenConfig | 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. |
error | google.protobuf.StringValue | Error is an optional field. It should be filled when there is an error in the GetSome process. |
time | google.protobuf.Timestamp |
Field Name | Type | Description |
---|---|---|
partial_eq_filter | TokenConfig[…] | 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. |
time | arista.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. |
Field Name | Type | Description |
---|---|---|
value | TokenConfig | 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. |
time | google.protobuf.Timestamp | Time holds the timestamp of this TokenConfig’s last modification. |
type | arista.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. |
Field Name | Type | Description |
---|---|---|
key | TokenKey | Key uniquely identifies a Token instance to retrieve. This value must be populated. |
time | google.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. |
Field Name | Type | Description |
---|---|---|
value | Token | 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. |
time | google.protobuf.Timestamp | Time carries the (UTC) timestamp of the last-modification of the Token instance in this response. |
Field Name | Type | Description |
---|---|---|
keys | TokenKey[…] | |
time | google.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. |
Field Name | Type | Description |
---|---|---|
value | Token | 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. |
error | google.protobuf.StringValue | Error is an optional field. It should be filled when there is an error in the GetSome process. |
time | google.protobuf.Timestamp |
Field Name | Type | Description |
---|---|---|
partial_eq_filter | Token[…] | 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. |
time | arista.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. |
Field Name | Type | Description |
---|---|---|
value | Token | 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. |
time | google.protobuf.Timestamp | Time holds the timestamp of this Token’s last modification. |
type | arista.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. |
Method Name | Request Type | Response Type | Description |
---|---|---|---|
GetOne | AccountConfigRequest | AccountConfigResponse | |
GetSome | AccountConfigSomeRequest | AccountConfigSomeResponse stream | |
GetAll | AccountConfigStreamRequest | AccountConfigStreamResponse stream | |
Subscribe | AccountConfigStreamRequest | AccountConfigStreamResponse stream | |
GetMeta | AccountConfigStreamRequest | MetaResponse | |
SubscribeMeta | AccountConfigStreamRequest | MetaResponse stream | |
Set | AccountConfigSetRequest | AccountConfigSetResponse | |
SetSome | AccountConfigSetSomeRequest | AccountConfigSetSomeResponse stream | |
Delete | AccountConfigDeleteRequest | AccountConfigDeleteResponse | |
DeleteSome | AccountConfigDeleteSomeRequest | AccountConfigDeleteSomeResponse stream | |
DeleteAll | AccountConfigDeleteAllRequest | AccountConfigDeleteAllResponse stream |
Method Name | Request Type | Response Type | Description |
---|---|---|---|
GetOne | AccountRequest | AccountResponse | |
GetSome | AccountSomeRequest | AccountSomeResponse stream | |
GetAll | AccountStreamRequest | AccountStreamResponse stream | |
Subscribe | AccountStreamRequest | AccountStreamResponse stream | |
GetMeta | AccountStreamRequest | MetaResponse | |
SubscribeMeta | AccountStreamRequest | MetaResponse stream |
Method Name | Request Type | Response Type | Description |
---|---|---|---|
GetOne | TokenConfigRequest | TokenConfigResponse | |
GetSome | TokenConfigSomeRequest | TokenConfigSomeResponse stream | |
GetAll | TokenConfigStreamRequest | TokenConfigStreamResponse stream | |
Subscribe | TokenConfigStreamRequest | TokenConfigStreamResponse stream | |
GetMeta | TokenConfigStreamRequest | MetaResponse | |
SubscribeMeta | TokenConfigStreamRequest | MetaResponse stream | |
Set | TokenConfigSetRequest | TokenConfigSetResponse | |
SetSome | TokenConfigSetSomeRequest | TokenConfigSetSomeResponse stream | |
Delete | TokenConfigDeleteRequest | TokenConfigDeleteResponse | |
DeleteSome | TokenConfigDeleteSomeRequest | TokenConfigDeleteSomeResponse stream | |
DeleteAll | TokenConfigDeleteAllRequest | TokenConfigDeleteAllResponse stream |
Method Name | Request Type | Response Type | Description |
---|---|---|---|
GetOne | TokenRequest | TokenResponse | |
GetSome | TokenSomeRequest | TokenSomeResponse stream | |
GetAll | TokenStreamRequest | TokenStreamResponse stream | |
Subscribe | TokenStreamRequest | TokenStreamResponse stream | |
GetMeta | TokenStreamRequest | MetaResponse | |
SubscribeMeta | TokenStreamRequest | MetaResponse stream |