@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Account Management Overview
@base https://api.frontegg.com/tenants
@version 1.0
@auth Bearer bearer
@endpoints 25
@hint download_for_search
@toc resources(25)

@endpoint GET /resources/tenants/v1/{tenantId}
@required {tenantId: str}
@errors {400}

@endpoint PUT /resources/tenants/v1/{tenantId}
@required {tenantId: str}
@errors {400, 404}

@endpoint DELETE /resources/tenants/v1/{tenantId}
@required {tenantId: str}
@errors {404}

@endpoint POST /resources/tenants/v1
@optional {tenantId: str, name: str, status: str, website: str, applicationUrl: str, logo: str, logoUrl: str, address: str, timezone: str, currency: str, creatorName: str, creatorEmail: str, isReseller: bool, parentTenantId: str}
@errors {400}

@endpoint DELETE /resources/tenants/v1
@returns(200)

@endpoint POST /resources/tenants/v1/{tenantId}/metadata
@required {tenantId: str, metadata: any}
@errors {400, 404}

@endpoint DELETE /resources/tenants/v1/{tenantId}/metadata/{key}
@required {tenantId: str, key: str}
@errors {404}

@endpoint GET /resources/tenants/v2
@optional {_limit: num, _offset: num, _filter: str, _sortBy: str, _order: str, _tenantIds: [str]}
@returns(200)

@endpoint GET /resources/tenants/v2/alias/{alias}
@required {alias: str}
@returns(200)

@endpoint GET /resources/tenants/v2/{tenantId}
@required {tenantId: str}
@returns(200)

@endpoint PUT /resources/tenants/v2/{tenantId}
@required {tenantId: str}
@returns(200)

@endpoint POST /resources/sub-tenants/v1
@required {tenantId: str, name: str, parentTenantId: str}
@optional {status: str, logo: str, logoUrl: str, creatorName: str, creatorEmail: str, isReseller: bool}
@errors {400}

@endpoint PUT /resources/sub-tenants/v1/{tenantId}/management
@required {tenantId: str}
@returns(200)

@endpoint PUT /resources/sub-tenants/v1/{tenantId}/hierarchy-settings
@required {tenantId: str}
@returns(200)

@endpoint DELETE /resources/sub-tenants/v1/{tenantId}
@required {tenantId: str}
@errors {404}

@endpoint GET /resources/account-settings/v1
@required {frontegg-tenant-id: str}
@returns(200)
@errors {404}

@endpoint PUT /resources/account-settings/v1
@required {frontegg-tenant-id: str}
@returns(200)
@errors {400, 404}

@endpoint GET /resources/account-settings/v1/public
@required {frontegg-tenant-id: str}
@returns(200)
@errors {404}

@endpoint POST /resources/migrations/v1/tenants
@required {tenants: [str]}
@returns(202)

@endpoint GET /resources/migrations/v1/tenants/status/{migrationId}
@required {migrationId: str}
@returns(200)

@endpoint GET /resources/hierarchy/v1
@required {frontegg-tenant-id: str}
@returns(200)

@endpoint POST /resources/hierarchy/v1
@optional {parentTenantId: str, childTenantId: str}
@errors {400}

@endpoint DELETE /resources/hierarchy/v1
@errors {400, 404}

@endpoint GET /resources/hierarchy/v1/parents
@required {frontegg-tenant-id: str}
@returns(200)

@endpoint GET /resources/hierarchy/v1/tree
@required {frontegg-tenant-id: str}
@errors {400}

@end