All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.cloudfoundry.operations.useradmin.UserAdmin Maven / Gradle / Ivy

There is a newer version: 5.12.2.RELEASE
Show newest version
/*
 * Copyright 2013-2018 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.operations.useradmin;

import reactor.core.publisher.Mono;

/**
 * Main entry point to the Cloud Foundry User Admin Operations API
 */
public interface UserAdmin {

    /**
     * Create a user
     *
     * @param request the create user request
     * @return completion indicator
     */
    Mono create(CreateUserRequest request);

    /**
     * Delete a user
     *
     * @param request the delete user request
     * @return completion indicator
     */
    Mono delete(DeleteUserRequest request);

    /**
     * List organization users
     *
     * @param request the list organization users request
     * @return the Organization Users
     */
    Mono listOrganizationUsers(ListOrganizationUsersRequest request);

    /**
     * List space users
     *
     * @param request the list space users request
     * @return the Space Users
     */
    Mono listSpaceUsers(ListSpaceUsersRequest request);

    /**
     * Assign an organization role to a user
     *
     * @param request the set organization user request
     * @return completion indicator
     */
    Mono setOrganizationRole(SetOrganizationRoleRequest request);

    /**
     * Assign a space role to a user
     *
     * @param request the set space user request
     * @return completion indicator
     */
    Mono setSpaceRole(SetSpaceRoleRequest request);

    /**
     * Remove an organization role from a user
     *
     * @param request the unset organization user request
     * @return completion indicator
     */
    Mono unsetOrganizationRole(UnsetOrganizationRoleRequest request);

    /**
     * Remove a space role from a user
     *
     * @param request the unset space user request
     * @return completion indicator
     */
    Mono unsetSpaceRole(UnsetSpaceRoleRequest request);

}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy