{"note":"OpenAPI conversion -- returning structured metadata","name":"frontegg-tenants","description":"Account Management Overview","version":"1.0","base_url":"https://api.frontegg.com/tenants","endpoints":25,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Account Management Overview\n@base https://api.frontegg.com/tenants\n@version 1.0\n@auth Bearer bearer\n@endpoints 25\n@hint download_for_search\n@toc resources(25)\n\n@endpoint GET /resources/tenants/v1/{tenantId}\n@desc Get account (tenant) by ID\n@required {tenantId: str # The account (tenant) ID to get.}\n@errors {400: When the account (tenant) ID does not pass the validation.}\n\n@endpoint PUT /resources/tenants/v1/{tenantId}\n@desc Update account (tenant)\n@required {tenantId: str}\n@errors {400: When body doesn't contain any property to change., 404: When given account (tenant) doesn't exist.}\n\n@endpoint DELETE /resources/tenants/v1/{tenantId}\n@desc Delete account (tenant)\n@required {tenantId: str}\n@errors {404: When the given account (tenant) doesn't exist.}\n\n@endpoint POST /resources/tenants/v1\n@desc Create an account (tenant)\n@optional {tenantId: str # Send your own unique tenantId or Frontegg will auto-generate a UUID, name: str, status: str # This field can be used for custom logic, it is not enforced in Frontegg flows, website: str, applicationUrl: str, logo: str # Base64-encoded image to use as logo., logoUrl: str, address: str, timezone: str, currency: str, creatorName: str, creatorEmail: str, isReseller: bool, parentTenantId: str}\n@errors {400: When the account (tenant) ID does not pass the validation.}\n\n@endpoint DELETE /resources/tenants/v1\n@desc Delete current account (tenant)\n@returns(200) When current account (tenant) has been removed.\n\n@endpoint POST /resources/tenants/v1/{tenantId}/metadata\n@desc Add account (tenant) metadata\n@required {tenantId: str, metadata: any}\n@errors {400: When the given metadata is neither a JSON, nor JSON-string., 404: When the given account (tenant) doesn't exist.}\n\n@endpoint DELETE /resources/tenants/v1/{tenantId}/metadata/{key}\n@desc Delete account (tenant) metadata\n@required {tenantId: str, key: str}\n@errors {404: When the provided account (tenant) doesn't exist.}\n\n@endpoint GET /resources/tenants/v2\n@desc Get accounts (tenants)\n@optional {_limit: num # The default limit is 50 accounts (tenants) per request, the maximum is 200, _offset: num, _filter: str # This param allows filtering the request using an account's name or tenantId, _sortBy: str # This param allows sorting the results via createdAt, name, tenantId, _order: str # This param can be used together with sortBy and define the order as ACS or DESC, _tenantIds: [str] # This param allows passing specific tenantIds and getting only these accounts (tenants) data}\n@returns(200)\n\n@endpoint GET /resources/tenants/v2/alias/{alias}\n@desc Get account (tenant) by alias\n@required {alias: str}\n@returns(200)\n\n@endpoint GET /resources/tenants/v2/{tenantId}\n@desc Get an account (tenant)\n@required {tenantId: str}\n@returns(200)\n\n@endpoint PUT /resources/tenants/v2/{tenantId}\n@desc Update an account (tenant)\n@required {tenantId: str}\n@returns(200)\n\n@endpoint POST /resources/sub-tenants/v1\n@desc Create sub-account\n@required {tenantId: str, name: str, parentTenantId: str}\n@optional {status: str # This field can be used for custom logic, it is not enforced in Frontegg flows, logo: str # Base64-encoded image to use as logo., logoUrl: str, creatorName: str, creatorEmail: str, isReseller: bool}\n@errors {400: When account (tenant) ID does not pass validation.}\n\n@endpoint PUT /resources/sub-tenants/v1/{tenantId}/management\n@desc Update sub-account (tenant) management\n@required {tenantId: str}\n@returns(200)\n\n@endpoint PUT /resources/sub-tenants/v1/{tenantId}/hierarchy-settings\n@desc Update sub-account hierarchy settings\n@required {tenantId: str}\n@returns(200)\n\n@endpoint DELETE /resources/sub-tenants/v1/{tenantId}\n@desc Delete a sub-account by ID\n@required {tenantId: str}\n@errors {404: When the given account (tenant) doesn't exist.}\n\n@endpoint GET /resources/account-settings/v1\n@desc Get account settings\n@required {frontegg-tenant-id: str # The account (tenant) ID identifier}\n@returns(200) Settings retrieved successfully\n@errors {404: When an account (tenant) with given ID does not exist.}\n\n@endpoint PUT /resources/account-settings/v1\n@desc Update account settings\n@required {frontegg-tenant-id: str # The account (tenant) ID identifier}\n@returns(200) Settings updated successfully\n@errors {400: When: a) given parameters do not pass validation b) empty object is passed in request content, 404: When an account (tenant) with given ID does not exist.}\n\n@endpoint GET /resources/account-settings/v1/public\n@desc Get public settings\n@required {frontegg-tenant-id: str # The account (tenant) ID identifier}\n@returns(200) Public settings retrieved successfully\n@errors {404: When an account (tenant) with given ID does not exist.}\n\n@endpoint POST /resources/migrations/v1/tenants\n@desc Migrate accounts (tenants)\n@required {tenants: [str]}\n@returns(202)\n\n@endpoint GET /resources/migrations/v1/tenants/status/{migrationId}\n@desc Accounts (tenants) migration status\n@required {migrationId: str}\n@returns(200)\n\n@endpoint GET /resources/hierarchy/v1\n@desc Get sub-accounts (tenants)\n@required {frontegg-tenant-id: str # The account (tenant) ID identifier}\n@returns(200)\n\n@endpoint POST /resources/hierarchy/v1\n@desc Create sub-account (tenant)\n@optional {parentTenantId: str, childTenantId: str}\n@errors {400: When:a) given parameters do not pass validationb) or parent and child account (tenant) are equal:c) or child account (tenant) is already a sub-account in other organization's hierarchy}\n\n@endpoint DELETE /resources/hierarchy/v1\n@desc Delete sub-account (tenant)\n@errors {400: When provided parameters do not pass validation., 404: When given accounts (tenants) are not in parent-child relation.}\n\n@endpoint GET /resources/hierarchy/v1/parents\n@desc Get parent accounts (tenants)\n@required {frontegg-tenant-id: str # The account (tenant) ID identifier}\n@returns(200)\n\n@endpoint GET /resources/hierarchy/v1/tree\n@desc Get sub-accounts (tenanants) hierarchy tree\n@required {frontegg-tenant-id: str # The account (tenant) ID identifier}\n@errors {400: When circular dependency is detected in the hierarchy}\n\n@end\n"}