Class: Aws::VerifiedPermissions::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::VerifiedPermissions::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/client.rb
Overview
An API client for VerifiedPermissions. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::VerifiedPermissions::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#batch_get_policy(params = {}) ⇒ Types::BatchGetPolicyOutput
Retrieves information about a group (batch) of policies.
-
#batch_is_authorized(params = {}) ⇒ Types::BatchIsAuthorizedOutput
Makes a series of decisions about multiple authorization requests for one principal or resource.
-
#batch_is_authorized_with_token(params = {}) ⇒ Types::BatchIsAuthorizedWithTokenOutput
Makes a series of decisions about multiple authorization requests for one token.
-
#create_identity_source(params = {}) ⇒ Types::CreateIdentitySourceOutput
Adds an identity source to a policy store–an Amazon Cognito user pool or OpenID Connect (OIDC) identity provider (IdP).
-
#create_policy(params = {}) ⇒ Types::CreatePolicyOutput
Creates a Cedar policy and saves it in the specified policy store.
-
#create_policy_store(params = {}) ⇒ Types::CreatePolicyStoreOutput
Creates a policy store.
-
#create_policy_template(params = {}) ⇒ Types::CreatePolicyTemplateOutput
Creates a policy template.
-
#delete_identity_source(params = {}) ⇒ Struct
Deletes an identity source that references an identity provider (IdP) such as Amazon Cognito.
-
#delete_policy(params = {}) ⇒ Struct
Deletes the specified policy from the policy store.
-
#delete_policy_store(params = {}) ⇒ Struct
Deletes the specified policy store.
-
#delete_policy_template(params = {}) ⇒ Struct
Deletes the specified policy template from the policy store.
-
#get_identity_source(params = {}) ⇒ Types::GetIdentitySourceOutput
Retrieves the details about the specified identity source.
-
#get_policy(params = {}) ⇒ Types::GetPolicyOutput
Retrieves information about the specified policy.
-
#get_policy_store(params = {}) ⇒ Types::GetPolicyStoreOutput
Retrieves details about a policy store.
-
#get_policy_template(params = {}) ⇒ Types::GetPolicyTemplateOutput
Retrieve the details for the specified policy template in the specified policy store.
-
#get_schema(params = {}) ⇒ Types::GetSchemaOutput
Retrieve the details for the specified schema in the specified policy store.
-
#is_authorized(params = {}) ⇒ Types::IsAuthorizedOutput
Makes an authorization decision about a service request described in the parameters.
-
#is_authorized_with_token(params = {}) ⇒ Types::IsAuthorizedWithTokenOutput
Makes an authorization decision about a service request described in the parameters.
-
#list_identity_sources(params = {}) ⇒ Types::ListIdentitySourcesOutput
Returns a paginated list of all of the identity sources defined in the specified policy store.
-
#list_policies(params = {}) ⇒ Types::ListPoliciesOutput
Returns a paginated list of all policies stored in the specified policy store.
-
#list_policy_stores(params = {}) ⇒ Types::ListPolicyStoresOutput
Returns a paginated list of all policy stores in the calling Amazon Web Services account.
-
#list_policy_templates(params = {}) ⇒ Types::ListPolicyTemplatesOutput
Returns a paginated list of all policy templates in the specified policy store.
-
#put_schema(params = {}) ⇒ Types::PutSchemaOutput
Creates or updates the policy schema in the specified policy store.
-
#update_identity_source(params = {}) ⇒ Types::UpdateIdentitySourceOutput
Updates the specified identity source to use a new identity provider (IdP), or to change the mapping of identities from the IdP to a different principal entity type.
-
#update_policy(params = {}) ⇒ Types::UpdatePolicyOutput
Modifies a Cedar static policy in the specified policy store.
-
#update_policy_store(params = {}) ⇒ Types::UpdatePolicyStoreOutput
Modifies the validation setting for a policy store.
-
#update_policy_template(params = {}) ⇒ Types::UpdatePolicyTemplateOutput
Updates the specified policy template.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
474 475 476 |
# File 'gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/client.rb', line 474 def initialize(*args) super end |
Instance Method Details
#batch_get_policy(params = {}) ⇒ Types::BatchGetPolicyOutput
Retrieves information about a group (batch) of policies.
BatchGetPolicy
operation doesn't have its own IAM permission.
To authorize this operation for Amazon Web Services principals,
include the permission verifiedpermissions:GetPolicy
in their IAM
policies.
604 605 606 607 |
# File 'gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/client.rb', line 604 def batch_get_policy(params = {}, = {}) req = build_request(:batch_get_policy, params) req.send_request() end |
#batch_is_authorized(params = {}) ⇒ Types::BatchIsAuthorizedOutput
Makes a series of decisions about multiple authorization requests for
one principal or resource. Each request contains the equivalent
content of an IsAuthorized
request: principal, action, resource, and
context. Either the principal
or the resource
parameter must be
identical across all requests. For example, Verified Permissions
won't evaluate a pair of requests where bob
views photo1
and
alice
views photo2
. Authorization of bob
to view photo1
and
photo2
, or bob
and alice
to view photo1
, are valid batches.
The request is evaluated against all policies in the specified policy
store that match the entities that you declare. The result of the
decisions is a series of Allow
or Deny
responses, along with the
IDs of the policies that produced each decision.
The entities
of a BatchIsAuthorized
API request can contain up to
100 principals and up to 100 resources. The requests
of a
BatchIsAuthorized
API request can contain up to 30 requests.
BatchIsAuthorized
operation doesn't have its own IAM
permission. To authorize this operation for Amazon Web Services
principals, include the permission verifiedpermissions:IsAuthorized
in their IAM policies.
890 891 892 893 |
# File 'gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/client.rb', line 890 def (params = {}, = {}) req = build_request(:batch_is_authorized, params) req.send_request() end |
#batch_is_authorized_with_token(params = {}) ⇒ Types::BatchIsAuthorizedWithTokenOutput
Makes a series of decisions about multiple authorization requests for one token. The principal in this request comes from an external identity source in the form of an identity or access token, formatted as a JSON web token (JWT). The information in the parameters can also define additional context that Verified Permissions can include in the evaluations.
The request is evaluated against all policies in the specified policy
store that match the entities that you provide in the entities
declaration and in the token. The result of the decisions is a series
of Allow
or Deny
responses, along with the IDs of the policies
that produced each decision.
The entities
of a BatchIsAuthorizedWithToken
API request can
contain up to 100 resources and up to 99 user groups. The requests
of a BatchIsAuthorizedWithToken
API request can contain up to 30
requests.
BatchIsAuthorizedWithToken
operation doesn't have its own IAM
permission. To authorize this operation for Amazon Web Services
principals, include the permission
verifiedpermissions:IsAuthorizedWithToken
in their IAM policies.
1174 1175 1176 1177 |
# File 'gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/client.rb', line 1174 def (params = {}, = {}) req = build_request(:batch_is_authorized_with_token, params) req.send_request() end |
#create_identity_source(params = {}) ⇒ Types::CreateIdentitySourceOutput
Adds an identity source to a policy store–an Amazon Cognito user pool or OpenID Connect (OIDC) identity provider (IdP).
After you create an identity source, you can use the identities
provided by the IdP as proxies for the principal in authorization
queries that use the IsAuthorizedWithToken or
BatchIsAuthorizedWithToken API operations. These identities take
the form of tokens that contain claims about the user, such as IDs,
attributes and group memberships. Identity sources provide identity
(ID) tokens and access tokens. Verified Permissions derives
information about your user and session from token claims. Access
tokens provide action context
to your policies, and ID tokens
provide principal Attributes
.
Tokens from an identity source user continue to be usable until they expire. Token revocation and resource deletion have no effect on the validity of a token in your policy store
Amazon Cognito user pool:
Namespace::[Entity type]::[User pool ID]|[user principal attribute]
, for exampleMyCorp::User::us-east-1_EXAMPLE|a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
.OpenID Connect (OIDC) provider:
Namespace::[Entity type]::[entityIdPrefix]|[user principal attribute]
, for exampleMyCorp::User::MyOIDCProvider|a1b2c3d4-5678-90ab-cdef-EXAMPLE22222
.
1345 1346 1347 1348 |
# File 'gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/client.rb', line 1345 def create_identity_source(params = {}, = {}) req = build_request(:create_identity_source, params) req.send_request() end |
#create_policy(params = {}) ⇒ Types::CreatePolicyOutput
Creates a Cedar policy and saves it in the specified policy store. You can create either a static policy or a policy linked to a policy template.
To create a static policy, provide the Cedar policy text in the
StaticPolicy
section of thePolicyDefinition
.To create a policy that is dynamically linked to a policy template, specify the policy template ID and the principal and resource to associate with this policy in the
templateLinked
section of thePolicyDefinition
. If the policy template is ever updated, any policies linked to the policy template automatically use the updated template.
1575 1576 1577 1578 |
# File 'gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/client.rb', line 1575 def create_policy(params = {}, = {}) req = build_request(:create_policy, params) req.send_request() end |
#create_policy_store(params = {}) ⇒ Types::CreatePolicyStoreOutput
Creates a policy store. A policy store is a container for policy resources.
1694 1695 1696 1697 |
# File 'gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/client.rb', line 1694 def create_policy_store(params = {}, = {}) req = build_request(:create_policy_store, params) req.send_request() end |
#create_policy_template(params = {}) ⇒ Types::CreatePolicyTemplateOutput
Creates a policy template. A template can use placeholders for the principal and resource. A template must be instantiated into a policy by associating it with specific principals and resources to use for the placeholders. That instantiated policy can then be considered in authorization decisions. The instantiated policy works identically to any other policy, except that it is dynamically linked to the template. If the template changes, then any policies that are linked to that template are immediately updated as well.
1799 1800 1801 1802 |
# File 'gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/client.rb', line 1799 def create_policy_template(params = {}, = {}) req = build_request(:create_policy_template, params) req.send_request() end |
#delete_identity_source(params = {}) ⇒ Struct
Deletes an identity source that references an identity provider (IdP) such as Amazon Cognito. After you delete the identity source, you can no longer use tokens for identities from that identity source to represent principals in authorization queries made using IsAuthorizedWithToken. operations.
1848 1849 1850 1851 |
# File 'gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/client.rb', line 1848 def delete_identity_source(params = {}, = {}) req = build_request(:delete_identity_source, params) req.send_request() end |
#delete_policy(params = {}) ⇒ Struct
Deletes the specified policy from the policy store.
This operation is idempotent; if you specify a policy that doesn't
exist, the request response returns a successful HTTP 200
status
code.
1893 1894 1895 1896 |
# File 'gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/client.rb', line 1893 def delete_policy(params = {}, = {}) req = build_request(:delete_policy, params) req.send_request() end |
#delete_policy_store(params = {}) ⇒ Struct
Deletes the specified policy store.
This operation is idempotent. If you specify a policy store that does not exist, the request response will still return a successful HTTP 200 status code.
1932 1933 1934 1935 |
# File 'gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/client.rb', line 1932 def delete_policy_store(params = {}, = {}) req = build_request(:delete_policy_store, params) req.send_request() end |
#delete_policy_template(params = {}) ⇒ Struct
Deletes the specified policy template from the policy store.
This operation also deletes any policies that were created from the specified policy template. Those policies are immediately removed from all future API responses, and are asynchronously deleted from the policy store.
1979 1980 1981 1982 |
# File 'gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/client.rb', line 1979 def delete_policy_template(params = {}, = {}) req = build_request(:delete_policy_template, params) req.send_request() end |
#get_identity_source(params = {}) ⇒ Types::GetIdentitySourceOutput
Retrieves the details about the specified identity source.
2069 2070 2071 2072 |
# File 'gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/client.rb', line 2069 def get_identity_source(params = {}, = {}) req = build_request(:get_identity_source, params) req.send_request() end |
#get_policy(params = {}) ⇒ Types::GetPolicyOutput
Retrieves information about the specified policy.
2161 2162 2163 2164 |
# File 'gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/client.rb', line 2161 def get_policy(params = {}, = {}) req = build_request(:get_policy, params) req.send_request() end |
#get_policy_store(params = {}) ⇒ Types::GetPolicyStoreOutput
Retrieves details about a policy store.
2219 2220 2221 2222 |
# File 'gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/client.rb', line 2219 def get_policy_store(params = {}, = {}) req = build_request(:get_policy_store, params) req.send_request() end |
#get_policy_template(params = {}) ⇒ Types::GetPolicyTemplateOutput
Retrieve the details for the specified policy template in the specified policy store.
2284 2285 2286 2287 |
# File 'gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/client.rb', line 2284 def get_policy_template(params = {}, = {}) req = build_request(:get_policy_template, params) req.send_request() end |
#get_schema(params = {}) ⇒ Types::GetSchemaOutput
Retrieve the details for the specified schema in the specified policy store.
2345 2346 2347 2348 |
# File 'gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/client.rb', line 2345 def get_schema(params = {}, = {}) req = build_request(:get_schema, params) req.send_request() end |
#is_authorized(params = {}) ⇒ Types::IsAuthorizedOutput
Makes an authorization decision about a service request described in
the parameters. The information in the parameters can also define
additional context that Verified Permissions can include in the
evaluation. The request is evaluated against all matching policies in
the specified policy store. The result of the decision is either
Allow
or Deny
, along with a list of the policies that resulted in
the decision.
2515 2516 2517 2518 |
# File 'gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/client.rb', line 2515 def (params = {}, = {}) req = build_request(:is_authorized, params) req.send_request() end |
#is_authorized_with_token(params = {}) ⇒ Types::IsAuthorizedWithTokenOutput
Makes an authorization decision about a service request described in
the parameters. The principal in this request comes from an external
identity source in the form of an identity token formatted as a JSON
web token (JWT). The information in the parameters can also define
additional context that Verified Permissions can include in the
evaluation. The request is evaluated against all matching policies in
the specified policy store. The result of the decision is either
Allow
or Deny
, along with a list of the policies that resulted in
the decision.
Verified Permissions validates each token that is specified in a request by checking its expiration date and its signature.
Tokens from an identity source user continue to be usable until they expire. Token revocation and resource deletion have no effect on the validity of a token in your policy store
2691 2692 2693 2694 |
# File 'gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/client.rb', line 2691 def (params = {}, = {}) req = build_request(:is_authorized_with_token, params) req.send_request() end |
#list_identity_sources(params = {}) ⇒ Types::ListIdentitySourcesOutput
Returns a paginated list of all of the identity sources defined in the specified policy store.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2812 2813 2814 2815 |
# File 'gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/client.rb', line 2812 def list_identity_sources(params = {}, = {}) req = build_request(:list_identity_sources, params) req.send_request() end |
#list_policies(params = {}) ⇒ Types::ListPoliciesOutput
Returns a paginated list of all policies stored in the specified policy store.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3067 3068 3069 3070 |
# File 'gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/client.rb', line 3067 def list_policies(params = {}, = {}) req = build_request(:list_policies, params) req.send_request() end |
#list_policy_stores(params = {}) ⇒ Types::ListPolicyStoresOutput
Returns a paginated list of all policy stores in the calling Amazon Web Services account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3148 3149 3150 3151 |
# File 'gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/client.rb', line 3148 def list_policy_stores(params = {}, = {}) req = build_request(:list_policy_stores, params) req.send_request() end |
#list_policy_templates(params = {}) ⇒ Types::ListPolicyTemplatesOutput
Returns a paginated list of all policy templates in the specified policy store.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3239 3240 3241 3242 |
# File 'gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/client.rb', line 3239 def list_policy_templates(params = {}, = {}) req = build_request(:list_policy_templates, params) req.send_request() end |
#put_schema(params = {}) ⇒ Types::PutSchemaOutput
Creates or updates the policy schema in the specified policy store. The schema is used to validate any Cedar policies and policy templates submitted to the policy store. Any changes to the schema validate only policies and templates submitted after the schema change. Existing policies and templates are not re-evaluated against the changed schema. If you later update a policy, then it is evaluated against the new schema at that time.
3324 3325 3326 3327 |
# File 'gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/client.rb', line 3324 def put_schema(params = {}, = {}) req = build_request(:put_schema, params) req.send_request() end |
#update_identity_source(params = {}) ⇒ Types::UpdateIdentitySourceOutput
Updates the specified identity source to use a new identity provider (IdP), or to change the mapping of identities from the IdP to a different principal entity type.
3435 3436 3437 3438 |
# File 'gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/client.rb', line 3435 def update_identity_source(params = {}, = {}) req = build_request(:update_identity_source, params) req.send_request() end |
#update_policy(params = {}) ⇒ Types::UpdatePolicyOutput
Modifies a Cedar static policy in the specified policy store. You can change only certain elements of the UpdatePolicyDefinition parameter. You can directly update only static policies. To change a template-linked policy, you must update the template instead, using UpdatePolicyTemplate.
When you edit a static policy, you can change only certain elements of a static policy:
The action referenced by the policy.
A condition clause, such as when and unless. You can't change these elements of a static policy:
Changing a policy from a static policy to a template-linked policy.
Changing the effect of a static policy from permit or forbid.
The principal referenced by a static policy.
The resource referenced by a static policy.
- To update a template-linked policy, you must update the template instead.
3592 3593 3594 3595 |
# File 'gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/client.rb', line 3592 def update_policy(params = {}, = {}) req = build_request(:update_policy, params) req.send_request() end |
#update_policy_store(params = {}) ⇒ Types::UpdatePolicyStoreOutput
Modifies the validation setting for a policy store.
3666 3667 3668 3669 |
# File 'gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/client.rb', line 3666 def update_policy_store(params = {}, = {}) req = build_request(:update_policy_store, params) req.send_request() end |
#update_policy_template(params = {}) ⇒ Types::UpdatePolicyTemplateOutput
Updates the specified policy template. You can update only the description and the some elements of the policyBody.
Changes you make to the policy template content are immediately (within the constraints of eventual consistency) reflected in authorization decisions that involve all template-linked policies instantiated from this template.
3774 3775 3776 3777 |
# File 'gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/client.rb', line 3774 def update_policy_template(params = {}, = {}) req = build_request(:update_policy_template, params) req.send_request() end |