Admin - Add a new external policy rule

POST 
/admin/policies/add-external-rule

Add a new policy Rule to the system. A policy rule is a rule that is checked by an external service using REST API. The external service must be reachable by the Vertex. The external service must return a signed JWT with a schema specified in the Sodot technical docs.

Request

Header Parameters

AUTHORIZATION stringrequired

The AUTHORIZATION header must be set to the Admin token. which is set on Vertex setup

application/json

Body

required

jwt_alg stringrequired
name stringrequired
pubkey stringrequired
url urirequired

Responses

200

application/json

Schema

Schema

rule_id RuleIdrequired

Example (from schema)

{
  "rule_id": "string"
}

400

application/json

Schema

Schema

err_msg stringrequired
err_type stringrequired

Possible values: [already_performed_keygen, api_key_not_found, bad_n_and_t_params, bad_request_params, batch_too_large, executor_result, key_id_not_exists, key_operation_before_keygen, policy_in_use_by_keys, policy_in_use_by_users, policy_not_found, policy_validation_failed, room_creation_problem, rule_in_use, rule_not_found, rule_not_in_policy, server_share_backup_setting_disabled, unique_violation, user_has_associated_keys, user_id_not_exists, user_name_already_exists, you_have_to_be_admin]

Example (from schema)

{
  "err_msg": "string",
  "err_type": "already_performed_keygen"
}

401

application/json

Schema

Schema

err_msg stringrequired
err_type stringrequired

Possible values: [access_denied]

Example (from schema)

{
  "err_msg": "string",
  "err_type": "access_denied"
}

404

application/json

Schema

Schema

err_msg stringrequired
err_type stringrequired

Possible values: [not_found]

Example (from schema)

{
  "err_msg": "string",
  "err_type": "not_found"
}

500

application/json

Schema

Schema

err_msg stringrequired
err_type stringrequired

Possible values: [internal_problem]

Example (from schema)

{
  "err_msg": "string",
  "err_type": "internal_problem"
}

Loading...