phasetwo-sdk 0.2.0__py3-none-any.whl

phasetwo/__init__.py

@@ -0,0 +1,19 @@
+"""Python client for the Phase Two Admin REST API.
+
+The API classes and models are generated into ``phasetwo.openapi`` by
+https://github.com/p2-inc/phasetwo-sdk-generator and re-exported here, so
+``from phasetwo import OrganizationsApi`` works. Hand-written helpers live next to
+this file; never edit ``phasetwo/openapi`` by hand.
+"""
+
+from importlib.metadata import PackageNotFoundError, version as _version
+
+from phasetwo.openapi import *  # noqa: F401,F403
+from phasetwo.openapi import __all__ as _generated_all
+
+try:
+    __version__ = _version("phasetwo-sdk")
+except PackageNotFoundError:  # running from a source checkout
+    __version__ = "0.0.0"
+
+__all__ = list(_generated_all)

phasetwo/openapi/__init__.py

@@ -0,0 +1,244 @@
+# coding: utf-8
+
+# flake8: noqa
+
+"""
+Phase Two Admin REST API
+
+This is a REST API reference for the Phase Two Keycloak extensions. These are extensions to the standard [Keycloak Admin REST API](https://www.keycloak.org/docs-api/latest/rest-api/index.html), and run on your cluster alongside it.  ### Base URI format Paths specified in the documentation are relative to the base URI. - Format: `https://<your-cluster-host>/auth/realms` - Example: `https://auth.example.com/auth/realms`  `<your-cluster-host>` is your cluster's hostname from the Phase Two Dashboard, or a custom domain attached to it.  ### Authentication Send an access token in the `Authorization: Bearer <token>` header of every request. We recommend getting the token for a [service account](https://phasetwo.io/docs/api/service-accounts) with the client credentials grant, using a confidential client you create for API access.  A Keycloak admin client library, such as the [Keycloak Admin Client for JavaScript](https://github.com/keycloak/keycloak/tree/main/js/libs/keycloak-admin-client), can take care of getting an access token and refreshing it when it expires.  #### Client credentials grant example ``` POST /auth/realms/my-realm/protocol/openid-connect/token Host: auth.example.com Accept: application/json Content-Type: application/x-www-form-urlencoded  grant_type=client_credentials&client_id=api-client&client_secret=<client-secret> ```  The response contains the access token, its type, and its lifetime in seconds: ```json {   \"access_token\": \"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...\",   \"token_type\": \"Bearer\",   \"expires_in\": 300 } ```  ### SDKs Modern API libraries are available for several common languages. These are available as open source at the links below, or you can choose to generate your own using our [OpenAPI spec file](https://raw.githubusercontent.com/p2-inc/phasetwo-docs/main/openapi.yaml).  | Language | Library | | --- | --- | | Java (and other JVM langs) | https://github.com/p2-inc/phasetwo-java | | JavaScript/TypeScript | https://github.com/p2-inc/phasetwo-js | | Python | https://github.com/p2-inc/phasetwo-python |
+
+The version of the OpenAPI document: see sdk-generator.json
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+__version__ = "1.0.0"
+
+# Define package exports
+__all__ = [
+    "AttributesApi",
+    "EventsApi",
+    "IdentityProvidersApi",
+    "OrganizationDomainsApi",
+    "OrganizationInvitationsApi",
+    "OrganizationMembershipsApi",
+    "OrganizationRolesApi",
+    "OrganizationSCIMApi",
+    "OrganizationsApi",
+    "UsersApi",
+    "ApiResponse",
+    "ApiClient",
+    "Configuration",
+    "OpenApiException",
+    "ApiTypeError",
+    "ApiValueError",
+    "ApiKeyError",
+    "ApiAttributeError",
+    "ApiException",
+    "AccessTokenResponse",
+    "AuthDetailsRepresentation",
+    "BulkResponseItem",
+    "CredentialRepresentation",
+    "EventRepresentation",
+    "ExternalBasicScimAuth",
+    "ExternalJwtScimAuth",
+    "ExternalSecretScimAuth",
+    "IdentityProviderMapperRepresentation",
+    "IdentityProviderRepresentation",
+    "IdpInitiatedClientRepresentation",
+    "IdpInitiatedClientRepresentationAttributes",
+    "InvitationRepresentation",
+    "InvitationRequestRepresentation",
+    "KeycloakScimAuth",
+    "LinkIdentityProviderRepresentation",
+    "MagicLinkRequest",
+    "MagicLinkResponse",
+    "MyOrganizationRepresentation",
+    "OrganizationConfigRepresentation",
+    "OrganizationDomainRepresentation",
+    "OrganizationExportRepresentation",
+    "OrganizationExportRepresentationAllOfMembers",
+    "OrganizationMemberAttributeRepresentation",
+    "OrganizationRepresentation",
+    "OrganizationRoleRepresentation",
+    "OrganizationScimAuth",
+    "OrganizationScimRepresentation",
+    "OrganizationsConfigRepresentation",
+    "OrganizationsExportRepresentation",
+    "OrganizationsImportRepresentation",
+    "OrganizationsImportResultRepresentation",
+    "OrganizationsImportResultRepresentationErrorsInner",
+    "PortalLinkRepresentation",
+    "RealmAttributeRepresentation",
+    "SwitchOrganizationRepresentation",
+    "UserBriefRepresentation",
+    "UserRepresentation",
+    "UserWithOrgsBriefRepresentation",
+    "UserWithOrgsRepresentation",
+    "WebhookRepresentation",
+    "WebhookSendRepresentation",
+]
+
+# import apis into sdk package
+from phasetwo.openapi.api.attributes_api import AttributesApi as AttributesApi
+from phasetwo.openapi.api.events_api import EventsApi as EventsApi
+from phasetwo.openapi.api.identity_providers_api import (
+    IdentityProvidersApi as IdentityProvidersApi,
+)
+from phasetwo.openapi.api.organization_domains_api import (
+    OrganizationDomainsApi as OrganizationDomainsApi,
+)
+from phasetwo.openapi.api.organization_invitations_api import (
+    OrganizationInvitationsApi as OrganizationInvitationsApi,
+)
+from phasetwo.openapi.api.organization_memberships_api import (
+    OrganizationMembershipsApi as OrganizationMembershipsApi,
+)
+from phasetwo.openapi.api.organization_roles_api import (
+    OrganizationRolesApi as OrganizationRolesApi,
+)
+from phasetwo.openapi.api.organization_scim_api import (
+    OrganizationSCIMApi as OrganizationSCIMApi,
+)
+from phasetwo.openapi.api.organizations_api import OrganizationsApi as OrganizationsApi
+from phasetwo.openapi.api.users_api import UsersApi as UsersApi
+
+# import ApiClient
+from phasetwo.openapi.api_response import ApiResponse as ApiResponse
+from phasetwo.openapi.api_client import ApiClient as ApiClient
+from phasetwo.openapi.configuration import Configuration as Configuration
+from phasetwo.openapi.exceptions import OpenApiException as OpenApiException
+from phasetwo.openapi.exceptions import ApiTypeError as ApiTypeError
+from phasetwo.openapi.exceptions import ApiValueError as ApiValueError
+from phasetwo.openapi.exceptions import ApiKeyError as ApiKeyError
+from phasetwo.openapi.exceptions import ApiAttributeError as ApiAttributeError
+from phasetwo.openapi.exceptions import ApiException as ApiException
+
+# import models into sdk package
+from phasetwo.openapi.models.access_token_response import (
+    AccessTokenResponse as AccessTokenResponse,
+)
+from phasetwo.openapi.models.auth_details_representation import (
+    AuthDetailsRepresentation as AuthDetailsRepresentation,
+)
+from phasetwo.openapi.models.bulk_response_item import (
+    BulkResponseItem as BulkResponseItem,
+)
+from phasetwo.openapi.models.credential_representation import (
+    CredentialRepresentation as CredentialRepresentation,
+)
+from phasetwo.openapi.models.event_representation import (
+    EventRepresentation as EventRepresentation,
+)
+from phasetwo.openapi.models.external_basic_scim_auth import (
+    ExternalBasicScimAuth as ExternalBasicScimAuth,
+)
+from phasetwo.openapi.models.external_jwt_scim_auth import (
+    ExternalJwtScimAuth as ExternalJwtScimAuth,
+)
+from phasetwo.openapi.models.external_secret_scim_auth import (
+    ExternalSecretScimAuth as ExternalSecretScimAuth,
+)
+from phasetwo.openapi.models.identity_provider_mapper_representation import (
+    IdentityProviderMapperRepresentation as IdentityProviderMapperRepresentation,
+)
+from phasetwo.openapi.models.identity_provider_representation import (
+    IdentityProviderRepresentation as IdentityProviderRepresentation,
+)
+from phasetwo.openapi.models.idp_initiated_client_representation import (
+    IdpInitiatedClientRepresentation as IdpInitiatedClientRepresentation,
+)
+from phasetwo.openapi.models.idp_initiated_client_representation_attributes import (
+    IdpInitiatedClientRepresentationAttributes as IdpInitiatedClientRepresentationAttributes,
+)
+from phasetwo.openapi.models.invitation_representation import (
+    InvitationRepresentation as InvitationRepresentation,
+)
+from phasetwo.openapi.models.invitation_request_representation import (
+    InvitationRequestRepresentation as InvitationRequestRepresentation,
+)
+from phasetwo.openapi.models.keycloak_scim_auth import (
+    KeycloakScimAuth as KeycloakScimAuth,
+)
+from phasetwo.openapi.models.link_identity_provider_representation import (
+    LinkIdentityProviderRepresentation as LinkIdentityProviderRepresentation,
+)
+from phasetwo.openapi.models.magic_link_request import (
+    MagicLinkRequest as MagicLinkRequest,
+)
+from phasetwo.openapi.models.magic_link_response import (
+    MagicLinkResponse as MagicLinkResponse,
+)
+from phasetwo.openapi.models.my_organization_representation import (
+    MyOrganizationRepresentation as MyOrganizationRepresentation,
+)
+from phasetwo.openapi.models.organization_config_representation import (
+    OrganizationConfigRepresentation as OrganizationConfigRepresentation,
+)
+from phasetwo.openapi.models.organization_domain_representation import (
+    OrganizationDomainRepresentation as OrganizationDomainRepresentation,
+)
+from phasetwo.openapi.models.organization_export_representation import (
+    OrganizationExportRepresentation as OrganizationExportRepresentation,
+)
+from phasetwo.openapi.models.organization_export_representation_all_of_members import (
+    OrganizationExportRepresentationAllOfMembers as OrganizationExportRepresentationAllOfMembers,
+)
+from phasetwo.openapi.models.organization_member_attribute_representation import (
+    OrganizationMemberAttributeRepresentation as OrganizationMemberAttributeRepresentation,
+)
+from phasetwo.openapi.models.organization_representation import (
+    OrganizationRepresentation as OrganizationRepresentation,
+)
+from phasetwo.openapi.models.organization_role_representation import (
+    OrganizationRoleRepresentation as OrganizationRoleRepresentation,
+)
+from phasetwo.openapi.models.organization_scim_auth import (
+    OrganizationScimAuth as OrganizationScimAuth,
+)
+from phasetwo.openapi.models.organization_scim_representation import (
+    OrganizationScimRepresentation as OrganizationScimRepresentation,
+)
+from phasetwo.openapi.models.organizations_config_representation import (
+    OrganizationsConfigRepresentation as OrganizationsConfigRepresentation,
+)
+from phasetwo.openapi.models.organizations_export_representation import (
+    OrganizationsExportRepresentation as OrganizationsExportRepresentation,
+)
+from phasetwo.openapi.models.organizations_import_representation import (
+    OrganizationsImportRepresentation as OrganizationsImportRepresentation,
+)
+from phasetwo.openapi.models.organizations_import_result_representation import (
+    OrganizationsImportResultRepresentation as OrganizationsImportResultRepresentation,
+)
+from phasetwo.openapi.models.organizations_import_result_representation_errors_inner import (
+    OrganizationsImportResultRepresentationErrorsInner as OrganizationsImportResultRepresentationErrorsInner,
+)
+from phasetwo.openapi.models.portal_link_representation import (
+    PortalLinkRepresentation as PortalLinkRepresentation,
+)
+from phasetwo.openapi.models.realm_attribute_representation import (
+    RealmAttributeRepresentation as RealmAttributeRepresentation,
+)
+from phasetwo.openapi.models.switch_organization_representation import (
+    SwitchOrganizationRepresentation as SwitchOrganizationRepresentation,
+)
+from phasetwo.openapi.models.user_brief_representation import (
+    UserBriefRepresentation as UserBriefRepresentation,
+)
+from phasetwo.openapi.models.user_representation import (
+    UserRepresentation as UserRepresentation,
+)
+from phasetwo.openapi.models.user_with_orgs_brief_representation import (
+    UserWithOrgsBriefRepresentation as UserWithOrgsBriefRepresentation,
+)
+from phasetwo.openapi.models.user_with_orgs_representation import (
+    UserWithOrgsRepresentation as UserWithOrgsRepresentation,
+)
+from phasetwo.openapi.models.webhook_representation import (
+    WebhookRepresentation as WebhookRepresentation,
+)
+from phasetwo.openapi.models.webhook_send_representation import (
+    WebhookSendRepresentation as WebhookSendRepresentation,
+)

phasetwo/openapi/api/__init__.py

@@ -0,0 +1,13 @@
+# flake8: noqa
+
+# import apis into api package
+from phasetwo.openapi.api.attributes_api import AttributesApi
+from phasetwo.openapi.api.events_api import EventsApi
+from phasetwo.openapi.api.identity_providers_api import IdentityProvidersApi
+from phasetwo.openapi.api.organization_domains_api import OrganizationDomainsApi
+from phasetwo.openapi.api.organization_invitations_api import OrganizationInvitationsApi
+from phasetwo.openapi.api.organization_memberships_api import OrganizationMembershipsApi
+from phasetwo.openapi.api.organization_roles_api import OrganizationRolesApi
+from phasetwo.openapi.api.organization_scim_api import OrganizationSCIMApi
+from phasetwo.openapi.api.organizations_api import OrganizationsApi
+from phasetwo.openapi.api.users_api import UsersApi