org.cloudfoundry.uaa.users.Users Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2013-2021 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.cloudfoundry.uaa.users;

import reactor.core.publisher.Mono;

/**
 * Main entry point to the UAA Users Client API
 */
public interface Users {

    /**
     * Makes the Change User Password request
     *
     * @param request the Change User Password request
     * @return the response from the Change User Password request
     */
    Mono changePassword(ChangeUserPasswordRequest request);

    /**
     * Makes the Create User request
     *
     * @param request the Create User request
     * @return the response from the Create User request
     */
    Mono create(CreateUserRequest request);

    /**
     * Makes the Delete User request
     *
     * @param request the Delete User request
     * @return the response from the Delete User request
     */
    Mono delete(DeleteUserRequest request);

    /**
     * Makes the Force User Password to Expire request
     *
     * @param request the Expire Password request
     * @return the response from the Expire Password request
     */
    Mono expirePassword(ExpirePasswordRequest request);

    /**
     * Makes the Get User Verification Link request
     *
     * @param request the Get User Verification Link request
     * @return the response from the Get User Verification Link request
     */
    Mono getVerificationLink(
            GetUserVerificationLinkRequest request);

    /**
     * Makes the Invite Users request
     *
     * @param request the Invite Users request
     * @return the response from the Invite Users request
     */
    Mono invite(InviteUsersRequest request);

    /**
     * Makes the List Users request
     *
     * @param request the List Users request
     * @return the response from the List Users request
     */
    Mono list(ListUsersRequest request);

    /**
     * Makes the Lookup User IDs/Usernames request
     *
     * @param request the lookup userid and usernames request
     * @return the response from the lookup userid and usernames request
     */
    Mono lookup(LookupUserIdsRequest request);

    /**
     * Makes the Update User request
     *
     * @param request the Update User request
     * @return the response from the Update User request
     */
    Mono update(UpdateUserRequest request);

    /**
     * Makes the Retrieve User Info request
     *
     * @param request the User Info request
     * @return the response from the User Info request
     */
    Mono userInfo(UserInfoRequest request);

    /**
     * Makes the Verify User request
     *
     * @param request the Verify User request
     * @return the response from the Verify User request
     */
    Mono verify(VerifyUserRequest request);
}