Skip to main content

Retrieve the Duo group configured for an SVM or cluster

Contributors
PDFs

GET /security/authentication/duo/groups/{owner.uuid}/{name}

Introduced In: 9.14

Retrieves the Duo group configured for an SVM or cluster.

  • security login duo group show

Learn more

Parameters

Name Type In Required Description

owner.uuid

string

path

True

Account owner UUID.

name

string

path

True

Group name.

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

_links

_links

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

owner

SVM name and UUID for which the Duo group profile is configured.
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "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

returned_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

href

self

href

_links

Name Type Description

self

href

owner

SVM name and UUID for which the Duo group profile is configured.

Name Type Description

_links

_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.

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.