Auth0 organization schema.

object

A single auth0 organization.

namestringread-only

The name of the organization.

Example:My Organization

login_pathstringread-only

The login path of the organization.

Example:/v2/authenticate/federated?org_id=7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

Example

Auth0 organization registration response

object

A successful Auth0 organization registration response.

organization_idstring
login_pathstring
Example

User

object

The user object contains information about an individual user who can use the Konnect application and API.

idstring(uuid)read-only

The User ID.

Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

emailstring(email)

The email registered to the user.

<= 250 characters

Example:user@email.com

full_namestring

The User’s full name.

Match pattern:^[\w \W]+$

<= 250 characters

Example:Jane Doe

preferred_namestring

The User’s preferred name.

<= 250 characters

Example:Jane

activebooleanread-only

Returns True if a user has verified their email address.

Default:true

inferred_regionstringread-only

The Konnect region closest to the user’s IP address. This property might only be set for users on signup through Konnect’s build-in native authentication.

Example:us

created_atstring(date-time)read-only

The time stamp for the date the account was registered.

Example:2022-02-07T17:46:57.52Z

updated_atstring(date-time)read-only

A Unix timestamp representation of the most recent change to the User account.

Example:2022-10-08T17:00:00.52Z

Example

ParameterizedAssignedRole

object

A parameterized assigned role is a role that has been assigned to a managed system account with additional parameters.

idstring(uuid)

The ID of the role assignment.

Example:eaf7adf1-32c8-4bbf-b960-d1f8456afe67

role_namestring

Name of the role being assigned.

Example:Viewer

entity_idstring(uuid)

A RBAC entity ID.

Example:817d0422-45c9-4d88-8d64-45aef05c1ae7

entity_type_namestring

Name of the entity type the role is being assigned to.

Example:Control Planes

entity_regionstring

Region of the entity.

Allowed values:useuaumeinsg*

Example:eu

parametersobject

Additional parameters for the role assignment.

* Additional properties are allowed.
Example

User with Organization IDs only.

object

User with Organization IDs only.

idstring(uuid)read-only

ID of a user.

organization_idstring(uuid)read-only

organization ID of a user.

Example