com.slack.api.scim.SCIMClient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of slack-api-client Show documentation
The newest version!
package com.slack.api.scim;

import com.slack.api.RequestConfigurator;
import com.slack.api.scim.request.*;
import com.slack.api.scim.response.*;

import java.io.IOException;

/**
 * Slack SCIM API client.
 * 
 * Provision and manage user accounts and groups with the Slack SCIM API.
 * SCIM is used by Single Sign-On (SSO) services and identity providers to manage people
 * across a variety of tools, including Slack.
 * 
 * It's also possible to write your own apps
 * and scripts using the SCIM API to programmatically manage the members of your workspace.
 *
 * @see Slack SCIM API
 */
public interface SCIMClient {

    String ENDPOINT_URL_PREFIX = "https://api.slack.com/scim/v1/";

    String getEndpointUrlPrefix();

    void setEndpointUrlPrefix(String endpointUrlPrefix);

    // --------------------
    // ServiceProviderConfigs
    // --------------------

    ServiceProviderConfigsGetResponse getServiceProviderConfigs(ServiceProviderConfigsGetRequest req) throws IOException, SCIMApiException;

    ServiceProviderConfigsGetResponse getServiceProviderConfigs(RequestConfigurator req) throws IOException, SCIMApiException;

    // --------------------
    // Users
    // --------------------

    UsersSearchResponse searchUsers(UsersSearchRequest req) throws IOException, SCIMApiException;

    UsersSearchResponse searchUsers(RequestConfigurator req) throws IOException, SCIMApiException;

    // ---

    UsersReadResponse readUser(UsersReadRequest req) throws IOException, SCIMApiException;

    UsersReadResponse readUser(RequestConfigurator req) throws IOException, SCIMApiException;

    // ---

    UsersCreateResponse createUser(UsersCreateRequest req) throws IOException, SCIMApiException;

    UsersCreateResponse createUser(RequestConfigurator req) throws IOException, SCIMApiException;

    // ---

    UsersPatchResponse patchUser(UsersPatchRequest req) throws IOException, SCIMApiException;

    UsersPatchResponse patchUser(RequestConfigurator req) throws IOException, SCIMApiException;

    // ---

    UsersUpdateResponse updateUser(UsersUpdateRequest req) throws IOException, SCIMApiException;

    UsersUpdateResponse updateUser(RequestConfigurator req) throws IOException, SCIMApiException;

    // ---

    UsersDeleteResponse deleteUser(UsersDeleteRequest req) throws IOException, SCIMApiException;

    UsersDeleteResponse deleteUser(RequestConfigurator req) throws IOException, SCIMApiException;

    // --------------------
    // Groups
    // --------------------

    GroupsSearchResponse searchGroups(GroupsSearchRequest req) throws IOException, SCIMApiException;

    GroupsSearchResponse searchGroups(RequestConfigurator req) throws IOException, SCIMApiException;

    // ---

    GroupsReadResponse readGroup(GroupsReadRequest req) throws IOException, SCIMApiException;

    GroupsReadResponse readGroup(RequestConfigurator req) throws IOException, SCIMApiException;

    // ---

    GroupsCreateResponse createGroup(GroupsCreateRequest req) throws IOException, SCIMApiException;

    GroupsCreateResponse createGroup(RequestConfigurator req) throws IOException, SCIMApiException;

    // ---

    GroupsPatchResponse patchGroup(GroupsPatchRequest req) throws IOException, SCIMApiException;

    GroupsPatchResponse patchGroup(RequestConfigurator req) throws IOException, SCIMApiException;

    // ---

    GroupsUpdateResponse updateGroup(GroupsUpdateRequest req) throws IOException, SCIMApiException;

    GroupsUpdateResponse updateGroup(RequestConfigurator req) throws IOException, SCIMApiException;

    // ---

    GroupsDeleteResponse deleteGroup(GroupsDeleteRequest req) throws IOException, SCIMApiException;

    GroupsDeleteResponse deleteGroup(RequestConfigurator req) throws IOException, SCIMApiException;

}