Metadata-Version: 2.4
Name: credoxa-auth-sdk
Version: 0.1.0
Summary: Credoxa Auth v2 API
Home-page: 
Author: Credoxa
Author-email: 
License-Expression: Apache-2.0
Keywords: OpenAPI,OpenAPI-Generator,Credoxa Auth v2 API
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: urllib3<3.0.0,>=2.1.0
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: pydantic>=2
Requires-Dist: typing-extensions>=4.7.1
Dynamic: license-file

# 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](https://openapi-generator.tech) 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:

```sh
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:
```python
import credoxa_auth
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import credoxa_auth
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

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**](docs/DiscoveryApi.md#get_well_known_openid_configuration) | **GET** /.well-known/openid-configuration | GET /.well-known/openid-configuration
*FederationApi* | [**get_federation_saml_providers_provider_id_metadata**](docs/FederationApi.md#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**](docs/FederationApi.md#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**](docs/FederationApi.md#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**](docs/FederationApi.md#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**](docs/FederationApi.md#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**](docs/InternalApi.md#get_health_live) | **GET** /health/live | GET /health/live
*InternalApi* | [**get_health_metrics**](docs/InternalApi.md#get_health_metrics) | **GET** /health/metrics | GET /health/metrics
*InternalApi* | [**get_health_ready**](docs/InternalApi.md#get_health_ready) | **GET** /health/ready | GET /health/ready
*ManagementApi* | [**delete_api_v1_management_organizations_organization_id_role_assignments_humans**](docs/ManagementApi.md#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**](docs/ManagementApi.md#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**](docs/ManagementApi.md#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**](docs/ManagementApi.md#get_api_v1_management_me) | **GET** /api/v1/management/me | GET /api/v1/management/me
*ManagementApi* | [**get_api_v1_management_organizations_organization_id**](docs/ManagementApi.md#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**](docs/ManagementApi.md#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**](docs/ManagementApi.md#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**](docs/ManagementApi.md#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**](docs/ManagementApi.md#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**](docs/ManagementApi.md#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**](docs/ManagementApi.md#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**](docs/ManagementApi.md#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**](docs/ManagementApi.md#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**](docs/ManagementApi.md#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**](docs/ManagementApi.md#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**](docs/ManagementApi.md#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**](docs/ManagementApi.md#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**](docs/ManagementApi.md#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**](docs/ManagementApi.md#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**](docs/ManagementApi.md#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**](docs/ManagementApi.md#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**](docs/ManagementApi.md#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**](docs/ManagementApi.md#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**](docs/ManagementApi.md#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**](docs/ManagementApi.md#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**](docs/ManagementApi.md#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**](docs/ManagementApi.md#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**](docs/ManagementApi.md#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**](docs/ManagementApi.md#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**](docs/ManagementApi.md#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**](docs/ManagementApi.md#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**](docs/ManagementApi.md#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**](docs/ManagementApi.md#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**](docs/ManagementApi.md#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**](docs/ManagementApi.md#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**](docs/ManagementApi.md#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**](docs/ManagementApi.md#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**](docs/ManagementApi.md#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**](docs/ManagementApi.md#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**](docs/ManagementApi.md#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**](docs/ManagementApi.md#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**](docs/OauthApi.md#get_oauth_authorize) | **GET** /oauth/authorize | GET /oauth/authorize
*OauthApi* | [**post_oauth_introspect**](docs/OauthApi.md#post_oauth_introspect) | **POST** /oauth/introspect | POST /oauth/introspect
*OauthApi* | [**post_oauth_revoke**](docs/OauthApi.md#post_oauth_revoke) | **POST** /oauth/revoke | POST /oauth/revoke
*OauthApi* | [**post_oauth_token**](docs/OauthApi.md#post_oauth_token) | **POST** /oauth/token | POST /oauth/token
*OidcApi* | [**get_oidc_jwks**](docs/OidcApi.md#get_oidc_jwks) | **GET** /oidc/jwks | GET /oidc/jwks
*OidcApi* | [**get_oidc_userinfo**](docs/OidcApi.md#get_oidc_userinfo) | **GET** /oidc/userinfo | GET /oidc/userinfo
*ScimApi* | [**delete_scim_v2_groups_resource_id**](docs/ScimApi.md#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**](docs/ScimApi.md#delete_scim_v2_users_resource_id) | **DELETE** /scim/v2/Users/{resource_id} | DELETE /scim/v2/Users/{resource_id}
*ScimApi* | [**get_scim_v2_groups**](docs/ScimApi.md#get_scim_v2_groups) | **GET** /scim/v2/Groups | GET /scim/v2/Groups
*ScimApi* | [**get_scim_v2_groups_resource_id**](docs/ScimApi.md#get_scim_v2_groups_resource_id) | **GET** /scim/v2/Groups/{resource_id} | GET /scim/v2/Groups/{resource_id}
*ScimApi* | [**get_scim_v2_resourcetypes**](docs/ScimApi.md#get_scim_v2_resourcetypes) | **GET** /scim/v2/ResourceTypes | GET /scim/v2/ResourceTypes
*ScimApi* | [**get_scim_v2_schemas**](docs/ScimApi.md#get_scim_v2_schemas) | **GET** /scim/v2/Schemas | GET /scim/v2/Schemas
*ScimApi* | [**get_scim_v2_serviceproviderconfig**](docs/ScimApi.md#get_scim_v2_serviceproviderconfig) | **GET** /scim/v2/ServiceProviderConfig | GET /scim/v2/ServiceProviderConfig
*ScimApi* | [**get_scim_v2_users**](docs/ScimApi.md#get_scim_v2_users) | **GET** /scim/v2/Users | GET /scim/v2/Users
*ScimApi* | [**get_scim_v2_users_resource_id**](docs/ScimApi.md#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**](docs/ScimApi.md#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**](docs/ScimApi.md#patch_scim_v2_users_resource_id) | **PATCH** /scim/v2/Users/{resource_id} | PATCH /scim/v2/Users/{resource_id}
*ScimApi* | [**post_scim_v2_groups**](docs/ScimApi.md#post_scim_v2_groups) | **POST** /scim/v2/Groups | POST /scim/v2/Groups
*ScimApi* | [**post_scim_v2_users**](docs/ScimApi.md#post_scim_v2_users) | **POST** /scim/v2/Users | POST /scim/v2/Users
*ScimApi* | [**put_scim_v2_groups_resource_id**](docs/ScimApi.md#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**](docs/ScimApi.md#put_scim_v2_users_resource_id) | **PUT** /scim/v2/Users/{resource_id} | PUT /scim/v2/Users/{resource_id}


## Documentation For Models

 - [BulkDryRunIssuePayload](docs/BulkDryRunIssuePayload.md)
 - [BulkDryRunRowPayload](docs/BulkDryRunRowPayload.md)
 - [BulkDryRunRowPayloadCanonical](docs/BulkDryRunRowPayloadCanonical.md)
 - [BulkProvisioningJobDetailPayload](docs/BulkProvisioningJobDetailPayload.md)
 - [BulkProvisioningJobPayload](docs/BulkProvisioningJobPayload.md)
 - [BulkProvisioningRowResultPayload](docs/BulkProvisioningRowResultPayload.md)
 - [BulkProvisioningTransportRequest](docs/BulkProvisioningTransportRequest.md)
 - [BulkProvisioningTransportRequestOneOf](docs/BulkProvisioningTransportRequestOneOf.md)
 - [BulkProvisioningTransportRequestOneOf1](docs/BulkProvisioningTransportRequestOneOf1.md)
 - [BulkProvisioningTransportRequestOneOf2](docs/BulkProvisioningTransportRequestOneOf2.md)
 - [DeleteApiV1ManagementOrganizationsOrganizationIdRoleAssignmentsHumans400Response](docs/DeleteApiV1ManagementOrganizationsOrganizationIdRoleAssignmentsHumans400Response.md)
 - [DeleteApiV1ManagementOrganizationsOrganizationIdRoleAssignmentsHumans400ResponseError](docs/DeleteApiV1ManagementOrganizationsOrganizationIdRoleAssignmentsHumans400ResponseError.md)
 - [DeleteApiV1ManagementOrganizationsOrganizationIdRoleAssignmentsHumans400ResponseErrorDetails](docs/DeleteApiV1ManagementOrganizationsOrganizationIdRoleAssignmentsHumans400ResponseErrorDetails.md)
 - [DeleteApiV1ManagementOrganizationsOrganizationIdRoleAssignmentsMachines400Response](docs/DeleteApiV1ManagementOrganizationsOrganizationIdRoleAssignmentsMachines400Response.md)
 - [DeleteApiV1ManagementOrganizationsOrganizationIdRoleAssignmentsMachines400ResponseError](docs/DeleteApiV1ManagementOrganizationsOrganizationIdRoleAssignmentsMachines400ResponseError.md)
 - [DeleteApiV1ManagementOrganizationsOrganizationIdRoleAssignmentsMachines400ResponseErrorDetails](docs/DeleteApiV1ManagementOrganizationsOrganizationIdRoleAssignmentsMachines400ResponseErrorDetails.md)
 - [DeleteApiV1ManagementOrganizationsOrganizationIdRolesRoleIdPermissions400Response](docs/DeleteApiV1ManagementOrganizationsOrganizationIdRolesRoleIdPermissions400Response.md)
 - [DeleteApiV1ManagementOrganizationsOrganizationIdRolesRoleIdPermissions400ResponseError](docs/DeleteApiV1ManagementOrganizationsOrganizationIdRolesRoleIdPermissions400ResponseError.md)
 - [DeleteApiV1ManagementOrganizationsOrganizationIdRolesRoleIdPermissions400ResponseErrorDetails](docs/DeleteApiV1ManagementOrganizationsOrganizationIdRolesRoleIdPermissions400ResponseErrorDetails.md)
 - [DryRunPayload](docs/DryRunPayload.md)
 - [FederationProviderPayload](docs/FederationProviderPayload.md)
 - [GetApiV1ManagementMe200Response](docs/GetApiV1ManagementMe200Response.md)
 - [GetApiV1ManagementOrganizationsOrganizationIdAccess200Response](docs/GetApiV1ManagementOrganizationsOrganizationIdAccess200Response.md)
 - [GetApiV1ManagementOrganizationsOrganizationIdApplications200Response](docs/GetApiV1ManagementOrganizationsOrganizationIdApplications200Response.md)
 - [GetApiV1ManagementOrganizationsOrganizationIdBulkProvisioningJobs200Response](docs/GetApiV1ManagementOrganizationsOrganizationIdBulkProvisioningJobs200Response.md)
 - [GetApiV1ManagementOrganizationsOrganizationIdFederationProviders200Response](docs/GetApiV1ManagementOrganizationsOrganizationIdFederationProviders200Response.md)
 - [GetApiV1ManagementOrganizationsOrganizationIdIdentities200Response](docs/GetApiV1ManagementOrganizationsOrganizationIdIdentities200Response.md)
 - [GetApiV1ManagementOrganizationsOrganizationIdInvitations200Response](docs/GetApiV1ManagementOrganizationsOrganizationIdInvitations200Response.md)
 - [GetApiV1ManagementOrganizationsOrganizationIdMachines200Response](docs/GetApiV1ManagementOrganizationsOrganizationIdMachines200Response.md)
 - [GetApiV1ManagementOrganizationsOrganizationIdMemberships200Response](docs/GetApiV1ManagementOrganizationsOrganizationIdMemberships200Response.md)
 - [GetApiV1ManagementOrganizationsOrganizationIdPermissions200Response](docs/GetApiV1ManagementOrganizationsOrganizationIdPermissions200Response.md)
 - [GetApiV1ManagementOrganizationsOrganizationIdRoles200Response](docs/GetApiV1ManagementOrganizationsOrganizationIdRoles200Response.md)
 - [GetApiV1ManagementOrganizationsOrganizationIdSamlProviders200Response](docs/GetApiV1ManagementOrganizationsOrganizationIdSamlProviders200Response.md)
 - [GetApiV1ManagementOrganizationsOrganizationIdSamlProvidersProviderIdCertificates200Response](docs/GetApiV1ManagementOrganizationsOrganizationIdSamlProvidersProviderIdCertificates200Response.md)
 - [GetApiV1ManagementSessions200Response](docs/GetApiV1ManagementSessions200Response.md)
 - [GetHealthLive200Response](docs/GetHealthLive200Response.md)
 - [GetHealthMetrics200Response](docs/GetHealthMetrics200Response.md)
 - [GetHealthReady200Response](docs/GetHealthReady200Response.md)
 - [GetOauthAuthorize400Response](docs/GetOauthAuthorize400Response.md)
 - [GetOidcJwks200Response](docs/GetOidcJwks200Response.md)
 - [GetOidcUserinfo200Response](docs/GetOidcUserinfo200Response.md)
 - [GetWellKnownOpenidConfiguration200Response](docs/GetWellKnownOpenidConfiguration200Response.md)
 - [MachinePayload](docs/MachinePayload.md)
 - [ManagementDRFErrorEnvelope](docs/ManagementDRFErrorEnvelope.md)
 - [ManagementDRFErrorEnvelopeError](docs/ManagementDRFErrorEnvelopeError.md)
 - [ManagementHumansRoleAssignmentPayload](docs/ManagementHumansRoleAssignmentPayload.md)
 - [ManagementMachinesRoleAssignmentPayload](docs/ManagementMachinesRoleAssignmentPayload.md)
 - [MembershipPayload](docs/MembershipPayload.md)
 - [OauthClientPayload](docs/OauthClientPayload.md)
 - [OrganizationPayload](docs/OrganizationPayload.md)
 - [PermissionPayload](docs/PermissionPayload.md)
 - [PostApiV1ManagementOrganizationsOrganizationIdApplicationsClientIdSecrets201Response](docs/PostApiV1ManagementOrganizationsOrganizationIdApplicationsClientIdSecrets201Response.md)
 - [PostApiV1ManagementOrganizationsOrganizationIdBulkProvisioningJobs400Response](docs/PostApiV1ManagementOrganizationsOrganizationIdBulkProvisioningJobs400Response.md)
 - [PostApiV1ManagementOrganizationsOrganizationIdBulkProvisioningJobsJobIdExecute200Response](docs/PostApiV1ManagementOrganizationsOrganizationIdBulkProvisioningJobsJobIdExecute200Response.md)
 - [PostApiV1ManagementOrganizationsOrganizationIdBulkProvisioningJobsJobIdExecute200ResponseSummary](docs/PostApiV1ManagementOrganizationsOrganizationIdBulkProvisioningJobsJobIdExecute200ResponseSummary.md)
 - [PostApiV1ManagementOrganizationsOrganizationIdBulkProvisioningJobsJobIdRoles200Response](docs/PostApiV1ManagementOrganizationsOrganizationIdBulkProvisioningJobsJobIdRoles200Response.md)
 - [PostApiV1ManagementOrganizationsOrganizationIdBulkProvisioningJobsJobIdRolesRequest](docs/PostApiV1ManagementOrganizationsOrganizationIdBulkProvisioningJobsJobIdRolesRequest.md)
 - [PostApiV1ManagementOrganizationsOrganizationIdBulkProvisioningJobsRequest](docs/PostApiV1ManagementOrganizationsOrganizationIdBulkProvisioningJobsRequest.md)
 - [PostApiV1ManagementOrganizationsOrganizationIdFederationProvidersRequest](docs/PostApiV1ManagementOrganizationsOrganizationIdFederationProvidersRequest.md)
 - [PostApiV1ManagementOrganizationsOrganizationIdMachines400Response](docs/PostApiV1ManagementOrganizationsOrganizationIdMachines400Response.md)
 - [PostApiV1ManagementOrganizationsOrganizationIdMachines400ResponseError](docs/PostApiV1ManagementOrganizationsOrganizationIdMachines400ResponseError.md)
 - [PostApiV1ManagementOrganizationsOrganizationIdMachines400ResponseErrorDetails](docs/PostApiV1ManagementOrganizationsOrganizationIdMachines400ResponseErrorDetails.md)
 - [PostApiV1ManagementOrganizationsOrganizationIdMachinesRequest](docs/PostApiV1ManagementOrganizationsOrganizationIdMachinesRequest.md)
 - [PostApiV1ManagementOrganizationsOrganizationIdPermissions400Response](docs/PostApiV1ManagementOrganizationsOrganizationIdPermissions400Response.md)
 - [PostApiV1ManagementOrganizationsOrganizationIdPermissions400ResponseError](docs/PostApiV1ManagementOrganizationsOrganizationIdPermissions400ResponseError.md)
 - [PostApiV1ManagementOrganizationsOrganizationIdPermissions400ResponseErrorDetails](docs/PostApiV1ManagementOrganizationsOrganizationIdPermissions400ResponseErrorDetails.md)
 - [PostApiV1ManagementOrganizationsOrganizationIdPermissionsRequest](docs/PostApiV1ManagementOrganizationsOrganizationIdPermissionsRequest.md)
 - [PostApiV1ManagementOrganizationsOrganizationIdRoleAssignmentsHumans400Response](docs/PostApiV1ManagementOrganizationsOrganizationIdRoleAssignmentsHumans400Response.md)
 - [PostApiV1ManagementOrganizationsOrganizationIdRoleAssignmentsHumans400ResponseError](docs/PostApiV1ManagementOrganizationsOrganizationIdRoleAssignmentsHumans400ResponseError.md)
 - [PostApiV1ManagementOrganizationsOrganizationIdRoleAssignmentsHumans400ResponseErrorDetails](docs/PostApiV1ManagementOrganizationsOrganizationIdRoleAssignmentsHumans400ResponseErrorDetails.md)
 - [PostApiV1ManagementOrganizationsOrganizationIdRoleAssignmentsHumansRequest](docs/PostApiV1ManagementOrganizationsOrganizationIdRoleAssignmentsHumansRequest.md)
 - [PostApiV1ManagementOrganizationsOrganizationIdRoleAssignmentsMachines400Response](docs/PostApiV1ManagementOrganizationsOrganizationIdRoleAssignmentsMachines400Response.md)
 - [PostApiV1ManagementOrganizationsOrganizationIdRoleAssignmentsMachines400ResponseError](docs/PostApiV1ManagementOrganizationsOrganizationIdRoleAssignmentsMachines400ResponseError.md)
 - [PostApiV1ManagementOrganizationsOrganizationIdRoleAssignmentsMachines400ResponseErrorDetails](docs/PostApiV1ManagementOrganizationsOrganizationIdRoleAssignmentsMachines400ResponseErrorDetails.md)
 - [PostApiV1ManagementOrganizationsOrganizationIdRoleAssignmentsMachinesRequest](docs/PostApiV1ManagementOrganizationsOrganizationIdRoleAssignmentsMachinesRequest.md)
 - [PostApiV1ManagementOrganizationsOrganizationIdRoles400Response](docs/PostApiV1ManagementOrganizationsOrganizationIdRoles400Response.md)
 - [PostApiV1ManagementOrganizationsOrganizationIdRoles400ResponseError](docs/PostApiV1ManagementOrganizationsOrganizationIdRoles400ResponseError.md)
 - [PostApiV1ManagementOrganizationsOrganizationIdRoles400ResponseErrorDetails](docs/PostApiV1ManagementOrganizationsOrganizationIdRoles400ResponseErrorDetails.md)
 - [PostApiV1ManagementOrganizationsOrganizationIdRolesRequest](docs/PostApiV1ManagementOrganizationsOrganizationIdRolesRequest.md)
 - [PostApiV1ManagementOrganizationsOrganizationIdRolesRoleIdPermissions400Response](docs/PostApiV1ManagementOrganizationsOrganizationIdRolesRoleIdPermissions400Response.md)
 - [PostApiV1ManagementOrganizationsOrganizationIdRolesRoleIdPermissions400ResponseError](docs/PostApiV1ManagementOrganizationsOrganizationIdRolesRoleIdPermissions400ResponseError.md)
 - [PostApiV1ManagementOrganizationsOrganizationIdRolesRoleIdPermissions400ResponseErrorDetails](docs/PostApiV1ManagementOrganizationsOrganizationIdRolesRoleIdPermissions400ResponseErrorDetails.md)
 - [PostApiV1ManagementOrganizationsOrganizationIdRolesRoleIdPermissionsRequest](docs/PostApiV1ManagementOrganizationsOrganizationIdRolesRoleIdPermissionsRequest.md)
 - [PostApiV1ManagementOrganizationsOrganizationIdSamlProvidersProviderIdCertificatesRequest](docs/PostApiV1ManagementOrganizationsOrganizationIdSamlProvidersProviderIdCertificatesRequest.md)
 - [PostApiV1ManagementOrganizationsOrganizationIdSamlProvidersRequest](docs/PostApiV1ManagementOrganizationsOrganizationIdSamlProvidersRequest.md)
 - [PostApiV1ManagementSessionFamiliesFamilyIdRevoke404Response](docs/PostApiV1ManagementSessionFamiliesFamilyIdRevoke404Response.md)
 - [PostApiV1ManagementSessionsRevokeAll200Response](docs/PostApiV1ManagementSessionsRevokeAll200Response.md)
 - [PostFederationProvidersProviderIdBegin200Response](docs/PostFederationProvidersProviderIdBegin200Response.md)
 - [PostFederationProvidersProviderIdBegin400Response](docs/PostFederationProvidersProviderIdBegin400Response.md)
 - [PostFederationProvidersProviderIdBegin404Response](docs/PostFederationProvidersProviderIdBegin404Response.md)
 - [PostFederationProvidersProviderIdBegin404ResponseError](docs/PostFederationProvidersProviderIdBegin404ResponseError.md)
 - [PostFederationProvidersProviderIdBeginRequest](docs/PostFederationProvidersProviderIdBeginRequest.md)
 - [PostFederationProvidersProviderIdCallback200Response](docs/PostFederationProvidersProviderIdCallback200Response.md)
 - [PostFederationProvidersProviderIdCallback400Response](docs/PostFederationProvidersProviderIdCallback400Response.md)
 - [PostFederationProvidersProviderIdCallback404Response](docs/PostFederationProvidersProviderIdCallback404Response.md)
 - [PostFederationProvidersProviderIdCallback404ResponseError](docs/PostFederationProvidersProviderIdCallback404ResponseError.md)
 - [PostFederationProvidersProviderIdCallbackRequest](docs/PostFederationProvidersProviderIdCallbackRequest.md)
 - [PostFederationSamlProvidersProviderIdBegin200Response](docs/PostFederationSamlProvidersProviderIdBegin200Response.md)
 - [PostFederationSamlProvidersProviderIdBeginRequest](docs/PostFederationSamlProvidersProviderIdBeginRequest.md)
 - [PostOauthIntrospect200Response](docs/PostOauthIntrospect200Response.md)
 - [PostOauthIntrospect400Response](docs/PostOauthIntrospect400Response.md)
 - [PostOauthToken200Response](docs/PostOauthToken200Response.md)
 - [RolePayload](docs/RolePayload.md)
 - [SCIMDiscoveryList](docs/SCIMDiscoveryList.md)
 - [SCIMDiscoveryObject](docs/SCIMDiscoveryObject.md)
 - [SCIMError](docs/SCIMError.md)
 - [SCIMGroup](docs/SCIMGroup.md)
 - [SCIMGroupList](docs/SCIMGroupList.md)
 - [SCIMGroupMember](docs/SCIMGroupMember.md)
 - [SCIMGroupWrite](docs/SCIMGroupWrite.md)
 - [SCIMMeta](docs/SCIMMeta.md)
 - [SCIMPatchOperation](docs/SCIMPatchOperation.md)
 - [SCIMPatchRequest](docs/SCIMPatchRequest.md)
 - [SCIMUser](docs/SCIMUser.md)
 - [SCIMUserList](docs/SCIMUserList.md)
 - [SCIMUserWrite](docs/SCIMUserWrite.md)
 - [SamlCertificatePayload](docs/SamlCertificatePayload.md)
 - [SamlProviderPayload](docs/SamlProviderPayload.md)
 - [SessionPayload](docs/SessionPayload.md)
 - [UserPayload](docs/UserPayload.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="ManagementSessionBearer"></a>
### ManagementSessionBearer

- **Type**: Bearer authentication

<a id="SCIMMachineBearer"></a>
### SCIMMachineBearer

- **Type**: Bearer authentication

<a id="OIDCAccessTokenBearer"></a>
### OIDCAccessTokenBearer

- **Type**: Bearer authentication (OAuth2 access token)


## Author
