Add member to group

The user who runs this web service requires the Add/Update users permissions in the Vault.

URL

https://<IIS_Server_Ip>/PasswordVault/api/UserGroups/{id}/Members

The following mandatory value is required in the URL:

Parameter	id
Type	Number
Description	The unique ID of the Vault group.
Valid values	Vault Id

Resource information

HTTP method	POST
Content type	application/json

Header parameter

Parameter	Authorization
Type	String
Description	The token that identifies the session.
Valid values	A session token that was returned from the “Logon” method.

Body parameters

{ "memberId": "string", "memberType": "Vault", "domainName": "string" }

 

Parameter	memberId (mandatory)
Type	String
Description	The name of the Vault user or LDAP group to add to the Vault group.
Default	-
Parameter	memberType
Type	Enum
Description	The type of user being added to the Vault group. This differentiates members who are domain users from members who are Vault users.
Default	vault
Valid values	domain/vault
Parameter	domainName
Type	String
Description	The dns address of the domain. This parameter is mandatory if memberType=domain.
Default	-

Result

{ "memberId": "string", "memberType": "Vault", "domainName": "string" }

 

Parameter	memberName
Type	String
Description	The name of the Vault user or LDAP group added to the Vault group.
Parameter	memberType
Type	Enum
Description	Whether the group member was added from the Vault or from LDAP.
Default	vault
Valid values	domain/vault
Parameter	domainName
Type	String
Description	The dns address of the domain. This parameter is only returned if the group member was added from LDAP.
Default	-

URL

 

https://<IIS_Server_Ip>/PasswordVault/WebServices/PIMServices.svc/Groups/{GroupName}/Users

The following mandatory value is required in the URL:

Parameter	GroupName
Type	String
Description	The name of the group to which the user will be added.
Valid values	Group name

Resource information

HTTP method	POST
Content type	application/json

Header parameter

Parameter	Authorization
Type	String
Description	The token that identifies the session.
Valid values	A session token that was returned from the “Logon” method.

Body parameters

{ "UserName":"<string>" }

 

Parameter	UserName (mandatory)
Type	String
Description	The name of the user who will be added to the specified group.
Default	-

Result

None