Get Active Directory Groups - Security Cloud Control API Documentation

{"type":"api","title":"Get Active Directory Groups","meta":{"id":"/apps/pubhub/media/cdo-api-documentation/3cbd2b31d746744f0037786d8499488ecf93488c/9b0e4c9a-48cb-3530-a00a-1f32fbf2438c","info":{"title":"Cisco Security Cloud Control API","description":"Use the documentation to explore the endpoints Security Cloud Control has to offer","contact":{"name":"Cisco Security Cloud Control TAC","email":"cdo.tac@cisco.com"},"version":"1.5.0"},"tags":[{"name":"Cloud-delivered FMC","x-displayName":"Cloud-delivered FMC"},{"name":"Remote Access Monitoring","x-displayName":"Remote Access Monitoring"},{"name":"Users","x-displayName":"Users"},{"name":"Search","x-displayName":"Search"},{"name":"ASA Access Rules","x-displayName":"ASA Access Rules"},{"name":"Access Groups","x-displayName":"Access Groups"},{"name":"Inventory","x-displayName":"Inventory"},{"name":"Connectors","x-displayName":"Connectors"},{"name":"Command Line Interface","x-displayName":"Command Line Interface"},{"name":"Change Requests","x-displayName":"Change Requests"},{"name":"AI Assistant","x-displayName":"AI Assistant"},{"name":"Tenant Management","x-displayName":"Tenant Management"},{"name":"Meta","x-displayName":"Meta"},{"name":"Changelogs","x-displayName":"Changelogs"},{"name":"Audit Logs","x-displayName":"Audit Logs"},{"name":"swagger-redirect-controller","x-displayName":"swagger-redirect-controller"},{"name":"Object Management","x-displayName":"Object Management"},{"name":"MSP","x-displayName":"MSP"},{"name":"Transactions","x-displayName":"Transactions"}],"openapi":"3.0.1","servers":[{"url":"https://edge.us.cdo.cisco.com/api/rest","description":"US"},{"url":"https://edge.eu.cdo.cisco.com/api/rest","description":"EU"},{"url":"https://edge.apj.cdo.cisco.com/api/rest","description":"APJ"},{"url":"https://edge.aus.cdo.cisco.com/api/rest","description":"AUS"},{"url":"https://edge.in.cdo.cisco.com/api/rest","description":"IN"},{"url":"https://edge.staging.cdo.cisco.com/api/rest","description":"Staging"},{"url":"https://edge.scale.cdo.cisco.com/api/rest","description":"Scale"},{"url":"https://edge.ci.cdo.cisco.com/api/rest","description":"CI"}],"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}}},"spec":{"tags":["Users"],"summary":"Get Active Directory Groups","description":"Get a list of active directory groups associated with the Security Cloud Control tenant.","operationId":"getActiveDirectoryGroups","parameters":[{"name":"limit","in":"query","description":"The number of results to retrieve.","required":false,"schema":{"maximum":200,"minimum":0,"type":"string","default":"50"}},{"name":"offset","in":"query","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.","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"q","in":"query","description":"The query to execute. Use the Lucene Query Syntax to construct your query.","required":false,"schema":{"type":"string"},"example":"fieldName:fieldValue"}],"responses":{"200":{"description":"List of Active Directory Group objects","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"The total number of results available.","format":"int32","example":100},"limit":{"type":"integer","description":"The number of results retrieved.","format":"int32","example":50},"offset":{"type":"integer","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.","format":"int32","example":0},"items":{"type":"array","description":"The list of items retrieved.","items":{"type":"object","properties":{"uid":{"type":"string","description":"The unique identifier, represented as a UUID, of the Active Directory Group in Security Cloud Control.","format":"uuid","example":"7131daad-e813-4b8f-8f42-be1e241e8cdb"},"name":{"type":"string","description":"The name of the Active Directory Group. Security Cloud Control does not support special characters for this field.","example":"myusername"},"role":{"type":"string","description":"The role of the user this token belongs to. The user can be API-only or a human.","enum":["ROLE_ADMIN","ROLE_SUPER_ADMIN","ROLE_READ_ONLY","ROLE_DEPLOY_ONLY","ROLE_EDIT_ONLY","ROLE_VPN_SESSIONS_MANAGER","ROLE_FWAAS"],"$$ref":"#/components/schemas/UserRole"},"groupIdentifier":{"type":"string","description":"The unique identifier, represented as a UUID, of the Active Directory Group in your Identity Provider (IdP).","example":"7131daad-e813-4b8f-8f42-be1e241e8cdb"},"issuerUrl":{"type":"string","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"},"notes":{"type":"string","description":"Any notes that are applicable to this Active Directory Group.","example":"This is an example note on the Active Directory Group."}},"$$ref":"#/components/schemas/ActiveDirectoryGroup"}}},"$$ref":"#/components/schemas/ActiveDirectoryGroupPage"}}}},"400":{"description":"Invalid input provided. Check the response for details.","content":{"application/json":{"schema":{"type":"object","properties":{"errorCode":{"type":"string","description":"A unique code that describes the error.","example":"INVALID_INPUT","enum":["INVALID_INPUT","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","CONFLICT","TOO_MANY_REQUESTS","SERVER_ERROR","PROXY_ERROR","BAD_REQUEST"]},"errorMsg":{"type":"string","description":"A human-readable error description in English.","example":"sample error"},"details":{"type":"object","additionalProperties":{"type":"object","description":"Additional details, if any, on the error","example":{}},"description":"Additional details, if any, on the error","example":{}}},"$$ref":"#/components/schemas/CommonApiError"}}},"$$ref":"#/components/responses/http400BadRequest"},"401":{"description":"Request not authorized.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"A human-readable error description in English.","example":"invalid_token"},"errorDescription":{"type":"string","description":"A human-readable error description in English.","example":"Your token is invalid"}},"$$ref":"#/components/schemas/AuthenticationError"}}},"$$ref":"#/components/responses/http401Unauthorised"},"403":{"description":"User does not have sufficient privileges to perform this operation.","content":{"application/json":{"schema":{"type":"object","properties":{"errorCode":{"type":"string","description":"A unique code that describes the error.","example":"INVALID_INPUT","enum":["INVALID_INPUT","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","CONFLICT","TOO_MANY_REQUESTS","SERVER_ERROR","PROXY_ERROR","BAD_REQUEST"]},"errorMsg":{"type":"string","description":"A human-readable error description in English.","example":"sample error"},"details":{"type":"object","additionalProperties":{"type":"object","description":"Additional details, if any, on the error","example":{}},"description":"Additional details, if any, on the error","example":{}}},"$$ref":"#/components/schemas/CommonApiError"}}},"$$ref":"#/components/responses/http403Forbidden"},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"type":"object","properties":{"errorCode":{"type":"string","description":"A unique code that describes the error.","example":"INVALID_INPUT","enum":["INVALID_INPUT","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","CONFLICT","TOO_MANY_REQUESTS","SERVER_ERROR","PROXY_ERROR","BAD_REQUEST"]},"errorMsg":{"type":"string","description":"A human-readable error description in English.","example":"sample error"},"details":{"type":"object","additionalProperties":{"type":"object","description":"Additional details, if any, on the error","example":{}},"description":"Additional details, if any, on the error","example":{}}},"$$ref":"#/components/schemas/CommonApiError"}}}}},"security":[{"bearerAuth":[]}],"__originalOperationId":"getActiveDirectoryGroups","method":"get","path":"/v1/users/groups"}}