Discuss with expertTry it for free
© 2026 Direct Cursus Technology L.L.C.

Organization Policy API, REST: AuthenticationPolicyRule.Update

Written by
Updated at September 14, 2026
View in Markdown

Updates the specified authentication policy rule.

HTTP request

PATCH https://organization-manager.api.cloud.yandex.net/organization-manager/v1/policy/authenticationPolicyRules/{ruleId}

Path parameters

Field

Description

ruleId

string

Required field. ID of authentication policy rule to update.

The maximum string length in characters is 50.

Body parameters

{
  "updateMask": "string",
  "name": "string",
  "description": "string",
  "effect": "string",
  "obligations": [
    {
      // Includes only one of the fields `stepUpRequired`, `skipMfa`, `reauthenticationRequired`
      "stepUpRequired": {
        "acrId": "string",
        "ttl": "string"
      },
      "skipMfa": {
        "requireOnce": "boolean"
      },
      "reauthenticationRequired": {
        "ttl": "string"
      }
      // end of the list of possible fields
    }
  ],
  "subjectsInclude": [
    "string"
  ],
  "subjectsExclude": [
    "string"
  ],
  "networksInclude": [
    "string"
  ],
  "networksExclude": [
    "string"
  ],
  "applicationsExclude": [
    "string"
  ],
  "applicationsInclude": [
    "string"
  ],
  "labels": "object"
}

Field

Description

updateMask

string (field-mask)

A comma-separated names off ALL fields to be updated.
Only the specified fields will be changed. The others will be left untouched.
If the field is specified in updateMask and no value for that field was sent in the request,
the field's value will be reset to the default. The default value for most fields is null or 0.

If updateMask is not sent in the request, all fields' values will be updated.
Fields specified in the request will be updated to provided values.
The rest of the fields will be reset to the default.

name

string

Updated name of the authentication policy rule.
Name must be unique within organization.

Value must match the regular expression |[a-z]([-a-z0-9]{0,61}[a-z0-9])?.

description

string

Updated description of the authentication policy rule.

The maximum string length in characters is 256.

effect

enum (Effect)

Effect to apply when the rule matches.

obligations[]

Obligation

Obligations to satisfy when the effect is ALLOW_WITH_OBLIGATIONS.

The maximum number of elements is 5.

subjectsInclude[]

string

List of IDs of subjects to be affected by the authentication policy rule.
Empty list will match all subjects and is functionally equal to ["allUsers"].

The maximum string length in characters for each value is 64. The maximum number of elements is 64.

subjectsExclude[]

string

List of IDs of subjects not to be affected by the authentication policy rule.
Empty list will match no subjects.

The maximum string length in characters for each value is 64. The maximum number of elements is 64.

networksInclude[]

string

Source IP ranges in CIDR notation that the authentication policy rule applies to.
Empty list will match any source and is functionally equal to ["0.0.0.0/0", "::0/0"].

The maximum string length in characters for each value is 64. The maximum number of elements is 64.

networksExclude[]

string

Source IP ranges in CIDR notation excluded from the authentication policy rule.
Empty list will match no sources.

The maximum string length in characters for each value is 64. The maximum number of elements is 64.

applicationsExclude[]

string

List of IDs of applications not to be affected by the authentication policy rule.
Empty list will match no applications.

The maximum string length in characters for each value is 64. The maximum number of elements is 64.

applicationsInclude[]

string

List of IDs of applications to be affected by the authentication policy rule.
Empty list will match all applications.

The maximum string length in characters for each value is 64. The maximum number of elements is 64.

labels

object (map<string, string>)

Labels of the authentication policy rule.

The maximum string length in characters for each value is 63. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]*. Each value must match the regular expression [-_0-9a-z]*. No more than 64 per resource.

Obligation

Field

Description

stepUpRequired

StepUpRequired

Require step-up authentication.

Includes only one of the fields stepUpRequired, skipMfa, reauthenticationRequired.

skipMfa

SkipMfa

Allow skipping the organization's current MFA requirements.

Includes only one of the fields stepUpRequired, skipMfa, reauthenticationRequired.

reauthenticationRequired

ReauthenticationRequired

Require full authentication again.

Includes only one of the fields stepUpRequired, skipMfa, reauthenticationRequired.

StepUpRequired

Field

Description

acrId

string

Required field. ACR ID required to satisfy this obligation.

The maximum string length in characters is 50.

ttl

string (duration)

Required field. Maximum age of a factor verification that can satisfy this obligation.

SkipMfa

Field

Description

requireOnce

boolean

If true, the organization's current MFA requirements must have been satisfied at least once
during the current session.

ReauthenticationRequired

Field

Description

ttl

string (duration)

Required field. Maximum age of an authentication that can satisfy this obligation.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": "object",
  // Includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": "object"
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

createdAt

string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

createdBy

string

ID of the user or service account who initiated the operation.

modifiedAt

string (date-time)

The time when the Operation resource was last modified.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

done

boolean

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

object

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

object

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

Status

The error result of the operation in case of failure or cancellation.

Field

Description

code

integer (int32)

Error code. An enum value of google.rpc.Code.

message

string

An error message.

details[]

object

A list of messages that carry the error details.
Previous
Create
Next
Delete