Groups Api Set Ssh Mfa Fallback

Groups Api Set Ssh Mfa Fallback
Turn a Group's SSH MFA fallback on or off

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.

Request
URI
PUT
https://{api_host}/api/v1/groups/{id}/ssh-mfa-fallback
COPY
Path Parameters
integer
id
Required  

Security Group id

id example
1

Request Body

The wanted setting: enabled true turns the fallback on, false turns it off

SetSshMfaFallbackRequest of type(s) application/json
Required  

Show optional properties

{
    "enabled": false
}
{
    "enabled": true
}
boolean
enabled
Required  

True turns the fallback on, false turns it off

Authentication
This operation uses the following authentication methods.
Responses
200

200 OK successful response envelope. The fallback setting after the change

Returns SshMfaFallbackDto of type(s) application/json
{
    "groupId": 1,
    "state": "PENDING_ON",
    "enabled": true,
    "policyId": 12,
    "ruleId": 345,
    "publishedVersion": 4,
    "groupHasPendingChanges": true,
    "manualCatchAlls": [],
    "credentialsInBundle": 2
}
integer As int64 As int64
groupId
Required  

Security Group id

string
state
Required  

OFF, PENDING_ON (saved, not published), ON (published) or PENDING_OFF (removal saved, not published). Says nothing about what a host has applied.

Enumeration: OFF, PENDING_ON, ON, PENDING_OFF
boolean
enabled
Required  

True when the shared managed Policy is attached to the Group (ON or PENDING_ON).

integer As int64 As int64
policyId
Optional

Id of the shared Console-managed Policy, when it exists

integer As int64 As int64
ruleId
Optional

Id of the shared Console-managed catch-all rule, when it exists

integer As int64 As int64
publishedVersion
Required  

The Group's last published revision.

boolean
groupHasPendingChanges
Required  

True when the Group has changes that a Publish would send

array of object
manualCatchAlls
Required  

Catch-all SSH MFA rules an administrator authored in the Policies attached to the Group

integer As int32 As int32
credentialsInBundle
Required  

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

400 Bad Request: ENABLED_REQUIRED or INVALID_ARGUMENT

Returns ApiErrorResponse of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

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.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

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

401 Unauthorized: UNAUTHENTICATED when the VTP_SESSION cookie is missing, unknown, expired or revoked

Returns Unauthenticated of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

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.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

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

403 Forbidden: FORBIDDEN or CSRF_ERROR

Returns ApiErrorResponse of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

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.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

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

404 Not Found: SECURITY_GROUP_NOT_FOUND

Returns ApiErrorResponse of type(s) application/json
"ApiErrorResponse Object"
errorCode
Required  

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.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

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

409 Conflict: MANUAL_CATCH_ALL_EXISTS or FALLBACK_NAME_CONFLICT

Returns ApiErrorResponse of type(s) application/json
"ApiErrorResponse Object"
errorCode
Required  

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.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.


Code Samples
COPY
                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"enabled":"boolean"}' https://{api_host}/api/v1/groups/{id}/ssh-mfa-fallback