Skip to main content
REST API reference

Retrieve the JIT privilege user configurations for an SVM

PDFs

GET /security/jit-privilege-users/{owner.uuid}/{account.name}/{application}

Introduced In: 9.17

Retrieves the JIT privilege user configurations for an SVM.

  • security jit-privilege user show

Parameters

Name Type In Required Description

owner.uuid

string

path

True

Used to identify a cluster or an SVM

account.name

string

path

True

The username.

application

string

path

True

The name of the application.

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
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.
Example response 
{
  "account": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "joe.smith"
  },
  "application": "string",
  "comment": "Comment text",
  "end_time": "2024-11-08 06:15:31 -0500",
  "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 05:15:31 -0500"
}

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

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

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.