{"type":"api","title":"Get Information About Organizations","meta":{"id":"/apps/pubhub/media/cloud-security-apis-in-eft/9d37d008417d562ab46d4b67547a68457ce288d2/c24e887e-1827-3004-af8d-fdd6677097c8","info":{"title":"Cisco Umbrella Users and Roles API","version":"2.0.0","description":"Manage the Umbrella user accounts and roles.","contact":{"name":"Cloud Security Developer Community"}},"security":[{"oauthFlow":[]}],"tags":[{"name":"Users"},{"name":"Roles"},{"name":"Umbrella"}],"x-parser-conf":{"overview":{"markdownPath":"reference/admin/users-roles-overview.md","uri":"umbrella-api-reference-users-roles-overview"}},"openapi":"3.0.1","servers":[{"url":"https://api.umbrella.com/{basePath}","variables":{"basePath":{"default":"admin/v2"}}}],"securitySchemes":{"oauthFlow":{"type":"oauth2","description":"client credential flow","flows":{"clientCredentials":{"tokenUrl":"https://api.umbrella.com/auth/v2/token","scopes":{"admin.users:read":"Read admin users","admin.users:write":"Write admin users","admin.roles:read":"Read admin roles","admin.passwordreset:write":"Write admin passwords","admin.organizations:write":"Read admin organizations"}}}}}},"spec":{"tags":["Users","Umbrella"],"description":"Get information about your provider organizations.\nTo query the collection, provide an email address for a member of an Umbrella provider organization.","summary":"Get Information About Organizations","operationId":"getOrganizationInformation","security":[{"oauthFlow":["admin.organizations:read"]}],"parameters":[{"in":"query","name":"email","description":"The email address for a member of a provider organization.","required":true,"schema":{"type":"string"},"example":"name@cisco.com","$$ref":"#/components/parameters/emailParam"},{"name":"page","in":"query","description":"The number of a page in the collection.","schema":{"type":"integer","format":"int32","default":1,"minimum":1},"required":false,"example":2,"$$ref":"#/components/parameters/pageParam"},{"in":"query","name":"offset","required":false,"description":"The place to start reading in the collection. The default offset is 0.","schema":{"type":"integer","format":"int64","default":0},"example":10,"$$ref":"#/components/parameters/offsetParam"},{"name":"limit","in":"query","description":"The number of records from the collection to return on the page.","required":false,"schema":{"default":100,"type":"integer","format":"int32","minimum":1,"maximum":100},"example":50,"$$ref":"#/components/parameters/limitParam"}],"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","format":"iso-date-time"},"description":"The date and time of the request that is represented in ISO 8601 format.\nThe timestamp uses Greenwich Mean Time (GMT).","example":"Date: Mon, 18 Apr 2022 11:11:11 GMT","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","required":["mspOrganizationId","organizationId","organizationName","organizationTypeId"],"properties":{"organizationId":{"type":"integer","format":"int32","description":"The organization ID.","example":2622114},"originId":{"type":"integer","description":"The origin ID.","format":"int32","example":299707978},"resellerId":{"type":"integer","description":"The reseller ID.","example":0},"creatorUserId":{"type":"integer","description":"The user ID of the creator.","example":100000},"accountManagerUserId":{"type":"integer","description":"The user ID of the account manager.","example":0},"organizationName":{"type":"string","description":"The name of the organization.","example":"GTS Test - MSSP Console"},"website":{"type":"string","description":"The URL for the organization.","example":"cisco.com"},"mspOrganizationId":{"type":"integer","format":"int32","description":"The managed service provider (MSP) ID.","example":12345698},"organizationTypeId":{"type":"integer","format":"int32","description":"The type ID of the organization.","example":4},"createdAt":{"type":"integer","format":"int32","description":"The date when the organization was created.","example":1565986232},"modifiedAt":{"type":"integer","format":"int32","description":"The date when the organization was last modified.","example":1585081693},"salesforceAccountId":{"type":"string","description":"The Salesforce account ID.","example":"0011T00002QfUGgQAN"},"hasDelegatedAdmin":{"type":"boolean","description":"Specifies whether the organization has assigned an administrator.","example":true}},"example":{"organizationId":2622114,"originId":299707978,"resellerId":0,"creatorUserId":100000,"accountManagerUserId":0,"organizationName":"GTS Test - MSSP Console","website":"cisco.com","mspOrganizationId":1223445,"organizationTypeId":4,"createdAt":1565986232,"modifiedAt":1585081693,"salesforceAccountId":"0011T00002QfUGgQAN","hasDelegatedAdmin":true},"$$ref":"#/components/schemas/OrgInformation"}},"example":[{"organizationId":2622114,"originId":299707978,"resellerId":0,"creatorUserId":100000,"accountManagerUserId":0,"organizationName":"GTS - MSSP Console","website":"cisco.com","mspOrganizationId":0,"organizationTypeId":1,"createdAt":1565986232,"modifiedAt":1585081693,"salesforceAccountId":"0011T00002QfUGgQAN","hasDelegatedAdmin":true}]}}},"400":{"description":"Bad Request","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","format":"iso-date-time"},"description":"The date and time of the request that is represented in ISO 8601 format.\nThe timestamp uses Greenwich Mean Time (GMT).","example":"Date: Mon, 18 Apr 2022 11:11:11 GMT","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}},"example":{"message":"Invalid request"}}},"$$ref":"#/components/responses/400Error"},"401":{"description":"Unauthorized","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","format":"iso-date-time"},"description":"The date and time of the request that is represented in ISO 8601 format.\nThe timestamp uses Greenwich Mean Time (GMT).","example":"Date: Mon, 18 Apr 2022 11:11:11 GMT","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}},"example":{"message":"Unauthorized request"}}},"$$ref":"#/components/responses/401Error"},"403":{"description":"Forbidden","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","format":"iso-date-time"},"description":"The date and time of the request that is represented in ISO 8601 format.\nThe timestamp uses Greenwich Mean Time (GMT).","example":"Date: Mon, 18 Apr 2022 11:11:11 GMT","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}},"example":{"message":"Forbidden"}}},"$$ref":"#/components/responses/403Error"},"404":{"description":"Not Found","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","format":"iso-date-time"},"description":"The date and time of the request that is represented in ISO 8601 format.\nThe timestamp uses Greenwich Mean Time (GMT).","example":"Date: Mon, 18 Apr 2022 11:11:11 GMT","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}},"example":{"message":"The user identified by the email address\ndoes not exist in the organization."}}},"$$ref":"#/components/responses/404EmailError"},"500":{"description":"Internal Server Error","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","format":"iso-date-time"},"description":"The date and time of the request that is represented in ISO 8601 format.\nThe timestamp uses Greenwich Mean Time (GMT).","example":"Date: Mon, 18 Apr 2022 11:11:11 GMT","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}},"example":{"message":"Server error"}}},"$$ref":"#/components/responses/500Error"}},"__originalOperationId":"getOrganizationInformation","method":"get","path":"/organizations"}}