Group Attributes
The following table lists the group attributes for user-based Security Groups:
Attributes |
Description |
Path |
ID |
The internal ID for this group.
|
The path is automatically assigned. |
COMMENT |
The description for this Group. |
The path is automatically assigned. |
DESCRIPTOR |
The Name for this Group |
The path is automatically assigned. |
Note
The COMMENT
and DESCRIPTOR
attributes are only supported for the OAuth 2.0 Authentication Type .
By Default,“ID” is marked as displayAttribute
and descriptionAttribute
. In order to update it, use update-source | SailPoint Developer Community to change it. Below is an example for API body content:
[{
"op": "add",
"path": "/configuration/displayAttribute",
"value": "DESCRIPTOR"
}]
[{
"op": "add",
"path": "/configuration/descriptionAttribute",
"value": "COMMENT"
}]
Attributes |
Description |
Path |
ID |
The internal ID for the groups. |
The path is automatically assigned. |
TYPE |
The type for this Group. |
The path is automatically assigned. |
NAME |
The Name for this Group |
The path is automatically assigned. |
By default, OrganizationRole group object is not part of the out of the box schema. Use createSchema API to create new group schema for your source. Below is an example for API body content for adding entitlements to the source.
For more information, refer to REST API.
{
"name": "OrganizationRole",
"nativeObjectType": "OrganizationRole",
"identityAttribute": "ORG_ROLE##ORG_NAME",
"displayAttribute": "ORG_ROLE##ORG_NAME",
"hierarchyAttribute": null,
"includePermissions": false,
"features": [],
"configuration": {},
"attributes": [
{
"name": "ORG_ROLE##ORG_NAME",
"type": "STRING",
"schema": null,
"description": "Associates an organization role reference ID with an organization name reference ID",
"isMulti": false,
"isEntitlement": false,
"isGroup": false
},
{
"name": "ROLE_NAME",
"type": "STRING",
"schema": null,
"description": "Name of the Role",
"isMulti": false,
"isEntitlement": false,
"isGroup": false
},
{
"name": "ORGANIZATION_NAME",
"type": "STRING",
"schema": null,
"description": "Name of the organization",
"isMulti": false,
"isEntitlement": false,
"isGroup": false
},
{
"name": "ASSOCIATED_SECURITY_GROUP",
"type": "STRING",
"schema": null,
"description": "Name of the Associated role-based security group",
"isMulti": false,
"isEntitlement": false,
"isGroup": false
}
]
}
Attributes |
Description |
Path |
ORG_ROLE##ORG_NAME |
Associates an organization role reference ID with an organization name reference ID |
The path is automatically assigned. |
ROLE_NAME |
Organization role name |
The path is automatically assigned. |
ASSOCIATED_SECURITY_GROUP |
Associated role-based security group |
The path is automatically assigned. |
ORGANIZATION_NAME |
Name of the organization |
The path is automatically assigned. |
Note
The new group object is only supported for the OAuth 2.0 Authentication Type.