Auth0¶
With Auth0 modules in Ibexa Connect, you can create, monitor, update and search for users in your Auth0 account and make API calls.
To get started with Auth0, create an account at auth0.com.
Note
The module dialog fields that are displayed in bold (in the Ibexa Connect scenario, not in this documentation article) are mandatory.
Connecting Auth0 to Ibexa Connect¶
To make a connection you need to create an application in your Auth0 account and retrieve the credentials.
-
Log in to your Auth0 account.
-
Click Applications in the left-hand menu, then click Applications in the drop-down.
-
Click Create Application.
-
Choose a name for your new app.
-
Select the Machine to Machine app type, then click Create.
-
Select the API you want to authorize for invocation from your application. You can also create a new API.
-
Select any permissions you need, then click Authorize.
-
Once you have created your app, click Settings.
-
Under Basic Information, copy the Domain, Client ID, and Client Secret to your clipboard.
-
Go to your Ibexa Connect scenario and choose the Auth0 module you want to use.
-
Next to Connection, click Add.
-
Give your connection a name.
-
Copy the Domain URL from step 9 into the corresponding field. For example, if your Auth0 domain is vasyapupkin.eu.auth0.com then use
https://vasyapupkin.eu.auth0.com. -
Copy the Client ID and Client Secret into their respective fields.
-
Click Save.
You have successfully established the connection.
Users¶
Watch Users¶
Triggers when a new user is created.
| Query | Enter any search terms to filter the results. For more information see using query string syntax. |
| Limit | Enter the maximum number of users Ibexa Connect returns during one scenario execution cycle. |
Create a User¶
Creates a new user.
Email Address |
Enter the user's email address. |
|||
User Metadata |
Add any additional data related to the user. |
|||
Blocked |
Select whether this user was blocked by an administrator or not. |
|||
Email Verified |
Select whether this email address is verified or unverified. User will receive a verification email after creation if Email Verified is |
|||
Phone Verified |
Select whether this phone number has been verified or not. |
|||
App Metadata |
Add any additional data related to the user. |
|||
Given Name |
Enter the user's given name(s). |
|||
Family Name |
Enter the user's family name(s). |
|||
Full Name |
Enter the user's full name. |
|||
Nickname |
Enter the user's nickname. |
|||
Picture |
Enter a URI pointing to the user's picture. |
|||
User ID |
Enter the external user's ID provided by the identity provider. |
|||
Password |
Enter the initial password for this user. | Mandatory only for auth0 connection strategy. |
Verify Email
Select whether the user will receive a verification email after creation or no email.
Note
Overrides behavior of Email Verified parameter.
Username
Enter the user's username. Only valid if the connection requires a username.
Search Users¶
Searches for specific users or lists them all.
| Search | Enter any search terms to filter the results. For more information see using query string syntax. |
| Limit | Enter the maximum number of users Ibexa Connect returns during one scenario execution cycle. |
Update a User¶
Updates a user by ID.
User ID |
Select the ID of the user you want to update. |
|||
Email Address |
Enter the user's email address. |
|||
User Metadata |
Add any additional data related to the user. |
|||
Blocked |
Select whether this user was blocked by an administrator or not. |
|||
Email Verified |
Select whether this email address is verified or unverified. User will receive a verification email after creation if Email Verified is |
|||
Phone Verified |
Select whether this phone number has been verified or not. |
|||
App Metadata |
Add any additional data related to the user. |
|||
Given Name |
Enter the user's given name(s). |
|||
Family Name |
Enter the user's family name(s). |
|||
Full Name |
Enter the user's full name. |
|||
Nickname |
Enter the user's nickname. |
|||
Picture |
Enter a URI pointing to the user's picture. |
|||
User ID |
Enter the external user's ID provided by the identity provider. |
|||
Password |
Enter the initial password for this user. | Mandatory only for auth0 connection strategy. |
Verify Email
Select whether the user will receive a verification email after creation or no email.
Note
Overrides behavior of Email Verified parameter.
Username
Enter the user's username. Only valid if the connection requires a username.
Delete a User¶
Deletes a user by ID.
| User ID | Enter the ID of the user you want to delete. |
Get a User¶
Gets a user's details by ID.
| User ID | Enter the ID of the user you want to retrieve. |
Search Users by Email¶
Searches users by email.
| Fields | Select the data you want Ibexa Connect to return in the results. |
| Include Fields | Select whether specified fields are to be included (Yes) or excluded (No). |
| Enter the email address of the user. | |
| Limit | Enter the maximum number of users Ibexa Connect returns during one scenario execution cycle. |
Other¶
Make an API Call¶
Performs an arbitrary authorized API call.
Method |
Select the HTTP method you want to use: GET to retrieve information for an entry. POST to create a new entry. PUT to update/replace an existing entry. PATCH to make a partial entry update. DELETE to delete an entry. |
Headers |
Enter the desired request headers. You don't have to add authorization headers; we already did that for you. |
Query String |
Enter the request query string. |
Body |
Enter the body content for your API call. |
Example of use - List Users¶
The following API call returns a list of all the users in your Auth0 account.
URL: /v2/users
Method: GET
Matches of the search can be found in the module's Output under Bundle > Body. Our example returned 2 users:
