Create Organization (Internal)

Create a new organization with Auth0 authentication. The Auth0 user will be the organization owner.

post
https://global.api.konghq.com/v2/internal/auth0/register

Body

application/json

Auth0 organization register

Auth0 organization registration

organization_namestringrequired
default_regionstringrequired

Response

application/json

Auth0 organization registration

Auth0 organization registration response

A successful Auth0 organization registration response.

organization_idstring
login_pathstring
post/internal/auth0/register

Body

{ "organization_name": "organization_name", "default_region": "default_region" }
 
application/json

List Organizations (Internal)

Retrieves the list of organizations available to the given user.

get
https://global.api.konghq.com/v2/internal/auth0/organizations

Response

application/json

A paginated list response for a collection of auth0 organizations.

metaobject

returns the pagination information

Show Child Parameters
dataarray[object]

A single auth0 organization.

Show Child Parameters
get/internal/auth0/organizations
 
application/json

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