{"type":"api","title":"Get Organizations","meta":{"id":"/apps/pubhub/media/legacy-umbrella-api/bf58de618cbb72dda8f39b0414ce94c0a15cd467/8688476f-9746-3939-b4a0-6ecdd6ae8710","swagger":"2.0","info":{"version":"1.0.0","title":"Network Devices and Policies","description":"Management of Organizations, Network Devices, and Policies.","contact":{"name":"Cloud Security Developer Community"}},"host":"management.api.umbrella.com","basePath":"/v1","schemes":["https"],"securityDefinitions":{"http":{"type":"basic"}},"security":[{"http":[]}],"x-parser-conf":{"httpBasic":{"username":"","password":""},"overview":{"markdownPath":"legacy/management/network-devices-intro.md"},"meta":{"useProxy":true}}},"spec":{"tags":["Organizations"],"summary":"List Organizations","description":"Get the list of organization ID and name for the Umbrella API key.\nTo list the child organizations of a parent organization, provide\nan Umbrella API key for an MSP, MSSP, or ISP.","operationId":"getOrganizations","parameters":[{"name":"page","in":"query","description":"The number of the page to begin reading in the collection.","required":false,"default":1,"type":"integer","format":"int32","minimum":1,"$$ref":"#/parameters/paginationPageParam"},{"name":"limit","in":"query","description":"The maximum number of items to return from the collection.","required":false,"default":100,"type":"integer","format":"int32","minimum":1,"maximum":100,"$$ref":"#/parameters/paginationLimitParam"}],"produces":["application/json"],"responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"object","minProperties":2,"required":["organizationId","name"],"properties":{"organizationId":{"type":"integer","format":"int32","example":123456,"minimum":1,"description":"The ID of the organization."},"name":{"type":"string","example":"API Demo Organization","description":"The name of the organization as it appears in Umbrella.","minLength":1}}},"$$ref":"#/definitions/OrganizationsList"}},"400":{"description":"Validation Error","schema":{"type":"object","minProperties":3,"required":["statusCode","error","txId"],"properties":{"statusCode":{"type":"integer","example":400,"description":"the http error code returned."},"error":{"type":"string","example":"Validation Error","description":"a brief description of the error"},"txId":{"type":"string","example":"86e189a6-0124-47d3-a32c-25ff3f07deaf","description":"a unique hex number that can be used for debugging"},"validationErrors":{"type":"object","properties":{"someProperty":{"type":"string","example":"must not be empty","description":"the name of the property failing validation."}}}}},"$$ref":"#/responses/BadRequest"},"401":{"description":"Unauthorized- The authorization header is missing or the token is unauthorized","schema":{"type":"object","minProperties":3,"required":["statusCode","error","txId"],"properties":{"statusCode":{"type":"integer","example":401,"description":"the http error code returned."},"error":{"type":"string","example":"Unauthorized","description":"a brief description of the error"},"txId":{"type":"string","example":"86e189a6-0124-47d3-a32c-25ff3f07deaf","description":"a unique hex number that can be used for debugging"}}},"$$ref":"#/responses/Unauthorized"},"403":{"description":"Forbidden- The token is invalid","schema":{"type":"object","minProperties":1,"required":["message"],"properties":{"message":{"type":"string","example":"Invalid authentication credentials","description":"a brief description of the error"}}},"$$ref":"#/responses/Forbidden"},"404":{"description":"Not Found- A resource specified in the URL was not found","schema":{"type":"object","minProperties":3,"required":["statusCode","error","txId"],"properties":{"statusCode":{"type":"integer","example":404,"description":"the http error code returned."},"error":{"type":"string","example":"Not Found","description":"a brief description of the error"},"txId":{"type":"string","example":"86e189a6-0124-47d3-a32c-25ff3f07deaf","description":"a unique hex number that can be used for debugging"}}},"$$ref":"#/responses/NotFound"},"500":{"description":"Error- This request could not be processed by the server","schema":{"type":"object","minProperties":3,"required":["statusCode","error","txId"],"properties":{"statusCode":{"type":"integer","example":500,"description":"the http error code returned."},"error":{"type":"string","example":"Internal Server Error","description":"a brief description of the error"},"txId":{"type":"string","example":"86e189a6-0124-47d3-a32c-25ff3f07deaf","description":"a unique hex number that can be used for debugging"}}},"$$ref":"#/responses/ServerError"}},"__originalOperationId":"getOrganizations","consumes":["application/json"],"security":[{"http":[]}],"method":"get","path":"/organizations"}}