Create User in Security Cloud Control Tenant - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Create User in Security Cloud Control Tenant","meta":{"id":"/apps/pubhub/media/cdo-api-documentation/ee9bdf946673e45c4f256a22e0a754e29a9b2098/9b0e4c9a-48cb-3530-a00a-1f32fbf2438c","info":{"title":"Cisco Security Cloud Control Firewall Manager API","version":"1.15.0","description":"Use the documentation to explore the endpoints Security Cloud Control Firewall Manager has to offer","contact":{"name":"Cisco Security Cloud Control TAC","email":"cdo.tac@cisco.com"}},"openapi":"3.0.1","servers":[{"url":"https://api.us.security.cisco.com/firewall","description":"US"},{"url":"https://api.eu.security.cisco.com/firewall","description":"EU"},{"url":"https://api.apj.security.cisco.com/firewall","description":"APJ"},{"url":"https://api.au.security.cisco.com/firewall","description":"AUS"},{"url":"https://api.in.security.cisco.com/firewall","description":"IN"},{"url":"https://api.int.security.cisco.com/firewall","description":"Staging"},{"url":"https://scale.manage.security.cisco.com/api/rest","description":"Scale"},{"url":"https://ci.manage.security.cisco.com/api/rest","description":"CI"},{"url":"https://manage.stg.secure.cisco/api/rest","description":"Stgf9"}],"securitySchemes":{"bearerAuth":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}}},"spec":{"description":"Create a user in the Security Cloud Control enterprise and assigns the specified role for access to the Firewall Manager application.","operationId":"createUser","requestBody":{"content":{"application/json":{"schema":{"properties":{"apiOnlyUser":{"default":false,"description":"Whether the user is API-only, an API-only user cannot access Security Cloud Control in the UI.","example":false,"type":"boolean"},"firstName":{"description":"The first name of the user in Security Cloud Control. Note: This field must not be specified for API-only users.","example":"Ram","type":"string"},"lastName":{"description":"The last name of the user in Security Cloud Control. Note: This field must not be specified for API-only users.","example":"Singh","type":"string"},"name":{"description":"The name of the user in Security Cloud Control. This has to be a valid email if creating a human user, and must not be an email if creating an API-only user.","example":"myusername@cisco.com","minLength":1,"type":"string"},"role":{"description":"The user role in Security Cloud Control.","example":"ROLE_ADMIN","type":"string"}},"required":["name"],"type":"object","$$ref":"#/components/schemas/UserCreateOrUpdateInput"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"apiOnlyUser":{"description":"Whether the user is API-only, an API-only user cannot access Security Cloud Control in the UI.","example":false,"type":"boolean"},"emailAddress":{"description":"The e-mail address in Security Cloud Control.","example":"ram.singh@cisco.com","type":"string"},"firstName":{"description":"The first name of the user in Security Cloud Control.","example":"Ram","type":"string"},"lastName":{"description":"The last name of the user in Security Cloud Control.","example":"Singh","type":"string"},"lastSuccessfulLogin":{"description":"The time (UTC; represented using the RFC-3339 standard) that indicate the last time the user successfully logged in to Security Cloud Control.","example":"2023-12-13T05:15:44Z","format":"date-time","type":"string"},"name":{"deprecated":true,"description":"The username (e-mail address) in Security Cloud Control.","example":"ram.singh@cisco.com","type":"string"},"roles":{"description":"Roles associated with this user in Security Cloud Control.","example":"[ROLE_ADMIN]","items":{"enum":["ROLE_ADMIN","ROLE_SUPER_ADMIN","ROLE_READ_ONLY","ROLE_DEPLOY_ONLY","ROLE_EDIT_ONLY","ROLE_VPN_SESSIONS_MANAGER","ROLE_FWAAS","ROLE_PASSIVE_IDENTITY_AGENT"],"type":"string","$$ref":"#/components/schemas/UserRole"},"type":"array"},"uid":{"description":"The unique identifier of the user in Security Cloud Control.","example":"7131daad-e813-4b8f-8f42-be1e241e8cdb","type":"string"}},"type":"object","$$ref":"#/components/schemas/User"}}},"description":"User object"},"400":{"content":{"application/json":{"schema":{"properties":{"details":{"additionalProperties":{"description":"Additional details, if any, about the error.","example":{},"type":"object"},"description":"Additional details, if any, about the error.","example":{},"type":"object"},"errorCode":{"description":"Unique code that describes the error.","enum":["INVALID_INPUT","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","CONFLICT","TOO_MANY_REQUESTS","SERVER_ERROR","PROXY_ERROR","BAD_REQUEST","UNPROCESSABLE_ENTITY"],"example":"INVALID_INPUT","type":"string"},"errorMsg":{"description":"Human-readable error description in English.","example":"sample error","type":"string"}},"$$ref":"#/components/schemas/CommonApiError"}}},"description":"Invalid input provided. Check the response for details.","$$ref":"#/components/responses/http400BadRequest"},"401":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A human-readable error description in English.","example":"invalid_token","type":"string"},"errorDescription":{"description":"A human-readable error description in English.","example":"Your token is invalid","type":"string"}},"$$ref":"#/components/schemas/AuthenticationError"}}},"description":"Request not authorized.","$$ref":"#/components/responses/http401Unauthorised"},"403":{"content":{"application/json":{"schema":{"properties":{"details":{"additionalProperties":{"description":"Additional details, if any, about the error.","example":{},"type":"object"},"description":"Additional details, if any, about the error.","example":{},"type":"object"},"errorCode":{"description":"Unique code that describes the error.","enum":["INVALID_INPUT","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","CONFLICT","TOO_MANY_REQUESTS","SERVER_ERROR","PROXY_ERROR","BAD_REQUEST","UNPROCESSABLE_ENTITY"],"example":"INVALID_INPUT","type":"string"},"errorMsg":{"description":"Human-readable error description in English.","example":"sample error","type":"string"}},"$$ref":"#/components/schemas/CommonApiError"}}},"description":"User does not have sufficient privileges to perform this operation.","$$ref":"#/components/responses/http403Forbidden"},"500":{"content":{"application/json":{"schema":{"properties":{"details":{"additionalProperties":{"description":"Additional details, if any, about the error.","example":{},"type":"object"},"description":"Additional details, if any, about the error.","example":{},"type":"object"},"errorCode":{"description":"Unique code that describes the error.","enum":["INVALID_INPUT","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","CONFLICT","TOO_MANY_REQUESTS","SERVER_ERROR","PROXY_ERROR","BAD_REQUEST","UNPROCESSABLE_ENTITY"],"example":"INVALID_INPUT","type":"string"},"errorMsg":{"description":"Human-readable error description in English.","example":"sample error","type":"string"}},"$$ref":"#/components/schemas/CommonApiError"}}},"description":"Internal server error."}},"security":[{"bearerAuth":[]}],"summary":"Create User in Security Cloud Control Tenant","tags":["Users"],"__originalOperationId":"createUser","method":"post","path":"/v1/users"}}