Skip to content

fix(User Management): add examples #80

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
padamstx merged 5 commits into from
Feb 25, 2021
Merged

fix(User Management): add examples #80

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e427ce9
fix(User Management): add examples
pyrooka Feb 24, 2021
5501ca1
chore: improve user management integration tests
pyrooka Feb 24, 2021
0911e52
chore: add user management examples to the maven config
pyrooka Feb 24, 2021
ec64e8f
chore: modify examples
pyrooka Feb 24, 2021
94daff8
chore: improve examples with cleaner syntax
pyrooka Feb 25, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions modules/examples/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,11 @@
<artifactId>usage-reports</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>${project.groupId}</groupId>
<artifactId>user-management</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-jdk14</artifactId>
Expand Down
241 changes: 241 additions & 0 deletions .../main/java/com/ibm/cloud/platform_services/user_management/v1/UserManagementExamples.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,241 @@
/*
* (C) Copyright IBM Corp. 2021.
*
* 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 com.ibm.cloud.platform_services.user_management.v1;

import com.ibm.cloud.platform_services.user_management.v1.model.Attribute;
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.InviteUser;
import com.ibm.cloud.platform_services.user_management.v1.model.InviteUserIamPolicy;
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.Resource;
import com.ibm.cloud.platform_services.user_management.v1.model.Role;
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.sdk.core.http.Response;
import com.ibm.cloud.sdk.core.service.exception.ServiceResponseException;
import com.ibm.cloud.sdk.core.util.CredentialUtils;
import java.util.Map;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

//
// This file provides an example of how to use the User Management service.
//
// The following configuration properties are assumed to be defined:
//
// USER_MANAGEMENT_URL=<service url>
// USER_MANAGEMENT_AUTHTYPE=iam
// USER_MANAGEMENT_AUTH_URL=<IAM token service URL - omit this if using the production environment>
// USER_MANAGEMENT_APIKEY=<IAM apikey>
// USER_MANAGEMENT_ACCOUNT_ID=<account ID>
// USER_MANAGEMENT_USER_ID=<user ID>
// USER_MANAGEMENT_MEMBER_EMAIL=<member email to invite>
// USER_MANAGEMENT_VIEWER_ROLE_ID=<viewer role ID>
// USER_MANAGEMENT_ACCESS_GROUP_ID=<access group ID>
// # alternateService
// USER_MANAGEMENT_ADMIN_URL=<service url>
// USER_MANAGEMENT_ADMIN_AUTHTYPE=iam
// USER_MANAGEMENT_ADMIN_AUTH_URL=<IAM token service URL - omit this if using the production environment>
// USER_MANAGEMENT_ADMIN_APIKEY=<IAM apikey>
//
// These configuration properties can be exported as environment variables, or stored
// in a configuration file and then:
// export IBM_CREDENTIALS_FILE=<name of configuration file>
//
public class UserManagementExamples {
private static final Logger logger = LoggerFactory.getLogger(UserManagementExamples.class);
protected UserManagementExamples() { }

private static String accountId;
private static String userId;
private static String memberEmail;
private static String viewerRoleId;
private static String accessGroupId;

private static String deleteUserId;

static {
System.setProperty("IBM_CREDENTIALS_FILE", "../../user_management.env");
}

@SuppressWarnings("checkstyle:methodlength")
public static void main(String[] args) throws Exception {
UserManagement service = UserManagement.newInstance(UserManagement.DEFAULT_SERVICE_NAME);
UserManagement adminService = UserManagement.newInstance("USER_MANAGEMENT_ADMIN");

// Load up our test-specific config properties.
Map<String, String> config = CredentialUtils.getServiceProperties(UserManagement.DEFAULT_SERVICE_NAME);

accountId = config.get("ACCOUNT_ID");
userId = config.get("USER_ID");
memberEmail = config.get("MEMBER_EMAIL");
viewerRoleId = config.get("VIEWER_ROLE_ID");
accessGroupId = config.get("ACCESS_GROUP_ID");

try {
// begin-invite_users
InviteUser inviteUserModel = new InviteUser.Builder()
.email(memberEmail)
.accountRole("Member")
.build();

Role roleModel = new Role.Builder()
.roleId(viewerRoleId)
.build();

Attribute attributeModel = new Attribute.Builder()
.name("accountId")
.value(accountId)
.build();

Attribute attributeModel2 = new Attribute.Builder()
.name("resourceGroupId")
.value("*")
.build();

Resource resourceModel = new Resource.Builder()
.addAttributes(attributeModel)
.addAttributes(attributeModel2)
.build();

InviteUserIamPolicy inviteUserIamPolicyModel = new InviteUserIamPolicy.Builder()
.type("access")
.addRoles(roleModel)
.addResources(resourceModel)
.build();

InviteUsersOptions inviteUsersOptions = new InviteUsersOptions.Builder()
.accountId(accountId)
.addUsers(inviteUserModel)
.addIamPolicy(inviteUserIamPolicyModel)
.addAccessGroups(accessGroupId)
.build();

Response<InvitedUserList> response = adminService.inviteUsers(inviteUsersOptions).execute();
InvitedUserList invitedUserList = response.getResult();

System.out.println(invitedUserList);
// end-invite_users
deleteUserId = invitedUserList.getResources().get(0).getId();
} catch (ServiceResponseException e) {
logger.error(String.format("Service returned status code %s: %s\nError details: %s",
e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()), e);
}

try {
// begin-list_users
ListUsersOptions listUsersOptions = new ListUsersOptions.Builder()
.accountId(accountId)
.state("ACTIVE")
.limit(100)
.build();

Response<UserList> response = service.listUsers(listUsersOptions).execute();
UserList userList = response.getResult();

System.out.println(userList);
// end-list_users
} catch (ServiceResponseException e) {
logger.error(String.format("Service returned status code %s: %s\nError details: %s",
e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()), e);
}

try {
// begin-remove_user
RemoveUserOptions removeUserOptions = new RemoveUserOptions.Builder()
.accountId(accountId)
.iamId(deleteUserId)
.build();

service.removeUser(removeUserOptions).execute();
// end-remove_user
} catch (ServiceResponseException e) {
logger.error(String.format("Service returned status code %s: %s\nError details: %s",
e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()), e);
}

try {
// begin-get_user_profile
GetUserProfileOptions getUserProfileOptions = new GetUserProfileOptions.Builder()
.accountId(accountId)
.iamId(userId)
.build();

Response<UserProfile> response = service.getUserProfile(getUserProfileOptions).execute();
UserProfile userProfile = response.getResult();

System.out.println(userProfile);
// end-get_user_profile
} catch (ServiceResponseException e) {
logger.error(String.format("Service returned status code %s: %s\nError details: %s",
e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()), e);
}

try {
// begin-update_user_profile
UpdateUserProfileOptions updateUserProfileOptions = new UpdateUserProfileOptions.Builder()
.accountId(accountId)
.iamId(userId)
.phonenumber("123456789")
.build();

service.updateUserProfile(updateUserProfileOptions).execute();
// end-update_user_profile
} catch (ServiceResponseException e) {
logger.error(String.format("Service returned status code %s: %s\nError details: %s",
e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()), e);
}

try {
// begin-get_user_settings
GetUserSettingsOptions getUserSettingsOptions = new GetUserSettingsOptions.Builder()
.accountId(accountId)
.iamId(userId)
.build();

Response<UserSettings> response = service.getUserSettings(getUserSettingsOptions).execute();
UserSettings userSettings = response.getResult();

System.out.println(userSettings);
// end-get_user_settings
} catch (ServiceResponseException e) {
logger.error(String.format("Service returned status code %s: %s\nError details: %s",
e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()), e);
}

try {
// begin-update_user_settings
UpdateUserSettingsOptions updateUserSettingsOptions = new UpdateUserSettingsOptions.Builder()
.accountId(accountId)
.iamId(userId)
.selfManage(true)
.allowedIpAddresses("192.168.0.2,192.168.0.3")
.build();

service.updateUserSettings(updateUserSettingsOptions).execute();
// end-update_user_settings
} catch (ServiceResponseException e) {
logger.error(String.format("Service returned status code %s: %s\nError details: %s",
e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()), e);
}

}
}
36 changes: 24 additions & 12 deletions ...nt/src/test/java/com/ibm/cloud/platform_services/user_management/v1/UserManagementIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,17 +58,17 @@
*/
public class UserManagementIT extends SdkIntegrationTestBase {
public UserManagement service = null;
public UserManagement alternateService = null;
public UserManagement adminService = null;
public static Map<String, String> config = null;
final HashMap<String, InputStream> mockStreamMap = TestUtilities.createMockStreamMap();
final List<FileWithMetadata> mockListFileWithMetadata = TestUtilities.creatMockListFileWithMetadata();
public String userId = null;

public static final String ACCOUNT_ID = "1aa434630b594b8a88b961a44c9eb2a9";
public static final String IAM_USERID = "IBMid-550008BJPR";
public static final String INVITED_USER_EMAIL = "aminttest+linked_account_owner_11@mail.test.ibm.com";
public static final String VIEWER_ROLEID = "crn:v1:bluemix:public:iam::::role:Viewer";
public static final String ACCESS_GROUP_ID = "AccessGroupId-51675919-2bd7-4ce3-86e4-5faff8065574";
private static String ACCOUNT_ID;
private static String IAM_USERID;
private static String INVITED_USER_EMAIL;
private static String VIEWER_ROLEID;
private static String ACCESS_GROUP_ID;

@Override
public String getConfigFilename() {
Expand All @@ -87,20 +87,32 @@ public void constructService() {
return;
}

service = UserManagement.newInstance("USERMGMT1");
service = UserManagement.newInstance(UserManagement.DEFAULT_SERVICE_NAME);
assertNotNull(service);
assertNotNull(service.getServiceUrl());

alternateService = UserManagement.newInstance("USERMGMT2");
assertNotNull(alternateService);
assertNotNull(alternateService.getServiceUrl());
adminService = UserManagement.newInstance("USER_MANAGEMENT_ADMIN");
assertNotNull(adminService);
assertNotNull(adminService.getServiceUrl());

// Load up our test-specific config properties.
config = CredentialUtils.getServiceProperties("USERMGMT1");
config = CredentialUtils.getServiceProperties(UserManagement.DEFAULT_SERVICE_NAME);
assertNotNull(config);
assertFalse(config.isEmpty());
assertEquals(service.getServiceUrl(), config.get("URL"));

ACCOUNT_ID = config.get("ACCOUNT_ID");
IAM_USERID = config.get("USER_ID");
INVITED_USER_EMAIL = config.get("MEMBER_EMAIL");
VIEWER_ROLEID = config.get("VIEWER_ROLE_ID");
ACCESS_GROUP_ID = config.get("ACCESS_GROUP_ID");

assertNotNull(ACCOUNT_ID);
assertNotNull(IAM_USERID);
assertNotNull(INVITED_USER_EMAIL);
assertNotNull(VIEWER_ROLEID);
assertNotNull(ACCESS_GROUP_ID);

log(String.format("Service URL: %s", service.getServiceUrl()));
log("Setup complete.");
}
Expand Down Expand Up @@ -234,7 +246,7 @@ public void testInviteUsers() throws Exception {
.build();

// Invoke operation
Response<InvitedUserList> response = alternateService.inviteUsers(inviteUsersOptions).execute();
Response<InvitedUserList> response = adminService.inviteUsers(inviteUsersOptions).execute();
// Validate response
assertNotNull(response);
assertEquals(response.getStatusCode(), 202);
Expand Down