Groups Api Set Ssh Mfa Fallback
Idempotent. Never publishes: it attaches or detaches the shared managed Policy, which marks the Group as having pending changes. 409 MANUAL_CATCH_ALL_EXISTS when the Group already has an administrator-authored catch-all SSH MFA rule; 409 FALLBACK_NAME_CONFLICT when a reserved name is taken. Requires the ADMIN or SECURITY_OPERATOR role.
Security Group id
1
The wanted setting: enabled true turns the fallback on, false turns it off
Show optional properties
{
"enabled": false
}
{
"enabled": true
}
True turns the fallback on, false turns it off
200 OK successful response envelope. The fallback setting after the change
{
"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: ENABLED_REQUIRED or INVALID_ARGUMENT
{
"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.
403 Forbidden: FORBIDDEN or CSRF_ERROR
{
"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
"ApiErrorResponse Object"
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.
409 Conflict: MANUAL_CATCH_ALL_EXISTS or FALLBACK_NAME_CONFLICT
"ApiErrorResponse Object"
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 -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"enabled":"boolean"}' https://{api_host}/api/v1/groups/{id}/ssh-mfa-fallback