IdentityCollection

IdentityCollection
IdentityCollection

A collection of user and group identities

JSON Example
{
    "includeNestedGroupsAndMembers": false,
    "identityGroupInfo": {
        "identityGroupInfo": {
            "mappedGroupData": [
                {
                    "mappedGroup": {
                        "groupName": "groupName",
                        "dn": "dc=vidb,dc=com",
                        "objectGuid": "dfd3c968-0b6d-4750-a66e-405d4c04c245",
                        "groupBaseDN": "CN=Users,DC=vidb,DC=com",
                        "source": "DIRECTORY",
                        "isCompliant": false,
                        "validationResult": {
                            "invalidAttributes": [
                                "string"
                            ],
                            "isDuplicateId": false
                        }
                    },
                    "selected": false
                }
            ],
            "numSelected": 1,
            "numTotal": 0,
            "selected": true
        }
    },
    "identityUserInfo": {
        "identityUserInfo": {
            "users": [
                {
                    "userId": "2d825955-c4bc-4ea0-8c79-d1a0ed9a9de6",
                    "user": "John Doe",
                    "userDn": "CN=Administrator,CN=Users,DC=vidb,DC=com",
                    "mail": "[email protected]",
                    "admin": false,
                    "selected": false
                }
            ],
            "numTotal": 0
        }
    },
    "allGroupsSelectedGroupDns": [
        "string"
    ],
    "groupNameOnlyGroupDNs": [
        "string"
    ],
    "entitledGroupsGroupDNs": [
        "string"
    ]
}
boolean
includeNestedGroupsAndMembers
Optional

Whether nested groups members should be discovered or not using memberOf query. If not provided in the request, the default value is false

object
identityGroupInfo
Optional

Information about the groups in the base DN

object
identityUserInfo
Optional

Information about the users in the base DN

array of string
allGroupsSelectedGroupDns
Optional

Group DNs for which all the groups have been selected to sync

array of string
groupNameOnlyGroupDNs
Optional

Group DNs where only the group is retrieved without user membership calculation

array of string
entitledGroupsGroupDNs
Optional

Group DNs for the groups which are entitled in vIDM service