Skip to main content

Retrieve an applied restricted group policy for an SVM

Contributors
PDFs

GET /protocols/cifs/group-policies/{svm.uuid}/restricted-groups/{policy_index}/{group_name}

Introduced In: 9.12

Retrieves applied policy of restricted group for specified SVM.

  • vserver cifs group-policy restricted-group show-applied

Parameters

Name Type In Required Description

policy_index

integer

path

True

Group policy index.

group_name

string

path

True

Group 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

group_name

string

link

string

Link info.

members

array[string]

Members of the group.

memberships

array[string]

Group is member of Group/OU.

policy_index

integer

Group policy index.

policy_name

string

svm

svm

Will not be populated for objects that are yet to be applied.

version

integer

Group policy object version.
Example response 
{
  "group_name": "test_group",
  "link": "domain",
  "members": [
    "DOMAIN/test_user",
    "DOMAIN/user2"
  ],
  "memberships": [
    "DOMAIN/AdministratorGrp",
    "DOMAIN/deptMark"
  ],
  "policy_name": "test_policy",
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  },
  "version": 7
}

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

svm

Will not be populated for objects that are yet to be applied.

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.

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.