Description:
Retrieve detailed information about a user group.
Precondition:
Right 🔓 read groups required.
Postcondition:
User group is returned.
Further Information:
None.
643 matches
100 actions
DRACOON
100 actions
- Add or change room granted group(s)PUTv1.0.0
- Add or change room granted user(s)PUTv1.0.0
- Add or edit custom user attributesPUTv1.0.0
- Add or edit customer attributesPUTv1.0.0
- Add or edit user profile attributesPUTv1.0.0
- Create Active Directory configurationPOSTv1.0.0
- Create customerPOSTv1.0.0
- Create key pair and preserve copy of old private keyPOSTv1.0.0
- Create key pair and preserve copy of old private keyPOSTv1.0.0
- Create new folderPOSTv1.0.0
- Create new roomPOSTv1.0.0
- Create new userPOSTv1.0.0
- Create new user groupPOSTv1.0.0
- Create node commentPOSTv1.0.0
- Create OpenID Connect IDP configurationPOSTv1.0.0
- Create RADIUS configurationPOSTv1.0.0
- Create S3 storage configurationPOSTv1.0.0
- Create S3 tagPOSTv1.0.0
- Create system rescue key pair and preserve copy of old private keyPOSTv1.0.0
- Disable a MFA TOTP setup with generated OTPDELETEv1.0.0
- Edit node commentPUTv1.0.0
- Get customerGETv1.0.0
- Initiate OpenID Connect authenticationGETv1.0.0
- List node subscriptionsGETv1.0.0
- Mark or unmark a list of nodes (room, folder or file) as favoritePUTv1.0.0
- Request Active Directory authentication informationGETv1.0.0
- Request Active Directory configurationGETv1.0.0
- Request algorithmsGETv1.0.0
- Request all roles with assigned rightsGETv1.0.0
- Request all system rescue key pairsGETv1.0.0
- Request allowed Log OperationsGETv1.0.0
- Request authentication settingsGETv1.0.0
- Request avatarGETv1.0.0
- Request classification policiesGETv1.0.0
- Request classification policiesGETv1.0.0
- Request customer information for userGETv1.0.0
- Request customer's key pairGETv1.0.0
- Request deleted nodeGETv1.0.0
- Request eventlog settingsGETv1.0.0
- Request general settingsGETv1.0.0
- Request general settingsGETv1.0.0
- Request group member users or / and users who can become a memberGETv1.0.0
- Request groups with specific roleGETv1.0.0
- Request guest user policiesGETv1.0.0
- Request guest users policiesGETv1.0.0
- Request information about the user's mfa statusGETv1.0.0
- Request information to setup TOTP as second authentication factorGETv1.0.0
- Request infrastructure propertiesGETv1.0.0
- Request infrastructure propertiesGETv1.0.0
- Request list of Active Directory configurationsGETv1.0.0
- Request list of currently enabled product packagesGETv1.0.0
- Request list of event typesGETv1.0.0
- Request list of event typesGETv1.0.0
- Request list of notification channelsGETv1.0.0
- Request list of notification channelsGETv1.0.0
- Request list of notification configurationsGETv1.0.0
- Request list of OpenID Connect IDP configurationsGETv1.0.0
- Request list of parent nodesGETv1.0.0
- Request list of product packagesGETv1.0.0
- Request list of roles assigned to the groupGETv1.0.0
- Request list of subscription scopesGETv1.0.0
- Request MFA policiesGETv1.0.0
- Request nodeGETv1.0.0
- Request OpenID Connect IDP configurationGETv1.0.0
- Request OpenID Connect provider authentication informationGETv1.0.0
- Request password policiesGETv1.0.0
- Request password policiesGETv1.0.0
- Request password policies for a certain password typeGETv1.0.0
- Request RADIUS configurationGETv1.0.0
- Request Room PoliciesGETv1.0.0
- Request rooms where the group is defined as last admin groupGETv1.0.0
- Request rooms where the user is last adminGETv1.0.0
- Request S3 storage configurationGETv1.0.0
- Request subscription planGETv1.0.0
- Request user avatarGETv1.0.0
- Request user groupGETv1.0.0
- Request user profile attributesGETv1.0.0
- Request user-room assignments per groupGETv1.0.0
- Request users with specific roleGETv1.0.0
- Search nodesGETv1.0.0
- Subscribe or Unsubscribe a List of nodes for notificationsPUTv1.0.0
- Update Active Directory configurationPUTv1.0.0
- Update authentication settingsPUTv1.0.0
- Update customerPUTv1.0.0
- Update eventlog settingsPUTv1.0.0
- Update general settingsPUTv1.0.0
- Update notification configurationPUTv1.0.0
- Update OpenID Connect IDP configurationPUTv1.0.0
- Update RADIUS configurationPUTv1.0.0
- Update S3 storage configurationPUTv1.0.0
- Update syslog settingsPUTv1.0.0
- Update system defaultsPUTv1.0.0
- Update system settingsPUTv1.0.0
- Update user accountPUTv1.0.0
- Update user group's metadataPUTv1.0.0
- Update user's metadataPUTv1.0.0
- Updates a file’s metadataPUTv1.0.0
- Updates a list of file’s metadataPUTv1.0.0
- Updates folder’s metadataPUTv1.0.0
- Updates room’s metadataPUTv1.0.0
Infrastructure/DRACOON
Request user group
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
{
"type": "object",
"properties": {
"X-Sds-Auth-Token": {
"type": "string"
},
"X-Sds-Date-Format": {
"type": "string",
"enum": [
"UTC",
"LOCAL",
"OFFSET",
"EPOCH",
"LEET"
]
},
"group_id": {
"type": "integer",
"format": "int64"
}
},
"required": [
"group_id"
],
"additionalProperties": false
}Output
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 154
- 155
- 156
- 157
- 158
- 159
- 160
- 161
- 162
- 163
- 164
- 165
- 166
- 167
- 168
- 169
- 170
- 171
- 172
- 173
- 174
- 175
- 176
- 177
- 178
- 179
- 180
- 181
- 182
- 183
- 184
- 185
- 186
- 187
- 188
- 189
- 190
- 191
- 192
- 193
- 194
- 195
- 196
- 197
- 198
- 199
- 200
- 201
- 202
- 203
- 204
- 205
- 206
- 207
- 208
- 209
- 210
- 211
- 212
- 213
- 214
- 215
- 216
- 217
- 218
- 219
- 220
- 221
{
"type": "object",
"description": "Group information",
"required": [
"cntUsers",
"createdAt",
"createdBy",
"id",
"name"
],
"properties": {
"cntUsers": {
"type": "integer",
"format": "int32",
"description": "Amount of users"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "Creation date"
},
"createdBy": {
"type": "object",
"description": "User information",
"required": [
"avatarUuid",
"firstName",
"id",
"lastName",
"userName",
"userType"
],
"properties": {
"avatarUuid": {
"type": "string",
"description": "🚀 Since v4.11.0\n\nAvatar UUID"
},
"displayName": {
"type": "string",
"description": "🚧 Deprecated since v4.11.0\n\nDisplay name\n\nuse other fields from `UserInfo` instead to combine a display name"
},
"email": {
"type": "string",
"description": "🚀 Since v4.11.0\n\nEmail "
},
"firstName": {
"type": "string",
"description": "🚀 Since v4.11.0\n\nUser first name (mandatory if `userType` is `internal`)"
},
"id": {
"type": "integer",
"format": "int64",
"description": "Unique identifier for the user"
},
"lastName": {
"type": "string",
"description": "🚀 Since v4.11.0\n\nUser last name (mandatory if `userType` is `internal`)"
},
"title": {
"type": "string",
"description": "🚧 Deprecated since v4.18.0\n\nJob title"
},
"userName": {
"type": "string",
"description": "🚀 Since v4.13.0\n\nUsername (only returned for `internal` users)"
},
"userType": {
"type": "string",
"description": "🚀 Since v4.11.0\n\nUser type:\n\n* `internal` - ordinary DRACOON user\n\n* `external` - external user without DRACOON account\n\n* `system` - system user (non human 👽)\n\n* `deleted` - deleted DRACOON user",
"enum": [
"system",
"internal",
"external",
"deleted"
]
}
}
},
"expireAt": {
"type": "string",
"format": "date-time",
"description": "Expiration date"
},
"groupRoles": {
"type": "object",
"description": "List of roles",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"description": "List of roles",
"items": {
"type": "object",
"description": "Role information",
"required": [
"description",
"id",
"name"
],
"properties": {
"description": {
"type": "string",
"description": "Role description"
},
"id": {
"type": "integer",
"format": "int32",
"description": "Unique identifier for the role"
},
"items": {
"type": "array",
"description": "List of reachable right over role",
"items": {
"type": "object",
"description": "Right information",
"required": [
"description",
"id",
"name"
],
"properties": {
"description": {
"type": "string",
"description": "Right description"
},
"id": {
"type": "integer",
"format": "int32",
"description": "Unique identifier for the right"
},
"name": {
"type": "string",
"description": "Right (unique) name"
}
}
}
},
"name": {
"type": "string",
"description": "Role (unique) name"
}
}
}
}
}
},
"id": {
"type": "integer",
"format": "int64",
"description": "Unique identifier for the group"
},
"name": {
"type": "string",
"description": "Group name"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"description": "Modification date"
},
"updatedBy": {
"type": "object",
"description": "User information",
"required": [
"avatarUuid",
"firstName",
"id",
"lastName",
"userName",
"userType"
],
"properties": {
"avatarUuid": {
"type": "string",
"description": "🚀 Since v4.11.0\n\nAvatar UUID"
},
"displayName": {
"type": "string",
"description": "🚧 Deprecated since v4.11.0\n\nDisplay name\n\nuse other fields from `UserInfo` instead to combine a display name"
},
"email": {
"type": "string",
"description": "🚀 Since v4.11.0\n\nEmail "
},
"firstName": {
"type": "string",
"description": "🚀 Since v4.11.0\n\nUser first name (mandatory if `userType` is `internal`)"
},
"id": {
"type": "integer",
"format": "int64",
"description": "Unique identifier for the user"
},
"lastName": {
"type": "string",
"description": "🚀 Since v4.11.0\n\nUser last name (mandatory if `userType` is `internal`)"
},
"title": {
"type": "string",
"description": "🚧 Deprecated since v4.18.0\n\nJob title"
},
"userName": {
"type": "string",
"description": "🚀 Since v4.13.0\n\nUsername (only returned for `internal` users)"
},
"userType": {
"type": "string",
"description": "🚀 Since v4.11.0\n\nUser type:\n\n* `internal` - ordinary DRACOON user\n\n* `external` - external user without DRACOON account\n\n* `system` - system user (non human 👽)\n\n* `deleted` - deleted DRACOON user",
"enum": [
"system",
"internal",
"external",
"deleted"
]
}
}
}
}
}