python_pachyderm.experimental.proto.v2.auth_v2 package

Module contents

class ActivateRequest(root_token=<object object>)[source]

Bases: betterproto.Message

ActivateRequest enables authentication on the cluster. It issues an auth token with no expiration for the irrevocable admin user pach:root.

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

root_token = <object object>

class ActivateResponse(pach_token: str = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

pach_token = <object object>

class ApiBase[source]

Bases: betterproto.grpc.grpclib_server.ServiceBase

Methods

activate
authenticate
authorize
deactivate
delete_expired_auth_tokens
extract_auth_tokens
get_configuration
get_groups
get_groups_for_principal
get_oidc_login
get_permissions
get_permissions_for_principal
get_robot_token
get_role_binding
get_roles_for_permission
get_users
modify_members
modify_role_binding
restore_auth_token
revoke_auth_token
revoke_auth_tokens_for_user
rotate_root_token
set_configuration
set_groups_for_user
who_am_i

async activate(root_token)[source]

async authenticate(oidc_state, id_token)[source]

async authorize(resource, permissions)[source]

async deactivate()[source]

async delete_expired_auth_tokens()[source]

async extract_auth_tokens()[source]

async get_configuration()[source]

async get_groups()[source]

async get_groups_for_principal(principal)[source]

async get_oidc_login()[source]

async get_permissions(resource)[source]

async get_permissions_for_principal(resource, principal)[source]

async get_robot_token(robot, ttl)[source]

async get_role_binding(resource)[source]

async get_roles_for_permission(permission)[source]

async get_users(group)[source]

async modify_members(group, add, remove)[source]

async modify_role_binding(resource, principal, roles)[source]

async restore_auth_token(token)[source]

async revoke_auth_token(token)[source]

async revoke_auth_tokens_for_user(username)[source]

async rotate_root_token(root_token)[source]

async set_configuration(configuration)[source]

async set_groups_for_user(username, groups)[source]

async who_am_i()[source]

class ApiStub(channel, *, timeout=None, deadline=None, metadata=None)[source]

Bases: betterproto.grpc.grpclib_client.ServiceStub

Methods

activate
authenticate
authorize
deactivate
delete_expired_auth_tokens
extract_auth_tokens
get_configuration
get_groups
get_groups_for_principal
get_oidc_login
get_permissions
get_permissions_for_principal
get_robot_token
get_role_binding
get_roles_for_permission
get_users
modify_members
modify_role_binding
restore_auth_token
revoke_auth_token
revoke_auth_tokens_for_user
rotate_root_token
set_configuration
set_groups_for_user
who_am_i

async activate(*, root_token='')[source]

async authenticate(*, oidc_state='', id_token='')[source]

async authorize(*, resource=None, permissions=None)[source]

async deactivate()[source]

async delete_expired_auth_tokens()[source]

async extract_auth_tokens()[source]

async get_configuration()[source]

async get_groups()[source]

async get_groups_for_principal(*, principal='')[source]

async get_oidc_login()[source]

async get_permissions(*, resource=None)[source]

async get_permissions_for_principal(*, resource=None, principal='')[source]

async get_robot_token(*, robot='', ttl=0)[source]

async get_role_binding(*, resource=None)[source]

async get_roles_for_permission(*, permission=None)[source]

async get_users(*, group='')[source]

async modify_members(*, group='', add=None, remove=None)[source]

async modify_role_binding(*, resource=None, principal='', roles=None)[source]

async restore_auth_token(*, token=None)[source]

async revoke_auth_token(*, token='')[source]

async revoke_auth_tokens_for_user(*, username='')[source]

async rotate_root_token(*, root_token='')[source]

async set_configuration(*, configuration=None)[source]

async set_groups_for_user(*, username='', groups=None)[source]

async who_am_i()[source]

class AuthenticateRequest(oidc_state: str = <object object at 0x7f2cabcb78b0>, id_token: str = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

id_token = <object object>

oidc_state = <object object>

class AuthenticateResponse(pach_token: str = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

pach_token = <object object>

class AuthorizeRequest(resource: 'Resource' = <object object at 0x7f2cabcb78b0>, permissions: List[ForwardRef('Permission')] = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

permissions = <object object>

resource = <object object>

class AuthorizeResponse(authorized: bool = <object object at 0x7f2cabcb78b0>, satisfied: List[ForwardRef('Permission')] = <object object at 0x7f2cabcb78b0>, missing: List[ForwardRef('Permission')] = <object object at 0x7f2cabcb78b0>, principal: str = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

authorized = <object object>

missing = <object object>

principal = <object object>

satisfied = <object object>

class DeactivateRequest[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class DeactivateResponse[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class DeleteExpiredAuthTokensRequest[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class DeleteExpiredAuthTokensResponse[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class ExtractAuthTokensRequest[source]

Bases: betterproto.Message

ExtractAuthTokens returns all the hashed robot tokens that have been issued. User tokens are not extracted as they can be recreated by logging in.

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class ExtractAuthTokensResponse(tokens: List[ForwardRef('TokenInfo')] = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

tokens = <object object>

class GetConfigurationRequest[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class GetConfigurationResponse(configuration: 'OidcConfig' = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

configuration = <object object>

class GetGroupsForPrincipalRequest(principal: str = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

principal = <object object>

class GetGroupsRequest[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class GetGroupsResponse(groups: List[str] = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

groups = <object object>

class GetOidcLoginRequest[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class GetOidcLoginResponse(login_url: str = <object object at 0x7f2cabcb78b0>, state: str = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

login_url = <object object>

state = <object object>

class GetPermissionsForPrincipalRequest(resource=<object object>, principal=<object object>)[source]

Bases: betterproto.Message

GetPermissionsForPrincipal evaluates an arbitrary principal’s permissions on a resource

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

principal = <object object>

resource = <object object>

class GetPermissionsRequest(resource=<object object>)[source]

Bases: betterproto.Message

GetPermissions evaluates the current user’s permissions on a resource

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

resource = <object object>

class GetPermissionsResponse(permissions: List[ForwardRef('Permission')] = <object object at 0x7f2cabcb78b0>, roles: List[str] = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

permissions = <object object>

roles = <object object>

class GetRobotTokenRequest(robot: str = <object object at 0x7f2cabcb78b0>, ttl: int = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

robot = <object object>

ttl = <object object>

class GetRobotTokenResponse(token: str = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

token = <object object>

class GetRoleBindingRequest(resource: 'Resource' = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

resource = <object object>

class GetRoleBindingResponse(binding: 'RoleBinding' = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

binding = <object object>

class GetRolesForPermissionRequest(permission: 'Permission' = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

permission = <object object>

class GetRolesForPermissionResponse(roles: List[ForwardRef('Role')] = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

roles = <object object>

class GetUsersRequest(group: str = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

group = <object object>

class GetUsersResponse(usernames: List[str] = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

usernames = <object object>

class Groups(groups: Dict[str, bool] = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

groups = <object object>

class ModifyMembersRequest(group: str = <object object at 0x7f2cabcb78b0>, add: List[str] = <object object at 0x7f2cabcb78b0>, remove: List[str] = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

add = <object object>

group = <object object>

remove = <object object>

class ModifyMembersResponse[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class ModifyRoleBindingRequest(resource: 'Resource' = <object object at 0x7f2cabcb78b0>, principal: str = <object object at 0x7f2cabcb78b0>, roles: List[str] = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

principal = <object object>

resource = <object object>

roles = <object object>

class ModifyRoleBindingResponse[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class OidcConfig(issuer=<object object>, client_id=<object object>, client_secret=<object object>, redirect_uri=<object object>, scopes=<object object>, require_email_verified=<object object>, localhost_issuer=<object object>, user_accessible_issuer_host=<object object>)[source]

Bases: betterproto.Message

Configure Pachyderm’s auth system with an OIDC provider

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

client_id = <object object>

client_secret = <object object>

issuer = <object object>

localhost_issuer = <object object>

redirect_uri = <object object>

require_email_verified = <object object>

scopes = <object object>

user_accessible_issuer_host = <object object>

class Permission(value)[source]

Bases: betterproto.Enum

Permission represents the ability to perform a given operation on a Resource

CLUSTER_AUTH_ACTIVATE = 102

CLUSTER_AUTH_DEACTIVATE = 103

CLUSTER_AUTH_DELETE_EXPIRED_TOKENS = 140

CLUSTER_AUTH_EXTRACT_TOKENS = 112

CLUSTER_AUTH_GET_CONFIG = 104

CLUSTER_AUTH_GET_GROUPS = 110

CLUSTER_AUTH_GET_GROUP_USERS = 111

CLUSTER_AUTH_GET_PERMISSIONS_FOR_PRINCIPAL = 141

CLUSTER_AUTH_GET_ROBOT_TOKEN = 139

CLUSTER_AUTH_MODIFY_GROUP_MEMBERS = 109

CLUSTER_AUTH_RESTORE_TOKEN = 113

CLUSTER_AUTH_REVOKE_USER_TOKENS = 142

CLUSTER_AUTH_ROTATE_ROOT_TOKEN = 147

CLUSTER_AUTH_SET_CONFIG = 105

CLUSTER_CREATE_SECRET = 143

CLUSTER_DEBUG_DUMP = 131

CLUSTER_DELETE_ALL = 138

CLUSTER_ENTERPRISE_ACTIVATE = 114

CLUSTER_ENTERPRISE_DEACTIVATE = 117

CLUSTER_ENTERPRISE_GET_CODE = 116

CLUSTER_ENTERPRISE_HEARTBEAT = 115

CLUSTER_GET_BINDINGS = 101

CLUSTER_GET_PACHD_LOGS = 148

CLUSTER_IDENTITY_CREATE_IDP = 120

CLUSTER_IDENTITY_CREATE_OIDC_CLIENT = 125

CLUSTER_IDENTITY_DELETE_IDP = 124

CLUSTER_IDENTITY_DELETE_OIDC_CLIENT = 129

CLUSTER_IDENTITY_GET_CONFIG = 119

CLUSTER_IDENTITY_GET_IDP = 123

CLUSTER_IDENTITY_GET_OIDC_CLIENT = 128

CLUSTER_IDENTITY_LIST_IDPS = 122

CLUSTER_IDENTITY_LIST_OIDC_CLIENTS = 127

CLUSTER_IDENTITY_SET_CONFIG = 118

CLUSTER_IDENTITY_UPDATE_IDP = 121

CLUSTER_IDENTITY_UPDATE_OIDC_CLIENT = 126

CLUSTER_LICENSE_ACTIVATE = 132

CLUSTER_LICENSE_ADD_CLUSTER = 134

CLUSTER_LICENSE_DELETE_CLUSTER = 136

CLUSTER_LICENSE_GET_CODE = 133

CLUSTER_LICENSE_LIST_CLUSTERS = 137

CLUSTER_LICENSE_UPDATE_CLUSTER = 135

CLUSTER_LIST_SECRETS = 144

CLUSTER_MODIFY_BINDINGS = 100

PERMISSION_UNKNOWN = 0

PIPELINE_LIST_JOB = 301

REPO_ADD_PIPELINE_READER = 212

REPO_ADD_PIPELINE_WRITER = 214

REPO_CREATE_BRANCH = 207

REPO_DELETE = 203

REPO_DELETE_BRANCH = 209

REPO_DELETE_COMMIT = 206

REPO_INSPECT_COMMIT = 204

REPO_INSPECT_FILE = 210

REPO_LIST_BRANCH = 208

REPO_LIST_COMMIT = 205

REPO_LIST_FILE = 211

REPO_MODIFY_BINDINGS = 202

REPO_READ = 200

REPO_REMOVE_PIPELINE_READER = 213

REPO_WRITE = 201

SECRET_DELETE = 145

SECRET_INSPECT = 146

class Resource(type=<object object>, name=<object object>)[source]

Bases: betterproto.Message

Resource represents any resource that has role-bindings in the system

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

name = <object object>

type = <object object>

class ResourceType(value)[source]

Bases: betterproto.Enum

ResourceType represents the type of a Resource

CLUSTER = 1

REPO = 2

RESOURCE_TYPE_UNKNOWN = 0

SPEC_REPO = 3

class RestoreAuthTokenRequest(token=<object object>)[source]

Bases: betterproto.Message

RestoreAuthToken inserts a hashed token that has previously been extracted.

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

token = <object object>

class RestoreAuthTokenResponse[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class RevokeAuthTokenRequest(token: str = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

token = <object object>

class RevokeAuthTokenResponse[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class RevokeAuthTokensForUserRequest(username: str = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

username = <object object>

class RevokeAuthTokensForUserResponse[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class Role(name: str = <object object at 0x7f2cabcb78b0>, permissions: List[ForwardRef('Permission')] = <object object at 0x7f2cabcb78b0>, resource_types: List[ForwardRef('ResourceType')] = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

name = <object object>

permissions = <object object>

resource_types = <object object>

class RoleBinding(entries=<object object>)[source]

Bases: betterproto.Message

RoleBinding represents the set of roles principals have on a given Resource

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

entries = <object object>

class Roles(roles=<object object>)[source]

Bases: betterproto.Message

Roles represents the set of roles a principal has

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

roles = <object object>

class RotateRootTokenRequest(root_token: str = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

root_token = <object object>

class RotateRootTokenResponse(root_token: str = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

root_token = <object object>

class SessionInfo(nonce=<object object>, email=<object object>, conversion_err=<object object>)[source]

Bases: betterproto.Message

SessionInfo stores information associated with one OIDC authentication session (i.e. a single instance of a single user logging in). Sessions are short-lived and stored in the ‘oidc-authns’ collection, keyed by the OIDC ‘state’ token (30-character CSPRNG-generated string). ‘GetOIDCLogin’ generates and inserts entries, then /authorization-code/callback retrieves an access token from the ID provider and uses it to retrive the caller’s email and store it in ‘email’, and finally Authorize() returns a Pachyderm token identified with that email address as a subject in Pachyderm.

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

conversion_err = <object object>

email = <object object>

nonce = <object object>

class SetConfigurationRequest(configuration: 'OidcConfig' = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

configuration = <object object>

class SetConfigurationResponse[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class SetGroupsForUserRequest(username: str = <object object at 0x7f2cabcb78b0>, groups: List[str] = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

groups = <object object>

username = <object object>

class SetGroupsForUserResponse[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class TokenInfo(subject=<object object>, expiration=<object object>, hashed_token=<object object>)[source]

Bases: betterproto.Message

TokenInfo is the ‘value’ of an auth token ‘key’ in the ‘tokens’ collection

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

expiration = <object object>

hashed_token = <object object>

subject = <object object>

class Users(usernames: Dict[str, bool] = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

usernames = <object object>

class WhoAmIRequest[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class WhoAmIResponse(username: str = <object object at 0x7f2cabcb78b0>, expiration: datetime.datetime = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

expiration = <object object>

username = <object object>