Skip to main content

Update a Duo profile configured for an SVM or cluster

Contributors
PDFs

PATCH /security/authentication/duo/profiles/{owner.uuid}

Introduced In: 9.14

Updates a configured Duo profile for a cluster or an SVM.

  • security login duo modify

Learn more

Parameters

Name Type In Required Description

owner.uuid

string

path

True

Account owner UUID

Request Body

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.
Example request 
{
  "_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"
}

Response

Status: 200, 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.