IdentityNow API Documentation
Create a Role
POST {{baseUrl}}/roles
This API creates a role. You must have a token with API, ORGADMIN, ROLEADMIN, or ROLE_SUBADMIN authority to call this API. In addition, a ROLESUBADMIN may not create a role including an access profile if that access profile is associated with a source the ROLESUBADMIN is not associated with themselves. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles. However, any new roles as well as any updates to existing descriptions will be limited to 2000 characters.
Body
PARAM
| Key | Datatype | Required | Description |
HEADERS
| Key | Datatype | Required | Description |
Content-Type
|
string | ||
Accept
|
string |
RESPONSES
status Created
| {
"name": "Role 2567",
"owner": {
"type": "IDENTITY",
"id": "2c9180a46faadee4016fb4e018c20639",
"name": "support"
},
"id": "2c918086749d78830174a1a40e121518",
"created": "2021-03-01T22:32:58.104Z",
"modified": "2021-03-02T20:22:28.104Z",
"description": "Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor.",
"accessProfiles": [
{
"id": "ff808081751e6e129f1518161919ecca",
"type": "ACCESS_PROFILE",
"name": "Access Profile 2567"
},
{
"id": "ff808081751e6e129f1518161919ecca",
"type": "ACCESS_PROFILE",
"name": "Access Profile 2567"
}
],
"entitlements": [
{
"type": "ENTITLEMENT",
"id": "2c91809773dee32014e13e122092014e",
"name": "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local"
},
{
"type": "ENTITLEMENT",
"id": "2c91809773dee32014e13e122092014e",
"name": "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local"
}
],
"membership": {
"type": "IDENTITY_LIST",
"criteria": {
"operation": "EQUALS",
"key": {
"type": "ACCOUNT",
"property": "attribute.email",
"sourceId": "2c9180867427f3a301745aec18211519"
},
"stringValue": "carlee.cert1c9f9b6fd@mailinator.com",
"children": [
{
"operation": "EQUALS",
"key": {
"type": "ACCOUNT",
"property": "attribute.email",
"sourceId": "2c9180867427f3a301745aec18211519"
},
"stringValue": "carlee.cert1c9f9b6fd@mailinator.com",
"children": [
{
"operation": "EQUALS",
"key": {
"type": "ACCOUNT",
"property": "attribute.email",
"sourceId": "2c9180867427f3a301745aec18211519"
},
"stringValue": "carlee.cert1c9f9b6fd@mailinator.com"
},
{
"operation": "E Curl curl -X POST 'https://tenant.api.identitynow.com/v3/roles' -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{"name":"Role 2567","owner":{"type":"IDENTITY","id":"2c9180a46faadee4016fb4e018c20639","name":"support"},"id":"2c918086749d78830174a1a40e121518","created":"2021-03-01T22:32:58.104Z","modified":"2021-03-02T20:22:28.104Z","description":"Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor.","accessProfiles":[{"id":"ff808081751e6e129f1518161919ecca","type":"ACCESS_PROFILE","name":"Access Profile 2567"},{"id":"ff808081751e6e129f1518161919ecca","type":"ACCESS_PROFILE","name":"Access Profile 2567"}],"entitlements":[{"type":"ENTITLEMENT","id":"2c91809773dee32014e13e122092014e","name":"CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local"},{"type":"ENTITLEMENT","id":"2c91809773dee32014e13e122092014e","name":"CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local"}],"membership":{"type":"IDENTITY_LIST","criteria":{"operation":"EQUALS","key":{"type":"ACCOUNT","property":"attribute.email","sourceId":"2c9180867427f3a301745aec18211519"},"stringValue":"carlee.cert1c9f9b6fd@mailinator.com","children":[{"operation":"EQUALS","key":{"type":"ACCOUNT","property":"attribute.email","sourceId":"2c9180867427f3a301745aec18211519"},"stringValue":"carlee.cert1c9f9b6fd@mailinator.com","children":[{"operation":"EQUALS","key":{"type":"ACCOUNT","property":"attribute.email","sourceId":"2c9180867427f3a301745aec18211519"},"stringValue":"carlee.cert1c9f9b6fd@mailinator.com"},{"operation":"EQUALS","key":{"type":"ACCOUNT","property":"attribute.email","sourceId":"2c9180867427f3a301745aec18211519"},"stringValue":"carlee.cert1c9f9b6fd@mailinator.com"}]},{"operation":"EQUALS","key":{"type":"ACCOUNT","property":"attribute.email","sourceId":"2c9180867427f3a301745aec18211519"},"stringValue":"carlee.cert1c9f9b6fd@mailinator.com","children":[{"operation":"EQUALS","key":{"type":"ACCOUNT","property":"attribute.email","sourceId":"2c9180867427f3a301745aec18211519"},"stringValue":"carlee.cert1c9f9b6fd@mailinator.com"},{"operation":"EQUALS","key":{"type":"ACCOUNT","property":"attribute.email","sourceId":"2c9180867427f3a301745aec18211519"},"stringValue":"carlee.cert1c9f9b6fd@mailinator.com"}]}]},"identities":[{"type":"IDENTITY","id":"2c9180a46faadee4016fb4e018c20639","name":"Thomas Edison","aliasName":"t.edison"},{"type":"IDENTITY","id":"2c9180a46faadee4016fb4e018c20639","name":"Thomas Edison","aliasName":"t.edison"}]},"legacyMembershipInfo":{"type":"IDENTITY_LIST"},"enabled":true,"requestable":true,"accessRequestConfig":{"commentsRequired":true,"denialCommentsRequired":true,"approvalSchemes":[{"approverType":"GOVERNANCE_GROUP","approverId":"46c79819-a69f-49a2-becb-12c971ae66c6"},{"approverType":"GOVERNANCE_GROUP","approverId":"46c79819-a69f-49a2-becb-12c971ae66c6"}]},"revocationRequestConfig":null,"segments":["f7b1b8a3-5fed-4fd4-ad29-82014e137e19","29cb6c06-1da8-43ea-8be4-b3125f248f2a"],"dimensional":true,"dimensionRefs":"Excepteur incididunt offi"}' ENDPOINTS |