Admin - Get effective policy for a key share

GET 
/admin/policies/get-effective-key-policy

Get effective policy for a key share. If no policy is attached directly to the key, the default policy for the key owner will be returned.

Request

Query Parameters

key_id KeyIdrequired

Header Parameters

AUTHORIZATION stringrequired

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

Responses

200

application/json

Schema

Schema

oneOf

MOD1

string

MOD2

attached

object

required

policy

object

required

id PolicyIdrequired

name stringrequired

rules

object[]

required

Array [

oneOf

MOD1

rule

object

required

endpoint urirequired

id RuleIdrequired

name stringrequired

pubkey

object

required

The public key of the external rule server, in PEM format. This key is used to verify the JWT signature of the response.

jwt_alg stringrequired

pubkey stringrequired

type stringrequired

Possible values: [External]

]

via KeyOrUserDefaultrequired

Possible values: [key, user_default]

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...