Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* (C) Copyright IBM Corp. 2023.
*
* 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.
*/
/*
* IBM OpenAPI SDK Code Generator Version: 3.70.0-7df966bf-20230419-195904
*/
package com.ibm.cloud.platform_services.user_management.v1;
import com.google.gson.JsonObject;
import com.ibm.cloud.platform_services.common.SdkCommon;
import com.ibm.cloud.platform_services.user_management.v1.model.AcceptOptions;
import com.ibm.cloud.platform_services.user_management.v1.model.GetUserProfileOptions;
import com.ibm.cloud.platform_services.user_management.v1.model.GetUserSettingsOptions;
import com.ibm.cloud.platform_services.user_management.v1.model.InviteUsersOptions;
import com.ibm.cloud.platform_services.user_management.v1.model.InvitedUserList;
import com.ibm.cloud.platform_services.user_management.v1.model.ListUsersOptions;
import com.ibm.cloud.platform_services.user_management.v1.model.RemoveUserOptions;
import com.ibm.cloud.platform_services.user_management.v1.model.UpdateUserProfileOptions;
import com.ibm.cloud.platform_services.user_management.v1.model.UpdateUserSettingsOptions;
import com.ibm.cloud.platform_services.user_management.v1.model.UserList;
import com.ibm.cloud.platform_services.user_management.v1.model.UserProfile;
import com.ibm.cloud.platform_services.user_management.v1.model.UserSettings;
import com.ibm.cloud.platform_services.user_management.v1.model.V3RemoveUserOptions;
import com.ibm.cloud.sdk.core.http.RequestBuilder;
import com.ibm.cloud.sdk.core.http.ResponseConverter;
import com.ibm.cloud.sdk.core.http.ServiceCall;
import com.ibm.cloud.sdk.core.security.Authenticator;
import com.ibm.cloud.sdk.core.security.ConfigBasedAuthenticatorFactory;
import com.ibm.cloud.sdk.core.service.BaseService;
import com.ibm.cloud.sdk.core.util.ResponseConverterUtils;
import java.util.HashMap;
import java.util.Map;
import java.util.Map.Entry;
/**
* Manage the lifecycle of your users using User Management APIs.
*
* API Version: 1.0
*/
public class UserManagement extends BaseService {
/**
* Default service name used when configuring the `UserManagement` client.
*/
public static final String DEFAULT_SERVICE_NAME = "user_management";
/**
* Default service endpoint URL.
*/
public static final String DEFAULT_SERVICE_URL = "https://user-management.cloud.ibm.com";
/**
* Class method which constructs an instance of the `UserManagement` client.
* The default service name is used to configure the client instance.
*
* @return an instance of the `UserManagement` client using external configuration
*/
public static UserManagement newInstance() {
return newInstance(DEFAULT_SERVICE_NAME);
}
/**
* Class method which constructs an instance of the `UserManagement` client.
* The specified service name is used to configure the client instance.
*
* @param serviceName the service name to be used when configuring the client instance
* @return an instance of the `UserManagement` client using external configuration
*/
public static UserManagement newInstance(String serviceName) {
Authenticator authenticator = ConfigBasedAuthenticatorFactory.getAuthenticator(serviceName);
UserManagement service = new UserManagement(serviceName, authenticator);
service.configureService(serviceName);
return service;
}
/**
* Constructs an instance of the `UserManagement` client.
* The specified service name and authenticator are used to configure the client instance.
*
* @param serviceName the service name to be used when configuring the client instance
* @param authenticator the {@link Authenticator} instance to be configured for this client
*/
public UserManagement(String serviceName, Authenticator authenticator) {
super(serviceName, authenticator);
setServiceUrl(DEFAULT_SERVICE_URL);
}
/**
* List users.
*
* Retrieve users in the account. You can use the IAM service token or a user token for authorization. To use this
* method, the requesting user or service ID must have at least the viewer, editor, or administrator role on the User
* Management service. If unrestricted view is enabled, the user can see all users in the same account without an IAM
* role. If restricted view is enabled and user has the viewer, editor, or administrator role on the user management
* service, the API returns all users in the account. If unrestricted view is enabled and the user does not have these
* roles, the API returns only the current user. Users are returned in a paginated list with a default limit of 100
* users. You can iterate through all users by following the `next_url` field. Additional substring search fields are
* supported to filter the users.
*
* @param listUsersOptions the {@link ListUsersOptions} containing the options for the call
* @return a {@link ServiceCall} with a result of type {@link UserList}
*/
public ServiceCall listUsers(ListUsersOptions listUsersOptions) {
com.ibm.cloud.sdk.core.util.Validator.notNull(listUsersOptions,
"listUsersOptions cannot be null");
Map pathParamsMap = new HashMap();
pathParamsMap.put("account_id", listUsersOptions.accountId());
RequestBuilder builder = RequestBuilder.get(RequestBuilder.resolveRequestUrl(getServiceUrl(), "/v2/accounts/{account_id}/users", pathParamsMap));
Map sdkHeaders = SdkCommon.getSdkHeaders("user_management", "v1", "listUsers");
for (Entry header : sdkHeaders.entrySet()) {
builder.header(header.getKey(), header.getValue());
}
builder.header("Accept", "application/json");
if (listUsersOptions.limit() != null) {
builder.query("limit", String.valueOf(listUsersOptions.limit()));
}
if (listUsersOptions.includeSettings() != null) {
builder.query("include_settings", String.valueOf(listUsersOptions.includeSettings()));
}
if (listUsersOptions.search() != null) {
builder.query("search", String.valueOf(listUsersOptions.search()));
}
if (listUsersOptions.start() != null) {
builder.query("_start", String.valueOf(listUsersOptions.start()));
}
if (listUsersOptions.userId() != null) {
builder.query("user_id", String.valueOf(listUsersOptions.userId()));
}
ResponseConverter responseConverter =
ResponseConverterUtils.getValue(new com.google.gson.reflect.TypeToken() { }.getType());
return createServiceCall(builder.build(), responseConverter);
}
/**
* Invite users to an account.
*
* Invite users to the account. You must use a user token for authorization. Service IDs can't invite users to the
* account. To use this method, the requesting user must have the editor or administrator role on the User Management
* service. For more information, see the [Inviting
* users](https://cloud.ibm.com/docs/account?topic=account-iamuserinv) documentation. You can specify the user account
* role and the corresponding IAM policy information in the request body. <br/><br/>When you invite a user
* to an account, the user is initially created in the `PROCESSING` state. After the user is successfully created, all
* specified permissions are configured, and the activation email is sent, the invited user is transitioned to the
* `PENDING` state. When the invited user clicks the activation email and creates and confirms their IBM Cloud
* account, the user is transitioned to `ACTIVE` state. If the user email is already verified, no email is generated.
*
* @param inviteUsersOptions the {@link InviteUsersOptions} containing the options for the call
* @return a {@link ServiceCall} with a result of type {@link InvitedUserList}
*/
public ServiceCall inviteUsers(InviteUsersOptions inviteUsersOptions) {
com.ibm.cloud.sdk.core.util.Validator.notNull(inviteUsersOptions,
"inviteUsersOptions cannot be null");
Map pathParamsMap = new HashMap();
pathParamsMap.put("account_id", inviteUsersOptions.accountId());
RequestBuilder builder = RequestBuilder.post(RequestBuilder.resolveRequestUrl(getServiceUrl(), "/v2/accounts/{account_id}/users", pathParamsMap));
Map sdkHeaders = SdkCommon.getSdkHeaders("user_management", "v1", "inviteUsers");
for (Entry header : sdkHeaders.entrySet()) {
builder.header(header.getKey(), header.getValue());
}
builder.header("Accept", "application/json");
final JsonObject contentJson = new JsonObject();
if (inviteUsersOptions.users() != null) {
contentJson.add("users", com.ibm.cloud.sdk.core.util.GsonSingleton.getGson().toJsonTree(inviteUsersOptions.users()));
}
if (inviteUsersOptions.iamPolicy() != null) {
contentJson.add("iam_policy", com.ibm.cloud.sdk.core.util.GsonSingleton.getGson().toJsonTree(inviteUsersOptions.iamPolicy()));
}
if (inviteUsersOptions.accessGroups() != null) {
contentJson.add("access_groups", com.ibm.cloud.sdk.core.util.GsonSingleton.getGson().toJsonTree(inviteUsersOptions.accessGroups()));
}
builder.bodyJson(contentJson);
ResponseConverter responseConverter =
ResponseConverterUtils.getValue(new com.google.gson.reflect.TypeToken() { }.getType());
return createServiceCall(builder.build(), responseConverter);
}
/**
* Get user profile.
*
* Retrieve a user's profile by the user's IAM ID in your account. You can use the IAM service token or a user token
* for authorization. To use this method, the requesting user or service ID must have at least the viewer, editor, or
* administrator role on the User Management service.
*
* @param getUserProfileOptions the {@link GetUserProfileOptions} containing the options for the call
* @return a {@link ServiceCall} with a result of type {@link UserProfile}
*/
public ServiceCall getUserProfile(GetUserProfileOptions getUserProfileOptions) {
com.ibm.cloud.sdk.core.util.Validator.notNull(getUserProfileOptions,
"getUserProfileOptions cannot be null");
Map pathParamsMap = new HashMap();
pathParamsMap.put("account_id", getUserProfileOptions.accountId());
pathParamsMap.put("iam_id", getUserProfileOptions.iamId());
RequestBuilder builder = RequestBuilder.get(RequestBuilder.resolveRequestUrl(getServiceUrl(), "/v2/accounts/{account_id}/users/{iam_id}", pathParamsMap));
Map sdkHeaders = SdkCommon.getSdkHeaders("user_management", "v1", "getUserProfile");
for (Entry header : sdkHeaders.entrySet()) {
builder.header(header.getKey(), header.getValue());
}
builder.header("Accept", "application/json");
if (getUserProfileOptions.includeActivity() != null) {
builder.query("include_activity", String.valueOf(getUserProfileOptions.includeActivity()));
}
ResponseConverter responseConverter =
ResponseConverterUtils.getValue(new com.google.gson.reflect.TypeToken() { }.getType());
return createServiceCall(builder.build(), responseConverter);
}
/**
* Partially update user profile.
*
* Partially update a user's profile by user's IAM ID. You can use the IAM service token or a user token for
* authorization. To use this method, the requesting user or service ID must have at least the editor or administrator
* role on the User Management service. A user or service ID with these roles can change a user's state between
* `ACTIVE`, `VPN_ONLY`, or `DISABLED_CLASSIC_INFRASTRUCTURE`, but they can't change the state to `PROCESSING` or
* `PENDING` because these are system states. For other request body fields, a user can update their own profile
* without having User Management service permissions.
*
* @param updateUserProfileOptions the {@link UpdateUserProfileOptions} containing the options for the call
* @return a {@link ServiceCall} with a void result
*/
public ServiceCall updateUserProfile(UpdateUserProfileOptions updateUserProfileOptions) {
com.ibm.cloud.sdk.core.util.Validator.notNull(updateUserProfileOptions,
"updateUserProfileOptions cannot be null");
Map pathParamsMap = new HashMap();
pathParamsMap.put("account_id", updateUserProfileOptions.accountId());
pathParamsMap.put("iam_id", updateUserProfileOptions.iamId());
RequestBuilder builder = RequestBuilder.patch(RequestBuilder.resolveRequestUrl(getServiceUrl(), "/v2/accounts/{account_id}/users/{iam_id}", pathParamsMap));
Map sdkHeaders = SdkCommon.getSdkHeaders("user_management", "v1", "updateUserProfile");
for (Entry header : sdkHeaders.entrySet()) {
builder.header(header.getKey(), header.getValue());
}
if (updateUserProfileOptions.includeActivity() != null) {
builder.query("include_activity", String.valueOf(updateUserProfileOptions.includeActivity()));
}
final JsonObject contentJson = new JsonObject();
if (updateUserProfileOptions.firstname() != null) {
contentJson.addProperty("firstname", updateUserProfileOptions.firstname());
}
if (updateUserProfileOptions.lastname() != null) {
contentJson.addProperty("lastname", updateUserProfileOptions.lastname());
}
if (updateUserProfileOptions.state() != null) {
contentJson.addProperty("state", updateUserProfileOptions.state());
}
if (updateUserProfileOptions.email() != null) {
contentJson.addProperty("email", updateUserProfileOptions.email());
}
if (updateUserProfileOptions.phonenumber() != null) {
contentJson.addProperty("phonenumber", updateUserProfileOptions.phonenumber());
}
if (updateUserProfileOptions.altphonenumber() != null) {
contentJson.addProperty("altphonenumber", updateUserProfileOptions.altphonenumber());
}
if (updateUserProfileOptions.photo() != null) {
contentJson.addProperty("photo", updateUserProfileOptions.photo());
}
builder.bodyJson(contentJson);
ResponseConverter responseConverter = ResponseConverterUtils.getVoid();
return createServiceCall(builder.build(), responseConverter);
}
/**
* Remove user from account.
*
* Remove users from an account by user's IAM ID. You must use a user token for authorization. Service IDs can't
* remove users from an account. To use this method, the requesting user must have the editor or administrator role on
* the User Management service. For more information, see the [Removing
* users](https://cloud.ibm.com/docs/account?topic=account-remove) documentation.
*
* @param removeUserOptions the {@link RemoveUserOptions} containing the options for the call
* @return a {@link ServiceCall} with a void result
*/
public ServiceCall removeUser(RemoveUserOptions removeUserOptions) {
com.ibm.cloud.sdk.core.util.Validator.notNull(removeUserOptions,
"removeUserOptions cannot be null");
Map pathParamsMap = new HashMap();
pathParamsMap.put("account_id", removeUserOptions.accountId());
pathParamsMap.put("iam_id", removeUserOptions.iamId());
RequestBuilder builder = RequestBuilder.delete(RequestBuilder.resolveRequestUrl(getServiceUrl(), "/v2/accounts/{account_id}/users/{iam_id}", pathParamsMap));
Map sdkHeaders = SdkCommon.getSdkHeaders("user_management", "v1", "removeUser");
for (Entry header : sdkHeaders.entrySet()) {
builder.header(header.getKey(), header.getValue());
}
if (removeUserOptions.includeActivity() != null) {
builder.query("include_activity", String.valueOf(removeUserOptions.includeActivity()));
}
ResponseConverter responseConverter = ResponseConverterUtils.getVoid();
return createServiceCall(builder.build(), responseConverter);
}
/**
* Accept an invitation.
*
* Accept a user invitation to an account. You can use the user's token for authorization. To use this method, the
* requesting user must provide the account ID for the account that they are accepting an invitation for. If the user
* already accepted the invitation request, it returns 204 with no response body.
*
* @param acceptOptions the {@link AcceptOptions} containing the options for the call
* @return a {@link ServiceCall} with a void result
*/
public ServiceCall accept(AcceptOptions acceptOptions) {
boolean skipBody = false;
if (acceptOptions == null) {
acceptOptions = new AcceptOptions.Builder().build();
skipBody = true;
}
RequestBuilder builder = RequestBuilder.post(RequestBuilder.resolveRequestUrl(getServiceUrl(), "/v2/users/accept"));
Map sdkHeaders = SdkCommon.getSdkHeaders("user_management", "v1", "accept");
for (Entry header : sdkHeaders.entrySet()) {
builder.header(header.getKey(), header.getValue());
}
if (!skipBody) {
final JsonObject contentJson = new JsonObject();
if (acceptOptions.accountId() != null) {
contentJson.addProperty("account_id", acceptOptions.accountId());
}
builder.bodyJson(contentJson);
}
ResponseConverter responseConverter = ResponseConverterUtils.getVoid();
return createServiceCall(builder.build(), responseConverter);
}
/**
* Accept an invitation.
*
* Accept a user invitation to an account. You can use the user's token for authorization. To use this method, the
* requesting user must provide the account ID for the account that they are accepting an invitation for. If the user
* already accepted the invitation request, it returns 204 with no response body.
*
* @return a {@link ServiceCall} with a void result
*/
public ServiceCall accept() {
return accept(null);
}
/**
* Remove user from account (Asynchronous).
*
* Remove users from an account by using the user's IAM ID. You must use a user token for authorization. Service IDs
* can't remove users from an account. If removing the user fails it will set the user's state to
* ERROR_WHILE_DELETING. To use this method, the requesting user must have the editor or administrator role on the
* User Management service. For more information, see the [Removing
* users](https://cloud.ibm.com/docs/account?topic=account-remove) documentation.
*
* @param v3RemoveUserOptions the {@link V3RemoveUserOptions} containing the options for the call
* @return a {@link ServiceCall} with a void result
*/
public ServiceCall v3RemoveUser(V3RemoveUserOptions v3RemoveUserOptions) {
com.ibm.cloud.sdk.core.util.Validator.notNull(v3RemoveUserOptions,
"v3RemoveUserOptions cannot be null");
Map pathParamsMap = new HashMap();
pathParamsMap.put("account_id", v3RemoveUserOptions.accountId());
pathParamsMap.put("iam_id", v3RemoveUserOptions.iamId());
RequestBuilder builder = RequestBuilder.delete(RequestBuilder.resolveRequestUrl(getServiceUrl(), "/v3/accounts/{account_id}/users/{iam_id}", pathParamsMap));
Map sdkHeaders = SdkCommon.getSdkHeaders("user_management", "v1", "v3RemoveUser");
for (Entry header : sdkHeaders.entrySet()) {
builder.header(header.getKey(), header.getValue());
}
ResponseConverter responseConverter = ResponseConverterUtils.getVoid();
return createServiceCall(builder.build(), responseConverter);
}
/**
* Get user settings.
*
* Retrieve a user's settings by the user's IAM ID. You can use the IAM service token or a user token for
* authorization. To use this method, the requesting user or service ID must have the viewer, editor, or administrator
* role on the User Management service. <br/><br/>The user settings have several fields. The `language`
* field is the language setting for the user interface display language. The `notification_language` field is the
* language setting for phone and email notifications. The `allowed_ip_addresses` field specifies a list of IP
* addresses that the user can log in and perform operations from as described in [Allowing specific IP addresses for
* a user](https://cloud.ibm.com/docs/account?topic=account-ips). For information about the `self_manage` field,
* review information about the [user-managed login setting](https://cloud.ibm.com/docs/account?topic=account-types).
*
* @param getUserSettingsOptions the {@link GetUserSettingsOptions} containing the options for the call
* @return a {@link ServiceCall} with a result of type {@link UserSettings}
*/
public ServiceCall getUserSettings(GetUserSettingsOptions getUserSettingsOptions) {
com.ibm.cloud.sdk.core.util.Validator.notNull(getUserSettingsOptions,
"getUserSettingsOptions cannot be null");
Map pathParamsMap = new HashMap();
pathParamsMap.put("account_id", getUserSettingsOptions.accountId());
pathParamsMap.put("iam_id", getUserSettingsOptions.iamId());
RequestBuilder builder = RequestBuilder.get(RequestBuilder.resolveRequestUrl(getServiceUrl(), "/v2/accounts/{account_id}/users/{iam_id}/settings", pathParamsMap));
Map sdkHeaders = SdkCommon.getSdkHeaders("user_management", "v1", "getUserSettings");
for (Entry header : sdkHeaders.entrySet()) {
builder.header(header.getKey(), header.getValue());
}
builder.header("Accept", "application/json");
ResponseConverter responseConverter =
ResponseConverterUtils.getValue(new com.google.gson.reflect.TypeToken() { }.getType());
return createServiceCall(builder.build(), responseConverter);
}
/**
* Partially update user settings.
*
* Update a user's settings by the user's IAM ID. You can use the IAM service token or a user token for authorization.
* To fully use this method, the user or service ID must have the editor or administrator role on the User Management
* service. Without these roles, a user can update only their own `language` or `notification_language` fields. If
* `self_manage` is `true`, the user can also update the `allowed_ip_addresses` field.
*
* @param updateUserSettingsOptions the {@link UpdateUserSettingsOptions} containing the options for the call
* @return a {@link ServiceCall} with a void result
*/
public ServiceCall updateUserSettings(UpdateUserSettingsOptions updateUserSettingsOptions) {
com.ibm.cloud.sdk.core.util.Validator.notNull(updateUserSettingsOptions,
"updateUserSettingsOptions cannot be null");
Map pathParamsMap = new HashMap();
pathParamsMap.put("account_id", updateUserSettingsOptions.accountId());
pathParamsMap.put("iam_id", updateUserSettingsOptions.iamId());
RequestBuilder builder = RequestBuilder.patch(RequestBuilder.resolveRequestUrl(getServiceUrl(), "/v2/accounts/{account_id}/users/{iam_id}/settings", pathParamsMap));
Map sdkHeaders = SdkCommon.getSdkHeaders("user_management", "v1", "updateUserSettings");
for (Entry header : sdkHeaders.entrySet()) {
builder.header(header.getKey(), header.getValue());
}
final JsonObject contentJson = new JsonObject();
if (updateUserSettingsOptions.language() != null) {
contentJson.addProperty("language", updateUserSettingsOptions.language());
}
if (updateUserSettingsOptions.notificationLanguage() != null) {
contentJson.addProperty("notification_language", updateUserSettingsOptions.notificationLanguage());
}
if (updateUserSettingsOptions.allowedIpAddresses() != null) {
contentJson.addProperty("allowed_ip_addresses", updateUserSettingsOptions.allowedIpAddresses());
}
if (updateUserSettingsOptions.selfManage() != null) {
contentJson.addProperty("self_manage", updateUserSettingsOptions.selfManage());
}
builder.bodyJson(contentJson);
ResponseConverter responseConverter = ResponseConverterUtils.getVoid();
return createServiceCall(builder.build(), responseConverter);
}
}
