{"openapi":"3.0.3","info":{"title":"Vertex O Series User Management Public API Service","description":"Public API Service for Vertex O Series Instance User Configuration","version":"2.0.0","termsOfService":"https://www.vertexinc.com/terms-of-use","contact":{"name":"Vertex O Series Support","url":"http://www.vertexinc.com/support","email":"support@vertexinc.com"}},"x-readme":{"explorer-enabled":false,"proxy-enabled":true},"tags":[{"name":"UserMgmtController"}],"security":[{"BasicAuth":[]},{"Bearer":[]}],"servers":[{"url":"{baseUrl}/oseries-auth/{version}","variables":{"baseUrl":{"default":"http://localhost:8095"},"version":{"default":"v2"}}}],"paths":{"/users":{"get":{"tags":["UserMgmtController"],"summary":"Search for Users.","operationId":"getUsers","parameters":[{"name":"isDisabled","in":"query","required":false,"description":"Search for enabled vs disabled users.","schema":{"type":"boolean","example":false}},{"name":"username","in":"query","required":false,"description":"The username of the user to get.","schema":{"type":"string","example":"user1@vertexinc.com"}},{"name":"passwordExpirationDateMinimum","in":"query","required":false,"description":"Search for users with a password expiration date greater than or equal to the specified date.","schema":{"type":"string","format":"date","example":"2020-01-01"}},{"name":"passwordExpirationDateMaximum","in":"query","required":false,"description":"Search for users with a password expiration date less than or equal to the specified date.","schema":{"type":"string","format":"date","example":"2020-01-01"}},{"name":"roleUUID","in":"query","required":false,"description":"Search for users with specific role UUID.","schema":{"type":"string","format":"uuid","example":"37f038e2-22ec-4e5b-93f4-f065bea65542"}},{"name":"partitionUUID","in":"query","required":false,"description":"Search for users in this partition.","schema":{"type":"string","format":"uuid","example":"37f038e2-22ec-4e5b-93f4-f065bea65542"}}],"responses":{"200":{"description":"A List of Users.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/paths/~1users/post/requestBody/content/application~1json/schema"}}}}},"204":{"description":"No Users Found Matching Criteria"},"400":{"description":"Failed to Get Users","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","target"],"properties":{"code":{"type":"string","description":"One of a server-defined set of error codes","example":"VertexAuthenticationException"},"message":{"type":"string","description":"A human-readable representation of the error","example":"Access Token Expired"},"target":{"type":"string","description":"The target of the error","example":"/users"}}}}}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/paths/~1users/get/responses/400/content/application~1json/schema"}}}}}},"post":{"tags":["UserMgmtController"],"summary":"Creates a User.","operationId":"createUser","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","readOnly":true,"example":"37f038e2-22ec-4e5b-93f4-f065bea65542"},"username":{"type":"string","example":"user1@vertexinc.com"},"email":{"type":"string","format":"email","example":"user1@vertexinc.com"},"fullName":{"type":"string","example":"Joe Smith"},"isDisabled":{"type":"boolean","default":null,"example":true},"passwordExpirationDisabled":{"type":"boolean","default":null,"example":false},"defaultPartition":{"type":"object","required":["uuid"],"properties":{"uuid":{"type":"string","format":"uuid","example":"37f038e2-22ec-4e5b-93f4-f065bea65542"},"name":{"type":"string","example":"Vertex Cloud"}}},"partitionRoles":{"type":"array","items":{"type":"object","required":["partition","roles"],"properties":{"partition":{"$ref":"#/paths/~1users/post/requestBody/content/application~1json/schema/properties/defaultPartition"},"roles":{"type":"array","items":{"type":"object","required":["uuid"],"properties":{"uuid":{"type":"string","format":"uuid","example":"37f038e2-22ec-4e5b-93f4-f065bea65542"},"sourceId":{"type":"integer","format":"int64","default":null,"example":1},"name":{"type":"string","example":"User Role Name"},"description":{"type":"string","example":"User Role Description"}}}}}}},"password":{"type":"string","writeOnly":true},"passwordExpirationDate":{"type":"string","format":"date","example":"2020-01-01"},"isSSOUser":{"type":"boolean","default":null,"example":false},"isServiceAccount":{"type":"boolean","default":null,"example":false},"locale":{"type":"string","example":"en_US"}}}}}},"responses":{"200":{"description":"The User Created.","content":{"application/json":{"schema":{"$ref":"#/paths/~1users/post/requestBody/content/application~1json/schema"}}}},"400":{"description":"Failed to Create User","content":{"application/json":{"schema":{"$ref":"#/paths/~1users/get/responses/400/content/application~1json/schema"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/paths/~1users/get/responses/400/content/application~1json/schema"}}}}}}},"/users/{uuid}":{"get":{"tags":["UserMgmtController"],"summary":"Get a Specific User.","operationId":"getUser","parameters":[{"name":"uuid","in":"path","required":true,"description":"The UUID of the user to update","schema":{"type":"string","format":"uuid","example":"37f038e2-22ec-4e5b-93f4-f065bea65542"}}],"responses":{"200":{"description":"The User Searched For.","content":{"application/json":{"schema":{"$ref":"#/paths/~1users/post/requestBody/content/application~1json/schema"}}}},"400":{"description":"Failed to Get User","content":{"application/json":{"schema":{"$ref":"#/paths/~1users/get/responses/400/content/application~1json/schema"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/paths/~1users/get/responses/400/content/application~1json/schema"}}}},"404":{"description":"User Not Found"}}},"put":{"tags":["UserMgmtController"],"summary":"Update a User Overriding Fields.","operationId":"putUser","parameters":[{"name":"uuid","in":"path","required":true,"description":"The UUID of the user to update","schema":{"type":"string","format":"uuid","example":"37f038e2-22ec-4e5b-93f4-f065bea65542"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/paths/~1users/post/requestBody/content/application~1json/schema"}}}},"responses":{"200":{"description":"Updated User Successfully","content":{"application/json":{"schema":{"$ref":"#/paths/~1users/post/requestBody/content/application~1json/schema"}}}},"204":{"description":"No User Found to Update"},"400":{"description":"Failed to Update User","content":{"application/json":{"schema":{"$ref":"#/paths/~1users/get/responses/400/content/application~1json/schema"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/paths/~1users/get/responses/400/content/application~1json/schema"}}}}}}}},"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Bearer Token"},"BasicAuth":{"type":"http","scheme":"basic","description":"Basic Authentication"}}}}