Package com.slack.api.scim

Interface SCIMClient

All Known Implementing Classes:

SCIMClientImpl

public interface SCIMClient

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 Also:

Slack SCIM API

Field Summary

Fields

Modifier and Type	Field	Description
static String	ENDPOINT_URL_PREFIX

Method Summary

Modifier and Type	Method	Description
GroupsCreateResponse	createGroup(RequestConfigurator<GroupsCreateRequest.GroupsCreateRequestBuilder> req)
GroupsCreateResponse	createGroup(GroupsCreateRequest req)
UsersCreateResponse	createUser(RequestConfigurator<UsersCreateRequest.UsersCreateRequestBuilder> req)
UsersCreateResponse	createUser(UsersCreateRequest req)
GroupsDeleteResponse	deleteGroup(RequestConfigurator<GroupsDeleteRequest.GroupsDeleteRequestBuilder> req)
GroupsDeleteResponse	deleteGroup(GroupsDeleteRequest req)
UsersDeleteResponse	deleteUser(RequestConfigurator<UsersDeleteRequest.UsersDeleteRequestBuilder> req)
UsersDeleteResponse	deleteUser(UsersDeleteRequest req)
String	getEndpointUrlPrefix()
ServiceProviderConfigsGetResponse	getServiceProviderConfigs(RequestConfigurator<ServiceProviderConfigsGetRequest.ServiceProviderConfigsGetRequestBuilder> req)
ServiceProviderConfigsGetResponse	getServiceProviderConfigs(ServiceProviderConfigsGetRequest req)
GroupsPatchResponse	patchGroup(RequestConfigurator<GroupsPatchRequest.GroupsPatchRequestBuilder> req)
GroupsPatchResponse	patchGroup(GroupsPatchRequest req)
UsersPatchResponse	patchUser(RequestConfigurator<UsersPatchRequest.UsersPatchRequestBuilder> req)
UsersPatchResponse	patchUser(UsersPatchRequest req)
GroupsReadResponse	readGroup(RequestConfigurator<GroupsReadRequest.GroupsReadRequestBuilder> req)
GroupsReadResponse	readGroup(GroupsReadRequest req)
UsersReadResponse	readUser(RequestConfigurator<UsersReadRequest.UsersReadRequestBuilder> req)
UsersReadResponse	readUser(UsersReadRequest req)
GroupsSearchResponse	searchGroups(RequestConfigurator<GroupsSearchRequest.GroupsSearchRequestBuilder> req)
GroupsSearchResponse	searchGroups(GroupsSearchRequest req)
UsersSearchResponse	searchUsers(RequestConfigurator<UsersSearchRequest.UsersSearchRequestBuilder> req)
UsersSearchResponse	searchUsers(UsersSearchRequest req)
void	setEndpointUrlPrefix(String endpointUrlPrefix)
GroupsUpdateResponse	updateGroup(RequestConfigurator<GroupsUpdateRequest.GroupsUpdateRequestBuilder> req)
GroupsUpdateResponse	updateGroup(GroupsUpdateRequest req)
UsersUpdateResponse	updateUser(RequestConfigurator<UsersUpdateRequest.UsersUpdateRequestBuilder> req)
UsersUpdateResponse	updateUser(UsersUpdateRequest req)

Field Detail

ENDPOINT_URL_PREFIX

static final String ENDPOINT_URL_PREFIX

See Also:

Constant Field Values

Method Detail

getEndpointUrlPrefix

String getEndpointUrlPrefix()

setEndpointUrlPrefix

void setEndpointUrlPrefix(String endpointUrlPrefix)

getServiceProviderConfigs

ServiceProviderConfigsGetResponse getServiceProviderConfigs(ServiceProviderConfigsGetRequest req)
                                                     throws IOException,
                                                            SCIMApiException

Throws:

IOException

SCIMApiException

getServiceProviderConfigs

ServiceProviderConfigsGetResponse getServiceProviderConfigs(RequestConfigurator<ServiceProviderConfigsGetRequest.ServiceProviderConfigsGetRequestBuilder> req)
                                                     throws IOException,
                                                            SCIMApiException

Throws:

IOException

SCIMApiException

searchUsers

UsersSearchResponse searchUsers(UsersSearchRequest req)
                         throws IOException,
                                SCIMApiException

Throws:

IOException

SCIMApiException

searchUsers

UsersSearchResponse searchUsers(RequestConfigurator<UsersSearchRequest.UsersSearchRequestBuilder> req)
                         throws IOException,
                                SCIMApiException

Throws:

IOException

SCIMApiException

readUser

UsersReadResponse readUser(UsersReadRequest req)
                    throws IOException,
                           SCIMApiException

Throws:

IOException

SCIMApiException

readUser

UsersReadResponse readUser(RequestConfigurator<UsersReadRequest.UsersReadRequestBuilder> req)
                    throws IOException,
                           SCIMApiException

Throws:

IOException

SCIMApiException

createUser

UsersCreateResponse createUser(UsersCreateRequest req)
                        throws IOException,
                               SCIMApiException

Throws:

IOException

SCIMApiException

createUser

UsersCreateResponse createUser(RequestConfigurator<UsersCreateRequest.UsersCreateRequestBuilder> req)
                        throws IOException,
                               SCIMApiException

Throws:

IOException

SCIMApiException

patchUser

UsersPatchResponse patchUser(UsersPatchRequest req)
                      throws IOException,
                             SCIMApiException

Throws:

IOException

SCIMApiException

patchUser

UsersPatchResponse patchUser(RequestConfigurator<UsersPatchRequest.UsersPatchRequestBuilder> req)
                      throws IOException,
                             SCIMApiException

Throws:

IOException

SCIMApiException

updateUser

UsersUpdateResponse updateUser(UsersUpdateRequest req)
                        throws IOException,
                               SCIMApiException

Throws:

IOException

SCIMApiException

updateUser

UsersUpdateResponse updateUser(RequestConfigurator<UsersUpdateRequest.UsersUpdateRequestBuilder> req)
                        throws IOException,
                               SCIMApiException

Throws:

IOException

SCIMApiException

deleteUser

UsersDeleteResponse deleteUser(UsersDeleteRequest req)
                        throws IOException,
                               SCIMApiException

Throws:

IOException

SCIMApiException

deleteUser

UsersDeleteResponse deleteUser(RequestConfigurator<UsersDeleteRequest.UsersDeleteRequestBuilder> req)
                        throws IOException,
                               SCIMApiException

Throws:

IOException

SCIMApiException

searchGroups

GroupsSearchResponse searchGroups(GroupsSearchRequest req)
                           throws IOException,
                                  SCIMApiException

Throws:

IOException

SCIMApiException

searchGroups

GroupsSearchResponse searchGroups(RequestConfigurator<GroupsSearchRequest.GroupsSearchRequestBuilder> req)
                           throws IOException,
                                  SCIMApiException

Throws:

IOException

SCIMApiException

readGroup

GroupsReadResponse readGroup(GroupsReadRequest req)
                      throws IOException,
                             SCIMApiException

Throws:

IOException

SCIMApiException

readGroup

GroupsReadResponse readGroup(RequestConfigurator<GroupsReadRequest.GroupsReadRequestBuilder> req)
                      throws IOException,
                             SCIMApiException

Throws:

IOException

SCIMApiException

createGroup

GroupsCreateResponse createGroup(GroupsCreateRequest req)
                          throws IOException,
                                 SCIMApiException

Throws:

IOException

SCIMApiException

createGroup

GroupsCreateResponse createGroup(RequestConfigurator<GroupsCreateRequest.GroupsCreateRequestBuilder> req)
                          throws IOException,
                                 SCIMApiException

Throws:

IOException

SCIMApiException

patchGroup

GroupsPatchResponse patchGroup(GroupsPatchRequest req)
                        throws IOException,
                               SCIMApiException

Throws:

IOException

SCIMApiException

patchGroup

GroupsPatchResponse patchGroup(RequestConfigurator<GroupsPatchRequest.GroupsPatchRequestBuilder> req)
                        throws IOException,
                               SCIMApiException

Throws:

IOException

SCIMApiException

updateGroup

GroupsUpdateResponse updateGroup(GroupsUpdateRequest req)
                          throws IOException,
                                 SCIMApiException

Throws:

IOException

SCIMApiException

updateGroup

GroupsUpdateResponse updateGroup(RequestConfigurator<GroupsUpdateRequest.GroupsUpdateRequestBuilder> req)
                          throws IOException,
                                 SCIMApiException

Throws:

IOException

SCIMApiException

deleteGroup

GroupsDeleteResponse deleteGroup(GroupsDeleteRequest req)
                          throws IOException,
                                 SCIMApiException

Throws:

IOException

SCIMApiException

deleteGroup

GroupsDeleteResponse deleteGroup(RequestConfigurator<GroupsDeleteRequest.GroupsDeleteRequestBuilder> req)
                          throws IOException,
                                 SCIMApiException

Throws:

IOException

SCIMApiException