{"type":"api","title":"List Tenants","meta":{"id":"/apps/pubhub/media/cloud-security-apis-in-eft/83e8a10367d157243cd1c3e478b807cb81262a3d/4256a582-1647-37dc-ad22-3c895445a2ee","info":{"title":"Cisco Secure Access Multi-Tenants API","description":"List the tenants in the Secure Access organization.","version":"1.0.0","contact":{"name":"Cloud Security Developer Community"}},"security":[{"oauthFlow":[]}],"tags":[{"name":"Tenants","description":"The tenants in the organization."},{"name":"Secure Access"}],"x-parser-conf":{"overview":{"markdownPath":"secure-access/reference/admin/multi-tenants-overview.md","uri":"secure-access-api-reference-multi-tenants-overview"}},"openapi":"3.0.3","servers":[{"url":"https://api.sse.cisco.com/{basePath}","variables":{"basePath":{"default":"admin/v2"}}}],"securitySchemes":{"oauthFlow":{"type":"oauth2","description":"The client credential flow.","flows":{"clientCredentials":{"tokenUrl":"https://api.sse.cisco.com/auth/v2/token","scopes":{"admin.tenants:read":"Read the tenant resources in the organization."}}}}}},"spec":{"tags":["Tenants","Secure Access"],"security":[{"oauthFlow":["admin.tenants:read"]}],"summary":"List Tenants","description":"List the tenants in the organization.","operationId":"listTenants","parameters":[{"in":"query","name":"organizationIds","required":true,"style":"form","explode":true,"schema":{"type":"string","pattern":"^\\d+(,\\d+)*$","example":"1234567,2345678,3123456,4234567"},"description":"A comma-separated list of IDs for the tenant organizations.","$$ref":"#/components/parameters/tenantIds"},{"in":"query","name":"optionalFields","required":false,"schema":{"type":"array","description":"The list of labels for the fields to filter the query.","items":{"type":"string","description":"The label for a field to filter the query."}},"description":"Optional fields to request additional data along with regular response.","$$ref":"#/components/parameters/optionalFields"},{"in":"query","name":"filters","description":"Filters that can be applied to the response by the system.","required":false,"schema":{"type":"object","description":"The properties of the tenant.","properties":{"organizationId":{"type":"integer","description":"Filter by the ID of the tenant."},"organizationName":{"type":"string","description":"Filter by the name of the tenant."}}},"$$ref":"#/components/parameters/filters"},{"in":"query","description":"The properties to sort the collection.","name":"sort","required":false,"schema":{"type":"object","description":"The properties to use when sorting the collection.","properties":{"order[organizationId]":{"type":"string","enum":["asc","desc"],"description":"The order to use when sorting the ID of the tenants.","example":"desc"},"order[organizationName]":{"type":"string","description":"The order to use when sorting the name of the tenants.","enum":["asc","desc"],"example":"asc"}}},"$$ref":"#/components/parameters/sort"}],"responses":{"200":{"description":"OK","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"array","description":"The list of tenants in the organization.","items":{"type":"object","description":"The properties of the tenant.","properties":{"organizationName":{"type":"string","description":"The legal or canonical name of the tenant.","minLength":1,"maxLength":255,"example":"NameOfCustomer","$$ref":"#/components/schemas/orgName"},"organizationId":{"type":"integer","description":"The unique identifier of the tenant.","example":1233,"$$ref":"#/components/schemas/orgId"}},"example":{"organizationId":8276505,"organizationName":"tenant one"},"$$ref":"#/components/schemas/TenantResponse"},"example":[{"organizationId":8276505,"organizationName":"tenant one"},{"organizationId":1235467,"organizationName":"tenant two"}],"$$ref":"#/components/schemas/TenantListResponse"},"example":[{"organizationId":1234567,"organizationName":"tenant one"}]}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Bad Request"}}}},"$$ref":"#/components/responses/400Error"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Unauthorized"}}}},"$$ref":"#/components/responses/401Error"},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Forbidden"}}}},"$$ref":"#/components/responses/403Error"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Not Found"}}}},"$$ref":"#/components/responses/404Error"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Internal Server error"}}}},"$$ref":"#/components/responses/500Error"}},"__originalOperationId":"listTenants","method":"get","path":"/tenants/list"}}