org.symphonyoss.symphony.clients.UserManagementClient Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of symphony-client Show documentation

The newest version!

/*
 *
 *
 * Copyright 2016 The Symphony Software Foundation
 *
 * Licensed to The Symphony Software Foundation (SSF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.symphonyoss.symphony.clients;

import org.symphonyoss.client.exceptions.UserManagementClientException;

public interface UserManagementClient {

    /**
     * Grant/disable external access to a user.
     *
     * @param userId the Symphony user id
     * @param allowExternalAccess true to turn external access on for the given user, false to turn it off
     * @throws UserManagementClientException if user external access fails to update
     */
     void updateExternalAccess(long userId, boolean allowExternalAccess) throws UserManagementClientException;

}