cloudvision.api.arista.identityprovider.v1 package

Module contents

class cloudvision.api.arista.identityprovider.v1.MetaResponse(time: datetime.datetime = <PLACEHOLDER>, type: '__subscriptions__.Operation' = <PLACEHOLDER>, count: int | None = <PLACEHOLDER>)[source]

Bases: Message

count: int | None = <PLACEHOLDER>: Count is the number of items present under the conditions of the request.

time: datetime = <PLACEHOLDER>: Time holds the timestamp of the last item included in the metadata calculation.

type: __subscriptions__.Operation = <PLACEHOLDER>: 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.

class cloudvision.api.arista.identityprovider.v1.OAuthConfig(key: ~cloudvision.api.arista.identityprovider.v1.OAuthKey = <PLACEHOLDER>, endpoint: str | None = <PLACEHOLDER>, client_id: str | None = <PLACEHOLDER>, client_secret: str | None = <PLACEHOLDER>, algorithms: ~cloudvision.api.fmp.RepeatedString = <PLACEHOLDER>, link_to_shared_provider: bool | None = <PLACEHOLDER>, jwks_uri: str | None = <PLACEHOLDER>, permitted_email_domains: ~cloudvision.api.fmp.RepeatedString = <PLACEHOLDER>, roles_scope_name: str | None = <PLACEHOLDER>, bearer_token_introspection_endpoint: str | None = <PLACEHOLDER>, roles_claim_name: str | None = <PLACEHOLDER>)[source]

Bases: Message

OAuthConfig holds the configuration for an OAuth provider.

algorithms: ___fmp__.RepeatedString = <PLACEHOLDER>: algorithms is the set of signing algorithms. This is an optional field. If specified, only this set of algorithms may be used to sign the JWT. Otherwise, this defaults to the set of algorithms that the provider supports.

bearer_token_introspection_endpoint: str | None = <PLACEHOLDER>: bearer_token_introspection_endpoint is the provider instrospection endpoint used in Bearer Token based login support for CloudVision. This is an optional field. If specified, this endpoint will be used to verify bearer tokens generated via the provider to log in automated user accounts.

client_id: str | None = <PLACEHOLDER>: client_id is the ID that the OAuth authorization server issues to the registered client.

client_secret: str | None = <PLACEHOLDER>: client_secret is the secret that the OAuth authorization server issues to the registered client.

endpoint: str | None = <PLACEHOLDER>: endpoint is the URL that identifies an OAuth authorization server. This endpoint is used to interact with the provider. It must be a URI [RFC3986] with a scheme component that must be https, a host component, and optionally, port and path components, but no query or fragment components.

jwks_uri: str | None = <PLACEHOLDER>: jwks_uri is where signing keys are downloaded. This is an optional field. Only needed if the default construction from endpoint would be incorrect.

key: OAuthKey = <PLACEHOLDER>: key is the ID of the OAuth provider.

link_to_shared_provider: bool | None = <PLACEHOLDER>: link_to_shared_provider indicates whether or not use the provider as a shared provider. This is an optional field and set to false by default.

permitted_email_domains: ___fmp__.RepeatedString = <PLACEHOLDER>: permitted_email_domains are domains of emails that users are allowed to use. This is an optional field. If not set, all domains are accepted by default.

roles_claim_name: str | None = <PLACEHOLDER>: roles_claim_name is the name for a claim that holds CloudVision roles in ID Token. CloudVision uses this value to look up roles in the ID Token. This is an optional field. If not set, CloudVision determines that mapping roles from the provider is disabled. If it’s set, roles_scope_name also needs to be set.

roles_scope_name: str | None = <PLACEHOLDER>: roles_scope_name is the name for a scope tied to a claim that holds CloudVision roles in ID Token. CloudVision uses scope values to specify what access privileges are being requested for id token. CloudVision appends this value to scope query parameter in the authorization request URL. This is an optional field. If not set, CloudVision determines that mapping roles from the provider is disabled. If it’s set, roles_claim_name also needs to be set.

class cloudvision.api.arista.identityprovider.v1.OAuthConfigBatchedStreamRequest(partial_eq_filter: List[ForwardRef('OAuthConfig')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>, max_messages: int | None = <PLACEHOLDER>)[source]

Bases: Message

max_messages: int | None = <PLACEHOLDER>: MaxMessages limits the maximum number of messages that can be contained in one batch. MaxMessages is required to be at least 1. The maximum number of messages in a batch is min(max_messages, INTERNAL_BATCH_LIMIT) INTERNAL_BATCH_LIMIT is set based on the maximum message size.

partial_eq_filter: List[OAuthConfig] = <PLACEHOLDER>

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: __time__.TimeBounds = <PLACEHOLDER>

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 OAuthConfig at end. * Each OAuthConfig response is fully-specified (all fields set).

start: Returns the state of each OAuthConfig at start, followed by updates until now. * Each OAuthConfig response at start is fully-specified, but updates may be partial.

start and end: Returns the state of each OAuthConfig at start, followed by updates until end. * Each OAuthConfig response at start is fully-specified, but updates until end may

be partial.

This field is not allowed in the Subscribe RPC.

class cloudvision.api.arista.identityprovider.v1.OAuthConfigBatchedStreamResponse(responses: List[ForwardRef('OAuthConfigStreamResponse')] = <PLACEHOLDER>)[source]

Bases: Message

responses: List[OAuthConfigStreamResponse] = <PLACEHOLDER>: Values are the values deemed relevant to the initiating request. The length of this structure is guaranteed to be between (inclusive) 1 and min(req.max_messages, INTERNAL_BATCH_LIMIT).

class cloudvision.api.arista.identityprovider.v1.OAuthConfigDeleteAllRequest(partial_eq_filter: List[ForwardRef('OAuthConfig')] = <PLACEHOLDER>)[source]

Bases: Message

partial_eq_filter: List[OAuthConfig] = <PLACEHOLDER>: PartialEqFilter provides a way to server-side filter a DeleteAll. This requires all provided fields to be equal to the response. A filtered DeleteAll will use GetAll with filter to find things to delete.

class cloudvision.api.arista.identityprovider.v1.OAuthConfigDeleteAllResponse(type: '___fmp__.DeleteError' = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>, key: 'OAuthKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

error: str | None = <PLACEHOLDER>: This indicates the error message from the delete failure.

key: OAuthKey = <PLACEHOLDER>: This is the key of the OAuthConfig instance that failed to be deleted.

time: datetime = <PLACEHOLDER>: Time indicates the (UTC) timestamp when the key was being deleted.

type: ___fmp__.DeleteError = <PLACEHOLDER>: This describes the class of delete error. A DeleteAllResponse is only sent when there is an error.

class cloudvision.api.arista.identityprovider.v1.OAuthConfigDeleteRequest(key: 'OAuthKey' = <PLACEHOLDER>)[source]

Bases: Message

key: OAuthKey = <PLACEHOLDER>: Key indicates which OAuthConfig instance to remove. This field must always be set.

class cloudvision.api.arista.identityprovider.v1.OAuthConfigDeleteResponse(key: 'OAuthKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

key: OAuthKey = <PLACEHOLDER>: Key echoes back the key of the deleted OAuthConfig instance.

time: datetime = <PLACEHOLDER>

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.

class cloudvision.api.arista.identityprovider.v1.OAuthConfigDeleteSomeRequest(keys: List[ForwardRef('OAuthKey')] = <PLACEHOLDER>)[source]

Bases: Message

keys: List[OAuthKey] = <PLACEHOLDER>: key contains a list of OAuthConfig keys to delete

class cloudvision.api.arista.identityprovider.v1.OAuthConfigDeleteSomeResponse(key: ~cloudvision.api.arista.identityprovider.v1.OAuthKey = <PLACEHOLDER>, error: str = <PLACEHOLDER>)[source]

Bases: Message

OAuthConfigDeleteSomeResponse is only sent when there is an error.

error: str = <PLACEHOLDER>

key: OAuthKey = <PLACEHOLDER>

class cloudvision.api.arista.identityprovider.v1.OAuthConfigRequest(key: 'OAuthKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

key: OAuthKey = <PLACEHOLDER>: Key uniquely identifies a OAuthConfig instance to retrieve. This value must be populated.

time: datetime = <PLACEHOLDER>: 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.

class cloudvision.api.arista.identityprovider.v1.OAuthConfigResponse(value: 'OAuthConfig' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time carries the (UTC) timestamp of the last-modification of the OAuthConfig instance in this response.

value: OAuthConfig = <PLACEHOLDER>: 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.

class cloudvision.api.arista.identityprovider.v1.OAuthConfigServiceBase[source]

Bases: ServiceBase

async delete(o_auth_config_delete_request: OAuthConfigDeleteRequest) → OAuthConfigDeleteResponse[source]

async delete_all(o_auth_config_delete_all_request: OAuthConfigDeleteAllRequest) → AsyncIterator[OAuthConfigDeleteAllResponse][source]

async delete_some(o_auth_config_delete_some_request: OAuthConfigDeleteSomeRequest) → AsyncIterator[OAuthConfigDeleteSomeResponse][source]

async get_all(o_auth_config_stream_request: OAuthConfigStreamRequest) → AsyncIterator[OAuthConfigStreamResponse][source]

async get_all_batched(o_auth_config_batched_stream_request: OAuthConfigBatchedStreamRequest) → AsyncIterator[OAuthConfigBatchedStreamResponse][source]

async get_meta(o_auth_config_stream_request: OAuthConfigStreamRequest) → MetaResponse[source]

async get_one(o_auth_config_request: OAuthConfigRequest) → OAuthConfigResponse[source]

async get_some(o_auth_config_some_request: OAuthConfigSomeRequest) → AsyncIterator[OAuthConfigSomeResponse][source]

async set(o_auth_config_set_request: OAuthConfigSetRequest) → OAuthConfigSetResponse[source]

async set_some(o_auth_config_set_some_request: OAuthConfigSetSomeRequest) → AsyncIterator[OAuthConfigSetSomeResponse][source]

async subscribe(o_auth_config_stream_request: OAuthConfigStreamRequest) → AsyncIterator[OAuthConfigStreamResponse][source]

async subscribe_batched(o_auth_config_batched_stream_request: OAuthConfigBatchedStreamRequest) → AsyncIterator[OAuthConfigBatchedStreamResponse][source]

async subscribe_meta(o_auth_config_stream_request: OAuthConfigStreamRequest) → AsyncIterator[MetaResponse][source]

Bases: ServiceStub

async delete(o_auth_config_delete_request: OAuthConfigDeleteRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → OAuthConfigDeleteResponse[source]

async delete_all(o_auth_config_delete_all_request: OAuthConfigDeleteAllRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[OAuthConfigDeleteAllResponse][source]

async delete_some(o_auth_config_delete_some_request: OAuthConfigDeleteSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[OAuthConfigDeleteSomeResponse][source]

async get_all(o_auth_config_stream_request: OAuthConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[OAuthConfigStreamResponse][source]

async get_all_batched(o_auth_config_batched_stream_request: OAuthConfigBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[OAuthConfigBatchedStreamResponse][source]

async get_meta(o_auth_config_stream_request: OAuthConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → MetaResponse[source]

async get_one(o_auth_config_request: OAuthConfigRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → OAuthConfigResponse[source]

async get_some(o_auth_config_some_request: OAuthConfigSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[OAuthConfigSomeResponse][source]

async set(o_auth_config_set_request: OAuthConfigSetRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → OAuthConfigSetResponse[source]

async set_some(o_auth_config_set_some_request: OAuthConfigSetSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[OAuthConfigSetSomeResponse][source]

async subscribe(o_auth_config_stream_request: OAuthConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[OAuthConfigStreamResponse][source]

async subscribe_batched(o_auth_config_batched_stream_request: OAuthConfigBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[OAuthConfigBatchedStreamResponse][source]

async subscribe_meta(o_auth_config_stream_request: OAuthConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[MetaResponse][source]

class cloudvision.api.arista.identityprovider.v1.OAuthConfigSetRequest(value: 'OAuthConfig' = <PLACEHOLDER>)[source]

Bases: Message

value: OAuthConfig = <PLACEHOLDER>: OAuthConfig carries the value to set into the datastore. See the documentation on the OAuthConfig struct for which fields are required.

class cloudvision.api.arista.identityprovider.v1.OAuthConfigSetResponse(value: 'OAuthConfig' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>

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.

value: OAuthConfig = <PLACEHOLDER>: Value carries all the values given in the OAuthConfigSetRequest as well as any server-generated values.

class cloudvision.api.arista.identityprovider.v1.OAuthConfigSetSomeRequest(values: List[ForwardRef('OAuthConfig')] = <PLACEHOLDER>)[source]

Bases: Message

values: List[OAuthConfig] = <PLACEHOLDER>

value contains a list of OAuthConfig 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.

class cloudvision.api.arista.identityprovider.v1.OAuthConfigSetSomeResponse(key: 'OAuthKey' = <PLACEHOLDER>, error: str = <PLACEHOLDER>)[source]

Bases: Message

error: str = <PLACEHOLDER>

key: OAuthKey = <PLACEHOLDER>

class cloudvision.api.arista.identityprovider.v1.OAuthConfigSomeRequest(keys: List[ForwardRef('OAuthKey')] = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

keys: List[OAuthKey] = <PLACEHOLDER>

time: datetime = <PLACEHOLDER>: 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.

class cloudvision.api.arista.identityprovider.v1.OAuthConfigSomeResponse(value: 'OAuthConfig' = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

error: str | None = <PLACEHOLDER>: Error is an optional field. It should be filled when there is an error in the GetSome process.

time: datetime = <PLACEHOLDER>

value: OAuthConfig = <PLACEHOLDER>: 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.

class cloudvision.api.arista.identityprovider.v1.OAuthConfigStreamRequest(partial_eq_filter: List[ForwardRef('OAuthConfig')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>)[source]

Bases: Message

partial_eq_filter: List[OAuthConfig] = <PLACEHOLDER>

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: __time__.TimeBounds = <PLACEHOLDER>

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 OAuthConfig at end. * Each OAuthConfig response is fully-specified (all fields set).

start: Returns the state of each OAuthConfig at start, followed by updates until now. * Each OAuthConfig response at start is fully-specified, but updates may be partial.

start and end: Returns the state of each OAuthConfig at start, followed by updates until end. * Each OAuthConfig response at start is fully-specified, but updates until end may

be partial.

This field is not allowed in the Subscribe RPC.

class cloudvision.api.arista.identityprovider.v1.OAuthConfigStreamResponse(value: 'OAuthConfig' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>, type: '__subscriptions__.Operation' = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time holds the timestamp of this OAuthConfig’s last modification.

type: __subscriptions__.Operation = <PLACEHOLDER>: Operation indicates how the OAuthConfig 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.

value: OAuthConfig = <PLACEHOLDER>: 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.

class cloudvision.api.arista.identityprovider.v1.OAuthKey(provider_id: str | None = <PLACEHOLDER>)[source]

Bases: Message

OAuthKey contains OAuth provider ID.

provider_id: str | None = <PLACEHOLDER>: provider_id is the ID of the OAuth provider.

class cloudvision.api.arista.identityprovider.v1.ProtocolBinding(value: int)[source]

Bases: Enum

ProtocolBinding indicates SAML protocol binding to be used.

HTTP_POST = ProtocolBinding.HTTP_POST: PROTOCOL_BINDING_HTTP_POST indicates HTTP-POST SAML protocol binding.

HTTP_REDIRECT = ProtocolBinding.HTTP_REDIRECT: PROTOCOL_BINDING_HTTP_REDIRECT indicates HTTP-Redirect SAML protocol binding.

UNSPECIFIED = ProtocolBinding.UNSPECIFIED: PROTOCOL_BINDING_UNSPECIFIED indicates that a protocol binding is unspecified.

name: str | None

value: int

class cloudvision.api.arista.identityprovider.v1.SamlConfig(key: ~cloudvision.api.arista.identityprovider.v1.SamlKey = <PLACEHOLDER>, idp_issuer: str | None = <PLACEHOLDER>, idp_metadata_url: str | None = <PLACEHOLDER>, authreq_binding: ~cloudvision.api.arista.identityprovider.v1.ProtocolBinding = <PLACEHOLDER>, email_attrname: str | None = <PLACEHOLDER>, link_to_shared_provider: bool | None = <PLACEHOLDER>, permitted_email_domains: ~cloudvision.api.fmp.RepeatedString = <PLACEHOLDER>, force_saml_authn: bool | None = <PLACEHOLDER>, roles_attrname: str | None = <PLACEHOLDER>, org_attrname: str | None = <PLACEHOLDER>, username_attrname: str | None = <PLACEHOLDER>)[source]

Bases: Message

SAMLConfig holds the configuration for a SAML provider.

authreq_binding: ProtocolBinding = <PLACEHOLDER>: authreq_binding specifies the ProtocolBinding used to send SAML authentication request to the SAML provider.

email_attrname: str | None = <PLACEHOLDER>: email_attrname specifies the Attribute name for email ID in Assertion of SAMLResponse from the SAML provider.

force_saml_authn: bool | None = <PLACEHOLDER>: force_saml_authn indicates wether or not enable force authentication in SAML login. This is an optional field. If not set, it defaults to false.

idp_issuer: str | None = <PLACEHOLDER>: idp_issuer identifies the SAML provider. There is no restriction on its format other than a string to carry the issuer’s name.

idp_metadata_url: str | None = <PLACEHOLDER>: idp_metadata_url is the URL that CloudVision uses to fetch the SAML provider metadata.

key: SamlKey = <PLACEHOLDER>: key is the ID of the SAML provider.

link_to_shared_provider: bool | None = <PLACEHOLDER>: link_to_shared_provider indicates whether or not use the provider as a shared provider. This is an optional field and set to false by default.

org_attrname: str | None = <PLACEHOLDER>: org_attrname specifies the Attribute name for CloudVision organization/tenant in the Assertion of SAMLResponse. This is an optional field. CloudVision supports use of certain shared SAML Identity Providers for authenticating users across multiple CloudVision organizations/tenants. In case a given organization uses a shared provider, then, CloudVision needs this attribute to determine if the organization that the shared SAML Identity Provider is sending the assertion for is the same as the one the user requested to be logged into. For an existing user on CloudVision, the user’s email is used to determine which organization the user belongs to do the same verification but in case a dynamic user creation is needed and the given user doesn’t exist on CloudVision currently then the matching organization attribute from the shared Identity Privder becomes necessary. Dynamic user creation is disabled for a given organization using shared Identity Provider if this attribute is not specified.

permitted_email_domains: ___fmp__.RepeatedString = <PLACEHOLDER>: permitted_email_domains are domains of emails that users are allowed to use. This is an optional field. If not set, all domains are accepted by default.

roles_attrname: str | None = <PLACEHOLDER>: roles_attrname specifies the Attribute name for CloudVision roles in the Assertion of SAMLResponse. This is an optional field. If not set, CloudVision determines that mapping roles from the provider is disabled.

username_attrname: str | None = <PLACEHOLDER>: username_attrname specifies Attribute name for CloudVision users’ username in the Assertion of SAMLResponse. This is an optional field as long as mapping roles from provider is not enabled. Once enabled, this field becomes mandatory.

class cloudvision.api.arista.identityprovider.v1.SamlConfigBatchedStreamRequest(partial_eq_filter: List[ForwardRef('SamlConfig')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>, max_messages: int | None = <PLACEHOLDER>)[source]

Bases: Message

max_messages: int | None = <PLACEHOLDER>: MaxMessages limits the maximum number of messages that can be contained in one batch. MaxMessages is required to be at least 1. The maximum number of messages in a batch is min(max_messages, INTERNAL_BATCH_LIMIT) INTERNAL_BATCH_LIMIT is set based on the maximum message size.

partial_eq_filter: List[SamlConfig] = <PLACEHOLDER>

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: __time__.TimeBounds = <PLACEHOLDER>

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 SAMLConfig at end. * Each SAMLConfig response is fully-specified (all fields set).

start: Returns the state of each SAMLConfig at start, followed by updates until now. * Each SAMLConfig response at start is fully-specified, but updates may be partial.

start and end: Returns the state of each SAMLConfig at start, followed by updates until end. * Each SAMLConfig response at start is fully-specified, but updates until end may

be partial.

This field is not allowed in the Subscribe RPC.

class cloudvision.api.arista.identityprovider.v1.SamlConfigBatchedStreamResponse(responses: List[ForwardRef('SamlConfigStreamResponse')] = <PLACEHOLDER>)[source]

Bases: Message

responses: List[SamlConfigStreamResponse] = <PLACEHOLDER>: Values are the values deemed relevant to the initiating request. The length of this structure is guaranteed to be between (inclusive) 1 and min(req.max_messages, INTERNAL_BATCH_LIMIT).

class cloudvision.api.arista.identityprovider.v1.SamlConfigDeleteAllRequest(partial_eq_filter: List[ForwardRef('SamlConfig')] = <PLACEHOLDER>)[source]

Bases: Message

partial_eq_filter: List[SamlConfig] = <PLACEHOLDER>: PartialEqFilter provides a way to server-side filter a DeleteAll. This requires all provided fields to be equal to the response. A filtered DeleteAll will use GetAll with filter to find things to delete.

class cloudvision.api.arista.identityprovider.v1.SamlConfigDeleteAllResponse(type: '___fmp__.DeleteError' = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>, key: 'SamlKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

error: str | None = <PLACEHOLDER>: This indicates the error message from the delete failure.

key: SamlKey = <PLACEHOLDER>: This is the key of the SAMLConfig instance that failed to be deleted.

time: datetime = <PLACEHOLDER>: Time indicates the (UTC) timestamp when the key was being deleted.

type: ___fmp__.DeleteError = <PLACEHOLDER>: This describes the class of delete error. A DeleteAllResponse is only sent when there is an error.

class cloudvision.api.arista.identityprovider.v1.SamlConfigDeleteRequest(key: 'SamlKey' = <PLACEHOLDER>)[source]

Bases: Message

key: SamlKey = <PLACEHOLDER>: Key indicates which SAMLConfig instance to remove. This field must always be set.

class cloudvision.api.arista.identityprovider.v1.SamlConfigDeleteResponse(key: 'SamlKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

key: SamlKey = <PLACEHOLDER>: Key echoes back the key of the deleted SAMLConfig instance.

time: datetime = <PLACEHOLDER>

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.

class cloudvision.api.arista.identityprovider.v1.SamlConfigDeleteSomeRequest(keys: List[ForwardRef('SamlKey')] = <PLACEHOLDER>)[source]

Bases: Message

keys: List[SamlKey] = <PLACEHOLDER>: key contains a list of SAMLConfig keys to delete

class cloudvision.api.arista.identityprovider.v1.SamlConfigDeleteSomeResponse(key: ~cloudvision.api.arista.identityprovider.v1.SamlKey = <PLACEHOLDER>, error: str = <PLACEHOLDER>)[source]

Bases: Message

SAMLConfigDeleteSomeResponse is only sent when there is an error.

error: str = <PLACEHOLDER>

key: SamlKey = <PLACEHOLDER>

class cloudvision.api.arista.identityprovider.v1.SamlConfigRequest(key: 'SamlKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

key: SamlKey = <PLACEHOLDER>: Key uniquely identifies a SAMLConfig instance to retrieve. This value must be populated.

time: datetime = <PLACEHOLDER>: 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.

class cloudvision.api.arista.identityprovider.v1.SamlConfigResponse(value: 'SamlConfig' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time carries the (UTC) timestamp of the last-modification of the SAMLConfig instance in this response.

value: SamlConfig = <PLACEHOLDER>: 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.

class cloudvision.api.arista.identityprovider.v1.SamlConfigServiceBase[source]

Bases: ServiceBase

async delete(saml_config_delete_request: SamlConfigDeleteRequest) → SamlConfigDeleteResponse[source]

async delete_all(saml_config_delete_all_request: SamlConfigDeleteAllRequest) → AsyncIterator[SamlConfigDeleteAllResponse][source]

async delete_some(saml_config_delete_some_request: SamlConfigDeleteSomeRequest) → AsyncIterator[SamlConfigDeleteSomeResponse][source]

async get_all(saml_config_stream_request: SamlConfigStreamRequest) → AsyncIterator[SamlConfigStreamResponse][source]

async get_all_batched(saml_config_batched_stream_request: SamlConfigBatchedStreamRequest) → AsyncIterator[SamlConfigBatchedStreamResponse][source]

async get_meta(saml_config_stream_request: SamlConfigStreamRequest) → MetaResponse[source]

async get_one(saml_config_request: SamlConfigRequest) → SamlConfigResponse[source]

async get_some(saml_config_some_request: SamlConfigSomeRequest) → AsyncIterator[SamlConfigSomeResponse][source]

async set(saml_config_set_request: SamlConfigSetRequest) → SamlConfigSetResponse[source]

async set_some(saml_config_set_some_request: SamlConfigSetSomeRequest) → AsyncIterator[SamlConfigSetSomeResponse][source]

async subscribe(saml_config_stream_request: SamlConfigStreamRequest) → AsyncIterator[SamlConfigStreamResponse][source]

async subscribe_batched(saml_config_batched_stream_request: SamlConfigBatchedStreamRequest) → AsyncIterator[SamlConfigBatchedStreamResponse][source]

async subscribe_meta(saml_config_stream_request: SamlConfigStreamRequest) → AsyncIterator[MetaResponse][source]

Bases: ServiceStub

async delete(saml_config_delete_request: SamlConfigDeleteRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → SamlConfigDeleteResponse[source]

async delete_all(saml_config_delete_all_request: SamlConfigDeleteAllRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[SamlConfigDeleteAllResponse][source]

async delete_some(saml_config_delete_some_request: SamlConfigDeleteSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[SamlConfigDeleteSomeResponse][source]

async get_all(saml_config_stream_request: SamlConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[SamlConfigStreamResponse][source]

async get_all_batched(saml_config_batched_stream_request: SamlConfigBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[SamlConfigBatchedStreamResponse][source]

async get_meta(saml_config_stream_request: SamlConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → MetaResponse[source]

async get_one(saml_config_request: SamlConfigRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → SamlConfigResponse[source]

async get_some(saml_config_some_request: SamlConfigSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[SamlConfigSomeResponse][source]

async set(saml_config_set_request: SamlConfigSetRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → SamlConfigSetResponse[source]

async set_some(saml_config_set_some_request: SamlConfigSetSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[SamlConfigSetSomeResponse][source]

async subscribe(saml_config_stream_request: SamlConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[SamlConfigStreamResponse][source]

async subscribe_batched(saml_config_batched_stream_request: SamlConfigBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[SamlConfigBatchedStreamResponse][source]

async subscribe_meta(saml_config_stream_request: SamlConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[MetaResponse][source]

class cloudvision.api.arista.identityprovider.v1.SamlConfigSetRequest(value: 'SamlConfig' = <PLACEHOLDER>)[source]

Bases: Message

value: SamlConfig = <PLACEHOLDER>: SAMLConfig carries the value to set into the datastore. See the documentation on the SAMLConfig struct for which fields are required.

class cloudvision.api.arista.identityprovider.v1.SamlConfigSetResponse(value: 'SamlConfig' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>

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.

value: SamlConfig = <PLACEHOLDER>: Value carries all the values given in the SAMLConfigSetRequest as well as any server-generated values.

class cloudvision.api.arista.identityprovider.v1.SamlConfigSetSomeRequest(values: List[ForwardRef('SamlConfig')] = <PLACEHOLDER>)[source]

Bases: Message

values: List[SamlConfig] = <PLACEHOLDER>

value contains a list of SAMLConfig 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.

class cloudvision.api.arista.identityprovider.v1.SamlConfigSetSomeResponse(key: 'SamlKey' = <PLACEHOLDER>, error: str = <PLACEHOLDER>)[source]

Bases: Message

error: str = <PLACEHOLDER>

key: SamlKey = <PLACEHOLDER>

class cloudvision.api.arista.identityprovider.v1.SamlConfigSomeRequest(keys: List[ForwardRef('SamlKey')] = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

keys: List[SamlKey] = <PLACEHOLDER>

time: datetime = <PLACEHOLDER>: 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.

class cloudvision.api.arista.identityprovider.v1.SamlConfigSomeResponse(value: 'SamlConfig' = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

error: str | None = <PLACEHOLDER>: Error is an optional field. It should be filled when there is an error in the GetSome process.

time: datetime = <PLACEHOLDER>

value: SamlConfig = <PLACEHOLDER>: 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.

class cloudvision.api.arista.identityprovider.v1.SamlConfigStreamRequest(partial_eq_filter: List[ForwardRef('SamlConfig')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>)[source]

Bases: Message

partial_eq_filter: List[SamlConfig] = <PLACEHOLDER>

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: __time__.TimeBounds = <PLACEHOLDER>

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 SAMLConfig at end. * Each SAMLConfig response is fully-specified (all fields set).

start: Returns the state of each SAMLConfig at start, followed by updates until now. * Each SAMLConfig response at start is fully-specified, but updates may be partial.

start and end: Returns the state of each SAMLConfig at start, followed by updates until end. * Each SAMLConfig response at start is fully-specified, but updates until end may

be partial.

This field is not allowed in the Subscribe RPC.

class cloudvision.api.arista.identityprovider.v1.SamlConfigStreamResponse(value: 'SamlConfig' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>, type: '__subscriptions__.Operation' = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time holds the timestamp of this SAMLConfig’s last modification.

type: __subscriptions__.Operation = <PLACEHOLDER>: Operation indicates how the SAMLConfig 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.

value: SamlConfig = <PLACEHOLDER>: 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.

class cloudvision.api.arista.identityprovider.v1.SamlKey(provider_id: str | None = <PLACEHOLDER>)[source]

Bases: Message

SAMLKey contains SAML Provider ID.

provider_id: str | None = <PLACEHOLDER>: provider_id is the ID of the SAML provider.