Skip to main content
REST API reference

Retrieve the JIT privilege user configurations for an SVM

PDFs

GET /security/jit-privilege-users

Introduced In: 9.17

Retrieves the JIT privilege user configurations for an SVM.

  • security jit-privilege user show

Parameters

Name Type In Required Description

account.name

string

query

False

Filter by account.name

owner.uuid

string

query

False

Filter by owner.uuid

owner.name

string

query

False

Filter by owner.name

comment

string

query

False

Filter by comment

start_time

string

query

False

Filter by start_time

session_validity

string

query

False

Filter by session_validity

role.name

string

query

False

Filter by role.name

jit_validity

string

query

False

Filter by jit_validity

application

string

query

False

Filter by application

jit_state

string

query

False

Filter by jit_state

end_time

string

query

False

Filter by end_time

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.

  • Default value: 15

  • Max value: 120

  • Min value: 0

order_by

array[string]

query

False

Order results by specified fields and optional [asc

desc] direction. Default direction is 'asc' for ascending.

fields

array[string]

query

False

Response

Status: 200, Ok
Name Type Description

_links

_links

num_records

integer

Number of records.

records

array[security_jit_privilege_user]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": [
    {
      "account": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "joe.smith"
      },
      "application": "string",
      "comment": "Comment text",
      "end_time": "2024-11-08 11:15:31 +0000",
      "jit_state": "active",
      "jit_validity": "P90D",
      "owner": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "svm1",
        "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
      },
      "role": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "admin"
      },
      "session_validity": "PT1H",
      "start_time": "2024-11-08 10:15:31 +0000"
    }
  ]
}

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

account_reference

The name of the user.

Name Type Description

_links

_links

name

string

User account

owner

Owner name and UUID that uniquely identifies the JIT settings for a user.

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.

role

The role the user will be elevated to.

Name Type Description

_links

_links

name

string

Role name

security_jit_privilege_user

Name Type Description

account

account_reference

The name of the user.

application

string

The name of the application.

comment

string

The description of the elevation rule.

end_time

string

The end date and time of the JIT privilege session in UTC.

jit_state

string

The current status of the rule: preactive, idle, or active.

jit_validity

string

The JIT validity period on this SVM for this user.

owner

owner

Owner name and UUID that uniquely identifies the JIT settings for a user.

role

role

The role the user will be elevated to.

session_validity

string

The session validity period on this SVM for this user.

start_time

string

The start date and time of the JIT privilege session in UTC.

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.