List Identities - Cloud Security API

{"type":"api","title":"List Identities","meta":{"id":"/apps/pubhub/media/cloud-security-apis-in-eft/83e8a10367d157243cd1c3e478b807cb81262a3d/55187620-d35e-353c-8340-4b81462250a3","info":{"version":"1.0.0","title":"Cisco Secure Access Identities Registration API","description":"Manage the Secure Access identity endpoints and security groups tags (SGTs) for the identities in the organization.","contact":{"name":"Cloud Security Developer Community"}},"security":[{"oauthFlow":[]}],"tags":[{"name":"Identities"},{"name":"Secure Access"}],"x-parser-conf":{"overview":{"markdownPath":"secure-access/reference/deployments/identities-registration-overview.md","uri":"secure-access-api-reference-identities-registration-overview"}},"openapi":"3.0.2","servers":[{"url":"https://api.sse.cisco.com/{basePath}","variables":{"basePath":{"default":"deployments/v2"}}}],"securitySchemes":{"oauthFlow":{"type":"oauth2","description":"The client credential flow.","flows":{"clientCredentials":{"tokenUrl":"https://api.sse.cisco.com/auth/v2/token","scopes":{"deployments.identities:read":"Read the identity endpoint or security group tag.","deployments.identities:write":"Update the identity endpoint or security group tag."}}}}}},"spec":{"tags":["Identities","Secure Access"],"summary":"List Identities","description":"Get the list of identity endpoints or security group tags (SGTs) for the identities in the organization.","operationId":"getIdentities","security":[{"oauthFlow":["deployments.identities:read"]}],"parameters":[{"name":"type","in":"path","description":"Use `device` to query the collection for the identity endpoints in the organization.\nUse `securityGroupTag` to query the collection for the security group tags in the organization.","required":true,"schema":{"type":"string","enum":["device","securityGroupTag"]},"$$ref":"#/components/parameters/type"},{"name":"label","in":"query","description":"The descriptive name of the identity endpoint or security group tag (SGT).","schema":{"type":"string"},"$$ref":"#/components/parameters/label"},{"in":"query","name":"offset","description":"The place to start reading in the collection. The default offset is `0`.","schema":{"type":"integer","format":"int64","default":0},"example":1,"$$ref":"#/components/parameters/offset"},{"in":"query","name":"limit","description":"The number of items to return in the page. The default limit is `100`.","schema":{"type":"integer","format":"int64","default":100,"minimum":1,"maximum":250},"example":25,"$$ref":"#/components/parameters/limit"}],"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","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","description":"The metadata for the response and the list of identity endpoints or security group tags in the collection.","required":["total","limit","offset","data"],"properties":{"total":{"type":"integer","description":"The total number of identities provisioned in the organization.","example":100,"$$ref":"#/components/schemas/total"},"limit":{"type":"integer","description":"The number of items returned in the page. The default value of the `limit` is `100`.","format":"int64","default":100,"minimum":1,"maximum":250,"example":25,"$$ref":"#/components/schemas/limit"},"offset":{"type":"integer","format":"int64","default":0,"description":"The place in the collection where the system started to read the resources. The default value of the `offset` is `0`.","example":1,"$$ref":"#/components/schemas/offset"},"data":{"type":"array","maxItems":250,"description":"The list of identities in the collection returned for either the `device` or `securityGroupTag` identity type.","items":{"oneOf":[{"type":"object","description":"The properties of the identity endpoint.","required":["key","label","status","authName","createdAt","modifiedAt"],"properties":{"key":{"type":"string","description":"The unique identifier specified in the UUID4 format. The key is used for all identity endpoints or security group tags.","example":"123e4567-e89b-12d3-a456-426614174001","$$ref":"#/components/schemas/key"},"label":{"type":"string","description":"The descriptive name assigned to the identity endpoint or security group tag.","example":"device one","$$ref":"#/components/schemas/label"},"status":{"type":"string","description":"The state of the identity endpoint or security group tag.","enum":["active","inactive"],"example":"active","$$ref":"#/components/schemas/status"},"authName":{"type":"string","description":"The attribute used to authenticate the identity endpoint.","example":"auth_device_beta","$$ref":"#/components/schemas/authName"},"createdAt":{"type":"integer","description":"The date and time in nanoseconds since the Unix Epoch when the system created the identity.","format":"int64","example":1753870525233159700,"$$ref":"#/components/schemas/createdAt"},"modifiedAt":{"type":"integer","description":"The date and time in nanoseconds since the Unix Epoch when the system updated the identity.","example":1753870525233159700,"$$ref":"#/components/schemas/modifiedAt"}},"example":{"key":"123e4567-e89b-12d3-a456-426614174001","label":"Device Alpha","status":"active","authName":"auth_device_alpha","createdAt":17538705252331596000,"modifiedAt":1753870525233159700},"$$ref":"#/components/schemas/IdentityEndpointsGetResponse"},{"type":"object","description":"The properties of the security group tag.","required":["key","label","status","tagId","createdAt","modifiedAt"],"properties":{"key":{"type":"string","description":"The unique identifier specified in the UUID4 format. The key is used for all identity endpoints or security group tags.","example":"123e4567-e89b-12d3-a456-426614174001","$$ref":"#/components/schemas/key"},"label":{"type":"string","description":"The descriptive name assigned to the identity endpoint or security group tag.","example":"device one","$$ref":"#/components/schemas/label"},"status":{"type":"string","description":"The state of the identity endpoint or security group tag.","enum":["active","inactive"],"example":"active","$$ref":"#/components/schemas/status"},"tagId":{"type":"integer","format":"int64","description":"The unique identifier of the security group tag.","$$ref":"#/components/schemas/tagId"},"createdAt":{"type":"integer","description":"The date and time in nanoseconds since the Unix Epoch when the system created the identity.","format":"int64","example":1753870525233159700,"$$ref":"#/components/schemas/createdAt"},"modifiedAt":{"type":"integer","description":"The date and time in nanoseconds since the Unix Epoch when the system updated the identity.","example":1753870525233159700,"$$ref":"#/components/schemas/modifiedAt"}},"example":{"key":"123e4567-e89b-12d3-a456-426614174001","label":"Device Alpha","status":"active","tagId":12345671234564266,"createdAt":17538705252331596000,"modifiedAt":1753870525233159700},"$$ref":"#/components/schemas/SecurityGroupTagIdentityGetResponse"}]},"example":[{"key":"123e4567-e89b-12d3-a456-426614174001","label":"Device Alpha","status":"active","authName":"auth_device_alpha","createdAt":17538705252331596000,"modifiedAt":1753870525233159700}],"$$ref":"#/components/schemas/IdentitiesGetResponse"}}},"example":{"total":2,"limit":100,"offset":1,"data":[{"key":"123e4567-e89b-12d3-a456-426614174001","label":"Device Alpha","status":"active","authName":"auth_device_alpha","createdAt":17538705252331596000,"modifiedAt":1753870525233159700},{"key":"123e4567-e89b-12d3-a456-426614174002","label":"Device Beta","status":"inactive","authName":"auth_device_beta","createdAt":1753870525233159700,"modifiedAt":1753870525233159700}]}}}},"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","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"text/plain":{"example":"Bad 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","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"text/plain":{"example":"Authentication failed."}},"$$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","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"text/plain":{"example":"Access denied."}},"$$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","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"text/plain":{"example":"Not Found"}},"$$ref":"#/components/responses/404Error"},"405":{"description":"Method Not Allowed","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","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"text/plain":{"example":"Method Not Allowed"}},"$$ref":"#/components/responses/405Error"},"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","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates if the request was successful."},"error":{"type":"string","description":"Error string translation if any."}},"example":{"success":false,"error":"Internal server error."}},"example":{"success":false,"error":"Internal server error."}}},"$$ref":"#/components/responses/500Error"}},"__originalOperationId":"getIdentities","method":"get","path":"/identities/registrations/{type}"}}