Tenant Admin Profile Management¶
Retrieve tenant admin list with details¶
-
GET/api/v1/tenants/(string: tenant_id)/admins/¶ Retrieve the tenant admin details.
Additional information:
- Response JSON Object:
admins (array) – A list of admins. See Tenant Admin Details.
Create an admin¶
-
POST/api/v1/tenants/(string: tenant_id)/admins/¶ Add a new tenant admin.
Additional requirements:
- Request JSON Object:
admin (object) – an admin object defined as Tenant Admin Details.
Retrieve admin details¶
-
GET/api/v1/tenants/(string: tenant_id)/admins/(string: user_id)/¶ Retrieve the tenant admin details.
Additional information:
- Response JSON Object:
admin (object) – an admin object defined as Tenant Admin Details.
Update admin details¶
-
PUT/api/v1/tenants/(string: tenant_id)/admins/(string: user_id)/¶ Update the tenant admin details.
Additional requirements:
- Request JSON Object:
admin (object) – an admin object defined as Tenant Admin Details.
Remove an admin¶
-
DELETE/api/v1/tenants/(string: tenant_id)/admins/(string: user_id)/¶ Delete an admin from the tenant.
Tenant Admin Details¶
Name |
Type |
Methods |
Description |
|||
|---|---|---|---|---|---|---|
GET |
POST |
PUT |
DELETE |
|||
userId |
String |
A |
R |
F |
F |
The unique id of the tenant admin if the network element allows/requires to specify it. |
firstName |
String |
A |
O |
O |
F |
The first name of the tenant admin. |
lastName |
String |
A |
O |
O |
F |
The last name of the tenant admin. |
language |
String |
A |
O |
O |
F |
The preferred language for the tenant admin. |
password |
String |
F |
O |
O |
F |
The password for a new tenant admin. |