Skip to content
ssoossh

Purge a tombstoned group early (admin only)

DELETE
/api/admin/nss/groups/{gid}/tombstone
curl --request DELETE \
  --url https://example.com/api/admin/nss/groups/1/tombstone \
  --header 'X-Ssoossh-Key-Secret: <X-Ssoossh-Key-Secret>'

Deletes the tombstoned NSS group with this gid before nss.tombstone_retention, freeing its gid and name, and audits it as nss.tombstone_purged. Only a tombstone: a live group is 404.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
gid
required
integer

The tombstone’s gid

Responses

Section titled “Responses”

200

Section titled “200”

The purged group

Media typeapplication/json
object
data
required
object
dn
required
string
name
required
string
number
required

Number is the uid or gid the row held.

integer
error
string

Example generated

{
  "data": {
    "dn": "example",
    "name": "example",
    "number": 1
  },
  "error": "example"
}

400

Section titled “400”

The gid is not a number

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"
}

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”

No tombstoned group has that gid, or 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"
}