{
"opencollection": "1.0.0",
"info": {
"name": "Auth0 Authentication actions organizations API",
"version": "1.0.0"
},
"items": [
{
"info": {
"name": "organizations",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Organizations",
"type": "http"
},
"http": {
"method": "GET",
"url": "{auth0_domain}/organizations",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page index of the results to return. First page is 0."
},
{
"name": "per_page",
"value": "",
"type": "query",
"description": "Number of results per page. Defaults to 50."
},
{
"name": "include_totals",
"value": "",
"type": "query",
"description": "Return results inside an object that contains the total result count (true) or as a direct array of results (false, default)."
},
{
"name": "from",
"value": "",
"type": "query",
"description": "Optional Id from which to start selection."
},
{
"name": "take",
"value": "",
"type": "query",
"description": "Number of results per page. Defaults to 50."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "Field to sort by. Use field:order where order is 1 for ascending and -1 for descending. e.g. created_at:1. We currently support sorting by the following fields: name, display_name and created_at."
}
]
},
"docs": "Retrieve detailed list of all Organizations available in your tenant. For more information, see Auth0 Organizations.\n\nThis endpoint supports two types of pagination:\n
from: Optional id from which to start selection.t"
},
{
"info": {
"name": "Create an Organization",
"type": "http"
},
"http": {
"method": "POST",
"url": "{auth0_domain}/organizations",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new Organization within your tenant. To learn more about Organization settings, behavior, and configuration options, review Create Your First Organization.\n"
},
{
"info": {
"name": "Get Organization by Name",
"type": "http"
},
"http": {
"method": "GET",
"url": "{auth0_domain}/organizations/name/:name",
"params": [
{
"name": "name",
"value": "",
"type": "path",
"description": "name of the organization to retrieve."
}
]
},
"docs": "Retrieve details about a single Organization specified by name.\n"
},
{
"info": {
"name": "Get Organization",
"type": "http"
},
"http": {
"method": "GET",
"url": "{auth0_domain}/organizations/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the organization to retrieve."
}
]
},
"docs": "Retrieve details about a single Organization specified by ID. \n"
},
{
"info": {
"name": "Modify an Organization",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "{auth0_domain}/organizations/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the organization to update."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update the details of a specific Organization, such as name and display name, branding options, and metadata.\n"
},
{
"info": {
"name": "Delete Organization",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{auth0_domain}/organizations/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Organization identifier."
}
]
},
"docs": "Remove an Organization from your tenant. This action cannot be undone. \n\nNote: Members are automatically disassociated from an Organization when it is deleted. However, this action does not delete these users from your tenant.\n"
},
{
"info": {
"name": "Get Client Grants Associated to an Organization",
"type": "http"
},
"http": {
"method": "GET",
"url": "{auth0_domain}/organizations/:id/client-grants",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Organization identifier."
},
{
"name": "audience",
"value": "",
"type": "query",
"description": "Optional filter on audience of the client grant."
},
{
"name": "client_id",
"value": "",
"type": "query",
"description": "Optional filter on client_id of the client grant."
},
{
"name": "grant_ids",
"value": "",
"type": "query",
"description": "Optional filter on the ID of the client grant. Must be URL encoded and may be specified multiple times (max 10).
e.g. ../client-grants?grant_ids=id1&grant_ids=id2"
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Page index of the results to return. First page is 0."
},
{
"name": "per_page",
"value": "",
"type": "query",
"description": "Number of results per page. Defaults to 50."
},
{
"name": "include_totals",
"value": "",
"type": "query",
"description": "Return results inside an object that contains the total result count (true) or as a direct array of results (false, default)."
}
]
},
"docs": "Get Client Grants Associated to an Organization"
},
{
"info": {
"name": "Associate a Client Grant with an Organization",
"type": "http"
},
"http": {
"method": "POST",
"url": "{auth0_domain}/organizations/:id/client-grants",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Organization identifier."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Associate a Client Grant with an Organization"
},
{
"info": {
"name": "Remove a Client Grant from an Organization",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{auth0_domain}/organizations/:id/client-grants/:grant_id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Organization identifier."
},
{
"name": "grant_id",
"value": "",
"type": "path",
"description": "The Client Grant ID to remove from the organization"
}
]
},
"docs": "Remove a Client Grant from an Organization"
},
{
"info": {
"name": "Get Connections Associated with an Organization",
"type": "http"
},
"http": {
"method": "GET",
"url": "{auth0_domain}/organizations/:id/connections",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Organization identifier."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Page index of the results to return. First page is 0."
},
{
"name": "per_page",
"value": "",
"type": "query",
"description": "Number of results per page. Defaults to 50."
},
{
"name": "include_totals",
"value": "",
"type": "query",
"description": "Return results inside an object that contains the total result count (true) or as a direct array of results (false, default)."
},
{
"name": "is_enabled",
"value": "",
"type": "query",
"description": "Filter connections by enabled status."
}
]
},
"docs": "Get Connections Associated with an Organization"
},
{
"info": {
"name": "Adds a Connection to an Organization",
"type": "http"
},
"http": {
"method": "POST",
"url": "{auth0_domain}/organizations/:id/connections",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Organization identifier."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Adds a Connection to an Organization"
},
{
"info": {
"name": "Get a Specific Connection Associated with an Organization",
"type": "http"
},
"http": {
"method": "GET",
"url": "{auth0_domain}/organizations/:id/connections/:connection_id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Organization identifier."
},
{
"name": "connection_id",
"value": "",
"type": "path",
"description": "Connection identifier."
}
]
},
"docs": "Get a Specific Connection Associated with an Organization"
},
{
"info": {
"name": "Update a Connection for an Organization",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "{auth0_domain}/organizations/:id/connections/:connection_id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Organization identifier."
},
{
"name": "connection_id",
"value": "",
"type": "path",
"description": "Connection identifier."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update a Connection for an Organization"
},
{
"info": {
"name": "Delete a Connection from an Organization",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{auth0_domain}/organizations/:id/connections/:connection_id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Organization identifier."
},
{
"name": "connection_id",
"value": "",
"type": "path",
"description": "Connection identifier."
}
]
},
"docs": "Delete a Connection from an Organization"
},
{
"info": {
"name": "Retrieve All Organization Discovery Domains",
"type": "http"
},
"http": {
"method": "GET",
"url": "{auth0_domain}/organizations/:id/discovery-domains",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the organization."
},
{
"name": "from",
"value": "",
"type": "query",
"description": "Optional Id from which to start selection."
},
{
"name": "take",
"value": "",
"type": "query",
"description": "Number of results per page. Defaults to 50."
}
]
},
"docs": "Retrieve list of all organization discovery domains associated with the specified organization.\nThis endpoint is subject to eventual consistency; newly created, updated, or deleted discovery domains may not immediately appear in the response.\n"
},
{
"info": {
"name": "Create an Organization Discovery Domain",
"type": "http"
},
"http": {
"method": "POST",
"url": "{auth0_domain}/organizations/:id/discovery-domains",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new discovery domain for an organization."
},
{
"info": {
"name": "Retrieve an Organization Discovery Domain by Domain Name",
"type": "http"
},
"http": {
"method": "GET",
"url": "{auth0_domain}/organizations/:id/discovery-domains/name/:discovery_domain",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the organization."
},
{
"name": "discovery_domain",
"value": "",
"type": "path",
"description": "Domain name of the discovery domain."
}
]
},
"docs": "Retrieve details about a single organization discovery domain specified by domain name.\nThis endpoint is subject to eventual consistency; newly created, updated, or deleted discovery domains may not immediately appear in the response.\n"
},
{
"info": {
"name": "Retrieve an Organization Discovery Domain by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "{auth0_domain}/organizations/:id/discovery-domains/:discovery_domain_id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the organization."
},
{
"name": "discovery_domain_id",
"value": "",
"type": "path",
"description": "ID of the discovery domain."
}
]
},
"docs": "Retrieve details about a single organization discovery domain specified by ID.\nThis endpoint is subject to eventual consistency; newly created, updated, or deleted discovery domains may not immediately appear in the response.\n"
},
{
"info": {
"name": "Update an Organization Discovery Domain",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "{auth0_domain}/organizations/:id/discovery-domains/:discovery_domain_id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the organization."
},
{
"name": "discovery_domain_id",
"value": "",
"type": "path",
"description": "ID of the discovery domain to update."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update the verification status and/or use_for_organization_discovery for an organization discovery domain. The status field must be either pending or verified. The use_for_organization_discovery field can be true or false (default: true).\n"
},
{
"info": {
"name": "Delete an Organization Discovery Domain",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{auth0_domain}/organizations/:id/discovery-domains/:discovery_domain_id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the organization."
},
{
"name": "discovery_domain_id",
"value": "",
"type": "path",
"description": "ID of the discovery domain."
}
]
},
"docs": "Remove a discovery domain from an organization. This action cannot be undone. "
},
{
"info": {
"name": "Get Connections Enabled for an Organization",
"type": "http"
},
"http": {
"method": "GET",
"url": "{auth0_domain}/organizations/:id/enabled_connections",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Organization identifier."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Page index of the results to return. First page is 0."
},
{
"name": "per_page",
"value": "",
"type": "query",
"description": "Number of results per page. Defaults to 50."
},
{
"name": "include_totals",
"value": "",
"type": "query",
"description": "Return results inside an object that contains the total result count (true) or as a direct array of results (false, default)."
}
]
},
"docs": "Retrieve details about a specific connection currently enabled for an Organization. Information returned includes details such as connection ID, name, strategy, and whether the connection automatically grants membership upon login.\n"
},
{
"info": {
"name": "Add Connections to an Organization",
"type": "http"
},
"http": {
"method": "POST",
"url": "{auth0_domain}/organizations/:id/enabled_connections",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Organization identifier."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Enable a specific connection for a given Organization. To enable a connection, it must already exist within your tenant; connections cannot be created through this action.\n\nConnections represent the relationship between Auth0 and a source of users. Available types of connections include database, enterprise, and social.\n"
},
{
"info": {
"name": "Get an Enabled Connection for an Organization",
"type": "http"
},
"http": {
"method": "GET",
"url": "{auth0_domain}/organizations/:id/enabled_connections/:connectionId",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Organization identifier."
},
{
"name": "connectionId",
"value": "",
"type": "path",
"description": "Connection identifier."
}
]
},
"docs": "Retrieve details about a specific connection currently enabled for an Organization. Information returned includes details such as connection ID, name, strategy, and whether the connection automatically grants membership upon login.\n"
},
{
"info": {
"name": "Update the Connection of an Organization",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "{auth0_domain}/organizations/:id/enabled_connections/:connectionId",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Organization identifier."
},
{
"name": "connectionId",
"value": "",
"type": "path",
"description": "Connection identifier."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modify the details of a specific connection currently enabled for an Organization.\n"
},
{
"info": {
"name": "Delete Connections from an Organization",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{auth0_domain}/organizations/:id/enabled_connections/:connectionId",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Organization identifier."
},
{
"name": "connectionId",
"value": "",
"type": "path",
"description": "Connection identifier."
}
]
},
"docs": "Disable a specific connection for an Organization. Once disabled, Organization members can no longer use that connection to authenticate. \n\nNote: This action does not remove the connection from your tenant.\n"
},
{
"info": {
"name": "Get Invitations to an Organization",
"type": "http"
},
"http": {
"method": "GET",
"url": "{auth0_domain}/organizations/:id/invitations",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Organization identifier."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Page index of the results to return. First page is 0."
},
{
"name": "per_page",
"value": "",
"type": "query",
"description": "Number of results per page. Defaults to 50."
},
{
"name": "include_totals",
"value": "",
"type": "query",
"description": "When true, return results inside an object that also contains the start and limit. When false (default), a direct array of results is returned. We do not yet support returning the total invitations count."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields."
},
{
"name": "include_fields",
"value": "",
"type": "query",
"description": "Whether specified fields are to be included (true) or excluded (false). Defaults to true."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "Field to sort by. Use field:order where order is 1 for ascending and -1 for descending Defaults to created_at:-1."
}
]
},
"docs": "Retrieve a detailed list of invitations sent to users for a specific Organization. The list includes details such as inviter and invitee information, invitation URLs, and dates of creation and expiration. To learn more about Organization invitations, review Invite Organization Members. \n"
},
{
"info": {
"name": "Create Invitations to an Organization",
"type": "http"
},
"http": {
"method": "POST",
"url": "{auth0_domain}/organizations/:id/invitations",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Organization identifier."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a user invitation for a specific Organization. Upon creation, the listed user receives an email inviting them to join the Organization. To learn more about Organization invitations, review Invite Organization Members. \n"
},
{
"info": {
"name": "Get a Specific Invitation to an Organization",
"type": "http"
},
"http": {
"method": "GET",
"url": "{auth0_domain}/organizations/:id/invitations/:invitation_id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Organization identifier."
},
{
"name": "invitation_id",
"value": "",
"type": "path",
"description": "The id of the user invitation."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields."
},
{
"name": "include_fields",
"value": "",
"type": "query",
"description": "Whether specified fields are to be included (true) or excluded (false). Defaults to true."
}
]
},
"docs": "Get a Specific Invitation to an Organization"
},
{
"info": {
"name": "Delete an Invitation to an Organization",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{auth0_domain}/organizations/:id/invitations/:invitation_id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Organization identifier."
},
{
"name": "invitation_id",
"value": "",
"type": "path",
"description": "The id of the user invitation."
}
]
},
"docs": "Delete an Invitation to an Organization"
},
{
"info": {
"name": "Get Members Who Belong to an Organization",
"type": "http"
},
"http": {
"method": "GET",
"url": "{auth0_domain}/organizations/:id/members",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Organization identifier."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Page index of the results to return. First page is 0."
},
{
"name": "per_page",
"value": "",
"type": "query",
"description": "Number of results per page. Defaults to 50."
},
{
"name": "include_totals",
"value": "",
"type": "query",
"description": "Return results inside an object that contains the total result count (true) or as a direct array of results (false, default)."
},
{
"name": "from",
"value": "",
"type": "query",
"description": "Optional Id from which to start selection."
},
{
"name": "take",
"value": "",
"type": "query",
"description": "Number of results per page. Defaults to 50."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields."
},
{
"name": "include_fields",
"value": "",
"type": "query",
"description": "Whether specified fields are to be included (true) or excluded (false)."
}
]
},
"docs": "List organization members.\nThis endpoint is subject to eventual consistency. New users may not be immediately included in the response and deleted users may not be immediately removed from it.\n\n\n - \n Use the
fields parameter to optionally define the specific member details retrieved. If fields is left blank, all fields (except roles) are returned.\n \n - \n Member roles are not sent by default. Use
fields=roles to retrieve the roles assig"
},
{
"info": {
"name": "Add Members to an Organization",
"type": "http"
},
"http": {
"method": "POST",
"url": "{auth0_domain}/organizations/:id/members",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Organization identifier."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Set one or more existing users as members of a specific Organization.\n\nTo add a user to an Organization through this action, the user must already exist in your tenant. If a user does not yet exist, you can invite them to create an account, manually create them through the Auth0 Dashboard, or use the Management API.\n"
},
{
"info": {
"name": "Delete Members from an Organization",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{auth0_domain}/organizations/:id/members",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Organization identifier."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Delete Members from an Organization"
},
{
"info": {
"name": "Get User Roles Assigned to an Organization Member",
"type": "http"
},
"http": {
"method": "GET",
"url": "{auth0_domain}/organizations/:id/members/:user_id/roles",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Organization identifier."
},
{
"name": "user_id",
"value": "",
"type": "path",
"description": "ID of the user to associate roles with."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Page index of the results to return. First page is 0."
},
{
"name": "per_page",
"value": "",
"type": "query",
"description": "Number of results per page. Defaults to 50."
},
{
"name": "include_totals",
"value": "",
"type": "query",
"description": "Return results inside an object that contains the total result count (true) or as a direct array of results (false, default)."
}
]
},
"docs": "Retrieve detailed list of roles assigned to a given user within the context of a specific Organization. \n\nUsers can be members of multiple Organizations with unique roles assigned for each membership. This action only returns the roles associated with the specified Organization; any roles assigned to the user within other Organizations are not included.\n"
},
{
"info": {
"name": "Assign User Roles to an Organization Member",
"type": "http"
},
"http": {
"method": "POST",
"url": "{auth0_domain}/organizations/:id/members/:user_id/roles",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Organization identifier."
},
{
"name": "user_id",
"value": "",
"type": "path",
"description": "ID of the user to associate roles with."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Assign one or more roles to a user to determine their access for a specific Organization.\n\nUsers can be members of multiple Organizations with unique roles assigned for each membership. This action assigns roles to a user only for the specified Organization. Roles cannot be assigned to a user across multiple Organizations in the same call.\n"
},
{
"info": {
"name": "Delete User Roles from an Organization Member",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{auth0_domain}/organizations/:id/members/:user_id/roles",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Organization identifier."
},
{
"name": "user_id",
"value": "",
"type": "path",
"description": "User ID of the organization member to remove roles from."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Remove one or more Organization-specific roles from a given user.\n\nUsers can be members of multiple Organizations with unique roles assigned for each membership. This action removes roles from a user in relation to the specified Organization. Roles assigned to the user within a different Organization cannot be managed in the same call.\n"
}
]
}
],
"bundled": true
}