Skip to content

Commit

Permalink
update swagger baseline v5_2
Browse files Browse the repository at this point in the history
Signed-off-by: TomFitzpatrick <[email protected]>
  • Loading branch information
Tom-Fitzpatrick committed Dec 20, 2023
1 parent ea21068 commit 835f19a
Showing 1 changed file with 77 additions and 87 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -3606,23 +3606,23 @@
}
}
},
"/user/{loginname}" : {
"get" : {
"/user/otheruserpassword" : {
"post" : {
"tags" : [ "RBAC User API" ],
"description" : "This method returns a user based on the specified login name.",
"operationId" : "get_user__loginname_",
"parameters" : [ {
"name" : "loginname",
"in" : "path",
"description" : "The login name of the user to be returned",
"required" : true,
"schema" : {
"type" : "string",
"description" : "The login name of the user to be returned",
"nullable" : false,
"example" : "string"
}
} ],
"description" : "This method updates another user's password, only usable by admin.",
"operationId" : "post_user_otheruserpassword",
"parameters" : [ ],
"requestBody" : {
"description" : "requestBody",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ChangeOtherUserPasswordWrapperRequest"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "\n A user with the following attributes:\n id: Unique server generated identifier for the user\n version: The version of the user; version 0 is assigned to a newly created user\n updateTimestamp: The date and time when the user was last updated\n fullName: The full name for the new user\n loginName: The login name for the new user\n enabled: If true, the user account is enabled; false, the account is disabled\n ssoAuth: If true, the user account is enabled for SSO authentication; \n false, the account is enabled for password authentication\n passwordExpiry: The date and time when the password should expire, specified as an ISO-8601 string;\n value of null means that the password does not expire\n parentGroup: An optional identifier of the user group for the new user to be included;\n value of null means that the user will belong to the root group\n properties: An optional set of key/value properties associated with a user account\n roleAssociations: A set of roles associated with the user account",
Expand All @@ -3643,23 +3643,12 @@
}
}
},
"/user/{loginname}/otheruserpassword" : {
"/user/selfpassword" : {
"post" : {
"tags" : [ "RBAC User API" ],
"description" : "This method updates another user's password, only usable by admin.",
"operationId" : "post_user__loginname__otheruserpassword",
"parameters" : [ {
"name" : "loginname",
"in" : "path",
"description" : "The login name of the user who's password will be changed",
"required" : true,
"schema" : {
"type" : "string",
"description" : "The login name of the user who's password will be changed",
"nullable" : false,
"example" : "string"
}
} ],
"description" : "This method updates a users own password.",
"operationId" : "post_user_selfpassword",
"parameters" : [ ],
"requestBody" : {
"description" : "requestBody",
"content" : {
Expand Down Expand Up @@ -3699,6 +3688,43 @@
}
}
},
"/user/{loginname}" : {
"get" : {
"tags" : [ "RBAC User API" ],
"description" : "This method returns a user based on the specified login name.",
"operationId" : "get_user__loginname_",
"parameters" : [ {
"name" : "loginname",
"in" : "path",
"description" : "The login name of the user to be returned",
"required" : true,
"schema" : {
"type" : "string",
"description" : "The login name of the user to be returned",
"nullable" : false,
"example" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "\n A user with the following attributes:\n id: Unique server generated identifier for the user\n version: The version of the user; version 0 is assigned to a newly created user\n updateTimestamp: The date and time when the user was last updated\n fullName: The full name for the new user\n loginName: The login name for the new user\n enabled: If true, the user account is enabled; false, the account is disabled\n ssoAuth: If true, the user account is enabled for SSO authentication; \n false, the account is enabled for password authentication\n passwordExpiry: The date and time when the password should expire, specified as an ISO-8601 string;\n value of null means that the password does not expire\n parentGroup: An optional identifier of the user group for the new user to be included;\n value of null means that the user will belong to the root group\n properties: An optional set of key/value properties associated with a user account\n roleAssociations: A set of roles associated with the user account",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UserResponseType"
}
}
}
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
}
}
}
},
"/user/{loginname}/permissionsummary" : {
"get" : {
"tags" : [ "RBAC User API" ],
Expand Down Expand Up @@ -3830,62 +3856,6 @@
}
}
},
"/user/{loginname}/selfpassword" : {
"post" : {
"tags" : [ "RBAC User API" ],
"description" : "This method updates a users own password.",
"operationId" : "post_user__loginname__selfpassword",
"parameters" : [ {
"name" : "loginname",
"in" : "path",
"description" : "The login name of the user.",
"required" : true,
"schema" : {
"type" : "string",
"description" : "The login name of the user.",
"nullable" : false,
"example" : "string"
}
} ],
"requestBody" : {
"description" : "requestBody",
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"password" : {
"type" : "string",
"description" : "The new password to apply.",
"nullable" : false,
"example" : "string"
}
}
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "\n A user with the following attributes:\n id: Unique server generated identifier for the user\n version: The version of the user; version 0 is assigned to a newly created user\n updateTimestamp: The date and time when the user was last updated\n fullName: The full name for the new user\n loginName: The login name for the new user\n enabled: If true, the user account is enabled; false, the account is disabled\n ssoAuth: If true, the user account is enabled for SSO authentication; \n false, the account is enabled for password authentication\n passwordExpiry: The date and time when the password should expire, specified as an ISO-8601 string;\n value of null means that the password does not expire\n parentGroup: An optional identifier of the user group for the new user to be included;\n value of null means that the user will belong to the root group\n properties: An optional set of key/value properties associated with a user account\n roleAssociations: A set of roles associated with the user account",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UserResponseType"
}
}
}
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
}
}
}
},
"/virtualnode" : {
"get" : {
"tags" : [ "Virtual Node API" ],
Expand Down Expand Up @@ -4487,6 +4457,26 @@
}
}
},
"ChangeOtherUserPasswordWrapperRequest" : {
"required" : [ "password", "username" ],
"type" : "object",
"properties" : {
"password" : {
"type" : "string",
"description" : "The new password to apply.",
"nullable" : false,
"example" : "string"
},
"username" : {
"type" : "string",
"description" : "Username for the password change.",
"nullable" : false,
"example" : "string"
}
},
"description" : "ChangeOtherUserPasswordWrapperRequest",
"nullable" : false
},
"ChangeVirtualNodeStateResponse" : {
"required" : [ "holdingIdShortHash", "newState" ],
"type" : "object",
Expand Down

0 comments on commit 835f19a

Please sign in to comment.