Create User Group
If the authSourceId is specified(in the request), then the user group will be imported from the corresponding auth source (LDAP/AD/SSO/VIDM/VIDB).Note that the id of the user group has to be null.
For LDAP/AD groups the distinguishedName should be provided in the name field.
The value of displayName is used only while importing LDAP/AD groups, and if it is not provided then the value of name will be assigned to it. For SSO/VIDM groups the value of name is assigned to displayName.
NOTE: Before importing please make sure that the group exists in the specified authSource by using the following API - /api/auth/sources/{id}/usergroups/search . Otherwise, if you try to import a non-existing group, a new one will be created with the specified authSourceId.
NOTE: In the case of vIDB user group, the import occurs based on the provided externalId. If other provided details are incorrect, they will be asynchronously updated with the correct values right after the import operation is completed.
The group object to be created.
Show optional properties
{
"name": "string"
}"{\n \"name\" : \"user_group_name\",\n \"description\" : \"user_group_desc\",\n \"userIds\" : [ \"0659cefc-592f-473a-910c-2ee01c13ea07\" ],\n \"role-permissions\" : [ {\n \"roleName\" : \"Administrator\",\n \"traversal-spec-instances\" : [ {\n \"adapterKind\" : \"adap_kind\",\n \"resourceKind\" : \"resource_kind\",\n \"name\" : \"traversal_spec_name\",\n \"selectAllResources\" : true\n } ],\n \"allowAllObjects\" : true\n } ]\n}"The identifier of this group.(unique)
Note: Required when updating or deleting the user group.
The identifier of the auth source. If it is null, a local user group will be created.
The name of this group.
A description about this group.
The displayName of this group.
The list of users who are members of this group.
(Deprecated) List of role names assigned to the user group. May be null.
The list of role permissions assigned to this group. May be null. Replaces and takes precedence over roleNames.
External ID of vIDB user group. This field is only used in vIDB user group import flow. It will not be populated for any other scenarios. Please note, this field may be removed in future.
Represents a HTTP 'link' element.
It is implicit that all the link tags support http 'GET' method.
The user group is created successfully
"{\n \"id\" : \"89fed483-c533-4bd0-bf25-753550dd5f83\",\n \"name\" : \"user_group_name\",\n \"description\" : \"user_group_desc\",\n \"userIds\" : [ \"b20e256a-9cf0-4000-bdb2-023853fe018e\" ],\n \"role-permissions\" : [ {\n \"roleName\" : \"Administrator\",\n \"traversal-spec-instances\" : [ {\n \"adapterKind\" : \"adap_kind\",\n \"resourceKind\" : \"resource_kind\",\n \"name\" : \"traversal_spec_name\",\n \"selectAllResources\" : true\n } ],\n \"allowAllObjects\" : true\n } ]\n}"The identifier of this group.(unique)
Note: Required when updating or deleting the user group.
The identifier of the auth source. If it is null, a local user group will be created.
The name of this group.
A description about this group.
The displayName of this group.
The list of users who are members of this group.
(Deprecated) List of role names assigned to the user group. May be null.
The list of role permissions assigned to this group. May be null. Replaces and takes precedence over roleNames.
External ID of vIDB user group. This field is only used in vIDB user group import flow. It will not be populated for any other scenarios. Please note, this field may be removed in future.
Represents a HTTP 'link' element.
It is implicit that all the link tags support http 'GET' method.
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"name:"string"}' https://{api_host}/suite-api/api/auth/usergroups