Skip to main content

credoxa-auth

Credoxa Auth v2 API contract for authentication, authorization, OAuth 2.0, OpenID Connect, multi-tenant identity management, federation, SCIM provisioning, and session management.

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 0.1.0
  • Package version: 0.1.0
  • Generator version: 7.14.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import credoxa_auth

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import credoxa_auth

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import credoxa_auth
from credoxa_auth.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = credoxa_auth.Configuration(
    host = "http://localhost"
)



# Enter a context with an instance of the API client
with credoxa_auth.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = credoxa_auth.DiscoveryApi(api_client)

    try:
        # GET /.well-known/openid-configuration
        api_response = api_instance.get_well_known_openid_configuration()
        print("The response of DiscoveryApi->get_well_known_openid_configuration:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DiscoveryApi->get_well_known_openid_configuration: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
DiscoveryApi get_well_known_openid_configuration GET /.well-known/openid-configuration GET /.well-known/openid-configuration
FederationApi get_federation_saml_providers_provider_id_metadata GET /federation/saml/providers/{provider_id}/metadata GET /federation/saml/providers/{provider_id}/metadata
FederationApi post_federation_providers_provider_id_begin POST /federation/providers/{provider_id}/begin POST /federation/providers/{provider_id}/begin
FederationApi post_federation_providers_provider_id_callback POST /federation/providers/{provider_id}/callback POST /federation/providers/{provider_id}/callback
FederationApi post_federation_saml_providers_provider_id_acs POST /federation/saml/providers/{provider_id}/acs POST /federation/saml/providers/{provider_id}/acs
FederationApi post_federation_saml_providers_provider_id_begin POST /federation/saml/providers/{provider_id}/begin POST /federation/saml/providers/{provider_id}/begin
InternalApi get_health_live GET /health/live GET /health/live
InternalApi get_health_metrics GET /health/metrics GET /health/metrics
InternalApi get_health_ready GET /health/ready GET /health/ready
ManagementApi delete_api_v1_management_organizations_organization_id_role_assignments_humans DELETE /api/v1/management/organizations/{organization_id}/role-assignments/humans DELETE /api/v1/management/organizations/{organization_id}/role-assignments/humans
ManagementApi delete_api_v1_management_organizations_organization_id_role_assignments_machines DELETE /api/v1/management/organizations/{organization_id}/role-assignments/machines DELETE /api/v1/management/organizations/{organization_id}/role-assignments/machines
ManagementApi delete_api_v1_management_organizations_organization_id_roles_role_id_permissions DELETE /api/v1/management/organizations/{organization_id}/roles/{role_id}/permissions DELETE /api/v1/management/organizations/{organization_id}/roles/{role_id}/permissions
ManagementApi get_api_v1_management_me GET /api/v1/management/me GET /api/v1/management/me
ManagementApi get_api_v1_management_organizations_organization_id GET /api/v1/management/organizations/{organization_id} GET /api/v1/management/organizations/{organization_id}
ManagementApi get_api_v1_management_organizations_organization_id_access GET /api/v1/management/organizations/{organization_id}/access GET /api/v1/management/organizations/{organization_id}/access
ManagementApi get_api_v1_management_organizations_organization_id_applications GET /api/v1/management/organizations/{organization_id}/applications GET /api/v1/management/organizations/{organization_id}/applications
ManagementApi get_api_v1_management_organizations_organization_id_bulk_provisioning_jobs GET /api/v1/management/organizations/{organization_id}/bulk-provisioning/jobs GET /api/v1/management/organizations/{organization_id}/bulk-provisioning/jobs
ManagementApi get_api_v1_management_organizations_organization_id_bulk_provisioning_jobs_job_id GET /api/v1/management/organizations/{organization_id}/bulk-provisioning/jobs/{job_id} GET /api/v1/management/organizations/{organization_id}/bulk-provisioning/jobs/{job_id}
ManagementApi get_api_v1_management_organizations_organization_id_federation_providers GET /api/v1/management/organizations/{organization_id}/federation/providers GET /api/v1/management/organizations/{organization_id}/federation/providers
ManagementApi get_api_v1_management_organizations_organization_id_federation_providers_provider_id GET /api/v1/management/organizations/{organization_id}/federation/providers/{provider_id} GET /api/v1/management/organizations/{organization_id}/federation/providers/{provider_id}
ManagementApi get_api_v1_management_organizations_organization_id_identities GET /api/v1/management/organizations/{organization_id}/identities GET /api/v1/management/organizations/{organization_id}/identities
ManagementApi get_api_v1_management_organizations_organization_id_invitations GET /api/v1/management/organizations/{organization_id}/invitations GET /api/v1/management/organizations/{organization_id}/invitations
ManagementApi get_api_v1_management_organizations_organization_id_machines GET /api/v1/management/organizations/{organization_id}/machines GET /api/v1/management/organizations/{organization_id}/machines
ManagementApi get_api_v1_management_organizations_organization_id_memberships GET /api/v1/management/organizations/{organization_id}/memberships GET /api/v1/management/organizations/{organization_id}/memberships
ManagementApi get_api_v1_management_organizations_organization_id_permissions GET /api/v1/management/organizations/{organization_id}/permissions GET /api/v1/management/organizations/{organization_id}/permissions
ManagementApi get_api_v1_management_organizations_organization_id_roles GET /api/v1/management/organizations/{organization_id}/roles GET /api/v1/management/organizations/{organization_id}/roles
ManagementApi get_api_v1_management_organizations_organization_id_saml_providers GET /api/v1/management/organizations/{organization_id}/saml/providers GET /api/v1/management/organizations/{organization_id}/saml/providers
ManagementApi get_api_v1_management_organizations_organization_id_saml_providers_provider_id GET /api/v1/management/organizations/{organization_id}/saml/providers/{provider_id} GET /api/v1/management/organizations/{organization_id}/saml/providers/{provider_id}
ManagementApi get_api_v1_management_organizations_organization_id_saml_providers_provider_id_certificates GET /api/v1/management/organizations/{organization_id}/saml/providers/{provider_id}/certificates GET /api/v1/management/organizations/{organization_id}/saml/providers/{provider_id}/certificates
ManagementApi get_api_v1_management_sessions GET /api/v1/management/sessions GET /api/v1/management/sessions
ManagementApi post_api_v1_management_organizations_organization_id_applications_client_id_secrets POST /api/v1/management/organizations/{organization_id}/applications/{client_id}/secrets POST /api/v1/management/organizations/{organization_id}/applications/{client_id}/secrets
ManagementApi post_api_v1_management_organizations_organization_id_bulk_provisioning_dry_run POST /api/v1/management/organizations/{organization_id}/bulk-provisioning/dry-run POST /api/v1/management/organizations/{organization_id}/bulk-provisioning/dry-run
ManagementApi post_api_v1_management_organizations_organization_id_bulk_provisioning_jobs POST /api/v1/management/organizations/{organization_id}/bulk-provisioning/jobs POST /api/v1/management/organizations/{organization_id}/bulk-provisioning/jobs
ManagementApi post_api_v1_management_organizations_organization_id_bulk_provisioning_jobs_job_id_cancel POST /api/v1/management/organizations/{organization_id}/bulk-provisioning/jobs/{job_id}/cancel POST /api/v1/management/organizations/{organization_id}/bulk-provisioning/jobs/{job_id}/cancel
ManagementApi post_api_v1_management_organizations_organization_id_bulk_provisioning_jobs_job_id_execute POST /api/v1/management/organizations/{organization_id}/bulk-provisioning/jobs/{job_id}/execute POST /api/v1/management/organizations/{organization_id}/bulk-provisioning/jobs/{job_id}/execute
ManagementApi post_api_v1_management_organizations_organization_id_bulk_provisioning_jobs_job_id_roles POST /api/v1/management/organizations/{organization_id}/bulk-provisioning/jobs/{job_id}/roles POST /api/v1/management/organizations/{organization_id}/bulk-provisioning/jobs/{job_id}/roles
ManagementApi post_api_v1_management_organizations_organization_id_federation_providers POST /api/v1/management/organizations/{organization_id}/federation/providers POST /api/v1/management/organizations/{organization_id}/federation/providers
ManagementApi post_api_v1_management_organizations_organization_id_machines POST /api/v1/management/organizations/{organization_id}/machines POST /api/v1/management/organizations/{organization_id}/machines
ManagementApi post_api_v1_management_organizations_organization_id_machines_machine_identity_id_action POST /api/v1/management/organizations/{organization_id}/machines/{machine_identity_id}/{action} POST /api/v1/management/organizations/{organization_id}/machines/{machine_identity_id}/{action}
ManagementApi post_api_v1_management_organizations_organization_id_permissions POST /api/v1/management/organizations/{organization_id}/permissions POST /api/v1/management/organizations/{organization_id}/permissions
ManagementApi post_api_v1_management_organizations_organization_id_role_assignments_humans POST /api/v1/management/organizations/{organization_id}/role-assignments/humans POST /api/v1/management/organizations/{organization_id}/role-assignments/humans
ManagementApi post_api_v1_management_organizations_organization_id_role_assignments_machines POST /api/v1/management/organizations/{organization_id}/role-assignments/machines POST /api/v1/management/organizations/{organization_id}/role-assignments/machines
ManagementApi post_api_v1_management_organizations_organization_id_roles POST /api/v1/management/organizations/{organization_id}/roles POST /api/v1/management/organizations/{organization_id}/roles
ManagementApi post_api_v1_management_organizations_organization_id_roles_role_id_permissions POST /api/v1/management/organizations/{organization_id}/roles/{role_id}/permissions POST /api/v1/management/organizations/{organization_id}/roles/{role_id}/permissions
ManagementApi post_api_v1_management_organizations_organization_id_saml_providers POST /api/v1/management/organizations/{organization_id}/saml/providers POST /api/v1/management/organizations/{organization_id}/saml/providers
ManagementApi post_api_v1_management_organizations_organization_id_saml_providers_provider_id_certificates POST /api/v1/management/organizations/{organization_id}/saml/providers/{provider_id}/certificates POST /api/v1/management/organizations/{organization_id}/saml/providers/{provider_id}/certificates
ManagementApi post_api_v1_management_organizations_organization_id_saml_providers_provider_id_certificates_certificate_id_retire POST /api/v1/management/organizations/{organization_id}/saml/providers/{provider_id}/certificates/{certificate_id}/retire POST /api/v1/management/organizations/{organization_id}/saml/providers/{provider_id}/certificates/{certificate_id}/retire
ManagementApi post_api_v1_management_session_families_family_id_revoke POST /api/v1/management/session-families/{family_id}/revoke POST /api/v1/management/session-families/{family_id}/revoke
ManagementApi post_api_v1_management_sessions_revoke_all POST /api/v1/management/sessions/revoke-all POST /api/v1/management/sessions/revoke-all
ManagementApi post_api_v1_management_sessions_session_id_revoke POST /api/v1/management/sessions/{session_id}/revoke POST /api/v1/management/sessions/{session_id}/revoke
OauthApi get_oauth_authorize GET /oauth/authorize GET /oauth/authorize
OauthApi post_oauth_introspect POST /oauth/introspect POST /oauth/introspect
OauthApi post_oauth_revoke POST /oauth/revoke POST /oauth/revoke
OauthApi post_oauth_token POST /oauth/token POST /oauth/token
OidcApi get_oidc_jwks GET /oidc/jwks GET /oidc/jwks
OidcApi get_oidc_userinfo GET /oidc/userinfo GET /oidc/userinfo
ScimApi delete_scim_v2_groups_resource_id DELETE /scim/v2/Groups/{resource_id} DELETE /scim/v2/Groups/{resource_id}
ScimApi delete_scim_v2_users_resource_id DELETE /scim/v2/Users/{resource_id} DELETE /scim/v2/Users/{resource_id}
ScimApi get_scim_v2_groups GET /scim/v2/Groups GET /scim/v2/Groups
ScimApi get_scim_v2_groups_resource_id GET /scim/v2/Groups/{resource_id} GET /scim/v2/Groups/{resource_id}
ScimApi get_scim_v2_resourcetypes GET /scim/v2/ResourceTypes GET /scim/v2/ResourceTypes
ScimApi get_scim_v2_schemas GET /scim/v2/Schemas GET /scim/v2/Schemas
ScimApi get_scim_v2_serviceproviderconfig GET /scim/v2/ServiceProviderConfig GET /scim/v2/ServiceProviderConfig
ScimApi get_scim_v2_users GET /scim/v2/Users GET /scim/v2/Users
ScimApi get_scim_v2_users_resource_id GET /scim/v2/Users/{resource_id} GET /scim/v2/Users/{resource_id}
ScimApi patch_scim_v2_groups_resource_id PATCH /scim/v2/Groups/{resource_id} PATCH /scim/v2/Groups/{resource_id}
ScimApi patch_scim_v2_users_resource_id PATCH /scim/v2/Users/{resource_id} PATCH /scim/v2/Users/{resource_id}
ScimApi post_scim_v2_groups POST /scim/v2/Groups POST /scim/v2/Groups
ScimApi post_scim_v2_users POST /scim/v2/Users POST /scim/v2/Users
ScimApi put_scim_v2_groups_resource_id PUT /scim/v2/Groups/{resource_id} PUT /scim/v2/Groups/{resource_id}
ScimApi put_scim_v2_users_resource_id PUT /scim/v2/Users/{resource_id} PUT /scim/v2/Users/{resource_id}

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

ManagementSessionBearer

  • Type: Bearer authentication

SCIMMachineBearer

  • Type: Bearer authentication

OIDCAccessTokenBearer

  • Type: Bearer authentication (OAuth2 access token)

Author

Metadata

Release files for credoxa-auth-sdk 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for credoxa-auth-sdk 0.1.0
File Size Uploaded Provenance Actions
credoxa_auth_sdk-0.1.0.tar.gz 99.3 kB With provenance Details for credoxa_auth_sdk-0.1.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for credoxa-auth-sdk 0.1.0
File Interpreter ABI Platform Actions
credoxa_auth_sdk-0.1.0-py3-none-any.whl Python 3 none any Details for credoxa_auth_sdk-0.1.0-py3-none-any.whl

Total release size: 353.1 kB

Release files / credoxa_auth_sdk-0.1.0.tar.gz

Download URL credoxa_auth_sdk-0.1.0.tar.gz
Size 99.3 kB
Tags Source
SHA-256 checksum
How to use checksums
6341cda13b80115acf6337fc6518d2e71c9629866e6e6c71f4f5e6b77332abfe
BLAKE2b-256 checksum
How to use checksums
609e0bc8a0ce36a095abbc34dd2d2a557593fa3edac94e5cbf2f6c9de911bdf3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 10, 2026.

Transparency log

Release files / credoxa_auth_sdk-0.1.0-py3-none-any.whl

Download URL credoxa_auth_sdk-0.1.0-py3-none-any.whl
Size 253.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
55db292483dd1e26f8a436980460b5d8e33ed31757f6a4b0b9ee8877173784fd
BLAKE2b-256 checksum
How to use checksums
ce775d0be4d4da8a8ecbd57cc2d492af160b63eac32ce961a054298f1267cf75
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 10, 2026.

Transparency log

Security for credoxa-auth-sdk 0.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for credoxa_auth_sdk-0.1.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 10, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page