CreateUsergroups

UserService / CreateUsergroups

Description: Create usergroups

URL: http://{your-server-url}/api/v1/core/users/usergroups

Method: POST

Token Required: True

Request Headers:

currentaccountid: {accountid - optional and default value is user's own account}
content-type: application/json or content-type: application/xml
token: {token}

Required Roles:

Portal Administrator, Account Administrator, Account Owner, Network Administrator

Rights:

Type: Nexus.AppSpace.Service.Contract.Model.Enums.Rights.Rights

Right	Require	Comment
Network_Management	Optional	Required if create user group with network id that different with current user's home network
Basic	Yes

Request:

Type: Nexus.AppSpace.Service.Contract.Messages.AppSpaceIntegration.v1.User.UserRequest

Parameter	Type	Nullable
Request.Groups	Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Users.Usergroup[]	False

Response:

Type: Nexus.AppSpace.Service.Contract.Messages.AppSpaceIntegration.v1.User.UserResponse

Parameter	Type
Response.Groups	Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Users.Usergroup[]

Enums:

Field	Name	Values
Status	Nexus.AppSpace.Service.Contract.Model.Enums.User.Status	Disabled = 0, Active = 1, Locked = 2, Undefined = -1

The following is an example request Xml body:

<UserRequest xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages.AppSpaceIntegration.v1.User" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Groups xmlns:a="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Users">
    <a:Usergroup>
      <a:Description>String</a:Description>
      <a:Guid>11111111-1111-1111-1111-111111111111</a:Guid>
      <a:HomeNetworkId>123</a:HomeNetworkId>
      <a:Name>String</a:Name>
      <a:RoleIds xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <b:int>123</b:int>
      </a:RoleIds>
      <a:Status>Locked</a:Status>
    </a:Usergroup>
  </Groups>
</UserRequest>

The following is an example request Json body:

{
	"Groups":[
		{
			"Description":"String",
			"Guid":"11111111-1111-1111-1111-111111111111",
			"HomeNetworkId":123,
			"Name":"String",
			"RoleIds":[
				123
			],
			"Status":2
		}
	]
}

The following is an example response Xml body:

<UserResponse xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages.AppSpaceIntegration.v1.User" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <DebugMessage xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages">String</DebugMessage>
  <Errors xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages">
    <Error>
      <Code>String</Code>
      <Message>String</Message>
      <StackTrace>String</StackTrace>
    </Error>
  </Errors>
  <Status xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages">Success</Status>
  <Groups xmlns:a="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Users">
    <a:Usergroup>
      <a:Description>String</a:Description>
      <a:EntitlementIds xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <b:int>123</b:int>
      </a:EntitlementIds>
      <a:Guid>11111111-1111-1111-1111-111111111111</a:Guid>
      <a:HomeNetworkId>123</a:HomeNetworkId>
      <a:Id>123</a:Id>
      <a:Name>String</a:Name>
      <a:RoleIds xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <b:int>123</b:int>
      </a:RoleIds>
      <a:Status>Locked</a:Status>
    </a:Usergroup>
  </Groups>
</UserResponse>

The following is an example response Json body:

{
	"DebugMessage":"String",
	"Errors":[
		{
			"Code":"String",
			"Message":"String",
			"StackTrace":"String"
		}
	],
	"Status":1,
	"Groups":[
		{
			"Description":"String",
			"EntitlementIds":[
				123
			],
			"Guid":"11111111-1111-1111-1111-111111111111",
			"HomeNetworkId":123,
			"Id":123,
			"Name":"String",
			"RoleIds":[
				123
			],
			"Status":2
		}
	]
}