{"type":"api","title":"Unlock an user","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/e1ae91f25de62367ac175351487a12de3ae46a25/c92e7384-b2f4-3d3b-8e8e-03a9325b07bb","info":{"title":"Crosswork RBAC API - Version 1","description":"Crosswork Role-based Access Control APIs","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"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"}},"openapi":"3.0.1","servers":[{"url":"https://{cw_ip}:30603/crosswork/aaa/v1"}],"securitySchemes":{"bearerAuth":{"type":"apiKey","description":"Use a bearer token to authenticate requests. Include the token in the Authorization header with the prefix 'Bearer '.","name":"Authorization","in":"header"}}},"spec":{"tags":["rbac"],"summary":"Unlock an user.","description":"This API lock the user by updating the user status to Active.","operationId":"UsersUnLockPutReq","requestBody":{"description":"Updated specification for unlock an user.","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"title":"RBAC User Detail (with Actions)","required":["Status","actionItems","firstName","id","lastName","role","userName","virtualDomains"],"type":"object","properties":{"id":{"type":"integer","description":"The unique numerical identifier for the user.","format":"int64"},"userName":{"type":"string","description":"The unique username for the account."},"role":{"type":"string","description":"The RBAC role assigned to this user."},"virtualDomains":{"type":"array","description":"A list of virtual domains or device access groups to which this user has access.","items":{"title":"Device Access Groups are defined parts of the network, so that user access can be limited to the parts they are assigned.","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."}},"$$ref":"#/components/schemas/rbacDeviceAccessGroup"}},"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":{"title":"RBAC User Action Items","required":["Items"],"type":"object","properties":{"popoverActionClass":{"type":"string","description":"A CSS class or identifier for a UI popover action, if applicable."},"Items":{"type":"array","description":"A list of action groups available for the user.","items":{"title":"RBAC User Action Group","required":["items"],"type":"object","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","description":"A list of individual actions within this group.","items":{"title":"RBAC User Action","required":["enable","name"],"type":"object","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."}},"description":"Defines a single action that can be performed on a user, with its name and enablement status.","$$ref":"#/components/schemas/rbacUserAction"}}},"description":"A grouping of related actions available for a user.","$$ref":"#/components/schemas/rbacUserActionGroup"}}},"description":"Container for a user's available actions, often categorized or grouped for UI display.","$$ref":"#/components/schemas/rbacUserActionItems"}},"description":"Comprehensive details for an RBAC user, including their profile, status, and dynamic action items.","$$ref":"#/components/schemas/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":"#/components/schemas/rbacLockUnLockUserReq"}}},"required":true},"responses":{"204":{"description":"No Content. The request was successful and there is no additional content in the response body.","content":{"application/json":{"schema":{"type":"object","properties":{"rbacEmpty":{"type":"object","properties":{}}},"$$ref":"#/components/schemas/rbacEmpty"}}}},"500":{"description":"Internal Server Error. The server could not fulfill the request.","content":{}}},"x-codegen-request-body-name":"body","__originalOperationId":"UsersUnLockPutReq","security":[{"bearerAuth":[]}],"method":"put","path":"/unlockUsers"}}