org.openmetadata.client.api.UsersApi Maven / Gradle / Ivy
package org.openmetadata.client.api;
import org.openmetadata.client.ApiClient;
import org.openmetadata.client.EncodingUtils;
import org.openmetadata.client.model.ApiResponse;
import org.openmetadata.client.model.AuthenticationMechanism;
import org.openmetadata.client.model.ChangePasswordRequest;
import org.openmetadata.client.model.CreatePersonalToken;
import org.openmetadata.client.model.CreateUser;
import org.openmetadata.client.model.CsvImportResult;
import org.openmetadata.client.model.EmailRequest;
import org.openmetadata.client.model.EntityHistory;
import org.openmetadata.client.model.EntityReference;
import org.openmetadata.client.model.GenerateTokenRequest;
import org.openmetadata.client.model.JWTAuthMechanism;
import org.openmetadata.client.model.JwtResponse;
import org.openmetadata.client.model.LoginRequest;
import org.openmetadata.client.model.LogoutRequest;
import org.openmetadata.client.model.PasswordResetRequest;
import org.openmetadata.client.model.PersonalAccessToken;
import org.openmetadata.client.model.PersonalAccessTokenList;
import org.openmetadata.client.model.RegistrationRequest;
import org.openmetadata.client.model.RestoreEntity;
import org.openmetadata.client.model.RevokePersonalTokenRequest;
import org.openmetadata.client.model.RevokeTokenRequest;
import org.openmetadata.client.model.TokenRefreshRequest;
import java.util.UUID;
import org.openmetadata.client.model.User;
import org.openmetadata.client.model.UserList;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import feign.*;
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-07-03T19:44:33.436780642Z[Etc/UTC]")
public interface UsersApi extends ApiClient.Api {
/**
* Change Password For User
* Create a new user.
* @param changePasswordRequest (optional)
* @return User
*/
@RequestLine("PUT /v1/users/changePassword")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
User changeUserPassword(ChangePasswordRequest changePasswordRequest);
/**
* Change Password For User
* Similar to changeUserPassword but it also returns the http response headers .
* Create a new user.
* @param changePasswordRequest (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("PUT /v1/users/changePassword")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse changeUserPasswordWithHttpInfo(ChangePasswordRequest changePasswordRequest);
/**
* Check if a email is already in use
* Check if a email is already in use
* @param emailRequest (optional)
* @return Boolean
*/
@RequestLine("POST /v1/users/checkEmailInUse")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
Boolean checkEmailInUse(EmailRequest emailRequest);
/**
* Check if a email is already in use
* Similar to checkEmailInUse but it also returns the http response headers .
* Check if a email is already in use
* @param emailRequest (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("POST /v1/users/checkEmailInUse")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse checkEmailInUseWithHttpInfo(EmailRequest emailRequest);
/**
* Check if a mail is verified
* Check if a mail is already in use
* @param emailRequest (optional)
* @return Boolean
*/
@RequestLine("POST /v1/users/checkEmailVerified")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
Boolean checkEmailIsVerified(EmailRequest emailRequest);
/**
* Check if a mail is verified
* Similar to checkEmailIsVerified but it also returns the http response headers .
* Check if a mail is already in use
* @param emailRequest (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("POST /v1/users/checkEmailVerified")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse checkEmailIsVerifiedWithHttpInfo(EmailRequest emailRequest);
/**
* Confirm User Email
* Confirm User Email
* @param token Token sent for Email Confirmation (optional)
*/
@RequestLine("PUT /v1/users/registrationConfirmation?token={token}")
@Headers({
"Accept: application/json",
})
void confirmUserEmail(@Param("token") String token);
/**
* Confirm User Email
* Similar to confirmUserEmail but it also returns the http response headers .
* Confirm User Email
* @param token Token sent for Email Confirmation (optional)
*/
@RequestLine("PUT /v1/users/registrationConfirmation?token={token}")
@Headers({
"Accept: application/json",
})
ApiResponse confirmUserEmailWithHttpInfo(@Param("token") String token);
/**
* Confirm User Email
* Confirm User Email
* Note, this is equivalent to the other confirmUserEmail method,
* but with the query parameters collected into a single Map parameter. This
* is convenient for services with optional query parameters, especially when
* used with the {@link ConfirmUserEmailQueryParams} class that allows for
* building up this map in a fluent style.
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - token - Token sent for Email Confirmation (optional)
*
*/
@RequestLine("PUT /v1/users/registrationConfirmation?token={token}")
@Headers({
"Accept: application/json",
})
void confirmUserEmail(@QueryMap(encoded=true) ConfirmUserEmailQueryParams queryParams);
/**
* Confirm User Email
* Confirm User Email
* Note, this is equivalent to the other confirmUserEmail that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - token - Token sent for Email Confirmation (optional)
*
*/
@RequestLine("PUT /v1/users/registrationConfirmation?token={token}")
@Headers({
"Accept: application/json",
})
ApiResponse confirmUserEmailWithHttpInfo(@QueryMap(encoded=true) ConfirmUserEmailQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* confirmUserEmail method in a fluent style.
*/
public static class ConfirmUserEmailQueryParams extends HashMap {
public ConfirmUserEmailQueryParams token(final String value) {
put("token", EncodingUtils.encode(value));
return this;
}
}
/**
* Update user
* Create or Update a user.
* @param createUser (optional)
* @return CreateUser
*/
@RequestLine("PUT /v1/users")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
CreateUser createOrUpdateUser(CreateUser createUser);
/**
* Update user
* Similar to createOrUpdateUser but it also returns the http response headers .
* Create or Update a user.
* @param createUser (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("PUT /v1/users")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse createOrUpdateUserWithHttpInfo(CreateUser createUser);
/**
* Provide access token to User
* Provide access token to User
* @param createPersonalToken (optional)
* @return PersonalAccessToken
*/
@RequestLine("PUT /v1/users/security/token")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
PersonalAccessToken createPersonalAccessToken(CreatePersonalToken createPersonalToken);
/**
* Provide access token to User
* Similar to createPersonalAccessToken but it also returns the http response headers .
* Provide access token to User
* @param createPersonalToken (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("PUT /v1/users/security/token")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse createPersonalAccessTokenWithHttpInfo(CreatePersonalToken createPersonalToken);
/**
* Create a user
* Create a new user.
* @param createUser (optional)
* @return User
*/
@RequestLine("POST /v1/users")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
User createUser(CreateUser createUser);
/**
* Create a user
* Similar to createUser but it also returns the http response headers .
* Create a new user.
* @param createUser (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("POST /v1/users")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse createUserWithHttpInfo(CreateUser createUser);
/**
* Delete a user
* Users can't be deleted but are soft-deleted.
* @param id Id of the user (required)
* @param hardDelete Hard delete the entity. (Default = `false`) (optional, default to false)
*/
@RequestLine("DELETE /v1/users/{id}?hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
void deleteUser(@Param("id") UUID id, @Param("hardDelete") Boolean hardDelete);
/**
* Delete a user
* Similar to deleteUser but it also returns the http response headers .
* Users can't be deleted but are soft-deleted.
* @param id Id of the user (required)
* @param hardDelete Hard delete the entity. (Default = `false`) (optional, default to false)
*/
@RequestLine("DELETE /v1/users/{id}?hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteUserWithHttpInfo(@Param("id") UUID id, @Param("hardDelete") Boolean hardDelete);
/**
* Delete a user
* Users can't be deleted but are soft-deleted.
* Note, this is equivalent to the other deleteUser method,
* but with the query parameters collected into a single Map parameter. This
* is convenient for services with optional query parameters, especially when
* used with the {@link DeleteUserQueryParams} class that allows for
* building up this map in a fluent style.
* @param id Id of the user (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - hardDelete - Hard delete the entity. (Default = `false`) (optional, default to false)
*
*/
@RequestLine("DELETE /v1/users/{id}?hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
void deleteUser(@Param("id") UUID id, @QueryMap(encoded=true) DeleteUserQueryParams queryParams);
/**
* Delete a user
* Users can't be deleted but are soft-deleted.
* Note, this is equivalent to the other deleteUser that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param id Id of the user (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - hardDelete - Hard delete the entity. (Default = `false`) (optional, default to false)
*
*/
@RequestLine("DELETE /v1/users/{id}?hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteUserWithHttpInfo(@Param("id") UUID id, @QueryMap(encoded=true) DeleteUserQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* deleteUser method in a fluent style.
*/
public static class DeleteUserQueryParams extends HashMap {
public DeleteUserQueryParams hardDelete(final Boolean value) {
put("hardDelete", EncodingUtils.encode(value));
return this;
}
}
/**
* Delete a user
* Users can't be deleted but are soft-deleted.
* @param name Name of the user (required)
* @param hardDelete Hard delete the entity. (Default = `false`) (optional, default to false)
*/
@RequestLine("DELETE /v1/users/name/{name}?hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
void deleteUserByName(@Param("name") String name, @Param("hardDelete") Boolean hardDelete);
/**
* Delete a user
* Similar to deleteUserByName but it also returns the http response headers .
* Users can't be deleted but are soft-deleted.
* @param name Name of the user (required)
* @param hardDelete Hard delete the entity. (Default = `false`) (optional, default to false)
*/
@RequestLine("DELETE /v1/users/name/{name}?hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteUserByNameWithHttpInfo(@Param("name") String name, @Param("hardDelete") Boolean hardDelete);
/**
* Delete a user
* Users can't be deleted but are soft-deleted.
* Note, this is equivalent to the other deleteUserByName method,
* but with the query parameters collected into a single Map parameter. This
* is convenient for services with optional query parameters, especially when
* used with the {@link DeleteUserByNameQueryParams} class that allows for
* building up this map in a fluent style.
* @param name Name of the user (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - hardDelete - Hard delete the entity. (Default = `false`) (optional, default to false)
*
*/
@RequestLine("DELETE /v1/users/name/{name}?hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
void deleteUserByName(@Param("name") String name, @QueryMap(encoded=true) DeleteUserByNameQueryParams queryParams);
/**
* Delete a user
* Users can't be deleted but are soft-deleted.
* Note, this is equivalent to the other deleteUserByName that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param name Name of the user (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - hardDelete - Hard delete the entity. (Default = `false`) (optional, default to false)
*
*/
@RequestLine("DELETE /v1/users/name/{name}?hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteUserByNameWithHttpInfo(@Param("name") String name, @QueryMap(encoded=true) DeleteUserByNameQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* deleteUserByName method in a fluent style.
*/
public static class DeleteUserByNameQueryParams extends HashMap {
public DeleteUserByNameQueryParams hardDelete(final Boolean value) {
put("hardDelete", EncodingUtils.encode(value));
return this;
}
}
/**
* Export users in a team in CSV format
*
* @param team Name of the team to under which the users are imported to (required)
* @return String
*/
@RequestLine("GET /v1/users/export?team={team}")
@Headers({
"Accept: application/json",
})
String exportUsers(@Param("team") String team);
/**
* Export users in a team in CSV format
* Similar to exportUsers but it also returns the http response headers .
*
* @param team Name of the team to under which the users are imported to (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/users/export?team={team}")
@Headers({
"Accept: application/json",
})
ApiResponse exportUsersWithHttpInfo(@Param("team") String team);
/**
* Export users in a team in CSV format
*
* Note, this is equivalent to the other exportUsers method,
* but with the query parameters collected into a single Map parameter. This
* is convenient for services with optional query parameters, especially when
* used with the {@link ExportUsersQueryParams} class that allows for
* building up this map in a fluent style.
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - team - Name of the team to under which the users are imported to (required)
*
* @return String
*/
@RequestLine("GET /v1/users/export?team={team}")
@Headers({
"Accept: application/json",
})
String exportUsers(@QueryMap(encoded=true) ExportUsersQueryParams queryParams);
/**
* Export users in a team in CSV format
*
* Note, this is equivalent to the other exportUsers that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - team - Name of the team to under which the users are imported to (required)
*
* @return String
*/
@RequestLine("GET /v1/users/export?team={team}")
@Headers({
"Accept: application/json",
})
ApiResponse exportUsersWithHttpInfo(@QueryMap(encoded=true) ExportUsersQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* exportUsers method in a fluent style.
*/
public static class ExportUsersQueryParams extends HashMap {
public ExportUsersQueryParams team(final String value) {
put("team", EncodingUtils.encode(value));
return this;
}
}
/**
* Generate JWT Token for a Bot User
* Generate JWT Token for a Bot User.
* @param id Id of the user (required)
* @param generateTokenRequest (optional)
* @return String
*/
@RequestLine("PUT /v1/users/generateToken/{id}")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
String generateJWTTokenForBotUser(@Param("id") UUID id, GenerateTokenRequest generateTokenRequest);
/**
* Generate JWT Token for a Bot User
* Similar to generateJWTTokenForBotUser but it also returns the http response headers .
* Generate JWT Token for a Bot User.
* @param id Id of the user (required)
* @param generateTokenRequest (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("PUT /v1/users/generateToken/{id}")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse generateJWTTokenForBotUserWithHttpInfo(@Param("id") UUID id, GenerateTokenRequest generateTokenRequest);
/**
* Generate Password Reset Link
* Generate Password Reset Link
* @param emailRequest (optional)
*/
@RequestLine("POST /v1/users/generatePasswordResetLink")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
void generatePasswordResetLink(EmailRequest emailRequest);
/**
* Generate Password Reset Link
* Similar to generatePasswordResetLink but it also returns the http response headers .
* Generate Password Reset Link
* @param emailRequest (optional)
*/
@RequestLine("POST /v1/users/generatePasswordResetLink")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse generatePasswordResetLinkWithHttpInfo(EmailRequest emailRequest);
/**
* Generate a random password
* Generate a random password
*/
@RequestLine("GET /v1/users/generateRandomPwd")
@Headers({
"Accept: application/json",
})
void generateRandomPwd();
/**
* Generate a random password
* Similar to generateRandomPwd but it also returns the http response headers .
* Generate a random password
*/
@RequestLine("GET /v1/users/generateRandomPwd")
@Headers({
"Accept: application/json",
})
ApiResponse generateRandomPwdWithHttpInfo();
/**
* Get Authentication Mechanism for a Bot User
* Get Authentication Mechanism for a Bot User.
* @param id Id of the user (required)
* @return AuthenticationMechanism
*/
@RequestLine("GET /v1/users/auth-mechanism/{id}")
@Headers({
"Accept: application/json",
})
AuthenticationMechanism getAuthenticationMechanismBotUser(@Param("id") UUID id);
/**
* Get Authentication Mechanism for a Bot User
* Similar to getAuthenticationMechanismBotUser but it also returns the http response headers .
* Get Authentication Mechanism for a Bot User.
* @param id Id of the user (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/users/auth-mechanism/{id}")
@Headers({
"Accept: application/json",
})
ApiResponse getAuthenticationMechanismBotUserWithHttpInfo(@Param("id") UUID id);
/**
* Get CSV documentation for user import/export
*
* @return String
*/
@RequestLine("GET /v1/users/documentation/csv")
@Headers({
"Accept: application/json",
})
String getCsvDocumentation2();
/**
* Get CSV documentation for user import/export
* Similar to getCsvDocumentation2 but it also returns the http response headers .
*
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/users/documentation/csv")
@Headers({
"Accept: application/json",
})
ApiResponse getCsvDocumentation2WithHttpInfo();
/**
* Get current logged in user
* Get the user who is authenticated and is currently logged in.
* @param fields Fields requested in the returned resource (optional)
* @return User
*/
@RequestLine("GET /v1/users/loggedInUser?fields={fields}")
@Headers({
"Accept: application/json",
})
User getCurrentLoggedInUser(@Param("fields") String fields);
/**
* Get current logged in user
* Similar to getCurrentLoggedInUser but it also returns the http response headers .
* Get the user who is authenticated and is currently logged in.
* @param fields Fields requested in the returned resource (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/users/loggedInUser?fields={fields}")
@Headers({
"Accept: application/json",
})
ApiResponse getCurrentLoggedInUserWithHttpInfo(@Param("fields") String fields);
/**
* Get current logged in user
* Get the user who is authenticated and is currently logged in.
* Note, this is equivalent to the other getCurrentLoggedInUser method,
* but with the query parameters collected into a single Map parameter. This
* is convenient for services with optional query parameters, especially when
* used with the {@link GetCurrentLoggedInUserQueryParams} class that allows for
* building up this map in a fluent style.
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - fields - Fields requested in the returned resource (optional)
*
* @return User
*/
@RequestLine("GET /v1/users/loggedInUser?fields={fields}")
@Headers({
"Accept: application/json",
})
User getCurrentLoggedInUser(@QueryMap(encoded=true) GetCurrentLoggedInUserQueryParams queryParams);
/**
* Get current logged in user
* Get the user who is authenticated and is currently logged in.
* Note, this is equivalent to the other getCurrentLoggedInUser that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - fields - Fields requested in the returned resource (optional)
*
* @return User
*/
@RequestLine("GET /v1/users/loggedInUser?fields={fields}")
@Headers({
"Accept: application/json",
})
ApiResponse getCurrentLoggedInUserWithHttpInfo(@QueryMap(encoded=true) GetCurrentLoggedInUserQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* getCurrentLoggedInUser method in a fluent style.
*/
public static class GetCurrentLoggedInUserQueryParams extends HashMap {
public GetCurrentLoggedInUserQueryParams fields(final String value) {
put("fields", EncodingUtils.encode(value));
return this;
}
}
/**
* Get group type of teams for current logged in user
* Get the group type of teams of user who is authenticated and is currently logged in.
* @return List<EntityReference>
*/
@RequestLine("GET /v1/users/loggedInUser/groupTeams")
@Headers({
"Accept: application/json",
})
List getCurrentLoggedInUserGroupTeams();
/**
* Get group type of teams for current logged in user
* Similar to getCurrentLoggedInUserGroupTeams but it also returns the http response headers .
* Get the group type of teams of user who is authenticated and is currently logged in.
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/users/loggedInUser/groupTeams")
@Headers({
"Accept: application/json",
})
ApiResponse> getCurrentLoggedInUserGroupTeamsWithHttpInfo();
/**
* Get JWT Token for a Bot User
* Get JWT Token for a Bot User.
* @param id Id of the user (required)
* @return JWTAuthMechanism
*/
@RequestLine("GET /v1/users/token/{id}")
@Headers({
"Accept: application/json",
})
JWTAuthMechanism getJWTTokenForBotUser(@Param("id") UUID id);
/**
* Get JWT Token for a Bot User
* Similar to getJWTTokenForBotUser but it also returns the http response headers .
* Get JWT Token for a Bot User.
* @param id Id of the user (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/users/token/{id}")
@Headers({
"Accept: application/json",
})
ApiResponse getJWTTokenForBotUserWithHttpInfo(@Param("id") UUID id);
/**
* Get personal access token to User
* Get a personal access token
* @param username User Name of the User for which to get. (Default = `false`) (optional)
* @return PersonalAccessTokenList
*/
@RequestLine("GET /v1/users/security/token?username={username}")
@Headers({
"Accept: application/json",
})
PersonalAccessTokenList getPersonalAccessToken(@Param("username") String username);
/**
* Get personal access token to User
* Similar to getPersonalAccessToken but it also returns the http response headers .
* Get a personal access token
* @param username User Name of the User for which to get. (Default = `false`) (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/users/security/token?username={username}")
@Headers({
"Accept: application/json",
})
ApiResponse getPersonalAccessTokenWithHttpInfo(@Param("username") String username);
/**
* Get personal access token to User
* Get a personal access token
* Note, this is equivalent to the other getPersonalAccessToken method,
* but with the query parameters collected into a single Map parameter. This
* is convenient for services with optional query parameters, especially when
* used with the {@link GetPersonalAccessTokenQueryParams} class that allows for
* building up this map in a fluent style.
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - username - User Name of the User for which to get. (Default = `false`) (optional)
*
* @return PersonalAccessTokenList
*/
@RequestLine("GET /v1/users/security/token?username={username}")
@Headers({
"Accept: application/json",
})
PersonalAccessTokenList getPersonalAccessToken(@QueryMap(encoded=true) GetPersonalAccessTokenQueryParams queryParams);
/**
* Get personal access token to User
* Get a personal access token
* Note, this is equivalent to the other getPersonalAccessToken that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - username - User Name of the User for which to get. (Default = `false`) (optional)
*
* @return PersonalAccessTokenList
*/
@RequestLine("GET /v1/users/security/token?username={username}")
@Headers({
"Accept: application/json",
})
ApiResponse getPersonalAccessTokenWithHttpInfo(@QueryMap(encoded=true) GetPersonalAccessTokenQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* getPersonalAccessToken method in a fluent style.
*/
public static class GetPersonalAccessTokenQueryParams extends HashMap {
public GetPersonalAccessTokenQueryParams username(final String value) {
put("username", EncodingUtils.encode(value));
return this;
}
}
/**
* Get a version of the user
* Get a version of the user by given `id`
* @param id Id of the user (required)
* @param version User version number in the form `major`.`minor` (required)
* @return User
*/
@RequestLine("GET /v1/users/{id}/versions/{version}")
@Headers({
"Accept: application/json",
})
User getSpecificUserVersion(@Param("id") UUID id, @Param("version") String version);
/**
* Get a version of the user
* Similar to getSpecificUserVersion but it also returns the http response headers .
* Get a version of the user by given `id`
* @param id Id of the user (required)
* @param version User version number in the form `major`.`minor` (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/users/{id}/versions/{version}")
@Headers({
"Accept: application/json",
})
ApiResponse getSpecificUserVersionWithHttpInfo(@Param("id") UUID id, @Param("version") String version);
/**
* Get a user by name
* Get a user by `name`.
* @param name Name of the user (required)
* @param fields Fields requested in the returned resource (optional)
* @param include Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
* @return User
*/
@RequestLine("GET /v1/users/name/{name}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
User getUserByFQN(@Param("name") String name, @Param("fields") String fields, @Param("include") String include);
/**
* Get a user by name
* Similar to getUserByFQN but it also returns the http response headers .
* Get a user by `name`.
* @param name Name of the user (required)
* @param fields Fields requested in the returned resource (optional)
* @param include Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/users/name/{name}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse getUserByFQNWithHttpInfo(@Param("name") String name, @Param("fields") String fields, @Param("include") String include);
/**
* Get a user by name
* Get a user by `name`.
* Note, this is equivalent to the other getUserByFQN method,
* but with the query parameters collected into a single Map parameter. This
* is convenient for services with optional query parameters, especially when
* used with the {@link GetUserByFQNQueryParams} class that allows for
* building up this map in a fluent style.
* @param name Name of the user (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - fields - Fields requested in the returned resource (optional)
* - include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
*
* @return User
*/
@RequestLine("GET /v1/users/name/{name}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
User getUserByFQN(@Param("name") String name, @QueryMap(encoded=true) GetUserByFQNQueryParams queryParams);
/**
* Get a user by name
* Get a user by `name`.
* Note, this is equivalent to the other getUserByFQN that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param name Name of the user (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - fields - Fields requested in the returned resource (optional)
* - include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
*
* @return User
*/
@RequestLine("GET /v1/users/name/{name}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse getUserByFQNWithHttpInfo(@Param("name") String name, @QueryMap(encoded=true) GetUserByFQNQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* getUserByFQN method in a fluent style.
*/
public static class GetUserByFQNQueryParams extends HashMap {
public GetUserByFQNQueryParams fields(final String value) {
put("fields", EncodingUtils.encode(value));
return this;
}
public GetUserByFQNQueryParams include(final String value) {
put("include", EncodingUtils.encode(value));
return this;
}
}
/**
* Get a user
* Get a user by `id`
* @param id Id of the user (required)
* @param fields Fields requested in the returned resource (optional)
* @param include Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
* @return User
*/
@RequestLine("GET /v1/users/{id}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
User getUserByID(@Param("id") UUID id, @Param("fields") String fields, @Param("include") String include);
/**
* Get a user
* Similar to getUserByID but it also returns the http response headers .
* Get a user by `id`
* @param id Id of the user (required)
* @param fields Fields requested in the returned resource (optional)
* @param include Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/users/{id}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse getUserByIDWithHttpInfo(@Param("id") UUID id, @Param("fields") String fields, @Param("include") String include);
/**
* Get a user
* Get a user by `id`
* Note, this is equivalent to the other getUserByID method,
* but with the query parameters collected into a single Map parameter. This
* is convenient for services with optional query parameters, especially when
* used with the {@link GetUserByIDQueryParams} class that allows for
* building up this map in a fluent style.
* @param id Id of the user (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - fields - Fields requested in the returned resource (optional)
* - include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
*
* @return User
*/
@RequestLine("GET /v1/users/{id}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
User getUserByID(@Param("id") UUID id, @QueryMap(encoded=true) GetUserByIDQueryParams queryParams);
/**
* Get a user
* Get a user by `id`
* Note, this is equivalent to the other getUserByID that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param id Id of the user (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - fields - Fields requested in the returned resource (optional)
* - include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
*
* @return User
*/
@RequestLine("GET /v1/users/{id}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse getUserByIDWithHttpInfo(@Param("id") UUID id, @QueryMap(encoded=true) GetUserByIDQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* getUserByID method in a fluent style.
*/
public static class GetUserByIDQueryParams extends HashMap {
public GetUserByIDQueryParams fields(final String value) {
put("fields", EncodingUtils.encode(value));
return this;
}
public GetUserByIDQueryParams include(final String value) {
put("include", EncodingUtils.encode(value));
return this;
}
}
/**
* Import from CSV to create, and update teams.
*
* @param team Name of the team to under which the users are imported to (required)
* @param dryRun Dry-run when true is used for validating the CSV without really importing it. (default=true) (optional, default to true)
* @param body (optional)
* @return CsvImportResult
*/
@RequestLine("PUT /v1/users/import?team={team}&dryRun={dryRun}")
@Headers({
"Content-Type: text/plain",
"Accept: application/json",
})
CsvImportResult importTeams1(@Param("team") String team, @Param("dryRun") Boolean dryRun, String body);
/**
* Import from CSV to create, and update teams.
* Similar to importTeams1 but it also returns the http response headers .
*
* @param team Name of the team to under which the users are imported to (required)
* @param dryRun Dry-run when true is used for validating the CSV without really importing it. (default=true) (optional, default to true)
* @param body (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("PUT /v1/users/import?team={team}&dryRun={dryRun}")
@Headers({
"Content-Type: text/plain",
"Accept: application/json",
})
ApiResponse importTeams1WithHttpInfo(@Param("team") String team, @Param("dryRun") Boolean dryRun, String body);
/**
* Import from CSV to create, and update teams.
*
* Note, this is equivalent to the other importTeams1 method,
* but with the query parameters collected into a single Map parameter. This
* is convenient for services with optional query parameters, especially when
* used with the {@link ImportTeams1QueryParams} class that allows for
* building up this map in a fluent style.
* @param body (optional)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - team - Name of the team to under which the users are imported to (required)
* - dryRun - Dry-run when true is used for validating the CSV without really importing it. (default=true) (optional, default to true)
*
* @return CsvImportResult
*/
@RequestLine("PUT /v1/users/import?team={team}&dryRun={dryRun}")
@Headers({
"Content-Type: text/plain",
"Accept: application/json",
})
CsvImportResult importTeams1(String body, @QueryMap(encoded=true) ImportTeams1QueryParams queryParams);
/**
* Import from CSV to create, and update teams.
*
* Note, this is equivalent to the other importTeams1 that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param body (optional)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - team - Name of the team to under which the users are imported to (required)
* - dryRun - Dry-run when true is used for validating the CSV without really importing it. (default=true) (optional, default to true)
*
* @return CsvImportResult
*/
@RequestLine("PUT /v1/users/import?team={team}&dryRun={dryRun}")
@Headers({
"Content-Type: text/plain",
"Accept: application/json",
})
ApiResponse importTeams1WithHttpInfo(String body, @QueryMap(encoded=true) ImportTeams1QueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* importTeams1 method in a fluent style.
*/
public static class ImportTeams1QueryParams extends HashMap {
public ImportTeams1QueryParams team(final String value) {
put("team", EncodingUtils.encode(value));
return this;
}
public ImportTeams1QueryParams dryRun(final Boolean value) {
put("dryRun", EncodingUtils.encode(value));
return this;
}
}
/**
* List user versions
* Get a list of all the versions of a user identified by `id`
* @param id Id of the user (required)
* @return EntityHistory
*/
@RequestLine("GET /v1/users/{id}/versions")
@Headers({
"Accept: application/json",
})
EntityHistory listAllUserVersion(@Param("id") UUID id);
/**
* List user versions
* Similar to listAllUserVersion but it also returns the http response headers .
* Get a list of all the versions of a user identified by `id`
* @param id Id of the user (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/users/{id}/versions")
@Headers({
"Accept: application/json",
})
ApiResponse listAllUserVersionWithHttpInfo(@Param("id") UUID id);
/**
* List users
* Get a list of users. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params.
* @param fields Fields requested in the returned resource (optional)
* @param team Filter users by team (optional)
* @param limit Limit the number users returned. (1 to 1000000, default = 10) (optional, default to 10)
* @param before Returns list of users before this cursor (optional)
* @param after Returns list of users after this cursor (optional)
* @param isAdmin Returns list of admin users if set to true (optional)
* @param isBot Returns list of bot users if set to true (optional)
* @param include Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
* @return UserList
*/
@RequestLine("GET /v1/users?fields={fields}&team={team}&limit={limit}&before={before}&after={after}&isAdmin={isAdmin}&isBot={isBot}&include={include}")
@Headers({
"Accept: application/json",
})
UserList listUsers(@Param("fields") String fields, @Param("team") String team, @Param("limit") Integer limit, @Param("before") String before, @Param("after") String after, @Param("isAdmin") Boolean isAdmin, @Param("isBot") Boolean isBot, @Param("include") String include);
/**
* List users
* Similar to listUsers but it also returns the http response headers .
* Get a list of users. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params.
* @param fields Fields requested in the returned resource (optional)
* @param team Filter users by team (optional)
* @param limit Limit the number users returned. (1 to 1000000, default = 10) (optional, default to 10)
* @param before Returns list of users before this cursor (optional)
* @param after Returns list of users after this cursor (optional)
* @param isAdmin Returns list of admin users if set to true (optional)
* @param isBot Returns list of bot users if set to true (optional)
* @param include Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/users?fields={fields}&team={team}&limit={limit}&before={before}&after={after}&isAdmin={isAdmin}&isBot={isBot}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse listUsersWithHttpInfo(@Param("fields") String fields, @Param("team") String team, @Param("limit") Integer limit, @Param("before") String before, @Param("after") String after, @Param("isAdmin") Boolean isAdmin, @Param("isBot") Boolean isBot, @Param("include") String include);
/**
* List users
* Get a list of users. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params.
* Note, this is equivalent to the other listUsers method,
* but with the query parameters collected into a single Map parameter. This
* is convenient for services with optional query parameters, especially when
* used with the {@link ListUsersQueryParams} class that allows for
* building up this map in a fluent style.
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - fields - Fields requested in the returned resource (optional)
* - team - Filter users by team (optional)
* - limit - Limit the number users returned. (1 to 1000000, default = 10) (optional, default to 10)
* - before - Returns list of users before this cursor (optional)
* - after - Returns list of users after this cursor (optional)
* - isAdmin - Returns list of admin users if set to true (optional)
* - isBot - Returns list of bot users if set to true (optional)
* - include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
*
* @return UserList
*/
@RequestLine("GET /v1/users?fields={fields}&team={team}&limit={limit}&before={before}&after={after}&isAdmin={isAdmin}&isBot={isBot}&include={include}")
@Headers({
"Accept: application/json",
})
UserList listUsers(@QueryMap(encoded=true) ListUsersQueryParams queryParams);
/**
* List users
* Get a list of users. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params.
* Note, this is equivalent to the other listUsers that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - fields - Fields requested in the returned resource (optional)
* - team - Filter users by team (optional)
* - limit - Limit the number users returned. (1 to 1000000, default = 10) (optional, default to 10)
* - before - Returns list of users before this cursor (optional)
* - after - Returns list of users after this cursor (optional)
* - isAdmin - Returns list of admin users if set to true (optional)
* - isBot - Returns list of bot users if set to true (optional)
* - include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
*
* @return UserList
*/
@RequestLine("GET /v1/users?fields={fields}&team={team}&limit={limit}&before={before}&after={after}&isAdmin={isAdmin}&isBot={isBot}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse listUsersWithHttpInfo(@QueryMap(encoded=true) ListUsersQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* listUsers method in a fluent style.
*/
public static class ListUsersQueryParams extends HashMap {
public ListUsersQueryParams fields(final String value) {
put("fields", EncodingUtils.encode(value));
return this;
}
public ListUsersQueryParams team(final String value) {
put("team", EncodingUtils.encode(value));
return this;
}
public ListUsersQueryParams limit(final Integer value) {
put("limit", EncodingUtils.encode(value));
return this;
}
public ListUsersQueryParams before(final String value) {
put("before", EncodingUtils.encode(value));
return this;
}
public ListUsersQueryParams after(final String value) {
put("after", EncodingUtils.encode(value));
return this;
}
public ListUsersQueryParams isAdmin(final Boolean value) {
put("isAdmin", EncodingUtils.encode(value));
return this;
}
public ListUsersQueryParams isBot(final Boolean value) {
put("isBot", EncodingUtils.encode(value));
return this;
}
public ListUsersQueryParams include(final String value) {
put("include", EncodingUtils.encode(value));
return this;
}
}
/**
* Login User with email (plain-text) and Password (encoded in base 64)
* Login User with email(plain-text) and Password (encoded in base 64)
* @param loginRequest (optional)
* @return JwtResponse
*/
@RequestLine("POST /v1/users/login")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
JwtResponse loginUserWithPwd(LoginRequest loginRequest);
/**
* Login User with email (plain-text) and Password (encoded in base 64)
* Similar to loginUserWithPwd but it also returns the http response headers .
* Login User with email(plain-text) and Password (encoded in base 64)
* @param loginRequest (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("POST /v1/users/login")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse loginUserWithPwdWithHttpInfo(LoginRequest loginRequest);
/**
* Logout a User(Only called for saml and basic Auth)
* Logout a User(Only called for saml and basic Auth)
* @param logoutRequest (optional)
*/
@RequestLine("POST /v1/users/logout")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
void logoutUser(LogoutRequest logoutRequest);
/**
* Logout a User(Only called for saml and basic Auth)
* Similar to logoutUser but it also returns the http response headers .
* Logout a User(Only called for saml and basic Auth)
* @param logoutRequest (optional)
*/
@RequestLine("POST /v1/users/logout")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse logoutUserWithHttpInfo(LogoutRequest logoutRequest);
/**
* Update a user
* Update an existing user using JsonPatch.
* @param id Id of the user (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Update a user Documentation
*/
@RequestLine("PATCH /v1/users/{id}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
void patchUser(@Param("id") UUID id, Object body);
/**
* Update a user
* Similar to patchUser but it also returns the http response headers .
* Update an existing user using JsonPatch.
* @param id Id of the user (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Update a user Documentation
*/
@RequestLine("PATCH /v1/users/{id}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
ApiResponse patchUserWithHttpInfo(@Param("id") UUID id, Object body);
/**
* Provide access token to User with refresh token
* Provide access token to User with refresh token
* @param tokenRefreshRequest (optional)
* @return JwtResponse
*/
@RequestLine("POST /v1/users/refresh")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
JwtResponse refreshToken(TokenRefreshRequest tokenRefreshRequest);
/**
* Provide access token to User with refresh token
* Similar to refreshToken but it also returns the http response headers .
* Provide access token to User with refresh token
* @param tokenRefreshRequest (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("POST /v1/users/refresh")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse refreshTokenWithHttpInfo(TokenRefreshRequest tokenRefreshRequest);
/**
* Register User
* Register a new User
* @param registrationRequest (optional)
*/
@RequestLine("POST /v1/users/signup")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
void registerUser(RegistrationRequest registrationRequest);
/**
* Register User
* Similar to registerUser but it also returns the http response headers .
* Register a new User
* @param registrationRequest (optional)
*/
@RequestLine("POST /v1/users/signup")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse registerUserWithHttpInfo(RegistrationRequest registrationRequest);
/**
* Resend Registration Token
* Resend Registration Token
* @param user Token sent for Email Confirmation Earlier (optional)
*/
@RequestLine("PUT /v1/users/resendRegistrationToken?user={user}")
@Headers({
"Accept: application/json",
})
void resendRegistrationToken(@Param("user") String user);
/**
* Resend Registration Token
* Similar to resendRegistrationToken but it also returns the http response headers .
* Resend Registration Token
* @param user Token sent for Email Confirmation Earlier (optional)
*/
@RequestLine("PUT /v1/users/resendRegistrationToken?user={user}")
@Headers({
"Accept: application/json",
})
ApiResponse resendRegistrationTokenWithHttpInfo(@Param("user") String user);
/**
* Resend Registration Token
* Resend Registration Token
* Note, this is equivalent to the other resendRegistrationToken method,
* but with the query parameters collected into a single Map parameter. This
* is convenient for services with optional query parameters, especially when
* used with the {@link ResendRegistrationTokenQueryParams} class that allows for
* building up this map in a fluent style.
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - user - Token sent for Email Confirmation Earlier (optional)
*
*/
@RequestLine("PUT /v1/users/resendRegistrationToken?user={user}")
@Headers({
"Accept: application/json",
})
void resendRegistrationToken(@QueryMap(encoded=true) ResendRegistrationTokenQueryParams queryParams);
/**
* Resend Registration Token
* Resend Registration Token
* Note, this is equivalent to the other resendRegistrationToken that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - user - Token sent for Email Confirmation Earlier (optional)
*
*/
@RequestLine("PUT /v1/users/resendRegistrationToken?user={user}")
@Headers({
"Accept: application/json",
})
ApiResponse resendRegistrationTokenWithHttpInfo(@QueryMap(encoded=true) ResendRegistrationTokenQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* resendRegistrationToken method in a fluent style.
*/
public static class ResendRegistrationTokenQueryParams extends HashMap {
public ResendRegistrationTokenQueryParams user(final String value) {
put("user", EncodingUtils.encode(value));
return this;
}
}
/**
* Reset Password For User
* Reset User Password
* @param passwordResetRequest (optional)
* @return User
*/
@RequestLine("POST /v1/users/password/reset")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
User resetUserPassword(PasswordResetRequest passwordResetRequest);
/**
* Reset Password For User
* Similar to resetUserPassword but it also returns the http response headers .
* Reset User Password
* @param passwordResetRequest (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("POST /v1/users/password/reset")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse resetUserPasswordWithHttpInfo(PasswordResetRequest passwordResetRequest);
/**
* Restore a soft deleted User.
* Restore a soft deleted User.
* @param restoreEntity (optional)
* @return User
*/
@RequestLine("PUT /v1/users/restore")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
User restore31(RestoreEntity restoreEntity);
/**
* Restore a soft deleted User.
* Similar to restore31 but it also returns the http response headers .
* Restore a soft deleted User.
* @param restoreEntity (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("PUT /v1/users/restore")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse restore31WithHttpInfo(RestoreEntity restoreEntity);
/**
* Revoke JWT Token for a Bot User
* Revoke JWT Token for a Bot User.
* @param revokeTokenRequest (optional)
* @return JWTAuthMechanism
*/
@RequestLine("PUT /v1/users/revokeToken")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
JWTAuthMechanism revokeJWTTokenForBotUser(RevokeTokenRequest revokeTokenRequest);
/**
* Revoke JWT Token for a Bot User
* Similar to revokeJWTTokenForBotUser but it also returns the http response headers .
* Revoke JWT Token for a Bot User.
* @param revokeTokenRequest (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("PUT /v1/users/revokeToken")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse revokeJWTTokenForBotUserWithHttpInfo(RevokeTokenRequest revokeTokenRequest);
/**
* Revoke personal access token to User
* Revoke personal access token
* @param username Username in case admin is revoking. (Default = `false`) (optional)
* @param removeAll Remove All tokens of the user. (Default = `false`) (optional, default to false)
* @param revokePersonalTokenRequest (optional)
* @return PersonalAccessTokenList
*/
@RequestLine("PUT /v1/users/security/token/revoke?username={username}&removeAll={removeAll}")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
PersonalAccessTokenList revokePersonalAccessToken(@Param("username") String username, @Param("removeAll") Boolean removeAll, RevokePersonalTokenRequest revokePersonalTokenRequest);
/**
* Revoke personal access token to User
* Similar to revokePersonalAccessToken but it also returns the http response headers .
* Revoke personal access token
* @param username Username in case admin is revoking. (Default = `false`) (optional)
* @param removeAll Remove All tokens of the user. (Default = `false`) (optional, default to false)
* @param revokePersonalTokenRequest (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("PUT /v1/users/security/token/revoke?username={username}&removeAll={removeAll}")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse revokePersonalAccessTokenWithHttpInfo(@Param("username") String username, @Param("removeAll") Boolean removeAll, RevokePersonalTokenRequest revokePersonalTokenRequest);
/**
* Revoke personal access token to User
* Revoke personal access token
* Note, this is equivalent to the other revokePersonalAccessToken method,
* but with the query parameters collected into a single Map parameter. This
* is convenient for services with optional query parameters, especially when
* used with the {@link RevokePersonalAccessTokenQueryParams} class that allows for
* building up this map in a fluent style.
* @param revokePersonalTokenRequest (optional)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - username - Username in case admin is revoking. (Default = `false`) (optional)
* - removeAll - Remove All tokens of the user. (Default = `false`) (optional, default to false)
*
* @return PersonalAccessTokenList
*/
@RequestLine("PUT /v1/users/security/token/revoke?username={username}&removeAll={removeAll}")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
PersonalAccessTokenList revokePersonalAccessToken(RevokePersonalTokenRequest revokePersonalTokenRequest, @QueryMap(encoded=true) RevokePersonalAccessTokenQueryParams queryParams);
/**
* Revoke personal access token to User
* Revoke personal access token
* Note, this is equivalent to the other revokePersonalAccessToken that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param revokePersonalTokenRequest (optional)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - username - Username in case admin is revoking. (Default = `false`) (optional)
* - removeAll - Remove All tokens of the user. (Default = `false`) (optional, default to false)
*
* @return PersonalAccessTokenList
*/
@RequestLine("PUT /v1/users/security/token/revoke?username={username}&removeAll={removeAll}")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse revokePersonalAccessTokenWithHttpInfo(RevokePersonalTokenRequest revokePersonalTokenRequest, @QueryMap(encoded=true) RevokePersonalAccessTokenQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* revokePersonalAccessToken method in a fluent style.
*/
public static class RevokePersonalAccessTokenQueryParams extends HashMap {
public RevokePersonalAccessTokenQueryParams username(final String value) {
put("username", EncodingUtils.encode(value));
return this;
}
public RevokePersonalAccessTokenQueryParams removeAll(final Boolean value) {
put("removeAll", EncodingUtils.encode(value));
return this;
}
}
}