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

Retrieve users for a UNIX group and SVM

Contributors

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

Introduced In: 9.10

Retrieves users for the specified UNIX group and SVM.

  • vserver services name-service unix-group show

Parameters

Name Type In Required Description

unix_group.name

string

path

True

UNIX group name.

name

string

path

True

UNIX user to be retrieved from the group.

fields

array[string]

query

False

Specify the fields to return.

svm.uuid

string

path

True

UUID of the SVM to which this object belongs.

Response

Status: 200, Ok
Name Type Description

_links

_links

name

string

UNIX user who belongs to the specified UNIX group and the SVM.

records

array[records]

An array of UNIX users specified to add multiple users to a UNIX group in a single API call. Not allowed when the name property is used.

skip_name_validation

boolean

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

svm

svm

SVM, applies only to SVM-scoped objects.

unix_group

unix_group

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

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

Name Type Description

self

href

records

Name Type Description

name

string

UNIX user who belongs to the specified UNIX group and the SVM.

svm

SVM, applies only to SVM-scoped objects.

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.

unix_group

Name Type Description

name

string

UNIX group 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.