Groups Api Get Ssh Mfa Fallback
Accessible to every authenticated role. The Group's 'Require MFA for all SSH users' setting. It is on exactly when the shared Console-managed catch-all Policy (one Policy for all Groups) is attached to the Group. state separates saved from published: PENDING_ON and PENDING_OFF need a Group Publish, and neither says what a host has applied.
Security Group id
1
200 OK successful response envelope. The fallback setting and its state
{
"groupId": 1,
"state": "PENDING_ON",
"enabled": true,
"policyId": 12,
"ruleId": 345,
"publishedVersion": 4,
"groupHasPendingChanges": true,
"manualCatchAlls": [],
"credentialsInBundle": 2
}
Security Group id
OFF, PENDING_ON (saved, not published), ON (published) or PENDING_OFF (removal saved, not published). Says nothing about what a host has applied.
True when the shared managed Policy is attached to the Group (ON or PENDING_ON).
Id of the shared Console-managed Policy, when it exists
Id of the shared Console-managed catch-all rule, when it exists
The Group's last published revision.
True when the Group has changes that a Publish would send
Catch-all SSH MFA rules an administrator authored in the Policies attached to the Group
How many MFA credentials (enabled, enrolled users) the Group's bundle would carry on publish. Zero means no seed reaches the hosts, so an all-users rule may not be enforced.
400 Bad Request: INVALID_ARGUMENT when the id path variable is not a number
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
401 Unauthorized: UNAUTHENTICATED when the VTP_SESSION cookie is missing, unknown, expired or revoked
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
404 Not Found: SECURITY_GROUP_NOT_FOUND
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
curl -H 'Authorization: <value>' https://{api_host}/api/v1/groups/{id}/ssh-mfa-fallback