{"type":"api","title":"Unlock an user","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/c92e7384-b2f4-3d3b-8e8e-03a9325b07bb","info":{"title":"Crosswork RBAC API - Version 1","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"description":"Crosswork Role-based Access Control APIs","license":{"name":"Cisco Software License Agreement","url":"http://www.cisco.com/public/sw-license-agreement.html"},"version":"1.0.0"},"security":[{"bearerAuth":[]}],"x-parser-conf":{"overview":{"markdownPath":"reference/INFRA/RBAC/rbac-v1-overview.md"}},"swagger":"2.0","basePath":"/crosswork/aaa/v1","schemes":["https"],"securityDefinitions":{"bearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"Use a bearer token to authenticate requests. Include the token in the Authorization header with the prefix 'Bearer '."}}},"spec":{"summary":"Unlock an user.","description":"This API lock the user by updating the user status to Active.","operationId":"UsersUnLockPutReq","responses":{"204":{"description":"No Content. The request was successful and there is no additional content in the response body.","schema":{"type":"object","properties":{"rbacEmpty":{"type":"object"}},"$$ref":"#/definitions/rbacEmpty"}},"500":{"description":"Internal Server Error. The server could not fulfill the request."}},"parameters":[{"name":"body","description":"Updated specification for unlock an user.","in":"body","required":true,"schema":{"type":"object","additionalProperties":{"type":"object","title":"RBAC User Detail (with Actions)","description":"Comprehensive details for an RBAC user, including their profile, status, and dynamic action items.","properties":{"id":{"type":"integer","format":"int64","description":"The unique numerical identifier for the user."},"userName":{"type":"string","description":"The unique username for the account."},"role":{"type":"string","description":"The RBAC role assigned to this user."},"virtualDomains":{"type":"array","items":{"type":"object","properties":{"Uuid":{"type":"string","description":"The unique identifier (UUID) of the device access group."},"DomainName":{"type":"string","description":"The human-readable name of the domain, tenant, or network partition represented by this access group."},"Description":{"type":"string","description":"An optional descriptive text explaining the purpose or scope of this device access group."}},"title":"Device Access Groups are defined parts of the network, so that user access can be limited to the parts they are assigned.","$$ref":"#/definitions/rbacDeviceAccessGroup"},"description":"A list of virtual domains or device access groups to which this user has access."},"firstName":{"type":"string","description":"The first name of the user."},"lastName":{"type":"string","description":"The last name of the user."},"Status":{"type":"string","description":"The current status of the user account (e.g., 'Active', 'Locked', 'Inactive')."},"actionItems":{"description":"A collection of actions that can be performed on or by this user, often used for UI presentation.","type":"object","title":"RBAC User Action Items","properties":{"popoverActionClass":{"type":"string","description":"A CSS class or identifier for a UI popover action, if applicable."},"Items":{"type":"array","items":{"type":"object","title":"RBAC User Action Group","description":"A grouping of related actions available for a user.","properties":{"name":{"type":"string","description":"The name of the action group (can be an empty string if sub-items are directly listed without a group name)."},"items":{"type":"array","items":{"type":"object","title":"RBAC User Action","description":"Defines a single action that can be performed on a user, with its name and enablement status.","properties":{"name":{"type":"string","description":"The human-readable name of the action (e.g., 'Audit Log', 'Lock User')."},"enable":{"type":"boolean","description":"Indicates whether this action is currently enabled or available for the user. **Note:** Your example uses string 'true'/'false', but boolean is more standard for OpenAPI."}},"required":["name","enable"],"$$ref":"#/definitions/rbacUserAction"},"description":"A list of individual actions within this group."}},"required":["items"],"$$ref":"#/definitions/rbacUserActionGroup"},"description":"A list of action groups available for the user."}},"required":["Items"],"$$ref":"#/definitions/rbacUserActionItems"}},"required":["id","userName","role","virtualDomains","firstName","lastName","Status","actionItems"],"$$ref":"#/definitions/rbacUserDetail"},"example":{"peppa":{"id":5,"userName":"peppa","role":"sample","virtualDomains":[{"Uuid":"c2e38812-0955-4b36-ae94-4a87bf6533d7","DomainName":"ALL-ACCESS","Description":""}],"firstName":"Peppa","lastName":"Pig","Status":"Locked","actionItems":{"popoverActionClass":"","Items":[{"name":"","items":[{"name":"Audit Log","enable":"true"},{"name":"Lock User","enable":"false"},{"name":"Unlock User","enable":"true"}]}]}},"test1":{"id":6,"userName":"test1","role":"admin","virtualDomains":[{"Uuid":"c2e38812-0955-4b36-ae94-4a87bf6533d7","DomainName":"ALL-ACCESS","Description":""}],"firstName":"test1","lastName":"test1","Status":"Locked","actionItems":{"popoverActionClass":"","Items":[{"name":"","items":[{"name":"Audit Log","enable":"true"},{"name":"Lock User","enable":"false"},{"name":"Unlock User","enable":"true"}]}]}}},"$$ref":"#/definitions/rbacLockUnLockUserReq"}}],"tags":["rbac"],"__originalOperationId":"UsersUnLockPutReq","consumes":["application/json"],"produces":["application/json"],"security":[{"bearerAuth":[]}],"method":"put","path":"/unlockUsers"}}