akeyless 2.15.32 → 2.16.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +13 -1
- data/docs/Auth.md +5 -1
- data/docs/AuthMethodAccessInfo.md +2 -0
- data/docs/CertAccessRules.md +34 -0
- data/docs/CreateAuthMethodCert.md +48 -0
- data/docs/CreateAuthMethodCertOutput.md +18 -0
- data/docs/CreateAuthMethodLDAP.md +3 -1
- data/docs/CreateAuthMethodOIDC.md +4 -0
- data/docs/CreateClassicKey.md +5 -1
- data/docs/GatewayCreateProducerCustom.md +4 -0
- data/docs/GatewayCreateProducerOracleDb.md +8 -0
- data/docs/GatewayMessageQueueInfo.md +1 -3
- data/docs/GatewayUpdateProducerCustom.md +4 -0
- data/docs/GatewayUpdateProducerOracleDb.md +8 -0
- data/docs/KMIPClient.md +2 -0
- data/docs/KMIPServer.md +4 -0
- data/docs/KmipDeleteServer.md +20 -0
- data/docs/KmipDescribeServerOutput.md +4 -0
- data/docs/KmipMoveServer.md +22 -0
- data/docs/KmipMoveServerOutput.md +20 -0
- data/docs/ListAuthMethods.md +3 -1
- data/docs/ListRoles.md +2 -0
- data/docs/ListTargets.md +2 -0
- data/docs/OIDCAccessRules.md +4 -0
- data/docs/UpdateAuthMethodCert.md +50 -0
- data/docs/UpdateAuthMethodCertOutput.md +18 -0
- data/docs/UpdateAuthMethodLDAP.md +3 -1
- data/docs/UpdateAuthMethodOIDC.md +4 -0
- data/docs/UpdateOutput.md +2 -0
- data/docs/V2Api.md +256 -0
- data/lib/akeyless/api/v2_api.rb +248 -0
- data/lib/akeyless/api_client.rb +3 -1
- data/lib/akeyless/models/auth.rb +22 -2
- data/lib/akeyless/models/auth_method_access_info.rb +10 -1
- data/lib/akeyless/models/cert_access_rules.rb +316 -0
- data/lib/akeyless/models/create_auth_method_cert.rb +401 -0
- data/lib/akeyless/models/create_auth_method_cert_output.rb +219 -0
- data/lib/akeyless/models/create_auth_method_ldap.rb +14 -4
- data/lib/akeyless/models/create_auth_method_oidc.rb +23 -1
- data/lib/akeyless/models/create_classic_key.rb +26 -4
- data/lib/akeyless/models/gateway_create_producer_custom.rb +23 -1
- data/lib/akeyless/models/gateway_create_producer_oracle_db.rb +39 -1
- data/lib/akeyless/models/gateway_message_queue_info.rb +4 -13
- data/lib/akeyless/models/gateway_update_producer_custom.rb +23 -1
- data/lib/akeyless/models/gateway_update_producer_oracle_db.rb +39 -1
- data/lib/akeyless/models/kmip_client.rb +10 -1
- data/lib/akeyless/models/kmip_delete_server.rb +231 -0
- data/lib/akeyless/models/kmip_describe_server_output.rb +19 -1
- data/lib/akeyless/models/kmip_move_server.rb +240 -0
- data/lib/akeyless/models/kmip_move_server_output.rb +228 -0
- data/lib/akeyless/models/kmip_server.rb +19 -1
- data/lib/akeyless/models/list_auth_methods.rb +12 -2
- data/lib/akeyless/models/list_roles.rb +11 -1
- data/lib/akeyless/models/list_targets.rb +11 -1
- data/lib/akeyless/models/oidc_access_rules.rb +23 -1
- data/lib/akeyless/models/update_auth_method_cert.rb +411 -0
- data/lib/akeyless/models/update_auth_method_cert_output.rb +219 -0
- data/lib/akeyless/models/update_auth_method_ldap.rb +14 -4
- data/lib/akeyless/models/update_auth_method_oidc.rb +23 -1
- data/lib/akeyless/models/update_output.rb +10 -1
- data/lib/akeyless/version.rb +1 -1
- data/lib/akeyless.rb +8 -0
- data/spec/models/cert_access_rules_spec.rb +82 -0
- data/spec/models/create_auth_method_cert_output_spec.rb +34 -0
- data/spec/models/create_auth_method_cert_spec.rb +124 -0
- data/spec/models/kmip_delete_server_spec.rb +40 -0
- data/spec/models/kmip_move_server_output_spec.rb +40 -0
- data/spec/models/kmip_move_server_spec.rb +46 -0
- data/spec/models/update_auth_method_cert_output_spec.rb +34 -0
- data/spec/models/update_auth_method_cert_spec.rb +130 -0
- metadata +34 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 6e0e642fffc6300372e044a44f816855d233f8eb3d3ebe363478c56574e40053
|
|
4
|
+
data.tar.gz: 29804e798df08ae2bfb39d05eda32186352c4a8a0dacf09b2589129a3766b18c
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: a63b65aa9b25cfc53cec88234a94ede154cd214737be2215eca4860caf23462c0bc0b13b560dc50fdba8f0e4478ac92989a5e1bd246d455ec467eff23deecd5d
|
|
7
|
+
data.tar.gz: 915e919d3479c8d65c68621b0d08c888727c54a7641f1a44cc392d95b28ee02b50cb95206de9fec37b9a1a7a3e1d222bb71eef74e6fe4b4443ca5af2cb2a22c9
|
data/README.md
CHANGED
|
@@ -7,7 +7,7 @@ The purpose of this application is to provide access to Akeyless API.
|
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
8
8
|
|
|
9
9
|
- API version: 2.0
|
|
10
|
-
- Package version: 2.
|
|
10
|
+
- Package version: 2.16.0
|
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
12
12
|
For more information, please visit [http://akeyless.io](http://akeyless.io)
|
|
13
13
|
|
|
@@ -68,6 +68,7 @@ Class | Method | HTTP request | Description
|
|
|
68
68
|
*Akeyless::V2Api* | [**create_auth_method**](docs/V2Api.md#create_auth_method) | **POST** /create-auth-method |
|
|
69
69
|
*Akeyless::V2Api* | [**create_auth_method_awsiam**](docs/V2Api.md#create_auth_method_awsiam) | **POST** /create-auth-method-aws-iam |
|
|
70
70
|
*Akeyless::V2Api* | [**create_auth_method_azure_ad**](docs/V2Api.md#create_auth_method_azure_ad) | **POST** /create-auth-method-azure-ad |
|
|
71
|
+
*Akeyless::V2Api* | [**create_auth_method_cert**](docs/V2Api.md#create_auth_method_cert) | **POST** /create-auth-method-cert |
|
|
71
72
|
*Akeyless::V2Api* | [**create_auth_method_gcp**](docs/V2Api.md#create_auth_method_gcp) | **POST** /create-auth-method-gcp |
|
|
72
73
|
*Akeyless::V2Api* | [**create_auth_method_huawei**](docs/V2Api.md#create_auth_method_huawei) | **POST** /create-auth-method-huawei |
|
|
73
74
|
*Akeyless::V2Api* | [**create_auth_method_k8_s**](docs/V2Api.md#create_auth_method_k8_s) | **POST** /create-auth-method-k8s |
|
|
@@ -198,9 +199,11 @@ Class | Method | HTTP request | Description
|
|
|
198
199
|
*Akeyless::V2Api* | [**kmip_client_set_rule**](docs/V2Api.md#kmip_client_set_rule) | **POST** /kmip-client-set-rule |
|
|
199
200
|
*Akeyless::V2Api* | [**kmip_create_client**](docs/V2Api.md#kmip_create_client) | **POST** /kmip-create-client |
|
|
200
201
|
*Akeyless::V2Api* | [**kmip_delete_client**](docs/V2Api.md#kmip_delete_client) | **POST** /kmip-delete-client |
|
|
202
|
+
*Akeyless::V2Api* | [**kmip_delete_server**](docs/V2Api.md#kmip_delete_server) | **DELETE** /kmip-delete-environment |
|
|
201
203
|
*Akeyless::V2Api* | [**kmip_describe_client**](docs/V2Api.md#kmip_describe_client) | **POST** /kmip-get-client |
|
|
202
204
|
*Akeyless::V2Api* | [**kmip_describe_server**](docs/V2Api.md#kmip_describe_server) | **POST** /kmip-get-environment |
|
|
203
205
|
*Akeyless::V2Api* | [**kmip_list_clients**](docs/V2Api.md#kmip_list_clients) | **POST** /kmip-list-clients |
|
|
206
|
+
*Akeyless::V2Api* | [**kmip_move_server**](docs/V2Api.md#kmip_move_server) | **POST** /kmip-move-environment |
|
|
204
207
|
*Akeyless::V2Api* | [**kmip_renew_client_certificate**](docs/V2Api.md#kmip_renew_client_certificate) | **POST** /kmip-renew-client |
|
|
205
208
|
*Akeyless::V2Api* | [**kmip_renew_server_certificate**](docs/V2Api.md#kmip_renew_server_certificate) | **POST** /kmip-renew-environment |
|
|
206
209
|
*Akeyless::V2Api* | [**kmip_server_setup**](docs/V2Api.md#kmip_server_setup) | **POST** /kmip-create-environment |
|
|
@@ -233,6 +236,7 @@ Class | Method | HTTP request | Description
|
|
|
233
236
|
*Akeyless::V2Api* | [**update_auth_method**](docs/V2Api.md#update_auth_method) | **POST** /update-auth-method |
|
|
234
237
|
*Akeyless::V2Api* | [**update_auth_method_awsiam**](docs/V2Api.md#update_auth_method_awsiam) | **POST** /update-auth-method-aws-iam |
|
|
235
238
|
*Akeyless::V2Api* | [**update_auth_method_azure_ad**](docs/V2Api.md#update_auth_method_azure_ad) | **POST** /update-auth-method-azure-ad |
|
|
239
|
+
*Akeyless::V2Api* | [**update_auth_method_cert**](docs/V2Api.md#update_auth_method_cert) | **POST** /update-auth-method-cert |
|
|
236
240
|
*Akeyless::V2Api* | [**update_auth_method_gcp**](docs/V2Api.md#update_auth_method_gcp) | **POST** /update-auth-method-gcp |
|
|
237
241
|
*Akeyless::V2Api* | [**update_auth_method_k8_s**](docs/V2Api.md#update_auth_method_k8_s) | **POST** /update-auth-method-k8s |
|
|
238
242
|
*Akeyless::V2Api* | [**update_auth_method_ldap**](docs/V2Api.md#update_auth_method_ldap) | **POST** /update-auth-method-ldap |
|
|
@@ -298,6 +302,7 @@ Class | Method | HTTP request | Description
|
|
|
298
302
|
- [Akeyless::AzurePayload](docs/AzurePayload.md)
|
|
299
303
|
- [Akeyless::CFConfigPart](docs/CFConfigPart.md)
|
|
300
304
|
- [Akeyless::CacheConfigPart](docs/CacheConfigPart.md)
|
|
305
|
+
- [Akeyless::CertAccessRules](docs/CertAccessRules.md)
|
|
301
306
|
- [Akeyless::CertificateIssueInfo](docs/CertificateIssueInfo.md)
|
|
302
307
|
- [Akeyless::ClassicKeyDetailsInfo](docs/ClassicKeyDetailsInfo.md)
|
|
303
308
|
- [Akeyless::ClassicKeyStatusInfo](docs/ClassicKeyStatusInfo.md)
|
|
@@ -317,6 +322,8 @@ Class | Method | HTTP request | Description
|
|
|
317
322
|
- [Akeyless::CreateAuthMethodAWSIAMOutput](docs/CreateAuthMethodAWSIAMOutput.md)
|
|
318
323
|
- [Akeyless::CreateAuthMethodAzureAD](docs/CreateAuthMethodAzureAD.md)
|
|
319
324
|
- [Akeyless::CreateAuthMethodAzureADOutput](docs/CreateAuthMethodAzureADOutput.md)
|
|
325
|
+
- [Akeyless::CreateAuthMethodCert](docs/CreateAuthMethodCert.md)
|
|
326
|
+
- [Akeyless::CreateAuthMethodCertOutput](docs/CreateAuthMethodCertOutput.md)
|
|
320
327
|
- [Akeyless::CreateAuthMethodGCP](docs/CreateAuthMethodGCP.md)
|
|
321
328
|
- [Akeyless::CreateAuthMethodGCPOutput](docs/CreateAuthMethodGCPOutput.md)
|
|
322
329
|
- [Akeyless::CreateAuthMethodHuawei](docs/CreateAuthMethodHuawei.md)
|
|
@@ -598,10 +605,13 @@ Class | Method | HTTP request | Description
|
|
|
598
605
|
- [Akeyless::KmipCreateClient](docs/KmipCreateClient.md)
|
|
599
606
|
- [Akeyless::KmipCreateClientOutput](docs/KmipCreateClientOutput.md)
|
|
600
607
|
- [Akeyless::KmipDeleteClient](docs/KmipDeleteClient.md)
|
|
608
|
+
- [Akeyless::KmipDeleteServer](docs/KmipDeleteServer.md)
|
|
601
609
|
- [Akeyless::KmipDescribeClient](docs/KmipDescribeClient.md)
|
|
602
610
|
- [Akeyless::KmipDescribeServer](docs/KmipDescribeServer.md)
|
|
603
611
|
- [Akeyless::KmipDescribeServerOutput](docs/KmipDescribeServerOutput.md)
|
|
604
612
|
- [Akeyless::KmipListClients](docs/KmipListClients.md)
|
|
613
|
+
- [Akeyless::KmipMoveServer](docs/KmipMoveServer.md)
|
|
614
|
+
- [Akeyless::KmipMoveServerOutput](docs/KmipMoveServerOutput.md)
|
|
605
615
|
- [Akeyless::KmipRenewClientCertificate](docs/KmipRenewClientCertificate.md)
|
|
606
616
|
- [Akeyless::KmipRenewClientCertificateOutput](docs/KmipRenewClientCertificateOutput.md)
|
|
607
617
|
- [Akeyless::KmipRenewServerCertificate](docs/KmipRenewServerCertificate.md)
|
|
@@ -708,6 +718,8 @@ Class | Method | HTTP request | Description
|
|
|
708
718
|
- [Akeyless::UpdateAuthMethod](docs/UpdateAuthMethod.md)
|
|
709
719
|
- [Akeyless::UpdateAuthMethodAWSIAM](docs/UpdateAuthMethodAWSIAM.md)
|
|
710
720
|
- [Akeyless::UpdateAuthMethodAzureAD](docs/UpdateAuthMethodAzureAD.md)
|
|
721
|
+
- [Akeyless::UpdateAuthMethodCert](docs/UpdateAuthMethodCert.md)
|
|
722
|
+
- [Akeyless::UpdateAuthMethodCertOutput](docs/UpdateAuthMethodCertOutput.md)
|
|
711
723
|
- [Akeyless::UpdateAuthMethodGCP](docs/UpdateAuthMethodGCP.md)
|
|
712
724
|
- [Akeyless::UpdateAuthMethodK8S](docs/UpdateAuthMethodK8S.md)
|
|
713
725
|
- [Akeyless::UpdateAuthMethodK8SOutput](docs/UpdateAuthMethodK8SOutput.md)
|
data/docs/Auth.md
CHANGED
|
@@ -6,15 +6,17 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **access_id** | **String** | Access ID | [optional] |
|
|
8
8
|
| **access_key** | **String** | Access key (relevant only for access-type=access_key) | [optional] |
|
|
9
|
-
| **access_type** | **String** | Access Type (access_key/password/saml/ldap/k8s/azure_ad/oidc/aws_iam/universal_identity/jwt/gcp/
|
|
9
|
+
| **access_type** | **String** | Access Type (access_key/password/saml/ldap/k8s/azure_ad/oidc/aws_iam/universal_identity/jwt/gcp/cert) | [optional][default to 'access_key'] |
|
|
10
10
|
| **admin_email** | **String** | Email (relevant only for access-type=password) | [optional] |
|
|
11
11
|
| **admin_password** | **String** | Password (relevant only for access-type=password) | [optional] |
|
|
12
|
+
| **cert_data** | **String** | Certificate data encoded in base64. Used if file was not provided. (relevant only for access-type=cert) | [optional] |
|
|
12
13
|
| **cloud_id** | **String** | The cloud identity (relevant only for access-type=azure_ad,aws_iam,gcp) | [optional] |
|
|
13
14
|
| **debug** | **Boolean** | | [optional] |
|
|
14
15
|
| **gcp_audience** | **String** | GCP JWT audience | [optional] |
|
|
15
16
|
| **jwt** | **String** | The Json Web Token (relevant only for access-type=jwt/oidc) | [optional] |
|
|
16
17
|
| **k8s_auth_config_name** | **String** | The K8S Auth config name (relevant only for access-type=k8s) | [optional] |
|
|
17
18
|
| **k8s_service_account_token** | **String** | The K8S service account token. (relevant only for access-type=k8s) | [optional] |
|
|
19
|
+
| **key_data** | **String** | Private key data encoded in base64. Used if file was not provided.(relevant only for access-type=cert) | [optional] |
|
|
18
20
|
| **ldap_password** | **String** | LDAP password (relevant only for access-type=ldap) | [optional] |
|
|
19
21
|
| **ldap_username** | **String** | LDAP username (relevant only for access-type=ldap) | [optional] |
|
|
20
22
|
| **uid_token** | **String** | The universal_identity token (relevant only for access-type=universal_identity) | [optional] |
|
|
@@ -30,12 +32,14 @@ instance = Akeyless::Auth.new(
|
|
|
30
32
|
access_type: null,
|
|
31
33
|
admin_email: null,
|
|
32
34
|
admin_password: null,
|
|
35
|
+
cert_data: null,
|
|
33
36
|
cloud_id: null,
|
|
34
37
|
debug: null,
|
|
35
38
|
gcp_audience: null,
|
|
36
39
|
jwt: null,
|
|
37
40
|
k8s_auth_config_name: null,
|
|
38
41
|
k8s_service_account_token: null,
|
|
42
|
+
key_data: null,
|
|
39
43
|
ldap_password: null,
|
|
40
44
|
ldap_username: null,
|
|
41
45
|
uid_token: null
|
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
| **api_key_access_rules** | [**APIKeyAccessRules**](APIKeyAccessRules.md) | | [optional] |
|
|
10
10
|
| **aws_iam_access_rules** | [**AWSIAMAccessRules**](AWSIAMAccessRules.md) | | [optional] |
|
|
11
11
|
| **azure_ad_access_rules** | [**AzureADAccessRules**](AzureADAccessRules.md) | | [optional] |
|
|
12
|
+
| **cert_access_rules** | [**CertAccessRules**](CertAccessRules.md) | | [optional] |
|
|
12
13
|
| **cidr_whitelist** | **String** | | [optional] |
|
|
13
14
|
| **email_pass_access_rules** | [**EmailPassAccessRules**](EmailPassAccessRules.md) | | [optional] |
|
|
14
15
|
| **force_sub_claims** | **Boolean** | if true the role associated with this auth method must include sub claims | [optional] |
|
|
@@ -34,6 +35,7 @@ instance = Akeyless::AuthMethodAccessInfo.new(
|
|
|
34
35
|
api_key_access_rules: null,
|
|
35
36
|
aws_iam_access_rules: null,
|
|
36
37
|
azure_ad_access_rules: null,
|
|
38
|
+
cert_access_rules: null,
|
|
37
39
|
cidr_whitelist: null,
|
|
38
40
|
email_pass_access_rules: null,
|
|
39
41
|
force_sub_claims: null,
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# Akeyless::CertAccessRules
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **bound_common_names** | **Array<String>** | A list of names. At least one must exist in the Common Name. Supports globbing. | [optional] |
|
|
8
|
+
| **bound_dns_sans** | **Array<String>** | A list of DNS names. At least one must exist in the SANs. Supports globbing. | [optional] |
|
|
9
|
+
| **bound_email_sans** | **Array<String>** | A list of Email Addresses. At least one must exist in the SANs. Supports globbing. | [optional] |
|
|
10
|
+
| **bound_extensions** | **Array<String>** | A list of extensions formatted as \"oid:value\". Expects the extension value to be some type of ASN1 encoded string. All values must match. Supports globbing on \"value\". | [optional] |
|
|
11
|
+
| **bound_organizational_units** | **Array<String>** | A list of Organizational Units names. At least one must exist in the OU field. | [optional] |
|
|
12
|
+
| **bound_uri_sans** | **Array<String>** | A list of URIs. At least one must exist in the SANs. Supports globbing. | [optional] |
|
|
13
|
+
| **certificate** | **Array<Integer>** | Base64 encdoed PEM certificate | [optional] |
|
|
14
|
+
| **revoked_cert_ids** | **Array<String>** | A list of revoked cert ids | [optional] |
|
|
15
|
+
| **unique_identifier** | **String** | A unique identifier to distinguish different users | [optional] |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```ruby
|
|
20
|
+
require 'akeyless'
|
|
21
|
+
|
|
22
|
+
instance = Akeyless::CertAccessRules.new(
|
|
23
|
+
bound_common_names: null,
|
|
24
|
+
bound_dns_sans: null,
|
|
25
|
+
bound_email_sans: null,
|
|
26
|
+
bound_extensions: null,
|
|
27
|
+
bound_organizational_units: null,
|
|
28
|
+
bound_uri_sans: null,
|
|
29
|
+
certificate: null,
|
|
30
|
+
revoked_cert_ids: null,
|
|
31
|
+
unique_identifier: null
|
|
32
|
+
)
|
|
33
|
+
```
|
|
34
|
+
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
# Akeyless::CreateAuthMethodCert
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **access_expires** | **Integer** | Access expiration date in Unix timestamp (select 0 for access without expiry date) | [optional][default to 0] |
|
|
8
|
+
| **bound_common_names** | **Array<String>** | A list of names. At least one must exist in the Common Name. Supports globbing. | [optional] |
|
|
9
|
+
| **bound_dns_sans** | **Array<String>** | A list of DNS names. At least one must exist in the SANs. Supports globbing. | [optional] |
|
|
10
|
+
| **bound_email_sans** | **Array<String>** | A list of Email Addresses. At least one must exist in the SANs. Supports globbing. | [optional] |
|
|
11
|
+
| **bound_extensions** | **Array<String>** | A list of extensions formatted as \"oid:value\". Expects the extension value to be some type of ASN1 encoded string. All values much match. Supports globbing on \"value\". | [optional] |
|
|
12
|
+
| **bound_ips** | **Array<String>** | A CIDR whitelist with the IPs that the access is restricted to | [optional] |
|
|
13
|
+
| **bound_organizational_units** | **Array<String>** | A list of Organizational Units names. At least one must exist in the OU field. | [optional] |
|
|
14
|
+
| **bound_uri_sans** | **Array<String>** | A list of URIs. At least one must exist in the SANs. Supports globbing. | [optional] |
|
|
15
|
+
| **certificate_data** | **String** | The certificate data in base64, if no file was provided | [optional] |
|
|
16
|
+
| **force_sub_claims** | **Boolean** | if true: enforce role-association must include sub claims | [optional] |
|
|
17
|
+
| **jwt_ttl** | **Integer** | Jwt TTL | [optional][default to 0] |
|
|
18
|
+
| **name** | **String** | Auth Method name | |
|
|
19
|
+
| **revoked_cert_ids** | **Array<String>** | A list of revoked cert ids | [optional] |
|
|
20
|
+
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
21
|
+
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
22
|
+
| **unique_identifier** | **String** | A unique identifier (ID) value should be configured, such as common_name or organizational_unit Whenever a user logs in with a token, these authentication types issue a \"sub claim\" that contains details uniquely identifying that user. This sub claim includes a key containing the ID value that you configured, and is used to distinguish between different users from within the same organization. | |
|
|
23
|
+
|
|
24
|
+
## Example
|
|
25
|
+
|
|
26
|
+
```ruby
|
|
27
|
+
require 'akeyless'
|
|
28
|
+
|
|
29
|
+
instance = Akeyless::CreateAuthMethodCert.new(
|
|
30
|
+
access_expires: null,
|
|
31
|
+
bound_common_names: null,
|
|
32
|
+
bound_dns_sans: null,
|
|
33
|
+
bound_email_sans: null,
|
|
34
|
+
bound_extensions: null,
|
|
35
|
+
bound_ips: null,
|
|
36
|
+
bound_organizational_units: null,
|
|
37
|
+
bound_uri_sans: null,
|
|
38
|
+
certificate_data: null,
|
|
39
|
+
force_sub_claims: null,
|
|
40
|
+
jwt_ttl: null,
|
|
41
|
+
name: null,
|
|
42
|
+
revoked_cert_ids: null,
|
|
43
|
+
token: null,
|
|
44
|
+
uid_token: null,
|
|
45
|
+
unique_identifier: null
|
|
46
|
+
)
|
|
47
|
+
```
|
|
48
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Akeyless::CreateAuthMethodCertOutput
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **access_id** | **String** | | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'akeyless'
|
|
13
|
+
|
|
14
|
+
instance = Akeyless::CreateAuthMethodCertOutput.new(
|
|
15
|
+
access_id: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -12,6 +12,7 @@
|
|
|
12
12
|
| **public_key_data** | **String** | A public key generated for LDAP authentication method on Akeyless in base64 format [RSA2048] | [optional] |
|
|
13
13
|
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
14
14
|
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
15
|
+
| **unique_identifier** | **String** | A unique identifier (ID) value should be configured for OAuth2, LDAP and SAML authentication method types and is usually a value such as the email, username, or upn for example. Whenever a user logs in with a token, these authentication types issue a \"sub claim\" that contains details uniquely identifying that user. This sub claim includes a key containing the ID value that you configured, and is used to distinguish between different users from within the same organization. | [optional] |
|
|
15
16
|
|
|
16
17
|
## Example
|
|
17
18
|
|
|
@@ -26,7 +27,8 @@ instance = Akeyless::CreateAuthMethodLDAP.new(
|
|
|
26
27
|
name: null,
|
|
27
28
|
public_key_data: null,
|
|
28
29
|
token: null,
|
|
29
|
-
uid_token: null
|
|
30
|
+
uid_token: null,
|
|
31
|
+
unique_identifier: null
|
|
30
32
|
)
|
|
31
33
|
```
|
|
32
34
|
|
|
@@ -13,6 +13,8 @@
|
|
|
13
13
|
| **issuer** | **String** | Issuer URL | [optional] |
|
|
14
14
|
| **jwt_ttl** | **Integer** | Jwt TTL | [optional][default to 0] |
|
|
15
15
|
| **name** | **String** | Auth Method name | |
|
|
16
|
+
| **required_scopes** | **Array<String>** | RequiredScopes is a list of required scopes that the oidc method will request from the oidc provider and the user must approve | [optional] |
|
|
17
|
+
| **required_scopes_prefix** | **String** | RequiredScopesPrefix is a a prefix to add to all required-scopes when requesting them from the oidc server (for example, azures' Application ID URI) | [optional] |
|
|
16
18
|
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
17
19
|
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
18
20
|
| **unique_identifier** | **String** | A unique identifier (ID) value should be configured for OIDC, OAuth2, LDAP and SAML authentication method types and is usually a value such as the email, username, or upn for example. Whenever a user logs in with a token, these authentication types issue a \"sub claim\" that contains details uniquely identifying that user. This sub claim includes a key containing the ID value that you configured, and is used to distinguish between different users from within the same organization. | |
|
|
@@ -32,6 +34,8 @@ instance = Akeyless::CreateAuthMethodOIDC.new(
|
|
|
32
34
|
issuer: null,
|
|
33
35
|
jwt_ttl: null,
|
|
34
36
|
name: null,
|
|
37
|
+
required_scopes: null,
|
|
38
|
+
required_scopes_prefix: null,
|
|
35
39
|
token: null,
|
|
36
40
|
uid_token: null,
|
|
37
41
|
unique_identifier: null
|
data/docs/CreateClassicKey.md
CHANGED
|
@@ -7,6 +7,7 @@
|
|
|
7
7
|
| **alg** | **String** | Classic Key type; options: [AES128GCM, AES256GCM, AES128SIV, AES256SIV, RSA1024, RSA2048, RSA3072, RSA4096, EC256, EC384] | |
|
|
8
8
|
| **cert_file_data** | **String** | Certificate in a PEM format. | [optional] |
|
|
9
9
|
| **key_data** | **String** | Base64-encoded classic key value | [optional] |
|
|
10
|
+
| **key_operations** | **Array<String>** | A list of allowed operations for the key (required for azure targets) | [optional] |
|
|
10
11
|
| **metadata** | **String** | Metadata about the classic key | [optional] |
|
|
11
12
|
| **name** | **String** | ClassicKey name | |
|
|
12
13
|
| **protection_key_name** | **String** | The name of a key that used to encrypt the secret value (if empty, the account default protectionKey key will be used) | [optional] |
|
|
@@ -14,6 +15,7 @@
|
|
|
14
15
|
| **target_name** | **String** | Target name | [optional] |
|
|
15
16
|
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
16
17
|
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
18
|
+
| **vault_name** | **String** | Name of the vault used (required for azure targets) | [optional] |
|
|
17
19
|
|
|
18
20
|
## Example
|
|
19
21
|
|
|
@@ -24,13 +26,15 @@ instance = Akeyless::CreateClassicKey.new(
|
|
|
24
26
|
alg: null,
|
|
25
27
|
cert_file_data: null,
|
|
26
28
|
key_data: null,
|
|
29
|
+
key_operations: null,
|
|
27
30
|
metadata: null,
|
|
28
31
|
name: null,
|
|
29
32
|
protection_key_name: null,
|
|
30
33
|
tags: null,
|
|
31
34
|
target_name: null,
|
|
32
35
|
token: null,
|
|
33
|
-
uid_token: null
|
|
36
|
+
uid_token: null,
|
|
37
|
+
vault_name: null
|
|
34
38
|
)
|
|
35
39
|
```
|
|
36
40
|
|
|
@@ -4,7 +4,9 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **admin_rotation_interval_days** | **Integer** | Define rotation interval in days | [optional] |
|
|
7
8
|
| **create_sync_url** | **String** | URL of an endpoint that implements /sync/create method, for example https://webhook.example.com/sync/create | |
|
|
9
|
+
| **enable_admin_rotation** | **Boolean** | Should admin credentials be rotated | [optional][default to false] |
|
|
8
10
|
| **name** | **String** | Producer name | |
|
|
9
11
|
| **payload** | **String** | Secret payload to be sent with each create/revoke webhook request | [optional] |
|
|
10
12
|
| **producer_encryption_key_name** | **String** | Dynamic producer encryption key | [optional] |
|
|
@@ -22,7 +24,9 @@
|
|
|
22
24
|
require 'akeyless'
|
|
23
25
|
|
|
24
26
|
instance = Akeyless::GatewayCreateProducerCustom.new(
|
|
27
|
+
admin_rotation_interval_days: null,
|
|
25
28
|
create_sync_url: null,
|
|
29
|
+
enable_admin_rotation: null,
|
|
26
30
|
name: null,
|
|
27
31
|
payload: null,
|
|
28
32
|
producer_encryption_key_name: null,
|
|
@@ -14,6 +14,10 @@
|
|
|
14
14
|
| **oracle_service_name** | **String** | Oracle DB Name | [optional] |
|
|
15
15
|
| **oracle_username** | **String** | Oracle Username | [optional] |
|
|
16
16
|
| **producer_encryption_key_name** | **String** | Dynamic producer encryption key | [optional] |
|
|
17
|
+
| **secure_access_bastion_issuer** | **String** | | [optional] |
|
|
18
|
+
| **secure_access_enable** | **String** | | [optional] |
|
|
19
|
+
| **secure_access_host** | **Array<String>** | | [optional] |
|
|
20
|
+
| **secure_access_web** | **Boolean** | | [optional] |
|
|
17
21
|
| **tags** | **Array<String>** | List of the tags attached to this secret | [optional] |
|
|
18
22
|
| **target_name** | **String** | Target name | [optional] |
|
|
19
23
|
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
@@ -36,6 +40,10 @@ instance = Akeyless::GatewayCreateProducerOracleDb.new(
|
|
|
36
40
|
oracle_service_name: null,
|
|
37
41
|
oracle_username: null,
|
|
38
42
|
producer_encryption_key_name: null,
|
|
43
|
+
secure_access_bastion_issuer: null,
|
|
44
|
+
secure_access_enable: null,
|
|
45
|
+
secure_access_host: null,
|
|
46
|
+
secure_access_web: null,
|
|
39
47
|
tags: null,
|
|
40
48
|
target_name: null,
|
|
41
49
|
token: null,
|
|
@@ -7,7 +7,6 @@
|
|
|
7
7
|
| **mq_type** | **String** | | [optional] |
|
|
8
8
|
| **queue_name** | **String** | | [optional] |
|
|
9
9
|
| **queue_url** | **String** | | [optional] |
|
|
10
|
-
| **use_new_queue** | **Boolean** | | [optional] |
|
|
11
10
|
|
|
12
11
|
## Example
|
|
13
12
|
|
|
@@ -17,8 +16,7 @@ require 'akeyless'
|
|
|
17
16
|
instance = Akeyless::GatewayMessageQueueInfo.new(
|
|
18
17
|
mq_type: null,
|
|
19
18
|
queue_name: null,
|
|
20
|
-
queue_url: null
|
|
21
|
-
use_new_queue: null
|
|
19
|
+
queue_url: null
|
|
22
20
|
)
|
|
23
21
|
```
|
|
24
22
|
|
|
@@ -4,7 +4,9 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **admin_rotation_interval_days** | **Integer** | Define rotation interval in days | [optional] |
|
|
7
8
|
| **create_sync_url** | **String** | URL of an endpoint that implements /sync/create method, for example https://webhook.example.com/sync/create | |
|
|
9
|
+
| **enable_admin_rotation** | **Boolean** | Should admin credentials be rotated | [optional][default to false] |
|
|
8
10
|
| **name** | **String** | Producer name | |
|
|
9
11
|
| **new_name** | **String** | Producer name | [optional] |
|
|
10
12
|
| **payload** | **String** | Secret payload to be sent with each create/revoke webhook request | [optional] |
|
|
@@ -23,7 +25,9 @@
|
|
|
23
25
|
require 'akeyless'
|
|
24
26
|
|
|
25
27
|
instance = Akeyless::GatewayUpdateProducerCustom.new(
|
|
28
|
+
admin_rotation_interval_days: null,
|
|
26
29
|
create_sync_url: null,
|
|
30
|
+
enable_admin_rotation: null,
|
|
27
31
|
name: null,
|
|
28
32
|
new_name: null,
|
|
29
33
|
payload: null,
|
|
@@ -15,6 +15,10 @@
|
|
|
15
15
|
| **oracle_service_name** | **String** | Oracle DB Name | [optional] |
|
|
16
16
|
| **oracle_username** | **String** | Oracle Username | [optional] |
|
|
17
17
|
| **producer_encryption_key_name** | **String** | Dynamic producer encryption key | [optional] |
|
|
18
|
+
| **secure_access_bastion_issuer** | **String** | | [optional] |
|
|
19
|
+
| **secure_access_enable** | **String** | | [optional] |
|
|
20
|
+
| **secure_access_host** | **Array<String>** | | [optional] |
|
|
21
|
+
| **secure_access_web** | **Boolean** | | [optional] |
|
|
18
22
|
| **tags** | **Array<String>** | List of the tags attached to this secret | [optional] |
|
|
19
23
|
| **target_name** | **String** | Target name | [optional] |
|
|
20
24
|
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
@@ -38,6 +42,10 @@ instance = Akeyless::GatewayUpdateProducerOracleDb.new(
|
|
|
38
42
|
oracle_service_name: null,
|
|
39
43
|
oracle_username: null,
|
|
40
44
|
producer_encryption_key_name: null,
|
|
45
|
+
secure_access_bastion_issuer: null,
|
|
46
|
+
secure_access_enable: null,
|
|
47
|
+
secure_access_host: null,
|
|
48
|
+
secure_access_web: null,
|
|
41
49
|
tags: null,
|
|
42
50
|
target_name: null,
|
|
43
51
|
token: null,
|
data/docs/KMIPClient.md
CHANGED
|
@@ -5,6 +5,7 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **certificate_issue_date** | **Time** | | [optional] |
|
|
8
|
+
| **certificate_ttl_in_seconds** | **Integer** | | [optional] |
|
|
8
9
|
| **id** | **String** | | [optional] |
|
|
9
10
|
| **name** | **String** | | [optional] |
|
|
10
11
|
| **rules** | [**Array<PathRule>**](PathRule.md) | | [optional] |
|
|
@@ -16,6 +17,7 @@ require 'akeyless'
|
|
|
16
17
|
|
|
17
18
|
instance = Akeyless::KMIPClient.new(
|
|
18
19
|
certificate_issue_date: null,
|
|
20
|
+
certificate_ttl_in_seconds: null,
|
|
19
21
|
id: null,
|
|
20
22
|
name: null,
|
|
21
23
|
rules: null
|
data/docs/KMIPServer.md
CHANGED
|
@@ -7,6 +7,8 @@
|
|
|
7
7
|
| **active** | **Boolean** | | [optional] |
|
|
8
8
|
| **ca** | **Array<Integer>** | | [optional] |
|
|
9
9
|
| **certificate** | **Array<Integer>** | | [optional] |
|
|
10
|
+
| **certificate_issue_date** | **Time** | | [optional] |
|
|
11
|
+
| **certificate_ttl_in_seconds** | **Integer** | | [optional] |
|
|
10
12
|
| **hostname** | **String** | | [optional] |
|
|
11
13
|
| **root** | **String** | | [optional] |
|
|
12
14
|
|
|
@@ -19,6 +21,8 @@ instance = Akeyless::KMIPServer.new(
|
|
|
19
21
|
active: null,
|
|
20
22
|
ca: null,
|
|
21
23
|
certificate: null,
|
|
24
|
+
certificate_issue_date: null,
|
|
25
|
+
certificate_ttl_in_seconds: null,
|
|
22
26
|
hostname: null,
|
|
23
27
|
root: null
|
|
24
28
|
)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Akeyless::KmipDeleteServer
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
8
|
+
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'akeyless'
|
|
14
|
+
|
|
15
|
+
instance = Akeyless::KmipDeleteServer.new(
|
|
16
|
+
token: null,
|
|
17
|
+
uid_token: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -6,6 +6,8 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **active** | **Boolean** | | [optional] |
|
|
8
8
|
| **ca_cert** | **Array<Integer>** | | [optional] |
|
|
9
|
+
| **certificate_issue_date** | **Time** | | [optional] |
|
|
10
|
+
| **certificate_ttl_in_seconds** | **Integer** | | [optional] |
|
|
9
11
|
| **hostname** | **String** | | [optional] |
|
|
10
12
|
| **root** | **String** | | [optional] |
|
|
11
13
|
|
|
@@ -17,6 +19,8 @@ require 'akeyless'
|
|
|
17
19
|
instance = Akeyless::KmipDescribeServerOutput.new(
|
|
18
20
|
active: null,
|
|
19
21
|
ca_cert: null,
|
|
22
|
+
certificate_issue_date: null,
|
|
23
|
+
certificate_ttl_in_seconds: null,
|
|
20
24
|
hostname: null,
|
|
21
25
|
root: null
|
|
22
26
|
)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Akeyless::KmipMoveServer
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **new_root** | **String** | | [optional] |
|
|
8
|
+
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
9
|
+
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'akeyless'
|
|
15
|
+
|
|
16
|
+
instance = Akeyless::KmipMoveServer.new(
|
|
17
|
+
new_root: null,
|
|
18
|
+
token: null,
|
|
19
|
+
uid_token: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Akeyless::KmipMoveServerOutput
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **new_root** | **String** | | [optional] |
|
|
8
|
+
| **old_root** | **String** | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'akeyless'
|
|
14
|
+
|
|
15
|
+
instance = Akeyless::KmipMoveServerOutput.new(
|
|
16
|
+
new_root: null,
|
|
17
|
+
old_root: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
data/docs/ListAuthMethods.md
CHANGED
|
@@ -4,9 +4,10 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **filter** | **String** | Filter by auth method name or part of it | [optional] |
|
|
7
8
|
| **pagination_token** | **String** | Next page reference | [optional] |
|
|
8
9
|
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
9
|
-
| **type** | **Array<String>** | The Auth method types list of the requested method. In case it is empty, all types of auth methods will be returned. options: [api_key, azure_ad, oauth2/jwt, saml2, ldap, aws_iam, oidc, universal_identity, gcp, k8s] | [optional] |
|
|
10
|
+
| **type** | **Array<String>** | The Auth method types list of the requested method. In case it is empty, all types of auth methods will be returned. options: [api_key, azure_ad, oauth2/jwt, saml2, ldap, aws_iam, oidc, universal_identity, gcp, k8s, cert] | [optional] |
|
|
10
11
|
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
11
12
|
|
|
12
13
|
## Example
|
|
@@ -15,6 +16,7 @@
|
|
|
15
16
|
require 'akeyless'
|
|
16
17
|
|
|
17
18
|
instance = Akeyless::ListAuthMethods.new(
|
|
19
|
+
filter: null,
|
|
18
20
|
pagination_token: null,
|
|
19
21
|
token: null,
|
|
20
22
|
type: null,
|
data/docs/ListRoles.md
CHANGED
|
@@ -4,6 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **filter** | **String** | Filter by item name or part of it | [optional] |
|
|
7
8
|
| **pagination_token** | **String** | Next page reference | [optional] |
|
|
8
9
|
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
9
10
|
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
@@ -14,6 +15,7 @@
|
|
|
14
15
|
require 'akeyless'
|
|
15
16
|
|
|
16
17
|
instance = Akeyless::ListRoles.new(
|
|
18
|
+
filter: null,
|
|
17
19
|
pagination_token: null,
|
|
18
20
|
token: null,
|
|
19
21
|
uid_token: null
|
data/docs/ListTargets.md
CHANGED
|
@@ -4,6 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **filter** | **String** | Filter by auth method name or part of it | [optional] |
|
|
7
8
|
| **pagination_token** | **String** | Next page reference | [optional] |
|
|
8
9
|
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
9
10
|
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
@@ -14,6 +15,7 @@
|
|
|
14
15
|
require 'akeyless'
|
|
15
16
|
|
|
16
17
|
instance = Akeyless::ListTargets.new(
|
|
18
|
+
filter: null,
|
|
17
19
|
pagination_token: null,
|
|
18
20
|
token: null,
|
|
19
21
|
uid_token: null
|
data/docs/OIDCAccessRules.md
CHANGED
|
@@ -10,6 +10,8 @@
|
|
|
10
10
|
| **client_secret** | **String** | Client Secret | [optional] |
|
|
11
11
|
| **is_internal** | **Boolean** | IsInternal indicates whether this is an internal Auth Method where the client has no control over it, or it was created by the client e.g - Sign In with Google will create an OIDC Auth Method with IsInternal=true | [optional] |
|
|
12
12
|
| **issuer** | **String** | Issuer URL | [optional] |
|
|
13
|
+
| **required_scopes** | **Array<String>** | A list of required scopes to request from the oidc provider, and to check on the token | [optional] |
|
|
14
|
+
| **required_scopes_prefix** | **String** | A prefix to add to the required scopes (for example, azures' Application ID URI) | [optional] |
|
|
13
15
|
| **unique_identifier** | **String** | A unique identifier to distinguish different users | [optional] |
|
|
14
16
|
|
|
15
17
|
## Example
|
|
@@ -24,6 +26,8 @@ instance = Akeyless::OIDCAccessRules.new(
|
|
|
24
26
|
client_secret: null,
|
|
25
27
|
is_internal: null,
|
|
26
28
|
issuer: null,
|
|
29
|
+
required_scopes: null,
|
|
30
|
+
required_scopes_prefix: null,
|
|
27
31
|
unique_identifier: null
|
|
28
32
|
)
|
|
29
33
|
```
|