Retrieve the configured groups
Retrieves the list of configured groups to view their current settings and configurations. This allows you to manage and review authentication group setups efficiently.
HTTP method and endpoint
GET /security/authentication/duo/groups
Introduced in
ONTAP 9.14
Usage notes
Retrieves the configured groups.
Related ONTAP commands
-
security login duo group show
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
owner.name |
string |
query |
False |
Filter by owner.name |
owner.uuid |
string |
query |
False |
Filter by owner.uuid |
name |
string |
query |
False |
Filter by name |
comment |
string |
query |
False |
Filter by comment |
excluded_users |
string |
query |
False |
Filter by excluded_users |
fields |
array[string] |
query |
False |
Specify the fields to return. |
max_records |
integer |
query |
False |
Limit the number of records returned. |
return_records |
boolean |
query |
False |
The default is true for GET calls. When set to false, only the number of records is returned.
|
return_timeout |
integer |
query |
False |
The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.
|
order_by |
array[string] |
query |
False |
Order results by specified fields and optional [asc |
Response
Status: 200, Ok
| Name | Type | Description |
|---|---|---|
_links |
||
num_records |
integer |
Number of records. |
records |
array[duogroup] |
Example response
{
"_links": {
"next": {
"href": "/api/resourcelink"
},
"self": {
"href": "/api/resourcelink"
}
},
"num_records": 1,
"records": [
{
"comment": "string",
"excluded_users": [
"user1",
"user2"
],
"name": "AD_Group",
"owner": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "svm1",
"uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
}
}
]
}
Error
Status: Default, Error
| Name | Type | Description |
|---|---|---|
error |
Example error
{
"error": {
"arguments": [
{
"code": "string",
"message": "string"
}
],
"code": "4",
"message": "entry doesn't exist",
"target": "uuid"
}
}
Definitions
See Definitions
href
| Name | Type | Description |
|---|---|---|
href |
string |
_links
| Name | Type | Description |
|---|---|---|
next |
||
self |
_links
| Name | Type | Description |
|---|---|---|
self |
owner
SVM name and UUID for which the Duo group profile is configured.
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
The name of the SVM. This field cannot be specified in a PATCH method. |
uuid |
string |
The unique identifier of the SVM. This field cannot be specified in a PATCH method. |
duogroup
Group profile to include in Duo authentication.
| Name | Type | Description |
|---|---|---|
comment |
string |
Comment for the Duo group. |
excluded_users |
array[string] |
List of excluded users. |
name |
string |
Name of the group to be included in Duo authentication. |
owner |
SVM name and UUID for which the Duo group profile is configured. |
error_arguments
| Name | Type | Description |
|---|---|---|
code |
string |
Argument code |
message |
string |
Message argument |
returned_error
| Name | Type | Description |
|---|---|---|
arguments |
array[error_arguments] |
Message arguments |
code |
string |
Error code |
message |
string |
Error message |
target |
string |
The target parameter that caused the error. |