Get Active Directory Groups - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Get Active Directory Groups","meta":{"id":"/apps/pubhub/media/cdo-api-documentation/cdbcd64e8c81b1f572dff1a1b687b52867178d60/9b0e4c9a-48cb-3530-a00a-1f32fbf2438c","info":{"title":"Cisco Security Cloud Control Firewall Manager API","version":"1.15.0","description":"Use the documentation to explore the endpoints Security Cloud Control Firewall Manager has to offer","contact":{"name":"Cisco Security Cloud Control TAC","email":"cdo.tac@cisco.com"}},"openapi":"3.0.1","servers":[{"url":"https://api.us.security.cisco.com/firewall","description":"US"},{"url":"https://api.eu.security.cisco.com/firewall","description":"EU"},{"url":"https://api.apj.security.cisco.com/firewall","description":"APJ"},{"url":"https://api.au.security.cisco.com/firewall","description":"AUS"},{"url":"https://api.in.security.cisco.com/firewall","description":"IN"},{"url":"https://api.int.security.cisco.com/firewall","description":"Staging"},{"url":"https://scale.manage.security.cisco.com/api/rest","description":"Scale"},{"url":"https://ci.manage.security.cisco.com/api/rest","description":"CI"},{"url":"https://manage.stg.secure.cisco/api/rest","description":"Stgf9"}],"securitySchemes":{"bearerAuth":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}}},"spec":{"description":"Get a list of active directory groups associated with the Security Cloud Control tenant.","operationId":"getActiveDirectoryGroups","parameters":[{"description":"The number of results to retrieve.","in":"query","name":"limit","required":false,"schema":{"maximum":200,"minimum":0,"type":"string"}},{"description":"The offset of the results retrieved. The Security Cloud Control API uses the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.","in":"query","name":"offset","required":false,"schema":{"minimum":0,"type":"string"}},{"description":"The query to execute. Use the Lucene Query Syntax to construct your query.","example":"fieldName:fieldValue","in":"query","name":"q","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total number of results available.","example":100,"format":"int32","type":"integer"},"items":{"description":"The list of items retrieved.","items":{"properties":{"groupIdentifier":{"description":"The unique identifier of the user group in your Identity Provider (IdP).","example":"7131daad-e813-4b8f-8f42-be1e241e8cdb","type":"string"},"issuerUrl":{"description":"The Identity Provider (IdP) URL, which Cisco Defense Orchestrator will use to validate SAML assertions during the sign-in process.","example":"https://access.example.com/saml2/idp/metadata.php","type":"string"},"name":{"description":"The name of the user group. Security Cloud Control does not support special characters for this field.","example":"myusername","type":"string"},"notes":{"description":"Any notes that are applicable to this user group.","example":"This is an example note on the user group.","type":"string"},"role":{"enum":["ROLE_ADMIN","ROLE_SUPER_ADMIN","ROLE_READ_ONLY","ROLE_DEPLOY_ONLY","ROLE_EDIT_ONLY","ROLE_VPN_SESSIONS_MANAGER","ROLE_FWAAS","ROLE_PASSIVE_IDENTITY_AGENT"],"type":"string","$$ref":"#/components/schemas/UserRole","description":"This determines the role for all the users included in this Active Directory Group.","example":"ROLE_ADMIN"},"uid":{"description":"The unique identifier, represented as a UUID, of the Active Directory Group in Security Cloud Control.","example":"7131daad-e813-4b8f-8f42-be1e241e8cdb","format":"uuid","type":"string"}},"type":"object","$$ref":"#/components/schemas/ActiveDirectoryGroup"},"type":"array"},"limit":{"description":"The number of results retrieved.","example":50,"format":"int32","type":"integer"},"offset":{"description":"The offset of the results retrieved. The Security Cloud Control API uses the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.","example":0,"format":"int32","type":"integer"}},"type":"object","$$ref":"#/components/schemas/ActiveDirectoryGroupPage"}}},"description":"List of Active Directory Group objects"},"400":{"content":{"application/json":{"schema":{"properties":{"details":{"additionalProperties":{"description":"Additional details, if any, on the error","example":{},"type":"object"},"description":"Additional details, if any, on the error","example":{},"type":"object"},"errorCode":{"description":"A unique code that describes the error.","enum":["INVALID_INPUT","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","CONFLICT","TOO_MANY_REQUESTS","SERVER_ERROR","PROXY_ERROR","BAD_REQUEST","UNPROCESSABLE_ENTITY"],"example":"INVALID_INPUT","type":"string"},"errorMsg":{"description":"A human-readable error description in English.","example":"sample error","type":"string"}},"$$ref":"#/components/schemas/CommonApiError"}}},"description":"Invalid input provided. Check the response for details.","$$ref":"#/components/responses/http400BadRequest"},"401":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A human-readable error description in English.","example":"invalid_token","type":"string"},"errorDescription":{"description":"A human-readable error description in English.","example":"Your token is invalid","type":"string"}},"$$ref":"#/components/schemas/AuthenticationError"}}},"description":"Request not authorized.","$$ref":"#/components/responses/http401Unauthorised"},"403":{"content":{"application/json":{"schema":{"properties":{"details":{"additionalProperties":{"description":"Additional details, if any, on the error","example":{},"type":"object"},"description":"Additional details, if any, on the error","example":{},"type":"object"},"errorCode":{"description":"A unique code that describes the error.","enum":["INVALID_INPUT","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","CONFLICT","TOO_MANY_REQUESTS","SERVER_ERROR","PROXY_ERROR","BAD_REQUEST","UNPROCESSABLE_ENTITY"],"example":"INVALID_INPUT","type":"string"},"errorMsg":{"description":"A human-readable error description in English.","example":"sample error","type":"string"}},"$$ref":"#/components/schemas/CommonApiError"}}},"description":"User does not have sufficient privileges to perform this operation.","$$ref":"#/components/responses/http403Forbidden"},"500":{"content":{"application/json":{"schema":{"properties":{"details":{"additionalProperties":{"description":"Additional details, if any, on the error","example":{},"type":"object"},"description":"Additional details, if any, on the error","example":{},"type":"object"},"errorCode":{"description":"A unique code that describes the error.","enum":["INVALID_INPUT","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","CONFLICT","TOO_MANY_REQUESTS","SERVER_ERROR","PROXY_ERROR","BAD_REQUEST","UNPROCESSABLE_ENTITY"],"example":"INVALID_INPUT","type":"string"},"errorMsg":{"description":"A human-readable error description in English.","example":"sample error","type":"string"}},"$$ref":"#/components/schemas/CommonApiError"}}},"description":"Internal server error."}},"security":[{"bearerAuth":[]}],"summary":"Get Active Directory Groups","tags":["Users"],"__originalOperationId":"getActiveDirectoryGroups","method":"get","path":"/v1/users/groups"}}