Skip to content

Commit

Permalink
feature(membership_type support): Added membership supports to access…
Browse files Browse the repository at this point in the history 
… groups
  • Loading branch information
Narinder committed Apr 4, 2022
1 parent a371939 commit d669825
Show file tree
Hide file tree
Showing 4 changed files with 84 additions and 16 deletions.
40 changes: 37 additions & 3 deletions examples/iam-access-groups.v2.test.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,13 @@ const authHelper = require('../test/resources/auth-helper.js');
// IAM_ACCESS_GROUPS_APIKEY=<your iam apikey>
// IAM_ACCESS_GROUPS_AUTH_URL=<IAM token service URL - omit this if using the production environment>
// IAM_ACCESS_GROUPS_TEST_ACCOUNT_ID=<id of an account used for testing>
// IAM_ACCESS_GROUPS_TEST_PROFILE_ID=<id of an profile used for testing which exists in the account>
//
// 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>
//
const configFile = 'iam_access_groups.env';
const configFile = 'iam_access_groups_v2.env';

const describe = authHelper.prepareTests(configFile);

Expand All @@ -60,7 +61,7 @@ describe('IamAccessGroupsV2', () => {
const config = readExternalSources(IamAccessGroupsV2.DEFAULT_SERVICE_NAME);

let testAccountId = config.testAccountId;

let profileId = config.testProfileId
let testGroupETag;
let testGroupId;
let testClaimRuleId;
Expand Down Expand Up @@ -202,9 +203,14 @@ describe('IamAccessGroupsV2', () => {
iam_id: 'iam-ServiceId-123',
type: 'service',
};
var groupMember3 = {
iam_id: profileId,
type : 'profile',
}

const params = {
accessGroupId: testGroupId,
members: [groupMember1, groupMember2],
members: [groupMember1, groupMember2,groupMember3],
};

try {
Expand Down Expand Up @@ -323,6 +329,34 @@ describe('IamAccessGroupsV2', () => {

// end-remove_members_from_access_group
});
test('removeMembersFromAccessGroup request example', async () => {

consoleLogMock.mockImplementation(output => {
originalLog(output);
});
consoleWarnMock.mockImplementation(output => {
originalWarn(output);
// when the test fails we need to print out the error message and stop execution right after it
expect(true).toBeFalsy();
});

originalLog('removeMembersFromAccessGroup() result:');
// begin-remove_members_from_access_group

const params = {
accessGroupId: testGroupId,
members: [profileId]
};

try {
const res = await iamAccessGroupsService.removeMembersFromAccessGroup(params);
console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
console.warn(err);
}

// end-remove_members_from_access_group
});
test('addMemberToMultipleAccessGroups request example', async () => {

consoleLogMock.mockImplementation(output => {
Expand Down
52 changes: 40 additions & 12 deletions iam-access-groups/v2.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
*/

/**
* IBM OpenAPI SDK Code Generator Version: 3.43.4-432d779b-20220119-173927
* IBM OpenAPI SDK Code Generator Version: 3.46.1-a5569134-20220316-164819
*/

import * as extend from 'extend';
Expand Down Expand Up @@ -186,7 +186,11 @@ class IamAccessGroupsV2 extends BaseService {
* useful for tracking calls through multiple services by using one identifier. The header key must be set to
* Transaction-Id and the value is anything that you choose. If no transaction ID is passed in, then a random ID is
* generated.
* @param {string} [params.iamId] - Return groups for member id (IBMid, Service Id or Profile Id).
* @param {string} [params.iamId] - Return groups for member ID (IBMid, service ID or trusted profile ID).
* @param {string} [params.membershipType] - Membership type need to be specified along with iam_id and must be either
* `static`, `dynamic` or `all`. If membership type is `static`, members explicitly added to the group will be shown.
* If membership type is `dynamic`, members accessing the access group at the moment via dynamic rules will be shown.
* If membership type is `all`, both static and dynamic members will be shown.
* @param {number} [params.limit] - Return up to this limit of results where limit is between 0 and 100.
* @param {number} [params.offset] - The offset of the first result item to be returned.
* @param {string} [params.sort] - Sort the results by id, name, description, or is_federated flag.
Expand All @@ -206,6 +210,7 @@ class IamAccessGroupsV2 extends BaseService {
'accountId',
'transactionId',
'iamId',
'membershipType',
'limit',
'offset',
'sort',
Expand All @@ -221,6 +226,7 @@ class IamAccessGroupsV2 extends BaseService {
const query = {
'account_id': _params.accountId,
'iam_id': _params.iamId,
'membership_type': _params.membershipType,
'limit': _params.limit,
'offset': _params.offset,
'sort': _params.sort,
Expand Down Expand Up @@ -471,9 +477,9 @@ class IamAccessGroupsV2 extends BaseService {
/**
* Check membership in an access group.
*
* This HEAD operation determines if a given `iam_id` is present in a group. No response body is returned with this
* request. If the membership exists, a `204 - No Content` status code is returned. If the membership or the group
* does not exist, a `404 - Not Found` status code is returned.
* This HEAD operation determines if a given `iam_id` is present in a group either explicitly or via dynamic rules. No
* response body is returned with this request. If the membership exists, a `204 - No Content` status code is
* returned. If the membership or the group does not exist, a `404 - Not Found` status code is returned.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.accessGroupId - The access group identifier.
Expand Down Expand Up @@ -611,10 +617,13 @@ class IamAccessGroupsV2 extends BaseService {
* useful for tracking calls through multiple services by using one identifier. The header key must be set to
* Transaction-Id and the value is anything that you choose. If no transaction ID is passed in, then a random ID is
* generated.
* @param {string} [params.membershipType] - Filters members by membership type. Membership type can be either
* `static`, `dynamic` or `all`. `static` lists those members explicitly added to the access group, `dynamic` lists
* those members part of access group via dynamic rules at the moment. `all` lists both static and dynamic members.
* @param {number} [params.limit] - Return up to this limit of results where limit is between 0 and 100.
* @param {number} [params.offset] - The offset of the first result item to be returned.
* @param {string} [params.type] - Filter the results by member type.
* @param {boolean} [params.verbose] - Return user's email and name for each user id or the name for each service id
* @param {boolean} [params.verbose] - Return user's email and name for each user ID or the name for each service ID
* or trusted profile.
* @param {string} [params.sort] - If verbose is true, sort the results by id, name, or email.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
Expand All @@ -628,6 +637,7 @@ class IamAccessGroupsV2 extends BaseService {
const _validParams = [
'accessGroupId',
'transactionId',
'membershipType',
'limit',
'offset',
'type',
Expand All @@ -641,6 +651,7 @@ class IamAccessGroupsV2 extends BaseService {
}

const query = {
'membership_type': _params.membershipType,
'limit': _params.limit,
'offset': _params.offset,
'type': _params.type,
Expand Down Expand Up @@ -685,7 +696,8 @@ class IamAccessGroupsV2 extends BaseService {
* Delete member from an access group.
*
* Remove one member from a group using this API. If the operation is successful, only a `204 - No Content` response
* with no body is returned. However, if any error occurs, the standard error format will be returned.
* with no body is returned. However, if any error occurs, the standard error format will be returned. Dynamic member
* cannot be deleted using this API. Dynamic rules needs to be adjusted to delete dynamic members.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.accessGroupId - The access group identifier.
Expand Down Expand Up @@ -745,7 +757,8 @@ class IamAccessGroupsV2 extends BaseService {
*
* Remove multiple members from a group using this API. On a successful call, this API will always return 207. It is
* the caller's responsibility to iterate across the body to determine successful deletion of each member. This API
* request payload can delete up to 50 members per call.
* request payload can delete up to 50 members per call. This API doesnt delete dynamic members accessing the access
* group via dynamic rules.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.accessGroupId - The access group identifier.
Expand Down Expand Up @@ -1499,8 +1512,14 @@ namespace IamAccessGroupsV2 {
* anything that you choose. If no transaction ID is passed in, then a random ID is generated.
*/
transactionId?: string;
/** Return groups for member id (IBMid, Service Id or Profile Id). */
/** Return groups for member ID (IBMid, service ID or trusted profile ID). */
iamId?: string;
/** Membership type need to be specified along with iam_id and must be either `static`, `dynamic` or `all`. If
* membership type is `static`, members explicitly added to the group will be shown. If membership type is
* `dynamic`, members accessing the access group at the moment via dynamic rules will be shown. If membership type
* is `all`, both static and dynamic members will be shown.
*/
membershipType?: string;
/** Return up to this limit of results where limit is between 0 and 100. */
limit?: number;
/** The offset of the first result item to be returned. */
Expand Down Expand Up @@ -1605,13 +1624,18 @@ namespace IamAccessGroupsV2 {
* anything that you choose. If no transaction ID is passed in, then a random ID is generated.
*/
transactionId?: string;
/** Filters members by membership type. Membership type can be either `static`, `dynamic` or `all`. `static`
* lists those members explicitly added to the access group, `dynamic` lists those members part of access group via
* dynamic rules at the moment. `all` lists both static and dynamic members.
*/
membershipType?: string;
/** Return up to this limit of results where limit is between 0 and 100. */
limit?: number;
/** The offset of the first result item to be returned. */
offset?: number;
/** Filter the results by member type. */
type?: string;
/** Return user's email and name for each user id or the name for each service id or trusted profile. */
/** Return user's email and name for each user ID or the name for each service ID or trusted profile. */
verbose?: boolean;
/** If verbose is true, sort the results by id, name, or email. */
sort?: string;
Expand Down Expand Up @@ -1824,7 +1848,7 @@ namespace IamAccessGroupsV2 {

/** AddGroupMembersRequestMembersItem. */
export interface AddGroupMembersRequestMembersItem {
/** The IBMid, Service Id or Profile Id of the member. */
/** The IBMid, service ID or trusted profile ID of the member. */
iam_id: string;
/** The type of the member, must be either "user", "service" or "trusted profile". */
type: string;
Expand Down Expand Up @@ -1944,6 +1968,8 @@ namespace IamAccessGroupsV2 {
href?: string;
/** This is set to true if rules exist for the group. */
is_federated?: boolean;
/** Type of the membership. `static` or `dynamic`. */
membership_type?: string;
}

/** The members of a group. */
Expand Down Expand Up @@ -1996,8 +2022,10 @@ namespace IamAccessGroupsV2 {
export interface ListGroupMembersResponseMember {
/** The IBMid or Service Id of the member. */
iam_id?: string;
/** The member type - either `user` or `service`. */
/** The member type - either `user`, `service` or `profile`. */
type?: string;
/** The membership type - either `static` or `dynamic`. */
membership_type?: string;
/** The user's or service id's name. */
name?: string;
/** If the member type is user, this is the user's email. */
Expand Down
2 changes: 1 addition & 1 deletion test/integration/iam-access-groups.v2.test.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ const authHelper = require('../resources/auth-helper.js');
const timeout = 25000;

// Location of our config file.
const configFile = 'iam_access_groups.env';
const configFile = 'iam_access_groups_v2.env';

// Use authHelper to skip tests if our configFile is not available.
const describe = authHelper.prepareTests(configFile);
Expand Down
6 changes: 6 additions & 0 deletions test/unit/iam-access-groups.v2.test.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -200,6 +200,7 @@ describe('IamAccessGroupsV2', () => {
const accountId = 'testString';
const transactionId = 'testString';
const iamId = 'testString';
const membershipType = 'static';
const limit = 38;
const offset = 38;
const sort = 'name';
Expand All @@ -209,6 +210,7 @@ describe('IamAccessGroupsV2', () => {
accountId: accountId,
transactionId: transactionId,
iamId: iamId,
membershipType: membershipType,
limit: limit,
offset: offset,
sort: sort,
Expand All @@ -233,6 +235,7 @@ describe('IamAccessGroupsV2', () => {
checkUserHeader(createRequestMock, 'Transaction-Id', transactionId);
expect(mockRequestOptions.qs.account_id).toEqual(accountId);
expect(mockRequestOptions.qs.iam_id).toEqual(iamId);
expect(mockRequestOptions.qs.membership_type).toEqual(membershipType);
expect(mockRequestOptions.qs.limit).toEqual(limit);
expect(mockRequestOptions.qs.offset).toEqual(offset);
expect(mockRequestOptions.qs.sort).toEqual(sort);
Expand Down Expand Up @@ -766,6 +769,7 @@ describe('IamAccessGroupsV2', () => {
// Construct the params object for operation listAccessGroupMembers
const accessGroupId = 'testString';
const transactionId = 'testString';
const membershipType = 'static';
const limit = 38;
const offset = 38;
const type = 'testString';
Expand All @@ -774,6 +778,7 @@ describe('IamAccessGroupsV2', () => {
const listAccessGroupMembersParams = {
accessGroupId: accessGroupId,
transactionId: transactionId,
membershipType: membershipType,
limit: limit,
offset: offset,
type: type,
Expand All @@ -796,6 +801,7 @@ describe('IamAccessGroupsV2', () => {
const expectedContentType = undefined;
checkMediaHeaders(createRequestMock, expectedAccept, expectedContentType);
checkUserHeader(createRequestMock, 'Transaction-Id', transactionId);
expect(mockRequestOptions.qs.membership_type).toEqual(membershipType);
expect(mockRequestOptions.qs.limit).toEqual(limit);
expect(mockRequestOptions.qs.offset).toEqual(offset);
expect(mockRequestOptions.qs.type).toEqual(type);
Expand Down

0 comments on commit d669825

Please sign in to comment.