Skip to content

Latest commit

 

History

History
2991 lines (2102 loc) · 42.7 KB

File metadata and controls

2991 lines (2102 loc) · 42.7 KB

Reference

OrganizationDetails

client.organization_details.get() -> GetOrganizationDetailsResponseContent

📝 Description

Retrieve details for this Organization, including display name and branding options. To learn more about Auth0 Organizations, read Organizations.

🔌 Usage

from auth0.myorganization import Auth0
from auth0.myorganization.environment import Auth0Environment

client = Auth0(
    token="<token>",
    environment=Auth0Environment.DEFAULT,
)

client.organization_details.get()

⚙️ Parameters

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

client.organization_details.update(...) -> UpdateOrganizationDetailsResponseContent

📝 Description

Update details for this Organization, such as display name and branding options. To learn more about Auth0 Organizations, read Organizations.

🔌 Usage

from auth0.myorganization import Auth0, OrgBranding, OrgBrandingColors
from auth0.myorganization.environment import Auth0Environment

client = Auth0(
    token="<token>",
    environment=Auth0Environment.DEFAULT,
)

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

request: UpdateOrganizationDetailsRequestContent

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

Organization Configuration

client.organization.configuration.get() -> GetConfigurationResponseContent

📝 Description

Retrieve the My Organization API configuration. Returns only the connection_deletion_behavior and allowed_strategies. Identifier attributes such as user_attribute_profile_id and connection_profile_id are not included. Cache this information, as it does not change frequently.

🔌 Usage

from auth0.myorganization import Auth0
from auth0.myorganization.environment import Auth0Environment

client = Auth0(
    token="<token>",
    environment=Auth0Environment.DEFAULT,
)

client.organization.configuration.get()

⚙️ Parameters

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

Organization Domains

client.organization.domains.list(...) -> ListOrganizationDomainsResponseContent

📝 Description

Retrieve a list of all pending and verified domains for this Organization.

🔌 Usage

from auth0.myorganization import Auth0
from auth0.myorganization.environment import Auth0Environment

client = Auth0(
    token="<token>",
    environment=Auth0Environment.DEFAULT,
)

client.organization.domains.list(
    from_="from",
    take=1,
)

⚙️ Parameters

from: typing.Optional[str] — An optional cursor from which to start the selection (exclusive).

take: typing.Optional[int] — Number of results per page. Defaults to 50.

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

client.organization.domains.create(...) -> CreateOrganizationDomainResponseContent

📝 Description

Create a new domain for this Organization.

🔌 Usage

from auth0.myorganization import Auth0
from auth0.myorganization.environment import Auth0Environment

client = Auth0(
    token="<token>",
    environment=Auth0Environment.DEFAULT,
)

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

⚙️ Parameters

domain: OrgDomainName

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

client.organization.domains.get(...) -> GetOrganizationDomainResponseContent

📝 Description

Retrieve details of a domain specified by ID for this Organization.

🔌 Usage

from auth0.myorganization import Auth0
from auth0.myorganization.environment import Auth0Environment

client = Auth0(
    token="<token>",
    environment=Auth0Environment.DEFAULT,
)

client.organization.domains.get(
    domain_id="domain_id",
)

⚙️ Parameters

domain_id: OrgDomainId

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

client.organization.domains.delete(...)

📝 Description

Remove a domain specified by ID from this Organization.

🔌 Usage

from auth0.myorganization import Auth0
from auth0.myorganization.environment import Auth0Environment

client = Auth0(
    token="<token>",
    environment=Auth0Environment.DEFAULT,
)

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() -> ListIdentityProvidersResponseContent

📝 Description

Retrieve a list of all Identity Providers for this Organization.

🔌 Usage

from auth0.myorganization import Auth0
from auth0.myorganization.environment import Auth0Environment

client = Auth0(
    token="<token>",
    environment=Auth0Environment.DEFAULT,
)

client.organization.identity_providers.list()

⚙️ Parameters

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

client.organization.identity_providers.create(...) -> CreateIdentityProviderResponseContent

📝 Description

Create a new Identity Provider for this Organization.

🔌 Usage

from auth0.myorganization import Auth0, IdpOidcRequest, IdpOidcOptionsRequest
from auth0.myorganization.environment import Auth0Environment

client = Auth0(
    token="<token>",
    environment=Auth0Environment.DEFAULT,
)

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

⚙️ Parameters

request: CreateIdentityProviderRequestContent

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

client.organization.identity_providers.get(...) -> GetIdentityProviderResponseContent

📝 Description

Retrieve details of an Identity Provider specified by ID for this Organization.

🔌 Usage

from auth0.myorganization import Auth0
from auth0.myorganization.environment import Auth0Environment

client = Auth0(
    token="<token>",
    environment=Auth0Environment.DEFAULT,
)

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(...)

📝 Description

Delete an Identity Provider specified by ID from this Organization. This will remove the association and delete the underlying Identity Provider. Members will no longer be able to authenticate using this Identity Provider.

🔌 Usage

from auth0.myorganization import Auth0
from auth0.myorganization.environment import Auth0Environment

client = Auth0(
    token="<token>",
    environment=Auth0Environment.DEFAULT,
)

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(...) -> UpdateIdentityProviderResponseContent

📝 Description

Update the details of an Identity Provider specified by ID for this Organization.

🔌 Usage

from auth0.myorganization import Auth0, IdpOidcUpdateRequest, IdpOidcOptionsRequest
from auth0.myorganization.environment import Auth0Environment

client = Auth0(
    token="<token>",
    environment=Auth0Environment.DEFAULT,
)

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(...) -> GetIdentityProviderResponseContent

📝 Description

Refresh the attribute mapping for an Identity Provider specified by ID for this Organization. Mappings are reset to the admin-defined defaults.

🔌 Usage

from auth0.myorganization import Auth0
from auth0.myorganization.environment import Auth0Environment

client = Auth0(
    token="<token>",
    environment=Auth0Environment.DEFAULT,
)

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(...)

📝 Description

Remove an Identity Provider specified by ID from this Organization. This only removes the association; the underlying Identity Provider is not deleted. Members will no longer be able to authenticate using this Identity Provider.

🔌 Usage

from auth0.myorganization import Auth0
from auth0.myorganization.environment import Auth0Environment

client = Auth0(
    token="<token>",
    environment=Auth0Environment.DEFAULT,
)

client.organization.identity_providers.detach(
    idp_id="idp_id",
)

⚙️ Parameters

idp_id: IdpId

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

Organization Members

client.organization.members.list(...) -> ListOrganizationMembersResponseContent

📝 Description

Retrieve a list of all members for this Organization. The roles field is only included for each member when the token also carries the read:my_org:member_roles scope; without that scope the roles field is omitted from the response.

🔌 Usage

from auth0.myorganization import Auth0
from auth0.myorganization.environment import Auth0Environment

client = Auth0(
    token="<token>",
    environment=Auth0Environment.DEFAULT,
)

client.organization.members.list(
    fields="fields",
    include_fields=True,
    from_="from",
    take=1,
)

⚙️ Parameters

fields: typing.Optional[str] — Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields.

include_fields: typing.Optional[bool] — Whether specified fields are to be included (true) or excluded (false). Defaults to true

from: typing.Optional[str] — An optional cursor from which to start the selection (exclusive).

take: typing.Optional[int] — Number of results per page. Defaults to 50.

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

client.organization.members.get(...) -> GetOrganizationMemberResponseContent

📝 Description

Retrieve details of a member specified by user ID for this Organization.

🔌 Usage

from auth0.myorganization import Auth0
from auth0.myorganization.environment import Auth0Environment

client = Auth0(
    token="<token>",
    environment=Auth0Environment.DEFAULT,
)

client.organization.members.get(
    user_id="user_id",
    fields="fields",
    include_fields=True,
)

⚙️ Parameters

user_id: OrgMemberId

fields: typing.Optional[str] — Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields.

include_fields: typing.Optional[bool] — Whether specified fields are to be included (true) or excluded (false). Defaults to true

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

Organization Memberships

client.organization.memberships.delete_memberships(...)

📝 Description

Remove one member from this Organization. The underlying user account is not deleted.

🔌 Usage

from auth0.myorganization import Auth0
from auth0.myorganization.environment import Auth0Environment

client = Auth0(
    token="<token>",
    environment=Auth0Environment.DEFAULT,
)

client.organization.memberships.delete_memberships(
    members=[
        "auth0|1234567890"
    ],
)

⚙️ Parameters

members: typing.List[OrgMemberId]

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

Organization Invitations

client.organization.invitations.list(...) -> ListMembersInvitationsResponseContent

📝 Description

Retrieve a list of all member invitations for this Organization.

🔌 Usage

from auth0.myorganization import Auth0
from auth0.myorganization.environment import Auth0Environment

client = Auth0(
    token="<token>",
    environment=Auth0Environment.DEFAULT,
)

client.organization.invitations.list(
    fields="fields",
    include_fields=True,
    from_="from",
    take=1,
    sort="sort",
)

⚙️ Parameters

fields: typing.Optional[str] — Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields. Note: you cannot filter on ticket_id and this value will only be returned when fields are not filtered.

include_fields: typing.Optional[bool] — Whether specified fields are to be included (true) or excluded (false). Defaults to true

from: typing.Optional[str] — An optional cursor from which to start the selection (exclusive).

take: typing.Optional[int] — Number of results per page. Defaults to 50.

sort: typing.Optional[str] — Field to sort by. Use field:order where order is 1 for ascending and -1 for descending. Defaults to created_at:-1

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

client.organization.invitations.create(...) -> CreateMemberInvitationResponseContent

📝 Description

Create one or more member invitations for this Organization. If an active invitation already exists for a user, generating a new invitation will automatically revoke any outstanding invitations for that user. Roles specified in the payload will be granted to the user upon acceptance of the invitation.

🔌 Usage

from auth0.myorganization import Auth0, CreateMemberInvitationInvitee, MemberInvitationInviter
from auth0.myorganization.environment import Auth0Environment

client = Auth0(
    token="<token>",
    environment=Auth0Environment.DEFAULT,
)

client.organization.invitations.create(
    invitees=[
        CreateMemberInvitationInvitee(
            email="user@example.com",
            roles=[
                "rol_0000000000000001"
            ],
        )
    ],
    inviter=MemberInvitationInviter(
        name="Allison the Admin",
    ),
    identity_provider_id="con_2CZPv6IY0gWzDaQJ",
    ttl_sec=3600,
)

⚙️ Parameters

invitees: typing.List[CreateMemberInvitationInvitee]

auth_0_custom_domain: typing.Optional[str]

inviter: typing.Optional[MemberInvitationInviter]

identity_provider_id: typing.Optional[str] — Identity provider identifier.

ttl_sec: typing.Optional[int] — Number of seconds for which the invitation is valid before expiration. If unspecified or set to 0, this value defaults to 604800 seconds (7 days). Max value: 2592000 seconds (30 days).

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

client.organization.invitations.get(...) -> GetMemberInvitationResponseContent

📝 Description

Retrieve details of a member invitation specified by ID for this Organization.

🔌 Usage

from auth0.myorganization import Auth0
from auth0.myorganization.environment import Auth0Environment

client = Auth0(
    token="<token>",
    environment=Auth0Environment.DEFAULT,
)

client.organization.invitations.get(
    invitation_id="invitation_id",
    fields="fields",
    include_fields=True,
)

⚙️ Parameters

invitation_id: InvitationId

fields: typing.Optional[str] — Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields. Note: you cannot filter on ticket_id and this value will only be returned when fields are not filtered.

include_fields: typing.Optional[bool] — Whether specified fields are to be included (true) or excluded (false). Defaults to true

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

client.organization.invitations.delete(...)

📝 Description

Revoke a member invitation specified by ID for this Organization.

🔌 Usage

from auth0.myorganization import Auth0
from auth0.myorganization.environment import Auth0Environment

client = Auth0(
    token="<token>",
    environment=Auth0Environment.DEFAULT,
)

client.organization.invitations.delete(
    invitation_id="invitation_id",
)

⚙️ Parameters

invitation_id: InvitationId

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

Organization Roles

client.organization.roles.list(...) -> ListRolesResponseContent

📝 Description

Retrieve the list of roles available for binding to members and invitations for this Organization. Only roles made visible to this Organization by the Tenant Admin are returned.

🔌 Usage

from auth0.myorganization import Auth0
from auth0.myorganization.environment import Auth0Environment

client = Auth0(
    token="<token>",
    environment=Auth0Environment.DEFAULT,
)

client.organization.roles.list(
    from_="from",
    take=1,
    name="name",
)

⚙️ Parameters

from: typing.Optional[str] — An optional cursor from which to start the selection (exclusive).

take: typing.Optional[int] — Number of results per page. Defaults to 50.

name: typing.Optional[str] — An optional filter on the name (case-insensitive).

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

Organization Configuration IdentityProviders

client.organization.configuration.identity_providers.get() -> GetIdpConfigurationResponseContent

📝 Description

Retrieve the Connection Profile for this application. You should cache this information as it does not change frequently.

🔌 Usage

from auth0.myorganization import Auth0
from auth0.myorganization.environment import Auth0Environment

client = Auth0(
    token="<token>",
    environment=Auth0Environment.DEFAULT,
)

client.organization.configuration.identity_providers.get()

⚙️ Parameters

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

Organization Domains Verify

client.organization.domains.verify.create(...) -> StartOrganizationDomainVerificationResponseContent

📝 Description

Initiate the verification process for a domain specified by ID for this Organization.

🔌 Usage

from auth0.myorganization import Auth0
from auth0.myorganization.environment import Auth0Environment

client = Auth0(
    token="<token>",
    environment=Auth0Environment.DEFAULT,
)

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(...) -> ListDomainIdentityProvidersResponseContent

📝 Description

Retrieve the list of Identity Providers associated with a domain specified by ID for this Organization.

🔌 Usage

from auth0.myorganization import Auth0
from auth0.myorganization.environment import Auth0Environment

client = Auth0(
    token="<token>",
    environment=Auth0Environment.DEFAULT,
)

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(...) -> CreateIdpDomainResponseContent

📝 Description

Associate a domain with an Identity Provider specified by ID for this Organization. The domain must be claimed and verified.

🔌 Usage

from auth0.myorganization import Auth0
from auth0.myorganization.environment import Auth0Environment

client = Auth0(
    token="<token>",
    environment=Auth0Environment.DEFAULT,
)

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(...)

📝 Description

Remove a domain specified by name from an Identity Provider specified by ID for this Organization.

🔌 Usage

from auth0.myorganization import Auth0
from auth0.myorganization.environment import Auth0Environment

client = Auth0(
    token="<token>",
    environment=Auth0Environment.DEFAULT,
)

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(...) -> GetIdPProvisioningConfigResponseContent

📝 Description

Retrieve the Provisioning Configuration for an Identity Provider specified by ID for this Organization.

🔌 Usage

from auth0.myorganization import Auth0
from auth0.myorganization.environment import Auth0Environment

client = Auth0(
    token="<token>",
    environment=Auth0Environment.DEFAULT,
)

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(...) -> CreateIdPProvisioningConfigResponseContent

📝 Description

Create a new Provisioning Configuration for an Identity Provider specified by ID for this Organization.

🔌 Usage

from auth0.myorganization import Auth0
from auth0.myorganization.environment import Auth0Environment

client = Auth0(
    token="<token>",
    environment=Auth0Environment.DEFAULT,
)

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(...)

📝 Description

Delete the Provisioning Configuration for an Identity Provider specified by ID for this Organization.

🔌 Usage

from auth0.myorganization import Auth0
from auth0.myorganization.environment import Auth0Environment

client = Auth0(
    token="<token>",
    environment=Auth0Environment.DEFAULT,
)

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(...) -> GetIdPProvisioningConfigResponseContent

📝 Description

Refresh the attribute mapping for the Provisioning Configuration of an Identity Provider specified by ID for this Organization. Mappings are reset to the admin-defined defaults.

🔌 Usage

from auth0.myorganization import Auth0
from auth0.myorganization.environment import Auth0Environment

client = Auth0(
    token="<token>",
    environment=Auth0Environment.DEFAULT,
)

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(...) -> ListIdpProvisioningScimTokensResponseContent

📝 Description

Retrieve a list of SCIM tokens for the Provisioning Configuration of an Identity Provider specified by ID for this Organization.

🔌 Usage

from auth0.myorganization import Auth0
from auth0.myorganization.environment import Auth0Environment

client = Auth0(
    token="<token>",
    environment=Auth0Environment.DEFAULT,
)

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(...) -> CreateIdpProvisioningScimTokenResponseContent

📝 Description

Create a new SCIM token for the Provisioning Configuration of an Identity Provider specified by ID for this Organization.

🔌 Usage

from auth0.myorganization import Auth0
from auth0.myorganization.environment import Auth0Environment

client = Auth0(
    token="<token>",
    environment=Auth0Environment.DEFAULT,
)

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(...)

📝 Description

Revoke a SCIM token specified by token ID for the Provisioning Configuration of an Identity Provider specified by ID for this Organization.

🔌 Usage

from auth0.myorganization import Auth0
from auth0.myorganization.environment import Auth0Environment

client = Auth0(
    token="<token>",
    environment=Auth0Environment.DEFAULT,
)

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.

Organization Members Roles

client.organization.members.roles.list(...) -> GetOrganizationMemberRolesResponseContent

📝 Description

Retrieve a list of roles assigned to a member specified by ID for this Organization.

🔌 Usage

from auth0.myorganization import Auth0
from auth0.myorganization.environment import Auth0Environment

client = Auth0(
    token="<token>",
    environment=Auth0Environment.DEFAULT,
)

client.organization.members.roles.list(
    user_id="user_id",
    from_="from",
    take=1,
)

⚙️ Parameters

user_id: OrgMemberId

from: typing.Optional[str] — An optional cursor from which to start the selection (exclusive).

take: typing.Optional[int] — Number of results per page. Defaults to 50.

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

client.organization.members.roles.assign(...)

📝 Description

Assign roles to a member specified by ID for this Organization.

🔌 Usage

from auth0.myorganization import Auth0
from auth0.myorganization.environment import Auth0Environment

client = Auth0(
    token="<token>",
    environment=Auth0Environment.DEFAULT,
)

client.organization.members.roles.assign(
    user_id="user_id",
    role_ids=[
        "rol_SO2j0sFo9NFa3F9w"
    ],
)

⚙️ Parameters

user_id: OrgMemberId

request: OrganizationMemberRolesChangeRequestContent

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

client.organization.members.roles.unassign(...)

📝 Description

Remove roles from a member specified by ID for this Organization.

🔌 Usage

from auth0.myorganization import Auth0
from auth0.myorganization.environment import Auth0Environment

client = Auth0(
    token="<token>",
    environment=Auth0Environment.DEFAULT,
)

client.organization.members.roles.unassign(
    user_id="user_id",
    role_ids=[
        "rol_SO2j0sFo9NFa3F9w"
    ],
)

⚙️ Parameters

user_id: OrgMemberId

request: OrganizationMemberRolesChangeRequestContent

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