Module pachyderm_sdk.api.identity

Classes

class User (email: str = None, last_authenticated: datetime.datetime = None)

User represents an IDP user that has authenticated via OIDC

Expand source code

@dataclass(eq=False, repr=False)
class User(betterproto.Message):
    """User represents an IDP user that has authenticated via OIDC"""

    email: str = betterproto.string_field(1)
    last_authenticated: datetime = betterproto.message_field(2)

Ancestors

• betterproto.Message
• abc.ABC

Class variables

var email : str

var last_authenticated : datetime.datetime

class IdentityServerConfig (issuer: str = None, id_token_expiry: str = None, rotation_token_expiry: str = None)

IdentityServerConfig is the configuration for the identity web server. When the configuration is changed the web server is reloaded automatically.

Expand source code

@dataclass(eq=False, repr=False)
class IdentityServerConfig(betterproto.Message):
    """
    IdentityServerConfig is the configuration for the identity web server. When
    the configuration is changed the web server is reloaded automatically.
    """

    issuer: str = betterproto.string_field(1)
    id_token_expiry: str = betterproto.string_field(2)
    rotation_token_expiry: str = betterproto.string_field(3)

Ancestors

• betterproto.Message
• abc.ABC

Class variables

var issuer : str

var id_token_expiry : str

var rotation_token_expiry : str

class SetIdentityServerConfigRequest (config: IdentityServerConfig = None)

SetIdentityServerConfigRequest(config: 'IdentityServerConfig' = None)

Expand source code

@dataclass(eq=False, repr=False)
class SetIdentityServerConfigRequest(betterproto.Message):
    config: "IdentityServerConfig" = betterproto.message_field(1)

Ancestors

• betterproto.Message
• abc.ABC

Class variables

var config : IdentityServerConfig

class SetIdentityServerConfigResponse

SetIdentityServerConfigResponse()

Expand source code

@dataclass(eq=False, repr=False)
class SetIdentityServerConfigResponse(betterproto.Message):
    pass

Ancestors

• betterproto.Message
• abc.ABC

class GetIdentityServerConfigRequest

GetIdentityServerConfigRequest()

Expand source code

@dataclass(eq=False, repr=False)
class GetIdentityServerConfigRequest(betterproto.Message):
    pass

Ancestors

• betterproto.Message
• abc.ABC

class GetIdentityServerConfigResponse (config: IdentityServerConfig = None)

GetIdentityServerConfigResponse(config: 'IdentityServerConfig' = None)

Expand source code

@dataclass(eq=False, repr=False)
class GetIdentityServerConfigResponse(betterproto.Message):
    config: "IdentityServerConfig" = betterproto.message_field(1)

Ancestors

• betterproto.Message
• abc.ABC

Class variables

var config : IdentityServerConfig

class IdpConnector (id: str = None, name: str = None, type: str = None, config_version: int = None, json_config: str = None, config: betterproto_lib_google_protobuf.Struct = None)

IDPConnector represents a connection to an identity provider

Expand source code

@dataclass(eq=False, repr=False)
class IdpConnector(betterproto.Message):
    """IDPConnector represents a connection to an identity provider"""

    id: str = betterproto.string_field(1)
    """ID is the unique identifier for this connector."""

    name: str = betterproto.string_field(2)
    """
    Name is the human-readable identifier for this connector, which will be
    shown to end users when they're authenticating.
    """

    type: str = betterproto.string_field(3)
    """Type is the type of the IDP ex. `saml`, `oidc`, `github`."""

    config_version: int = betterproto.int64_field(4)
    """
    ConfigVersion must be incremented every time a connector is updated, to
    avoid concurrent updates conflicting.
    """

    json_config: str = betterproto.string_field(5)
    """
    This is left for backwards compatibility, but we want users to use the
    config defined below.
    """

    config: "betterproto_lib_google_protobuf.Struct" = betterproto.message_field(6)
    """
    Config is the configuration for the upstream IDP, which varies based on the
    type. We make the assumption that this is either yaml or JSON.
    """

Ancestors

• betterproto.Message
• abc.ABC

Class variables

var id : str

ID is the unique identifier for this connector.

var name : str

Name is the human-readable identifier for this connector, which will be shown to end users when they're authenticating.

var type : str

Type is the type of the IDP ex. saml, oidc, github.

var config_version : int

ConfigVersion must be incremented every time a connector is updated, to avoid concurrent updates conflicting.

var json_config : str

This is left for backwards compatibility, but we want users to use the config defined below.

var config : betterproto.lib.google.protobuf.Struct

Config is the configuration for the upstream IDP, which varies based on the type. We make the assumption that this is either yaml or JSON.

class CreateIdpConnectorRequest (connector: IdpConnector = None)

CreateIdpConnectorRequest(connector: 'IdpConnector' = None)

Expand source code

@dataclass(eq=False, repr=False)
class CreateIdpConnectorRequest(betterproto.Message):
    connector: "IdpConnector" = betterproto.message_field(1)

Ancestors

• betterproto.Message
• abc.ABC

Class variables

var connector : IdpConnector

class CreateIdpConnectorResponse

CreateIdpConnectorResponse()

Expand source code

@dataclass(eq=False, repr=False)
class CreateIdpConnectorResponse(betterproto.Message):
    pass

Ancestors

• betterproto.Message
• abc.ABC

class UpdateIdpConnectorRequest (connector: IdpConnector = None)

UpdateIdpConnectorRequest(connector: 'IdpConnector' = None)

Expand source code

@dataclass(eq=False, repr=False)
class UpdateIdpConnectorRequest(betterproto.Message):
    connector: "IdpConnector" = betterproto.message_field(1)

Ancestors

• betterproto.Message
• abc.ABC

Class variables

var connector : IdpConnector

class UpdateIdpConnectorResponse

UpdateIdpConnectorResponse()

Expand source code

@dataclass(eq=False, repr=False)
class UpdateIdpConnectorResponse(betterproto.Message):
    pass

Ancestors

• betterproto.Message
• abc.ABC

class ListIdpConnectorsRequest

ListIdpConnectorsRequest()

Expand source code

@dataclass(eq=False, repr=False)
class ListIdpConnectorsRequest(betterproto.Message):
    pass

Ancestors

• betterproto.Message
• abc.ABC

class ListIdpConnectorsResponse (connectors: List[ForwardRef('IdpConnector')] = None)

ListIdpConnectorsResponse(connectors: List[ForwardRef('IdpConnector')] = None)

Expand source code

@dataclass(eq=False, repr=False)
class ListIdpConnectorsResponse(betterproto.Message):
    connectors: List["IdpConnector"] = betterproto.message_field(1)

Ancestors

• betterproto.Message
• abc.ABC

Class variables

var connectors : List[IdpConnector]

class GetIdpConnectorRequest (id: str = None)

GetIdpConnectorRequest(id: str = None)

Expand source code

@dataclass(eq=False, repr=False)
class GetIdpConnectorRequest(betterproto.Message):
    id: str = betterproto.string_field(1)

Ancestors

• betterproto.Message
• abc.ABC

Class variables

var id : str

class GetIdpConnectorResponse (connector: IdpConnector = None)

GetIdpConnectorResponse(connector: 'IdpConnector' = None)

Expand source code

@dataclass(eq=False, repr=False)
class GetIdpConnectorResponse(betterproto.Message):
    connector: "IdpConnector" = betterproto.message_field(1)

Ancestors

• betterproto.Message
• abc.ABC

Class variables

var connector : IdpConnector

class DeleteIdpConnectorRequest (id: str = None)

DeleteIdpConnectorRequest(id: str = None)

Expand source code

@dataclass(eq=False, repr=False)
class DeleteIdpConnectorRequest(betterproto.Message):
    id: str = betterproto.string_field(1)

Ancestors

• betterproto.Message
• abc.ABC

Class variables

var id : str

class DeleteIdpConnectorResponse

DeleteIdpConnectorResponse()

Expand source code

@dataclass(eq=False, repr=False)
class DeleteIdpConnectorResponse(betterproto.Message):
    pass

Ancestors

• betterproto.Message
• abc.ABC

class OidcClient (id: str = None, redirect_uris: List[str] = None, trusted_peers: List[str] = None, name: str = None, secret: str = None)

OidcClient(id: str = None, redirect_uris: List[str] = None, trusted_peers: List[str] = None, name: str = None, secret: str = None)

Expand source code

@dataclass(eq=False, repr=False)
class OidcClient(betterproto.Message):
    id: str = betterproto.string_field(1)
    redirect_uris: List[str] = betterproto.string_field(2)
    trusted_peers: List[str] = betterproto.string_field(3)
    name: str = betterproto.string_field(4)
    secret: str = betterproto.string_field(5)

Ancestors

• betterproto.Message
• abc.ABC

Class variables

var id : str

var redirect_uris : List[str]

var trusted_peers : List[str]

var name : str

var secret : str

class CreateOidcClientRequest (client: OidcClient = None)

CreateOidcClientRequest(client: 'OidcClient' = None)

Expand source code

@dataclass(eq=False, repr=False)
class CreateOidcClientRequest(betterproto.Message):
    client: "OidcClient" = betterproto.message_field(1)

Ancestors

• betterproto.Message
• abc.ABC

Class variables

var client : OidcClient

class CreateOidcClientResponse (client: OidcClient = None)

CreateOidcClientResponse(client: 'OidcClient' = None)

Expand source code

@dataclass(eq=False, repr=False)
class CreateOidcClientResponse(betterproto.Message):
    client: "OidcClient" = betterproto.message_field(1)

Ancestors

• betterproto.Message
• abc.ABC

Class variables

var client : OidcClient

class GetOidcClientRequest (id: str = None)

GetOidcClientRequest(id: str = None)

Expand source code

@dataclass(eq=False, repr=False)
class GetOidcClientRequest(betterproto.Message):
    id: str = betterproto.string_field(1)

Ancestors

• betterproto.Message
• abc.ABC

Class variables

var id : str

class GetOidcClientResponse (client: OidcClient = None)

GetOidcClientResponse(client: 'OidcClient' = None)

Expand source code

@dataclass(eq=False, repr=False)
class GetOidcClientResponse(betterproto.Message):
    client: "OidcClient" = betterproto.message_field(1)

Ancestors

• betterproto.Message
• abc.ABC

Class variables

var client : OidcClient

class ListOidcClientsRequest

ListOidcClientsRequest()

Expand source code

@dataclass(eq=False, repr=False)
class ListOidcClientsRequest(betterproto.Message):
    pass

Ancestors

• betterproto.Message
• abc.ABC

class ListOidcClientsResponse (clients: List[ForwardRef('OidcClient')] = None)

ListOidcClientsResponse(clients: List[ForwardRef('OidcClient')] = None)

Expand source code

@dataclass(eq=False, repr=False)
class ListOidcClientsResponse(betterproto.Message):
    clients: List["OidcClient"] = betterproto.message_field(1)

Ancestors

• betterproto.Message
• abc.ABC

Class variables

var clients : List[OidcClient]

class UpdateOidcClientRequest (client: OidcClient = None)

UpdateOidcClientRequest(client: 'OidcClient' = None)

Expand source code

@dataclass(eq=False, repr=False)
class UpdateOidcClientRequest(betterproto.Message):
    client: "OidcClient" = betterproto.message_field(1)

Ancestors

• betterproto.Message
• abc.ABC

Class variables

var client : OidcClient

class UpdateOidcClientResponse

UpdateOidcClientResponse()

Expand source code

@dataclass(eq=False, repr=False)
class UpdateOidcClientResponse(betterproto.Message):
    pass

Ancestors

• betterproto.Message
• abc.ABC

class DeleteOidcClientRequest (id: str = None)

DeleteOidcClientRequest(id: str = None)

Expand source code

@dataclass(eq=False, repr=False)
class DeleteOidcClientRequest(betterproto.Message):
    id: str = betterproto.string_field(1)

Ancestors

• betterproto.Message
• abc.ABC

Class variables

var id : str

class DeleteOidcClientResponse

DeleteOidcClientResponse()

Expand source code

@dataclass(eq=False, repr=False)
class DeleteOidcClientResponse(betterproto.Message):
    pass

Ancestors

• betterproto.Message
• abc.ABC

class DeleteAllRequest

DeleteAllRequest()

Expand source code

@dataclass(eq=False, repr=False)
class DeleteAllRequest(betterproto.Message):
    pass

Ancestors

• betterproto.Message
• abc.ABC

class DeleteAllResponse

DeleteAllResponse()

Expand source code

@dataclass(eq=False, repr=False)
class DeleteAllResponse(betterproto.Message):
    pass

Ancestors

• betterproto.Message
• abc.ABC

class ApiStub (channel: grpc.Channel)

Expand source code

class ApiStub:

    def __init__(self, channel: "grpc.Channel"):
        self.__rpc_set_identity_server_config = channel.unary_unary(
            "/identity_v2.API/SetIdentityServerConfig",
            request_serializer=SetIdentityServerConfigRequest.SerializeToString,
            response_deserializer=SetIdentityServerConfigResponse.FromString,
        )
        self.__rpc_get_identity_server_config = channel.unary_unary(
            "/identity_v2.API/GetIdentityServerConfig",
            request_serializer=GetIdentityServerConfigRequest.SerializeToString,
            response_deserializer=GetIdentityServerConfigResponse.FromString,
        )
        self.__rpc_create_idp_connector = channel.unary_unary(
            "/identity_v2.API/CreateIDPConnector",
            request_serializer=CreateIdpConnectorRequest.SerializeToString,
            response_deserializer=CreateIdpConnectorResponse.FromString,
        )
        self.__rpc_update_idp_connector = channel.unary_unary(
            "/identity_v2.API/UpdateIDPConnector",
            request_serializer=UpdateIdpConnectorRequest.SerializeToString,
            response_deserializer=UpdateIdpConnectorResponse.FromString,
        )
        self.__rpc_list_idp_connectors = channel.unary_unary(
            "/identity_v2.API/ListIDPConnectors",
            request_serializer=ListIdpConnectorsRequest.SerializeToString,
            response_deserializer=ListIdpConnectorsResponse.FromString,
        )
        self.__rpc_get_idp_connector = channel.unary_unary(
            "/identity_v2.API/GetIDPConnector",
            request_serializer=GetIdpConnectorRequest.SerializeToString,
            response_deserializer=GetIdpConnectorResponse.FromString,
        )
        self.__rpc_delete_idp_connector = channel.unary_unary(
            "/identity_v2.API/DeleteIDPConnector",
            request_serializer=DeleteIdpConnectorRequest.SerializeToString,
            response_deserializer=DeleteIdpConnectorResponse.FromString,
        )
        self.__rpc_create_oidc_client = channel.unary_unary(
            "/identity_v2.API/CreateOIDCClient",
            request_serializer=CreateOidcClientRequest.SerializeToString,
            response_deserializer=CreateOidcClientResponse.FromString,
        )
        self.__rpc_update_oidc_client = channel.unary_unary(
            "/identity_v2.API/UpdateOIDCClient",
            request_serializer=UpdateOidcClientRequest.SerializeToString,
            response_deserializer=UpdateOidcClientResponse.FromString,
        )
        self.__rpc_get_oidc_client = channel.unary_unary(
            "/identity_v2.API/GetOIDCClient",
            request_serializer=GetOidcClientRequest.SerializeToString,
            response_deserializer=GetOidcClientResponse.FromString,
        )
        self.__rpc_list_oidc_clients = channel.unary_unary(
            "/identity_v2.API/ListOIDCClients",
            request_serializer=ListOidcClientsRequest.SerializeToString,
            response_deserializer=ListOidcClientsResponse.FromString,
        )
        self.__rpc_delete_oidc_client = channel.unary_unary(
            "/identity_v2.API/DeleteOIDCClient",
            request_serializer=DeleteOidcClientRequest.SerializeToString,
            response_deserializer=DeleteOidcClientResponse.FromString,
        )
        self.__rpc_delete_all = channel.unary_unary(
            "/identity_v2.API/DeleteAll",
            request_serializer=DeleteAllRequest.SerializeToString,
            response_deserializer=DeleteAllResponse.FromString,
        )

    def set_identity_server_config(
        self, *, config: "IdentityServerConfig" = None
    ) -> "SetIdentityServerConfigResponse":

        request = SetIdentityServerConfigRequest()
        if config is not None:
            request.config = config

        return self.__rpc_set_identity_server_config(request)

    def get_identity_server_config(self) -> "GetIdentityServerConfigResponse":

        request = GetIdentityServerConfigRequest()

        return self.__rpc_get_identity_server_config(request)

    def create_idp_connector(
        self, *, connector: "IdpConnector" = None
    ) -> "CreateIdpConnectorResponse":

        request = CreateIdpConnectorRequest()
        if connector is not None:
            request.connector = connector

        return self.__rpc_create_idp_connector(request)

    def update_idp_connector(
        self, *, connector: "IdpConnector" = None
    ) -> "UpdateIdpConnectorResponse":

        request = UpdateIdpConnectorRequest()
        if connector is not None:
            request.connector = connector

        return self.__rpc_update_idp_connector(request)

    def list_idp_connectors(self) -> "ListIdpConnectorsResponse":

        request = ListIdpConnectorsRequest()

        return self.__rpc_list_idp_connectors(request)

    def get_idp_connector(self, *, id: str = "") -> "GetIdpConnectorResponse":

        request = GetIdpConnectorRequest()
        request.id = id

        return self.__rpc_get_idp_connector(request)

    def delete_idp_connector(self, *, id: str = "") -> "DeleteIdpConnectorResponse":

        request = DeleteIdpConnectorRequest()
        request.id = id

        return self.__rpc_delete_idp_connector(request)

    def create_oidc_client(
        self, *, client: "OidcClient" = None
    ) -> "CreateOidcClientResponse":

        request = CreateOidcClientRequest()
        if client is not None:
            request.client = client

        return self.__rpc_create_oidc_client(request)

    def update_oidc_client(
        self, *, client: "OidcClient" = None
    ) -> "UpdateOidcClientResponse":

        request = UpdateOidcClientRequest()
        if client is not None:
            request.client = client

        return self.__rpc_update_oidc_client(request)

    def get_oidc_client(self, *, id: str = "") -> "GetOidcClientResponse":

        request = GetOidcClientRequest()
        request.id = id

        return self.__rpc_get_oidc_client(request)

    def list_oidc_clients(self) -> "ListOidcClientsResponse":

        request = ListOidcClientsRequest()

        return self.__rpc_list_oidc_clients(request)

    def delete_oidc_client(self, *, id: str = "") -> "DeleteOidcClientResponse":

        request = DeleteOidcClientRequest()
        request.id = id

        return self.__rpc_delete_oidc_client(request)

    def delete_all(self) -> "DeleteAllResponse":

        request = DeleteAllRequest()

        return self.__rpc_delete_all(request)

Methods

def set_identity_server_config(self, *, config: IdentityServerConfig = None) ‑> SetIdentityServerConfigResponse

Expand source code

def set_identity_server_config(
    self, *, config: "IdentityServerConfig" = None
) -> "SetIdentityServerConfigResponse":

    request = SetIdentityServerConfigRequest()
    if config is not None:
        request.config = config

    return self.__rpc_set_identity_server_config(request)

def get_identity_server_config(self) ‑> GetIdentityServerConfigResponse

Expand source code

def get_identity_server_config(self) -> "GetIdentityServerConfigResponse":

    request = GetIdentityServerConfigRequest()

    return self.__rpc_get_identity_server_config(request)

def create_idp_connector(self, *, connector: IdpConnector = None) ‑> CreateIdpConnectorResponse

Expand source code

def create_idp_connector(
    self, *, connector: "IdpConnector" = None
) -> "CreateIdpConnectorResponse":

    request = CreateIdpConnectorRequest()
    if connector is not None:
        request.connector = connector

    return self.__rpc_create_idp_connector(request)

def update_idp_connector(self, *, connector: IdpConnector = None) ‑> UpdateIdpConnectorResponse

Expand source code

def update_idp_connector(
    self, *, connector: "IdpConnector" = None
) -> "UpdateIdpConnectorResponse":

    request = UpdateIdpConnectorRequest()
    if connector is not None:
        request.connector = connector

    return self.__rpc_update_idp_connector(request)

def list_idp_connectors(self) ‑> ListIdpConnectorsResponse

Expand source code

def list_idp_connectors(self) -> "ListIdpConnectorsResponse":

    request = ListIdpConnectorsRequest()

    return self.__rpc_list_idp_connectors(request)

def get_idp_connector(self, *, id: str = '') ‑> GetIdpConnectorResponse

Expand source code

def get_idp_connector(self, *, id: str = "") -> "GetIdpConnectorResponse":

    request = GetIdpConnectorRequest()
    request.id = id

    return self.__rpc_get_idp_connector(request)

def delete_idp_connector(self, *, id: str = '') ‑> DeleteIdpConnectorResponse

Expand source code

def delete_idp_connector(self, *, id: str = "") -> "DeleteIdpConnectorResponse":

    request = DeleteIdpConnectorRequest()
    request.id = id

    return self.__rpc_delete_idp_connector(request)

def create_oidc_client(self, *, client: OidcClient = None) ‑> CreateOidcClientResponse

Expand source code

def create_oidc_client(
    self, *, client: "OidcClient" = None
) -> "CreateOidcClientResponse":

    request = CreateOidcClientRequest()
    if client is not None:
        request.client = client

    return self.__rpc_create_oidc_client(request)

def update_oidc_client(self, *, client: OidcClient = None) ‑> UpdateOidcClientResponse

Expand source code

def update_oidc_client(
    self, *, client: "OidcClient" = None
) -> "UpdateOidcClientResponse":

    request = UpdateOidcClientRequest()
    if client is not None:
        request.client = client

    return self.__rpc_update_oidc_client(request)

def get_oidc_client(self, *, id: str = '') ‑> GetOidcClientResponse

Expand source code

def get_oidc_client(self, *, id: str = "") -> "GetOidcClientResponse":

    request = GetOidcClientRequest()
    request.id = id

    return self.__rpc_get_oidc_client(request)

def list_oidc_clients(self) ‑> ListOidcClientsResponse

Expand source code

def list_oidc_clients(self) -> "ListOidcClientsResponse":

    request = ListOidcClientsRequest()

    return self.__rpc_list_oidc_clients(request)

def delete_oidc_client(self, *, id: str = '') ‑> DeleteOidcClientResponse

Expand source code

def delete_oidc_client(self, *, id: str = "") -> "DeleteOidcClientResponse":

    request = DeleteOidcClientRequest()
    request.id = id

    return self.__rpc_delete_oidc_client(request)

def delete_all(self) ‑> DeleteAllResponse

Expand source code

def delete_all(self) -> "DeleteAllResponse":

    request = DeleteAllRequest()

    return self.__rpc_delete_all(request)