Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

Identity Manager Connector - UserGroupManager endpoint

Connected Services Framework
The UserGroupManager endpoint is called by the IdentityManagerClient class.  These methods are also available on the aggregate IdentityManager endpoint.

To Identity Manager connector UserGroupManager

From Identity Manager connector UserGroupManager

 

 

Request Method Message used in Request Register for Response Action Message used in Response

CreateGroups

CreateGroupsRequest

CreateGroupsResponse

CreateGroupsResponse

ReadGroup

ReadGroupRequest

ReadGroupResponse

ReadGroupResponse

AddUserToGroups

AddUserToGroupsRequest

AddUserToGroupsResponse

AddUserToGroupsResponse

DeleteUserFromGroups

DeleteUserFromGroupsRequest

DeleteUserFromGroupsResponse

DeleteUserFromGroupsResponse

UsersInGroup

UsersInGroupRequest

UsersInGroupResponse

UsersInGroupResponse

DeleteGroup

DeleteGroupRequest

DeleteGroupResponse

DeleteGroupResponse

User Group Manager method details

CreateGroups is used to create new groups in CSF.

CreateGroupsRequest message

Parameter Description  

RequestContext

The application defined context, returned in the response to a request.

Optional

Groups This is a collection of strings of group names.  Required

Descriptions

A collection of strings containing descriptions associated with the groups specified in the groups property. 

Optional

CreateGroups result codes.  These are returned in the response message:

ResultCode Description
0 Success
30000 Input message validation failed
30001 Unexpected system exception encountered
30009 Group already exists
30021 Message header does not contain proper credential
30029 Domain controller is not reachable

CreateGroups Sample XML:

<UserGroupManagerCreate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.microsoft.com/csf/21/IdentityManager">
    <RequestContext>Request Context</RequestContext>
    <Groups>
        <GroupName>Group1@Customer-TestCustomer.com</GroupName>
    </Groups>
    <OrganizationId>Customer-TestCustomer.com</OrganizationId>
</UserGroupManagerCreate>

ReadGroup is used to read the properties of a group in CSF.

ReadGroupRequest message

Parameter Description  

RequestContext

The application defined context, returned in the response to a request.

Optional

GroupName The name of the group to read. Required

ReadGroup result codes.  These are returned in the response message:

ResultCode Description
0 Success
30000 Input message validation failed
30001 Unexpected system exception encountered
30010 Group does not exist
30021 Message header does not contain proper credential
30029 Domain controller is not reachable

 

ReadGroup Sample XML:

<UserGroupManagerRead xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.microsoft.com/csf/20/IdentityManager">
    <RequestContext>Request Context</RequestContext>
    <GroupName>Group1@Customer-TestCustomer.com</GroupName>
</UserGroupManagerRead>

AddUserToGroups is used to add a CSF user to the specified groups.

AddUserToGroupsRequest message

Parameter Description  

RequestContext

The application defined context, returned in the response to a request.

Optional

UserId The Id of the user to add to the specified groups. Required
Groups A list of strings containing the groups to add the user to. Required

AddUserToGroups result codes.  These are returned in the response message:

ResultCode Description
0 Success
30000 Input message validation failed
30001 Unexpected system exception encountered
30010 Group does not exist
30012 User does not exist
30021 Message header does not contain proper credential
30029 Domain controller is not reachable
30042 User is already a member of the specified group

 

AddUserToGroups Sample XML:

<UserGroupManagerAddUserToGroups xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.microsoft.com/csf/21/IdentityManager">
    <RequestContext>Request Context</RequestContext>
    <UserId>test1@csf.com</UserId>
    <Groups>
        <GroupName>Group1@Customer-TestCustomer.com</GroupName>
        <GroupName>AllUsers@Customer-TestCustomer.com</GroupName>
        <GroupName>Admins@Customer-TestCustomer.com</GroupName>
        <GroupName>Developers@Customer-TestCustomer.com</GroupName>
    </Groups>
</UserGroupManagerAddUserToGroups>

DeleteUserFromGroups is used to remove a CSF user from the specified groups.

DeleteUserFromGroupsRequest message

Parameter Description  

RequestContext

The application defined context, returned in the response to a request.

Optional

UserId The Id of the user to delete from the specified groups. Required
Groups A list of strings containing the groups to delete the user from. Required

DeleteUserFromGroups result codes.  These are returned in the response message:

ResultCode Description
0 Success
30000 Input message validation failed
30001 Unexpected system exception encountered
30010 Group does not exist
30012 User does not exist
30021 Message header does not contain proper credential
30029 Domain controller is not reachable
30043 User is not a member of the specified group

 

DeleteUserFromGroups Sample XML:

<UserGroupManagerDeleteUserFromGroups xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.microsoft.com/csf/21/IdentityManager">
    <RequestContext>Request Context</RequestContext>
    <UserId>test1@csf.com</UserId>
    <Groups>
        <GroupName>Developers@Customer-TestCustomer.com</GroupName>
    </Groups>
</UserGroupManagerDeleteUserFromGroups>

UsersInGroup is used to get the CSF users in the specified group.

UserInGroupRequest message

Parameter Description  

RequestContext

The application defined context, returned in the response to a request.

Optional

GroupName The name of the group to read al the users from. Required

UsersInGroup result codes.  These are returned in the response message:

ResultCode Description
0 Success
30000 Input message validation failed
30001 Unexpected system exception encountered
30010 Group does not exist
30021 Message header does not contain proper credential
30029 Domain controller is not reachable
30043 User is not a member of the specified group

 

UsersInGroup Sample XML:

<UserGroupManagerUsersInGroup xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.microsoft.com/csf/20/IdentityManager">
    <RequestContext>Request Context</RequestContext>
    <GroupName>Group1@Customer-TestCustomer.com</GroupName>
</UserGroupManagerUsersInGroup>

DeleteGroup is used to delete a group in CSF.

DeleteGroupRequest message

Parameter Description  

RequestContext

The application defined context, returned in the response to a request.

Optional

GroupName The name of the group to delete. Required

DeleteGroup result codes.  These are returned in the response message:

ResultCode Description
0 Success
30000 Input message validation failed
30001 Unexpected system exception encountered
30010 Group does not exist
30021 Message header does not contain proper credential
30029 Domain controller is not reachable
30043 User is not a member of the specified group

 

DeleteGroup Sample XML:

<UserGroupManagerDelete xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.microsoft.com/csf/20/IdentityManager">
    <RequestContext>Request Context</RequestContext>
    <GroupName>Group1@Customer-TestCustomer.com</GroupName>
</UserGroupManagerDelete>

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.