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 .xml suffix or ?format=xml

HTTP + XML

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

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

<CreateUserProfile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eQuipModel">
  <AssetCategoryScopes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </AssetCategoryScopes>
  <CustomScopes>
    <CustomScope>
      <Scopes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>0</d4p1:int>
      </Scopes>
      <TemplateTableName>String</TemplateTableName>
    </CustomScope>
  </CustomScopes>
  <DepartmentScopes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </DepartmentScopes>
  <LocationCategoryScopes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </LocationCategoryScopes>
  <PeopleCategoryScopes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </PeopleCategoryScopes>
  <SiteScopes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </SiteScopes>
  <UserId>0</UserId>
  <UserRole>String</UserRole>
  <UserUuid>00000000-0000-0000-0000-000000000000</UserUuid>
</CreateUserProfile>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UserProfileDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eQuipModel">
  <AssetCategoryScopes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </AssetCategoryScopes>
  <CustomScopes>
    <CustomScope>
      <Scopes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>0</d4p1:int>
      </Scopes>
      <TemplateTableName>String</TemplateTableName>
    </CustomScope>
  </CustomScopes>
  <DepartmentScopes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </DepartmentScopes>
  <LocationCategoryScopes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </LocationCategoryScopes>
  <PeopleCategoryScopes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </PeopleCategoryScopes>
  <ProfileID>0</ProfileID>
  <SiteScopes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </SiteScopes>
  <UserRole>String</UserRole>
</UserProfileDto>