Skip to content

Commit d923e81

Browse files
fix: Update Organizations Docs for My Org API (#945)
* Fix endpoint link Updated endpoint reference for modifying organization connections. * Revise organization connection management documentation Updated the documentation for disabling connections in organizations, including steps for both the Auth0 Dashboard and Management API. Adjusted code examples for various programming languages to reflect the correct endpoint. * Revise organization connection management documentation Updated connection management instructions and properties for organizations, including new API endpoints and configuration options. * Update API endpoint references for organization connections * Page updates and clean up * Management API endpoints added * Fix typo in warning about organization connections * Update enable-connections.mdx * Update retrieve-connections.mdx * Update login-flows-for-organizations.mdx --------- Co-authored-by: amanda-vanscoy <amanda.vanscoy@auth0.com>
1 parent d0e9cb1 commit d923e81

5 files changed

Lines changed: 294 additions & 141 deletions

File tree

main/docs/manage-users/my-organization-api.mdx

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
description: Learn how to activate and use the My Organization API.
33
sidebarTitle: My Organization API
44
title: My Organization API and Embeddable UI Components
5+
validatedOn: 2026-04-14
56
---
67

78
<Warning>
@@ -80,15 +81,14 @@ The My Organization API will always remain opt-in for security reasons. Disablin
8081

8182
[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.
8283

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:
8485

8586
| **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.|
9292

9393
#### Configure client application attributes
9494

@@ -315,10 +315,10 @@ The API introduces an ownership model to distinguish between connections managed
315315

316316
**Management API Endpoints for Connections**:
317317

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)
322322

323323
When you call the `/connections` endpoints, use the same scopes as you would for the `/enabled_connections` endpoints:
324324

0 commit comments

Comments
 (0)