Skip to content
ssoossh

List pending uid and gid changes (admin only)

GET
/api/admin/nss/pending-id-changes
curl --request GET \
  --url https://example.com/api/admin/nss/pending-id-changes \
  --header 'X-Ssoossh-Key-Secret: <X-Ssoossh-Key-Secret>'

Every NSS account and group whose directory entry now gives a stored uid or gid a different value. Hosts keep being served the stored value until an admin accepts the change (after re-owning files on the hosts) or the directory reverts; the server raises nss.id_change_pending daily meanwhile. Oldest first.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

The pending changes

Media typeapplication/json
object
data
required
object
groups
required
Array<object>
object
dn
required
string
gid
required
integer
name
required
string
pending_gid
required
integer
pending_since
required
string
users
required
Array<object>
object
dn
required
string
gid
integer
name
required
string
pending_gid
integer
pending_since
required

PendingSince is the first sync that saw the pending value.

string
pending_uid

PendingUID and PendingGID are the directory’s values, absent when that number has not changed.

integer
uid
required

UID and GID are the stored values, still served. GID is absent when the entry has no gid attribute (accepted only under nss.auto_private_groups “true”).

integer
error
string

Example generated

{
  "data": {
    "groups": [
      {
        "dn": "example",
        "gid": 1,
        "name": "example",
        "pending_gid": 1,
        "pending_since": "example"
      }
    ],
    "users": [
      {
        "dn": "example",
        "gid": 1,
        "name": "example",
        "pending_gid": 1,
        "pending_since": "example",
        "pending_uid": 1,
        "uid": 1
      }
    ]
  },
  "error": "example"
}

401

Section titled “401”

Not authenticated

Media typeapplication/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

Section titled “403”

Not authorized as admin

Media typeapplication/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

Section titled “404”

NSS is disabled

Media typeapplication/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"
}