services.aaa.UserService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of model Show documentation
Model management tools for the oVirt Engine API.
There is a newer version: 4.6.0
/*
Copyright (c) 2015 Red Hat, Inc.

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 services.aaa;

import annotations.Area;
import mixins.Follow;
import org.ovirt.api.metamodel.annotations.In;
import org.ovirt.api.metamodel.annotations.InputDetail;
import org.ovirt.api.metamodel.annotations.Out;
import org.ovirt.api.metamodel.annotations.Service;
import services.AssignedPermissionsService;
import services.AssignedRolesService;
import services.AssignedTagsService;
import services.EventSubscriptionsService;
import types.User;
import static org.ovirt.api.metamodel.language.ApiLanguage.optional;
/**
 * A service to manage a user in the system.
 * Use this service to either get users details or remove users.
 * In order to add new users please use
 * <>.
 *
 * @author Oved Ourfali 
 * @date 28 Nov 2016
 * @status added
 */
@Service
@Area("Infrastructure")
public interface UserService {
    /**
     * Gets the system user information.
     *
     * Usage:
     *
     * ....
     * GET /ovirt-engine/api/users/1234
     * ....
     *
     * Will return the user information:
     *
     * [source,xml]
     * ----
     * 
     *   admin
     *   
     *   
     *   
     *   
     *   
     *   23456
     *   [email protected]
     *   Lastname
     *   *
     *   user1
     *   user1@domain-authz
     *   
     *     domain-authz
     *   
     * 
     * ----
     *
     * @author Ravi Nori 
     * @date 7 Dec 2017
     * @status added
     */
    interface Get extends Follow {
        /**
         * The system user.
         *
         * @author Ravi Nori 
         * @date 7 Dec 2017
         * @status added
         */
        @Out User user();
    }


    /**
     * Updates information about the user.
     *
     * Only the `user_options` field can be updated.
     *
     * For example, to update user options:
     *
     * [source]
     * ----
     * PUT /ovirt-engine/api/users/123
     * ----
     *
     * With a request body like this:
     *
     * [source,xml]
     * ----
     * 
     *    
     *       
     *          test
     *          ["any","JSON"]
     *       
     *    
     * 
     * ----
     *
     * IMPORTANT: Since version 4.4.5 of the engine this operation is deprecated, and preserved only for backwards
     * compatibility. It will be removed in the future. Please use the <>
     * endpoint instead.
     *
     * @author Bohdan Iakymets 
     * @date 2 Oct 2019
     * @status added
     * @since 4.4
     * @deprecated 4.4.5
     */
    @Deprecated
    interface Update {
        @InputDetail
        default void inputDetail() {
            optional(user().userOptions());
        }
        @In @Out User user();
    }

   /**
    * Removes the system user.
    *
    * Usage:
    *
    * ....
    * DELETE /ovirt-engine/api/users/1234
    * ....
    *
    * @author Ravi Nori 
    * @date 7 Dec 2017
    * @status added
    */
    interface Remove {
        /**
         * Indicates if the remove should be performed asynchronously.
         */
        @In Boolean async();
    }

    @Service DomainUserGroupsService groups();
    @Service AssignedRolesService roles();
    @Service AssignedPermissionsService permissions();
    @Service AssignedTagsService tags();
    @Service SshPublicKeysService sshPublicKeys();
    /**
     * @author Radoslaw Szwajkowski 
     * @date 11 Jan 2021
     * @status added
     * @since 4.4.5
     */
    @Service UserOptionsService options();

    /**
     * List of event-subscriptions for this user.
     *
     * @author Ori Liel 
     * @date 17 June 2019
     * @status added
     * @since 4.4.0
     */
    @Service EventSubscriptionsService eventSubscriptions();

}