Update Identities - Cloud Security API

{"type":"api","title":"Update 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":"Update Identities","description":"* Use the `PUT` operation to add a list of identity devices or security group tags (SGTs) in the organization. For each API operation, you can add 1–250 identity devices\n or security group tags.\n* Use the `PUT` operation to modify the properties of the identities registered in the organization.\n When you set the `status` field of an identity endpoint or security group tag to `inactive`, Secure Access makes the identity inactive in the organization\n and the identity is not managed or protected by the configured access rules and security controls in the Access policy.","operationId":"updateIdentities","security":[{"oauthFlow":["deployments.identities:write"]}],"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"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","description":"The list of the properties for the identity devices or security group tags.","maxItems":250,"items":{"description":"Provide an identity device for the list of identity devices.\nProvide a security group tag for the list of security group tags.","oneOf":[{"type":"object","description":"Update the properties of the identity device.","required":["key","label","status","authName"],"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"},"guidHash":{"type":"string","description":"The globally unique identifier for the Active Directory integration.","example":"11223-asd-213-zaas123-nasmomc","$$ref":"#/components/schemas/guidHash"},"domainName":{"type":"string","description":"The configured domain name for the identity device.","example":"abc.com"},"samAccountName":{"type":"string","description":"The configured SAM account name for the identity device.","example":"account name"}},"example":{"key":"123e4567-e89b-12d3-a456-426614174001","label":"Device one","status":"active","authName":"auth_device_one"},"$$ref":"#/components/schemas/UpdateIdentityDevices"},{"type":"object","description":"Update the properties of the security group tag.","required":["key","label","status","tagId"],"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"}},"example":{"key":"123e4567-e89b-12d3-a456-426614174001","label":"Device one","status":"active","tagId":12345671234564266},"$$ref":"#/components/schemas/UpdateSecurityGroupTags"}]}},"examples":{"example-devices":{"summary":"Example of the list of identity devices.","value":[{"key":"123e4567-e89b-12d3-a456-426614174001","label":"Device one","status":"active","authName":"auth_device_one"}]},"example-sgts":{"summary":"Example of the Security Group Tags.","value":[{"key":"123e4567-e89b-12d3-a456-426614174001","label":"Device one","status":"active","tagId":12345671234564266}]}}}},"$$ref":"#/components/requestBodies/UpdateIdentities"},"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","properties":{"success":{"type":"boolean","description":"Indicates whether the system updated the identities.","example":false}}},"example":{"success":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","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":"updateIdentities","method":"put","path":"/identities/registrations/{type}"}}