Skip to main content
REST API reference

Retrieve username, role, and permissions information for the logged-in ONTAP user

PDFs

GET /security/login/whoami

Introduced In: 9.19

Retrieves the username, role, and permissions information for the logged-in user.

  • security login whoami

Response

Status: 200, Ok
Name Type Description

_links

_links

privileges

array[whoami_privileges]

List of privileges

roles

array[string]

Role name or names

username

string

User name
Example response 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "privileges": [
    {
      "access": "all",
      "path": "security login",
      "query": "-username 'tom'"
    }
  ],
  "roles": [
    "string"
  ],
  "username": "tom"
}

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

self

href

whoami_privileges

Name Type Description

access

string

Access level for the REST endpoint or command/command directory path. If it denotes the access level for a command/command directory path, the only supported enum values are 'none','readonly' and 'all'.

path

string

Either of REST URI/endpoint OR command/command directory path.

query

string

Query

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.