| License | MIT |
| ReleasedLast Release | Oct 2019 |
Maintained by Luis Sanches, Britton Katnich, Rob Weber, James Go, Yasmeen Taj, Syed Yusuf, Syed Yusuf.
MAS IdentityManagement is the user and group management framework of the iOS Mobile SDK, which is part of CA Mobile API Gateway. It enables developers to securely access users and groups from enterprise identity providers like LDAP, MSAD, and others. Supports creating groups on the fly (called ad hoc groups) for collaborative apps. The underlying protocol is SCIM.
The MASIdentityManagement framework comes with the following features:
Contributions are welcome and much appreciated. To learn more, see the Contribution Guidelines.
MASIdentityManagement supports multiple methods for installing the library in a project.
To integrate MASIdentityManagement into your Xcode project using CocoaPods, specify it in your Podfile:
source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '9.0'
pod 'MASIdentityManagement'
Then, run the following command using the command prompt from the folder of your project:
$ pod install
For manual install, you add the Mobile SDK to your Xcode project. Note that you must add the MASFoundation library. For complete MAS functionality, install all of the MAS libraries as shown.
Copy items if needed.File->Add files to 'project name' and add the msso_config.json file from your project folder.-ObjC for Other Linker Flags.#import <MASFoundation/MASFoundation.h>
#import <MASIdentityManagement/MASIdentityManagement.h>
//Retrieve a MASUser object that matches the given userName
[MASUser getUserByUserName:sampleUserName completion:^(MASUser *user, NSError *error) {
//your code here
}];
//Retrieve a MASUser object that matches the given objectId
[MASUser getUserByObjectId:sampleUserObjectId completion:^(MASUser *user, NSError *error) {
//your code here
}];
Following list of code examples demonstrate basic CRUD operations of ad-hoc group (created on the fly). More advanced operations with using filter request can be found in the next section.
MASGroup *newGroup = [MASGroup group]; // create new MASGroup object
newGroup.groupName = @"New group's name"; // set the group name
newGroup.owner = [MASUser currentUser].userName; // set the owner of the group to a current user
[newGroup saveInBackgroundWithCompletion:^(MASGroup *group, NSError *error) {
//your code here
}];
//Retrieve all groups in Identity Management system
[MASGroup getAllGroupsWithCompletion:^(NSArray *groupList, NSError *error, NSUInteger totalResults){
//your code here
}];
//Retrieve an MASGroup object that matches the given displayName
[MASGroup getGroupByGroupName:@"groupName" completion:^(MASGroup *group, NSError *error) {
//your code here
}];
//Retrieve an MASGroup object that matches the given objectId
[MASGroup getGroupByObjectId:@"objectId" completion:^(MASGroup *group, NSError *error) {
//your code here
}];
MASGroup *thisGroup = retrieve the group object to add a member;
MASUser *thisUser = retrieve the user object to be added;
//Add the member to the group
[thisGroup addMember:thisUser completion:^(MASGroup *group, NSError *error) {
//your code here
}];
MASGroup *thisGroup = retrieve the group object to remove a member;
MASUser *thisUser = retrieve the user object to be removed;
//Remove the member from the group
[thisGroup removeMember:thisUser completion:^(MASGroup *group, NSError *error) {
//your code here
}];
MASGroup *thisGroup = retrieve the group to delete;
//Delete the group
[thisGroup deleteInBackgroundWithCompletion:^(BOOL success, NSError *error) {
//your code here
}];
The MASFilteredRequest class is a convenience request builder to make the interaction with the Identity Management system extremely easy and void of errors. The Identity Management service is able to use a set of conditions for querying both users and groups consisting of the following conditionals:
Include/Exclude
To include or exclude attributes, you need to provide a list of attributes in the query, containing either the key attributes=[comma separated attribute list], or excludedAttributes=[comma separated attribute list]. However, the FilteredRequestBuilder can be used to perform the URL formatting for you.
To read users from the MAS Identity Management service, use the
getUsersByFilter api along with the MASFilteredRequest:
//
// Create FilteredRequest
//
MASFilteredRequest *filteredRequest = [MASFilteredRequest filteredRequest];
//
// Create Filter object.
// Set the attribute, 'userName' or 'displayName', and the filter. For example, a filter of 'sm'
// would match all users with the userName such as 'Smith', 'Asmil', 'Smeel',
// or all groups with the displayName such as 'Small', 'Smart group'
// etc.
//
MASFilter *filter = [MASFilter filterByAttribute:@"userName" contains:@"sm"];
filteredRequest.filter = filter;
//
// Set the sortOrder, either descending or ascending.
// sortOrder is an enumeration value with MASFilteredRequestSortOrderDescending or
// MASFilteredRequestSortOrderAscending.
//
filteredRequest.sortOrder = MASFilteredRequestSortOrderDescending;
//
// Set the pagination for the request.
//
filteredRequest.paginationRange = NSMakeRange(0, 10);
By using the FilteredRequest above, users can easily be retrieved that match with the filter request. There are many other ways of retrieving users without creating a filteredRequest object with several combinations of filter attributes. For more details on the documentation, please refer to the iOS reference.
MASFilteredRequest *filteredRequest = filteredRequest object;
//
// Retrieve an array of MASUser objects based on the filterRequest
//
[MASUser getUsersByFilteredRequest:filteredRequest completion:^(NSArray *userList, NSError *error, NSUInteger totalResults) {
if (error)
{
// Handle error case here
}
else {
// Handle successful request here
}
}];By using the FilteredRequest above, groups can easily be retrieved that match with the filter request. There are many other ways of retrieving groups without creating a filteredRequest object with several combinations of filter attributes. For more details on the documentation, please refer to the iOS reference.
MASFilteredRequest *filteredRequest = filteredRequest object;
//
// Retrieve an array of MASGroup objects based on the filterRequest
//
[MASGroup getGroupsByFilteredRequest:filteredRequest completion:^(NSArray *groupList, NSError *error, NSUInteger totalResults) {
if (error)
{
// Handle error case here
}
else {
// Handle successful request here
}
}];Copyright (c) 2016 CA. All rights reserved.
This software may be modified and distributed under the terms
of the MIT license. See the LICENSE file for details.