Skip to main content
A newer release of this product is available.

Create the TOTP profile for a user account

Contributors
PDFs

POST /security/login/totps

Introduced In: 9.13

Creates a TOTP profile for a user account.

Required properties

  • owner.uuid - Account owner UUID.

  • account.name - Account user name.

  • security login totp create

Learn more

Parameters

Name Type In Required Description

return_records

boolean

query

False

The default is false. If set to true, the records are returned.

  • Default value:

Request Body

Name Type Description

_links

_links

account

account_reference

comment

string

Optional comment for the TOTP profile.

enabled

boolean

Status of the TOTP profile.

owner

owner

Owner name and UUID that uniquely identifies the TOTP profile.

scope

string

Scope of the entity. Set to "cluster" for cluster owned objects and to "svm" for SVM owned objects.

sha_fingerprint

string

SHA fingerprint for the TOTP secret key.
Example request 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "account": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "joe.smith"
  },
  "comment": "string",
  "enabled": "",
  "owner": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  },
  "scope": "string",
  "sha_fingerprint": "string"
}

Response

Status: 201, Created
Name Type Description

num_records

integer

Number of records.

records

array[totp_post]
Example response 
{
  "num_records": 1,
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "account": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "joe.smith"
      },
      "comment": "string",
      "emergency_codes": "17503785",
      "enabled": 1,
      "install_url": "string",
      "owner": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "svm1",
        "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
      },
      "scope": "string",
      "secret_key": "string",
      "sha_fingerprint": "string",
      "verification_code": "string"
    }
  ]
}

Headers

Name Description Type

Location

Useful for tracking the resource location

string

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

144834561

TOTP is not configured for the user.

Also see the table of common errors in the Response body overview section of this documentation.

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

self

href

account_reference

Name Type Description

_links

_links

name

string

User account

owner

Owner name and UUID that uniquely identifies the TOTP profile.

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.

totp

TOTP profile for the user account used to access SSH.

Name Type Description

_links

_links

account

account_reference

comment

string

Optional comment for the TOTP profile.

enabled

boolean

Status of the TOTP profile.

owner

owner

Owner name and UUID that uniquely identifies the TOTP profile.

scope

string

Scope of the entity. Set to "cluster" for cluster owned objects and to "svm" for SVM owned objects.

sha_fingerprint

string

SHA fingerprint for the TOTP secret key.

totp_post

Response object of the TOTP profile creation.

Name Type Description

_links

_links

account

account_reference

comment

string

Optional comment for the TOTP profile.

emergency_codes

array[string]

TOTP profile emergency codes for a user. These codes are for emergency use when a user cannot access 2FA codes through other means.

enabled

boolean

Status of the TOTP profile.

install_url

string

TOTP profile installation URL for a user.

owner

owner

Owner name and UUID that uniquely identifies the TOTP profile.

scope

string

Scope of the entity. Set to "cluster" for cluster owned objects and to "svm" for SVM owned objects.

secret_key

string

TOTP profile secret key for a user.

sha_fingerprint

string

SHA fingerprint for the TOTP secret key.

verification_code

string

TOTP profile verification code for a user.

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.