|
2 | 2 | description: Learn how to activate and use the My Organization API. |
3 | 3 | sidebarTitle: My Organization API |
4 | 4 | title: My Organization API and Embeddable UI Components |
| 5 | +validatedOn: 2026-04-14 |
5 | 6 | --- |
6 | 7 |
|
7 | 8 | <Warning> |
@@ -80,15 +81,14 @@ The My Organization API will always remain opt-in for security reasons. Disablin |
80 | 81 |
|
81 | 82 | [Create an application](/docs/get-started/auth0-overview/create-applications) in Auth0 to use with the My Organization API. Once created, navigate to **[Auth0 Dashboard > Applications > APIs](https://manage.auth0.com/#/apis)** and authorize the My Organization API, including the scopes you want the application to perform. |
82 | 83 |
|
83 | | -The client application must provide a specific configuration object (`my_organization_configuration`) containing the following properties: |
| 84 | +Your application must provide the `my_organization_configuration` object or the My Organization API gives an error and rejects the request. You can use the following properties with the `my_organization_configuration` object: |
84 | 85 |
|
85 | 86 | | **Property** | **Description** | |
86 | | -| -- | ------ | |
87 | | -| `my_organization_configuration` | **Object.** The application must provide this object with configurations for the My Organization API to follow. If the application does not define this object, the My Organization API will give an error and reject the request.| |
88 | | -| `my_organization_configuration.connection_profile_id` | **Connection Profile ID.** ID of the [Connection Profile](/docs/authenticate/enterprise-connections/connection-profile) used with the application when leveraging the My Organization API. If not provided, My Organization API features that require a Connection Profile to be present will not function. This ID must refer to a valid Connection Profile in the same tenant.| |
89 | | -| `my_organization_configuration.user_attribute_profile_id` | **User Attribute Profile ID**. ID of the [User Attribute Profile](/docs/authenticate/enterprise-connections/user-attribute-profile) used with the application when leveraging the My Organization API. If it is not provided, My Organization API features that require a User Attribute Profile to be present will not function. This ID must refer to a valid User Attribute Profile in the same tenant.| |
90 | | -| `my_organization_configuration.allowed_strategies` | **Array of strings.** Each string is unique and refers to a supported strategy. The supported strategies - the values for the enum - are as follows: `pingfederate`, `ad`, `adfs`, `waad`, `google-apps`, `okta`, `oidc`, and `samlp`.| |
91 | | -| `my_organization_configuration.connection_deletion_behavior` | **Enum (allow, allow_if_empty).** Describes how the My Organization API behaves when an end user tries to delete a connection when attempted via the My Organization API from this application. The values and description of the enum are as follows: <p></p> 1. `allow`: Given the user has the correct scope, a user can delete the connection which results in all users originating from the connection being deleted. <p></p> 2.`allow_if_empty`: Given the user has the correct scope, a user can only delete the connection if there are no users in the connection. If users are present, the My Organization API will return an error and won’t proceed with the deletion.| |
| 87 | +| ------ | ------ | |
| 88 | +| `connection_profile_id` | **Connection Profile ID.** ID of the [Connection Profile](/docs/authenticate/enterprise-connections/connection-profile) used with the application when leveraging the My Organization API. If not provided, My Organization API features that require a Connection Profile to be present will not function. This ID must refer to a valid Connection Profile in the same tenant.| |
| 89 | +| `user_attribute_profile_id` | **User Attribute Profile ID**. ID of the [User Attribute Profile](/docs/authenticate/enterprise-connections/user-attribute-profile) used with the application when leveraging the My Organization API. If it is not provided, My Organization API features that require a User Attribute Profile to be present will not function. This ID must refer to a valid User Attribute Profile in the same tenant.| |
| 90 | +| `allowed_strategies` | **Array of strings.** Each string is unique and refers to a supported strategy. The supported strategies - the values for the enum - are as follows: `pingfederate`, `ad`, `adfs`, `waad`, `google-apps`, `okta`, `oidc`, and `samlp`.| |
| 91 | +| `connection_deletion_behavior` | **Enum (allow, allow_if_empty).** Describes how the My Organization API behaves when an end user tries to delete a connection when attempted via the My Organization API from this application. The values and description of the enum are as follows: <p></p> 1. `allow`: Given the user has the correct scope, a user can delete the connection which results in all users originating from the connection being deleted. <p></p> 2.`allow_if_empty`: Given the user has the correct scope, a user can only delete the connection if there are no users in the connection. If users are present, the My Organization API will return an error and won’t proceed with the deletion.| |
92 | 92 |
|
93 | 93 | #### Configure client application attributes |
94 | 94 |
|
@@ -315,10 +315,10 @@ The API introduces an ownership model to distinguish between connections managed |
315 | 315 |
|
316 | 316 | **Management API Endpoints for Connections**: |
317 | 317 |
|
318 | | -* `GET` `/api/v2/organizations/{id}/connections` |
319 | | -* `POST` `/api/v2/organizations/{id}/connections` |
320 | | -* `PATCH` `/api/v2/organizations/{id}/connections/{id}` |
321 | | -* `DELETE` `/api/v2/organizations/{id}/connections/{id}` |
| 318 | +* `GET` [`/api/v2/organizations/{id}/connections`](https://auth0.com/docs/api/management/v2/organizations/get-organization-connection) |
| 319 | +* `POST` [`/api/v2/organizations/{id}/connections`](https://auth0.com/docs/api/management/v2/organizations/post-organization-connection) |
| 320 | +* `PATCH` [`/api/v2/organizations/{id}/connections/{id}`](https://auth0.com/docs/api/management/v2/organizations/patch-organization-connection) |
| 321 | +* `DELETE` [`/api/v2/organizations/{id}/connections/{id}`](https://auth0.com/docs/api/management/v2/organizations/delete-organization-connection) |
322 | 322 |
|
323 | 323 | When you call the `/connections` endpoints, use the same scopes as you would for the `/enabled_connections` endpoints: |
324 | 324 |
|
|
0 commit comments