List a stored NSS group's membership rows (auditor and above)

GET

/api/admin/nss/groups/{gid}/members

const url = 'https://example.com/api/admin/nss/groups/1/members?limit=25';
const options = {method: 'GET', headers: {'X-Ssoossh-Key-Secret': '<X-Ssoossh-Key-Secret>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example.com/api/admin/nss/groups/1/members?limit=25' \
  --header 'X-Ssoossh-Key-Secret: <X-Ssoossh-Key-Secret>'

One page of the posix_group_members rows for this gid, ordered by uid, each with the stored account of that uid and its state when there is one (a member with no stored account is never served). The cursor is the last uid of the previous page. Reads only the database.

Authorizations

sessionCookie

Parameters

Path Parameters

gid

required

integer

The group’s stored gid

Query Parameters

after

string

Uid to start after (cursor): the previous page’s next_cursor

limit

integer

Page size (default 25, max 100)

Example

Responses

200

One page of members

application/json

object

data

required

object

members

required

Array<object>

object

added_at

AddedAt is when ssoosshd first stored the membership, which is not the date of the add in the directory (it does not timestamp member values). Absent for a membership the first full import stored: present before that import.

string

name

Name and State describe the stored account with that uid, and are absent when no stored account has it (such a member is never served).

string

state

string

Allowed values: withheld tombstone disabled missing pending active

uid

required

integer

next_cursor

NextCursor is the after for the following page: this page’s last uid, absent on the last page.

string

total

required

Total is the group’s membership rows, across all pages.

integer

error

string

Example

{
  "data": {
    "members": [
      {
        "state": "withheld"
      }
    ]
  }
}

400

The gid is not a number, invalid paging parameters, an after that is not a uid, or offset

application/json

object

data

Data is always null on an error response.

error

required

Error is a human-readable message. Branch on the HTTP status rather than this string; it is for humans and logs.

string

error_code

required

ErrorCode is a machine-readable error classifier. One of the error_code constants from internal/apitypes; use this to decide whether to retry or branch on the failure mode.

string

Example

{
  "error": "certificate request \"9f1c…\" not found",
  "error_code": "not_found"
}

401

Not authenticated

application/json

object

data

Data is always null on an error response.

error

required

Error is a human-readable message. Branch on the HTTP status rather than this string; it is for humans and logs.

string

error_code

required

ErrorCode is a machine-readable error classifier. One of the error_code constants from internal/apitypes; use this to decide whether to retry or branch on the failure mode.

string

Example

{
  "error": "certificate request \"9f1c…\" not found",
  "error_code": "not_found"
}

403

Not authorized as auditor

application/json

object

data

Data is always null on an error response.

error

required

Error is a human-readable message. Branch on the HTTP status rather than this string; it is for humans and logs.

string

error_code

required

ErrorCode is a machine-readable error classifier. One of the error_code constants from internal/apitypes; use this to decide whether to retry or branch on the failure mode.

string

Example

{
  "error": "certificate request \"9f1c…\" not found",
  "error_code": "not_found"
}

404

No stored group has that gid, or NSS is disabled

application/json

object

data

Data is always null on an error response.

error

required

Error is a human-readable message. Branch on the HTTP status rather than this string; it is for humans and logs.

string

error_code

required

ErrorCode is a machine-readable error classifier. One of the error_code constants from internal/apitypes; use this to decide whether to retry or branch on the failure mode.

string

Example

{
  "error": "certificate request \"9f1c…\" not found",
  "error_code": "not_found"
}