_LookupUserIdsRequest.java

/*
 * Copyright 2013-2017 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 org.cloudfoundry.Nullable;
import org.cloudfoundry.QueryParameter;
import org.cloudfoundry.uaa.PaginatedAndSortedRequest;
import org.immutables.value.Value;

/**
 * The request payload for the lookup user ids and usernames operation
 */
@Value.Immutable
abstract class _LookupUserIdsRequest extends PaginatedAndSortedRequest {

    /**
     * Whether to include users from inactive identity providers
     */
    @Nullable
    @QueryParameter("includeInactive")
    abstract Boolean getIncludeInactive();

}