This API provides utilities to manage IAS tenants.
Overview
-
Description: A set of utilities to manage the UCX Suite tenants.
Base URL & Authentication
-
Base URL:
https://{host}/fw/Apps/ApplicationSuite/WebAPI-
The
{host}variable represents the UCX Suite server hostname or IP address.
-
-
Authentication:
All endpoints require HTTP Basic Authentication. You must include an Authorization header with your username and password encoded in Base64.Example header:
Authorization: Basic {base64(username:password)}
UCX Suite Tenants List
GET /Tenants/
-
HTTP Method: GET
-
URL:
/Tenants/
Request
-
Authentication: Required (Basic Auth via UserSecurity)
-
Parameters: None
Response
-
200 OK:
Returns a JSON array of tenant objects. Each tenant contains:-
id (string): Tenant id
Example:"6649e002-65ec-4eab-a4d6-7f3d493a1311" -
name (string): Tenant name
Example:"ACME"
-
-
Error Responses:
-
401 Unauthorized: Missing or invalid authentication credentials.
-
403 Forbidden: Authenticated user does not have the required privileges.
-
500 Internal Server Error: An error occurred while processing the request.
-
Security Schemes
-
UserSecurity:
-
Type: HTTP
-
Scheme: Basic
-