api.md

Zones

Types:

from keycardai_api.types import (
    EncryptionKeyAwsKmsConfig,
    PageInfoPagination,
    Zone,
    ZoneListResponse,
    ZoneListSessionResourceAccessResponse,
)

Methods:

• client.zones.create(**params) -> Zone
• client.zones.retrieve(zone_id, **params) -> Zone
• client.zones.update(zone_id, **params) -> Zone
• client.zones.list(**params) -> ZoneListResponse
• client.zones.delete(zone_id) -> None
• client.zones.list_session_resource_access(zone_id, **params) -> ZoneListSessionResourceAccessResponse

Applications

Types:

from keycardai_api.types.zones import (
    Application,
    ApplicationTrait,
    Metadata,
    MetadataUpdate,
    ApplicationListResponse,
    ApplicationListCredentialsResponse,
    ApplicationListResourcesResponse,
)

Methods:

• client.zones.applications.create(zone_id, **params) -> Application
• client.zones.applications.retrieve(id, *, zone_id) -> Application
• client.zones.applications.update(id, *, zone_id, **params) -> Application
• client.zones.applications.list(zone_id, **params) -> ApplicationListResponse
• client.zones.applications.delete(id, *, zone_id) -> None
• client.zones.applications.list_credentials(id, *, zone_id, **params) -> ApplicationListCredentialsResponse
• client.zones.applications.list_resources(id, *, zone_id, **params) -> ApplicationListResourcesResponse

Dependencies

Types:

from keycardai_api.types.zones.applications import Resource, DependencyListResponse

Methods:

• client.zones.applications.dependencies.retrieve(dependency_id, *, zone_id, id) -> Resource
• client.zones.applications.dependencies.list(id, *, zone_id, **params) -> DependencyListResponse
• client.zones.applications.dependencies.add(dependency_id, *, zone_id, id, **params) -> None
• client.zones.applications.dependencies.remove(dependency_id, *, zone_id, id) -> None

ApplicationCredentials

Types:

from keycardai_api.types.zones import (
    BaseFields,
    Credential,
    Password,
    Public,
    PublicKey,
    Token,
    URL,
    ApplicationCredentialCreateResponse,
    ApplicationCredentialListResponse,
)

Methods:

• client.zones.application_credentials.create(zone_id, **params) -> ApplicationCredentialCreateResponse
• client.zones.application_credentials.retrieve(id, *, zone_id) -> Credential
• client.zones.application_credentials.update(id, *, zone_id, **params) -> Credential
• client.zones.application_credentials.list(zone_id, **params) -> ApplicationCredentialListResponse
• client.zones.application_credentials.delete(id, *, zone_id) -> None

DelegatedGrants

Types:

from keycardai_api.types.zones import Grant, DelegatedGrantListResponse

Methods:

• client.zones.delegated_grants.retrieve(id, *, zone_id) -> Grant
• client.zones.delegated_grants.update(id, *, zone_id, **params) -> Grant
• client.zones.delegated_grants.list(zone_id, **params) -> DelegatedGrantListResponse
• client.zones.delegated_grants.delete(id, *, zone_id) -> None

Providers

Types:

from keycardai_api.types.zones import Provider, ProviderListResponse

Methods:

• client.zones.providers.create(zone_id, **params) -> Provider
• client.zones.providers.retrieve(id, *, zone_id) -> Provider
• client.zones.providers.update(id, *, zone_id, **params) -> Provider
• client.zones.providers.list(zone_id, **params) -> ProviderListResponse
• client.zones.providers.delete(id, *, zone_id) -> None

Resources

Types:

from keycardai_api.types.zones import ResourceListResponse

Methods:

• client.zones.resources.create(zone_id, **params) -> Resource
• client.zones.resources.retrieve(id, *, zone_id) -> Resource
• client.zones.resources.update(id, *, zone_id, **params) -> Resource
• client.zones.resources.list(zone_id, **params) -> ResourceListResponse
• client.zones.resources.delete(id, *, zone_id) -> None

Sessions

Types:

from keycardai_api.types.zones import Session, SessionListResponse

Methods:

• client.zones.sessions.retrieve(id, *, zone_id) -> Session
• client.zones.sessions.update(id, *, zone_id, **params) -> Session
• client.zones.sessions.list(zone_id, **params) -> SessionListResponse
• client.zones.sessions.delete(id, *, zone_id) -> None

UserAgents

Types:

from keycardai_api.types.zones import UserAgent, UserAgentListResponse

Methods:

• client.zones.user_agents.retrieve(id, *, zone_id) -> UserAgent
• client.zones.user_agents.list(zone_id, **params) -> UserAgentListResponse

Users

Types:

from keycardai_api.types.zones import User, UserListResponse

Methods:

• client.zones.users.retrieve(id, *, zone_id) -> User
• client.zones.users.list(zone_id, **params) -> UserListResponse

Members

Types:

from keycardai_api.types.zones import ZoneMember, ZoneRole, MemberListResponse

Methods:

• client.zones.members.retrieve(organization_user_id, *, zone_id) -> ZoneMember
• client.zones.members.update(organization_user_id, *, zone_id, **params) -> ZoneMember
• client.zones.members.list(zone_id, **params) -> MemberListResponse
• client.zones.members.delete(organization_user_id, *, zone_id) -> None
• client.zones.members.add(zone_id, **params) -> ZoneMember

Secrets

Types:

from keycardai_api.types.zones import (
    Secret,
    SecretPasswordFields,
    SecretTokenFields,
    SecretRetrieveResponse,
    SecretListResponse,
)

Methods:

• client.zones.secrets.create(path_zone_id, **params) -> Secret
• client.zones.secrets.retrieve(id, *, zone_id) -> SecretRetrieveResponse
• client.zones.secrets.update(id, *, zone_id, **params) -> Secret
• client.zones.secrets.list(zone_id, **params) -> SecretListResponse
• client.zones.secrets.delete(id, *, zone_id) -> None

PolicySchemas

Types:

from keycardai_api.types.zones import (
    SchemaVersion,
    SchemaVersionWithZoneInfo,
    PolicySchemaListResponse,
)

Methods:

• client.zones.policy_schemas.retrieve(version, *, zone_id, **params) -> SchemaVersionWithZoneInfo
• client.zones.policy_schemas.list(zone_id, **params) -> PolicySchemaListResponse
• client.zones.policy_schemas.set_default(version, *, zone_id, **params) -> SchemaVersionWithZoneInfo

Policies

Types:

from keycardai_api.types.zones import Policy, PolicyDraft, PolicyListResponse

Methods:

• client.zones.policies.create(zone_id, **params) -> Policy
• client.zones.policies.retrieve(policy_id, *, zone_id) -> Policy
• client.zones.policies.update(policy_id, *, zone_id, **params) -> Policy
• client.zones.policies.list(zone_id, **params) -> PolicyListResponse
• client.zones.policies.archive(policy_id, *, zone_id) -> Policy

Versions

Types:

from keycardai_api.types.zones.policies import PolicyVersion, VersionListResponse

Methods:

• client.zones.policies.versions.create(policy_id, *, zone_id, **params) -> PolicyVersion
• client.zones.policies.versions.retrieve(version_id, *, zone_id, policy_id, **params) -> PolicyVersion
• client.zones.policies.versions.list(policy_id, *, zone_id, **params) -> VersionListResponse
• client.zones.policies.versions.archive(version_id, *, zone_id, policy_id) -> PolicyVersion

PolicySets

Types:

from keycardai_api.types.zones import (
    Attestation,
    AttestationStatement,
    PolicySet,
    PolicySetDraft,
    PolicySetManifest,
    PolicySetManifestEntry,
    PolicySetWithBinding,
    PolicySetListResponse,
)

Methods:

• client.zones.policy_sets.create(zone_id, **params) -> PolicySetWithBinding
• client.zones.policy_sets.retrieve(policy_set_id, *, zone_id) -> PolicySetWithBinding
• client.zones.policy_sets.update(policy_set_id, *, zone_id, **params) -> PolicySetWithBinding
• client.zones.policy_sets.list(zone_id, **params) -> PolicySetListResponse
• client.zones.policy_sets.archive(policy_set_id, *, zone_id) -> PolicySetWithBinding

Versions

Types:

from keycardai_api.types.zones.policy_sets import (
    PolicySetVersion,
    VersionListResponse,
    VersionListPoliciesResponse,
)

Methods:

• client.zones.policy_sets.versions.create(policy_set_id, *, zone_id, **params) -> PolicySetVersion
• client.zones.policy_sets.versions.retrieve(version_id, *, zone_id, policy_set_id) -> PolicySetVersion
• client.zones.policy_sets.versions.update(version_id, *, zone_id, policy_set_id, **params) -> PolicySetVersion
• client.zones.policy_sets.versions.list(policy_set_id, *, zone_id, **params) -> VersionListResponse
• client.zones.policy_sets.versions.archive(version_id, *, zone_id, policy_set_id) -> PolicySetVersion
• client.zones.policy_sets.versions.list_policies(version_id, *, zone_id, policy_set_id, **params) -> VersionListPoliciesResponse

Organizations

Types:

from keycardai_api.types import (
    Organization,
    PageInfoCursor,
    RoleScope,
    TokenResponse,
    OrganizationListResponse,
    OrganizationListIdentitiesResponse,
    OrganizationListRolesResponse,
)

Methods:

• client.organizations.create(**params) -> Organization
• client.organizations.retrieve(organization_id, **params) -> Organization
• client.organizations.update(organization_id, **params) -> Organization
• client.organizations.list(**params) -> OrganizationListResponse
• client.organizations.exchange_token(organization_id) -> TokenResponse
• client.organizations.list_identities(organization_id, **params) -> OrganizationListIdentitiesResponse
• client.organizations.list_roles(organization_id, **params) -> OrganizationListRolesResponse

Users

Types:

from keycardai_api.types.organizations import (
    OrganizationRole,
    OrganizationStatus,
    OrganizationUser,
    UserListResponse,
)

Methods:

• client.organizations.users.retrieve(user_id, *, organization_id, **params) -> OrganizationUser
• client.organizations.users.update(user_id, *, organization_id, **params) -> OrganizationUser
• client.organizations.users.list(organization_id, **params) -> UserListResponse
• client.organizations.users.delete(user_id, *, organization_id) -> None

Invitations

Types:

from keycardai_api.types.organizations import Invitation, InvitationStatus, InvitationListResponse

Methods:

• client.organizations.invitations.create(organization_id, **params) -> Invitation
• client.organizations.invitations.list(organization_id, **params) -> InvitationListResponse
• client.organizations.invitations.delete(invitation_id, *, organization_id) -> None

ServiceAccounts

Types:

from keycardai_api.types.organizations import ServiceAccount, ServiceAccountListResponse

Methods:

• client.organizations.service_accounts.create(organization_id, **params) -> ServiceAccount
• client.organizations.service_accounts.retrieve(service_account_id, *, organization_id, **params) -> ServiceAccount
• client.organizations.service_accounts.update(service_account_id, *, organization_id, **params) -> ServiceAccount
• client.organizations.service_accounts.list(organization_id, **params) -> ServiceAccountListResponse
• client.organizations.service_accounts.delete(service_account_id, *, organization_id) -> None

Credentials

Types:

from keycardai_api.types.organizations.service_accounts import (
    ServiceAccountCredential,
    CredentialCreateResponse,
    CredentialListResponse,
)

Methods:

• client.organizations.service_accounts.credentials.create(service_account_id, *, organization_id, **params) -> CredentialCreateResponse
• client.organizations.service_accounts.credentials.retrieve(credential_id, *, organization_id, service_account_id, **params) -> ServiceAccountCredential
• client.organizations.service_accounts.credentials.update(credential_id, *, organization_id, service_account_id, **params) -> ServiceAccountCredential
• client.organizations.service_accounts.credentials.list(service_account_id, *, organization_id, **params) -> CredentialListResponse
• client.organizations.service_accounts.credentials.delete(credential_id, *, organization_id, service_account_id) -> None

SSOConnection

Types:

from keycardai_api.types.organizations import SSOConnection, SSOConnectionProtocol

Methods:

• client.organizations.sso_connection.retrieve(organization_id, **params) -> SSOConnection
• client.organizations.sso_connection.update(organization_id, **params) -> SSOConnection
• client.organizations.sso_connection.disable(organization_id) -> None
• client.organizations.sso_connection.enable(organization_id, **params) -> SSOConnection

Invitations

Types:

from keycardai_api.types import InvitationRetrieveResponse, InvitationAcceptResponse

Methods:

• client.invitations.retrieve(token) -> InvitationRetrieveResponse
• client.invitations.accept(token) -> InvitationAcceptResponse