POST v1/Entities({CompanyId})/SecurityRoles

Create a Security Role in a Company

Information:

Base URL:

https://api.covasoft.net/usermanager

Example of a call would be:

https://api.covasoft.net/usermanager/v1/Entities({CompanyId})/SecurityRoles

Example of the Body of the Call:

{ "Name": "API Test User" }

Request Information

URI Parameters

NameDescriptionTypeAdditional information
CompanyId

The unique Company Id that was provided in your onboarding pacakage

 integer

Required

Body Parameters

Name of Security Role - See Example

CreateSecurityRolePost
NameDescriptionTypeAdditional information
Name

Name of the Security Role

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "Name": "sample string 1"
}

Response Information

Resource Description

The Created Security Role in a Company

CreateSecurityRoleReturn
NameDescriptionTypeAdditional information
Id

This is the SecurityRoleId

 integer

None.
Name

string

None.
SecurityModelVersion

integer

None.
IsCrossEntity

boolean

None.

Response Formats

application/json, text/json

Sample: 
{
  "Id": 1,
  "Name": "sample string 2",
  "SecurityModelVersion": 3,
  "IsCrossEntity": true
}