{"type":"api","title":"Get Tenants","meta":{"id":"/apps/pubhub/media/edm-api-v2/a2a30bcc9ecab5281b65761ae61df7e0031d5691/f67a4e01-0023-334a-9a4a-7e606c2ef1a2","swagger":"2.0","info":{"contact":{"email":"devmgmt@cisco.com"},"description":"This is the IoT device management core service. The service is responsible for managing the lifecycle of various IoT gateways and endpoints deployed as part of the Field Area Networks","license":{"name":"Licensing is primarily subscription based. Call Andy now!","url":"https://www.cisco.com"},"termsOfService":"http://swagger.io/terms/","title":"IoT Device Lifecycle Management","version":"4.0.0"},"host":"us.ciscoiot.com","basePath":"/nbapi/edm/v1","schemes":["https"],"securityDefinitions":{"bearerAuth":{"description":"This is the bearer Auth token.","in":"header","name":"Authorization","type":"apiKey"}},"security":[{"bearerAuth":[]}],"x-parser-conf":{"apiKeyGenerator":{"$remoteModule":"./config/apikey.js"}}},"spec":{"description":"Return the list of tenants in the system. \u003cbr /\u003e One of the below permissions is needed to invoke this API\u003cbr /\u003e- Tenant Management","operationId":"getTenants","parameters":[{"description":"The uuid of the tenant in whose context we are calling the api.","format":"uuid","in":"header","name":"x-tenant-id","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"successful retrieval","schema":{"description":"contains details of a tenant.","properties":{"count":{"example":1},"tenants":{"items":{"properties":{"admins":{"example":["myadmin@cisco.com"]},"description":{"example":null},"id":{"example":"ea18dcee-667f-43d8-b0f4-bb0e01ea1b90"},"metadata":{"example":null},"mfaFlag":{"example":false},"name":{"example":"SA-POC Test"},"notification_history":{"example":null},"parent_tenant_id":{"example":"61685eca-24ce-4cfb-9828-56c644cecb3c"},"services":{"items":{"description":"contains details of a tenant.","properties":{"description":{"example":"Manage your network of devices."},"display_name":{"example":"Network Management"},"enabled":{"example":true},"name":{"example":"network-mgmt"},"uuid":{"example":"989cf627-c94a-4383-a83a-e2504f7c8137"}},"type":"object","$$ref":"#/definitions/TenantServicesVo"},"type":"array"},"status":{"example":"active"},"telemetryFlag":{"example":true}},"required":["results"],"type":"object","$$ref":"#/definitions/TenantEntryVo"},"type":"array"}},"$$ref":"#/definitions/TenantResVo"}},"400":{"description":"Bad request","schema":{"description":"Specifies the error that occurred during the request.","example":{"code":"10000","message":"Short message about the error","meta":"more information about that error"},"properties":{"code":{"description":"The error code that occurred in application level.","type":"number"},"message":{"description":"A user readable message that describes the error in details.","type":"string"},"meta":{"description":"Contains more information about the error message. For example when a validation error occurs, this field describes the fields that were invalid and the validation error that occurred. The content of this object can vary based on the type of error.\n","type":"object"}},"required":["code","message"],"type":"object","$$ref":"#/definitions/error"}},"401":{"description":"Unauthorized","schema":{"example":"Unauthorized","type":"string"}},"403":{"description":"Forbidden","schema":{"example":"Permission denied to access the resource","type":"string"}},"404":{"description":"Not found","schema":{"example":"Device not found","type":"string"}}},"summary":"Return the list of tenants in the system","tags":["tenants"],"__originalOperationId":"getTenants","security":[{"bearerAuth":[]}],"method":"get","path":"/tenants"}}