{
  "opencollection": "1.0.0",
  "info": {
    "name": "Logto API references Account center Organizations API",
    "version": "Cloud"
  },
  "request": {
    "auth": {
      "type": "oauth2",
      "flow": "client_credentials",
      "accessTokenUrl": "/oidc/token",
      "credentials": {
        "clientId": "{{clientId}}",
        "clientSecret": "{{clientSecret}}"
      }
    }
  },
  "items": [
    {
      "info": {
        "name": "Organizations",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get organizations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://[tenant_id].logto.app/api/organizations",
            "params": [
              {
                "name": "q",
                "value": "",
                "type": "query",
                "description": "The query to filter organizations. It can be a partial ID or name.\n\nIf not provided, all organizations will be returned."
              },
              {
                "name": "showFeatured",
                "value": "",
                "type": "query",
                "description": "Whether to show featured users in the organization. Featured users are randomly selected from the organization members.\n\nIf not provided, `featuredUsers` will not be included in the response."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page number (starts from 1)."
              },
              {
                "name": "page_size",
                "value": "",
                "type": "query",
                "description": "Entries per page."
              }
            ]
          },
          "docs": "Get organizations that match the given query with pagination."
        },
        {
          "info": {
            "name": "Create an organization",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://[tenant_id].logto.app/api/organizations",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new organization with the given data."
        },
        {
          "info": {
            "name": "Get organization",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://[tenant_id].logto.app/api/organizations/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the organization."
              }
            ]
          },
          "docs": "Get organization details by ID."
        },
        {
          "info": {
            "name": "Update organization",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://[tenant_id].logto.app/api/organizations/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the organization."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update organization details by ID with the given data."
        },
        {
          "info": {
            "name": "Delete organization",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://[tenant_id].logto.app/api/organizations/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the organization."
              }
            ]
          },
          "docs": "Delete organization by ID."
        },
        {
          "info": {
            "name": "Get organization user members",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://[tenant_id].logto.app/api/organizations/:id/users",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the organization."
              },
              {
                "name": "q",
                "value": "",
                "type": "query",
                "description": "The query to filter users. It will match multiple fields of users, including ID, name, username, email, and phone number.\n\nIf not provided, all users will be returned."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page number (starts from 1)."
              },
              {
                "name": "page_size",
                "value": "",
                "type": "query",
                "description": "Entries per page."
              }
            ]
          },
          "docs": "Get users that are members of the specified organization for the given query with pagination."
        },
        {
          "info": {
            "name": "Add user members to organization",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://[tenant_id].logto.app/api/organizations/:id/users",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the organization."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Add users as members to the specified organization with the given user IDs."
        },
        {
          "info": {
            "name": "Replace organization user members",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://[tenant_id].logto.app/api/organizations/:id/users",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the organization."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Replace all user members for the specified organization with the given users. This effectively removing all existing user memberships in the organization and adding the new users as members."
        },
        {
          "info": {
            "name": "Remove user member from organization",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://[tenant_id].logto.app/api/organizations/:id/users/:userId",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the organization."
              },
              {
                "name": "userId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the user."
              }
            ]
          },
          "docs": "Remove a user's membership from the specified organization."
        },
        {
          "info": {
            "name": "Assign roles to organization user members",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://[tenant_id].logto.app/api/organizations/:id/users/roles",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the organization."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Assign roles to user members of the specified organization."
        },
        {
          "info": {
            "name": "Get roles for a user in an organization",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://[tenant_id].logto.app/api/organizations/:id/users/:userId/roles",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the organization."
              },
              {
                "name": "userId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the user."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page number (starts from 1)."
              },
              {
                "name": "page_size",
                "value": "",
                "type": "query",
                "description": "Entries per page."
              }
            ]
          },
          "docs": "Get roles assigned to a user in the specified organization with pagination."
        },
        {
          "info": {
            "name": "Assign roles to a user in an organization",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://[tenant_id].logto.app/api/organizations/:id/users/:userId/roles",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the organization."
              },
              {
                "name": "userId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the user."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Assign roles to a user in the specified organization with the provided data."
        },
        {
          "info": {
            "name": "Update roles for a user in an organization",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://[tenant_id].logto.app/api/organizations/:id/users/:userId/roles",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the organization."
              },
              {
                "name": "userId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the user."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update roles assigned to a user in the specified organization with the provided data."
        },
        {
          "info": {
            "name": "Remove a role from a user in an organization",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://[tenant_id].logto.app/api/organizations/:id/users/:userId/roles/:organizationRoleId",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the organization."
              },
              {
                "name": "userId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the user."
              },
              {
                "name": "organizationRoleId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the organization role."
              }
            ]
          },
          "docs": "Remove a role assignment from a user in the specified organization."
        },
        {
          "info": {
            "name": "Get scopes for a user in an organization tailored by the organization roles",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://[tenant_id].logto.app/api/organizations/:id/users/:userId/scopes",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the organization."
              },
              {
                "name": "userId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the user."
              }
            ]
          },
          "docs": "Get scopes assigned to a user in the specified organization tailored by the organization roles. The scopes are derived from the organization roles assigned to the user."
        },
        {
          "info": {
            "name": "Get organization applications",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://[tenant_id].logto.app/api/organizations/:id/applications",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the organization."
              },
              {
                "name": "q",
                "value": "",
                "type": "query"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page number (starts from 1)."
              },
              {
                "name": "page_size",
                "value": "",
                "type": "query",
                "description": "Entries per page."
              }
            ]
          },
          "docs": "Get applications associated with the organization."
        },
        {
          "info": {
            "name": "Add organization application",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://[tenant_id].logto.app/api/organizations/:id/applications",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the organization."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Add an application to the organization."
        },
        {
          "info": {
            "name": "Replace organization applications",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://[tenant_id].logto.app/api/organizations/:id/applications",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the organization."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Replace all applications associated with the organization with the given data."
        },
        {
          "info": {
            "name": "Remove organization application",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://[tenant_id].logto.app/api/organizations/:id/applications/:applicationId",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the organization."
              },
              {
                "name": "applicationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the application."
              }
            ]
          },
          "docs": "Remove an application from the organization."
        },
        {
          "info": {
            "name": "Assign roles to applications in an organization",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://[tenant_id].logto.app/api/organizations/:id/applications/roles",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the organization."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Assign roles to applications in the specified organization."
        },
        {
          "info": {
            "name": "Get organization application roles",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://[tenant_id].logto.app/api/organizations/:id/applications/:applicationId/roles",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the organization."
              },
              {
                "name": "applicationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the application."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page number (starts from 1)."
              },
              {
                "name": "page_size",
                "value": "",
                "type": "query",
                "description": "Entries per page."
              }
            ]
          },
          "docs": "Get roles associated with the application in the organization."
        },
        {
          "info": {
            "name": "Add organization application role",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://[tenant_id].logto.app/api/organizations/:id/applications/:applicationId/roles",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the organization."
              },
              {
                "name": "applicationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the application."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Add a role to the application in the organization."
        },
        {
          "info": {
            "name": "Replace organization application roles",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://[tenant_id].logto.app/api/organizations/:id/applications/:applicationId/roles",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the organization."
              },
              {
                "name": "applicationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the application."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Replace all roles associated with the application in the organization with the given data."
        },
        {
          "info": {
            "name": "Remove organization application role",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://[tenant_id].logto.app/api/organizations/:id/applications/:applicationId/roles/:organizationRoleId",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the organization."
              },
              {
                "name": "applicationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the application."
              },
              {
                "name": "organizationRoleId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the organization role."
              }
            ]
          },
          "docs": "Remove a role from the application in the organization."
        },
        {
          "info": {
            "name": "Get organization JIT email domains",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://[tenant_id].logto.app/api/organizations/:id/jit/email-domains",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the organization."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page number (starts from 1)."
              },
              {
                "name": "page_size",
                "value": "",
                "type": "query",
                "description": "Entries per page."
              }
            ]
          },
          "docs": "Get email domains for just-in-time provisioning of users in the organization."
        },
        {
          "info": {
            "name": "Add organization JIT email domain",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://[tenant_id].logto.app/api/organizations/:id/jit/email-domains",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the organization."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Add a new email domain for just-in-time provisioning of users in the organization."
        },
        {
          "info": {
            "name": "Replace organization JIT email domains",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://[tenant_id].logto.app/api/organizations/:id/jit/email-domains",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the organization."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Replace all just-in-time provisioning email domains for the organization with the given data."
        },
        {
          "info": {
            "name": "Remove organization JIT email domain",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://[tenant_id].logto.app/api/organizations/:id/jit/email-domains/:emailDomain",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the organization."
              },
              {
                "name": "emailDomain",
                "value": "",
                "type": "path",
                "description": "The email domain to remove."
              }
            ]
          },
          "docs": "Remove an email domain for just-in-time provisioning of users in the organization."
        },
        {
          "info": {
            "name": "Get organization JIT default roles",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://[tenant_id].logto.app/api/organizations/:id/jit/roles",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the organization."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page number (starts from 1)."
              },
              {
                "name": "page_size",
                "value": "",
                "type": "query",
                "description": "Entries per page."
              }
            ]
          },
          "docs": "Get organization roles that will be assigned to users during just-in-time provisioning."
        },
        {
          "info": {
            "name": "Add organization JIT default roles",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://[tenant_id].logto.app/api/organizations/:id/jit/roles",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the organization."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Add new organization roles that will be assigned to users during just-in-time provisioning."
        },
        {
          "info": {
            "name": "Replace organization JIT default roles",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://[tenant_id].logto.app/api/organizations/:id/jit/roles",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the organization."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Replace all organization roles that will be assigned to users during just-in-time provisioning with the given data."
        },
        {
          "info": {
            "name": "Remove organization JIT default role",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://[tenant_id].logto.app/api/organizations/:id/jit/roles/:organizationRoleId",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the organization."
              },
              {
                "name": "organizationRoleId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the organization role."
              }
            ]
          },
          "docs": "Remove an organization role that will be assigned to users during just-in-time provisioning."
        },
        {
          "info": {
            "name": "Get organization JIT SSO connectors",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://[tenant_id].logto.app/api/organizations/:id/jit/sso-connectors",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the organization."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page number (starts from 1)."
              },
              {
                "name": "page_size",
                "value": "",
                "type": "query",
                "description": "Entries per page."
              }
            ]
          },
          "docs": "Get enterprise SSO connectors for just-in-time provisioning of users in the organization."
        },
        {
          "info": {
            "name": "Add organization JIT SSO connectors",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://[tenant_id].logto.app/api/organizations/:id/jit/sso-connectors",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the organization."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Add new enterprise SSO connectors for just-in-time provisioning of users in the organization."
        },
        {
          "info": {
            "name": "Replace organization JIT SSO connectors",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://[tenant_id].logto.app/api/organizations/:id/jit/sso-connectors",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the organization."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Replace all enterprise SSO connectors for just-in-time provisioning of users in the organization with the given data."
        },
        {
          "info": {
            "name": "Remove organization JIT SSO connector",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://[tenant_id].logto.app/api/organizations/:id/jit/sso-connectors/:ssoConnectorId",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the organization."
              },
              {
                "name": "ssoConnectorId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the sso connector."
              }
            ]
          },
          "docs": "Remove an enterprise SSO connector for just-in-time provisioning of users in the organization."
        }
      ]
    }
  ],
  "bundled": true
}