Skip to main content

Retrieve configured Duo profiles

Contributors
PDFs

GET /security/authentication/duo/profiles

Introduced In: 9.14

Retrieves the configured Duo profiles.

  • security login duo show

Learn more

Parameters

Name Type In Required Description

status

string

query

False

Filter by status

fingerprint

string

query

False

Filter by fingerprint

comment

string

query

False

Filter by comment

owner.uuid

string

query

False

Filter by owner.uuid

owner.name

string

query

False

Filter by owner.name

is_enabled

boolean

query

False

Filter by is_enabled

api_host

string

query

False

Filter by api_host

auto_push

boolean

query

False

Filter by auto_push

push_info

boolean

query

False

Filter by push_info

http_proxy

string

query

False

Filter by http_proxy

integration_key

string

query

False

Filter by integration_key

fail_mode

string

query

False

Filter by fail_mode

max_prompts

integer

query

False

Filter by max_prompts

  • Max value: 3

  • Min value: 1

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.

  • Default value: 1

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.

  • Max value: 120

  • Min value: 0

  • Default value: 1

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok
Name Type Description

_links

_links

num_records

integer

Number of records.

records

array[duo]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": [
    {
      "_links": {
        "next": {
          "href": "/api/resourcelink"
        },
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "api_host": "api-****.duo.com",
      "auto_push": 1,
      "comment": "string",
      "fail_mode": "safe",
      "fingerprint": "string",
      "http_proxy": "IPaddress:port",
      "integration_key": "string",
      "is_enabled": 1,
      "max_prompts": 1,
      "owner": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "svm1",
        "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
      },
      "push_info": 1,
      "secret_key": "string",
      "status": "OK"
    }
  ]
}

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

duo

Duo profile for the SVM or cluster-management server (Cserver).

Name Type Description

_links

_links

api_host

string

The URL at which the Duo API is hosted.

auto_push

boolean

Automatically sends a push notification for authentication when using Duo.

comment

string

Comment for the Duo profile.

fail_mode

string

Determines the behavior of the system when it cannot communicate with the Duo service.

fingerprint

string

The SHA fingerprint corresponding to the Duo secret key.

http_proxy

string

Specifies the HTTP proxy server to be used when connecting to the Duo service.

integration_key

string

The Integration Key associated with the Duo profile.

is_enabled

boolean

Indicates whether the Duo authentication feature is active or inactive.

max_prompts

integer

The maximum number of authentication attempts allowed for a user before the process is terminated.

owner

owner

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

push_info

boolean

Additional information sent along with the push notification for Duo authentication.

secret_key

string

The Secret Key associated with the Duo profile.

status

string

Information on the reachability status of Duo.

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.