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

Retrieve the UNIX user information for a user and SVM

Contributors
PDFs

GET /name-services/unix-users/{svm.uuid}/{name}

Introduced In: 9.9

Retrieves UNIX user information for the specified user and SVM.

  • vserver services name-service unix-user show

Parameters

Name Type In Required Description

name

string

path

True

UNIX user name

svm.uuid

string

path

True

UUID of the SVM to which this object belongs.

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

_links

_links

full_name

string

User's full name.

id

integer

UNIX user ID of the specified user.

name

string

UNIX user name to be added to the local database.

primary_gid

integer

Primary group ID to which the user belongs.

skip_name_validation

boolean

Indicates whether or not the validation for the specified UNIX user name is disabled.

svm

svm
Example response 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "full_name": "string",
  "name": "string",
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  }
}

Error

Status: Default, Error
Name Type Description

error

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

svm

Name Type Description

_links

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

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.