Skip to content

reference.md

Latest commit

 

History

History
1901 lines (1340 loc) · 24.8 KB

reference.md

File metadata and controls

1901 lines (1340 loc) · 24.8 KB

Reference

OrganizationDetails

client.organization_details.get() -> AsyncHttpResponse[GetOrganizationDetailsResponseContent]

📝 Description

Retrieve details for an Organization.

🔌 Usage

from auth0 import Auth0

client = Auth0(
    token="YOUR_TOKEN",
)
client.organization_details.get()

⚙️ Parameters

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.organization_details.update(...) -> AsyncHttpResponse[UpdateOrganizationDetailsResponseContent]

📝 Description

Update the details of a specific Organization, such as display name and branding options.

🔌 Usage

from auth0 import Auth0, OrgBranding, OrgBrandingColors

client = Auth0(
    token="YOUR_TOKEN",
)
client.organization_details.update(
    name="testorg",
    display_name="Test Organization",
    branding=OrgBranding(
        logo_url="https://example.com/logo.png",
        colors=OrgBrandingColors(
            primary="#000000",
            page_background="#FFFFFF",
        ),
    ),
)

⚙️ Parameters

id: typing.Optional[OrgId]

name: typing.Optional[str] — The name of this organization.

display_name: typing.Optional[str] — Friendly name of this organization.

branding: typing.Optional[OrgBranding]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Organization Configuration

client.organization.configuration.get() -> AsyncHttpResponse[GetConfigurationResponseContent]

📝 Description

Retrieve the configuration for the /my-org API. This will return all stored client information with the exception of attributes that are identifiers. Identifier attributes will be given their own endpoint that will return the full object. This will give the components all of the information they will need to be successful. The SDK provider for the components should manage fetching and caching this information for all components.

🔌 Usage

from auth0 import Auth0

client = Auth0(
    token="YOUR_TOKEN",
)
client.organization.configuration.get()

⚙️ Parameters

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Organization Domains

client.organization.domains.list() -> AsyncHttpResponse[ListOrganizationDomainsResponseContent]

📝 Description

Lists all domains pending and verified for an organization.

🔌 Usage

from auth0 import Auth0

client = Auth0(
    token="YOUR_TOKEN",
)
client.organization.domains.list()

⚙️ Parameters

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.organization.domains.create(...) -> AsyncHttpResponse[CreateOrganizationDomainResponseContent]

📝 Description

Create a new domain for an organization.

🔌 Usage

from auth0 import Auth0

client = Auth0(
    token="YOUR_TOKEN",
)
client.organization.domains.create(
    domain="acme.com",
)

⚙️ Parameters

domain: OrgDomainName

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.organization.domains.get(...) -> AsyncHttpResponse[GetOrganizationDomainResponseContent]

📝 Description

Retrieve a domain for an organization.

🔌 Usage

from auth0 import Auth0

client = Auth0(
    token="YOUR_TOKEN",
)
client.organization.domains.get(
    domain_id="domain_id",
)

⚙️ Parameters

domain_id: OrgDomainId

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.organization.domains.delete(...) -> AsyncHttpResponse[None]

📝 Description

Remove a domain from this organization.

🔌 Usage

from auth0 import Auth0

client = Auth0(
    token="YOUR_TOKEN",
)
client.organization.domains.delete(
    domain_id="domain_id",
)

⚙️ Parameters

domain_id: OrgDomainId

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Organization IdentityProviders

client.organization.identity_providers.list() -> AsyncHttpResponse[ListIdentityProvidersResponseContent]

📝 Description

List the identity providers associated with this organization.

🔌 Usage

from auth0 import Auth0

client = Auth0(
    token="YOUR_TOKEN",
)
client.organization.identity_providers.list()

⚙️ Parameters

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.organization.identity_providers.create(...) -> AsyncHttpResponse[CreateIdentityProviderResponseContent]

📝 Description

Create an identity provider associated with this organization.

🔌 Usage

from auth0 import Auth0, IdpOidcOptionsRequest, IdpOidcRequest

client = Auth0(
    token="YOUR_TOKEN",
)
client.organization.identity_providers.create(
    request=IdpOidcRequest(
        name="oidcIdp",
        strategy="oidc",
        domains=["mydomain.com"],
        display_name="OIDC IdP",
        show_as_button=True,
        assign_membership_on_login=False,
        is_enabled=True,
        options=IdpOidcOptionsRequest(
            type="front_channel",
            client_id="a8f3b2e7-5d1c-4f9a-8b0d-2e1c3a5b6f7d",
            client_secret="KzQp2sVxR8nTgMjFhYcEWuLoIbDvUoC6A9B1zX7yWqFjHkGrP5sQdLmNp",
            discovery_url="https://{yourDomain}/.well-known/openid-configuration",
        ),
    ),
)

⚙️ Parameters

request: CreateIdentityProviderRequestContent

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.organization.identity_providers.get(...) -> AsyncHttpResponse[GetIdentityProviderResponseContent]

📝 Description

Retrieve the details for one particular identity-provider.

🔌 Usage

from auth0 import Auth0

client = Auth0(
    token="YOUR_TOKEN",
)
client.organization.identity_providers.get(
    idp_id="idp_id",
)

⚙️ Parameters

idp_id: IdpId

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.organization.identity_providers.delete(...) -> AsyncHttpResponse[None]

📝 Description

Delete an identity provider from this organization.

🔌 Usage

from auth0 import Auth0

client = Auth0(
    token="YOUR_TOKEN",
)
client.organization.identity_providers.delete(
    idp_id="idp_id",
)

⚙️ Parameters

idp_id: IdpId

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.organization.identity_providers.update(...) -> AsyncHttpResponse[UpdateIdentityProviderResponseContent]

📝 Description

Update an identity provider associated with this organization.

🔌 Usage

from auth0 import Auth0, IdpOidcOptionsRequest, IdpOidcUpdateRequest

client = Auth0(
    token="YOUR_TOKEN",
)
client.organization.identity_providers.update(
    idp_id="idp_id",
    request=IdpOidcUpdateRequest(
        display_name="OIDC IdP",
        show_as_button=True,
        assign_membership_on_login=False,
        is_enabled=True,
        options=IdpOidcOptionsRequest(
            type="front_channel",
            client_id="a8f3b2e7-5d1c-4f9a-8b0d-2e1c3a5b6f7d",
            client_secret="KzQp2sVxR8nTgMjFhYcEWuLoIbDvUoC6A9B1zX7yWqFjHkGrP5sQdLmNp",
            discovery_url="https://{yourDomain}/.well-known/openid-configuration",
        ),
    ),
)

⚙️ Parameters

idp_id: IdpId

request: UpdateIdentityProviderRequestContent

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.organization.identity_providers.update_attributes(...) -> AsyncHttpResponse[GetIdentityProviderResponseContent]

📝 Description

Triggers a refresh of attribute mappings on the identity provider by overriding it with the admin defined defaults. The endpoint doesn't accept any body parameters.

🔌 Usage

from auth0 import Auth0

client = Auth0(
    token="YOUR_TOKEN",
)
client.organization.identity_providers.update_attributes(
    idp_id="idp_id",
    request={"key": "value"},
)

⚙️ Parameters

idp_id: IdpId

request: typing.Dict[str, typing.Any]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.organization.identity_providers.detach(...) -> AsyncHttpResponse[None]

📝 Description

Delete underlying identity provider from this organization.

🔌 Usage

from auth0 import Auth0

client = Auth0(
    token="YOUR_TOKEN",
)
client.organization.identity_providers.detach(
    idp_id="idp_id",
)

⚙️ Parameters

idp_id: IdpId

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Organization Configuration IdentityProviders

client.organization.configuration.identity_providers.get() -> AsyncHttpResponse[GetIdpConfigurationResponseContent]

📝 Description

Retrieve the connection profile for the application. This will give the components all of the information they will need to be successful. The SDK provider for the components should manage fetching and caching this information for all components.

🔌 Usage

from auth0 import Auth0

client = Auth0(
    token="YOUR_TOKEN",
)
client.organization.configuration.identity_providers.get()

⚙️ Parameters

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Organization Domains Verify

client.organization.domains.verify.create(...) -> AsyncHttpResponse[StartOrganizationDomainVerificationResponseContent]

📝 Description

Get a verification text and start the domain verification process for a particular domain.

🔌 Usage

from auth0 import Auth0

client = Auth0(
    token="YOUR_TOKEN",
)
client.organization.domains.verify.create(
    domain_id="domain_id",
)

⚙️ Parameters

domain_id: OrgDomainId

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Organization Domains IdentityProviders

client.organization.domains.identity_providers.get(...) -> AsyncHttpResponse[ListDomainIdentityProvidersResponseContent]

📝 Description

Retrieve the list of identity providers that have a specific organization domain alias.

🔌 Usage

from auth0 import Auth0

client = Auth0(
    token="YOUR_TOKEN",
)
client.organization.domains.identity_providers.get(
    domain_id="domain_id",
)

⚙️ Parameters

domain_id: OrgDomainId

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Organization IdentityProviders Domains

client.organization.identity_providers.domains.create(...) -> AsyncHttpResponse[CreateIdpDomainResponseContent]

📝 Description

Add a domain to the identity provider's list of domains for Home Realm Discovery (HRD). The domain passed must be claimed and verified by this organization.

🔌 Usage

from auth0 import Auth0

client = Auth0(
    token="YOUR_TOKEN",
)
client.organization.identity_providers.domains.create(
    idp_id="idp_id",
    domain="my-domain.com",
)

⚙️ Parameters

idp_id: IdpId

domain: OrgDomainName

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.organization.identity_providers.domains.delete(...) -> AsyncHttpResponse[None]

📝 Description

Remove a domain from an identity provider.

🔌 Usage

from auth0 import Auth0

client = Auth0(
    token="YOUR_TOKEN",
)
client.organization.identity_providers.domains.delete(
    idp_id="idp_id",
    domain="domain",
)

⚙️ Parameters

idp_id: IdpId

domain: OrgDomainName

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Organization IdentityProviders Provisioning

client.organization.identity_providers.provisioning.get(...) -> AsyncHttpResponse[GetIdPProvisioningConfigResponseContent]

📝 Description

Retrieve the Provisioning configuration for this identity provider.

🔌 Usage

from auth0 import Auth0

client = Auth0(
    token="YOUR_TOKEN",
)
client.organization.identity_providers.provisioning.get(
    idp_id="idp_id",
)

⚙️ Parameters

idp_id: IdpId

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.organization.identity_providers.provisioning.create(...) -> AsyncHttpResponse[CreateIdPProvisioningConfigResponseContent]

📝 Description

Create the Provisioning configuration for this identity provider.

🔌 Usage

from auth0 import Auth0

client = Auth0(
    token="YOUR_TOKEN",
)
client.organization.identity_providers.provisioning.create(
    idp_id="idp_id",
)

⚙️ Parameters

idp_id: IdpId

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.organization.identity_providers.provisioning.delete(...) -> AsyncHttpResponse[None]

📝 Description

Delete the Provisioning configuration for an identity provider.

🔌 Usage

from auth0 import Auth0

client = Auth0(
    token="YOUR_TOKEN",
)
client.organization.identity_providers.provisioning.delete(
    idp_id="idp_id",
)

⚙️ Parameters

idp_id: IdpId

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.organization.identity_providers.provisioning.update_attributes(...) -> AsyncHttpResponse[GetIdPProvisioningConfigResponseContent]

📝 Description

Triggers a refresh of attribute mappings on the provisioning configuration by overriding it with the admin defined defaults. The endpoint doesn't accept any body parameters.

🔌 Usage

from auth0 import Auth0

client = Auth0(
    token="YOUR_TOKEN",
)
client.organization.identity_providers.provisioning.update_attributes(
    idp_id="idp_id",
    request={"key": "value"},
)

⚙️ Parameters

idp_id: IdpId

request: typing.Dict[str, typing.Any]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Organization IdentityProviders Provisioning ScimTokens

client.organization.identity_providers.provisioning.scim_tokens.list(...) -> AsyncHttpResponse[ListIdpProvisioningScimTokensResponseContent]

📝 Description

List the Provisioning SCIM tokens for this identity provider.

🔌 Usage

from auth0 import Auth0

client = Auth0(
    token="YOUR_TOKEN",
)
client.organization.identity_providers.provisioning.scim_tokens.list(
    idp_id="idp_id",
)

⚙️ Parameters

idp_id: IdpId

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.organization.identity_providers.provisioning.scim_tokens.create(...) -> AsyncHttpResponse[CreateIdpProvisioningScimTokenResponseContent]

📝 Description

Create a Provisioning SCIM token for this identity provider.

🔌 Usage

from auth0 import Auth0

client = Auth0(
    token="YOUR_TOKEN",
)
client.organization.identity_providers.provisioning.scim_tokens.create(
    idp_id="idp_id",
    token_lifetime=86400,
)

⚙️ Parameters

idp_id: IdpId

token_lifetime: typing.Optional[int] — Lifetime of the token in seconds. Do not set for non-expiring tokens.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.organization.identity_providers.provisioning.scim_tokens.delete(...) -> AsyncHttpResponse[None]

📝 Description

Delete a Provisioning SCIM configuration for an identity provider.

🔌 Usage

from auth0 import Auth0

client = Auth0(
    token="YOUR_TOKEN",
)
client.organization.identity_providers.provisioning.scim_tokens.delete(
    idp_id="idp_id",
    idp_scim_token_id="idp_scim_token_id",
)

⚙️ Parameters

idp_id: IdpId

idp_scim_token_id: IdpProvisioningScimTokenId

request_options: typing.Optional[RequestOptions] — Request-specific configuration.