eQuipAPI

<back to all web services

CreateUserProfile

Create a new security profile for a specified user.

The following routes are available for this service:
POST/users/{userId}/profilesCreate a new security profile for a specified user.
CreateUserProfile Parameters:
NameParameterData TypeRequiredDescription
UserUuidqueryGuidYesThe internal Id of the user making the request
UserIdpathintYesID of user whose profile to create
UserRolebodystringYesUser role - To give role to user
SiteScopesbodyList<int>NoList of Site IDs that the user can access
AssetCategoryScopesbodyList<int>NoList of Asset Category IDs that the user can access
LocationCategoryScopesbodyList<int>NoList of Location Category IDs that the user can access
PeopleCategoryScopesbodyList<int>NoList of People Category IDs that the user can access
DepartmentScopesbodyList<int>NoList of Department IDs that the user can access
CustomScopesbodyList<CustomScope>NoTemplate table field scope list that the user can access
CustomScope Parameters:
NameParameterData TypeRequiredDescription
TemplateTableNamebodystringNo
ScopesbodyList<int>No
UserProfileDto Parameters:
NameParameterData TypeRequiredDescription
ProfileIDbodyInt32NoUser Profile ID
UserRolebodystringNoUser Role
SiteScopesbodystringNoList of Site IDs that the user can access
AssetCategoryScopesbodyList<int>NoList of Asset Category IDs that the user can access
LocationCategoryScopesbodyList<int>NoList of Location Category IDs that the user can access
PeopleCategoryScopesbodyList<int>NoList of People Category IDs that the user can access
DepartmentScopesbodyList<int>NoList of Department Category IDs that the user can access
CustomScopesbodyList<CustomScope>NoTemplate table field scope list that the user can access

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /jsv/reply/CreateUserProfile HTTP/1.1 
Host: equipstage3.e-isg.com 
Content-Type: text/jsv
Content-Length: length

{
	UserUuid: 00000000000000000000000000000000,
	UserId: 0,
	UserRole: String,
	SiteScopes: 
	[
		0
	],
	AssetCategoryScopes: 
	[
		0
	],
	LocationCategoryScopes: 
	[
		0
	],
	PeopleCategoryScopes: 
	[
		0
	],
	DepartmentScopes: 
	[
		0
	],
	CustomScopes: 
	[
		{
			TemplateTableName: String,
			Scopes: 
			[
				0
			]
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ProfileID: 0,
	UserRole: String,
	SiteScopes: 
	[
		0
	],
	AssetCategoryScopes: 
	[
		0
	],
	LocationCategoryScopes: 
	[
		0
	],
	PeopleCategoryScopes: 
	[
		0
	],
	DepartmentScopes: 
	[
		0
	],
	CustomScopes: 
	[
		{
			TemplateTableName: String,
			Scopes: 
			[
				0
			]
		}
	]
}