diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index 2b8bf0c..d8c0b9e 100644 --- a/.openapi-generator/FILES +++ b/.openapi-generator/FILES @@ -13,7 +13,6 @@ api_dynamic_client_registration.go api_federation_endpoint.go api_grant_management_endpoint.go api_hsk_operations.go -api_id_token_endpoint.go api_introspection_endpoint.go api_jose_object.go api_jwk_set_endpoint.go @@ -24,6 +23,7 @@ api_service_management.go api_token_endpoint.go api_token_operations.go api_user_info_endpoint.go +api_vci_endpoint.go client.go configuration.go docs/AccessToken.md @@ -38,6 +38,10 @@ docs/AuthorizationIssueRequest.md docs/AuthorizationIssueResponse.md docs/AuthorizationRequest.md docs/AuthorizationResponse.md +docs/AuthorizationTicketInfoRequest.md +docs/AuthorizationTicketInfoResponse.md +docs/AuthorizationTicketUpdateRequest.md +docs/AuthorizationTicketUpdateResponse.md docs/AuthzDetails.md docs/BackchannelAuthenticationCompleteRequest.md docs/BackchannelAuthenticationCompleteResponse.md @@ -63,14 +67,15 @@ docs/ClientExtensionRequestableScopesUpdateRequest.md docs/ClientExtensionRequestableScopesUpdateResponse.md docs/ClientFlagUpdateRequest.md docs/ClientFlagUpdateResponse.md +docs/ClientGetListApi200Response.md +docs/ClientGetListLimitedResponse.md docs/ClientGetListResponse.md docs/ClientGrantedScopesDeleteResponse.md -docs/ClientGrantedScopesGetResponse.md +docs/ClientLimited.md +docs/ClientLimitedAuthorization.md docs/ClientManagementApi.md docs/ClientRegistrationDeleteRequest.md docs/ClientRegistrationDeleteResponse.md -docs/ClientRegistrationGetRequest.md -docs/ClientRegistrationGetResponse.md docs/ClientRegistrationRequest.md docs/ClientRegistrationResponse.md docs/ClientRegistrationType.md @@ -81,6 +86,10 @@ docs/ClientSecretUpdateRequest.md docs/ClientSecretUpdateResponse.md docs/ClientType.md docs/ConfigurationEndpointApi.md +docs/CredentialIssuanceOrder.md +docs/CredentialIssuerMetadata.md +docs/CredentialOfferInfo.md +docs/CredentialRequestInfo.md docs/DefaultApi.md docs/DeliveryMode.md docs/DeviceAuthorizationRequest.md @@ -93,6 +102,7 @@ docs/DeviceVerificationResponse.md docs/Display.md docs/DynamicClientRegistrationApi.md docs/DynamicScope.md +docs/FapiMode.md docs/FederationConfigurationResponse.md docs/FederationEndpointApi.md docs/FederationRegistrationRequest.md @@ -111,7 +121,6 @@ docs/HskDeleteResponse.md docs/HskGetListResponse.md docs/HskGetResponse.md docs/HskOperationsApi.md -docs/IDTokenEndpointApi.md docs/IdtokenReissueRequest.md docs/IdtokenReissueResponse.md docs/InfoResponse.md @@ -140,8 +149,12 @@ docs/RevocationResponse.md docs/Scope.md docs/ServerMetadataApi.md docs/Service.md +docs/ServiceGetApi200Response.md +docs/ServiceGetListApi200Response.md +docs/ServiceGetListLimitedResponse.md docs/ServiceGetListResponse.md docs/ServiceJwksGetResponse.md +docs/ServiceLimited.md docs/ServiceManagementApi.md docs/ServiceProfile.md docs/Sns.md @@ -150,6 +163,11 @@ docs/StandardIntrospectionRequest.md docs/StandardIntrospectionResponse.md docs/SubjectType.md docs/TaggedValue.md +docs/TokenBatchStatus.md +docs/TokenBatchStatusResult.md +docs/TokenCreateBatchRequestInner.md +docs/TokenCreateBatchResponse.md +docs/TokenCreateBatchStatusResponse.md docs/TokenCreateRequest.md docs/TokenCreateResponse.md docs/TokenEndpointApi.md @@ -174,6 +192,29 @@ docs/UserinfoIssueRequest.md docs/UserinfoIssueResponse.md docs/UserinfoRequest.md docs/UserinfoResponse.md +docs/VciBatchIssueRequest.md +docs/VciBatchIssueResponse.md +docs/VciBatchParseRequest.md +docs/VciBatchParseResponse.md +docs/VciDeferredIssueRequest.md +docs/VciDeferredIssueResponse.md +docs/VciDeferredParseRequest.md +docs/VciDeferredParseResponse.md +docs/VciEndpointApi.md +docs/VciJwksRequest.md +docs/VciJwksResponse.md +docs/VciJwtissuerRequest.md +docs/VciJwtissuerResponse.md +docs/VciMetadataRequest.md +docs/VciMetadataResponse.md +docs/VciOfferCreateRequest.md +docs/VciOfferCreateResponse.md +docs/VciOfferInfoRequest.md +docs/VciOfferInfoResponse.md +docs/VciSingleIssueRequest.md +docs/VciSingleIssueResponse.md +docs/VciSingleParseRequest.md +docs/VciSingleParseResponse.md docs/VerifiedClaimsValidationSchema.md git_push.sh go.mod @@ -189,6 +230,10 @@ model_authorization_issue_request.go model_authorization_issue_response.go model_authorization_request.go model_authorization_response.go +model_authorization_ticket_info_request.go +model_authorization_ticket_info_response.go +model_authorization_ticket_update_request.go +model_authorization_ticket_update_response.go model_authz_details.go model_backchannel_authentication_complete_request.go model_backchannel_authentication_complete_response.go @@ -212,13 +257,14 @@ model_client_extension_requestable_scopes_update_request.go model_client_extension_requestable_scopes_update_response.go model_client_flag_update_request.go model_client_flag_update_response.go +model_client_get_list_api_200_response.go +model_client_get_list_limited_response.go model_client_get_list_response.go model_client_granted_scopes_delete_response.go -model_client_granted_scopes_get_response.go +model_client_limited.go +model_client_limited_authorization.go model_client_registration_delete_request.go model_client_registration_delete_response.go -model_client_registration_get_request.go -model_client_registration_get_response.go model_client_registration_request.go model_client_registration_response.go model_client_registration_type.go @@ -228,6 +274,10 @@ model_client_secret_refresh_response.go model_client_secret_update_request.go model_client_secret_update_response.go model_client_type.go +model_credential_issuance_order.go +model_credential_issuer_metadata.go +model_credential_offer_info.go +model_credential_request_info.go model_delivery_mode.go model_device_authorization_request.go model_device_authorization_response.go @@ -237,6 +287,7 @@ model_device_verification_request.go model_device_verification_response.go model_display.go model_dynamic_scope.go +model_fapi_mode.go model_federation_configuration_response.go model_federation_registration_request.go model_federation_registration_response.go @@ -274,8 +325,12 @@ model_revocation_request.go model_revocation_response.go model_scope.go model_service.go +model_service_get_api_200_response.go +model_service_get_list_api_200_response.go +model_service_get_list_limited_response.go model_service_get_list_response.go model_service_jwks_get_response.go +model_service_limited.go model_service_profile.go model_sns.go model_sns_credentials.go @@ -283,6 +338,11 @@ model_standard_introspection_request.go model_standard_introspection_response.go model_subject_type.go model_tagged_value.go +model_token_batch_status.go +model_token_batch_status_result.go +model_token_create_batch_request_inner.go +model_token_create_batch_response.go +model_token_create_batch_status_response.go model_token_create_request.go model_token_create_response.go model_token_fail_request.go @@ -304,6 +364,29 @@ model_userinfo_issue_request.go model_userinfo_issue_response.go model_userinfo_request.go model_userinfo_response.go +model_vci_batch_issue_request.go +model_vci_batch_issue_response.go +model_vci_batch_parse_request.go +model_vci_batch_parse_response.go +model_vci_deferred_issue_request.go +model_vci_deferred_issue_response.go +model_vci_deferred_parse_request.go +model_vci_deferred_parse_response.go +model_vci_jwks_request.go +model_vci_jwks_response.go +model_vci_jwtissuer_request.go +model_vci_jwtissuer_response.go +model_vci_metadata_request.go +model_vci_metadata_response.go +model_vci_offer_create_request.go +model_vci_offer_create_response.go +model_vci_offer_info_request.go +model_vci_offer_info_response.go +model_vci_single_issue_request.go +model_vci_single_issue_response.go +model_vci_single_parse_request.go +model_vci_single_parse_response.go model_verified_claims_validation_schema.go response.go +test/api_vci_endpoint_test.go utils.go diff --git a/README.md b/README.md index 14738f3..db2b2ea 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,8 @@ Authlete API Document. ## Overview This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client. -- API version: 2.3.12 -- Package version: 2.3 +- API version: 3.0.0 +- Package version: 3.0 - Build package: org.openapitools.codegen.languages.GoClientCodegen ## Installation @@ -74,72 +74,87 @@ ctx = context.WithValue(context.Background(), authlete.ContextOperationServerVar ## Documentation for API Endpoints -All URIs are relative to *https://api.authlete.com* +All URIs are relative to *https://beta.authlete.com* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- -*AuthorizationEndpointApi* | [**AuthAuthorizationApi**](docs/AuthorizationEndpointApi.md#authauthorizationapi) | **Post** /api/auth/authorization | /api/auth/authorization API -*AuthorizationEndpointApi* | [**AuthAuthorizationFailApi**](docs/AuthorizationEndpointApi.md#authauthorizationfailapi) | **Post** /api/auth/authorization/fail | /api/auth/authorization/fail API -*AuthorizationEndpointApi* | [**AuthAuthorizationIssueApi**](docs/AuthorizationEndpointApi.md#authauthorizationissueapi) | **Post** /api/auth/authorization/issue | /api/auth/authorization/issue API -*CIBAApi* | [**BackchannelAuthenticationApi**](docs/CIBAApi.md#backchannelauthenticationapi) | **Post** /api/backchannel/authentication | /api/backchannel/authentication API -*CIBAApi* | [**BackchannelAuthenticationCompleteApi**](docs/CIBAApi.md#backchannelauthenticationcompleteapi) | **Post** /api/backchannel/authentication/complete | /api/backchannel/authentication/complete API -*CIBAApi* | [**BackchannelAuthenticationFailApi**](docs/CIBAApi.md#backchannelauthenticationfailapi) | **Post** /api/backchannel/authentication/fail | /api/backchannel/authentication/fail API -*CIBAApi* | [**BackchannelAuthenticationIssueApi**](docs/CIBAApi.md#backchannelauthenticationissueapi) | **Post** /api/backchannel/authentication/issue | /api/backchannel/authentication/issue API -*ClientExtensionApi* | [**ClientExtensionRequestablesScopesDeleteApi**](docs/ClientExtensionApi.md#clientextensionrequestablesscopesdeleteapi) | **Delete** /api/client/extension/requestable_scopes/delete/{clientId} | /api/client/extension/requestable_scopes/delete/{clientId} API -*ClientExtensionApi* | [**ClientExtensionRequestablesScopesGetApi**](docs/ClientExtensionApi.md#clientextensionrequestablesscopesgetapi) | **Get** /api/client/extension/requestable_scopes/get/{clientId} | /api/client/extension/requestable_scopes/get/{clientId} API -*ClientExtensionApi* | [**ClientExtensionRequestablesScopesUpdateApi**](docs/ClientExtensionApi.md#clientextensionrequestablesscopesupdateapi) | **Put** /api/client/extension/requestable_scopes/update/{clientId} | /api/client/extension/requestable_scopes/update/{clientId} API -*ClientManagementApi* | [**ClientAuthorizationDeleteApi**](docs/ClientManagementApi.md#clientauthorizationdeleteapi) | **Delete** /api/client/authorization/delete/{clientId} | /api/client/authorization/delete/{clientId}/{subject} API -*ClientManagementApi* | [**ClientAuthorizationGetListApi**](docs/ClientManagementApi.md#clientauthorizationgetlistapi) | **Get** /api/client/authorization/get/list | /api/client/authorization/get/list/{subject} API -*ClientManagementApi* | [**ClientAuthorizationUpdateApi**](docs/ClientManagementApi.md#clientauthorizationupdateapi) | **Post** /api/client/authorization/update/{clientId} | /api/client/authorization/update/{clientId} API -*ClientManagementApi* | [**ClientCreateApi**](docs/ClientManagementApi.md#clientcreateapi) | **Post** /api/client/create | /api/client/create API -*ClientManagementApi* | [**ClientDeleteApi**](docs/ClientManagementApi.md#clientdeleteapi) | **Delete** /api/client/delete/{clientId} | /api/client/delete/{clientId} API -*ClientManagementApi* | [**ClientFlagUpdateApi**](docs/ClientManagementApi.md#clientflagupdateapi) | **Post** /api/client/lock_flag/update/{clientIdentifier} | /api/client/lock_flag/update/{clientIdentifier} API -*ClientManagementApi* | [**ClientGetApi**](docs/ClientManagementApi.md#clientgetapi) | **Get** /api/client/get/{clientId} | /api/client/get/{clientId} API -*ClientManagementApi* | [**ClientGetListApi**](docs/ClientManagementApi.md#clientgetlistapi) | **Get** /api/client/get/list | /api/client/get/list API -*ClientManagementApi* | [**ClientGrantedScopesDeleteApi**](docs/ClientManagementApi.md#clientgrantedscopesdeleteapi) | **Delete** /api/client/granted_scopes/delete/{clientId} | /api/client/granted_scopes/delete/{clientId}/{subject} API -*ClientManagementApi* | [**ClientGrantedScopesGetApi**](docs/ClientManagementApi.md#clientgrantedscopesgetapi) | **Get** /api/client/granted_scopes/get/{clientId} | /api/client/granted_scopes/get/{clientId}/{subject} API -*ClientManagementApi* | [**ClientSecretRefreshApi**](docs/ClientManagementApi.md#clientsecretrefreshapi) | **Get** /api/client/secret/refresh/{clientIdentifier} | /api/client/secret/refresh API -*ClientManagementApi* | [**ClientSecretUpdateApi**](docs/ClientManagementApi.md#clientsecretupdateapi) | **Post** /api/client/secret/update/{clientIdentifier} | /api/client/secret/update API -*ClientManagementApi* | [**ClientUpdateApi**](docs/ClientManagementApi.md#clientupdateapi) | **Post** /api/client/update/{clientId} | /api/client/update/{clientId} API -*ConfigurationEndpointApi* | [**ServiceConfigurationApi**](docs/ConfigurationEndpointApi.md#serviceconfigurationapi) | **Get** /api/service/configuration | /api/service/configuration API +*AuthorizationEndpointApi* | [**ApiServiceIdAuthAuthorizationTicketInfoGet**](docs/AuthorizationEndpointApi.md#apiserviceidauthauthorizationticketinfoget) | **Get** /api/{serviceId}/auth/authorization/ticket/info | /api/{serviceId}/auth/authorization/ticket/info API +*AuthorizationEndpointApi* | [**ApiServiceIdAuthAuthorizationTicketUpdatePost**](docs/AuthorizationEndpointApi.md#apiserviceidauthauthorizationticketupdatepost) | **Post** /api/{serviceId}/auth/authorization/ticket/update | /api/{serviceId}/auth/authorization/ticket/update API +*AuthorizationEndpointApi* | [**AuthAuthorizationApi**](docs/AuthorizationEndpointApi.md#authauthorizationapi) | **Post** /api/{serviceId}/auth/authorization | /api/{serviceId}/auth/authorization API +*AuthorizationEndpointApi* | [**AuthAuthorizationFailApi**](docs/AuthorizationEndpointApi.md#authauthorizationfailapi) | **Post** /api/{serviceId}/auth/authorization/fail | /api/{serviceId}/auth/authorization/fail API +*AuthorizationEndpointApi* | [**AuthAuthorizationIssueApi**](docs/AuthorizationEndpointApi.md#authauthorizationissueapi) | **Post** /api/{serviceId}/auth/authorization/issue | /api/{serviceId}/auth/authorization/issue API +*CIBAApi* | [**BackchannelAuthenticationApi**](docs/CIBAApi.md#backchannelauthenticationapi) | **Post** /api/{serviceId}/backchannel/authentication | /api/{serviceId}/backchannel/authentication API +*CIBAApi* | [**BackchannelAuthenticationCompleteApi**](docs/CIBAApi.md#backchannelauthenticationcompleteapi) | **Post** /api/{serviceId}/backchannel/authentication/complete | /api/{serviceId}/backchannel/authentication/complete API +*CIBAApi* | [**BackchannelAuthenticationFailApi**](docs/CIBAApi.md#backchannelauthenticationfailapi) | **Post** /api/{serviceId}/backchannel/authentication/fail | /api/{serviceId}/backchannel/authentication/fail API +*CIBAApi* | [**BackchannelAuthenticationIssueApi**](docs/CIBAApi.md#backchannelauthenticationissueapi) | **Post** /api/{serviceId}/backchannel/authentication/issue | /api/{serviceId}/backchannel/authentication/issue API +*ClientExtensionApi* | [**ClientExtensionRequestablesScopesDeleteApi**](docs/ClientExtensionApi.md#clientextensionrequestablesscopesdeleteapi) | **Delete** /api/{serviceId}/client/extension/requestable_scopes/delete/{clientId} | /api/{serviceId}/client/extension/requestable_scopes/delete/{clientId} API +*ClientExtensionApi* | [**ClientExtensionRequestablesScopesGetApi**](docs/ClientExtensionApi.md#clientextensionrequestablesscopesgetapi) | **Get** /api/{serviceId}/client/extension/requestable_scopes/get/{clientId} | /api/{serviceId}/client/extension/requestable_scopes/get/{clientId} API +*ClientExtensionApi* | [**ClientExtensionRequestablesScopesUpdateApi**](docs/ClientExtensionApi.md#clientextensionrequestablesscopesupdateapi) | **Put** /api/{serviceId}/client/extension/requestable_scopes/update/{clientId} | /api/{serviceId}/client/extension/requestable_scopes/update/{clientId} API +*ClientManagementApi* | [**ClientAuthorizationDeleteApi**](docs/ClientManagementApi.md#clientauthorizationdeleteapi) | **Delete** /api/{serviceId}/client/authorization/delete/{clientId} | /api/{serviceId}/client/authorization/delete/{clientId}/{subject} API +*ClientManagementApi* | [**ClientAuthorizationGetListApi**](docs/ClientManagementApi.md#clientauthorizationgetlistapi) | **Get** /api/{serviceId}/client/authorization/get/list | /api/{serviceId}/client/authorization/get/list/{subject} API +*ClientManagementApi* | [**ClientAuthorizationUpdateApi**](docs/ClientManagementApi.md#clientauthorizationupdateapi) | **Post** /api/{serviceId}/client/authorization/update/{clientId} | /api/{serviceId}/client/authorization/update/{clientId} API +*ClientManagementApi* | [**ClientCreateApi**](docs/ClientManagementApi.md#clientcreateapi) | **Post** /api/{serviceId}/client/create | /api/{serviceId}/client/create API +*ClientManagementApi* | [**ClientDeleteApi**](docs/ClientManagementApi.md#clientdeleteapi) | **Delete** /api/{serviceId}/client/delete/{clientId} | /api/{serviceId}/client/delete/{clientId} API +*ClientManagementApi* | [**ClientFlagUpdateApi**](docs/ClientManagementApi.md#clientflagupdateapi) | **Post** /api/{serviceId}/client/lock_flag/update/{clientIdentifier} | /api/{serviceId}/client/lock_flag/update/{clientIdentifier} API +*ClientManagementApi* | [**ClientGetApi**](docs/ClientManagementApi.md#clientgetapi) | **Get** /api/{serviceId}/client/get/{clientId} | /api/{serviceId}/client/get/{clientId} API +*ClientManagementApi* | [**ClientGetListApi**](docs/ClientManagementApi.md#clientgetlistapi) | **Get** /api/{serviceId}/client/get/list | /api/{serviceId}/client/get/list API +*ClientManagementApi* | [**ClientGrantedScopesDeleteApi**](docs/ClientManagementApi.md#clientgrantedscopesdeleteapi) | **Delete** /api/{serviceId}/client/granted_scopes/delete/{clientId} | /api/{serviceId}/client/granted_scopes/delete/{clientId}/{subject} API +*ClientManagementApi* | [**ClientGrantedScopesGetApi**](docs/ClientManagementApi.md#clientgrantedscopesgetapi) | **Get** /api/{serviceId}/client/granted_scopes/get/{clientId} | /api/{serviceId}/client/granted_scopes/get/{clientId}/{subject} API +*ClientManagementApi* | [**ClientSecretRefreshApi**](docs/ClientManagementApi.md#clientsecretrefreshapi) | **Get** /api/{serviceId}/client/secret/refresh/{clientIdentifier} | /api/{serviceId}/client/secret/refresh API +*ClientManagementApi* | [**ClientSecretUpdateApi**](docs/ClientManagementApi.md#clientsecretupdateapi) | **Post** /api/{serviceId}/client/secret/update/{clientIdentifier} | /api/{serviceId}/client/secret/update API +*ClientManagementApi* | [**ClientUpdateApi**](docs/ClientManagementApi.md#clientupdateapi) | **Post** /api/{serviceId}/client/update/{clientId} | /api/{serviceId}/client/update/{clientId} API +*ConfigurationEndpointApi* | [**ServiceConfigurationApi**](docs/ConfigurationEndpointApi.md#serviceconfigurationapi) | **Get** /api/{serviceId}/service/configuration | /api/{serviceId}/service/configuration API *DefaultApi* | [**MiscEchoApi**](docs/DefaultApi.md#miscechoapi) | **Get** /api/misc/echo | /api/misc/echo API -*DeviceFlowApi* | [**DeviceAuthorizationApi**](docs/DeviceFlowApi.md#deviceauthorizationapi) | **Post** /api/device/authorization | /api/device/authorization API -*DeviceFlowApi* | [**DeviceCompleteApi**](docs/DeviceFlowApi.md#devicecompleteapi) | **Post** /api/device/complete | /api/device/complete API -*DeviceFlowApi* | [**DeviceVerificationApi**](docs/DeviceFlowApi.md#deviceverificationapi) | **Post** /api/device/verification | /api/device/verification API -*DynamicClientRegistrationApi* | [**ClientRegistrationApi**](docs/DynamicClientRegistrationApi.md#clientregistrationapi) | **Post** /api/client/registration | /api/client/registration API -*DynamicClientRegistrationApi* | [**ClientRegistrationDeleteApi**](docs/DynamicClientRegistrationApi.md#clientregistrationdeleteapi) | **Post** /api/client/registration/delete | /api/client/registration/delete API -*DynamicClientRegistrationApi* | [**ClientRegistrationGetApi**](docs/DynamicClientRegistrationApi.md#clientregistrationgetapi) | **Post** /api/client/registration/get | /api/client/registration/get API -*DynamicClientRegistrationApi* | [**ClientRegistrationUpdateApi**](docs/DynamicClientRegistrationApi.md#clientregistrationupdateapi) | **Post** /api/client/registration/update | /api/client/registration/update API -*FederationEndpointApi* | [**FederationConfigurationApi**](docs/FederationEndpointApi.md#federationconfigurationapi) | **Post** /api/federation/configuration | /api/federation/configuration API -*FederationEndpointApi* | [**FederationRegistrationApi**](docs/FederationEndpointApi.md#federationregistrationapi) | **Post** /api/federation/registration | /api/federation/registration API -*GrantManagementEndpointApi* | [**GrantMApi**](docs/GrantManagementEndpointApi.md#grantmapi) | **Post** /api/gm | /api/gm API -*HskOperationsApi* | [**HskCreateApi**](docs/HskOperationsApi.md#hskcreateapi) | **Post** /api/hsk/create | /api/hsk/create API -*HskOperationsApi* | [**HskDeleteApi**](docs/HskOperationsApi.md#hskdeleteapi) | **Delete** /api/hsk/delete/{handle} | /api/hsk/delete/{handle} API -*HskOperationsApi* | [**HskGetApi**](docs/HskOperationsApi.md#hskgetapi) | **Get** /api/hsk/get/{handle} | /api/hsk/get/{handle} API -*HskOperationsApi* | [**HskGetListApi**](docs/HskOperationsApi.md#hskgetlistapi) | **Get** /api/hsk/get/list | /api/hsk/get/list API -*IDTokenEndpointApi* | [**IdtokenReissueApi**](docs/IDTokenEndpointApi.md#idtokenreissueapi) | **Post** /api/idtoken/reissue | /api/idtoken/reissue API -*IntrospectionEndpointApi* | [**AuthIntrospectionApi**](docs/IntrospectionEndpointApi.md#authintrospectionapi) | **Post** /api/auth/introspection | /api/auth/introspection API -*IntrospectionEndpointApi* | [**AuthIntrospectionStandardApi**](docs/IntrospectionEndpointApi.md#authintrospectionstandardapi) | **Post** /api/auth/introspection/standard | /api/auth/introspection/standard API -*JWKSetEndpointApi* | [**ServiceJwksGetApi**](docs/JWKSetEndpointApi.md#servicejwksgetapi) | **Get** /api/service/jwks/get | /api/service/jwks/get API -*JoseObjectApi* | [**JoseVerifyApi**](docs/JoseObjectApi.md#joseverifyapi) | **Post** /api/jose/verify | /api/jose/verify API -*PushedAuthorizationEndpointApi* | [**PushedAuthReqApi**](docs/PushedAuthorizationEndpointApi.md#pushedauthreqapi) | **Post** /api/pushed_auth_req | /api/pushed_auth_req API -*RevocationEndpointApi* | [**AuthRevocationApi**](docs/RevocationEndpointApi.md#authrevocationapi) | **Post** /api/auth/revocation | /api/auth/revocation API +*DeviceFlowApi* | [**DeviceAuthorizationApi**](docs/DeviceFlowApi.md#deviceauthorizationapi) | **Post** /api/{serviceId}/device/authorization | /api/{serviceId}/device/authorization API +*DeviceFlowApi* | [**DeviceCompleteApi**](docs/DeviceFlowApi.md#devicecompleteapi) | **Post** /api/{serviceId}/device/complete | /api/{serviceId}/device/complete API +*DeviceFlowApi* | [**DeviceVerificationApi**](docs/DeviceFlowApi.md#deviceverificationapi) | **Post** /api/{serviceId}/device/verification | /api/{serviceId}/device/verification API +*DynamicClientRegistrationApi* | [**ClientRegistrationApi**](docs/DynamicClientRegistrationApi.md#clientregistrationapi) | **Post** /api/{serviceId}/client/registration | /api/{serviceId}/client/registration API +*DynamicClientRegistrationApi* | [**ClientRegistrationDeleteApi**](docs/DynamicClientRegistrationApi.md#clientregistrationdeleteapi) | **Post** /api/{serviceId}/client/registration/delete | /api/{serviceId}/client/registration/delete API +*DynamicClientRegistrationApi* | [**ClientRegistrationGetApi**](docs/DynamicClientRegistrationApi.md#clientregistrationgetapi) | **Post** /api/{serviceId}/client/registration/get | /api/{serviceId}/client/registration/get API +*DynamicClientRegistrationApi* | [**ClientRegistrationUpdateApi**](docs/DynamicClientRegistrationApi.md#clientregistrationupdateapi) | **Post** /api/{serviceId}/client/registration/update | /api/{serviceId}/client/registration/update API +*FederationEndpointApi* | [**FederationConfigurationApi**](docs/FederationEndpointApi.md#federationconfigurationapi) | **Post** /api/{serviceId}/federation/configuration | /api/{serviceId}/federation/configuration API +*FederationEndpointApi* | [**FederationRegistrationApi**](docs/FederationEndpointApi.md#federationregistrationapi) | **Post** /api/{serviceId}/federation/registration | /api/{serviceId}/federation/registration API +*GrantManagementEndpointApi* | [**GrantMApi**](docs/GrantManagementEndpointApi.md#grantmapi) | **Post** /api/{serviceId}/gm | /api/{serviceId}/gm API +*HskOperationsApi* | [**HskCreateApi**](docs/HskOperationsApi.md#hskcreateapi) | **Post** /api/{serviceId}/hsk/create | /api/{serviceId}/hsk/create API +*HskOperationsApi* | [**HskDeleteApi**](docs/HskOperationsApi.md#hskdeleteapi) | **Delete** /api/{serviceId}/hsk/delete/{handle} | /api/{serviceId}/hsk/delete/{handle} API +*HskOperationsApi* | [**HskGetApi**](docs/HskOperationsApi.md#hskgetapi) | **Get** /api/{serviceId}/hsk/get/{handle} | /api/{serviceId}/hsk/get/{handle} API +*HskOperationsApi* | [**HskGetListApi**](docs/HskOperationsApi.md#hskgetlistapi) | **Get** /api/{serviceId}/hsk/get/list | /api/{serviceId}/hsk/get/list API +*IntrospectionEndpointApi* | [**AuthIntrospectionApi**](docs/IntrospectionEndpointApi.md#authintrospectionapi) | **Post** /api/{serviceId}/auth/introspection | /api/{serviceId}/auth/introspection API +*IntrospectionEndpointApi* | [**AuthIntrospectionStandardApi**](docs/IntrospectionEndpointApi.md#authintrospectionstandardapi) | **Post** /api/{serviceId}/auth/introspection/standard | /api/{serviceId}/auth/introspection/standard API +*JWKSetEndpointApi* | [**ServiceJwksGetApi**](docs/JWKSetEndpointApi.md#servicejwksgetapi) | **Get** /api/{serviceId}/service/jwks/get | /api/{serviceId}/service/jwks/get API +*JoseObjectApi* | [**JoseVerifyApi**](docs/JoseObjectApi.md#joseverifyapi) | **Post** /api/{serviceId}/jose/verify | /api/{serviceId}/jose/verify API +*PushedAuthorizationEndpointApi* | [**PushedAuthReqApi**](docs/PushedAuthorizationEndpointApi.md#pushedauthreqapi) | **Post** /api/{serviceId}/pushed_auth_req | /api/{serviceId}/pushed_auth_req API +*RevocationEndpointApi* | [**AuthRevocationApi**](docs/RevocationEndpointApi.md#authrevocationapi) | **Post** /api/{serviceId}/auth/revocation | /api/{serviceId}/auth/revocation API *ServerMetadataApi* | [**InfoApi**](docs/ServerMetadataApi.md#infoapi) | **Get** /api/info | /api/info API *ServiceManagementApi* | [**ServiceCreateApi**](docs/ServiceManagementApi.md#servicecreateapi) | **Post** /api/service/create | /api/service/create API -*ServiceManagementApi* | [**ServiceDeleteApi**](docs/ServiceManagementApi.md#servicedeleteapi) | **Delete** /api/service/delete/{serviceApiKey} | /api/service/delete/{serviceApiKey} API -*ServiceManagementApi* | [**ServiceGetApi**](docs/ServiceManagementApi.md#servicegetapi) | **Get** /api/service/get/{serviceApiKey} | /api/service/get/{serviceApiKey} API +*ServiceManagementApi* | [**ServiceDeleteApi**](docs/ServiceManagementApi.md#servicedeleteapi) | **Delete** /api/{serviceId}/service/delete | /api/{serviceId}/service/delete API +*ServiceManagementApi* | [**ServiceGetApi**](docs/ServiceManagementApi.md#servicegetapi) | **Get** /api/{serviceId}/service/get | /api/{serviceId}/service/get API *ServiceManagementApi* | [**ServiceGetListApi**](docs/ServiceManagementApi.md#servicegetlistapi) | **Get** /api/service/get/list | /api/service/get/list API -*ServiceManagementApi* | [**ServiceUpdateApi**](docs/ServiceManagementApi.md#serviceupdateapi) | **Post** /api/service/update/{serviceApiKey} | /api/service/update/{serviceApiKey} API -*TokenEndpointApi* | [**AuthTokenApi**](docs/TokenEndpointApi.md#authtokenapi) | **Post** /api/auth/token | /api/auth/token API -*TokenEndpointApi* | [**AuthTokenFailApi**](docs/TokenEndpointApi.md#authtokenfailapi) | **Post** /api/auth/token/fail | /api/auth/token/fail API -*TokenEndpointApi* | [**AuthTokenIssueApi**](docs/TokenEndpointApi.md#authtokenissueapi) | **Post** /api/auth/token/issue | /api/auth/token/issue API -*TokenOperationsApi* | [**AuthTokenCreateApi**](docs/TokenOperationsApi.md#authtokencreateapi) | **Post** /api/auth/token/create | /api/auth/token/create API -*TokenOperationsApi* | [**AuthTokenDeleteApi**](docs/TokenOperationsApi.md#authtokendeleteapi) | **Delete** /api/auth/token/delete/{accessTokenIdentifier} | /api/auth/token/delete API -*TokenOperationsApi* | [**AuthTokenGetListApi**](docs/TokenOperationsApi.md#authtokengetlistapi) | **Get** /api/auth/token/get/list | /api/auth/token/get/list API -*TokenOperationsApi* | [**AuthTokenRevokeApi**](docs/TokenOperationsApi.md#authtokenrevokeapi) | **Post** /api/auth/token/revoke | /api/auth/token/revoke API -*TokenOperationsApi* | [**AuthTokenUpdateApi**](docs/TokenOperationsApi.md#authtokenupdateapi) | **Post** /api/auth/token/update | /api/auth/token/update API -*UserInfoEndpointApi* | [**AuthUserinfoApi**](docs/UserInfoEndpointApi.md#authuserinfoapi) | **Post** /api/auth/userinfo | /api/auth/userinfo API -*UserInfoEndpointApi* | [**AuthUserinfoIssueApi**](docs/UserInfoEndpointApi.md#authuserinfoissueapi) | **Post** /api/auth/userinfo/issue | /api/auth/userinfo/issue API +*ServiceManagementApi* | [**ServiceUpdateApi**](docs/ServiceManagementApi.md#serviceupdateapi) | **Post** /api/{serviceId}/service/update | /api/{serviceId}/service/update API +*TokenEndpointApi* | [**AuthTokenApi**](docs/TokenEndpointApi.md#authtokenapi) | **Post** /api/{serviceId}/auth/token | /api/{serviceId}/auth/token API +*TokenEndpointApi* | [**AuthTokenFailApi**](docs/TokenEndpointApi.md#authtokenfailapi) | **Post** /api/{serviceId}/auth/token/fail | /api/{serviceId}/auth/token/fail API +*TokenEndpointApi* | [**AuthTokenIssueApi**](docs/TokenEndpointApi.md#authtokenissueapi) | **Post** /api/{serviceId}/auth/token/issue | /api/{serviceId}/auth/token/issue API +*TokenEndpointApi* | [**IdtokenReissueApi**](docs/TokenEndpointApi.md#idtokenreissueapi) | **Post** /api/{serviceId}/idtoken/reissue | /api/{serviceId}/idtoken/reissue API +*TokenOperationsApi* | [**AuthTokenCreateApi**](docs/TokenOperationsApi.md#authtokencreateapi) | **Post** /api/{serviceId}/auth/token/create | /api/{serviceId}/auth/token/create API +*TokenOperationsApi* | [**AuthTokenCreateBatchApi**](docs/TokenOperationsApi.md#authtokencreatebatchapi) | **Post** /api/{serviceId}/auth/token/create/batch | /api/{serviceId}/auth/token/create/batch API +*TokenOperationsApi* | [**AuthTokenCreateBatchStatusApi**](docs/TokenOperationsApi.md#authtokencreatebatchstatusapi) | **Post** /api/{serviceId}/auth/token/create/batch/status/{requestId} | /api/{serviceId}/auth/token/create/batch/status/{requestId} API +*TokenOperationsApi* | [**AuthTokenDeleteApi**](docs/TokenOperationsApi.md#authtokendeleteapi) | **Delete** /api/{serviceId}/auth/token/delete/{accessTokenIdentifier} | /api/{serviceId}/auth/token/delete API +*TokenOperationsApi* | [**AuthTokenGetListApi**](docs/TokenOperationsApi.md#authtokengetlistapi) | **Get** /api/{serviceId}/auth/token/get/list | /api/{serviceId}/auth/token/get/list API +*TokenOperationsApi* | [**AuthTokenRevokeApi**](docs/TokenOperationsApi.md#authtokenrevokeapi) | **Post** /api/{serviceId}/auth/token/revoke | /api/{serviceId}/auth/token/revoke API +*TokenOperationsApi* | [**AuthTokenUpdateApi**](docs/TokenOperationsApi.md#authtokenupdateapi) | **Post** /api/{serviceId}/auth/token/update | /api/{serviceId}/auth/token/update API +*UserInfoEndpointApi* | [**AuthUserinfoApi**](docs/UserInfoEndpointApi.md#authuserinfoapi) | **Post** /api/{serviceId}/auth/userinfo | /api/{serviceId}/auth/userinfo API +*UserInfoEndpointApi* | [**AuthUserinfoIssueApi**](docs/UserInfoEndpointApi.md#authuserinfoissueapi) | **Post** /api/{serviceId}/auth/userinfo/issue | /api/{serviceId}/auth/userinfo/issue API +*VciEndpointApi* | [**VciBatchIssueApi**](docs/VciEndpointApi.md#vcibatchissueapi) | **Post** /api/{serviceId}/vci/batch/issue | /api/{serviceId}/vci/batch/issue API +*VciEndpointApi* | [**VciBatchParseApi**](docs/VciEndpointApi.md#vcibatchparseapi) | **Post** /api/{serviceId}/vci/batch/parse | /api/{serviceId}/vci/batch/parse API +*VciEndpointApi* | [**VciDeferredIssueApi**](docs/VciEndpointApi.md#vcideferredissueapi) | **Post** /api/{serviceId}/vci/deferred/issue | /api/{serviceId}/vci/deferred/issue API +*VciEndpointApi* | [**VciDeferredParseApi**](docs/VciEndpointApi.md#vcideferredparseapi) | **Post** /api/{serviceId}/vci/deferred/parse | /api/{serviceId}/vci/deferred/parse API +*VciEndpointApi* | [**VciJwksApi**](docs/VciEndpointApi.md#vcijwksapi) | **Post** /api/{serviceId}/vci/jwks | /api/{serviceId}/vci/jwks API +*VciEndpointApi* | [**VciJwtissuerApi**](docs/VciEndpointApi.md#vcijwtissuerapi) | **Post** /api/{serviceId}/vci/jwtissuer | /api/{serviceId}/vci/jwtissuer API +*VciEndpointApi* | [**VciMetadataApi**](docs/VciEndpointApi.md#vcimetadataapi) | **Post** /api/{serviceId}/vci/metadata | /api/{serviceId}/vci/metadata API +*VciEndpointApi* | [**VciOfferCreateApi**](docs/VciEndpointApi.md#vcioffercreateapi) | **Post** /api/{serviceId}/vci/offer/create | /api/{serviceId}/vci/offer/create API +*VciEndpointApi* | [**VciOfferInfoApi**](docs/VciEndpointApi.md#vciofferinfoapi) | **Post** /api/{serviceId}/vci/offer/info | /api/{serviceId}/vci/offer/info API +*VciEndpointApi* | [**VciSingleIssueApi**](docs/VciEndpointApi.md#vcisingleissueapi) | **Post** /api/{serviceId}/vci/single/issue | /api/{serviceId}/vci/single/issue API +*VciEndpointApi* | [**VciSingleParseApi**](docs/VciEndpointApi.md#vcisingleparseapi) | **Post** /api/{serviceId}/vci/single/parse | /api/{serviceId}/vci/single/parse API ## Documentation For Models @@ -155,6 +170,10 @@ Class | Method | HTTP request | Description - [AuthorizationIssueResponse](docs/AuthorizationIssueResponse.md) - [AuthorizationRequest](docs/AuthorizationRequest.md) - [AuthorizationResponse](docs/AuthorizationResponse.md) + - [AuthorizationTicketInfoRequest](docs/AuthorizationTicketInfoRequest.md) + - [AuthorizationTicketInfoResponse](docs/AuthorizationTicketInfoResponse.md) + - [AuthorizationTicketUpdateRequest](docs/AuthorizationTicketUpdateRequest.md) + - [AuthorizationTicketUpdateResponse](docs/AuthorizationTicketUpdateResponse.md) - [AuthzDetails](docs/AuthzDetails.md) - [BackchannelAuthenticationCompleteRequest](docs/BackchannelAuthenticationCompleteRequest.md) - [BackchannelAuthenticationCompleteResponse](docs/BackchannelAuthenticationCompleteResponse.md) @@ -178,13 +197,14 @@ Class | Method | HTTP request | Description - [ClientExtensionRequestableScopesUpdateResponse](docs/ClientExtensionRequestableScopesUpdateResponse.md) - [ClientFlagUpdateRequest](docs/ClientFlagUpdateRequest.md) - [ClientFlagUpdateResponse](docs/ClientFlagUpdateResponse.md) + - [ClientGetListApi200Response](docs/ClientGetListApi200Response.md) + - [ClientGetListLimitedResponse](docs/ClientGetListLimitedResponse.md) - [ClientGetListResponse](docs/ClientGetListResponse.md) - [ClientGrantedScopesDeleteResponse](docs/ClientGrantedScopesDeleteResponse.md) - - [ClientGrantedScopesGetResponse](docs/ClientGrantedScopesGetResponse.md) + - [ClientLimited](docs/ClientLimited.md) + - [ClientLimitedAuthorization](docs/ClientLimitedAuthorization.md) - [ClientRegistrationDeleteRequest](docs/ClientRegistrationDeleteRequest.md) - [ClientRegistrationDeleteResponse](docs/ClientRegistrationDeleteResponse.md) - - [ClientRegistrationGetRequest](docs/ClientRegistrationGetRequest.md) - - [ClientRegistrationGetResponse](docs/ClientRegistrationGetResponse.md) - [ClientRegistrationRequest](docs/ClientRegistrationRequest.md) - [ClientRegistrationResponse](docs/ClientRegistrationResponse.md) - [ClientRegistrationType](docs/ClientRegistrationType.md) @@ -194,6 +214,10 @@ Class | Method | HTTP request | Description - [ClientSecretUpdateRequest](docs/ClientSecretUpdateRequest.md) - [ClientSecretUpdateResponse](docs/ClientSecretUpdateResponse.md) - [ClientType](docs/ClientType.md) + - [CredentialIssuanceOrder](docs/CredentialIssuanceOrder.md) + - [CredentialIssuerMetadata](docs/CredentialIssuerMetadata.md) + - [CredentialOfferInfo](docs/CredentialOfferInfo.md) + - [CredentialRequestInfo](docs/CredentialRequestInfo.md) - [DeliveryMode](docs/DeliveryMode.md) - [DeviceAuthorizationRequest](docs/DeviceAuthorizationRequest.md) - [DeviceAuthorizationResponse](docs/DeviceAuthorizationResponse.md) @@ -203,6 +227,7 @@ Class | Method | HTTP request | Description - [DeviceVerificationResponse](docs/DeviceVerificationResponse.md) - [Display](docs/Display.md) - [DynamicScope](docs/DynamicScope.md) + - [FapiMode](docs/FapiMode.md) - [FederationConfigurationResponse](docs/FederationConfigurationResponse.md) - [FederationRegistrationRequest](docs/FederationRegistrationRequest.md) - [FederationRegistrationResponse](docs/FederationRegistrationResponse.md) @@ -240,8 +265,12 @@ Class | Method | HTTP request | Description - [RevocationResponse](docs/RevocationResponse.md) - [Scope](docs/Scope.md) - [Service](docs/Service.md) + - [ServiceGetApi200Response](docs/ServiceGetApi200Response.md) + - [ServiceGetListApi200Response](docs/ServiceGetListApi200Response.md) + - [ServiceGetListLimitedResponse](docs/ServiceGetListLimitedResponse.md) - [ServiceGetListResponse](docs/ServiceGetListResponse.md) - [ServiceJwksGetResponse](docs/ServiceJwksGetResponse.md) + - [ServiceLimited](docs/ServiceLimited.md) - [ServiceProfile](docs/ServiceProfile.md) - [Sns](docs/Sns.md) - [SnsCredentials](docs/SnsCredentials.md) @@ -249,6 +278,11 @@ Class | Method | HTTP request | Description - [StandardIntrospectionResponse](docs/StandardIntrospectionResponse.md) - [SubjectType](docs/SubjectType.md) - [TaggedValue](docs/TaggedValue.md) + - [TokenBatchStatus](docs/TokenBatchStatus.md) + - [TokenBatchStatusResult](docs/TokenBatchStatusResult.md) + - [TokenCreateBatchRequestInner](docs/TokenCreateBatchRequestInner.md) + - [TokenCreateBatchResponse](docs/TokenCreateBatchResponse.md) + - [TokenCreateBatchStatusResponse](docs/TokenCreateBatchStatusResponse.md) - [TokenCreateRequest](docs/TokenCreateRequest.md) - [TokenCreateResponse](docs/TokenCreateResponse.md) - [TokenFailRequest](docs/TokenFailRequest.md) @@ -270,6 +304,28 @@ Class | Method | HTTP request | Description - [UserinfoIssueResponse](docs/UserinfoIssueResponse.md) - [UserinfoRequest](docs/UserinfoRequest.md) - [UserinfoResponse](docs/UserinfoResponse.md) + - [VciBatchIssueRequest](docs/VciBatchIssueRequest.md) + - [VciBatchIssueResponse](docs/VciBatchIssueResponse.md) + - [VciBatchParseRequest](docs/VciBatchParseRequest.md) + - [VciBatchParseResponse](docs/VciBatchParseResponse.md) + - [VciDeferredIssueRequest](docs/VciDeferredIssueRequest.md) + - [VciDeferredIssueResponse](docs/VciDeferredIssueResponse.md) + - [VciDeferredParseRequest](docs/VciDeferredParseRequest.md) + - [VciDeferredParseResponse](docs/VciDeferredParseResponse.md) + - [VciJwksRequest](docs/VciJwksRequest.md) + - [VciJwksResponse](docs/VciJwksResponse.md) + - [VciJwtissuerRequest](docs/VciJwtissuerRequest.md) + - [VciJwtissuerResponse](docs/VciJwtissuerResponse.md) + - [VciMetadataRequest](docs/VciMetadataRequest.md) + - [VciMetadataResponse](docs/VciMetadataResponse.md) + - [VciOfferCreateRequest](docs/VciOfferCreateRequest.md) + - [VciOfferCreateResponse](docs/VciOfferCreateResponse.md) + - [VciOfferInfoRequest](docs/VciOfferInfoRequest.md) + - [VciOfferInfoResponse](docs/VciOfferInfoResponse.md) + - [VciSingleIssueRequest](docs/VciSingleIssueRequest.md) + - [VciSingleIssueResponse](docs/VciSingleIssueResponse.md) + - [VciSingleParseRequest](docs/VciSingleParseRequest.md) + - [VciSingleParseResponse](docs/VciSingleParseResponse.md) - [VerifiedClaimsValidationSchema](docs/VerifiedClaimsValidationSchema.md) @@ -277,32 +333,122 @@ Class | Method | HTTP request | Description -### ServiceCredentials +### Admin -- **Type**: HTTP basic authentication +- **Type**: HTTP Bearer token authentication Example ```golang -auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{ - UserName: "username", - Password: "password", -}) +auth := context.WithValue(context.Background(), sw.ContextAccessToken, "BEARER_TOKEN_STRING") r, err := client.Service.Operation(auth, args) ``` -### ServiceOwnerCredentials +### CreateClient -- **Type**: HTTP basic authentication +- **Type**: HTTP Bearer token authentication Example ```golang -auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{ - UserName: "username", - Password: "password", -}) +auth := context.WithValue(context.Background(), sw.ContextAccessToken, "BEARER_TOKEN_STRING") +r, err := client.Service.Operation(auth, args) +``` + + +### CreateService + +- **Type**: HTTP Bearer token authentication + +Example + +```golang +auth := context.WithValue(context.Background(), sw.ContextAccessToken, "BEARER_TOKEN_STRING") +r, err := client.Service.Operation(auth, args) +``` + + +### DeleteService + +- **Type**: HTTP Bearer token authentication + +Example + +```golang +auth := context.WithValue(context.Background(), sw.ContextAccessToken, "BEARER_TOKEN_STRING") +r, err := client.Service.Operation(auth, args) +``` + + +### ModifyClient + +- **Type**: HTTP Bearer token authentication + +Example + +```golang +auth := context.WithValue(context.Background(), sw.ContextAccessToken, "BEARER_TOKEN_STRING") +r, err := client.Service.Operation(auth, args) +``` + + +### ModifyService + +- **Type**: HTTP Bearer token authentication + +Example + +```golang +auth := context.WithValue(context.Background(), sw.ContextAccessToken, "BEARER_TOKEN_STRING") +r, err := client.Service.Operation(auth, args) +``` + + +### UseService + +- **Type**: HTTP Bearer token authentication + +Example + +```golang +auth := context.WithValue(context.Background(), sw.ContextAccessToken, "BEARER_TOKEN_STRING") +r, err := client.Service.Operation(auth, args) +``` + + +### ViewClient + +- **Type**: HTTP Bearer token authentication + +Example + +```golang +auth := context.WithValue(context.Background(), sw.ContextAccessToken, "BEARER_TOKEN_STRING") +r, err := client.Service.Operation(auth, args) +``` + + +### ViewDefaultService + +- **Type**: HTTP Bearer token authentication + +Example + +```golang +auth := context.WithValue(context.Background(), sw.ContextAccessToken, "BEARER_TOKEN_STRING") +r, err := client.Service.Operation(auth, args) +``` + + +### ViewService + +- **Type**: HTTP Bearer token authentication + +Example + +```golang +auth := context.WithValue(context.Background(), sw.ContextAccessToken, "BEARER_TOKEN_STRING") r, err := client.Service.Operation(auth, args) ``` diff --git a/api/openapi.yaml b/api/openapi.yaml index bcddcf6..ba34f13 100644 --- a/api/openapi.yaml +++ b/api/openapi.yaml @@ -6,10 +6,10 @@ info: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html title: Authlete API - version: 2.3.12 + version: 3.0.0 servers: -- description: Shared production server. - url: https://api.authlete.com +- description: Beta Shared server. + url: https://beta.authlete.com tags: - description: desc1 name: Service Management @@ -21,8 +21,6 @@ tags: name: Pushed Authorization Endpoint - description: desc1 name: Token Endpoint -- description: desc1 - name: ID Token Endpoint - description: desc1 name: Introspection Endpoint - description: desc1 @@ -50,15 +48,18 @@ tags: - description: desc1 name: Federation Endpoint paths: - /api/service/get/{serviceApiKey}: + /api/{serviceId}/service/get: get: description: | Get a service. + + If the access token can only view or modify clients underneath this service, but does not + have access to view this service directly, a limited view of the service will be returned. operationId: service_get_api parameters: - - description: The API key of a service. + - description: A service ID. in: path - name: serviceApiKey + name: serviceId required: true schema: type: string @@ -66,100 +67,109 @@ paths: "200": content: application/json: - example: - accessTokenDuration: 3600 - accessTokenType: Bearer - allowableClockSkew: 0 - apiKey: 21653835348762 - apiSecret: uE4NgqeIpuSV_XejQ7Ds3jsgA1yXhjR1MXJ1LbPuyls - attributes: - - key: attribute1-key - value: attribute1-value - - key: attribute2-key - value: attribute2-value - authorizationEndpoint: https://my-service.example.com/authz - authorizationResponseDuration: 0 - backchannelAuthReqIdDuration: 0 - backchannelBindingMessageRequiredInFapi: false - backchannelPollingInterval: 0 - backchannelUserCodeParameterSupported: false - claimShortcutRestrictive: false - clientIdAliasEnabled: true - clientsPerDeveloper: 0 - createdAt: 1639373421000 - dcrScopeUsedAsRequestable: false - deviceFlowCodeDuration: 0 - deviceFlowPollingInterval: 0 - directAuthorizationEndpointEnabled: false - directIntrospectionEndpointEnabled: false - directJwksEndpointEnabled: false - directRevocationEndpointEnabled: false - directTokenEndpointEnabled: false - directUserInfoEndpointEnabled: false - dynamicRegistrationSupported: false - errorDescriptionOmitted: false - errorUriOmitted: false - frontChannelRequestObjectEncryptionRequired: false - grantManagementActionRequired: false - hsmEnabled: false - idTokenDuration: 0 - introspectionEndpoint: https://my-service.example.com/introspection - issSuppressed: false - issuer: https://my-service.example.com - metadata: - - key: clientCount - value: "1" - missingClientIdAllowed: false - modifiedAt: 1639373421000 - mutualTlsValidatePkiCertChain: false - nbfOptional: false - number: 5041 - parRequired: false - pkceRequired: true - pkceS256Required: false - pushedAuthReqDuration: 0 - refreshTokenDuration: 3600 - refreshTokenDurationKept: false - refreshTokenDurationReset: false - refreshTokenKept: false - requestObjectEncryptionAlgMatchRequired: false - requestObjectEncryptionEncMatchRequired: false - requestObjectRequired: false - revocationEndpoint: https://my-service.example.com/revocation - scopeRequired: false - serviceName: My service - serviceOwnerNumber: 2 - singleAccessTokenPerSubject: false - supportedClaimTypes: - - NORMAL - supportedDisplays: - - PAGE - supportedGrantTypes: - - AUTHORIZATION_CODE - - REFRESH_TOKEN - supportedIntrospectionAuthMethods: - - CLIENT_SECRET_BASIC - supportedResponseTypes: - - CODE - supportedRevocationAuthMethods: - - CLIENT_SECRET_BASIC - supportedScopes: - - defaultEntry: false - description: A permission to read your history. - name: history.read - - defaultEntry: false - description: A permission to read your timeline. - name: timeline.read - supportedTokenAuthMethods: - - CLIENT_SECRET_BASIC - tlsClientCertificateBoundAccessTokens: false - tokenEndpoint: https://my-service.example.com/token - tokenExpirationLinked: false - traditionalRequestObjectProcessingApplied: false - unauthorizedOnClientConfigSupported: false - userCodeLength: 0 - schema: - $ref: '#/components/schemas/Service' + examples: + full: + summary: Example showing the full service object. + value: + accessTokenDuration: 3600 + accessTokenType: Bearer + allowableClockSkew: 0 + apiKey: 21653835348762 + attributes: + - key: attribute1-key + value: attribute1-value + - key: attribute2-key + value: attribute2-value + authorizationEndpoint: https://my-service.example.com/authz + authorizationResponseDuration: 0 + backchannelAuthReqIdDuration: 0 + backchannelBindingMessageRequiredInFapi: false + backchannelPollingInterval: 0 + backchannelUserCodeParameterSupported: false + claimShortcutRestrictive: false + clientIdAliasEnabled: true + clientsPerDeveloper: 0 + createdAt: 1639373421000 + dcrScopeUsedAsRequestable: false + deviceFlowCodeDuration: 0 + deviceFlowPollingInterval: 0 + directAuthorizationEndpointEnabled: false + directIntrospectionEndpointEnabled: false + directJwksEndpointEnabled: false + directRevocationEndpointEnabled: false + directTokenEndpointEnabled: false + directUserInfoEndpointEnabled: false + dynamicRegistrationSupported: false + errorDescriptionOmitted: false + errorUriOmitted: false + frontChannelRequestObjectEncryptionRequired: false + grantManagementActionRequired: false + hsmEnabled: false + idTokenDuration: 0 + introspectionEndpoint: https://my-service.example.com/introspection + issSuppressed: false + issuer: https://my-service.example.com + metadata: + - key: clientCount + value: "1" + missingClientIdAllowed: false + modifiedAt: 1639373421000 + mutualTlsValidatePkiCertChain: false + nbfOptional: false + number: 5041 + parRequired: false + pkceRequired: true + pkceS256Required: false + pushedAuthReqDuration: 0 + refreshTokenDuration: 3600 + refreshTokenDurationKept: false + refreshTokenDurationReset: false + refreshTokenKept: false + requestObjectEncryptionAlgMatchRequired: false + requestObjectEncryptionEncMatchRequired: false + requestObjectRequired: false + revocationEndpoint: https://my-service.example.com/revocation + scopeRequired: false + serviceName: My service + serviceOwnerNumber: 2 + singleAccessTokenPerSubject: false + supportedClaimTypes: + - NORMAL + supportedDisplays: + - PAGE + supportedGrantTypes: + - AUTHORIZATION_CODE + - REFRESH_TOKEN + supportedIntrospectionAuthMethods: + - CLIENT_SECRET_BASIC + supportedResponseTypes: + - CODE + supportedRevocationAuthMethods: + - CLIENT_SECRET_BASIC + supportedScopes: + - defaultEntry: false + description: A permission to read your history. + name: history.read + - defaultEntry: false + description: A permission to read your timeline. + name: timeline.read + supportedTokenAuthMethods: + - CLIENT_SECRET_BASIC + tlsClientCertificateBoundAccessTokens: false + tokenEndpoint: https://my-service.example.com/token + tokenExpirationLinked: false + traditionalRequestObjectProcessingApplied: false + unauthorizedOnClientConfigSupported: false + userCodeLength: 0 + limited: + summary: Example showing the limited service object. + value: + apiKey: 21653835348762 + description: This Service. + number: 5041 + serviceName: My service + schema: + $ref: '#/components/schemas/service_get_api_200_response' description: "" "400": content: @@ -200,80 +210,44 @@ paths: $ref: '#/components/schemas/result' description: "" security: - - ServiceOwnerCredentials: [] - summary: "/api/service/get/{serviceApiKey} API" + - ViewService: [] + summary: "/api/{serviceId}/service/get API" tags: - Service Management x-code-samples: - lang: shell label: curl source: | - curl -v https://api.authlete.com/api/service/get/21653835348762 \ - -u '9503564192:cxRpzPEkvqYbDu14gpCVKi_p6kMQvcW-lBMi7IfWLK4' + curl -v https://beta.authlete.com/api/21653835348762/service/get \ + -u 'Authorization: Bearer V5a40R6dWvw2gMkCOBFdZcM95q4HC0Z-T0YKD9-nR6F' - lang: java label: java source: | AuthleteConfiguration conf = ...; AuthleteApi api = AuthleteApiFactory.create(conf); - long serviceApiKey = ...; + long serviceId = ...; - api.getService(serviceApiKey); - - lang: cs - label: C# - source: | - IAuthleteConfiguration conf = ...; - IAuthleteApi api = new AuthleteApi(conf); - - long serviceApiKey = ...; - - await api.GetService(serviceApiKey); - - lang: php - label: PHP - source: | - $conf = ...; - $api = new AuthleteApiImpl($conf); - - $serviceApiKey = ...; - - $api.getService($serviceApiKey); - - lang: ruby - source: | - conf = ... - api = Authlete::Api.new(conf) - - service_api_key = ... - - api.service_get(service_api_key) + api.getService(serviceId); - lang: python source: | conf = ... api = AuthleteApiImpl(conf) - serviceApiKey = ... - - api.getService(serviceApiKey) - - lang: go - source: | - conf := ... - api := api.New(&conf) - - serviceApiKey := ... - - api.GetService(serviceApiKey) - - lang: ts - label: deno - source: | - const conf: AuthleteConfiguration = ...; - const api: AuthleteApi = new AuthleteApiImpl(conf); - - const serviceApiKey = ...; + serviceId = ... - await api.getService(serviceApiKey); + api.getService(serviceId) /api/service/get/list: get: description: | Get a list of services. + + If the access token can only view or modify clients underneath a service, but does not + have access to view that service directly, a limited view of the service will be returned. + Otherwise, all properties of the service are returned. + + If the access token is an administrative token, this returns a list of all services on the Authlete instance. + Otherwise, all services that the access token can view, even in a limited fashion, are returned. operationId: service_get_list_api parameters: - description: Start index (inclusive) of the result set. The default value @@ -296,104 +270,117 @@ paths: "200": content: application/json: - example: - start: 0 - end: 5 - totalCount: 1 - services: - - accessTokenDuration: 3600 - accessTokenType: Bearer - allowableClockSkew: 0 - apiKey: 21653835348762 - apiSecret: uE4NgqeIpuSV_XejQ7Ds3jsgA1yXhjR1MXJ1LbPuyls - attributes: - - key: attribute1-key - value: attribute1-value - - key: attribute2-key - value: attribute2-value - authorizationEndpoint: https://as.example.com/authz - authorizationResponseDuration: 0 - backchannelAuthReqIdDuration: 0 - backchannelBindingMessageRequiredInFapi: false - backchannelPollingInterval: 0 - backchannelUserCodeParameterSupported: false - claimShortcutRestrictive: false - clientIdAliasEnabled: true - clientsPerDeveloper: 0 - createdAt: 1639373421000 - dcrScopeUsedAsRequestable: false - deviceFlowCodeDuration: 0 - deviceFlowPollingInterval: 0 - directAuthorizationEndpointEnabled: false - directIntrospectionEndpointEnabled: false - directJwksEndpointEnabled: false - directRevocationEndpointEnabled: false - directTokenEndpointEnabled: false - directUserInfoEndpointEnabled: false - dynamicRegistrationSupported: false - errorDescriptionOmitted: false - errorUriOmitted: false - frontChannelRequestObjectEncryptionRequired: false - grantManagementActionRequired: false - hsmEnabled: false - idTokenDuration: 0 - introspectionEndpoint: https://my-service.example.com/introspection - issSuppressed: false - issuer: https://my-service.example.com - metadata: - - key: clientCount - value: "1" - missingClientIdAllowed: false - modifiedAt: 1639373421000 - mutualTlsValidatePkiCertChain: false - nbfOptional: false - number: 5041 - parRequired: false - pkceRequired: true - pkceS256Required: false - pushedAuthReqDuration: 0 - refreshTokenDuration: 3600 - refreshTokenDurationKept: false - refreshTokenDurationReset: false - refreshTokenKept: false - requestObjectEncryptionAlgMatchRequired: false - requestObjectEncryptionEncMatchRequired: false - requestObjectRequired: false - revocationEndpoint: https://my-service.example.com/revocation - scopeRequired: false - serviceName: My service - serviceOwnerNumber: 2 - singleAccessTokenPerSubject: false - supportedClaimTypes: - - NORMAL - supportedDisplays: - - PAGE - supportedGrantTypes: - - AUTHORIZATION_CODE - - REFRESH_TOKEN - supportedIntrospectionAuthMethods: - - CLIENT_SECRET_BASIC - supportedResponseTypes: - - CODE - supportedRevocationAuthMethods: - - CLIENT_SECRET_BASIC - supportedScopes: - - defaultEntry: false - description: A permission to read your history. - name: history.read - - defaultEntry: false - description: A permission to read your timeline. - name: timeline.read - supportedTokenAuthMethods: - - CLIENT_SECRET_BASIC - tlsClientCertificateBoundAccessTokens: false - tokenEndpoint: https://my-service.example.com/token - tokenExpirationLinked: false - traditionalRequestObjectProcessingApplied: false - unauthorizedOnClientConfigSupported: false - userCodeLength: 0 - schema: - $ref: '#/components/schemas/service_get_list_response' + examples: + full: + summary: Example showing the full service view. + value: + start: 0 + end: 5 + totalCount: 1 + services: + - accessTokenDuration: 3600 + accessTokenType: Bearer + allowableClockSkew: 0 + apiKey: 21653835348762 + apiSecret: uE4NgqeIpuSV_XejQ7Ds3jsgA1yXhjR1MXJ1LbPuyls + attributes: + - key: attribute1-key + value: attribute1-value + - key: attribute2-key + value: attribute2-value + authorizationEndpoint: https://as.example.com/authz + authorizationResponseDuration: 0 + backchannelAuthReqIdDuration: 0 + backchannelBindingMessageRequiredInFapi: false + backchannelPollingInterval: 0 + backchannelUserCodeParameterSupported: false + claimShortcutRestrictive: false + clientIdAliasEnabled: true + createdAt: 1639373421000 + dcrScopeUsedAsRequestable: false + deviceFlowCodeDuration: 0 + deviceFlowPollingInterval: 0 + directAuthorizationEndpointEnabled: false + directIntrospectionEndpointEnabled: false + directJwksEndpointEnabled: false + directRevocationEndpointEnabled: false + directTokenEndpointEnabled: false + directUserInfoEndpointEnabled: false + dynamicRegistrationSupported: false + errorDescriptionOmitted: false + errorUriOmitted: false + frontChannelRequestObjectEncryptionRequired: false + grantManagementActionRequired: false + hsmEnabled: false + idTokenDuration: 0 + introspectionEndpoint: https://my-service.example.com/introspection + issSuppressed: false + issuer: https://my-service.example.com + metadata: + - key: clientCount + value: "1" + missingClientIdAllowed: false + modifiedAt: 1639373421000 + mutualTlsValidatePkiCertChain: false + nbfOptional: false + number: 5041 + parRequired: false + pkceRequired: true + pkceS256Required: false + pushedAuthReqDuration: 0 + refreshTokenDuration: 3600 + refreshTokenDurationKept: false + refreshTokenDurationReset: false + refreshTokenKept: false + requestObjectEncryptionAlgMatchRequired: false + requestObjectEncryptionEncMatchRequired: false + requestObjectRequired: false + revocationEndpoint: https://my-service.example.com/revocation + scopeRequired: false + serviceName: My service + serviceOwnerNumber: 2 + singleAccessTokenPerSubject: false + supportedClaimTypes: + - NORMAL + supportedDisplays: + - PAGE + supportedGrantTypes: + - AUTHORIZATION_CODE + - REFRESH_TOKEN + supportedIntrospectionAuthMethods: + - CLIENT_SECRET_BASIC + supportedResponseTypes: + - CODE + supportedRevocationAuthMethods: + - CLIENT_SECRET_BASIC + supportedScopes: + - defaultEntry: false + description: A permission to read your history. + name: history.read + - defaultEntry: false + description: A permission to read your timeline. + name: timeline.read + supportedTokenAuthMethods: + - CLIENT_SECRET_BASIC + tlsClientCertificateBoundAccessTokens: false + tokenEndpoint: https://my-service.example.com/token + tokenExpirationLinked: false + traditionalRequestObjectProcessingApplied: false + unauthorizedOnClientConfigSupported: false + userCodeLength: 0 + limited: + summary: Example showing the limited service view. + value: + start: 0 + end: 5 + totalCount: 1 + services: + - apiKey: 21653835348762 + clientIdAliasEnabled: true + number: 5041 + serviceName: My service + schema: + $ref: '#/components/schemas/service_get_list_api_200_response' description: "" "400": content: @@ -434,7 +421,8 @@ paths: $ref: '#/components/schemas/result' description: "" security: - - ServiceOwnerCredentials: [] + - Admin: [] + - ViewService: [] summary: /api/service/get/list API tags: - Service Management @@ -442,8 +430,8 @@ paths: - lang: shell label: curl source: | - curl -v https://api.authlete.com/api/service/get/list?start=0\&end=5 \ - -u '9503564192:cxRpzPEkvqYbDu14gpCVKi_p6kMQvcW-lBMi7IfWLK4' + curl -v https://beta.authlete.com/api/9503564192/service/get/list?start=0\&end=5 \ + -u 'Authorization: Bearer V5a40R6dWvw2gMkCOBFdZcM95q4HC0Z-T0YKD9-nR6F' - lang: java label: java source: | @@ -454,34 +442,6 @@ paths: int end = 5; api.getServiceList(start, end); - - lang: cs - label: C# - source: | - IAuthleteConfiguration conf = ...; - IAuthleteApi api = new AuthleteApi(conf); - - int start = 0; - int end = 5; - - await api.GetServiceList(start, end); - - lang: php - label: PHP - source: | - $conf = ...; - $api = new AuthleteApiImpl($conf); - - $start = 0; - $end = 5; - - $api.getServiceList($start, $end); - - lang: ruby - source: | - conf = ... - api = Authlete::Api.new(conf) - - req = { start: 0, end: 5 } - - api.service_get_list(req) - lang: python source: | conf = ... @@ -491,25 +451,6 @@ paths: end = 5 api.getServiceList(start, end) - - lang: go - source: | - conf := ... - api := api.New(&conf) - - start := 0 - end := 5 - - api.GetServiceList(start, end) - - lang: ts - label: deno - source: | - const conf: AuthleteConfiguration = ...; - const api: AuthleteApi = new AuthleteApiImpl(conf); - - const start = 0; - const end = 5; - - await api.getServiceList(start, end); /api/service/create: post: description: | @@ -697,7 +638,7 @@ paths: $ref: '#/components/schemas/result' description: "" security: - - ServiceOwnerCredentials: [] + - CreateService: [] summary: /api/service/create API tags: - Service Management @@ -705,9 +646,9 @@ paths: - lang: shell label: curl source: | - curl -v -X POST https://api.authlete.com/api/service/create \ + curl -v -X POST https://beta.authlete.com/api/service/create \ -H 'Content-Type:application/json' \ - -u '9503564192:cxRpzPEkvqYbDu14gpCVKi_p6kMQvcW-lBMi7IfWLK4' \ + -u 'Authorization: Bearer V5a40R6dWvw2gMkCOBFdZcM95q4HC0Z-T0YKD9-nR6F' \ -d '{ "serviceName": "My Service", ... }' - lang: java label: java @@ -720,38 +661,6 @@ paths: ... api.createService(service); - - lang: cs - label: C# - source: | - IAuthleteConfiguration conf = ...; - IAuthleteApi api = new AuthleteApi(conf); - - Service service = new Service(); - service.ServiceName = "My Service"; - ... - - await api.CreateService(service); - - lang: php - label: PHP - source: | - $conf = ...; - $api = new AuthleteApiImpl($conf); - - $service = new Service(); - $service.setServiceName("My Service"); - ... - - $api.createService($service); - - lang: ruby - source: | - conf = ... - api = Authlete::Api.new(conf) - - service = Authlete::Model::Service.new - service.service_name = 'My Service' - ... - - api.service_create(service) - lang: python source: | conf = ... @@ -762,36 +671,15 @@ paths: ... api.createService(service) - - lang: go - source: | - conf := ... - api := api.New(&conf) - - service := dto.Service{} - service.ServiceName = "My Service" - ... - - api.CreateService(&service) - - lang: ts - label: deno - source: | - const conf: AuthleteConfiguration = ...; - const api: AuthleteApi = new AuthleteApiImpl(conf); - - const service = new Service(); - service.serviceName = 'My Service'; - ... - - await api.createService(service); - /api/service/update/{serviceApiKey}: + /api/{serviceId}/service/update: post: description: | Update a service. operationId: service_update_api parameters: - - description: The API key of the target service. + - description: A service ID. in: path - name: serviceApiKey + name: serviceId required: true schema: type: string @@ -1025,17 +913,17 @@ paths: $ref: '#/components/schemas/result' description: "" security: - - ServiceOwnerCredentials: [] - summary: "/api/service/update/{serviceApiKey} API" + - ModifyService: [] + summary: "/api/{serviceId}/service/update API" tags: - Service Management x-code-samples: - lang: shell label: curl source: | - curl -v -X POST https://api.authlete.com/api/service/update/21653835348762 \ + curl -v -X POST https://beta.authlete.com/api/21653835348762/service/update \ -H 'Content-Type:application/json' \ - -u '9503564192:cxRpzPEkvqYbDu14gpCVKi_p6kMQvcW-lBMi7IfWLK4' \ + -u 'Authorization: Bearer V5a40R6dWvw2gMkCOBFdZcM95q4HC0Z-T0YKD9-nR6F' \ -d '{ "serviceName": "My updated service", ... }' - lang: java label: java @@ -1044,102 +932,35 @@ paths: AuthleteApi api = AuthleteApiFactory.create(conf); // Get an existing service. - long serviceApiKey = ...; - Service service = api.getService(serviceApiKey); + long serviceId = ...; + Service service = api.getService(serviceId); // Update "service name". service.setAServiceName("My updated service"); api.updateService(service); - - lang: cs - label: C# - source: | - IAuthleteConfiguration conf = ...; - IAuthleteApi api = new AuthleteApi(conf); - - // Get an existing service. - long serviceApiKey = ...; - Service service = api.GetService(serviceApiKey); - - // Update "service name". - service.ServiceName = "My updated service"; - - await api.UpdateService(service); - - lang: php - label: PHP - source: | - $conf = ...; - $api = new AuthleteApiImpl($conf); - - // Get an existing service. - $serviceApiKey = ...; - $api.getService($serviceApiKey); - - // Update "service name". - service.setServiceName("My updated service"); - - $api.updateService($service); - - lang: ruby - source: | - conf = ... - api = Authlete::Api.new(conf) - - service_api_key = ... - api.service_get(service_api_key) - - # Update "service name". - service.serviceName = 'My updated service'; - - api.service_update(service) - lang: python source: | conf = ... api = AuthleteApiImpl(conf) # Get an existing service. - serviceApiKey = ... - service = api.getService(serviceApiKey) + serviceId = ... + service = api.getService(serviceId) # Update "service name". service.serviceName = 'My updated service' api.updateService(service) - - lang: go - source: | - conf := ... - api := api.New(&conf) - - // Get an existing service. - serviceApiKey := ... - service, _ := api.GetService(serviceApiKey) - - // Update "service name". - service.ServiceName := "My updated service" - - api.UpdateService(&service) - - lang: ts - label: deno - source: | - const conf: AuthleteConfiguration = ...; - const api: AuthleteApi = new AuthleteApiImpl(conf); - - // Get an existing service. - const serviceApiKey = ...; - const service = await api.getService(serviceApiKey); - - // Update "service name". - service.serviceName = 'My updated service'; - - await api.updateService(service); - /api/service/delete/{serviceApiKey}: + /api/{serviceId}/service/delete: delete: description: | Delete a service. operationId: service_delete_api parameters: - - description: The API key of the target service. + - description: A service ID. in: path - name: serviceApiKey + name: serviceId required: true schema: type: string @@ -1185,82 +1006,45 @@ paths: $ref: '#/components/schemas/result' description: "" security: - - ServiceOwnerCredentials: [] - summary: "/api/service/delete/{serviceApiKey} API" + - DeleteService: [] + summary: "/api/{serviceId}/service/delete API" tags: - Service Management x-code-samples: - lang: shell label: curl source: | - curl -v -X DELETE https://api.authlete.com/api/service/delete/21653835348762 \ - -u '9503564192:cxRpzPEkvqYbDu14gpCVKi_p6kMQvcW-lBMi7IfWLK4' + curl -v -X DELETE https://beta.authlete.com/api/9503564192/service/delete/21653835348762 \ + -u 'Authorization: Bearer V5a40R6dWvw2gMkCOBFdZcM95q4HC0Z-T0YKD9-nR6F' - lang: java label: java source: | AuthleteConfiguration conf = ...; AuthleteApi api = AuthleteApiFactory.create(conf); - long serviceApiKey = ...; - - api.deleteService(serviceApiKey); - - lang: cs - label: C# - source: | - IAuthleteConfiguration conf = ...; - IAuthleteApi api = new AuthleteApi(conf); - - long serviceApiKey = ...; - - await api.DeleteService(serviceApiKey); - - lang: php - label: PHP - source: | - $conf = ...; - $api = new AuthleteApiImpl($conf); - - $serviceApiKey = ...; - - $api.deleteService($serviceApiKey); - - lang: ruby - source: | - conf = ... - api = Authlete::Api.new(conf) - - service_api_key = ... + long serviceId = ...; - api.service_delete(service_api_key) + api.deleteService(serviceId); - lang: python source: | conf = ... api = AuthleteApiImpl(conf) - serviceApiKey = ... + serviceId = ... - api.deleteService(serviceApiKey) - - lang: go - source: | - conf := ... - api := api.New(&conf) - - serviceApiKey := ... - - api.DeleteService(serviceApiKey) - - lang: ts - label: deno - source: | - const conf: AuthleteConfiguration = ...; - const api: AuthleteApi = new AuthleteApiImpl(conf); - - const serviceApiKey = ...; - - await api.deleteService(serviceApiKey); - /api/client/get/{clientId}: + api.deleteService(serviceId) + /api/{serviceId}/client/get/{clientId}: get: description: | Get a client. operationId: client_get_api parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: + type: string - description: A client ID. in: path name: clientId @@ -1354,16 +1138,16 @@ paths: $ref: '#/components/schemas/result' description: "" security: - - ServiceCredentials: [] - summary: "/api/client/get/{clientId} API" + - ViewClient: [] + summary: "/api/{serviceId}/client/get/{clientId} API" tags: - Client Management x-code-samples: - lang: shell label: curl source: | - curl -v https://api.authlete.com/api/client/get/26478243745571 \ - -u '21653835348762:uE4NgqeIpuSV_XejQ7Ds3jsgA1yXhjR1MXJ1LbPuyls' + curl -v https://beta.authlete.com/api/21653835348762/client/get/26478243745571 \ + -u 'Authorization: Bearer V5a40R6dWvw2gMkCOBFdZcM95q4HC0Z-T0YKD9-nR6F' - lang: java label: java source: | @@ -1373,32 +1157,6 @@ paths: long clientId = ...; api.getClient(clientId); - - lang: cs - label: C# - source: | - IAuthleteConfiguration conf = ...; - IAuthleteApi api = new AuthleteApi(conf); - - long clientId = ...; - - await api.GetClient(clientId); - - lang: php - label: PHP - source: | - $conf = ...; - $api = new AuthleteApiImpl($conf); - - $clientId = ...; - - $api.getClient($clientId); - - lang: ruby - source: | - conf = ... - api = Authlete::Api.new(conf) - - client_id = ... - - api.client_get(client_id) - lang: python source: | conf = ... @@ -1407,29 +1165,22 @@ paths: clientId = ... api.getClient(clientId) - - lang: go - source: | - conf := ... - api := api.New(&conf) - - clientId := ... - - api.GetClient(clientId) - - lang: ts - label: deno - source: | - const conf: AuthleteConfiguration = ...; - const api: AuthleteApi = new AuthleteApiImpl(conf); - - const clientId = ...; - - await api.getClient(clientId); - /api/client/get/list: + /api/{serviceId}/client/get/list: get: description: | - Get a list of clients. + Get a list of clients on a service. + + If the access token can view a full service (including an admin), all clients within the + service are returned. Otherwise, only clients that the access token can view within the + service are returned. operationId: client_get_list_api parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: + type: string - description: | The developer of client applications. The default value is null. If this parameter is not set to `null`, client application of the specified developer are returned. Otherwise, all client @@ -1457,58 +1208,72 @@ paths: type: integer responses: "200": - content: - application/json: - example: - clients: - - applicationType: WEB - attributes: - - key: attribute1-key - value: attribute1-value - - key: attribute2-key - value: attribute2-value - authTimeRequired: false - bcUserCodeRequired: false - clientId: 26478243745571 - clientIdAlias: my-client - clientIdAliasEnabled: true - clientName: My client - clientSecret: gXz97ISgLs4HuXwOZWch8GEmgL4YMvUJwu3er_kDVVGcA0UOhA9avLPbEmoeZdagi9yC_-tEiT2BdRyH9dbrQQ - clientType: CONFIDENTIAL - createdAt: 1639468356000 - defaultMaxAge: 0 - derivedSectorIdentifier: my-client.example.com - developer: john - dynamicallyRegistered: false - frontChannelRequestObjectEncryptionRequired: false - grantTypes: - - AUTHORIZATION_CODE - - REFRESH_TOKEN - idTokenSignAlg: RS256 - modifiedAt: 1639468356000 - number: 6164 - parRequired: false - redirectUris: - - https://my-client.example.com/cb1 - - https://my-client.example.com/cb2 - requestObjectEncryptionAlgMatchRequired: false - requestObjectEncryptionEncMatchRequired: false - requestObjectRequired: false - responseTypes: - - CODE - - TOKEN - serviceNumber: 5041 - subjectType: PUBLIC - tlsClientCertificateBoundAccessTokens: false - tokenAuthMethod: CLIENT_SECRET_BASIC - developer: john - end: 3 - start: 0 - totalCount: 1 - schema: - $ref: '#/components/schemas/client_get_list_response' - description: "" - "400": + content: + application/json: + examples: + full: + summary: Example showing full client view. + value: + clients: + - applicationType: WEB + attributes: + - key: attribute1-key + value: attribute1-value + - key: attribute2-key + value: attribute2-value + authTimeRequired: false + bcUserCodeRequired: false + clientId: 26478243745571 + clientIdAlias: my-client + clientIdAliasEnabled: true + clientName: My client + clientSecret: gXz97ISgLs4HuXwOZWch8GEmgL4YMvUJwu3er_kDVVGcA0UOhA9avLPbEmoeZdagi9yC_-tEiT2BdRyH9dbrQQ + clientType: CONFIDENTIAL + createdAt: 1639468356000 + defaultMaxAge: 0 + derivedSectorIdentifier: my-client.example.com + dynamicallyRegistered: false + frontChannelRequestObjectEncryptionRequired: false + grantTypes: + - AUTHORIZATION_CODE + - REFRESH_TOKEN + idTokenSignAlg: RS256 + modifiedAt: 1639468356000 + number: 6164 + parRequired: false + redirectUris: + - https://my-client.example.com/cb1 + - https://my-client.example.com/cb2 + requestObjectEncryptionAlgMatchRequired: false + requestObjectEncryptionEncMatchRequired: false + requestObjectRequired: false + responseTypes: + - CODE + - TOKEN + serviceNumber: 5041 + subjectType: PUBLIC + tlsClientCertificateBoundAccessTokens: false + tokenAuthMethod: CLIENT_SECRET_BASIC + end: 3 + start: 0 + totalCount: 1 + limited: + summary: Example showing limited client view. + value: + clients: + - clientId: 26478243745571 + clientIdAlias: my-client + clientIdAliasEnabled: true + clientName: My client + clientType: CONFIDENTIAL + number: 6164 + end: 3 + start: 0 + totalCount: 1 + schema: + $ref: '#/components/schemas/client_get_list_api_200_response' + description: "" + "400": content: application/json: example: @@ -1547,16 +1312,17 @@ paths: $ref: '#/components/schemas/result' description: "" security: - - ServiceCredentials: [] - summary: /api/client/get/list API + - ViewService: [] + - ViewClient: [] + summary: "/api/{serviceId}/client/get/list API" tags: - Client Management x-code-samples: - lang: shell label: curl source: | - curl -v https://api.authlete.com/api/client/get/list?developer=john\&start=0\&end=5 \ - -u '21653835348762:uE4NgqeIpuSV_XejQ7Ds3jsgA1yXhjR1MXJ1LbPuyls' + curl -v https://beta.authlete.com/api/21653835348762/client/get/list?developer=john\&start=0\&end=5 \ + -u 'Authorization: Bearer V5a40R6dWvw2gMkCOBFdZcM95q4HC0Z-T0YKD9-nR6F' - lang: java label: java source: | @@ -1568,36 +1334,6 @@ paths: int end = 5; api.getClientList(developer, start, end); - - lang: cs - label: C# - source: | - IAuthleteConfiguration conf = ...; - IAuthleteApi api = new AuthleteApi(conf); - - String developer = "john"; - int start = 0; - int end = 5; - - await api.GetClientList(developer, start, end); - - lang: php - label: PHP - source: | - $conf = ...; - $api = new AuthleteApiImpl($conf); - - $developer = "john"; - $start = 0; - $end = 5; - - $api.getClientList($developer, $start, $end); - - lang: ruby - source: | - conf = ... - api = Authlete::Api.new(conf) - - req = { developer: 'john', start: 0, end: 5 } - - api.client_list_get(req) - lang: python source: | conf = ... @@ -1608,32 +1344,18 @@ paths: end = 5 api.getClientList(developer, start, end) - - lang: go - source: | - conf := ... - api := api.New(&conf) - - developer = "john" - start := 0 - end := 5 - - api.GetClientList(developer, start, end) - - lang: ts - label: deno - source: | - const conf: AuthleteConfiguration = ...; - const api: AuthleteApi = new AuthleteApiImpl(conf); - - const developer = 'john'; - const start = 0; - const end = 5; - - await api.getClientList(developer, start, end); - /api/client/create: + /api/{serviceId}/client/create: post: description: | Create a new client. operationId: client_create_api + parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: + type: string requestBody: content: application/json: @@ -1749,17 +1471,17 @@ paths: $ref: '#/components/schemas/result' description: "" security: - - ServiceCredentials: [] - summary: /api/client/create API + - CreateClient: [] + summary: "/api/{serviceId}/client/create API" tags: - Client Management x-code-samples: - lang: shell label: curl source: | - curl -v -X POST https://api.authlete.com/api/client/create \ + curl -v -X POST https://beta.authlete.com/api/21653835348762/client/create \ -H 'Content-Type:application/json' \ - -u '21653835348762:uE4NgqeIpuSV_XejQ7Ds3jsgA1yXhjR1MXJ1LbPuyls' \ + -u 'Authorization: Bearer V5a40R6dWvw2gMkCOBFdZcM95q4HC0Z-T0YKD9-nR6F' \ -d '{ "developer": "john", "clientName": "My Client", ... }' - lang: java label: java @@ -1773,41 +1495,6 @@ paths: ... api.createClient(client); - - lang: cs - label: C# - source: | - IAuthleteConfiguration conf = ...; - IAuthleteApi api = new AuthleteApi(conf); - - Client client = new Client(); - client.Developer = "john"; - client.ClientName = "My Client"; - ... - - await api.CreateClient(client); - - lang: php - label: PHP - source: | - $conf = ...; - $api = new AuthleteApiImpl($conf); - - $client = new Client(); - $client.setDeveloper("john"); - $client.setClientName("My Client"); - ... - - $api.createClient($client); - - lang: ruby - source: | - conf = ... - api = Authlete::Api.new(conf) - - client = Authlete::Model::Client.new - client.developer = 'john' - client.client_name = 'My Client' - ... - - api.client_create(client) - lang: python source: | conf = ... @@ -1819,35 +1506,18 @@ paths: ... api.createClient(client) - - lang: go - source: | - conf := ... - api := api.New(&conf) - - client := dto.Client{} - client.Developer = "john" - client.ClientName = "My Client" - ... - - api.CreateClient(client) - - lang: ts - label: deno - source: | - const conf: AuthleteConfiguration = ...; - const api: AuthleteApi = new AuthleteApiImpl(conf); - - const client = new Client(); - client.developer = 'john'; - client.clientName = 'My Client'; - ... - - await api.createClient(client); - /api/client/update/{clientId}: + /api/{serviceId}/client/update/{clientId}: post: description: | Update a client. operationId: client_update_api parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: + type: string - description: A client ID. in: path name: clientId @@ -1985,17 +1655,17 @@ paths: $ref: '#/components/schemas/result' description: "" security: - - ServiceCredentials: [] - summary: "/api/client/update/{clientId} API" + - ModifyClient: [] + summary: "/api/{serviceId}/client/update/{clientId} API" tags: - Client Management x-code-samples: - lang: shell label: curl source: | - curl -v -X POST https://api.authlete.com/api/client/update/26478243745571 \ + curl -v -X POST https://beta.authlete.com/api/21653835348762/client/update/26478243745571 \ -H 'Content-Type:application/json' \ - -u '21653835348762:uE4NgqeIpuSV_XejQ7Ds3jsgA1yXhjR1MXJ1LbPuyls' \ + -u 'Authorization: Bearer V5a40R6dWvw2gMkCOBFdZcM95q4HC0Z-T0YKD9-nR6F' \ -d '{ "clientName": "My updated client", ... }' - lang: java label: java @@ -2011,47 +1681,6 @@ paths: client.setClientName("My updated client"); api.updateClient(client); - - lang: cs - label: C# - source: | - IAuthleteConfiguration conf = ...; - IAuthleteApi api = new AuthleteApi(conf); - - // Get an existing client. - long clientId = ...; - Client client = api.GetClient(clientId); - - // Update "client name". - client.ClientName = "My updated client"; - - api.UpdateClient(client); - - lang: php - label: PHP - source: | - $conf = ...; - $api = new AuthleteApiImpl($conf); - - // Get an existing client. - $clientId = ...; - $client = $api.getClient(clientId); - - // Update "client name". - $client.setClientName("My updated client"); - - $api.updateClient($client); - - lang: ruby - source: | - conf = ... - api = Authlete::Api.new(conf) - - # Get an existing client. - client_id = ... - client = api.client_get(client_id) - - # Update "client name". - client.client_name = 'My updated client' - - api.client_update(client) - lang: python source: | conf = ... @@ -2065,39 +1694,18 @@ paths: client.clientName = 'My updated client' api.updatedClient(client) - - lang: go - source: | - conf := ... - api := api.New(&conf) - - // Get an existing client. - clientId := ... - client, _ := api.GetClient(clientId) - - // Update "client name". - client.ClientName := "My updated client" - - api.UpdateClient(&client) - - lang: ts - label: deno - source: | - const conf: AuthleteConfiguration = ...; - const api: AuthleteApi = new AuthleteApiImpl(conf); - - // Get an existing client. - const clientId = ...; - const client = await api.getClient(clientId); - - // Update "client name". - client.clientName = 'My updated client'; - - await api.updateClient(client); - /api/client/delete/{clientId}: + /api/{serviceId}/client/delete/{clientId}: delete: description: | Delete a client. operationId: client_delete_api parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: + type: string - description: The client ID. in: path name: clientId @@ -2146,16 +1754,16 @@ paths: $ref: '#/components/schemas/result' description: "" security: - - ServiceCredentials: [] - summary: "/api/client/delete/{clientId} API" + - ModifyClient: [] + summary: "/api/{serviceId}/client/delete/{clientId} API" tags: - Client Management x-code-samples: - lang: shell label: curl source: | - curl -v -X DELETE https://api.authlete.com/api/client/delete/26478243745571 \ - -u '21653835348762:uE4NgqeIpuSV_XejQ7Ds3jsgA1yXhjR1MXJ1LbPuyls' + curl -v -X DELETE https://beta.authlete.com/api/21653835348762/client/delete/26478243745571 \ + -u 'Authorization: Bearer V5a40R6dWvw2gMkCOBFdZcM95q4HC0Z-T0YKD9-nR6F' - lang: java label: java source: | @@ -2165,32 +1773,6 @@ paths: long clientId = ...; api.deleteClient(clientId); - - lang: cs - label: C# - source: | - IAuthleteConfiguration conf = ...; - IAuthleteApi api = new AuthleteApi(conf); - - long clientId = ...; - - await api.DeleteClient(clientId); - - lang: php - label: PHP - source: | - $conf = ...; - $api = new AuthleteApiImpl($conf); - - $clientId = ...; - - $api.deleteClient($clientId); - - lang: ruby - source: | - conf = ... - api = Authlete::Api.new(conf) - - client_id = ... - - api.client_delete(client_id) - lang: python source: | conf = ... @@ -2199,29 +1781,18 @@ paths: clientId = ... api.deleteClient(clientId) - - lang: go - source: | - conf := ... - api := api.New(&conf) - - clientId := ... - - api.DeleteClient(clientId) - - lang: ts - label: deno - source: | - const conf: AuthleteConfiguration = ...; - const api: AuthleteApi = new AuthleteApiImpl(conf); - - const clientId = ... - - await api.deleteClient(clientId); - /api/client/lock_flag/update/{clientIdentifier}: + /api/{serviceId}/client/lock_flag/update/{clientIdentifier}: post: description: | Lock and unlock a client operationId: client_flag_update_api parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: + type: string - description: A client ID. in: path name: clientIdentifier @@ -2285,11 +1856,11 @@ paths: $ref: '#/components/schemas/result' description: "" security: - - ServiceCredentials: [] - summary: "/api/client/lock_flag/update/{clientIdentifier} API" + - ModifyClient: [] + summary: "/api/{serviceId}/client/lock_flag/update/{clientIdentifier} API" tags: - Client Management - /api/client/secret/refresh/{clientIdentifier}: + /api/{serviceId}/client/secret/refresh/{clientIdentifier}: get: description: | Refresh the client secret of a client. A new value of the client secret will be generated by the @@ -2298,6 +1869,12 @@ paths: If you want to specify a new value, use `/api/client/secret/update` API. operationId: client_secret_refresh_api parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: + type: string - description: | The client ID or the client ID alias of a client. in: path @@ -2357,16 +1934,16 @@ paths: $ref: '#/components/schemas/result' description: "" security: - - ServiceCredentials: [] - summary: /api/client/secret/refresh API + - ModifyClient: [] + summary: "/api/{serviceId}/client/secret/refresh API" tags: - Client Management x-code-samples: - lang: shell label: curl source: | - curl -v https://api.authlete.com/api/client/secret/refresh/26478243745571 \ - -u '21653835348762:uE4NgqeIpuSV_XejQ7Ds3jsgA1yXhjR1MXJ1LbPuyls' + curl -v https://beta.authlete.com/api/21653835348762/client/secret/refresh/26478243745571 \ + -u 'Authorization: Bearer V5a40R6dWvw2gMkCOBFdZcM95q4HC0Z-T0YKD9-nR6F' - lang: java label: java source: | @@ -2376,32 +1953,6 @@ paths: String clientIdentifier = ...; api.refreshClientSecret(clientIdentifier); - - lang: cs - label: C# - source: | - IAuthleteConfiguration conf = ...; - IAuthleteApi api = new AuthleteApi(conf); - - string clientIdentifier = ...; - - await api.RefreshClientSecret(clientIdentifier); - - lang: php - label: PHP - source: | - $conf = ...; - $api = new AuthleteApiImpl($conf); - - $clientIdentifier = ...; - - $api.refreshClientSecret($clientIdentifier); - - lang: ruby - source: | - conf = ... - api = Authlete::Api.new(conf) - - client_identifier = ... - - api.refresh_client_secret(client_identifier) - lang: python source: | conf = ... @@ -2410,19 +1961,7 @@ paths: clientIdentifier = ... api.refreshClientSecret(clientIdentifier) - - lang: go - source: | - conf = ... - api = AuthleteApiImpl(conf) - - clientIdentifier = ... - - api.refreshClientSecret(clientIdentifier) - - lang: ts - label: deno - source: | - // This API is not supported yet. - /api/client/secret/update/{clientIdentifier}: + /api/{serviceId}/client/secret/update/{clientIdentifier}: post: description: | Update the client secret of a client. @@ -2431,6 +1970,12 @@ paths: API. operationId: client_secret_update_api parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: + type: string - description: | The client ID or the client ID alias of a client. in: path @@ -2501,17 +2046,17 @@ paths: $ref: '#/components/schemas/result' description: "" security: - - ServiceCredentials: [] - summary: /api/client/secret/update API + - ModifyCilent: [] + summary: "/api/{serviceId}/client/secret/update API" tags: - Client Management x-code-samples: - lang: shell label: curl source: | - curl -v https://api.authlete.com/api/client/secret/update/26478243745571 \ - -u '21653835348762:uE4NgqeIpuSV_XejQ7Ds3jsgA1yXhjR1MXJ1LbPuyls' \ + curl -v https://beta.authlete.com/api/21653835348762/client/secret/update/26478243745571 \ -H 'Content-Type:application/json' \ + -u 'Authorization: Bearer V5a40R6dWvw2gMkCOBFdZcM95q4HC0Z-T0YKD9-nR6F' \ -d '{ "clientSecret": "..." }' - lang: java label: java @@ -2523,35 +2068,6 @@ paths: String clientSecret = "my_updated_client_secret"; api.updateClientSecret(clientIdentifier, clientSecret); - - lang: cs - label: C# - source: | - IAuthleteConfiguration conf = ...; - IAuthleteApi api = new AuthleteApi(conf); - - string clientIdentifier = ...; - string clientSecret = "my_new_client_secret"; - - await api.UpdateClientSecret(clientIdentifier, clientSecret); - - lang: php - label: PHP - source: | - $conf = ...; - $api = new AuthleteApiImpl($conf); - - $clientIdentifier = ...; - $clientSecret = "my_new_client_secret"; - - $api.updateClientSecret($clientIdentifier, $clientSecret); - - lang: ruby - source: | - conf = ... - api = Authlete::Api.new(conf) - - client_identifier = ... - client_secret = 'my_new_client_secret' - - api.update_client_secret(client_identifier, client_secret) - lang: python source: | conf = ... @@ -2561,20 +2077,7 @@ paths: clientSecret = 'my_new_client_secret' api.updateClientSecret(clientIdentifier, clientSecret) - - lang: go - source: | - conf := ... - api := api.New(&conf) - - clientIdentifier := ... - clientSecret := "my_new_client_secret" - - api.UpdateClientSecret(clientIdentifier, clientSecret) - - lang: ts - label: deno - source: | - // This API is not supported yet. - /api/client/authorization/get/list: + /api/{serviceId}/client/authorization/get/list: get: description: | Get a list of client applications that an end-user has authorized. @@ -2582,6 +2085,12 @@ paths: The subject parameter is required and can be provided either in the path or as a query parameter. operationId: client_authorization_get_list_api parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: + type: string - description: | Unique user ID of an end-user. in: path @@ -2625,46 +2134,12 @@ paths: application/json: example: clients: - - applicationType: WEB - attributes: - - key: attribute1-key - value: attribute1-value - - key: attribute2-key - value: attribute2-value - authTimeRequired: false - bcUserCodeRequired: false - clientId: 26478243745571 + - clientId: 26478243745571 clientIdAlias: my-client clientIdAliasEnabled: true clientName: My client - clientSecret: gXz97ISgLs4HuXwOZWch8GEmgL4YMvUJwu3er_kDVVGcA0UOhA9avLPbEmoeZdagi9yC_-tEiT2BdRyH9dbrQQ clientType: CONFIDENTIAL - createdAt: 1639468356000 - defaultMaxAge: 0 - derivedSectorIdentifier: my-client.example.com - developer: john - dynamicallyRegistered: false - frontChannelRequestObjectEncryptionRequired: false - grantTypes: - - AUTHORIZATION_CODE - - REFRESH_TOKEN - idTokenSignAlg: RS256 - modifiedAt: 1639468356000 number: 6164 - parRequired: false - redirectUris: - - https://my-client.example.com/cb1 - - https://my-client.example.com/cb2 - requestObjectEncryptionAlgMatchRequired: false - requestObjectEncryptionEncMatchRequired: false - requestObjectRequired: false - responseTypes: - - CODE - - TOKEN - serviceNumber: 5041 - subjectType: PUBLIC - tlsClientCertificateBoundAccessTokens: false - tokenAuthMethod: CLIENT_SECRET_BASIC end: 5 start: 0 subject: john @@ -2711,15 +2186,15 @@ paths: $ref: '#/components/schemas/result' description: "" security: - - ServiceCredentials: [] - summary: "/api/client/authorization/get/list/{subject} API" + - ModifyClient: [] + summary: "/api/{serviceId}/client/authorization/get/list/{subject} API" tags: - Client Management x-code-samples: - lang: shell label: curl source: | - curl -v https://api.authlete.com/api/client/authorization/get/list/john?start=0\&end=5 \ + curl -v https://beta.authlete.com/api/client/authorization/get/list/john?start=0\&end=5 \ -u '21653835348762:uE4NgqeIpuSV_XejQ7Ds3jsgA1yXhjR1MXJ1LbPuyls' - lang: java label: java @@ -2733,41 +2208,6 @@ paths: req.setEnd(5); api.getClientAuthorizationList(req); - - lang: cs - label: C# - source: | - IAuthleteConfiguration conf = new AuthletePropertiesConfiguration(); - IAuthleteApi api = new AuthleteApi(conf); - - ClientAuthorizationGetListRequest req = new ClientAuthorizationGetListRequest(); - req.Subject = "john"; - req.Start = 0; - req.End = 5; - - await api.GetClientAuthorizationList(req); - - lang: php - label: PHP - source: | - $conf = ...; - $api = new AuthleteApiImpl($conf); - - $req = new ClientAuthorizationGetListRequest(); - $req.setSubject("john"); - $req.setStart(0); - $req.setEnd(5); - - $api.getClientAuthorizationList($req); - - lang: ruby - source: | - conf = ... - api = Authlete::Api.new(conf) - - req = Authlete::Model::Request::ClientAuthorizationGetListRequest.new - req.subject = 'john' - req.start = 0 - req.end = 5 - - api.get_client_authorization_list(req) - lang: python source: | conf = ... @@ -2779,27 +2219,18 @@ paths: req.end = 5 api.getClientAuthorizationList(req) - - lang: go - source: | - conf := ... - api := api.New(&conf) - - req := dto.ClientAuthorizationGetListRequest{} - req.Subject = "john" - req.Start = 0 - req.End = 5 - - api.GetClientAuthorizationList(&req) - - lang: ts - label: deno - source: | - // This API is not supported yet. - /api/client/authorization/update/{clientId}: + /api/{serviceId}/client/authorization/update/{clientId}: post: description: | Update attributes of all existing access tokens given to a client application. operationId: client_authorization_update_api parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: + type: string - description: | A client ID. in: path @@ -2870,17 +2301,17 @@ paths: $ref: '#/components/schemas/result' description: "" security: - - ServiceCredentials: [] - summary: "/api/client/authorization/update/{clientId} API" + - ModifyClient: [] + summary: "/api/{serviceId}/client/authorization/update/{clientId} API" tags: - Client Management x-code-samples: - lang: shell label: curl source: | - curl -v -X POST https://api.authlete.com/api/client/authorization/update/26478243745571 \ + curl -v -X POST https://beta.authlete.com/api/21653835348762/client/authorization/update/26478243745571 \ -H 'Content-Type:application/json' \ - -u '21653835348762:uE4NgqeIpuSV_XejQ7Ds3jsgA1yXhjR1MXJ1LbPuyls' \ + -u 'Authorization: Bearer V5a40R6dWvw2gMkCOBFdZcM95q4HC0Z-T0YKD9-nR6F' \ -d '{ "subject": "john", "scopes": [ "history.read" ] }' - lang: java label: java @@ -2895,44 +2326,6 @@ paths: req.setScopes(new String[]{ "history.read" }); api.updateClientAuthorization(clientId, req); - - lang: cs - label: C# - source: | - IAuthleteConfiguration conf = ...; - IAuthleteApi api = new AuthleteApi(conf); - - long clientId = ...; - - ClientAuthorizationUpdateRequest req = new ClientAuthorizationUpdateRequest(); - req.Subject = "john"; - req.Scopes = { "history.read" }; - - await api.UpdateClientAuthorization(clientId, req); - - lang: php - label: PHP - source: | - $conf = ...; - $api = new AuthleteApiImpl($conf); - - $clientId = ...; - - $req = new ClientAuthorizationUpdateRequest(); - $req.subject = "john"; - $req.setScopes([ "history.read" ]); - - $api.updateClientAuthorization($clientId, $req); - - lang: ruby - source: | - conf = ... - api = Authlete::Api.new(conf) - - client_id = ... - - req = Authlete::Model::Request::ClientAuthorizationUpdateRequest.new - req.subject = 'john' - req.scopes = [ 'history.read' ] - - api.update_client_authorization(client_id, req) - lang: python source: | conf = ... @@ -2945,23 +2338,7 @@ paths: req.scopes = [ 'history.read' ] api.updateClientAuthorization(clientId, req) - - lang: go - source: | - conf := ... - api := api.New(&conf) - - clientId := ... - - req := dto.ClientAuthorizationUpdateRequest{} - req.Subject = "john" - req.Scopes = [1]string{ "history.read" } - - api.UpdateClientAuthorization(clientId, &req) - - lang: ts - label: deno - source: | - // This API is not supported yet. - /api/client/authorization/delete/{clientId}: + /api/{serviceId}/client/authorization/delete/{clientId}: delete: description: | Delete all existing access tokens issued to a client application by an end-user. @@ -2969,6 +2346,12 @@ paths: The subject parameter is required and can be provided either in the path or as a query parameter. operationId: client_authorization_delete_api parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: + type: string - description: | A client ID. in: path @@ -3040,16 +2423,17 @@ paths: $ref: '#/components/schemas/result' description: "" security: - - ServiceCredentials: [] - summary: "/api/client/authorization/delete/{clientId}/{subject} API" + - ModifyClient: [] + summary: "/api/{serviceId}/client/authorization/delete/{clientId}/{subject}\ + \ API" tags: - Client Management x-code-samples: - lang: shell label: curl source: | - curl -v -X DELETE https://api.authlete.com/api/client/authorization/delete/26478243745571/john \ - -u '21653835348762:uE4NgqeIpuSV_XejQ7Ds3jsgA1yXhjR1MXJ1LbPuyls' + curl -v -X DELETE https://beta.authlete.com/api/21653835348762/client/authorization/delete/26478243745571/john \ + -u 'Authorization: Bearer V5a40R6dWvw2gMkCOBFdZcM95q4HC0Z-T0YKD9-nR6F' - lang: java label: java source: | @@ -3060,35 +2444,6 @@ paths: String subject = "john"; api.deleteClientAuthorization(clientId, subject); - - lang: cs - label: C# - source: | - IAuthleteConfiguration conf = ...; - IAuthleteApi api = new AuthleteApi(conf); - - long clientId = ...; - string subject = "john"; - - await api.DeleteClientAuthorization(clientId, subject); - - lang: php - label: PHP - source: | - $conf = ...; - $api = new AuthleteApiImpl($conf); - - $clientId = ...; - $subject = "john"; - - $api.deleteClientAuthorization($clientId, $subject); - - lang: ruby - source: | - conf = ... - api = Authlete::Api.new(conf) - - client_id = ... - subject = 'john' - - api.delete_client_authorization(client_id, subject) - lang: python source: | conf = ... @@ -3098,20 +2453,7 @@ paths: subject = 'john' api.deleteClientAuthorization(clientId, subject) - - lang: go - source: | - conf := ... - api := api.New(&conf) - - clientId := ... - subject := "john" - - api.DeleteClientAuthorization(clientId, subject) - - lang: ts - label: deno - source: | - // This API is not supported yet. - /api/client/granted_scopes/get/{clientId}: + /api/{serviceId}/client/granted_scopes/get/{clientId}: get: description: | Get the set of scopes that a user has granted to a client application. @@ -3142,10 +2484,16 @@ paths: operationId: client_granted_scopes_get_api parameters: - - description: | - A client ID. + - description: A service ID. in: path - name: clientId + name: serviceId + required: true + schema: + type: string + - description: | + A client ID. + in: path + name: clientId required: true schema: type: string @@ -3168,6 +2516,7 @@ paths: content: application/json: example: + type: GrantedScopesGetResponse serviceApiKey: 21653835348762 clientId: 26478243745571 subject: john @@ -3177,7 +2526,7 @@ paths: - history.read - timeline.read schema: - $ref: '#/components/schemas/client_granted_scopes_get_response' + $ref: '#/components/schemas/client_authorization_delete_response' description: "" "400": content: @@ -3218,16 +2567,16 @@ paths: $ref: '#/components/schemas/result' description: "" security: - - ServiceCredentials: [] - summary: "/api/client/granted_scopes/get/{clientId}/{subject} API" + - ViewClient: [] + summary: "/api/{serviceId}/client/granted_scopes/get/{clientId}/{subject} API" tags: - Client Management x-code-samples: - lang: shell label: curl source: | - curl -v https://api.authlete.com/api/client/granted_scopes/get/26478243745571/john \ - -u '21653835348762:uE4NgqeIpuSV_XejQ7Ds3jsgA1yXhjR1MXJ1LbPuyls' + curl -v https://beta.authlete.com/api/21653835348762/client/granted_scopes/get/26478243745571/john \ + -u 'Authorization: Bearer V5a40R6dWvw2gMkCOBFdZcM95q4HC0Z-T0YKD9-nR6F' - lang: java label: java source: | @@ -3238,35 +2587,6 @@ paths: String subject = "john"; api.getGrantedScopes(clientId, subject); - - lang: cs - label: C# - source: | - IAuthleteConfiguration conf = ...; - IAuthleteApi api = new AuthleteApi(conf); - - long clientId = 26478243745571; - string subject = "john"; - - await api.GetGrantedScopes(clientId, subject); - - lang: php - label: PHP - source: | - $conf = ...; - $api = new AuthleteApiImpl($conf); - - $clientId = 26478243745571; - $subject = "john"; - - $api.getGrantedScopes($clientId, $subject); - - lang: ruby - source: | - conf = ... - api = Authlete::Api.new(conf) - - client_id = 26478243745571 - subject = 'john' - - api.get_granted_scopes(client_id, subject) - lang: python source: | conf = ... @@ -3276,20 +2596,7 @@ paths: subject = 'john' api.getGrantedScopes(clientId, subject) - - lang: go - source: | - conf := ... - api := api.New(&conf) - - clientId := 26478243745571 - subject := "john" - - api.GetGrantedScopes(clientId, subject) - - lang: ts - label: deno - source: | - // This API is not supported yet. - /api/client/granted_scopes/delete/{clientId}: + /api/{serviceId}/client/granted_scopes/delete/{clientId}: delete: description: | Delete the set of scopes that an end-user has granted to a client application. @@ -3305,6 +2612,12 @@ paths: The subject parameter is required and can be provided either in the path or as a query parameter. operationId: client_granted_scopes_delete_api parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: + type: string - description: | A client ID. in: path @@ -3372,16 +2685,17 @@ paths: $ref: '#/components/schemas/result' description: "" security: - - ServiceCredentials: [] - summary: "/api/client/granted_scopes/delete/{clientId}/{subject} API" + - ModifyClient: [] + summary: "/api/{serviceId}/client/granted_scopes/delete/{clientId}/{subject}\ + \ API" tags: - Client Management x-code-samples: - lang: shell label: curl source: | - curl -v -X DELETE https://api.authlete.com/api/client/granted_scopes/delete/26478243745571/john \ - -u '21653835348762:uE4NgqeIpuSV_XejQ7Ds3jsgA1yXhjR1MXJ1LbPuyls' + curl -v -X DELETE https://beta.authlete.com/api/21653835348762/client/granted_scopes/delete/26478243745571/john \ + -u 'Authorization: Bearer V5a40R6dWvw2gMkCOBFdZcM95q4HC0Z-T0YKD9-nR6F' - lang: java label: java source: | @@ -3392,35 +2706,6 @@ paths: String subject = "john"; api.deleteGrantedScopes(clientId, subject); - - lang: cs - label: C# - source: | - IAuthleteConfiguration conf = ...; - IAuthleteApi api = new AuthleteApi(conf); - - long clientId = ...; - string subject = "john"; - - await api.DeleteGrantedScopes(clientId, subject); - - lang: php - label: PHP - source: | - $conf = ...; - $api = new AuthleteApiImpl($conf); - - $clientId = ...; - $subject = "john"; - - $api.deleteGrantedScopes($clientId, $subject); - - lang: ruby - source: | - conf = ... - api = Authlete::Api.new(conf) - - client_id = ... - subject = 'john' - - api.delete_granted_scopes(client_id, subject) - lang: python source: | conf = ... @@ -3430,20 +2715,7 @@ paths: subject = 'john' api.deleteGrantedScopes(clientId, subject) - - lang: go - source: | - conf := ... - api := api.New(&conf) - - clientId := ... - subject := "john" - - api.DeleteGrantedScopes(clientId, subject) - - lang: ts - label: deno - source: | - // This API is not supported yet. - /api/auth/authorization: + /api/{serviceId}/auth/authorization: post: description: | This API parses request parameters of an authorization request and returns necessary data for the authorization server @@ -3980,6 +3252,13 @@ paths: above in the description for the case of `action=NO_INTERACTION`. operationId: auth_authorization_api + parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: + type: string requestBody: content: application/json: @@ -4004,46 +3283,12 @@ paths: acrEssential: false action: INTERACTION client: - applicationType: WEB - attributes: - - key: attribute1-key - value: attribute1-value - - key: attribute2-key - value: attribute2-value - authTimeRequired: false - bcUserCodeRequired: false clientId: 26478243745571 clientIdAlias: my-client clientIdAliasEnabled: true clientName: My updated client - clientSecret: my_updated_client_secret - clientType: CONFIDENTIAL - createdAt: 1639468356000 - defaultMaxAge: 0 - derivedSectorIdentifier: my-client.example.com - developer: john - dynamicallyRegistered: false - frontChannelRequestObjectEncryptionRequired: false - grantTypes: - - AUTHORIZATION_CODE - - REFRESH_TOKEN - idTokenSignAlg: RS256 - modifiedAt: 1639560232000 + logo_uri: https://my-client.example.com/logo.png number: 6164 - parRequired: false - redirectUris: - - https://my-client.example.com/cb1 - - https://my-client.example.com/cb2 - requestObjectEncryptionAlgMatchRequired: false - requestObjectEncryptionEncMatchRequired: false - requestObjectRequired: false - responseTypes: - - CODE - - TOKEN - serviceNumber: 5041 - subjectType: PUBLIC - tlsClientCertificateBoundAccessTokens: false - tokenAuthMethod: CLIENT_SECRET_BASIC clientIdAliasUsed: false display: PAGE maxAge: 0 @@ -4055,97 +3300,10 @@ paths: description: A permission to read your timeline. name: timeline.read service: - accessTokenDuration: 3600 - accessTokenType: Bearer - allowableClockSkew: 0 apiKey: 21653835348762 - apiSecret: uE4NgqeIpuSV_XejQ7Ds3jsgA1yXhjR1MXJ1LbPuyls - attributes: - - key: attribute1-key - value: attribute1-value - - key: attribute2-key - value: attribute2-value - authorizationEndpoint: https://my-service.example.com/authz - authorizationResponseDuration: 0 - backchannelAuthReqIdDuration: 0 - backchannelBindingMessageRequiredInFapi: false - backchannelPollingInterval: 0 - backchannelUserCodeParameterSupported: false - claimShortcutRestrictive: false clientIdAliasEnabled: true - clientsPerDeveloper: 0 - createdAt: 1639373421000 - dcrScopeUsedAsRequestable: false - deviceFlowCodeDuration: 0 - deviceFlowPollingInterval: 0 - directAuthorizationEndpointEnabled: false - directIntrospectionEndpointEnabled: false - directJwksEndpointEnabled: false - directRevocationEndpointEnabled: false - directTokenEndpointEnabled: false - directUserInfoEndpointEnabled: false - dynamicRegistrationSupported: false - errorDescriptionOmitted: false - errorUriOmitted: false - frontChannelRequestObjectEncryptionRequired: false - grantManagementActionRequired: false - hsmEnabled: false - idTokenDuration: 0 - introspectionEndpoint: https://my-service.example.com/introspection - issSuppressed: false - issuer: https://my-service.example.com - metadata: - - key: clientCount - value: "1" - missingClientIdAllowed: false - modifiedAt: 1639559308000 - mutualTlsValidatePkiCertChain: false - nbfOptional: false number: 5041 - parRequired: false - pkceRequired: true - pkceS256Required: false - pushedAuthReqDuration: 0 - refreshTokenDuration: 3600 - refreshTokenDurationKept: false - refreshTokenDurationReset: false - refreshTokenKept: false - requestObjectEncryptionAlgMatchRequired: false - requestObjectEncryptionEncMatchRequired: false - requestObjectRequired: false - revocationEndpoint: https://my-service.example.com/revocation - scopeRequired: false serviceName: My updated service - serviceOwnerNumber: 2 - singleAccessTokenPerSubject: false - supportedClaimTypes: - - NORMAL - supportedDisplays: - - PAGE - supportedGrantTypes: - - AUTHORIZATION_CODE - - REFRESH_TOKEN - supportedIntrospectionAuthMethods: - - CLIENT_SECRET_BASIC - supportedResponseTypes: - - CODE - supportedRevocationAuthMethods: - - CLIENT_SECRET_BASIC - supportedScopes: - - defaultEntry: false - description: A permission to read your history. - name: history.read - - defaultEntry: false - description: A permission to read your timeline. - name: timeline.read - supportedTokenAuthMethods: - - CLIENT_SECRET_BASIC - tlsClientCertificateBoundAccessTokens: false - tokenEndpoint: https://my-service.example.com/token - tokenExpirationLinked: false - traditionalRequestObjectProcessingApplied: false - unauthorizedOnClientConfigSupported: false - userCodeLength: 0 ticket: hXoY87t_t23enrVHWxpXNP5FfVDhDypD3T6H6lt4IPA schema: $ref: '#/components/schemas/authorization_response' @@ -4189,17 +3347,17 @@ paths: $ref: '#/components/schemas/result' description: "" security: - - ServiceCredentials: [] - summary: /api/auth/authorization API + - UseService: [] + summary: "/api/{serviceId}/auth/authorization API" tags: - Authorization Endpoint x-code-samples: - lang: shell label: curl source: | - curl -v -X POST https://api.authlete.com/api/auth/authorization \ + curl -v -X POST https://beta.authlete.com/api/21653835348762/auth/authorization \ -H 'Content-Type: application/json' \ - -u '21653835348762:uE4NgqeIpuSV_XejQ7Ds3jsgA1yXhjR1MXJ1LbPuyls' \ + -u 'Authorization: Bearer V5a40R6dWvw2gMkCOBFdZcM95q4HC0Z-T0YKD9-nR6F' \ -d '{ "parameters": "response_type=code&client_id=26478243745571&redirect_uri=https%3A%2F%2Fmy-client.example.com%2Fcb1&scope=timeline.read+history.read&code_challenge=E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM&code_challenge_method=S256" }' - lang: java label: java @@ -4211,35 +3369,6 @@ paths: req.setParameters(...); api.authorization(req); - - lang: cs - label: C# - source: | - IAuthleteConfiguration conf = ...; - IAuthleteApi api = new AuthleteApi(conf); - - AuthorizationRequest req = new AuthorizationRequest(); - req.Parameters = ...; - - await api.Authorization(req); - - lang: php - label: PHP - source: | - $conf = ...; - $api = new AuthleteApiImpl($conf); - - $req = new AuthorizationRequest(); - $req.setParameters(...); - - $api.authorization($req); - - lang: ruby - source: | - conf = ... - api = Authlete::Api.new(conf) - - req = Authlete::Model::Request::AuthorizationRequest.new - req.parameters = '...' - - api.authorization(req) - lang: python source: | conf = ... @@ -4249,26 +3378,7 @@ paths: req.parameters = ... api.authorization(req) - - lang: go - source: | - conf := ... - api := api.New(&conf) - - req := dto.AuthorizationRequest{} - req.Parameters = ... - - api.Authorization(&req) - - lang: ts - label: deno - source: | - const conf: AuthleteConfiguration = ...; - const api: AuthleteApi = new AuthleteApiImpl(conf); - - const req = new AuthorizationRequest(); - req.parameters = ...; - - await api.authorization(req); - /api/auth/authorization/fail: + /api/{serviceId}/auth/authorization/fail: post: description: | This API generates a content of an error authorization response that the authorization server implementation @@ -4382,6 +3492,13 @@ paths: ``` operationId: auth_authorization_fail_api + parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: + type: string requestBody: content: application/json: @@ -4449,17 +3566,17 @@ paths: $ref: '#/components/schemas/result' description: "" security: - - ServiceCredentials: [] - summary: /api/auth/authorization/fail API + - UseService: [] + summary: "/api/{serviceId}/auth/authorization/fail API" tags: - Authorization Endpoint x-code-samples: - lang: shell label: curl source: | - curl -v -X POST https://api.authlete.com/api/auth/authorization/fail \ + curl -v -X POST https://beta.authlete.com/api/21653835348762/auth/authorization/fail \ -H 'Content-Type: application/json' \ - -u '21653835348762:uE4NgqeIpuSV_XejQ7Ds3jsgA1yXhjR1MXJ1LbPuyls' \ + -u 'Authorization: Bearer V5a40R6dWvw2gMkCOBFdZcM95q4HC0Z-T0YKD9-nR6F' \ -d '{ "ticket": "c4iy3TWGn74UMO7ihRl0ZS8OEUzV9axBlBbJbqxH-9Q", "reason": "NOT_AUTHENTICATED" }' - lang: java label: java @@ -4472,38 +3589,6 @@ paths: req.setReason(AuthorizationFailRequest.Reason.NOT_AUTHENTICATED); api.authorizationFail(req); - - lang: cs - label: C# - source: | - IAuthleteConfiguration conf = ...; - IAuthleteApi api = new AuthleteApi(conf); - - AuthorizationFailRequest req = new AuthorizationFailRequest(); - req.Ticket = "c4iy3TWGn74UMO7ihRl0ZS8OEUzV9axBlBbJbqxH-9Q"; - req.Reason = AuthorizationFailReason.NOT_AUTHENTICATED; - - await api.AuthorizationFail(req); - - lang: php - label: PHP - source: | - $conf = ...; - $api = new AuthleteApiImpl($conf); - - $req = new AuthorizationFailRequest(); - $req.setTicket("c4iy3TWGn74UMO7ihRl0ZS8OEUzV9axBlBbJbqxH-9Q"); - $req.setReason(AuthorizationFailReason.$NOT_AUTHENTICATED); - - $api.authorizationFail($req); - - lang: ruby - source: | - conf = ... - api = Authlete::Api.new(conf) - - req = Authlete::Model::Request::AuthorizationFailRequest.new - req.ticket = 'c4iy3TWGn74UMO7ihRl0ZS8OEUzV9axBlBbJbqxH-9Q' - req.reason = 'NOT_AUTHENTICATED' - - api.authorization_fail(req) - lang: python source: | conf = ... @@ -4514,28 +3599,7 @@ paths: req.reason = AuthorizationFailReason.NOT_AUTHENTICATED api.authorizationFail(req) - - lang: go - source: | - conf := ... - api := api.New(&conf) - - req := dto.AuthorizationFailRequest{} - req.Ticket = "c4iy3TWGn74UMO7ihRl0ZS8OEUzV9axBlBbJbqxH-9Q" - req.Reason = AuthorizationFailReason.NOT_AUTHENTICATED - - api.AuthorizationFail(&req) - - lang: ts - label: deno - source: | - const conf: AuthleteConfiguration = ...; - const api: AuthleteApi = new AuthleteApiImpl(conf); - - const req = new AuthorizationFailRequest(); - req.ticket = 'c4iy3TWGn74UMO7ihRl0ZS8OEUzV9axBlBbJbqxH-9Q'; - req.reason = AuthorizationFailRequest.Reason.NOT_AUTHENTICATED; - - await api.authorizationFail(req); - /api/auth/authorization/issue: + /api/{serviceId}/auth/authorization/issue: post: description: | This API parses request parameters of an authorization request and returns necessary data for the @@ -4652,6 +3716,13 @@ paths: ``` operationId: auth_authorization_issue_api + parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: + type: string requestBody: content: application/json: @@ -4719,17 +3790,17 @@ paths: $ref: '#/components/schemas/result' description: "" security: - - ServiceCredentials: [] - summary: /api/auth/authorization/issue API + - UseService: [] + summary: "/api/{serviceId}/auth/authorization/issue API" tags: - Authorization Endpoint x-code-samples: - lang: shell label: curl source: | - curl -v -X POST https://api.authlete.com/api/auth/authorization/issue \ + curl -v -X POST https://beta.authlete.com/api/21653835348762/auth/authorization/issue \ -H 'Content-Type: application/json' \ - -u '21653835348762:uE4NgqeIpuSV_XejQ7Ds3jsgA1yXhjR1MXJ1LbPuyls' \ + -u 'Authorization: Bearer V5a40R6dWvw2gMkCOBFdZcM95q4HC0Z-T0YKD9-nR6F' \ -d '{ "ticket": "FFgB9gwb_WXh6g1u-UQ8ZI-d_k4B-o-cm7RkVzI8Vnc", "subject": "john" }' - lang: java label: java @@ -4742,38 +3813,6 @@ paths: req.setSubject("john"); api.authorizationIssue(req); - - lang: cs - label: C# - source: | - IAuthleteConfiguration conf = new AuthletePropertiesConfiguration(); - IAuthleteApi api = new AuthleteApi(conf); - - AuthorizationIssueRequest req = new AuthorizationIssueRequest(); - req.Ticket = "FFgB9gwb_WXh6g1u-UQ8ZI-d_k4B-o-cm7RkVzI8Vnc"; - req.Subject = "john"; - - await api.AuthorizationIssue(req); - - lang: php - label: PHP - source: | - $conf = ...; - $api = new AuthleteApiImpl($conf); - - $req = new AuthorizationIssueRequest(); - $req.setTicket("FFgB9gwb_WXh6g1u-UQ8ZI-d_k4B-o-cm7RkVzI8Vnc"); - $req.setSubject("john"); - - $api.authorizationIssue($req); - - lang: ruby - source: | - conf = ... - api = Authlete::Api.new(conf) - - req = Authlete::Model::Request::AuthorizationIssueRequest.new - req.ticket = 'FFgB9gwb_WXh6g1u-UQ8ZI-d_k4B-o-cm7RkVzI8Vnc' - req.subject = 'john' - - api.authorization_issue(req) - lang: python source: | conf = ... @@ -4784,32 +3823,18 @@ paths: req.subject = 'john' api.authorizationIssue(req) - - lang: go - source: | - conf := ... - api := api.New(&conf) - - req := dto.AuthorizationIssueRequest{} - req.Ticket = "FFgB9gwb_WXh6g1u-UQ8ZI-d_k4B-o-cm7RkVzI8Vnc" - req.Subject = "john" - - api.AuthorizationIssue(&req) - - lang: ts - label: deno - source: | - const conf: AuthleteConfiguration = ...; - const api: AuthleteApi = new AuthleteApiImpl(conf); - - const req = new AuthorizationIssueRequest(); - req.ticket = 'FFgB9gwb_WXh6g1u-UQ8ZI-d_k4B-o-cm7RkVzI8Vnc'; - req.subjec = 'john'; - - await api.authorizationIssue(req); - /api/pushed_auth_req: + /api/{serviceId}/pushed_auth_req: post: description: | This API creates a pushed request authorization. It authenticates the client and creates a authorization_uri to be returned by the authorization server. operationId: pushed_auth_req_api + parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: + type: string requestBody: content: application/json: @@ -4881,17 +3906,17 @@ paths: $ref: '#/components/schemas/result' description: "" security: - - ServiceCredentials: [] - summary: /api/pushed_auth_req API + - UseService: [] + summary: "/api/{serviceId}/pushed_auth_req API" tags: - Pushed Authorization Endpoint x-code-samples: - lang: shell label: curl source: | - curl -v -X POST https://api.authlete.com/api/pushed_auth_req \ + curl -v -X POST https://beta.authlete.com/api/21653835348762/pushed_auth_req \ -H 'Content-Type: application/json' \ - -u '21653835348762:uE4NgqeIpuSV_XejQ7Ds3jsgA1yXhjR1MXJ1LbPuyls' \ + -u 'Authorization: Bearer V5a40R6dWvw2gMkCOBFdZcM95q4HC0Z-T0YKD9-nR6F' \ -d '{ "parameters": "response_type=code%20id_token&client_id=5921531358155430&redirect_uri=https%3A%2F%2Fserver.example.com%2Fcb&state=SOME_VALUE_ABLE_TO_PREVENT_CSRF&scope=openid&nonce=SOME_VALUE_ABLE_TO_PREVENT_REPLAY_ATTACK&code_challenge=5ZWDQJiryK3eaLtSeFV8y1XySMCWtyITxICLaTwvK8g&code_challenge_method=S256", "clientId": "5921531358155430", "clientSecret" : "P_FouxWlI7zcOep_9vBwR9qMAVJQiCiUiK1HrAP4GziOyezHQpqY0f5dHXK4JT4tnvI51OkbWVoEM9GnOyJViA"}' - lang: java label: java @@ -4905,41 +3930,6 @@ paths: req.setClientSecret("J_3C7P0nDTP7CwCg_HyPQh7bTQ1696CC8GWot-EjesZmdBiU5Gsidq5Ve3tMaN2x2_VcKV1UE1U3ZdGKRuTs7A"); api.token(req); - - lang: cs - label: C# - source: | - AuthleteConfiguration conf = ...; - AuthleteApi api = AuthleteApiFactory.create(conf); - - PushedAuthReqRequest req = new PushedAuthReqRequest(); - req.setParameters(...); - req.setClientId("57297408867"); - req.setClientSecret("J_3C7P0nDTP7CwCg_HyPQh7bTQ1696CC8GWot-EjesZmdBiU5Gsidq5Ve3tMaN2x2_VcKV1UE1U3ZdGKRuTs7A"); - - api.token(req); - - lang: php - label: PHP - source: | - $conf = ...; - $api = new AuthleteApiImpl($conf); - - $req = new PushedAuthReqRequest(); - $req.setParameters(...); - $req.setClientId("57297408867"); - $req.setClientSecret("J_3C7P0nDTP7CwCg_HyPQh7bTQ1696CC8GWot-EjesZmdBiU5Gsidq5Ve3tMaN2x2_VcKV1UE1U3ZdGKRuTs7A"); - - $api.token($req); - - lang: ruby - source: | - conf = ... - api = Authlete::Api.new(conf) - - req = Authlete::Model::Request::PushedAuthReqRequest.new - req.parameters = '...' - req.client_id = '57297408867' - req.client_secret = 'J_3C7P0nDTP7CwCg_HyPQh7bTQ1696CC8GWot-EjesZmdBiU5Gsidq5Ve3tMaN2x2_VcKV1UE1U3ZdGKRuTs7A' - - api.token(req) - lang: python source: | conf = ... @@ -4951,549 +3941,365 @@ paths: req.clientSecret = 'J_3C7P0nDTP7CwCg_HyPQh7bTQ1696CC8GWot-EjesZmdBiU5Gsidq5Ve3tMaN2x2_VcKV1UE1U3ZdGKRuTs7A' api.token(req) - - lang: go - source: | - conf := ... - api := api.New(&conf) + /api/{serviceId}/auth/token: + post: + description: | + This API parses request parameters of an authorization request and returns necessary data for the + authorization server implementation to process the authorization request further. - req := dto.PushedAuthReqRequest{} - req.Parameters = ... - req.ClientId = "57297408867" - req.ClientSecret = "J_3C7P0nDTP7CwCg_HyPQh7bTQ1696CC8GWot-EjesZmdBiU5Gsidq5Ve3tMaN2x2_VcKV1UE1U3ZdGKRuTs7A" +
+
+ Description - api.Token(&req) - - lang: ts - label: deno - source: | - const conf: AuthleteConfiguration = ...; - const api: AuthleteApi = new AuthleteApiImpl(conf); + This API is supposed to be called from with the implementation of the token endpoint of the service. + The endpoint implementation must extract the request parameters from the token request from the + client application and pass them as the value of parameters request parameter to Authlete's `/auth/token` API. + The value of parameters is the entire entity body (which is formatted in `application/x-www-form-urlencoded`) + of the token request. - const req = new PushedAuthReqRequest(); - req.parameters = ...; - req.clientId = '57297408867'; - req.clientSecret = 'J_3C7P0nDTP7CwCg_HyPQh7bTQ1696CC8GWot-EjesZmdBiU5Gsidq5Ve3tMaN2x2_VcKV1UE1U3ZdGKRuTs7A'; + In addition, if the token endpoint of the authorization server implementation supports basic authentication + as a means of [client authentication](https://datatracker.ietf.org/doc/html/rfc6749#section-2.3), + the client credentials must be extracted from `Authorization` header and they must be passed as + `clientId` request parameter and `clientSecret` request parameter to Authlete's `/auth/token` API. - await api.token(req); - /api/auth/token: - post: - description: "This API parses request parameters of an authorization request\ - \ and returns necessary data for the\nauthorization server implementation\ - \ to process the authorization request further.\n\n
\n
\nDescription\n\ - \nThis API is supposed to be called from with the implementation of the token\ - \ endpoint of the service.\nThe endpoint implementation must extract the request\ - \ parameters from the token request from the\nclient application and pass\ - \ them as the value of parameters request parameter to Authlete's `/auth/token`\ - \ API.\nThe value of parameters is the entire entity body (which is formatted\ - \ in `application/x-www-form-urlencoded`)\nof the token request.\n\nIn addition,\ - \ if the token endpoint of the authorization server implementation supports\ - \ basic authentication\nas a means of [client authentication](https://datatracker.ietf.org/doc/html/rfc6749#section-2.3),\n\ - the client credentials must be extracted from `Authorization` header and they\ - \ must be passed as\n`clientId` request parameter and `clientSecret` request\ - \ parameter to Authlete's `/auth/token` API.\n\nThe following code snippet\ - \ is an example in JAX-RS showing how to extract request parameters from\n\ - the token request and client credentials from Authorization header.\n\n```java\n\ - @POST\n@Consumes(MediaType.APPLICATION_FORM_URLENCODED)\npublic Response post(\n\ - \ @HeaderParam(HttpHeaders.AUTHORIZATION) String auth,\n String\ - \ parameters)\n{\n // Convert the value of Authorization header (credentials\ - \ of\n // the client application), if any, into BasicCredentials.\n \ - \ BasicCredentials credentials = BasicCredentials.parse(auth);\n\n // The\ - \ credentials of the client application extracted from\n // 'Authorization'\ - \ header. These may be null.\n String clientId = credentials == null\ - \ ? null\n : credentials.getUserId();\n String clientSecret\ - \ = credentials == null ? null\n : credentials.getPassword();\n\ - \n // Process the given parameters.\n return process(parameters, clientId,\ - \ clientSecret);\n}\n```\n\nThe response from `/auth/token` API has some parameters.\ - \ Among them, it is action parameter that\nthe service implementation should\ - \ check first because it denotes the next action that the authorization\n\ - server implementation should take. According to the value of action, the authorization\ - \ server\nimplementation must take the steps described below.\n\n**INTERNAL_SERVER_ERROR**\n\ - \nWhen the value of `action` is `INTERNAL_SERVER_ERROR`, it means that the\ - \ request from the authorization\nserver implementation was wrong or that\ - \ an error occurred in Authlete.\nIn either case, from the viewpoint of the\ - \ client application, it is an error on the server side.\nTherefore, the service\ - \ implementation should generate a response to the client application with\n\ - HTTP status of \"500 Internal Server Error\". Authlete recommends `application/json`\ - \ as the content\ntype although OAuth 2.0 specification does not mention the\ - \ format of the error response when the\nredirect URI is not usable.\n\nThe\ - \ value of `responseContent` is a JSON string which describes the error, so\ - \ it can be\nused as the entity body of the response.\n\nThe following illustrates\ - \ the response which the service implementation should generate and return\n\ - to the client application.\n\n```\nHTTP/1.1 500 Internal Server Error\nContent-Type:\ - \ application/json\nCache-Control: no-store\nPragma: no-cache\n\n{responseContent}\n\ - ```\n\nThe endpoint implementation may return another different response to\ - \ the client application\nsince \"500 Internal Server Error\" is not required\ - \ by OAuth 2.0.\n\n\n**INVALID_CLIENT**\n\nWhen the value of `action` is `INVALID_CLIENT`,\ - \ it means that authentication of the client failed.\nIn this case, the HTTP\ - \ status of the response to the client application is either \"400 Bad Request\"\ - \nor \"401 Unauthorized\". This requirement comes from [RFC 6749, 5.2. Error\ - \ Response](https://datatracker.ietf.org/doc/html/rfc6749#section-5.2).\n\ - The description about `invalid_client` shown below is an excerpt from RFC\ - \ 6749.\n\nClient authentication failed (e.g., unknown client, no client authentication\ - \ included, or unsupported\nauthentication method). The authorization server\ - \ MAY return an HTTP 401 (Unauthorized) status code\nto indicate which HTTP\ - \ authentication schemes are supported. If the client attempted to authenticate\n\ - via the `Authorization` request header field, the authorization server MUST\ - \ respond with an HTTP\n401 (Unauthorized) status code and include the `WWW-Authenticate`\ - \ response header field matching\nthe authentication scheme used by the client.\n\ - \nIn either case, the value of `responseContent` is a JSON string which can\ - \ be used as the entity\nbody of the response to the client application.\n\ - \nThe following illustrate responses which the service implementation must\ - \ generate and return to\nthe client application.\n\n```\nHTTP/1.1 400 Bad\ - \ Request\nContent-Type: application/json\nCache-Control: no-store\nPragma:\ - \ no-cache\n\n{responseContent}\n```\n\n
\n\n```\nHTTP/1.1 401 Unauthorized\n\ - WWW-Authenticate: {challenge}\nContent-Type: application/json\nCache-Control:\ - \ no-store\nPragma: no-cache\n\n{responseContent}\n```\n\n**BAD_REQUEST**\n\ - \nWhen the value of `action` is `BAD_REQUEST`, it means that the request from\ - \ the client application\nis invalid.\n\nA response with HTTP status of \"\ - 400 Bad Request\" must be returned to the client application and\nthe content\ - \ type must be `application/json`.\n\nThe value of `responseContent` is a\ - \ JSON string which describes the error, so it can be used as\nthe entity\ - \ body of the response.\n\nThe following illustrates the response which the\ - \ service implementation should generate and return\nto the client application.\n\ - \n```\nHTTP/1.1 400 Bad Request\nContent-Type: application/json\nCache-Control:\ - \ no-store\nPragma: no-cache\n\n{responseContent}\n```\n**PASSWORD**\n\nWhen\ - \ the value of `\"action\"` is `\"PASSWORD\"`, it means that\nthe request\ - \ from the client application is valid and `grant_type`\nis `\"password\"\ - `. That is, the flow is\n\"Resource Owner\nPassword Credentials\".\n\nIn this case, {@link #getUsername()}\ - \ returns the value of `\"username\"`\nrequest parameter and {@link #getPassword()}\ - \ returns the value of {@code\n\"password\"} request parameter which were\ - \ contained in the token request\nfrom the client application. The service\ - \ implementation must validate the\ncredentials of the resource owner (= end-user)\ - \ and take either of the\nactions below according to the validation result.\n\ - \n1. When the credentials are valid, call Authlete's /auth/token/issue} API\ - \ to generate an access token for the client\n application. The API requires\ - \ `\"ticket\"` request parameter and\n `\"subject\"` request parameter.\n\ - \ Use the value returned from {@link #getTicket()} method as the value\n\ - \ for `\"ticket\"` parameter.\n2. The response from `/auth/token/issue`\ - \ API ({@link\n TokenIssueResponse}) contains data (an access token and\ - \ others)\n which should be returned to the client application. Use the\ - \ data\n to generate a response to the client application.\n3. When the\ - \ credentials are invalid, call Authlete's {@code\n /auth/token/fail}\ - \ API with `reason=`{@link\n TokenFailRequest.Reason#INVALID_RESOURCE_OWNER_CREDENTIALS\n\ - \ INVALID_RESOURCE_OWNER_CREDENTIALS} to generate an error response\n \ - \ for the client application. The API requires `\"ticket\"`\n request\ - \ parameter. Use the value returned from {@link #getTicket()}\n method\ - \ as the value for `\"ticket\"` parameter.\n4. The response from `/auth/token/fail`\ - \ API ({@link\n TokenFailResponse}) contains error information which should\ - \ be\n returned to the client application. Use it to generate a response\n\ - \ to the client application.\n\n**OK**\n\nWhen the value of `action` is\ - \ `OK`, it means that the request from the client application is valid\nand\ - \ an access token, and optionally an ID token, is ready to be issued.\n\n\ - The HTTP status of the response returned to the client application must be\ - \ \"200 OK\" and the content\ntype must be `application/json`.\n\nThe value\ - \ of `responseContent` is a JSON string which contains an access token (and\ - \ optionally\nan ID token), so it can be used as the entity body of the response.\n\ - \nThe following illustrates the response which the service implementation\ - \ must generate and return\nto the client application.\n\n```\nHTTP/1.1 200\ - \ OK\nContent-Type: application/json\nCache-Control: no-store\nPragma: no-cache\n\ - \n{responseContent}\n```\n\n \n**TOKEN_EXCHANGE (Authlete 2.3 onwards)**\n\ - \nWhen the value of `\"action\"` is `\"TOKEN_EXCHANGE\"`, it means\nthat the\ - \ request from the client application is a valid token exchange\nrequest (cf.\ - \ RFC\n8693 OAuth\ - \ 2.0 Token Exchange) and that the request has already passed\nthe following\ - \ validation steps.\n\n\n1. Confirm that the value of the `requested_token_type`\ - \ request parameter\nis one of the registered token type identifiers if the\ - \ request parameter is\ngiven and its value is not empty.\n2. Confirm that\ - \ the `subject_token` request parameter is given and its\nvalue is not empty.\n\ - 3. Confirm that the `subject_token_type` request parameter is given and\n\ - its value is one of the registered token type identifiers.\n4. Confirm that\ - \ the `actor_token_type` request parameter is given and\nits value is one\ - \ of the registered token type identifiers if the\n`actor_token` request parameter\ - \ is given and its value is not empty.\n5. Confirm that the `actor_token_type`\ - \ request parameter is not given\nor its value is empty when the `actor_token`\ - \ request parameter is\nnot given or its value is empty.\n\n\nFurthermore,\ - \ Authlete performs additional validation on the tokens specified\nby the\ - \ `subject_token` request parameter and the `actor_token`\nrequest parameter\ - \ according to their respective token types as shown below.\n\n**Token Validation\ - \ Steps**\n\n*Token Type: `urn:ietf:params:oauth:token-type:jwt`* \n\n1. Confirm\ - \ that the format conforms to the JWT specification [RFC 7519][https://www.rfc-editor.org/rfc/rfc7519.html].\n\ - 2. Check if the JWT is encrypted and if it is encrypted, then (a) reject\n\ - \ the token exchange request when the {@link\n Service#isTokenExchangeEncryptedJwtRejected()\n\ - \ tokenExchangeEncryptedJwtRejected} flag of the service is `true`\n\ - \ or (b) skip remaining validation steps when the flag is `false`.\n\ - \ Note that Authlete does not verify an encrypted JWT because there\ - \ is\n no standard way to obtain the key to decrypt the JWT with. This\ - \ means\n that you must verify an encrypted JWT by yourself when one\ - \ is used as\n an input token with the token type\n { @code\ - \ \"urn:ietf:params:oauth:token-type:jwt\" }.\n3. Confirm that the current\ - \ time has not reached the time indicated by\n the `exp` claim if the\ - \ JWT contains the claim.\n4. Confirm that the current time is equal to or\ - \ after the time indicated\n by the `iat` claim if the JWT contains\ - \ the claim.\n5.Confirm that the current time is equal to or after the time\ - \ indicated\n by the `nbf` claim if the JWT contains the claim.\n6.\ - \ Check if the JWT is signed and if it is not signed, then (a) reject\n \ - \ the token exchange request when the {@link\n Service#isTokenExchangeUnsignedJwtRejected()\n\ - \ tokenExchangeUnsignedJwtRejected} flag of the service is `true`\n\ - \ or (b) finish validation on the input token. Note that Authlete does\n\ - \ not verify the signature of the JWT because there is no standard\ - \ way\n to obtain the key to verify the signature of a JWT with. This\ - \ means\n that you must verify the signature by yourself when a signed\ - \ JWT is\n used as an input token with the token type\n `\"\ - urn:ietf:params:oauth:token-type:jwt\"`.\n\n*Token Type: `urn:ietf:params:oauth:token-type:access_token`*\n\ - \n1. Confirm that the token is an access token that has been issued by\n \ - \ the Authlete server of your service. This implies that access\n \ - \ tokens issued by other systems cannot be used as a subject token\n\ - \ or an actor token with the token type\n urn:ietf:params:oauth:token-type:access_token.\n\ - 2. Confirm that the access token has not expired.\n3. Confirm that the access\ - \ token belongs to the service.\n\n*Token Type: `urn:ietf:params:oauth:token-type:refresh_token`*\n\ - \n1. Confirm that the token is a refresh token that has been issued by\n \ - \ the Authlete server of your service. This implies that refresh\n \ - \ tokens issued by other systems cannot be used as a subject token\n\ - \ or an actor token with the token type\n urn:ietf:params:oauth:token-type:refresh_token.\n\ - 2. Confirm that the refresh token has not expired.\n3. Confirm that the refresh\ - \ token belongs to the service.\n\n*Token Type: `urn:ietf:params:oauth:token-type:id_token`*\n\ - \n1. Confirm that the format conforms to the JWT specification (RFC 7519).\n\ - 2. Check if the ID Token is encrypted and if it is encrypted, then (a)\n \ - \ reject the token exchange request when the {@link\n Service#isTokenExchangeEncryptedJwtRejected()\n\ - \ tokenExchangeEncryptedJwtRejected} flag of the service is `true`\n\ - \ or (b) skip remaining validation steps when the flag is `false`.\n\ - \ Note that Authlete does not verify an encrypted ID Token because\n\ - \ there is no standard way to obtain the key to decrypt the ID Token\n\ - \ with in the context of token exchange where the client ID for the\n\ - \ encrypted ID Token cannot be determined. This means that you must\n\ - \ verify an encrypted ID Token by yourself when one is used as an\n\ - \ input token with the token type\n `\"urn:ietf:params:oauth:token-type:id_token\"\ - `.\n3. Confirm that the ID Token contains the `exp` claim and the\n \ - \ current time has not reached the time indicated by the claim.\n4. Confirm\ - \ that the ID Token contains the `iat` claim and the\n current time\ - \ is equal to or after the time indicated by the claim.\n5. Confirm that the\ - \ current time is equal to or after the time indicated\n by the `nbf`\ - \ claim if the ID Token contains the claim.\n6. Confirm that the ID Token\ - \ contains the `iss` claim and the\n value is a valid URI. In addition,\ - \ confirm that the URI has the\n `https` scheme, no query component\ - \ and no fragment component.\n7. Confirm that the ID Token contains the `aud`\ - \ claim and its\n value is a JSON string or an array of JSON strings.\n\ - 8. Confirm that the value of the `nonce` claim is a JSON string\n if\ - \ the ID Token contains the claim.\n9. Check if the ID Token is signed and\ - \ if it is not signed, then (a)\n reject the token exchange request\ - \ when the {@link\n Service#isTokenExchangeUnsignedJwtRejected()\n\ - \ tokenExchangeUnsignedJwtRejected} flag of the service is `true`\n\ - \ or (b) finish validation on the input token.\n10. Confirm that the\ - \ signature algorithm is asymmetric. This implies that\n ID Tokens\ - \ whose signature algorithm is symmetric (`HS256`,\n `HS384` or `HS512`)\ - \ cannot be used as a subject token or\n an actor token with the token\ - \ type\n `urn:ietf:params:oauth:token-type:id_token`.\n11. Verify the\ - \ signature of the ID Token. Signature verification is\n performed\ - \ even in the case where the issuer of the ID Token is not\n your service.\ - \ But in that case, the issuer must support the discovery\n endpoint\ - \ defined in OpenID\n Connect Discovery 1.0. Otherwise, signature verification\ - \ fails.\n\n*Token Type: `urn:ietf:params:oauth:token-type:saml1`*\n\n(Authlete\ - \ does not perform any validation for this token type.)\n\n*Token Type: `urn:ietf:params:oauth:token-type:saml2`*\n\ - \n(Authlete does not perform any validation for this token type.)\n\nThe specification\ - \ of Token Exchange (RFC 8693) is very\nflexible. In other words, the specification has abandoned\ - \ the task of\ndetermining details. Therefore, for secure token exchange,\ - \ you have\nto complement the specification with your own rules. For that\ - \ purpose,\nAuthlete provides some configuration options as listed below.\n\ - Authorization server implementers may utilize them and/or implement\ntheir\ - \ own rules.\n\n\nIn the case of {@link Action#TOKEN_EXCHANGE TOKEN_EXCHANGE},\ - \ the {@link\n#getResponseContent()} method returns `null`. You have to construct\n\ - the token response by yourself.\n\nFor example, you may generate an access\ - \ token by calling Authlete's\n`/api/auth/token/create` API and construct\ - \ a token response like\nbelow.\n\n```\nHTTP/1.1 401 Unauthorized\nWWW-Authenticate:\ - \ {challenge}\nContent-Type: application/json\nCache-Control: no-store\nPragma:\ - \ no-cache\n\n{responseContent}\n```\n\n```\nHTTP/1.1 200 OK\nContent-Type:\ - \ application/json\nCache-Control: no-cache, no-store\n{\n \"access_token\"\ - : \"{@link TokenCreateResponse#getAccessToken()}\",\n \"issued_token_type\"\ - : \"urn:ietf:params:oauth:token-type:access_token\",\n \"token_type\":\ - \ \"Bearer\",\n \"expires_in\": { @link TokenCreateResponse#getExpiresIn()\ - \ },\n \"scope\": \"String.join(\" \", {@link TokenCreateResponse#getScopes()})\"\ - \n}\n```\n\n\n**JWT_BEARER JWT_BEARER (Authlete 2.3 onwards)**\n\nWhen the\ - \ value of `\"action\"` is `\"JWT_BEARER\"`, it means that\nthe request from\ - \ the client application is a valid token request with the\ngrant type `\"\ - urn:ietf:params:oauth:grant-type:jwt-bearer\"` (RFC 7523 JSON Web Token (JWT)\nProfile for OAuth 2.0 Client Authentication\ - \ and Authorization Grants)\nand that the request has already passed the\ - \ following validation steps.\n\n1. Confirm that the `assertion` request parameter\ - \ is given and its value\n is not empty.\n2. Confirm that the format of the\ - \ assertion conforms to the JWT specification\n (RFC 7519).\n\n3. Check if the JWT is encrypted and if it is encrypted,\ - \ then (a) reject the\n token request when the {@link Service#isJwtGrantEncryptedJwtRejected()\n\ - \ jwtGrantEncryptedJwtRejected} flag of the service is `true` or (b)\n skip\ - \ remaining validation steps when the flag is `false`. Note that\n Authlete\ - \ does not verify an encrypted JWT because there is no standard way\n to\ - \ obtain the key to decrypt the JWT with. This means that you must verify\n\ - \ an encrypted JWT by yourself.\n4. Confirm that the JWT contains the `iss`\ - \ claim and its value is a\n JSON string.\n5. Confirm that the JWT contains\ - \ the `sub` claim and its value is a\n JSON string.\n6. Confirm that the\ - \ JWT contains the `aud` claim and its value is\n either a JSON string or\ - \ an array of JSON strings.\n7. Confirm that the issuer identifier of the\ - \ service (cf. {@link Service#getIssuer()})\n or the URL of the token endpoint\ - \ (cf. {@link Service#getTokenEndpoint()})\n is listed as audience in the\ - \ `aud` claim.\n8. Confirm that the JWT contains the `exp` claim and the current\ - \ time\n has not reached the time indicated by the claim.\n9. Confirm that\ - \ the current time is equal to or after the time indicated by\n by the `iat`\ - \ claim if the JWT contains the claim.\n10. Confirm that the current time\ - \ is equal to or after the time indicated by\n by the `nbf` claim if the\ - \ JWT contains the claim.\n11. Check if the JWT is signed and if it is not\ - \ signed, then (a) reject the\n token request when the {@link Service#isJwtGrantUnsignedJwtRejected()\n\ - \ jwtGrantUnsignedJwtRejected} flag of the service is `true` or (b)\n finish\ - \ validation on the JWT. Note that Authlete does not verify the\n signature\ - \ of the JWT because there is no standard way to obtain the key\n to verify\ - \ the signature of a JWT with. This means that you must verify\n the signature\ - \ by yourself.\n\nAuthlete provides some configuration options for the grant\ - \ type as listed\nbelow. Authorization server implementers may utilize them\ - \ and/or implement\ntheir own rules.\n\n\n```\nHTTP/1.1 200 OK\nContent-Type:\ - \ application/json\nCache-Control: no-cache, no-store\n{\n \"access_token\"\ - : \"{@link TokenCreateResponse#getAccessToken()}\",\n \"token_type\"\ - : \"Bearer\",\n \"expires_in\": {@link TokenCreateResponse#getExpiresIn()},\n\ - \ \"scope\": \"String.join(\" \", {@link TokenCreateResponse#getScopes()})\"\ - \n }\n```\n\n Finally, note again that Authlete\ - \ does not verify the signature of the JWT\n specified by the `assertion`\ - \ request parameter. You must verify the\n signature by yourself.\n \n
\n" - operationId: auth_token_api - requestBody: - content: - application/json: - example: - parameters: grant_type=authorization_code&code=Xv_su944auuBgc5mfUnxXayiiQU9Z4-T_Yae_UfExmo&redirect_uri=https%3A%2F%2Fmy-client.example.com%2Fcb1&code_verifier=dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk - clientId: "26478243745571" - clientSecret: gXz97ISgLs4HuXwOZWch8GEmgL4YMvUJwu3er_kDVVGcA0UOhA9avLPbEmoeZdagi9yC_-tEiT2BdRyH9dbrQQ - schema: - $ref: '#/components/schemas/token_request' - application/x-www-form-urlencoded: - schema: - $ref: '#/components/schemas/token_request' - required: true - responses: - "200": - content: - application/json: - example: - resultCode: A050001 - resultMessage: "[A050001] The token request (grant_type=authorization_code)\ - \ was processed successfully." - accessToken: C4SrUTijIj2IxqE1xBASr3dxQWgso3BpY49g8CyjGjQ - accessTokenDuration: 3600 - accessTokenExpiresAt: 1640252942736 - action: OK - clientAttributes: - - key: attribute1-key - value: attribute1-value - - key: attribute2-key - value: attribute2-value - clientId: 26478243745571 - clientIdAlias: my-client - clientIdAliasUsed: false - grantType: AUTHORIZATION_CODE - refreshToken: 60k0cZ38sJcpTgdxvG9Sqa-3RG5AmGExGpFB-1imSxo - refreshTokenDuration: 3600 - refreshTokenExpiresAt: 1640252942736 - responseContent: "{\\\"access_token\\\":\\\"C4SrUTijIj2IxqE1xBASr3dxQWgso3BpY49g8CyjGjQ\\\ - \",\\\"refresh_token\\\":\\\"60k0cZ38sJcpTgdxvG9Sqa-3RG5AmGExGpFB-1imSxo\\\ - \",\\\"scope\\\":\\\"history.read timeline.read\\\",\\\"token_type\\\ - \":\\\"Bearer\\\",\\\"expires_in\\\":3600}" - scopes: - - history.read - - timeline.read - serviceAttributes: - - key: attribute1-key - value: attribute1-value - - key: attribute2-key - value: attribute2-value - subject: john - schema: - $ref: '#/components/schemas/token_response' - description: "" - "400": - content: - application/json: - example: - resultCode: A001201 - resultMessage: "[A001201] /auth/authorization, TLS must be used." - schema: - $ref: '#/components/schemas/result' - description: "" - "401": - content: - application/json: - example: - resultCode: A001202 - resultMessage: "[A001202] /auth/authorization, Authorization header\ - \ is missing." - schema: - $ref: '#/components/schemas/result' - description: "" - "403": - content: - application/json: - example: - resultCode: A001215 - resultMessage: "[A001215] /auth/authorization, The client (ID = 26837717140341)\ - \ is locked." - schema: - $ref: '#/components/schemas/result' - description: "" - "500": - content: - application/json: - example: - resultCode: A001101 - resultMessage: "[A001101] /auth/authorization, Authlete Server error." - schema: - $ref: '#/components/schemas/result' - description: "" - security: - - ServiceCredentials: [] - summary: /api/auth/token API - tags: - - Token Endpoint - x-code-samples: - - lang: shell - label: curl - source: | - curl -v -X POST https://api.authlete.com/api/auth/token \ - -H 'Content-Type: application/json' \ - -u '21653835348762:uE4NgqeIpuSV_XejQ7Ds3jsgA1yXhjR1MXJ1LbPuyls' \ - -d '{ "parameters": "grant_type=authorization_code&code=Xv_su944auuBgc5mfUnxXayiiQU9Z4-T_Yae_UfExmo&redirect_uri=https%3A%2F%2Fmy-client.example.com%2Fcb1&code_verifier=dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk", "clientId": "57297408867", "clientSecret": "J_3C7P0nDTP7CwCg_HyPQh7bTQ1696CC8GWot-EjesZmdBiU5Gsidq5Ve3tMaN2x2_VcKV1UE1U3ZdGKRuTs7A" }' - - lang: java - label: java - source: | - AuthleteConfiguration conf = ...; - AuthleteApi api = AuthleteApiFactory.create(conf); + The following code snippet is an example in JAX-RS showing how to extract request parameters from + the token request and client credentials from Authorization header. - TokenRequest req = new TokenRequest(); - req.setParameters(...); - req.setClientId("57297408867"); - req.setClientSecret("J_3C7P0nDTP7CwCg_HyPQh7bTQ1696CC8GWot-EjesZmdBiU5Gsidq5Ve3tMaN2x2_VcKV1UE1U3ZdGKRuTs7A"); + ```java + @POST + @Consumes(MediaType.APPLICATION_FORM_URLENCODED) + public Response post( + @HeaderParam(HttpHeaders.AUTHORIZATION) String auth, + String parameters) + { + // Convert the value of Authorization header (credentials of + // the client application), if any, into BasicCredentials. + BasicCredentials credentials = BasicCredentials.parse(auth); + + // The credentials of the client application extracted from + // 'Authorization' header. These may be null. + String clientId = credentials == null ? null + : credentials.getUserId(); + String clientSecret = credentials == null ? null + : credentials.getPassword(); + + // Process the given parameters. + return process(parameters, clientId, clientSecret); + } + ``` - api.token(req); - - lang: cs - label: C# - source: | - AuthleteConfiguration conf = ...; - AuthleteApi api = AuthleteApiFactory.create(conf); + The response from `/auth/token` API has some parameters. Among them, it is action parameter that + the service implementation should check first because it denotes the next action that the authorization + server implementation should take. According to the value of action, the authorization server + implementation must take the steps described below. - TokenRequest req = new TokenRequest(); - req.setParameters(...); - req.setClientId("57297408867"); - req.setClientSecret("J_3C7P0nDTP7CwCg_HyPQh7bTQ1696CC8GWot-EjesZmdBiU5Gsidq5Ve3tMaN2x2_VcKV1UE1U3ZdGKRuTs7A"); + **INTERNAL_SERVER_ERROR** - api.token(req); - - lang: php - label: PHP - source: | - $conf = ...; - $api = new AuthleteApiImpl($conf); + When the value of `action` is `INTERNAL_SERVER_ERROR`, it means that the request from the authorization + server implementation was wrong or that an error occurred in Authlete. + In either case, from the viewpoint of the client application, it is an error on the server side. + Therefore, the service implementation should generate a response to the client application with + HTTP status of "500 Internal Server Error". Authlete recommends `application/json` as the content + type although OAuth 2.0 specification does not mention the format of the error response when the + redirect URI is not usable. - $req = new TokenRequest(); - $req.setParameters(...); - $req.setClientId("57297408867"); - $req.setClientSecret("J_3C7P0nDTP7CwCg_HyPQh7bTQ1696CC8GWot-EjesZmdBiU5Gsidq5Ve3tMaN2x2_VcKV1UE1U3ZdGKRuTs7A"); + The value of `responseContent` is a JSON string which describes the error, so it can be + used as the entity body of the response. - $api.token($req); - - lang: ruby - source: | - conf = ... - api = Authlete::Api.new(conf) + The following illustrates the response which the service implementation should generate and return + to the client application. - req = Authlete::Model::Request::TokenRequest.new - req.parameters = '...' - req.client_id = '57297408867' - req.client_secret = 'J_3C7P0nDTP7CwCg_HyPQh7bTQ1696CC8GWot-EjesZmdBiU5Gsidq5Ve3tMaN2x2_VcKV1UE1U3ZdGKRuTs7A' + ``` + HTTP/1.1 500 Internal Server Error + Content-Type: application/json + Cache-Control: no-store + Pragma: no-cache - api.token(req) - - lang: python - source: | - conf = ... - api = AuthleteApiImpl(conf) + {responseContent} + ``` - req = TokenRequest() - req.parameters = ... - req.clientId = '57297408867' - req.clientSecret = 'J_3C7P0nDTP7CwCg_HyPQh7bTQ1696CC8GWot-EjesZmdBiU5Gsidq5Ve3tMaN2x2_VcKV1UE1U3ZdGKRuTs7A' + The endpoint implementation may return another different response to the client application + since "500 Internal Server Error" is not required by OAuth 2.0. - api.token(req) - - lang: go - source: | - conf := ... - api := api.New(&conf) - req := dto.TokenRequest{} - req.Parameters = ... - req.ClientId = "57297408867" - req.ClientSecret = "J_3C7P0nDTP7CwCg_HyPQh7bTQ1696CC8GWot-EjesZmdBiU5Gsidq5Ve3tMaN2x2_VcKV1UE1U3ZdGKRuTs7A" + **INVALID_CLIENT** - api.Token(&req) - - lang: ts - label: deno - source: | - const conf: AuthleteConfiguration = ...; - const api: AuthleteApi = new AuthleteApiImpl(conf); + When the value of `action` is `INVALID_CLIENT`, it means that authentication of the client failed. + In this case, the HTTP status of the response to the client application is either "400 Bad Request" + or "401 Unauthorized". This requirement comes from [RFC 6749, 5.2. Error Response](https://datatracker.ietf.org/doc/html/rfc6749#section-5.2). + The description about `invalid_client` shown below is an excerpt from RFC 6749. - const req = new TokenRequest(); - req.parameters = ...; - req.clientId = '57297408867'; - req.clientSecret = 'J_3C7P0nDTP7CwCg_HyPQh7bTQ1696CC8GWot-EjesZmdBiU5Gsidq5Ve3tMaN2x2_VcKV1UE1U3ZdGKRuTs7A'; + Client authentication failed (e.g., unknown client, no client authentication included, or unsupported + authentication method). The authorization server MAY return an HTTP 401 (Unauthorized) status code + to indicate which HTTP authentication schemes are supported. If the client attempted to authenticate + via the `Authorization` request header field, the authorization server MUST respond with an HTTP + 401 (Unauthorized) status code and include the `WWW-Authenticate` response header field matching + the authentication scheme used by the client. - await api.token(req); - /api/auth/token/fail: - post: - description: | - This API generates a content of an error token response that the authorization server implementation - returns to the client application. + In either case, the value of `responseContent` is a JSON string which can be used as the entity + body of the response to the client application. -
-
- Description + The following illustrate responses which the service implementation must generate and return to + the client application. - This API is supposed to be called from within the implementation of the token endpoint of the service - in order to generate an error response to the client application. + ``` + HTTP/1.1 400 Bad Request + Content-Type: application/json + Cache-Control: no-store + Pragma: no-cache - The description of the `/auth/token` API describes the timing when this API should be called. See - the description for the case of `action=PASSWORD`. + {responseContent} + ``` - The response from `/auth/token/fail` API has some parameters. Among them, it is `action` parameter - that the authorization server implementation should check first because it denotes the next action - that the authorization server implementation should take. According to the value of `action`, the - authorization server implementation must take the steps described below. +
- **INTERNAL_SERVER_ERROR** + ``` + HTTP/1.1 401 Unauthorized + WWW-Authenticate: {challenge} + Content-Type: application/json + Cache-Control: no-store + Pragma: no-cache - When the value of `action` is `INTERNAL_SERVER_ERROR`, it means that the request from the authorization - server implementation was wrong or that an error occurred in Authlete. + {responseContent} + ``` - In either case, from the viewpoint of the client application, it is an error on the server side. - Therefore, the service implementation should generate a response to the client application with - HTTP status of "500 Internal Server Error". + **BAD_REQUEST** - The value of `responseContent` is a JSON string which describes the error, so it can be used - as the entity body of the response. + When the value of `action` is `BAD_REQUEST`, it means that the request from the client application + is invalid. + + A response with HTTP status of "400 Bad Request" must be returned to the client application and + the content type must be `application/json`. + + The value of `responseContent` is a JSON string which describes the error, so it can be used as + the entity body of the response. The following illustrates the response which the service implementation should generate and return to the client application. ``` - HTTP/1.1 500 Internal Server Error + HTTP/1.1 400 Bad Request Content-Type: application/json Cache-Control: no-store Pragma: no-cache {responseContent} ``` + **PASSWORD** + + When the value of `"action"` is `"PASSWORD"`, it means that + the request from the client application is valid and `grant_type` + is `"password"`. That is, the flow is + "Resource Owner + Password Credentials". + + In this case, {@link #getUsername()} returns the value of `"username"` + request parameter and {@link #getPassword()} returns the value of {@code + "password"} request parameter which were contained in the token request + from the client application. The service implementation must validate the + credentials of the resource owner (= end-user) and take either of the + actions below according to the validation result. + + 1. When the credentials are valid, call Authlete's /auth/token/issue} API to generate an access token for the client + application. The API requires `"ticket"` request parameter and + `"subject"` request parameter. + Use the value returned from {@link #getTicket()} method as the value + for `"ticket"` parameter. + 2. The response from `/auth/token/issue` API ({@link + TokenIssueResponse}) contains data (an access token and others) + which should be returned to the client application. Use the data + to generate a response to the client application. + 3. When the credentials are invalid, call Authlete's {@code + /auth/token/fail} API with `reason=`{@link + TokenFailRequest.Reason#INVALID_RESOURCE_OWNER_CREDENTIALS + INVALID_RESOURCE_OWNER_CREDENTIALS} to generate an error response + for the client application. The API requires `"ticket"` + request parameter. Use the value returned from {@link #getTicket()} + method as the value for `"ticket"` parameter. + 4. The response from `/auth/token/fail` API ({@link + TokenFailResponse}) contains error information which should be + returned to the client application. Use it to generate a response + to the client application. - The endpoint implementation may return another different response to the client application - since "500 Internal Server Error" is not required by OAuth 2.0. - - **BAD_REQUEST** + **OK** - When the value of `action` is `BAD_REQUEST`, it means that Authlete's `/auth/token/fail` API successfully - generated an error response for the client application. + When the value of `action` is `OK`, it means that the request from the client application is valid + and an access token, and optionally an ID token, is ready to be issued. - The HTTP status of the response returned to the client application must be "400 Bad Request" and - the content type must be `application/json`. + The HTTP status of the response returned to the client application must be "200 OK" and the content + type must be `application/json`. - The value of `responseContent` is a JSON string which describes the error, so it can be used - as the entity body of the response. + The value of `responseContent` is a JSON string which contains an access token (and optionally + an ID token), so it can be used as the entity body of the response. - The following illustrates the response which the service implementation should generate and return + The following illustrates the response which the service implementation must generate and return to the client application. ``` - HTTP/1.1 400 Bad Request + HTTP/1.1 200 OK + Content-Type: application/json + Cache-Control: no-store + Pragma: no-cache + + {responseContent} + ``` + + + **TOKEN_EXCHANGE (Authlete 2.3 onwards)** + + When the value of `"action"` is `"TOKEN_EXCHANGE"`, it means + that the request from the client application is a valid token exchange + request (cf. RFC + 8693 OAuth 2.0 Token Exchange) and that the request has already passed + the following validation steps. + + + 1. Confirm that the value of the `requested_token_type` request parameter + is one of the registered token type identifiers if the request parameter is + given and its value is not empty. + 2. Confirm that the `subject_token` request parameter is given and its + value is not empty. + 3. Confirm that the `subject_token_type` request parameter is given and + its value is one of the registered token type identifiers. + 4. Confirm that the `actor_token_type` request parameter is given and + its value is one of the registered token type identifiers if the + `actor_token` request parameter is given and its value is not empty. + 5. Confirm that the `actor_token_type` request parameter is not given + or its value is empty when the `actor_token` request parameter is + not given or its value is empty. + + + Furthermore, Authlete performs additional validation on the tokens specified + by the `subject_token` request parameter and the `actor_token` + request parameter according to their respective token types as shown below. + + **Token Validation Steps** + + *Token Type: `urn:ietf:params:oauth:token-type:jwt`* + + 1. Confirm that the format conforms to the JWT specification [RFC 7519][https://www.rfc-editor.org/rfc/rfc7519.html]. + 2. Check if the JWT is encrypted and if it is encrypted, then (a) reject + the token exchange request when the {@link + Service#isTokenExchangeEncryptedJwtRejected() + tokenExchangeEncryptedJwtRejected} flag of the service is `true` + or (b) skip remaining validation steps when the flag is `false`. + Note that Authlete does not verify an encrypted JWT because there is + no standard way to obtain the key to decrypt the JWT with. This means + that you must verify an encrypted JWT by yourself when one is used as + an input token with the token type + { @code "urn:ietf:params:oauth:token-type:jwt" }. + 3. Confirm that the current time has not reached the time indicated by + the `exp` claim if the JWT contains the claim. + 4. Confirm that the current time is equal to or after the time indicated + by the `iat` claim if the JWT contains the claim. + 5.Confirm that the current time is equal to or after the time indicated + by the `nbf` claim if the JWT contains the claim. + 6. Check if the JWT is signed and if it is not signed, then (a) reject + the token exchange request when the {@link + Service#isTokenExchangeUnsignedJwtRejected() + tokenExchangeUnsignedJwtRejected} flag of the service is `true` + or (b) finish validation on the input token. Note that Authlete does + not verify the signature of the JWT because there is no standard way + to obtain the key to verify the signature of a JWT with. This means + that you must verify the signature by yourself when a signed JWT is + used as an input token with the token type + `"urn:ietf:params:oauth:token-type:jwt"`. + + *Token Type: `urn:ietf:params:oauth:token-type:access_token`* + + 1. Confirm that the token is an access token that has been issued by + the Authlete server of your service. This implies that access + tokens issued by other systems cannot be used as a subject token + or an actor token with the token type + urn:ietf:params:oauth:token-type:access_token. + 2. Confirm that the access token has not expired. + 3. Confirm that the access token belongs to the service. + + *Token Type: `urn:ietf:params:oauth:token-type:refresh_token`* + + 1. Confirm that the token is a refresh token that has been issued by + the Authlete server of your service. This implies that refresh + tokens issued by other systems cannot be used as a subject token + or an actor token with the token type + urn:ietf:params:oauth:token-type:refresh_token. + 2. Confirm that the refresh token has not expired. + 3. Confirm that the refresh token belongs to the service. + + *Token Type: `urn:ietf:params:oauth:token-type:id_token`* + + 1. Confirm that the format conforms to the JWT specification (RFC 7519). + 2. Check if the ID Token is encrypted and if it is encrypted, then (a) + reject the token exchange request when the {@link + Service#isTokenExchangeEncryptedJwtRejected() + tokenExchangeEncryptedJwtRejected} flag of the service is `true` + or (b) skip remaining validation steps when the flag is `false`. + Note that Authlete does not verify an encrypted ID Token because + there is no standard way to obtain the key to decrypt the ID Token + with in the context of token exchange where the client ID for the + encrypted ID Token cannot be determined. This means that you must + verify an encrypted ID Token by yourself when one is used as an + input token with the token type + `"urn:ietf:params:oauth:token-type:id_token"`. + 3. Confirm that the ID Token contains the `exp` claim and the + current time has not reached the time indicated by the claim. + 4. Confirm that the ID Token contains the `iat` claim and the + current time is equal to or after the time indicated by the claim. + 5. Confirm that the current time is equal to or after the time indicated + by the `nbf` claim if the ID Token contains the claim. + 6. Confirm that the ID Token contains the `iss` claim and the + value is a valid URI. In addition, confirm that the URI has the + `https` scheme, no query component and no fragment component. + 7. Confirm that the ID Token contains the `aud` claim and its + value is a JSON string or an array of JSON strings. + 8. Confirm that the value of the `nonce` claim is a JSON string + if the ID Token contains the claim. + 9. Check if the ID Token is signed and if it is not signed, then (a) + reject the token exchange request when the {@link + Service#isTokenExchangeUnsignedJwtRejected() + tokenExchangeUnsignedJwtRejected} flag of the service is `true` + or (b) finish validation on the input token. + 10. Confirm that the signature algorithm is asymmetric. This implies that + ID Tokens whose signature algorithm is symmetric (`HS256`, + `HS384` or `HS512`) cannot be used as a subject token or + an actor token with the token type + `urn:ietf:params:oauth:token-type:id_token`. + 11. Verify the signature of the ID Token. Signature verification is + performed even in the case where the issuer of the ID Token is not + your service. But in that case, the issuer must support the discovery + endpoint defined in OpenID + Connect Discovery 1.0. Otherwise, signature verification fails. + + *Token Type: `urn:ietf:params:oauth:token-type:saml1`* + + (Authlete does not perform any validation for this token type.) + + *Token Type: `urn:ietf:params:oauth:token-type:saml2`* + + (Authlete does not perform any validation for this token type.) + + The specification of Token Exchange (RFC 8693) is very + flexible. In other words, the specification has abandoned the task of + determining details. Therefore, for secure token exchange, you have + to complement the specification with your own rules. For that purpose, + Authlete provides some configuration options as listed below. + Authorization server implementers may utilize them and/or implement + their own rules. + + + In the case of {@link Action#TOKEN_EXCHANGE TOKEN_EXCHANGE}, the {@link + #getResponseContent()} method returns `null`. You have to construct + the token response by yourself. + + For example, you may generate an access token by calling Authlete's + `/api/auth/token/create` API and construct a token response like + below. + + ``` + HTTP/1.1 401 Unauthorized + WWW-Authenticate: {challenge} Content-Type: application/json Cache-Control: no-store Pragma: no-cache @@ -5501,35 +4307,146 @@ paths: {responseContent} ``` + ``` + HTTP/1.1 200 OK + Content-Type: application/json + Cache-Control: no-cache, no-store + { + "access_token": "{@link TokenCreateResponse#getAccessToken()}", + "issued_token_type": "urn:ietf:params:oauth:token-type:access_token", + "token_type": "Bearer", + "expires_in": { @link TokenCreateResponse#getExpiresIn() }, + "scope": "String.join(" ", {@link TokenCreateResponse#getScopes()})" + } + ``` + + + **JWT_BEARER JWT_BEARER (Authlete 2.3 onwards)** + + When the value of `"action"` is `"JWT_BEARER"`, it means that + the request from the client application is a valid token request with the + grant type `"urn:ietf:params:oauth:grant-type:jwt-bearer"` (RFC 7523 JSON Web Token (JWT) + Profile for OAuth 2.0 Client Authentication and Authorization Grants) + and that the request has already passed the following validation steps. + + 1. Confirm that the `assertion` request parameter is given and its value + is not empty. + 2. Confirm that the format of the assertion conforms to the JWT specification + (RFC 7519). + + 3. Check if the JWT is encrypted and if it is encrypted, then (a) reject the + token request when the {@link Service#isJwtGrantEncryptedJwtRejected() + jwtGrantEncryptedJwtRejected} flag of the service is `true` or (b) + skip remaining validation steps when the flag is `false`. Note that + Authlete does not verify an encrypted JWT because there is no standard way + to obtain the key to decrypt the JWT with. This means that you must verify + an encrypted JWT by yourself. + 4. Confirm that the JWT contains the `iss` claim and its value is a + JSON string. + 5. Confirm that the JWT contains the `sub` claim and its value is a + JSON string. + 6. Confirm that the JWT contains the `aud` claim and its value is + either a JSON string or an array of JSON strings. + 7. Confirm that the issuer identifier of the service (cf. {@link Service#getIssuer()}) + or the URL of the token endpoint (cf. {@link Service#getTokenEndpoint()}) + is listed as audience in the `aud` claim. + 8. Confirm that the JWT contains the `exp` claim and the current time + has not reached the time indicated by the claim. + 9. Confirm that the current time is equal to or after the time indicated by + by the `iat` claim if the JWT contains the claim. + 10. Confirm that the current time is equal to or after the time indicated by + by the `nbf` claim if the JWT contains the claim. + 11. Check if the JWT is signed and if it is not signed, then (a) reject the + token request when the {@link Service#isJwtGrantUnsignedJwtRejected() + jwtGrantUnsignedJwtRejected} flag of the service is `true` or (b) + finish validation on the JWT. Note that Authlete does not verify the + signature of the JWT because there is no standard way to obtain the key + to verify the signature of a JWT with. This means that you must verify + the signature by yourself. + + Authlete provides some configuration options for the grant type as listed + below. Authorization server implementers may utilize them and/or implement + their own rules. + + + ``` + HTTP/1.1 200 OK + Content-Type: application/json + Cache-Control: no-cache, no-store + { + "access_token": "{@link TokenCreateResponse#getAccessToken()}", + "token_type": "Bearer", + "expires_in": {@link TokenCreateResponse#getExpiresIn()}, + "scope": "String.join(" ", {@link TokenCreateResponse#getScopes()})" + } + ``` + + Finally, note again that Authlete does not verify the signature of the JWT + specified by the `assertion` request parameter. You must verify the + signature by yourself. +
- operationId: auth_token_fail_api + operationId: auth_token_api + parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: + type: string requestBody: content: application/json: example: - ticket: 83BNqKIhGMyrkvop_7jQjv2Z1612LNdGSQKkvkrf47c - reason: INVALID_RESOURCE_OWNER_CREDENTIALS + parameters: grant_type=authorization_code&code=Xv_su944auuBgc5mfUnxXayiiQU9Z4-T_Yae_UfExmo&redirect_uri=https%3A%2F%2Fmy-client.example.com%2Fcb1&code_verifier=dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk + clientId: "26478243745571" + clientSecret: gXz97ISgLs4HuXwOZWch8GEmgL4YMvUJwu3er_kDVVGcA0UOhA9avLPbEmoeZdagi9yC_-tEiT2BdRyH9dbrQQ schema: - $ref: '#/components/schemas/token_fail_request' + $ref: '#/components/schemas/token_request' application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/token_fail_request' + $ref: '#/components/schemas/token_request' required: true responses: "200": content: application/json: example: - resultCode: A067301 - resultMessage: "[A067301] The credentials (username & password) passed\ - \ to the token endpoint are invalid." - action: BAD_REQUEST - responseContent: "{\\\"error_description\\\":\\\"[A067301] The credentials\ - \ (username & password) passed to the token endpoint are invalid.\\\ - \",\\\"error\\\":\\\"invalid_request\\\",\\\"error_uri\\\":\\\"\ - https://docs.authlete.com/#A067301\\\"}" + resultCode: A050001 + resultMessage: "[A050001] The token request (grant_type=authorization_code)\ + \ was processed successfully." + accessToken: C4SrUTijIj2IxqE1xBASr3dxQWgso3BpY49g8CyjGjQ + accessTokenDuration: 3600 + accessTokenExpiresAt: 1640252942736 + action: OK + clientAttributes: + - key: attribute1-key + value: attribute1-value + - key: attribute2-key + value: attribute2-value + clientId: 26478243745571 + clientIdAlias: my-client + clientIdAliasUsed: false + grantType: AUTHORIZATION_CODE + refreshToken: 60k0cZ38sJcpTgdxvG9Sqa-3RG5AmGExGpFB-1imSxo + refreshTokenDuration: 3600 + refreshTokenExpiresAt: 1640252942736 + responseContent: "{\\\"access_token\\\":\\\"C4SrUTijIj2IxqE1xBASr3dxQWgso3BpY49g8CyjGjQ\\\ + \",\\\"refresh_token\\\":\\\"60k0cZ38sJcpTgdxvG9Sqa-3RG5AmGExGpFB-1imSxo\\\ + \",\\\"scope\\\":\\\"history.read timeline.read\\\",\\\"token_type\\\ + \":\\\"Bearer\\\",\\\"expires_in\\\":3600}" + scopes: + - history.read + - timeline.read + serviceAttributes: + - key: attribute1-key + value: attribute1-value + - key: attribute2-key + value: attribute2-value + subject: john schema: - $ref: '#/components/schemas/token_fail_response' + $ref: '#/components/schemas/token_response' description: "" "400": content: @@ -5570,61 +4487,211 @@ paths: $ref: '#/components/schemas/result' description: "" security: - - ServiceCredentials: [] - summary: /api/auth/token/fail API + - UseService: [] + summary: "/api/{serviceId}/auth/token API" tags: - Token Endpoint x-code-samples: - lang: shell label: curl source: | - curl -v -X POST https://api.authlete.com/api/auth/token/fail \ + curl -v -X POST https://beta.authlete.com/api/21653835348762/auth/token \ -H 'Content-Type: application/json' \ - -u '21653835348762:uE4NgqeIpuSV_XejQ7Ds3jsgA1yXhjR1MXJ1LbPuyls' \ - -d '{ "ticket": "83BNqKIhGMyrkvop_7jQjv2Z1612LNdGSQKkvkrf47c", "reason": "INVALID_RESOURCE_OWNER_CREDENTIALS" }' + -u 'Authorization: Bearer V5a40R6dWvw2gMkCOBFdZcM95q4HC0Z-T0YKD9-nR6F' \ + -d '{ "parameters": "grant_type=authorization_code&code=Xv_su944auuBgc5mfUnxXayiiQU9Z4-T_Yae_UfExmo&redirect_uri=https%3A%2F%2Fmy-client.example.com%2Fcb1&code_verifier=dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk", "clientId": "57297408867", "clientSecret": "J_3C7P0nDTP7CwCg_HyPQh7bTQ1696CC8GWot-EjesZmdBiU5Gsidq5Ve3tMaN2x2_VcKV1UE1U3ZdGKRuTs7A" }' - lang: java label: java source: | AuthleteConfiguration conf = ...; AuthleteApi api = AuthleteApiFactory.create(conf); - TokenFailRequest req = new TokenFailRequest(); - req.setTicket("83BNqKIhGMyrkvop_7jQjv2Z1612LNdGSQKkvkrf47c"); - req.setReason(TokenFailRequest.Reason.INVALID_RESOURCE_OWNER_CREDENTIALS); + TokenRequest req = new TokenRequest(); + req.setParameters(...); + req.setClientId("57297408867"); + req.setClientSecret("J_3C7P0nDTP7CwCg_HyPQh7bTQ1696CC8GWot-EjesZmdBiU5Gsidq5Ve3tMaN2x2_VcKV1UE1U3ZdGKRuTs7A"); - api.tokenFail(req); - - lang: cs - label: C# + api.token(req); + - lang: python source: | - IAuthleteConfiguration conf = ...; - IAuthleteApi api = new AuthleteApi(conf); + conf = ... + api = AuthleteApiImpl(conf) - TokenFailRequest req = new TokenFailRequest(); - req.Ticket = "83BNqKIhGMyrkvop_7jQjv2Z1612LNdGSQKkvkrf47c"; - req.Reason = TokenFailReason.INVALID_RESOURCE_OWNER_CREDENTIALS; + req = TokenRequest() + req.parameters = ... + req.clientId = '57297408867' + req.clientSecret = 'J_3C7P0nDTP7CwCg_HyPQh7bTQ1696CC8GWot-EjesZmdBiU5Gsidq5Ve3tMaN2x2_VcKV1UE1U3ZdGKRuTs7A' - await api.TokenFail(req); - - lang: php - label: PHP - source: | - $conf = ...; - $api = new AuthleteApiImpl($conf); + api.token(req) + /api/{serviceId}/auth/token/fail: + post: + description: | + This API generates a content of an error token response that the authorization server implementation + returns to the client application. + +
+
+ Description + + This API is supposed to be called from within the implementation of the token endpoint of the service + in order to generate an error response to the client application. + + The description of the `/auth/token` API describes the timing when this API should be called. See + the description for the case of `action=PASSWORD`. + + The response from `/auth/token/fail` API has some parameters. Among them, it is `action` parameter + that the authorization server implementation should check first because it denotes the next action + that the authorization server implementation should take. According to the value of `action`, the + authorization server implementation must take the steps described below. + + **INTERNAL_SERVER_ERROR** + + When the value of `action` is `INTERNAL_SERVER_ERROR`, it means that the request from the authorization + server implementation was wrong or that an error occurred in Authlete. + + In either case, from the viewpoint of the client application, it is an error on the server side. + Therefore, the service implementation should generate a response to the client application with + HTTP status of "500 Internal Server Error". + + The value of `responseContent` is a JSON string which describes the error, so it can be used + as the entity body of the response. + + The following illustrates the response which the service implementation should generate and return + to the client application. + + ``` + HTTP/1.1 500 Internal Server Error + Content-Type: application/json + Cache-Control: no-store + Pragma: no-cache + + {responseContent} + ``` + + The endpoint implementation may return another different response to the client application + since "500 Internal Server Error" is not required by OAuth 2.0. + + **BAD_REQUEST** + + When the value of `action` is `BAD_REQUEST`, it means that Authlete's `/auth/token/fail` API successfully + generated an error response for the client application. + + The HTTP status of the response returned to the client application must be "400 Bad Request" and + the content type must be `application/json`. + + The value of `responseContent` is a JSON string which describes the error, so it can be used + as the entity body of the response. + + The following illustrates the response which the service implementation should generate and return + to the client application. + + ``` + HTTP/1.1 400 Bad Request + Content-Type: application/json + Cache-Control: no-store + Pragma: no-cache - $req = new TokenFailRequest(); - $req.setTicket("83BNqKIhGMyrkvop_7jQjv2Z1612LNdGSQKkvkrf47c"); - $req.setReason(TokenFailReason.INVALID_RESOURCE_OWNER_CREDENTIALS); + {responseContent} + ``` - $api.tokenFail($req); - - lang: ruby +
+ operationId: auth_token_fail_api + parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: + type: string + requestBody: + content: + application/json: + example: + ticket: 83BNqKIhGMyrkvop_7jQjv2Z1612LNdGSQKkvkrf47c + reason: INVALID_RESOURCE_OWNER_CREDENTIALS + schema: + $ref: '#/components/schemas/token_fail_request' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/token_fail_request' + required: true + responses: + "200": + content: + application/json: + example: + resultCode: A067301 + resultMessage: "[A067301] The credentials (username & password) passed\ + \ to the token endpoint are invalid." + action: BAD_REQUEST + responseContent: "{\\\"error_description\\\":\\\"[A067301] The credentials\ + \ (username & password) passed to the token endpoint are invalid.\\\ + \",\\\"error\\\":\\\"invalid_request\\\",\\\"error_uri\\\":\\\"\ + https://docs.authlete.com/#A067301\\\"}" + schema: + $ref: '#/components/schemas/token_fail_response' + description: "" + "400": + content: + application/json: + example: + resultCode: A001201 + resultMessage: "[A001201] /auth/authorization, TLS must be used." + schema: + $ref: '#/components/schemas/result' + description: "" + "401": + content: + application/json: + example: + resultCode: A001202 + resultMessage: "[A001202] /auth/authorization, Authorization header\ + \ is missing." + schema: + $ref: '#/components/schemas/result' + description: "" + "403": + content: + application/json: + example: + resultCode: A001215 + resultMessage: "[A001215] /auth/authorization, The client (ID = 26837717140341)\ + \ is locked." + schema: + $ref: '#/components/schemas/result' + description: "" + "500": + content: + application/json: + example: + resultCode: A001101 + resultMessage: "[A001101] /auth/authorization, Authlete Server error." + schema: + $ref: '#/components/schemas/result' + description: "" + security: + - UseService: [] + summary: "/api/{serviceId}/auth/token/fail API" + tags: + - Token Endpoint + x-code-samples: + - lang: shell + label: curl source: | - conf = ... - api = Authlete::Api.new(conf) + curl -v -X POST https://beta.authlete.com/api/21653835348762/auth/token/fail \ + -H 'Content-Type: application/json' \ + -u 'Authorization: Bearer V5a40R6dWvw2gMkCOBFdZcM95q4HC0Z-T0YKD9-nR6F' \ + -d '{ "ticket": "83BNqKIhGMyrkvop_7jQjv2Z1612LNdGSQKkvkrf47c", "reason": "INVALID_RESOURCE_OWNER_CREDENTIALS" }' + - lang: java + label: java + source: | + AuthleteConfiguration conf = ...; + AuthleteApi api = AuthleteApiFactory.create(conf); - req = Authlete::Model::Request::TokenFailRequest.new - req.ticket = '83BNqKIhGMyrkvop_7jQjv2Z1612LNdGSQKkvkrf47c' - req.reason = 'INVALID_RESOURCE_OWNER_CREDENTIALS' + TokenFailRequest req = new TokenFailRequest(); + req.setTicket("83BNqKIhGMyrkvop_7jQjv2Z1612LNdGSQKkvkrf47c"); + req.setReason(TokenFailRequest.Reason.INVALID_RESOURCE_OWNER_CREDENTIALS); - api.token_fail(req) + api.tokenFail(req); - lang: python source: | conf = ... @@ -5635,28 +4702,7 @@ paths: req.reason = TokenFailReason.INVALID_RESOURCE_OWNER_CREDENTIALS api.tokenFail(req) - - lang: go - source: | - conf := ... - api := api.New(&conf) - - req := dto.TokenFailRequest{} - req.Ticket = "83BNqKIhGMyrkvop_7jQjv2Z1612LNdGSQKkvkrf47c" - req.Reason = TokenFailReason.INVALID_RESOURCE_OWNER_CREDENTIALS - - api.TokenFail(&req) - - lang: ts - label: deno - source: | - const conf: AuthleteConfiguration = ...; - const api: AuthleteApi = new AuthleteApiImpl(conf); - - const req = new TokenFailRequest(); - req.ticket = '83BNqKIhGMyrkvop_7jQjv2Z1612LNdGSQKkvkrf47c'; - req.reason = TokenFailRequest.Reason.INVALID_RESOURCE_OWNER_CREDENTIALS; - - await api.tokenFail(req); - /api/auth/token/issue: + /api/{serviceId}/auth/token/issue: post: description: | This API generates a content of a successful token response that the authorization server implementation @@ -5729,6 +4775,13 @@ paths:
operationId: auth_token_issue_api + parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: + type: string requestBody: content: application/json: @@ -5816,17 +4869,17 @@ paths: $ref: '#/components/schemas/result' description: "" security: - - ServiceCredentials: [] - summary: /api/auth/token/issue API + - UseService: [] + summary: "/api/{serviceId}/auth/token/issue API" tags: - Token Endpoint x-code-samples: - lang: shell label: curl source: | - curl -v -X POST https://api.authlete.com/api/auth/token/issue \ + curl -v -X POST https://beta.authlete.com/api/21653835348762/auth/token/issue \ -H 'Content-Type: application/json' \ - -u '21653835348762:uE4NgqeIpuSV_XejQ7Ds3jsgA1yXhjR1MXJ1LbPuyls' \ + -u 'Authorization: Bearer V5a40R6dWvw2gMkCOBFdZcM95q4HC0Z-T0YKD9-nR6F' \ -d '{ "ticket": "p7SXQ9JFjng7KFOZdCMBKcoR3ift7B54l1LGIgQXqEM", "subject": "john" }' - lang: java label: java @@ -5838,35 +4891,6 @@ paths: req.setTicket("83BNqKIhGMyrkvop_7jQjv2Z1612LNdGSQKkvkrf47c"); api.tokenIssue(req); - - lang: cs - label: C# - source: | - IAuthleteConfiguration conf = ...; - IAuthleteApi api = new AuthleteApi(conf); - - TokenIssueRequest req = new TokenIssueRequest(); - req.Ticket = "83BNqKIhGMyrkvop_7jQjv2Z1612LNdGSQKkvkrf47c"; - - await api.TokenIssue(req); - - lang: php - label: PHP - source: | - $conf = ...; - $api = new AuthleteApiImpl($conf); - - $req = new TokenIssueRequest(); - $req.setTicket("83BNqKIhGMyrkvop_7jQjv2Z1612LNdGSQKkvkrf47c"); - - $api.tokenIssue($req); - - lang: ruby - source: | - conf = ... - api = Authlete::Api.new(conf) - - req = Authlete::Model::Request::TokenIssueRequest.new - req.ticket = '83BNqKIhGMyrkvop_7jQjv2Z1612LNdGSQKkvkrf47c' - - api.token_issue(req) - lang: python source: | conf = ... @@ -5876,90 +4900,7 @@ paths: req.ticket = '83BNqKIhGMyrkvop_7jQjv2Z1612LNdGSQKkvkrf47c' api.tokenIssue(req) - - lang: go - source: | - conf := ... - api := api.New(&conf) - - req := dto.TokenIssueRequest{} - req.Ticket = "83BNqKIhGMyrkvop_7jQjv2Z1612LNdGSQKkvkrf47c" - - api.TokenIssue(&req) - - lang: ts - label: deno - source: | - const conf: AuthleteConfiguration = ...; - const api: AuthleteApi = new AuthleteApiImpl(conf); - - const req = new TokenIssueRequest(); - req.ticket = '83BNqKIhGMyrkvop_7jQjv2Z1612LNdGSQKkvkrf47c'; - - await api.tokenIssue(req); - /api/idtoken/reissue: - post: - description: | - The API is expected to be called only when the value of the `action` - parameter in a response from the `/auth/token` API is {@link - TokenResponse.Action#ID_TOKEN_REISSUABLE ID_TOKEN_REISSUABLE}. The purpose - of the `/idtoken/reissue` API is to generate a token response that - includes a new ID token together with a new access token and a refresh - token. - operationId: idtoken_reissue_api - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/idtoken_reissue_request' - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/idtoken_reissue_response' - "400": - content: - application/json: - example: - resultCode: A001201 - resultMessage: "[A001201] /auth/authorization, TLS must be used." - schema: - $ref: '#/components/schemas/result' - description: "" - "401": - content: - application/json: - example: - resultCode: A001202 - resultMessage: "[A001202] /auth/authorization, Authorization header\ - \ is missing." - schema: - $ref: '#/components/schemas/result' - description: "" - "403": - content: - application/json: - example: - resultCode: A001215 - resultMessage: "[A001215] /auth/authorization, The client (ID = 26837717140341)\ - \ is locked." - schema: - $ref: '#/components/schemas/result' - description: "" - "500": - content: - application/json: - example: - resultCode: A001101 - resultMessage: "[A001101] /auth/authorization, Authlete Server error." - schema: - $ref: '#/components/schemas/result' - description: "" - security: - - ServiceCredentials: [] - summary: /api/idtoken/reissue API - tags: - - ID Token Endpoint - /api/auth/introspection: + /api/{serviceId}/auth/introspection: post: description: | This API gathers information about an access token. @@ -6128,8 +5069,15 @@ paths: operationId: auth_introspection_api - requestBody: - content: + parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: + type: string + requestBody: + content: application/json: example: token: VFGsNK-5sXiqterdaR7b5QbRX9VTwVCQB87jbr2_xAI @@ -6216,17 +5164,17 @@ paths: $ref: '#/components/schemas/result' description: "" security: - - ServiceCredentials: [] - summary: /api/auth/introspection API + - UseService: [] + summary: "/api/{serviceId}/auth/introspection API" tags: - Introspection Endpoint x-code-samples: - lang: shell label: curl source: | - curl -v -X POST https://api.authlete.com/api/auth/introspection \ + curl -v -X POST https://beta.authlete.com/api/21653835348762/auth/introspection \ -H 'Content-Type:application/json' \ - -u '21653835348762:uE4NgqeIpuSV_XejQ7Ds3jsgA1yXhjR1MXJ1LbPuyls' \ + -u 'Authorization: Bearer V5a40R6dWvw2gMkCOBFdZcM95q4HC0Z-T0YKD9-nR6F' \ -d '{ "token": "VFGsNK-5sXiqterdaR7b5QbRX9VTwVCQB87jbr2_xAI", "scopes": [ "history.read", "timeline.read" ] }' - lang: java label: java @@ -6239,38 +5187,6 @@ paths: req.setScopes(new String[] { "history.read", "timeline.read" }); api.introspection(req); - - lang: cs - label: C# - source: | - IAuthleteConfiguration conf = ...; - IAuthleteApi api = new AuthleteApi(conf); - - IntrospectionRequest req = new IntrospectionRequest(); - req.Token = "VFGsNK-5sXiqterdaR7b5QbRX9VTwVCQB87jbr2_xAI"; - req.Scopes = { "history.read", "timeline.read" }; - - await api.Introspection(req); - - lang: php - label: PHP - source: | - $conf = ...; - $api = new AuthleteApiImpl($conf); - - $req = new IntrospectionRequest(); - $req.setToken("VFGsNK-5sXiqterdaR7b5QbRX9VTwVCQB87jbr2_xAI"); - $req.setScopes([ "history.read", "timeline.read" ]); - - $api.introspection($req); - - lang: ruby - source: | - conf = ... - api = Authlete::Api.new(conf) - - req = Authlete::Model::Request::IntrospectionRequest.new - req.token = 'VFGsNK-5sXiqterdaR7b5QbRX9VTwVCQB87jbr2_xAI' - req.scopes = [ 'history.read', 'timeline.read' ] - - api.introspection(req) - lang: python source: | conf = ... @@ -6281,28 +5197,7 @@ paths: req.scopes = [ 'history.read', 'timeline.read' ] api.introspection(req) - - lang: go - source: | - conf := ... - api := api.New(&conf) - - req := dto.IntrospectionRequest{} - req.Token = "VFGsNK-5sXiqterdaR7b5QbRX9VTwVCQB87jbr2_xAI" - req.Scopes = [1]string{ "history.read", "timeline.read" } - - api.Introspection(&req) - - lang: ts - label: deno - source: | - const conf: AuthleteConfiguration = ...; - const api: AuthleteApi = new AuthleteApiImpl(conf); - - const req = new IntrospectionRequest(); - req.token = 'VFGsNK-5sXiqterdaR7b5QbRX9VTwVCQB87jbr2_xAI'; - req.scopes = [ 'history.read', 'timeline.read' ]; - - await api.introspection(req); - /api/auth/introspection/standard: + /api/{serviceId}/auth/introspection/standard: post: description: | This API exists to help your authorization server provide its own introspection API which complies @@ -6401,6 +5296,13 @@ paths: operationId: auth_introspection_standard_api + parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: + type: string requestBody: content: application/json: @@ -6467,17 +5369,17 @@ paths: $ref: '#/components/schemas/result' description: "" security: - - ServiceCredentials: [] - summary: /api/auth/introspection/standard API + - UseService: [] + summary: "/api/{serviceId}/auth/introspection/standard API" tags: - Introspection Endpoint x-code-samples: - lang: shell label: curl source: | - curl -v -X POST https://api.authlete.com/api/auth/introspection/standard \ + curl -v -X POST https://beta.authlete.com/api/21653835348762/auth/introspection/standard \ -H "Content-Type:application/json" \ - -u '21653835348762:uE4NgqeIpuSV_XejQ7Ds3jsgA1yXhjR1MXJ1LbPuyls' \ + -u 'Authorization: Bearer V5a40R6dWvw2gMkCOBFdZcM95q4HC0Z-T0YKD9-nR6F' \ -d '{ "parameters":"token=VFGsNK-5sXiqterdaR7b5QbRX9VTwVCQB87jbr2_xAI&token_type_hint=access_token" }' - lang: java label: java @@ -6489,35 +5391,6 @@ paths: req.setParameters(...); api.standardIntrospection(req); - - lang: cs - label: C# - source: | - IAuthleteConfiguration conf = ...; - IAuthleteApi api = new AuthleteApi(conf); - - StandardIntrospectionRequest req = new StandardIntrospectionRequest(); - req.Parameters = ...; - - await api.StandardIntrospection(req); - - lang: php - label: PHP - source: | - $conf = ...; - $api = new AuthleteApiImpl($conf); - - $req = new StandardIntrospectionRequest(); - $req.setParameters(...); - - $api.standardIntrospection($req); - - lang: ruby - source: | - conf = ... - api = Authlete::Api.new(conf) - - req = Authlete::Model::Request::StandardIntrospectionRequest.new - req.parameters = '...' - - api.standard_introspection(req) - lang: python source: | conf = ... @@ -6527,26 +5400,7 @@ paths: req.parameters = ... api.standardIntrospection(req) - - lang: go - source: | - conf := ... - api := api.New(&conf) - - req := dto.StandardIntrospectionRequest{} - req.Parameters = ... - - api.StandardIntrospection(&req) - - lang: ts - label: deno - source: | - const conf: AuthleteConfiguration = ...; - const api: AuthleteApi = new AuthleteApiImpl(conf); - - const req = new StandardIntrospectionRequest(); - req.parameters = ...; - - await api.standardIntrospection(req); - /api/auth/revocation: + /api/{serviceId}/auth/revocation: post: description: | This API revokes access tokens and refresh tokens. @@ -6682,6 +5536,13 @@ paths: ``` operationId: auth_revocation_api + parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: + type: string requestBody: content: application/json: @@ -6745,17 +5606,17 @@ paths: $ref: '#/components/schemas/result' description: "" security: - - ServiceCredentials: [] - summary: /api/auth/revocation API + - UseService: [] + summary: "/api/{serviceId}/auth/revocation API" tags: - Revocation Endpoint x-code-samples: - lang: shell label: curl source: | - curl -v -X POST https://api.authlete.com/api/auth/revocation \ + curl -v -X POST https://beta.authlete.com/api/21653835348762/auth/revocation \ -H 'Content-Type:application/json' \ - -u '21653835348762:uE4NgqeIpuSV_XejQ7Ds3jsgA1yXhjR1MXJ1LbPuyls' \ + -u 'Authorization: Bearer V5a40R6dWvw2gMkCOBFdZcM95q4HC0Z-T0YKD9-nR6F' \ -d '{ "parameters": "token=VFGsNK-5sXiqterdaR7b5QbRX9VTwVCQB87jbr2_xAI&token_type_hint=access_token", "clientId": "26478243745571", "clientSecret": "gXz97ISgLs4HuXwOZWch8GEmgL4YMvUJwu3er_kDVVGcA0UOhA9avLPbEmoeZdagi9yC_-tEiT2BdRyH9dbrQQ" }' - lang: java label: java @@ -6767,35 +5628,6 @@ paths: request.setParameters(...); api.revocation(req); - - lang: cs - label: C# - source: | - IAuthleteConfiguration conf = ...; - IAuthleteApi api = new AuthleteApi(conf); - - RevocationRequest req = new RevocationRequest(); - req.Parameters = ...; - - await api.Revocation(req); - - lang: php - label: PHP - source: | - $conf = ...; - $api = new AuthleteApiImpl($conf); - - $req = new RevocationRequest(); - $req.setParameters(...); - - $api.revocation($req); - - lang: ruby - source: | - conf = ... - api = Authlete::Api.new(conf) - - req = Authlete::Model::Request::RevocationRequest.new - req.parameters = '...' - - api.revocation(req) - lang: python source: | conf = ... @@ -6805,26 +5637,7 @@ paths: req.parameters = ... api.revocation(req) - - lang: go - source: | - conf := ... - api := api.New(&conf) - - req := dto.RevocationRequest{} - req.Parameters = ... - - api.Revocation(&req) - - lang: ts - label: deno - source: | - const conf: AuthleteConfiguration = ...; - const api: AuthleteApi = new AuthleteApiImpl(conf); - - const req = new RevocationRequest(); - req.parameters = ...; - - await api.revocation(req); - /api/auth/userinfo: + /api/{serviceId}/auth/userinfo: post: description: | This API gathers information about a user. @@ -6969,6 +5782,13 @@ paths: ``` operationId: auth_userinfo_api + parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: + type: string requestBody: content: application/json: @@ -7037,17 +5857,17 @@ paths: $ref: '#/components/schemas/result' description: "" security: - - ServiceCredentials: [] - summary: /api/auth/userinfo API + - UseService: [] + summary: "/api/{serviceId}/auth/userinfo API" tags: - UserInfo Endpoint x-code-samples: - lang: shell label: curl source: | - curl -v -X POST https://api.authlete.com/api/auth/userinfo \ + curl -v -X POST https://beta.authlete.com/api/21653835348762/auth/userinfo \ -H 'Content-Type:application/json' \ - -u '21653835348762:uE4NgqeIpuSV_XejQ7Ds3jsgA1yXhjR1MXJ1LbPuyls' \ + -u 'Authorization: Bearer V5a40R6dWvw2gMkCOBFdZcM95q4HC0Z-T0YKD9-nR6F' \ -d '{ "token": "Ntm9MDb8WXQAevqrBkd84KTTHbYHVQrTjgUZCOWqEUI" }' - lang: java label: java @@ -7059,35 +5879,6 @@ paths: req.setToken("Ntm9MDb8WXQAevqrBkd84KTTHbYHVQrTjgUZCOWqEUI"); api.userinfo(req); - - lang: cs - label: C# - source: | - IAuthleteConfiguration conf = ...; - IAuthleteApi api = new AuthleteApi(conf); - - UserInfoRequest req = new UserInfoRequest(); - req.Token = "Ntm9MDb8WXQAevqrBkd84KTTHbYHVQrTjgUZCOWqEUI"; - - await api.Userinfo(req); - - lang: php - label: PHP - source: | - $conf = ...; - $api = new AuthleteApiImpl($conf); - - $req = new UserInfoRequest(); - $req.setToken("Ntm9MDb8WXQAevqrBkd84KTTHbYHVQrTjgUZCOWqEUI"); - - $api.userinfo($req); - - lang: ruby - source: | - conf = ... - api = Authlete::Api.new(conf) - - req = Authlete::Model::Request::UserInfoRequest.new - req.token = 'Ntm9MDb8WXQAevqrBkd84KTTHbYHVQrTjgUZCOWqEUI' - - api.user_info(req) - lang: python source: | conf = ... @@ -7097,26 +5888,7 @@ paths: req.token = 'Ntm9MDb8WXQAevqrBkd84KTTHbYHVQrTjgUZCOWqEUI' api.userinfo(req) - - lang: go - source: | - conf := ... - api := api.New(&conf) - - req := dto.UserInfoRequest{} - req.Token = "Ntm9MDb8WXQAevqrBkd84KTTHbYHVQrTjgUZCOWqEUI" - - api.Userinfo(&req) - - lang: ts - label: deno - source: | - const conf: AuthleteConfiguration = ...; - const api: AuthleteApi = new AuthleteApiImpl(conf); - - const req = new UserInfoRequest(); - req.token = 'Ntm9MDb8WXQAevqrBkd84KTTHbYHVQrTjgUZCOWqEUI'; - - await api.userInfo(req); - /api/auth/userinfo/issue: + /api/{serviceId}/auth/userinfo/issue: post: description: | This API generates an ID token. @@ -7269,6 +6041,13 @@ paths: operationId: auth_userinfo_issue_api + parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: + type: string requestBody: content: application/json: @@ -7333,17 +6112,17 @@ paths: $ref: '#/components/schemas/result' description: "" security: - - ServiceCredentials: [] - summary: /api/auth/userinfo/issue API + - UseService: [] + summary: "/api/{serviceId}/auth/userinfo/issue API" tags: - UserInfo Endpoint x-code-samples: - lang: shell label: curl source: | - curl -v -X POST https://api.authlete.com/api/auth/userinfo/issue \ + curl -v -X POST https://beta.authlete.com/api/21653835348762/auth/userinfo/issue \ -H 'Content-Type:application/json' \ - -u '21653835348762:uE4NgqeIpuSV_XejQ7Ds3jsgA1yXhjR1MXJ1LbPuyls' \ + -u 'Authorization: Bearer V5a40R6dWvw2gMkCOBFdZcM95q4HC0Z-T0YKD9-nR6F' \ -d '{ "token": "Ntm9MDb8WXQAevqrBkd84KTTHbYHVQrTjgUZCOWqEUI" }' - lang: java label: java @@ -7355,35 +6134,6 @@ paths: req.setToken("Ntm9MDb8WXQAevqrBkd84KTTHbYHVQrTjgUZCOWqEUI"); api.userinfoIssue(req); - - lang: cs - label: C# - source: | - IAuthleteConfiguration conf = ...; - IAuthleteApi api = new AuthleteApi(conf); - - UserInfoIssueRequest req = new UserInfoIssueRequest(); - req.Token = "Ntm9MDb8WXQAevqrBkd84KTTHbYHVQrTjgUZCOWqEUI"; - - await api.UserinfoIssue(req); - - lang: php - label: PHP - source: | - $conf = ...; - $api = new AuthleteApiImpl($conf); - - $req = new UserInfoIssueRequest(); - $req.setToken("Ntm9MDb8WXQAevqrBkd84KTTHbYHVQrTjgUZCOWqEUI"); - - $api.userinfoIssue($req); - - lang: ruby - source: | - conf = ... - api = Authlete::Api.new(conf) - - req = Authlete::Model::Request::UserInfoIssueRequest.new - req.token = 'Ntm9MDb8WXQAevqrBkd84KTTHbYHVQrTjgUZCOWqEUI' - - api.user_info_issue(req) - lang: python source: | conf = ... @@ -7393,31 +6143,90 @@ paths: req.token = 'Ntm9MDb8WXQAevqrBkd84KTTHbYHVQrTjgUZCOWqEUI' api.userinfoIssue(req) - - lang: go - source: | - conf := ... - api := api.New(&conf) - - req := dto.UserInfoIssueRequest{} - req.Token = "Ntm9MDb8WXQAevqrBkd84KTTHbYHVQrTjgUZCOWqEUI" - - api.UserinfoIssue(&req) - - lang: ts - label: deno - source: | - const conf: AuthleteConfiguration = ...; - const api: AuthleteApi = new AuthleteApiImpl(conf); - - const req = new UserInfoIssueRequest(); - req.token = 'Ntm9MDb8WXQAevqrBkd84KTTHbYHVQrTjgUZCOWqEUI'; - - await api.userInfoIssue(req); - /api/gm: + /api/{serviceId}/idtoken/reissue: + post: + description: | + The API is expected to be called only when the value of the `action` + parameter in a response from the `/auth/token` API is {@link + TokenResponse.Action#ID_TOKEN_REISSUABLE ID_TOKEN_REISSUABLE}. The purpose + of the `/idtoken/reissue` API is to generate a token response that + includes a new ID token together with a new access token and a refresh + token. + operationId: idtoken_reissue_api + parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/idtoken_reissue_request' + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/idtoken_reissue_response' + "400": + content: + application/json: + example: + resultCode: A001201 + resultMessage: "[A001201] /auth/authorization, TLS must be used." + schema: + $ref: '#/components/schemas/result' + description: "" + "401": + content: + application/json: + example: + resultCode: A001202 + resultMessage: "[A001202] /auth/authorization, Authorization header\ + \ is missing." + schema: + $ref: '#/components/schemas/result' + description: "" + "403": + content: + application/json: + example: + resultCode: A001215 + resultMessage: "[A001215] /auth/authorization, The client (ID = 26837717140341)\ + \ is locked." + schema: + $ref: '#/components/schemas/result' + description: "" + "500": + content: + application/json: + example: + resultCode: A001101 + resultMessage: "[A001101] /auth/authorization, Authlete Server error." + schema: + $ref: '#/components/schemas/result' + description: "" + security: + - UseService: [] + summary: "/api/{serviceId}/idtoken/reissue API" + tags: + - Token Endpoint + /api/{serviceId}/gm: post: description: | The API is for the implementation of the grant management endpoint which is defined in "Grant Management for OAuth 2.0". operationId: grant_m_api + parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: + type: string requestBody: content: application/json: @@ -7475,11 +6284,11 @@ paths: $ref: '#/components/schemas/result' description: "" security: - - ServiceCredentials: [] - summary: /api/gm API + - UseService: [] + summary: "/api/{serviceId}/gm API" tags: - Grant Management Endpoint - /api/service/jwks/get: + /api/{serviceId}/service/jwks/get: get: description: | This API gathers JWK Set information for a service so that its client applications can verify @@ -7498,6 +6307,12 @@ paths: operationId: service_jwks_get_api parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: + type: string - description: "The boolean value that indicates whether the response should\ \ include the private keys associated with the service or not. If `true`,\ \ the private keys are included in the response. The default value is `false`." @@ -7586,16 +6401,16 @@ paths: $ref: '#/components/schemas/result' description: "" security: - - ServiceCredentials: [] - summary: /api/service/jwks/get API + - UseService: [] + summary: "/api/{serviceId}/service/jwks/get API" tags: - JWK Set Endpoint x-code-samples: - lang: shell label: curl source: | - curl -v https://api.authlete.com/api/service/jwks/get?pretty=true \ - -u '21653835348762:uE4NgqeIpuSV_XejQ7Ds3jsgA1yXhjR1MXJ1LbPuyls' + curl -v https://beta.authlete.com/api/21653835348762/service/jwks/get?pretty=true \ + -u 'Authorization: Bearer V5a40R6dWvw2gMkCOBFdZcM95q4HC0Z-T0YKD9-nR6F' - lang: java label: java source: | @@ -7606,32 +6421,6 @@ paths: boolean includePrivateKey = false; api.getServiceJwks(pretty, includePrivateKey); - - lang: cs - label: C# - source: | - IAuthleteConfiguration conf = ...; - IAuthleteApi api = new AuthleteApi(conf); - - bool pretty = true; - bool includePrivateKey = false; - - await api.GetServiceJwks(pretty, includePrivateKey); - - lang: php - label: PHP - source: | - $conf = ...; - $api = new AuthleteApiImpl($conf); - - $pretty = true; - $includePrivateKey = false; - - $api.getServiceJwks($pretty, $includePrivateKey); - - lang: ruby - source: | - conf = ... - api = Authlete::Api.new(conf) - - api.get_service_jwks(pretty: true, includePrivateKeys: false) - lang: python source: | conf = ... @@ -7641,26 +6430,7 @@ paths: includePrivateKey = False api.getServiceJwks(pretty, includePrivateKey) - - lang: go - source: | - conf := ... - api := api.New(&conf) - - pretty := true - includePrivateKey := false - - api.GetServiceJwks(pretty, includePrivateKey) - - lang: ts - label: deno - source: | - const conf: AuthleteConfiguration = ...; - const api: AuthleteApi = new AuthleteApiImpl(conf); - - const pretty = true; - const includePrivateKey = false; - - await api.getServiceJwks(pretty, includePrivateKey); - /api/service/configuration: + /api/{serviceId}/service/configuration: get: description: | This API gathers configuration information about a service. @@ -7678,6 +6448,12 @@ paths: operationId: service_configuration_api parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: + type: string - description: "This boolean value indicates whether the JSON in the response\ \ should be formatted or not. If `true`, the JSON in the response is pretty-formatted.\ \ The default value is `false`." @@ -8020,16 +6796,16 @@ paths: $ref: '#/components/schemas/result' description: "" security: - - ServiceCredentials: [] - summary: /api/service/configuration API + - UseService: [] + summary: "/api/{serviceId}/service/configuration API" tags: - Configuration Endpoint x-code-samples: - lang: shell label: curl source: | - curl -v https://api.authlete.com/api/service/configuration?pretty=true \ - -u '21653835348762:uE4NgqeIpuSV_XejQ7Ds3jsgA1yXhjR1MXJ1LbPuyls' + curl -v https://beta.authlete.com/api/21653835348762/service/configuration?pretty=true \ + -u 'Authorization: Bearer V5a40R6dWvw2gMkCOBFdZcM95q4HC0Z-T0YKD9-nR6F' - lang: java label: java source: | @@ -8037,46 +6813,13 @@ paths: AuthleteApi api = AuthleteApiFactory.create(conf); api.getServiceConfiguration(true); - - lang: cs - label: C# - source: | - IAuthleteConfiguration conf = ...; - IAuthleteApi api = new AuthleteApi(conf); - - await api.GetServiceConfiguration(true); - - lang: php - label: PHP - source: | - $conf = ...; - $api = new AuthleteApiImpl($conf); - - $api.getServiceConfiguration(true); - - lang: ruby - source: | - conf = ... - api = Authlete::Api.new(conf) - - api.get_service_configuration(pretty: true) - lang: python source: | conf = ... api = AuthleteApiImpl(conf) api.getServiceConfiguration(True) - - lang: go - source: | - conf := ... - api := api.New(&conf) - - api.GetServiceConfiguration(true) - - lang: ts - label: deno - source: | - const conf: AuthleteConfiguration = ...; - const api: AuthleteApi = new AuthleteApiImpl(conf); - - await api.getServiceConfiguration(true); - /api/client/registration: + /api/{serviceId}/client/registration: post: description: | Register a client. This API is supposed to be used to implement a client registration endpoint that @@ -8163,6 +6906,13 @@ paths: ``` operationId: client_registration_api + parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: + type: string requestBody: content: application/json: @@ -8259,17 +7009,17 @@ paths: $ref: '#/components/schemas/result' description: "" security: - - ServiceCredentials: [] - summary: /api/client/registration API + - UseService: [] + summary: "/api/{serviceId}/client/registration API" tags: - Dynamic Client Registration x-code-samples: - lang: shell label: curl source: | - curl -v -X POST https://api.authlete.com/api/client/registration \ + curl -v -X POST https://beta.authlete.com/api/21653835348762/client/registration \ -H 'Content-Type:application/json' \ - -u '21653835348762:uE4NgqeIpuSV_XejQ7Ds3jsgA1yXhjR1MXJ1LbPuyls' \ + -u 'Authorization: Bearer V5a40R6dWvw2gMkCOBFdZcM95q4HC0Z-T0YKD9-nR6F' \ -d '{ "json": "{ \"client_name\": \"My Dynamic Client\" }" }' - lang: java label: java @@ -8281,35 +7031,6 @@ paths: req.setJson(...); api.dynamicClientRegister(req); - - lang: cs - label: C# - source: | - IAuthleteConfiguration conf = ...; - IAuthleteApi api = new AuthleteApi(conf); - - ClientRegistrationRequest req = new ClientRegistrationRequest(); - req.Json = "..."; - - await api.DynamicClientRegister(req); - - lang: php - label: PHP - source: | - $conf = ...; - $api = new AuthleteApiImpl($conf); - - $req = new ClientRegistrationRequest(); - $req.json = "..."; - - $api.dynamicClientRegister($req); - - lang: ruby - source: | - conf = ... - api = Authlete::Api.new(conf) - - req = Authlete::Model::ClientRegistrationRequest.new - req.json = '...' - - api.dynamic_client_register(req) - lang: python source: | conf = ... @@ -8319,20 +7040,7 @@ paths: req.json = '...' api.dynamicClientRegister(req) - - lang: go - source: | - conf := ... - api := api.New(&conf) - - req := dto.ClientRegistrationRequest{} - req.Json = "..." - - api.DynamicClientRegister(&req) - - lang: ts - label: deno - source: | - // This API is not supported yet. - /api/client/registration/get: + /api/{serviceId}/client/registration/get: post: description: | Get a dynamically registered client. This API is supposed to be used to implement a client registration @@ -8446,6 +7154,13 @@ paths: ``` operationId: client_registration_get_api + parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: + type: string requestBody: content: application/json: @@ -8453,10 +7168,10 @@ paths: clientId: "26837717140341" token: qs4Tu5TV7qqDYT93bFs6ISyhTByMF9o-54GY4JU5vTA schema: - $ref: '#/components/schemas/client_registration_get_request' + $ref: '#/components/schemas/client_registration_request' application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/client_registration_get_request' + $ref: '#/components/schemas/client_registration_request' required: true responses: "200": @@ -8502,7 +7217,7 @@ paths: \":\\\"RS256\\\",\\\"subject_type\\\":\\\"public\\\",\\\"client_secret_expires_at\\\ \":0,\\\"require_signed_request_object\\\":false}" schema: - $ref: '#/components/schemas/client_registration_get_response' + $ref: '#/components/schemas/client_registration_response' description: "" "400": content: @@ -8543,17 +7258,17 @@ paths: $ref: '#/components/schemas/result' description: "" security: - - ServiceCredentials: [] - summary: /api/client/registration/get API + - UseService: [] + summary: "/api/{serviceId}/client/registration/get API" tags: - Dynamic Client Registration x-code-samples: - lang: shell label: curl source: | - curl -v -X POST https://api.authlete.com/api/client/registration/get \ + curl -v -X POST https://beta.authlete.com/api/21653835348762/client/registration/get \ -H 'Content-Type:application/json' \ - -u '10167240911:LFpGEwpyHKNYMeMHg-H339X8gXdVlix-GoCHQAjAMbI' \ + -u 'Authorization: Bearer V5a40R6dWvw2gMkCOBFdZcM95q4HC0Z-T0YKD9-nR6F' \ -d '{ "clientId": "26837717140341", "token": "qs4Tu5TV7qqDYT93bFs6ISyhTByMF9o-54GY4JU5vTA" }' - lang: java label: java @@ -8566,39 +7281,7 @@ paths: req.setToken("qs4Tu5TV7qqDYT93bFs6ISyhTByMF9o-54GY4JU5vTA"); api.dynamicClientGet(req); - - lang: cs - label: C# - source: | - IAuthleteConfiguration conf = ...; - IAuthleteApi api = new AuthleteApi(conf); - - ClientRegistrationRequest req = new ClientRegistrationRequest(); - req.ClientId = "26837717140341"; - req.Token = "qs4Tu5TV7qqDYT93bFs6ISyhTByMF9o-54GY4JU5vTA"; - - await api.DynamicClientGet(req); - - lang: php - label: PHP - source: | - $conf = ...; - $api = new AuthleteApiImpl($conf); - - $req = new ClientRegistrationRequest(); - $req.clientId = "26837717140341"; - $req.token = "qs4Tu5TV7qqDYT93bFs6ISyhTByMF9o-54GY4JU5vTA"; - - $api.dynamicClientGet($req); - - lang: ruby - source: | - conf = ... - api = Authlete::Api.new(conf) - - req = Authlete::Model::ClientRegistrationRequest.new - req.clientId = '26837717140341' - req.token = 'qs4Tu5TV7qqDYT93bFs6ISyhTByMF9o-54GY4JU5vTA' - - api.dynamic_client_get(req) - - lang: python + - lang: python source: | conf = ... api = AuthleteApiImpl(conf) @@ -8608,21 +7291,7 @@ paths: req.token = 'qs4Tu5TV7qqDYT93bFs6ISyhTByMF9o-54GY4JU5vTA' api.dynamicClientGet(req) - - lang: go - source: | - conf := ... - api := api.New(&conf) - - req := dto.ClientRegistrationRequest{} - req.ClientId = "26837717140341" - req.Token = "qs4Tu5TV7qqDYT93bFs6ISyhTByMF9o-54GY4JU5vTA" - - api.DynamicClientGet(&req) - - lang: ts - label: deno - source: | - // This API is not supported yet. - /api/client/registration/update: + /api/{serviceId}/client/registration/update: post: description: | Update a dynamically registered client. This API is supposed to be used to implement a client @@ -8736,6 +7405,13 @@ paths: ``` operationId: client_registration_update_api + parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: + type: string requestBody: content: application/json: @@ -8842,17 +7518,17 @@ paths: $ref: '#/components/schemas/result' description: "" security: - - ServiceCredentials: [] - summary: /api/client/registration/update API + - UseService: [] + summary: "/api/{serviceId}/client/registration/update API" tags: - Dynamic Client Registration x-code-samples: - lang: shell label: curl source: | - curl -v -X POST https://api.authlete.com/api/client/registration/update \ + curl -v -X POST https://beta.authlete.com/api/21653835348762/client/registration/update \ -H 'Content-Type:application/json' \ - -u '21653835348762:uE4NgqeIpuSV_XejQ7Ds3jsgA1yXhjR1MXJ1LbPuyls' \ + -u 'Authorization: Bearer V5a40R6dWvw2gMkCOBFdZcM95q4HC0Z-T0YKD9-nR6F' \ -d '{ "clientId": "26837717140341", "token": "qs4Tu5TV7qqDYT93bFs6ISyhTByMF9o-54GY4JU5vTA", "json": "..." }' - lang: java label: java @@ -8866,41 +7542,6 @@ paths: req.setJson("..."); api.dynamicClientUpdate(req); - - lang: cs - label: C# - source: | - IAuthleteConfiguration conf = ...; - IAuthleteApi api = new AuthleteApi(conf); - - ClientRegistrationRequest req = new ClientRegistrationRequest(); - req.ClientId = "26837717140341"; - req.Token = "qs4Tu5TV7qqDYT93bFs6ISyhTByMF9o-54GY4JU5vTA"; - req.Json = "..."; - - await api.DynamicClientUpdate(req); - - lang: php - label: PHP - source: | - $conf = ...; - $api = new AuthleteApiImpl($conf); - - $req = new ClientRegistrationRequest(); - $req.clientId = "26837717140341"; - $req.token = "qs4Tu5TV7qqDYT93bFs6ISyhTByMF9o-54GY4JU5vTA"; - $req.json = "..."; - - $api.dynamicClientUpdate($req); - - lang: ruby - source: | - conf = ... - api = Authlete::Api.new(conf) - - req = Authlete::Model::ClientRegistrationRequest.new - req.clientId = '26837717140341' - req.token = 'qs4Tu5TV7qqDYT93bFs6ISyhTByMF9o-54GY4JU5vTA' - req.json = '...' - - api.dynamic_client_update(req) - lang: python source: | conf = ... @@ -8912,22 +7553,7 @@ paths: req.json = '...' api.dynamicClientUpdate(req) - - lang: go - source: | - conf := ... - api := api.New(&conf) - - req := dto.ClientRegistrationRequest{} - req.ClientId = "26837717140341" - req.Token = "qs4Tu5TV7qqDYT93bFs6ISyhTByMF9o-54GY4JU5vTA" - req.Json = "..." - - api.DynamicClientUpdate(&req) - - lang: ts - label: deno - source: | - // This API is not supported yet. - /api/client/registration/delete: + /api/{serviceId}/client/registration/delete: post: description: | Delete a dynamically registered client. This API is supposed to be used to implement a client @@ -9036,6 +7662,13 @@ paths: ``` operationId: client_registration_delete_api + parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: + type: string requestBody: content: application/json: @@ -9098,17 +7731,17 @@ paths: $ref: '#/components/schemas/result' description: "" security: - - ServiceCredentials: [] - summary: /api/client/registration/delete API + - UseService: [] + summary: "/api/{serviceId}/client/registration/delete API" tags: - Dynamic Client Registration x-code-samples: - lang: shell label: curl source: | - curl -v -X POST https://api.authlete.com/api/client/registration/delete \ + curl -v -X POST https://beta.authlete.com/api/21653835348762/client/registration/delete \ -H 'Content-Type:application/json' \ - -u '21653835348762:uE4NgqeIpuSV_XejQ7Ds3jsgA1yXhjR1MXJ1LbPuyls' \ + -u 'Authorization: Bearer V5a40R6dWvw2gMkCOBFdZcM95q4HC0Z-T0YKD9-nR6F' \ -d '{ "clientId": "26837717140341", "token": "qs4Tu5TV7qqDYT93bFs6ISyhTByMF9o-54GY4JU5vTA"}' - lang: java label: java @@ -9121,38 +7754,6 @@ paths: req.setToken("qs4Tu5TV7qqDYT93bFs6ISyhTByMF9o-54GY4JU5vTA"); api.dynamicClientDelete(req); - - lang: cs - label: C# - source: | - IAuthleteConfiguration conf = ...; - IAuthleteApi api = new AuthleteApi(conf); - - ClientRegistrationRequest req = new ClientRegistrationRequest(); - req.ClientId = "26837717140341"; - req.Token = "qs4Tu5TV7qqDYT93bFs6ISyhTByMF9o-54GY4JU5vTA"; - - await api.DynamicClientDelete(client); - - lang: php - label: PHP - source: | - $conf = ...; - $api = new AuthleteApiImpl($conf); - - $req = new ClientRegistrationRequest(); - $req.clientId = "26837717140341"; - $req.token = "qs4Tu5TV7qqDYT93bFs6ISyhTByMF9o-54GY4JU5vTA"; - - $api.dynamicClientDelete($req); - - lang: ruby - source: | - conf = ... - api = Authlete::Api.new(conf) - - req = Authlete::Model::ClientRegistrationRequest.new - req.clientId = '26837717140341' - req.token = 'qs4Tu5TV7qqDYT93bFs6ISyhTByMF9o-54GY4JU5vTA' - - api.dynamic_client_delete(req) - lang: python source: | conf = ... @@ -9163,210 +7764,7 @@ paths: req.token = 'qs4Tu5TV7qqDYT93bFs6ISyhTByMF9o-54GY4JU5vTA' api.DynamicClientDelete(req) - - lang: go - source: | - conf := ... - api := api.New(&conf) - - req := dto.ClientRegistrationRequest{} - req.ClientId = "26837717140341" - req.Token = "qs4Tu5TV7qqDYT93bFs6ISyhTByMF9o-54GY4JU5vTA" - - api.DynamicClientDelete(&req) - - lang: ts - label: deno - source: | - // This API is not supported yet. - /api/client/extension/requestable_scopes/get/{clientId}: - get: - description: | - Get the requestable scopes per client - operationId: client_extension_requestables_scopes_get_api - parameters: - - description: | - A client ID. - in: path - name: clientId - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/client_extension_requestable_scopes_get_response' - "400": - content: - application/json: - example: - resultCode: A001201 - resultMessage: "[A001201] /auth/authorization, TLS must be used." - schema: - $ref: '#/components/schemas/result' - description: "" - "401": - content: - application/json: - example: - resultCode: A001202 - resultMessage: "[A001202] /auth/authorization, Authorization header\ - \ is missing." - schema: - $ref: '#/components/schemas/result' - description: "" - "403": - content: - application/json: - example: - resultCode: A001215 - resultMessage: "[A001215] /auth/authorization, The client (ID = 26837717140341)\ - \ is locked." - schema: - $ref: '#/components/schemas/result' - description: "" - "500": - content: - application/json: - example: - resultCode: A001101 - resultMessage: "[A001101] /auth/authorization, Authlete Server error." - schema: - $ref: '#/components/schemas/result' - description: "" - security: - - ServiceCredentials: [] - summary: "/api/client/extension/requestable_scopes/get/{clientId} API" - tags: - - Client Extension - /api/client/extension/requestable_scopes/update/{clientId}: - put: - description: | - Update requestable scopes of a client - operationId: client_extension_requestables_scopes_update_api - parameters: - - description: | - A client ID. - in: path - name: clientId - required: true - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/client_extension_requestable_scopes_update_request' - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/client_extension_requestable_scopes_update_response' - "400": - content: - application/json: - example: - resultCode: A001201 - resultMessage: "[A001201] /auth/authorization, TLS must be used." - schema: - $ref: '#/components/schemas/result' - description: "" - "401": - content: - application/json: - example: - resultCode: A001202 - resultMessage: "[A001202] /auth/authorization, Authorization header\ - \ is missing." - schema: - $ref: '#/components/schemas/result' - description: "" - "403": - content: - application/json: - example: - resultCode: A001215 - resultMessage: "[A001215] /auth/authorization, The client (ID = 26837717140341)\ - \ is locked." - schema: - $ref: '#/components/schemas/result' - description: "" - "500": - content: - application/json: - example: - resultCode: A001101 - resultMessage: "[A001101] /auth/authorization, Authlete Server error." - schema: - $ref: '#/components/schemas/result' - description: "" - security: - - ServiceCredentials: [] - summary: "/api/client/extension/requestable_scopes/update/{clientId} API" - tags: - - Client Extension - /api/client/extension/requestable_scopes/delete/{clientId}: - delete: - description: | - Delete a requestable scopes of a client - operationId: client_extension_requestables_scopes_delete_api - parameters: - - description: | - A client ID. - in: path - name: clientId - required: true - schema: - type: string - responses: - "204": - description: Requestable scopes was successfully deleted. - "400": - content: - application/json: - example: - resultCode: A001201 - resultMessage: "[A001201] /auth/authorization, TLS must be used." - schema: - $ref: '#/components/schemas/result' - description: "" - "401": - content: - application/json: - example: - resultCode: A001202 - resultMessage: "[A001202] /auth/authorization, Authorization header\ - \ is missing." - schema: - $ref: '#/components/schemas/result' - description: "" - "403": - content: - application/json: - example: - resultCode: A001215 - resultMessage: "[A001215] /auth/authorization, The client (ID = 26837717140341)\ - \ is locked." - schema: - $ref: '#/components/schemas/result' - description: "" - "500": - content: - application/json: - example: - resultCode: A001101 - resultMessage: "[A001101] /auth/authorization, Authlete Server error." - schema: - $ref: '#/components/schemas/result' - description: "" - security: - - ServiceCredentials: [] - summary: "/api/client/extension/requestable_scopes/delete/{clientId} API" - tags: - - Client Extension - /api/backchannel/authentication: + /api/{serviceId}/backchannel/authentication: post: description: | This API parses request parameters of a [backchannel authentication request](https://openid.net/specs/openid-client-initiated-backchannel-authentication-core-1_0.html#auth_request) @@ -9680,6 +8078,13 @@ paths: not have to be changed to support CIBA. operationId: backchannel_authentication_api + parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: + type: string requestBody: content: application/json: @@ -9763,17 +8168,17 @@ paths: $ref: '#/components/schemas/result' description: "" security: - - ServiceCredentials: [] - summary: /api/backchannel/authentication API + - UseService: [] + summary: "/api/{serviceId}/backchannel/authentication API" tags: - CIBA x-code-samples: - lang: shell label: curl source: | - curl -v -X POST https://api.authlete.com/api/backchannel/authentication \ + curl -v -X POST https://beta.authlete.com/api/21653835348762/backchannel/authentication \ -H 'Content-Type: application/json' \ - -u '21653835348762:uE4NgqeIpuSV_XejQ7Ds3jsgA1yXhjR1MXJ1LbPuyls' \ + -u 'Authorization: Bearer V5a40R6dWvw2gMkCOBFdZcM95q4HC0Z-T0YKD9-nR6F' \ -d '{ "parameters": "login_hint=john&scope=openid&client_notification_token=my-client-notification-token&user_code=my-user-code", "clientId": "26862190133482", "clientSecret":"8J9pAEX6IQw7lYtYGsc_s9N4jlEz_DfkoCHIswJjFjfgKZX-nC4EvKtaHXcP9mHBfS7IU4jytjSZZpaK9UJ77A" }' - lang: java label: java @@ -9787,45 +8192,10 @@ paths: req.setClientSecret("8J9pAEX6IQw7lYtYGsc_s9N4jlEz_DfkoCHIswJjFjfgKZX-nC4EvKtaHXcP9mHBfS7IU4jytjSZZpaK9UJ77A"); api.backchannelAuthentication(req); - - lang: cs - label: C# - source: | - IAuthleteConfiguration conf = new AuthletePropertiesConfiguration(); - IAuthleteApi api = new AuthleteApi(conf); - - BackchannelAuthenticationRequest req = new BackchannelAuthenticationRequest(); - req.Parameters = ...; - req.ClientId = "26862190133482"; - req.ClientSecret = "8J9pAEX6IQw7lYtYGsc_s9N4jlEz_DfkoCHIswJjFjfgKZX-nC4EvKtaHXcP9mHBfS7IU4jytjSZZpaK9UJ77A"; - - await api.BackchannelAuthentication(req); - - lang: php - label: PHP - source: | - $conf = ...; - $api = new AuthleteApiImpl($conf); - - $req = new BackchannelAuthenticationRequest(); - $req.setParameters(...); - $req.setClientId("26862190133482"); - $req.setClientSecret("8J9pAEX6IQw7lYtYGsc_s9N4jlEz_DfkoCHIswJjFjfgKZX-nC4EvKtaHXcP9mHBfS7IU4jytjSZZpaK9UJ77A"); - - $api.backchannelAuthentication($req); - - lang: ruby + - lang: python source: | conf = ... - api = Authlete::Api.new(conf) - - req = Authlete::Model::Request::BackchannelAuthenticationRequest.new - req.parameters = '...' - req.client_id = '26862190133482' - req.client_secret = '8J9pAEX6IQw7lYtYGsc_s9N4jlEz_DfkoCHIswJjFjfgKZX-nC4EvKtaHXcP9mHBfS7IU4jytjSZZpaK9UJ77A' - - api.backchannel_authentication(req) - - lang: python - source: | - conf = ... - api = AuthleteApiImpl(conf) + api = AuthleteApiImpl(conf) req = BackchannelAuthenticationRequest() req.parameters = ... @@ -9833,22 +8203,7 @@ paths: req.clientSecret = '8J9pAEX6IQw7lYtYGsc_s9N4jlEz_DfkoCHIswJjFjfgKZX-nC4EvKtaHXcP9mHBfS7IU4jytjSZZpaK9UJ77A' api.backchannelAuthentication(req) - - lang: go - source: | - conf := ... - api := api.New(&conf) - - req := dto.BackchannelAuthenticationRequest{} - req.Parameters = ... - req.ClientId = "26862190133482" - req.ClientSecret = "8J9pAEX6IQw7lYtYGsc_s9N4jlEz_DfkoCHIswJjFjfgKZX-nC4EvKtaHXcP9mHBfS7IU4jytjSZZpaK9UJ77A" - - api.BackchannelAuthentication(&req) - - lang: ts - label: deno - source: | - // This API is not supported yet. - /api/backchannel/authentication/issue: + /api/{serviceId}/backchannel/authentication/issue: post: description: | This API prepares JSON that contains an `auth_req_id`. The JSON should be used as the response body @@ -9941,6 +8296,13 @@ paths: ``` operationId: backchannel_authentication_issue_api + parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: + type: string requestBody: content: application/json: @@ -10007,17 +8369,17 @@ paths: $ref: '#/components/schemas/result' description: "" security: - - ServiceCredentials: [] - summary: /api/backchannel/authentication/issue API + - UseService: [] + summary: "/api/{serviceId}/backchannel/authentication/issue API" tags: - CIBA x-code-samples: - lang: shell label: curl source: | - curl -v -X POST https://api.authlete.com/api/backchannel/authentication/issue \ + curl -v -X POST https://beta.authlete.com/api/21653835348762/backchannel/authentication/issue \ -H 'Content-Type: application/json' \ - -u '21653835348762:uE4NgqeIpuSV_XejQ7Ds3jsgA1yXhjR1MXJ1LbPuyls' \ + -u 'Authorization: Bearer V5a40R6dWvw2gMkCOBFdZcM95q4HC0Z-T0YKD9-nR6F' \ -d '{ "ticket": "NFIHGx_btVrWmtAD093D-87JxvT4DAtuijEkLVHbS4Q" }' - lang: java label: java @@ -10029,35 +8391,6 @@ paths: req.setTicket("NFIHGx_btVrWmtAD093D-87JxvT4DAtuijEkLVHbS4Q"); api.backchannelAuthenticationIssue(req); - - lang: cs - label: C# - source: | - IAuthleteConfiguration conf = ...; - IAuthleteApi api = new AuthleteApi(conf); - - BackchannelAuthenticationIssueRequest req = new BackchannelAuthenticationIssueRequest(); - req.Ticket = "NFIHGx_btVrWmtAD093D-87JxvT4DAtuijEkLVHbS4Q"; - - await api.BackchannelAuthenticationIssue(req); - - lang: php - label: PHP - source: | - $conf = ...; - $api = new AuthleteApiImpl($conf); - - $req = new BackchannelAuthenticationIssueRequest(); - $req.setTicket("NFIHGx_btVrWmtAD093D-87JxvT4DAtuijEkLVHbS4Q"); - - $api.backchannelAuthenticationIssue($req); - - lang: ruby - source: | - conf = ... - api = Authlete::Api.new(conf) - - req = Authlete::Model::Request::BackchannelAuthenticationIssueRequest.new - req.ticket = 'NFIHGx_btVrWmtAD093D-87JxvT4DAtuijEkLVHbS4Q' - - api.backchannel_authentication_issue(req) - lang: python source: | conf = ... @@ -10067,20 +8400,7 @@ paths: req.ticket = 'NFIHGx_btVrWmtAD093D-87JxvT4DAtuijEkLVHbS4Q' api.backchannelAuthenticationIssue(req) - - lang: go - source: | - conf := ... - api := api.New(&conf) - - req := dto.BackchannelAuthenticationIssueRequest{} - req.Ticket = "NFIHGx_btVrWmtAD093D-87JxvT4DAtuijEkLVHbS4Q" - - api.BackchannelAuthenticationIssue(&req) - - lang: ts - label: deno - source: | - // This API is not supported yet. - /api/backchannel/authentication/fail: + /api/{serviceId}/backchannel/authentication/fail: post: description: | The API prepares JSON that contains an error. The JSON should be used as the response body of the @@ -10120,6 +8440,13 @@ paths: operationId: backchannel_authentication_fail_api + parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: + type: string requestBody: content: application/json: @@ -10181,17 +8508,17 @@ paths: $ref: '#/components/schemas/result' description: "" security: - - ServiceCredentials: [] - summary: /api/backchannel/authentication/fail API + - UseService: [] + summary: "/api/{serviceId}/backchannel/authentication/fail API" tags: - CIBA x-code-samples: - lang: shell label: curl source: | - curl -v -X POST https://api.authlete.com/api/backchannel/authentication/fail \ + curl -v -X POST https://beta.authlete.com/api/21653835348762/backchannel/authentication/fail \ -H 'Content-Type: application/json' \ - -u '21653835348762:uE4NgqeIpuSV_XejQ7Ds3jsgA1yXhjR1MXJ1LbPuyls' \ + -u 'Authorization: Bearer V5a40R6dWvw2gMkCOBFdZcM95q4HC0Z-T0YKD9-nR6F' \ -d '{ "ticket": "holsZhINBhum6j6MYE4yZefHuQN_kd609veKCst31p0", "reason": "ACCESS_DENIED" }' - lang: java label: java @@ -10204,38 +8531,6 @@ paths: req.setReason(BackchannelAuthenticationFailRequest.Reason.ACCESS_DENIED); api.backchannelAuthenticationFail(req); - - lang: cs - label: C# - source: | - IAuthleteConfiguration conf = ...; - IAuthleteApi api = new AuthleteApi(conf); - - BackchannelAuthenticationFailRequest req = new BackchannelAuthenticationFailRequest(); - req.Ticket = "holsZhINBhum6j6MYE4yZefHuQN_kd609veKCst31p0"; - req.Reason = BackchannelAuthenticationFailReason.ACCESS_DENIED; - - await api.BackchannelAuthenticationFail(req); - - lang: php - label: PHP - source: | - $conf = ...; - $api = new AuthleteApiImpl($conf); - - $req = new BackchannelAuthenticationFailRequest(); - $req.setTicket("holsZhINBhum6j6MYE4yZefHuQN_kd609veKCst31p0"); - $req.setReason(BackchannelAuthenticationFailReason.ACCESS_DENIED); - - $api.backchannelAuthenticationFail($req); - - lang: ruby - source: | - conf = ... - api = Authlete::Api.new(conf) - - req = Authlete::Model::Request::BackchannelAuthenticationFailRequest.new - req.ticket = 'holsZhINBhum6j6MYE4yZefHuQN_kd609veKCst31p0' - req.reason = 'ACCESS_DENIED' - - api.backchannel_authentication_fail(req) - lang: python source: | conf = ... @@ -10246,21 +8541,7 @@ paths: req.reason = BackchannelAuthenticationFailReason.ACCESS_DENIED api.backchannelAuthenticationFail(req) - - lang: go - source: | - conf := ... - api := api.New(&conf) - - req := dto.BackchannelAuthenticationFailRequest{} - req.Ticket = "holsZhINBhum6j6MYE4yZefHuQN_kd609veKCst31p0" - req.Reason = BackchannelAuthenticationFailReason.ACCESS_DENIED - - api.backchannelAuthenticationFail(&req) - - lang: ts - label: deno - source: | - // This API is not supported yet. - /api/backchannel/authentication/complete: + /api/{serviceId}/backchannel/authentication/complete: post: description: | This API returns information about what action the authorization server should take after it receives @@ -10372,6 +8653,13 @@ paths: ``` operationId: backchannel_authentication_complete_api + parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: + type: string requestBody: content: application/json: @@ -10450,17 +8738,17 @@ paths: $ref: '#/components/schemas/result' description: "" security: - - ServiceCredentials: [] - summary: /api/backchannel/authentication/complete API + - UseService: [] + summary: "/api/{serviceId}/backchannel/authentication/complete API" tags: - CIBA x-code-samples: - lang: shell label: curl source: | - curl -v -X POST https://api.authlete.com/api/backchannel/authentication/complete \ + curl -v -X POST https://beta.authlete.com/api/21653835348762/backchannel/authentication/complete \ -H 'Content-Type: application/json' \ - -u '21653835348762:uE4NgqeIpuSV_XejQ7Ds3jsgA1yXhjR1MXJ1LbPuyls' \ + -u 'Authorization: Bearer V5a40R6dWvw2gMkCOBFdZcM95q4HC0Z-T0YKD9-nR6F' \ -d '{ "ticket": "NFIHGx_btVrWmtAD093D-87JxvT4DAtuijEkLVHbS4Q", "result": "AUTHORIZED", "subject": "john" }' - lang: java label: java @@ -10474,41 +8762,6 @@ paths: req.setSubject("john"); api.backchannelAuthenticationComplete(req); - - lang: cs - label: C# - source: | - IAuthleteConfiguration conf = ...; - IAuthleteApi api = new AuthleteApi(conf); - - BackchannelAuthenticationCompleteRequest req = new BackchannelAuthenticationCompleteRequest(); - req.Ticket = "NFIHGx_btVrWmtAD093D-87JxvT4DAtuijEkLVHbS4Q"; - req.Result = BackchannelAuthenticationCompleteResult.AUTHORIZED; - req.Subject = "john"; - - await api.BackchannelAuthenticationComplete(req); - - lang: php - label: PHP - source: | - $conf = ...; - $api = new AuthleteApiImpl($conf); - - $req = new BackchannelAuthenticationCompleteRequest(); - $req.setTicket("NFIHGx_btVrWmtAD093D-87JxvT4DAtuijEkLVHbS4Q"); - $req.setResult(BackchannelAuthenticationCompleteResult.AUTHORIZED); - $req.setSubject("john"); - - $api.backchannelAuthenticationComplete($req); - - lang: ruby - source: | - conf = ... - api = Authlete::Api.new(conf) - - req = Authlete::Model::Request::BackchannelAuthenticationCompleteRequest.new - req.ticket = 'NFIHGx_btVrWmtAD093D-87JxvT4DAtuijEkLVHbS4Q' - req.result = 'AUTHORIZED' - req.subject = 'john' - - api.backchannel_authentication_complete(req) - lang: python source: | conf = ... @@ -10520,22 +8773,7 @@ paths: req.subject = 'john' api.backchannelAuthenticationComplete(req) - - lang: go - source: | - conf := ... - api := api.New(&conf) - - req := dto.BackchannelAuthenticationCompleteRequest{} - req.Ticket = "NFIHGx_btVrWmtAD093D-87JxvT4DAtuijEkLVHbS4Q" - req.Result = BackchannelAuthenticationCompleteResult.AUTHORIZED - req.Subject = "john" - - api.BackchannelAuthenticationComplete(&req) - - lang: ts - label: deno - source: | - // This API is not supported yet. - /api/device/authorization: + /api/{serviceId}/device/authorization: post: description: | This API parses request parameters of a [device authorization request](https://datatracker.ietf.org/doc/html/rfc8628#section-3.1) @@ -10635,6 +8873,13 @@ paths: and return to the client application. operationId: device_authorization_api + parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: + type: string requestBody: content: application/json: @@ -10720,17 +8965,17 @@ paths: $ref: '#/components/schemas/result' description: "" security: - - ServiceCredentials: [] - summary: /api/device/authorization API + - UseService: [] + summary: "/api/{serviceId}/device/authorization API" tags: - Device Flow x-code-samples: - lang: shell label: curl source: | - curl -v -X POST https://api.authlete.com/api/device/authorization \ + curl -v -X POST https://beta.authlete.com/api/21653835348762/device/authorization \ -H 'Content-Type: application/json' \ - -u '21653835348762:uE4NgqeIpuSV_XejQ7Ds3jsgA1yXhjR1MXJ1LbPuyls' \ + -u 'Authorization: Bearer V5a40R6dWvw2gMkCOBFdZcM95q4HC0Z-T0YKD9-nR6F' \ -d '{ "parameters": "client_id=26888344961664&scope=history.read", "clientId": "26888344961664", "clientSecret":"SfnYOLkJdofrb_66mTd6q03_SDoDEUnpXtvqFaE4k6L6UcpZzbdVJi2GpBj48AvGeDDllwsTruC62WYqQ_LGog" }' - lang: java label: java @@ -10744,41 +8989,6 @@ paths: req.setClientSecret("SfnYOLkJdofrb_66mTd6q03_SDoDEUnpXtvqFaE4k6L6UcpZzbdVJi2GpBj48AvGeDDllwsTruC62WYqQ_LGog"); api.deviceAuthorization(req); - - lang: cs - label: C# - source: | - IAuthleteConfiguration conf = ...; - IAuthleteApi api = new AuthleteApi(conf); - - DeviceAuthorizationRequest req = new DeviceAuthorizationRequest(); - req.Parameters = ...; - req.ClientId = "26888344961664"; - req.ClientSecret = "SfnYOLkJdofrb_66mTd6q03_SDoDEUnpXtvqFaE4k6L6UcpZzbdVJi2GpBj48AvGeDDllwsTruC62WYqQ_LGog"; - - await api.DeviceAuthorization(req); - - lang: php - label: PHP - source: | - $conf = ...; - $api = new AuthleteApiImpl($conf); - - $req = new DeviceAuthorizationRequest(); - $req.setParameters(...); - $req.setClientId("26888344961664"); - $req.setClientSecret("SfnYOLkJdofrb_66mTd6q03_SDoDEUnpXtvqFaE4k6L6UcpZzbdVJi2GpBj48AvGeDDllwsTruC62WYqQ_LGog"); - - $api.deviceAuthorization($req); - - lang: ruby - source: | - conf = ... - api = Authlete::Api.new(conf) - - req = Authlete::Model::Request::DeviceAuthorizationRequest.new - req.parameters = '...' - req.client_id = '26888344961664' - req.client_secret = 'SfnYOLkJdofrb_66mTd6q03_SDoDEUnpXtvqFaE4k6L6UcpZzbdVJi2GpBj48AvGeDDllwsTruC62WYqQ_LGog' - - api.device_authorization(req) - lang: python source: | conf = ... @@ -10790,22 +9000,7 @@ paths: req.clientSecret = 'SfnYOLkJdofrb_66mTd6q03_SDoDEUnpXtvqFaE4k6L6UcpZzbdVJi2GpBj48AvGeDDllwsTruC62WYqQ_LGog' api.deviceAuthorization(req) - - lang: go - source: | - conf := ... - api := api.New(&conf) - - req := dto.DeviceAuthorizationRequest{} - req.Parameters = ... - req.ClientId = "26888344961664" - req.ClientSecret = "SfnYOLkJdofrb_66mTd6q03_SDoDEUnpXtvqFaE4k6L6UcpZzbdVJi2GpBj48AvGeDDllwsTruC62WYqQ_LGog" - - api.DeviceAuthorization(&req) - - lang: ts - label: deno - source: | - // This API is not supported yet. - /api/device/verification: + /api/{serviceId}/device/verification: post: description: | The API returns information associated with a user code. @@ -10850,6 +9045,13 @@ paths: to ask whether she approves or rejects the authorization request from the device. operationId: device_verification_api + parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: + type: string requestBody: content: application/json: @@ -10923,17 +9125,17 @@ paths: $ref: '#/components/schemas/result' description: "" security: - - ServiceCredentials: [] - summary: /api/device/verification API + - UseService: [] + summary: "/api/{serviceId}/device/verification API" tags: - Device Flow x-code-samples: - lang: shell label: curl source: | - curl -v -X POST https://api.authlete.com/api/device/verification \ + curl -v -X POST https://beta.authlete.com/api/21653835348762/device/verification \ -H 'Content-Type: application/json' \ - -u '21653835348762:uE4NgqeIpuSV_XejQ7Ds3jsgA1yXhjR1MXJ1LbPuyls' \ + -u 'Authorization: Bearer V5a40R6dWvw2gMkCOBFdZcM95q4HC0Z-T0YKD9-nR6F' \ -d '{ "userCode": "XWWKPBWVXQ" }' - lang: java label: java @@ -10945,35 +9147,6 @@ paths: req.setUserCode("XWWKPBWVXQ"); api.deviceVerification(req); - - lang: cs - label: C# - source: | - IAuthleteConfiguration conf = ...; - IAuthleteApi api = new AuthleteApi(conf); - - DeviceVerificationRequest req = new DeviceVerificationRequest(); - req.SetUserCode("XWWKPBWVXQ"); - - await api.DeviceVerification(req); - - lang: php - label: PHP - source: | - $conf = ...; - $api = new AuthleteApiImpl($conf); - - $req = new DeviceVerificationRequest(); - $req.setUserCode("XWWKPBWVXQ"); - - $api.deviceVerification($req); - - lang: ruby - source: | - conf = ... - api = Authlete::Api.new(conf) - - req = Authlete::Model::Request::DeviceVerificationRequest.new - req.user_code = 'XWWKPBWVXQ' - - api.deviceVerification(req) - lang: python source: | conf = ... @@ -10983,20 +9156,7 @@ paths: req.setUserCode('XWWKPBWVXQ') api.deviceVerification(req) - - lang: go - source: | - conf := ... - api := api.New(&conf) - - req := dto.DeviceVerificationRequest{} - req.UserCode = "XWWKPBWVXQ" - - api.DeviceVerification(&req) - - lang: ts - label: deno - source: | - // This API is not supported yet. - /api/device/complete: + /api/{serviceId}/device/complete: post: description: | This API returns information about what action the authorization server should take after it receives @@ -11070,6 +9230,13 @@ paths: using. operationId: device_complete_api + parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: + type: string requestBody: content: application/json: @@ -11133,17 +9300,17 @@ paths: $ref: '#/components/schemas/result' description: "" security: - - ServiceCredentials: [] - summary: /api/device/complete API + - UseService: [] + summary: "/api/{serviceId}/device/complete API" tags: - Device Flow x-code-samples: - lang: shell label: curl source: | - curl -v -X POST https://api.authlete.com/api/device/complete \ + curl -v -X POST https://beta.authlete.com/api/21653835348762/device/complete \ -H 'Content-Type: application/json' \ - -u '21653835348762:uE4NgqeIpuSV_XejQ7Ds3jsgA1yXhjR1MXJ1LbPuyls' \ + -u 'Authorization: Bearer V5a40R6dWvw2gMkCOBFdZcM95q4HC0Z-T0YKD9-nR6F' \ -d '{ "userCode": "XWWKPBWVXQ", "result": "AUTHORIZED", "subject": "john" }' - lang: java label: java @@ -11157,41 +9324,6 @@ paths: req.setSubject("john"); api.deviceComplete(req); - - lang: cs - label: C# - source: | - IAuthleteConfiguration conf = ...; - IAuthleteApi api = new AuthleteApi(conf); - - DeviceCompleteRequest req = new DeviceCompleteRequest(); - req.SetUserCode("XWWKPBWVXQ"); - req.SetResult(DeviceCompleteResult.AUTHORIZED); - req.SetSubject("john"); - - await api.DeviceComplete(req); - - lang: php - label: PHP - source: | - $conf = ...; - $api = new AuthleteApiImpl($conf); - - $req = new DeviceCompleteRequest(); - $req.setUserCode("XWWKPBWVXQ"); - $req.setResult(DeviceCompleteResult.$AUTHORIZED); - $req.setSubject("john"); - - $api.deviceComplete($req); - - lang: ruby - source: | - conf = ... - api = Authlete::Api.new(conf) - - req = Authlete::Model::Request::DeviceCompleteRequest.new - req.use_code = 'XWWKPBWVXQ' - req.result = 'AUTHORIZED' - req.subject = 'john' - - api.deviceComplete(req) - lang: python source: | conf = ... @@ -11203,27 +9335,18 @@ paths: req.setSubject('john') api.deviceComplete(req) - - lang: go - source: | - conf := ... - api := api.New(&conf) - - req := dto.DeviceCompleteRequest{} - req.UserCode = "XWWKPBWVXQ" - req.Result = DeviceCompleteResult.AUTHORIZED - req.Subject = "john" - - api.DeviceComplete(&req) - - lang: ts - label: deno - source: | - // This API is not supported yet. - /api/auth/token/get/list: + /api/{serviceId}/auth/token/get/list: get: description: | Get a list of client applications that an end-user has authorized. operationId: auth_token_get_list_api parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: + type: string - description: | Client Identifier (client ID or client ID alias). in: query @@ -11296,53 +9419,11 @@ paths: - history.read subject: john client: - authTimeRequired: false - bcUserCodeRequired: false clientId: 26888344961664 clientIdAliasEnabled: false clientName: My Device Flow Client - clientSecret: SfnYOLkJdofrb_66mTd6q03_SDoDEUnpXtvqFaE4k6L6UcpZzbdVJi2GpBj48AvGeDDllwsTruC62WYqQ_LGog clientType: CONFIDENTIAL - createdAt: 1641996927000 - defaultMaxAge: 0 - derivedSectorIdentifier: api.authlete.com - developer: authlete_21653835348762 - dynamicallyRegistered: false - extension: - accessTokenDuration: 0 - refreshTokenDuration: 0 - requestableScopesEnabled: false - frontChannelRequestObjectEncryptionRequired: false - grantTypes: - - AUTHORIZATION_CODE - - IMPLICIT - - PASSWORD - - CLIENT_CREDENTIALS - - REFRESH_TOKEN - - CIBA - - DEVICE_CODE - idTokenSignAlg: HS256 - modifiedAt: 1641996927000 number: 6260 - parRequired: false - redirectUris: - - https://api.authlete.com/api/mock/redirection/21653835348762 - requestObjectEncryptionAlgMatchRequired: false - requestObjectEncryptionEncMatchRequired: false - requestObjectRequired: false - responseTypes: - - NONE - - CODE - - TOKEN - - ID_TOKEN - - CODE_TOKEN - - CODE_ID_TOKEN - - ID_TOKEN_TOKEN - - CODE_ID_TOKEN_TOKEN - serviceNumber: 5041 - subjectType: PUBLIC - tlsClientCertificateBoundAccessTokens: false - tokenAuthMethod: CLIENT_SECRET_BASIC end: 3 start: 0 subject: john @@ -11389,16 +9470,16 @@ paths: $ref: '#/components/schemas/result' description: "" security: - - ServiceCredentials: [] - summary: /api/auth/token/get/list API + - UseService: [] + summary: "/api/{serviceId}/auth/token/get/list API" tags: - Token Operations x-code-samples: - lang: shell label: curl source: | - curl -v https://api.authlete.com/api/auth/token/get/list/?clientIdentifier=26888344961664\&subject=john\&start=0\&end=3 \ - -u '21653835348762:uE4NgqeIpuSV_XejQ7Ds3jsgA1yXhjR1MXJ1LbPuyls' + curl -v https://beta.authlete.com/api/21653835348762/auth/token/get/list/?clientIdentifier=26888344961664\&subject=john\&start=0\&end=3 \ + -u 'Authorization: Bearer V5a40R6dWvw2gMkCOBFdZcM95q4HC0Z-T0YKD9-nR6F' - lang: java label: java source: | @@ -11411,25 +9492,6 @@ paths: int end = 3; api.getTokenList(clientIdentifier, subject, start, end); - - lang: cs - label: C# - source: | - // This API is not supported yet. - - lang: php - label: PHP - source: | - // This API is not supported yet. - - lang: ruby - source: | - conf = ... - api = Authlete::Api.new(conf) - - api.get_token_list( - client_identifier: '26888344961664', - subject: 'john', - start: 0, - end: 3 - ) - lang: python source: | conf = ... @@ -11441,26 +9503,18 @@ paths: end = 3 api.getTokenList(clientIdentifier, subject, start, end) - - lang: go - source: | - conf := ... - api := api.New(&conf) - - clientIdentifier = "26888344961664" - subject = "john" - start = 0 - end = 3 - - api.GetTokenList(clientIdentifier, subject, start, end) - - lang: ts - label: deno - source: | - // This API is not supported yet. - /api/auth/token/create: + /api/{serviceId}/auth/token/create: post: description: | Create an access token. operationId: auth_token_create_api + parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: + type: string requestBody: content: application/json: @@ -11539,17 +9593,17 @@ paths: $ref: '#/components/schemas/result' description: "" security: - - ServiceCredentials: [] - summary: /api/auth/token/create API + - UseService: [] + summary: "/api/{serviceId}/auth/token/create API" tags: - Token Operations x-code-samples: - lang: shell label: curl source: | - curl -v -X POST https://api.authlete.com/api/auth/token/create \ + curl -v -X POST https://beta.authlete.com/api/21653835348762/auth/token/create \ -H 'Content-Type:application/json' \ - -u '21653835348762:uE4NgqeIpuSV_XejQ7Ds3jsgA1yXhjR1MXJ1LbPuyls' \ + -u 'Authorization: Bearer V5a40R6dWvw2gMkCOBFdZcM95q4HC0Z-T0YKD9-nR6F' \ -d '{ "grantType": "AUTHORIZATION_CODE", "clientId": 26888344961664, "subject": "john", "scopes": [ "history.read", "timeline.read" ] }' - lang: java label: java @@ -11564,44 +9618,6 @@ paths: req.setScopes({ "history.read", "timeline.read" }); api.tokenCreate(req); - - lang: cs - label: C# - source: | - IAuthleteConfiguration conf = ...; - IAuthleteApi api = new AuthleteApi(conf); - - TokenCreateRequest req = new TokenCreateRequest(); - req.GrantType = GrantType.AUTHORIZATION_CODE; - req.ClientId = 26888344961664; - req.Subject = "john"; - req.Scopes = { "history.read", "timeline.read" }; - - await api.TokenCreate(request); - - lang: php - label: PHP - source: | - $conf = ...; - $api = new AuthleteApiImpl($conf); - - $req = new TokenCreateRequest(); - $req.setGrantType(GrantType.$AUTHORIZATION_CODE); - $req.setClientId(26888344961664); - $req.setSubject("john"); - $req.setScopes([ "history.read", "timeline.read" ]); - - $api.tokenCreate($req); - - lang: ruby - source: | - conf = ... - api = Authlete::Api.new(conf) - - req = Authlete::Model::Request::TokenCreateRequest.new - req.grant_type = 'AUTHORIZATION_CODE' - req.client_id = 26888344961664 - req.subject = 'john' - req.scopes = [ 'history.read', 'timeline.read' ] - - api.token_create(req) - lang: python source: | conf = ... @@ -11614,27 +9630,18 @@ paths: req.scopes = [ 'history.read', 'timeline.read' ] api.tokenCreate(req) - - lang: go - source: | - conf := ... - api := api.New(&conf) - - req := dto.TokenCreateRequest{} - req.GrantType = types.GrantType_AUTHORIZATION_CODE; - req.ClientId = 26888344961664; - req.Subject = "john"; - req.Scopes = [2]string{"history.read", "timeline.read"}; - - api.TokenCreate(&req) - - lang: ts - label: deno - source: | - // This API is not supported yet. - /api/auth/token/update: + /api/{serviceId}/auth/token/update: post: description: | Update an access token. operationId: auth_token_update_api + parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: + type: string requestBody: content: application/json: @@ -11703,17 +9710,17 @@ paths: $ref: '#/components/schemas/result' description: "" security: - - ServiceCredentials: [] - summary: /api/auth/token/update API + - UseService: [] + summary: "/api/{serviceId}/auth/token/update API" tags: - Token Operations x-code-samples: - lang: shell label: curl source: | - curl -v -X POST https://api.authlete.com/api/auth/token/update \ + curl -v -X POST https://beta.authlete.com/api/21653835348762/auth/token/update \ -H 'Content-Type:application/json' \ - -u '21653835348762:uE4NgqeIpuSV_XejQ7Ds3jsgA1yXhjR1MXJ1LbPuyls' \ + -u 'Authorization: Bearer V5a40R6dWvw2gMkCOBFdZcM95q4HC0Z-T0YKD9-nR6F' \ -d '{ "accessToken": "Z5a40U6dWvw2gMoCOAFbZcM85q4HC0Z--0YKD9-Nf6Q", "scopes": [ "history.read" ] }' - lang: java label: java @@ -11726,38 +9733,6 @@ paths: req.setScopes({ "history.read" }); api.tokenUpdate(req); - - lang: cs - label: C# - source: | - IAuthleteConfiguration conf = ...; - IAuthleteApi api = new AuthleteApi(conf); - - TokenUpdateRequest req = new TokenUpdateRequest(); - req.AccessToken = "JDGiiM9PuWT63FIwGjG9eYlGi-aZMq6CQ2IB475JUxs"; - req.Scopes = { "history.read" }; - - await api.TokenUpdate(request); - - lang: php - label: PHP - source: | - $conf = ...; - $api = new AuthleteApiImpl($conf); - - $req = new TokenUpdateRequest(); - $req.setAccessToken("JDGiiM9PuWT63FIwGjG9eYlGi-aZMq6CQ2IB475JUxs"); - $req.setScopes([ "history.read" ]); - - $api.tokenUpdate($req); - - lang: ruby - source: | - conf = ... - api = Authlete::Api.new(conf) - - req = Authlete::Model::Request::TokenUpdateRequest.new - req.access_token = 'JDGiiM9PuWT63FIwGjG9eYlGi-aZMq6CQ2IB475JUxs' - req.scopes = [ 'history.read' ] - - api.token_update(req) - lang: python source: | conf = ... @@ -11768,26 +9743,18 @@ paths: req.scopes = [ 'history.read' ] api.tokenUpdate(req) - - lang: go - source: | - conf := ... - api := api.New(&conf) - - req := dto.TokenUpdateRequest{} - req.AccessToken = "JDGiiM9PuWT63FIwGjG9eYlGi-aZMq6CQ2IB475JUxs" - req.Scopes = [1]string{ "history.read" } - - api.TokenUpdate(&req) - - lang: ts - label: deno - source: | - // This API is not supported yet. - /api/auth/token/delete/{accessTokenIdentifier}: + /api/{serviceId}/auth/token/delete/{accessTokenIdentifier}: delete: description: | Delete an access token. operationId: auth_token_delete_api parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: + type: string - description: | The identifier of an existing access token. The identifier is the value of the access token or the value of the hash of the access token. @@ -11839,17 +9806,17 @@ paths: $ref: '#/components/schemas/result' description: "" security: - - ServiceCredentials: [] - summary: /api/auth/token/delete API + - UseService: [] + summary: "/api/{serviceId}/auth/token/delete API" tags: - Token Operations x-code-samples: - lang: shell label: curl source: | - curl -v -X DELETE https://api.authlete.com/api/auth/token/delete/Bk1QneTxkoLKw_RRB8ToVL25Plt075RvPK68N9cWWtg \ + curl -v -X DELETE https://beta.authlete.com/api/21653835348762/auth/token/delete/Bk1QneTxkoLKw_RRB8ToVL25Plt075RvPK68N9cWWtg \ -H 'Content-Type:application/json' \ - -u '21653835348762:uE4NgqeIpuSV_XejQ7Ds3jsgA1yXhjR1MXJ1LbPuyls' + -u 'Authorization: Bearer V5a40R6dWvw2gMkCOBFdZcM95q4HC0Z-T0YKD9-nR6F' - lang: java label: java source: | @@ -11859,32 +9826,6 @@ paths: String accessTokenIdentifier = "Bk1QneTxkoLKw_RRB8ToVL25Plt075RvPK68N9cWWtg"; api.tokenDelete(accessToken); - - lang: cs - label: C# - source: | - IAuthleteConfiguration conf = ...; - IAuthleteApi api = new AuthleteApi(conf); - - string accessTokenIdentifier = "Bk1QneTxkoLKw_RRB8ToVL25Plt075RvPK68N9cWWtg"; - - await api.TokenDelete(accessToken); - - lang: php - label: PHP - source: | - $conf = ...; - $api = new AuthleteApiImpl($conf); - - $accessTokenIdentifier = "Bk1QneTxkoLKw_RRB8ToVL25Plt075RvPK68N9cWWtg"; - - $api.tokenDelete($accessToken); - - lang: ruby - source: | - conf = ... - api = Authlete::Api.new(conf) - - access_token_identifier = 'Bk1QneTxkoLKw_RRB8ToVL25Plt075RvPK68N9cWWtg' - - api.token_delete(access_token) - lang: python source: | conf = ... @@ -11893,23 +9834,18 @@ paths: accessTokenIdentifier = 'Bk1QneTxkoLKw_RRB8ToVL25Plt075RvPK68N9cWWtg' api.tokenDelete(accessToken) - - lang: go - source: | - conf := ... - api := api.New(&conf) - - accessTokenIdentifier := "Bk1QneTxkoLKw_RRB8ToVL25Plt075RvPK68N9cWWtg" - - api.TokenDelete(accessTokenIdentifier) - - lang: ts - label: deno - source: | - // This API is not supported yet. - /api/auth/token/revoke: + /api/{serviceId}/auth/token/revoke: post: description: | Revoke an access token. operationId: auth_token_revoke_api + parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: + type: string requestBody: content: application/json: @@ -11976,17 +9912,17 @@ paths: $ref: '#/components/schemas/result' description: "" security: - - ServiceCredentials: [] - summary: /api/auth/token/revoke API + - UseService: [] + summary: "/api/{serviceId}/auth/token/revoke API" tags: - Token Operations x-code-samples: - lang: shell label: curl source: | - curl -v -X POST https://api.authlete.com/api/auth/token/revoke \ + curl -v -X POST https://beta.authlete.com/api/21653835348762/auth/token/revoke \ -H 'Content-Type:application/json' \ - -u '21653835348762:uE4NgqeIpuSV_XejQ7Ds3jsgA1yXhjR1MXJ1LbPuyls' \ + -u 'Authorization: Bearer V5a40R6dWvw2gMkCOBFdZcM95q4HC0Z-T0YKD9-nR6F' \ -d '{ "accessToken": "Z5a40U6dWvw2gMoCOAFbZcM85q4HC0Z--0YKD9-Nf6Q", "scopes": [ "history.read" ] }' - lang: java label: java @@ -11999,38 +9935,6 @@ paths: req.setScopes({ "history.read" }); api.tokenUpdate(req); - - lang: cs - label: C# - source: | - IAuthleteConfiguration conf = ...; - IAuthleteApi api = new AuthleteApi(conf); - - TokenUpdateRequest req = new TokenUpdateRequest(); - req.AccessToken = "JDGiiM9PuWT63FIwGjG9eYlGi-aZMq6CQ2IB475JUxs"; - req.Scopes = { "history.read" }; - - await api.TokenUpdate(request); - - lang: php - label: PHP - source: | - $conf = ...; - $api = new AuthleteApiImpl($conf); - - $req = new TokenUpdateRequest(); - $req.setAccessToken("JDGiiM9PuWT63FIwGjG9eYlGi-aZMq6CQ2IB475JUxs"); - $req.setScopes([ "history.read" ]); - - $api.tokenUpdate($req); - - lang: ruby - source: | - conf = ... - api = Authlete::Api.new(conf) - - req = Authlete::Model::Request::TokenUpdateRequest.new - req.access_token = 'JDGiiM9PuWT63FIwGjG9eYlGi-aZMq6CQ2IB475JUxs' - req.scopes = [ 'history.read' ] - - api.token_update(req) - lang: python source: | conf = ... @@ -12041,33 +9945,265 @@ paths: req.scopes = [ 'history.read' ] api.tokenUpdate(req) - - lang: go - source: | - conf := ... - api := api.New(&conf) - - req := dto.TokenUpdateRequest{} - req.AccessToken = "JDGiiM9PuWT63FIwGjG9eYlGi-aZMq6CQ2IB475JUxs" - req.Scopes = [1]string{ "history.read" } - - api.TokenUpdate(&req) - - lang: ts - label: deno - source: | - // This API is not supported yet. - /api/jose/verify: + /api/{serviceId}/auth/token/create/batch: post: description: | - This API verifies a JOSE object. - operationId: jose_verify_api + Start a batch process to create multiple tokens. + operationId: auth_token_create_batch_api + parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: + type: string requestBody: content: application/json: example: - jose: eyJhbGciOiJFUzI1NiJ9.eyJleHAiOjE1NTk4MTE3NTAsImlzcyI6IjU3Mjk3NDA4ODY3In0K.csmdholMVcmjqHe59YWgLGNvm7I5Whp4phQCoGxyrlRGMnTgsfxtwyxBgMXQqEPD5q5k9FaEWNk37K8uAtSwrA - clockSkew: 100 - signedByClient: true - clientIdentifier: "57297408867" + - subject: john + grantType: AUTHORIZATION_CODE + clientId: 4284413807 + accessToken: 5ce31f34fa9d91fcb7a037c30dda3c2c + refreshToken: 7d627a538f29fcf1645aaa185b4567c7 + accessTokenDuration: 3600 + - subject: john + grantType: AUTHORIZATION_CODE + clientId: 4284413807 + accessToken: fee98be7aec1ab5c97c1e734be36615d + refreshToken: 1f039e64412a0988097e7a945f712381 + accessTokenDuration: 3600 + - subject: john + grantType: AUTHORIZATION_CODE + clientId: 4284413807 + accessToken: 7fdeff1ddece61c0e7ef59c8ca0236fa + refreshToken: f6315f15ee41073bd6753d6582e2a076 + accessTokenDuration: 3600 + schema: + $ref: '#/components/schemas/token_create_batch_request' + required: true + responses: + "200": + content: + application/json: + example: + resultCode: A482001 + resultMessage: "[A482001] Successfully issued a request ID." + requestId: Z5a40U6dWvw2gMoCOAFbZcM85q4HC0Z--0YKD9-Nf6Q + schema: + $ref: '#/components/schemas/token_create_batch_response' + description: "" + "400": + content: + application/json: + example: + resultCode: A001201 + resultMessage: "[A001201] /auth/authorization, TLS must be used." + schema: + $ref: '#/components/schemas/result' + description: "" + "401": + content: + application/json: + example: + resultCode: A001202 + resultMessage: "[A001202] /auth/authorization, Authorization header\ + \ is missing." + schema: + $ref: '#/components/schemas/result' + description: "" + "403": + content: + application/json: + example: + resultCode: A001215 + resultMessage: "[A001215] /auth/authorization, The client (ID = 26837717140341)\ + \ is locked." + schema: + $ref: '#/components/schemas/result' + description: "" + "500": + content: + application/json: + example: + resultCode: A001101 + resultMessage: "[A001101] /auth/authorization, Authlete Server error." + schema: + $ref: '#/components/schemas/result' + description: "" + security: + - AccessToken: [] + summary: "/api/{serviceId}/auth/token/create/batch API" + tags: + - Token Operations + x-code-samples: + - lang: shell + label: curl + source: | + curl -v -X POST https://beta.authlete.com/api/21653835348762/auth/token/create/batch \ + -H 'Content-Type:application/json' \ + -u 'Authorization: Bearer V5a40R6dWvw2gMkCOBFdZcM95q4HC0Z-T0YKD9-nR6F' \ + -d @tokens.json + - lang: java + label: java + source: | + AuthleteConfiguration conf = ...; + AuthleteApi api = AuthleteApiFactory.create(conf); + + TokenCreateRequest req1 = new TokenCreateRequest() + .setSubject("john") + .setAccessToken("sample-at1") + .setRefreshToken("sample-rt1") + .setGrantType(GrantType.AUTHORIZATION_CODE) + .setClientId(4284413807L) + .setAccessTokenDuration(3600) + ; + + TokenCreateRequest req2 = new TokenCreateRequest() + .setSubject("john") + .setAccessToken("sample-at2") + .setRefreshToken("sample-rt2") + .setGrantType(GrantType.AUTHORIZATION_CODE) + .setClientId(4284413807L) + .setAccessTokenDuration(3600) + ; + + TokenCreateRequest req3 = new TokenCreateRequest() + .setSubject("john") + .setAccessToken("sample-at3") + .setRefreshToken("sample-rt3") + .setGrantType(GrantType.AUTHORIZATION_CODE) + .setClientId(4284413807L) + .setAccessTokenDuration(3600) + ; + + api.tokenCreateBatch(new TokenCreateRequest[]{ req1, req2, req3 }, false); + /api/{serviceId}/auth/token/create/batch/status/{requestId}: + post: + description: | + Retrieves the status of a batch token creation process specified by the given request Id. + operationId: auth_token_create_batch_status_api + parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: + type: string + - description: A request ID. + in: path + name: requestId + required: true + schema: + type: string + responses: + "200": + content: + application/json: + example: + status: + batchKind: CREATE + requestId: AJFrtca4XR1rb4NUSoKfGQ + result: SUCCEEDED + tokenCount: 3 + errorCode: null + errorDescription: null + createdAt: 1715689814000 + modifiedAt: 1715689815000 + resultCode: A447001 + resultMessage: Successfully obtained the status. + schema: + $ref: '#/components/schemas/token_create_batch_status_response' + description: "" + "400": + content: + application/json: + example: + resultCode: A001201 + resultMessage: "[A001201] /auth/authorization, TLS must be used." + schema: + $ref: '#/components/schemas/result' + description: "" + "401": + content: + application/json: + example: + resultCode: A001202 + resultMessage: "[A001202] /auth/authorization, Authorization header\ + \ is missing." + schema: + $ref: '#/components/schemas/result' + description: "" + "403": + content: + application/json: + example: + resultCode: A001215 + resultMessage: "[A001215] /auth/authorization, The client (ID = 26837717140341)\ + \ is locked." + schema: + $ref: '#/components/schemas/result' + description: "" + "404": + content: + application/json: + example: + resultCode: A481302 + resultMessage: "[A481302] /api/{serviceId}/auth/token/create/batch/status/{requestId},\ + \ The request ID was not found." + schema: + $ref: '#/components/schemas/result' + description: "" + "500": + content: + application/json: + example: + resultCode: A001101 + resultMessage: "[A001101] /auth/authorization, Authlete Server error." + schema: + $ref: '#/components/schemas/result' + description: "" + security: + - AccessToken: [] + summary: "/api/{serviceId}/auth/token/create/batch/status/{requestId} API" + tags: + - Token Operations + x-code-samples: + - lang: shell + label: curl + source: | + curl -v -X POST https://beta.authlete.com/api/21653835348762/auth/token/create/batch/status/AJFrtca4XR1rb4NUSoKfGQ \ + -u 'Authorization: Bearer V5a40R6dWvw2gMkCOBFdZcM95q4HC0Z-T0YKD9-nR6F' + - lang: java + label: java + source: | + AuthleteConfiguration conf = ...; + AuthleteApi api = AuthleteApiFactory.create(conf); + + // Get the request ID for the batch operation. + String requestId = ...; + + api.getTokenCreateBatchStatus(requestId); + /api/{serviceId}/jose/verify: + post: + description: | + This API verifies a JOSE object. + operationId: jose_verify_api + parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: + type: string + requestBody: + content: + application/json: + example: + jose: eyJhbGciOiJFUzI1NiJ9.eyJleHAiOjE1NTk4MTE3NTAsImlzcyI6IjU3Mjk3NDA4ODY3In0K.csmdholMVcmjqHe59YWgLGNvm7I5Whp4phQCoGxyrlRGMnTgsfxtwyxBgMXQqEPD5q5k9FaEWNk37K8uAtSwrA + clockSkew: 100 + signedByClient: true + clientIdentifier: "57297408867" schema: $ref: '#/components/schemas/jose_verify_request' application/x-www-form-urlencoded: @@ -12125,16 +10261,16 @@ paths: $ref: '#/components/schemas/result' description: "" security: - - ServiceOwnerCredentials: [] - summary: /api/jose/verify API + - UseService: [] + summary: "/api/{serviceId}/jose/verify API" tags: - Jose Object x-code-samples: - lang: shell label: curl source: | - curl -v https://api.authlete.com/api/jose/verify \ - -u '21653835348762:uE4NgqeIpuSV_XejQ7Ds3jsgA1yXhjR1MXJ1LbPuyls' \ + curl -v https://beta.authlete.com/api/21653835348762/jose/verify \ + -u 'Authorization: Bearer V5a40R6dWvw2gMkCOBFdZcM95q4HC0Z-T0YKD9-nR6F' \ -d jose=eyJhbGciOiJFUzI1NiJ9.eyJleHAiOjE1NTk4MTE3NTAsImlzcyI6IjU3Mjk3NDA4ODY3In0K.csmdholMVcmjqHe59YWgLGNvm7I5Whp4phQCoGxyrlRGMnTgsfxtwyxBgMXQqEPD5q5k9FaEWNk37K8uAtSwrA \ -d clockSkew=100 \ -d signedByClient=true \ @@ -12152,26 +10288,6 @@ paths: req.setClientIdentifier("57297408867"); api.verifyJose(request); - - lang: cs - label: C# - source: | - IAuthleteConfiguration conf = ...; - IAuthleteApi api = new AuthleteApi(conf); - - JoseVerifyRequest req = new JoseVerifyRequest(); - req.Jose = "eyJhbGciOiJFUzI1NiJ9.eyJleHAiOjE1NTk4MTE3NTAsImlzcyI6IjU3Mjk3NDA4ODY3In0K.csmdholMVcmjqHe59YWgLGNvm7I5Whp4phQCoGxyrlRGMnTgsfxtw"; - req.ClockSkew = 100; - req.SinedByClient = true; - req.ClientIdentifier = "57297408867"; - - await api.VerifyJose(req); - - lang: php - label: PHP - source: | - // This API is not supported yet. - - lang: ruby - source: | - # This API is not supported yet. - lang: python source: | conf = ... @@ -12184,23 +10300,7 @@ paths: req.clientIdentifier = '57297408867' api.verifyJose(req) - - lang: go - source: | - conf := ... - api := api.New(&conf) - - req := dto.JoseVerifyRequest{} - req.Jose = "eyJhbGciOiJFUzI1NiJ9.eyJleHAiOjE1NTk4MTE3NTAsImlzcyI6IjU3Mjk3NDA4ODY3In0K.csmdholMVcmjqHe59YWgLGNvm7I5Whp4phQCoGxyrlRGMnTgsfxtw" - req.ClockSkew = 100 - req.SinedByClient = true - req.ClientIdentifier = "57297408867" - - api.VerifyJose(&req) - - lang: ts - label: deno - source: | - // This API is not supported yet. - /api/federation/configuration: + /api/{serviceId}/federation/configuration: post: description: | This API gathers the federation configuration about a service. @@ -12286,6 +10386,13 @@ paths: operationId: federation_configuration_api + parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: + type: string requestBody: content: application/json: @@ -12337,16 +10444,16 @@ paths: $ref: '#/components/schemas/result' description: "" security: - - ServiceCredentials: [] - summary: /api/federation/configuration API + - UseService: [] + summary: "/api/{serviceId}/federation/configuration API" tags: - Federation Endpoint x-code-samples: - lang: shell label: curl source: | - curl -v https://api.authlete.com/api/federation/configuration \ - -u '21653835348762:uE4NgqeIpuSV_XejQ7Ds3jsgA1yXhjR1MXJ1LbPuyls' + curl -v https://beta.authlete.com/api/21653835348762/federation/configuration \ + -u 'Authorization: Bearer V5a40R6dWvw2gMkCOBFdZcM95q4HC0Z-T0YKD9-nR6F' - lang: java label: java source: | @@ -12354,46 +10461,13 @@ paths: AuthleteApi api = AuthleteApiFactory.create(conf); api.getFederationConfiguration(); - - lang: cs - label: C# - source: | - IAuthleteConfiguration conf = ...; - IAuthleteApi api = new AuthleteApi(conf); - - await api.GetFederationConfiguration(true); - - lang: php - label: PHP - source: | - $conf = ...; - $api = new AuthleteApiImpl($conf); - - $api.getFederationConfiguration(true); - - lang: ruby - source: | - conf = ... - api = Authlete::Api.new(conf) - - api.get_federation_configuration(pretty: true) - lang: python source: | conf = ... api = AuthleteApiImpl(conf) api.getFederationConfiguration(True) - - lang: go - source: | - conf := ... - api := api.New(&conf) - - api.GetFederationConfiguration(true) - - lang: ts - label: deno - source: | - const conf: AuthleteConfiguration = ...; - const api: AuthleteApi = new AuthleteApiImpl(conf); - - await api.getFederationConfiguration(true); - /api/federation/registration: + /api/{serviceId}/federation/registration: post: description: | The Authlete API is for implementations of the federation registration @@ -12433,6 +10507,13 @@ paths: `trustChain` request parameter.

operationId: federation_registration_api + parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: + type: string requestBody: content: application/json: @@ -12487,8 +10568,8 @@ paths: $ref: '#/components/schemas/result' description: "" security: - - ServiceCredentials: [] - summary: /api/federation/registration API + - UseService: [] + summary: "/api/{serviceId}/federation/registration API" tags: - Federation Endpoint /api/info: @@ -12553,30 +10634,34 @@ paths: schema: $ref: '#/components/schemas/result' description: "" - security: - - ServiceCredentials: [] summary: /api/info API tags: - Server Metadata - /api/hsk/create: - post: - operationId: hsk_create_api - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/hsk_create_request' - application/x-www-form-urlencoded: - schema: - $ref: '#/components/schemas/hsk_create_request' + /api/{serviceId}/client/extension/requestable_scopes/get/{clientId}: + get: + description: | + Get the requestable scopes per client + operationId: client_extension_requestables_scopes_get_api + parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: + type: string + - description: | + A client ID. + in: path + name: clientId required: true + schema: + type: string responses: "200": content: application/json: schema: - $ref: '#/components/schemas/hsk_create_response' - description: "" + $ref: '#/components/schemas/client_extension_requestable_scopes_get_response' "400": content: application/json: @@ -12616,25 +10701,42 @@ paths: $ref: '#/components/schemas/result' description: "" security: - - ServiceOwnerCredentials: [] - summary: /api/hsk/create API + - ViewClient: [] + summary: "/api/{serviceId}/client/extension/requestable_scopes/get/{clientId}\ + \ API" tags: - - Hsk Operations - /api/hsk/delete/{handle}: - delete: - operationId: hsk_delete_api + - Client Extension + /api/{serviceId}/client/extension/requestable_scopes/update/{clientId}: + put: + description: | + Update requestable scopes of a client + operationId: client_extension_requestables_scopes_update_api parameters: - - in: path - name: handle + - description: A service ID. + in: path + name: serviceId + required: true + schema: + type: string + - description: | + A client ID. + in: path + name: clientId required: true schema: type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/client_extension_requestable_scopes_update_request' + required: true responses: - "204": + "200": content: application/json: schema: - $ref: '#/components/schemas/hsk_delete_response' + $ref: '#/components/schemas/client_extension_requestable_scopes_update_response' "400": content: application/json: @@ -12674,16 +10776,222 @@ paths: $ref: '#/components/schemas/result' description: "" security: - - ServiceOwnerCredentials: [] - summary: "/api/hsk/delete/{handle} API" + - ModifyClient: [] + summary: "/api/{serviceId}/client/extension/requestable_scopes/update/{clientId}\ + \ API" tags: - - Hsk Operations - /api/hsk/get/{handle}: - get: - operationId: hsk_get_api + - Client Extension + /api/{serviceId}/client/extension/requestable_scopes/delete/{clientId}: + delete: + description: | + Delete a requestable scopes of a client + operationId: client_extension_requestables_scopes_delete_api parameters: - - in: path - name: handle + - description: A service ID. + in: path + name: serviceId + required: true + schema: + type: string + - description: | + A client ID. + in: path + name: clientId + required: true + schema: + type: string + responses: + "204": + description: Requestable scopes was successfully deleted. + "400": + content: + application/json: + example: + resultCode: A001201 + resultMessage: "[A001201] /auth/authorization, TLS must be used." + schema: + $ref: '#/components/schemas/result' + description: "" + "401": + content: + application/json: + example: + resultCode: A001202 + resultMessage: "[A001202] /auth/authorization, Authorization header\ + \ is missing." + schema: + $ref: '#/components/schemas/result' + description: "" + "403": + content: + application/json: + example: + resultCode: A001215 + resultMessage: "[A001215] /auth/authorization, The client (ID = 26837717140341)\ + \ is locked." + schema: + $ref: '#/components/schemas/result' + description: "" + "500": + content: + application/json: + example: + resultCode: A001101 + resultMessage: "[A001101] /auth/authorization, Authlete Server error." + schema: + $ref: '#/components/schemas/result' + description: "" + security: + - ModifyService: [] + summary: "/api/{serviceId}/client/extension/requestable_scopes/delete/{clientId}\ + \ API" + tags: + - Client Extension + /api/{serviceId}/hsk/create: + post: + operationId: hsk_create_api + parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/hsk_create_request' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/hsk_create_request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/hsk_create_response' + description: "" + "400": + content: + application/json: + example: + resultCode: A001201 + resultMessage: "[A001201] /auth/authorization, TLS must be used." + schema: + $ref: '#/components/schemas/result' + description: "" + "401": + content: + application/json: + example: + resultCode: A001202 + resultMessage: "[A001202] /auth/authorization, Authorization header\ + \ is missing." + schema: + $ref: '#/components/schemas/result' + description: "" + "403": + content: + application/json: + example: + resultCode: A001215 + resultMessage: "[A001215] /auth/authorization, The client (ID = 26837717140341)\ + \ is locked." + schema: + $ref: '#/components/schemas/result' + description: "" + "500": + content: + application/json: + example: + resultCode: A001101 + resultMessage: "[A001101] /auth/authorization, Authlete Server error." + schema: + $ref: '#/components/schemas/result' + description: "" + security: + - ModifyService: [] + summary: "/api/{serviceId}/hsk/create API" + tags: + - Hsk Operations + /api/{serviceId}/hsk/delete/{handle}: + delete: + operationId: hsk_delete_api + parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: + type: string + - in: path + name: handle + required: true + schema: + type: string + responses: + "204": + content: + application/json: + schema: + $ref: '#/components/schemas/hsk_delete_response' + "400": + content: + application/json: + example: + resultCode: A001201 + resultMessage: "[A001201] /auth/authorization, TLS must be used." + schema: + $ref: '#/components/schemas/result' + description: "" + "401": + content: + application/json: + example: + resultCode: A001202 + resultMessage: "[A001202] /auth/authorization, Authorization header\ + \ is missing." + schema: + $ref: '#/components/schemas/result' + description: "" + "403": + content: + application/json: + example: + resultCode: A001215 + resultMessage: "[A001215] /auth/authorization, The client (ID = 26837717140341)\ + \ is locked." + schema: + $ref: '#/components/schemas/result' + description: "" + "500": + content: + application/json: + example: + resultCode: A001101 + resultMessage: "[A001101] /auth/authorization, Authlete Server error." + schema: + $ref: '#/components/schemas/result' + description: "" + security: + - ModifyService: [] + summary: "/api/{serviceId}/hsk/delete/{handle} API" + tags: + - Hsk Operations + /api/{serviceId}/hsk/get/{handle}: + get: + operationId: hsk_get_api + parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: + type: string + - in: path + name: handle required: true schema: type: string @@ -12733,13 +11041,20 @@ paths: $ref: '#/components/schemas/result' description: "" security: - - ServiceOwnerCredentials: [] - summary: "/api/hsk/get/{handle} API" + - UseService: [] + summary: "/api/{serviceId}/hsk/get/{handle} API" tags: - Hsk Operations - /api/hsk/get/list: + /api/{serviceId}/hsk/get/list: get: operationId: hsk_get_list_api + parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: + type: string responses: "200": content: @@ -12785,8 +11100,8 @@ paths: $ref: '#/components/schemas/result' description: "" security: - - ServiceOwnerCredentials: [] - summary: /api/hsk/get/list API + - UseService: [] + summary: "/api/{serviceId}/hsk/get/list API" tags: - Hsk Operations /api/misc/echo: @@ -12798,4103 +11113,4387 @@ paths: "200": description: | Successfully deleted - security: - - ServiceCredentials: [] summary: /api/misc/echo API -components: - responses: - "400": - content: - application/json: - example: - resultCode: A001201 - resultMessage: "[A001201] /auth/authorization, TLS must be used." - schema: - $ref: '#/components/schemas/result' - description: "" - "401": - content: - application/json: - example: - resultCode: A001202 - resultMessage: "[A001202] /auth/authorization, Authorization header is\ - \ missing." - schema: - $ref: '#/components/schemas/result' - description: "" - "403": - content: - application/json: - example: - resultCode: A001215 - resultMessage: "[A001215] /auth/authorization, The client (ID = 26837717140341)\ - \ is locked." - schema: - $ref: '#/components/schemas/result' - description: "" - "500": - content: - application/json: - example: - resultCode: A001101 - resultMessage: "[A001101] /auth/authorization, Authlete Server error." - schema: - $ref: '#/components/schemas/result' - description: "" - schemas: - AccessToken: - example: - createdAt: 2 - lastRefreshedAt: 7 - refreshTokenExpiresAt: 5 - clientId: 9 - accessTokenExpiresAt: 5 - subject: subject - scopes: - - scopes - - scopes - accessTokenHash: accessTokenHash - refreshTokenHash: refreshTokenHash - grantType: null - properties: - - hidden: true - value: value - key: key - - hidden: true - value: value - key: key - properties: - accessTokenHash: - description: The hash of the access token. - type: string - accessTokenExpiresAt: - description: The timestamp at which the access token will expire. - format: int64 - type: integer - refreshTokenHash: - description: The hash of the refresh token. + /api/{serviceId}/vci/metadata: + post: + operationId: vci_metadata_api + parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: type: string - refreshTokenExpiresAt: - description: The timestamp at which the refresh token will expire. - format: int64 - type: integer - createdAt: - description: | - The timestamp at which the access token was first created. - format: int64 - type: integer - lastRefreshedAt: - description: | - The timestamp at which the access token was last refreshed using the refresh token. - format: int64 - type: integer - clientId: - description: | - The ID of the client associated with the access token. - format: int64 - type: integer - subject: - description: | - The subject (= unique user ID) associated with the access token. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/vci_metadata_request' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/vci_metadata_request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/vci_metadata_response' + description: "" + "400": + content: + application/json: + example: + resultCode: A001201 + resultMessage: "[A001201] /auth/authorization, TLS must be used." + schema: + $ref: '#/components/schemas/result' + description: "" + "401": + content: + application/json: + example: + resultCode: A001202 + resultMessage: "[A001202] /auth/authorization, Authorization header\ + \ is missing." + schema: + $ref: '#/components/schemas/result' + description: "" + "403": + content: + application/json: + example: + resultCode: A001215 + resultMessage: "[A001215] /auth/authorization, The client (ID = 26837717140341)\ + \ is locked." + schema: + $ref: '#/components/schemas/result' + description: "" + "500": + content: + application/json: + example: + resultCode: A001101 + resultMessage: "[A001101] /auth/authorization, Authlete Server error." + schema: + $ref: '#/components/schemas/result' + description: "" + security: + - UseService: [] + summary: "/api/{serviceId}/vci/metadata API" + tags: + - Vci Endpoint + /api/{serviceId}/vci/jwtissuer: + post: + operationId: vci_jwtissuer_api + parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: type: string - grantType: - $ref: '#/components/schemas/grant_type' - scopes: - description: | - The scopes associated with the access token. - items: - type: string - type: array - properties: - description: | - The properties associated with the access token. - items: - $ref: '#/components/schemas/Property' - type: array - type: object - ApplicationType: - description: | - The application type. The value of this property affects the validation steps for a redirect URI. - See the description about `redirectUris` property for more details. - enum: - - WEB - - NATIVE - - null - nullable: true - type: string - AuthorizationDetails: - description: | - The authorization details. This represents the value of the `authorization_details` - request parameter in the preceding device authorization request which is defined in - "OAuth 2.0 Rich Authorization Requests". - example: - elements: - - dataTypes: - - dataTypes - - dataTypes - identifier: identifier - privileges: - - privileges - - privileges - locations: - - locations - - locations - type: type - otherFields: otherFields - actions: - - actions - - actions - - dataTypes: - - dataTypes - - dataTypes - identifier: identifier - privileges: - - privileges - - privileges - locations: - - locations - - locations - type: type - otherFields: otherFields - actions: - - actions - - actions - properties: - elements: - description: | - Elements of this authorization details. - items: - $ref: '#/components/schemas/authorization_details_element' - type: array - type: object - AuthorizationDetailsElement: - example: - dataTypes: - - dataTypes - - dataTypes - identifier: identifier - privileges: - - privileges - - privileges - locations: - - locations - - locations - type: type - otherFields: otherFields - actions: - - actions - - actions - properties: - type: - description: | - The type of this element. - - From _"OAuth 2.0 Rich Authorization Requests"_: _"The type of authorization data as a string. - This field MAY define which other elements are allowed in the request. This element is REQUIRED."_ - - This property is always NOT `null`. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/vci_jwtissuer_request' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/vci_jwtissuer_request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/vci_jwtissuer_response' + description: "" + "400": + content: + application/json: + example: + resultCode: A001201 + resultMessage: "[A001201] /auth/authorization, TLS must be used." + schema: + $ref: '#/components/schemas/result' + description: "" + "401": + content: + application/json: + example: + resultCode: A001202 + resultMessage: "[A001202] /auth/authorization, Authorization header\ + \ is missing." + schema: + $ref: '#/components/schemas/result' + description: "" + "403": + content: + application/json: + example: + resultCode: A001215 + resultMessage: "[A001215] /auth/authorization, The client (ID = 26837717140341)\ + \ is locked." + schema: + $ref: '#/components/schemas/result' + description: "" + "500": + content: + application/json: + example: + resultCode: A001101 + resultMessage: "[A001101] /auth/authorization, Authlete Server error." + schema: + $ref: '#/components/schemas/result' + description: "" + security: + - UseService: [] + summary: "/api/{serviceId}/vci/jwtissuer API" + tags: + - Vci Endpoint + /api/{serviceId}/vci/jwks: + post: + operationId: vci_jwks_api + parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: type: string - locations: - description: | - The resources and/or resource servers. This property may be `null`. - - From _"OAuth 2.0 Rich Authorization Requests"_: _"An array of strings representing the location of - the resource or resource server. This is typically composed of URIs."_ - - This property may be `null`. - items: - type: string - type: array - actions: - description: | - The actions. - - From _"OAuth 2.0 Rich Authorization Requests"_: _"An array of strings representing the kinds of actions - to be taken at the resource. The values of the strings are determined by the API being protected."_ - - This property may be `null`. - items: - type: string - type: array - dataTypes: - description: | - From _"OAuth 2.0 Rich Authorization Requests"_: _"An array of strings representing the kinds of data being requested - from the resource."_ - - This property may be `null`. - items: - type: string - type: array - identifier: - description: | - The identifier of a specific resource. - From _"OAuth 2.0 Rich Authorization Requests"_: _"A string identifier indicating a specific resource available at the API."_ - - This property may be `null`. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/vci_jwks_request' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/vci_jwks_request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/vci_jwks_response' + description: "" + "400": + content: + application/json: + example: + resultCode: A001201 + resultMessage: "[A001201] /auth/authorization, TLS must be used." + schema: + $ref: '#/components/schemas/result' + description: "" + "401": + content: + application/json: + example: + resultCode: A001202 + resultMessage: "[A001202] /auth/authorization, Authorization header\ + \ is missing." + schema: + $ref: '#/components/schemas/result' + description: "" + "403": + content: + application/json: + example: + resultCode: A001215 + resultMessage: "[A001215] /auth/authorization, The client (ID = 26837717140341)\ + \ is locked." + schema: + $ref: '#/components/schemas/result' + description: "" + "500": + content: + application/json: + example: + resultCode: A001101 + resultMessage: "[A001101] /auth/authorization, Authlete Server error." + schema: + $ref: '#/components/schemas/result' + description: "" + security: + - UseService: [] + summary: "/api/{serviceId}/vci/jwks API" + tags: + - Vci Endpoint + /api/{serviceId}/vci/offer/create: + post: + operationId: vci_offer_create_api + parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: type: string - privileges: - description: | - The types or levels of privilege. - From "OAuth 2.0 Rich Authorization Requests": _"An array of strings representing the types or - levels of privilege being requested at the resource."_ - - This property may be `null`. - items: - type: string - type: array - otherFields: - description: | - The RAR request in the JSON format excluding the pre-defined attributes such as `type` and `locations`. - The content and semantics are specific to the deployment and the use case implemented. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/vci_offer_create_request' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/vci_offer_create_request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/vci_offer_create_response' + description: "" + "400": + content: + application/json: + example: + resultCode: A001201 + resultMessage: "[A001201] /auth/authorization, TLS must be used." + schema: + $ref: '#/components/schemas/result' + description: "" + "401": + content: + application/json: + example: + resultCode: A001202 + resultMessage: "[A001202] /auth/authorization, Authorization header\ + \ is missing." + schema: + $ref: '#/components/schemas/result' + description: "" + "403": + content: + application/json: + example: + resultCode: A001215 + resultMessage: "[A001215] /auth/authorization, The client (ID = 26837717140341)\ + \ is locked." + schema: + $ref: '#/components/schemas/result' + description: "" + "500": + content: + application/json: + example: + resultCode: A001101 + resultMessage: "[A001101] /auth/authorization, Authlete Server error." + schema: + $ref: '#/components/schemas/result' + description: "" + security: + - UseService: [] + summary: "/api/{serviceId}/vci/offer/create API" + tags: + - Vci Endpoint + /api/{serviceId}/vci/offer/info: + post: + operationId: vci_offer_info_api + parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: type: string - required: - - type - type: object - ClaimType: - enum: - - NORMAL - - AGGREGATED - - DISTRIBUTED - type: string - ClientAuthenticationMethod: - description: | - The client authentication method that the client application declares that it uses at the token - endpoint. This property corresponds to `token_endpoint_auth_method` in [OpenID Connect Dynamic - Client Registration 1.0, 2. Client Metadata](https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata). - enum: - - NONE - - CLIENT_SECRET_BASIC - - CLIENT_SECRET_POST - - CLIENT_SECRET_JWT - - PRIVATE_KEY_JWT - - TLS_CLIENT_AUTH - - SELF_SIGNED_TLS_CLIENT_AUTH - type: string - ClientExtension: - example: - refreshTokenDuration: 9 - requestableScopes: - - requestableScopes - - requestableScopes - tokenExchangePermitted: true - requestableScopesEnabled: true - accessTokenDuration: 7 - properties: - requestableScopes: - description: | - The set of scopes that the client application is allowed to request. This paramter will be one - of the following. - - - `null` - - an empty set - - a set with at least one element - - When the value of this parameter is `null`, it means that the set of scopes that the client - application is allowed to request is the set of the scopes that the service supports. When the - value of this parameter is an empty set, it means that the client application is not allowed to - request any scopes. When the value of this parameter is a set with at least one element, it means - that the set is the set of scopes that the client application is allowed to request. - items: - type: string - type: array - requestableScopesEnabled: - description: | - The flag to indicate whether "Requestable Scopes per Client" is enabled or not. If `true`, you - can define the set of scopes which this client application can request. If `false`, this client - application can request any scope which is supported by the authorization server. - type: boolean - accessTokenDuration: - description: | - The value of the duration of access tokens per client in seconds. In normal cases, the value of - the service's `accessTokenDuration` property is used as the duration of access tokens issued by - the service. However, if this `accessTokenDuration` property holds a non-zero positive number - and its value is less than the duration configured by the service, the value is used as the duration - of access tokens issued to the client application. - - Note that the duration of access tokens can be controlled by the scope attribute `access_token.duration`, - too. Authlete chooses the minimum value among the candidates. - format: int64 - type: integer - refreshTokenDuration: - description: | - The value of the duration of refresh tokens per client in seconds. In normal cases, the value - of the service's `refreshTokenDuration` property is used as the duration of refresh tokens issued - by the service. However, if this `refreshTokenDuration` property holds a non-zero positive number - and its value is less than the duration configured by the service, the value is used as the duration - of refresh tokens issued to the client application. - - Note that the duration of refresh tokens can be controlled by the scope attribute `refresh_token.duration`, - too. Authlete chooses the minimum value among the candidates. - format: int64 - type: integer - tokenExchangePermitted: - description: |- - Get the flag indicating whether the client is explicitly given a - permission to make token exchange requests ([RFC 8693][https://www.rfc-editor.org/rfc/rfc8693.html]) - type: boolean - type: object - Client: - example: - serviceNumber: 6 - applicationType: null - bcNotificationEndpoint: bcNotificationEndpoint - tlsClientAuthSanEmail: tlsClientAuthSanEmail - modifiedAt: 5 - logoUris: - - tag: tag - value: value - - tag: tag - value: value - singleAccessTokenPerSubject: true - dpopRequired: true - signedJwksUri: signedJwksUri - descriptions: - - tag: tag - value: value - - tag: tag - value: value - subjectType: null - clientNames: - - tag: tag - value: value - - tag: tag - value: value - number: 0 - createdAt: 5 - automaticallyRegistered: true - clientType: null - tlsClientCertificateBoundAccessTokens: true - bcDeliveryMode: bcDeliveryMode - idTokenEncryptionEnc: null - clientSecret: clientSecret - selfSignedCertificateKeyId: selfSignedCertificateKeyId - idTokenSignAlg: null - locked: true - clientUri: clientUri - trustChain: - - trustChain - - trustChain - tlsClientAuthSanDns: tlsClientAuthSanDns - organizationName: organizationName - tlsClientAuthSanIp: tlsClientAuthSanIp - policyUris: - - tag: tag - value: value - - tag: tag - value: value - parRequired: true - derivedSectorIdentifier: derivedSectorIdentifier - logoUri: logoUri - requestObjectEncryptionEncMatchRequired: true - redirectUris: - - redirectUris - - redirectUris - requestEncryptionAlg: null - defaultAcrs: - - defaultAcrs - - defaultAcrs - requestObjectEncryptionAlgMatchRequired: true - trustChainExpiresAt: 3 - grantTypes: - - null - - null - authorizationEncryptionEnc: null - pkceS256Required: true - tlsClientAuthSubjectDn: tlsClientAuthSubjectDn - rsRequestSigned: true - tosUri: tosUri - requestUris: - - requestUris - - requestUris - explicitlyRegistered: true - softwareVersion: softwareVersion - authorizationSignAlg: null - registrationAccessTokenHash: registrationAccessTokenHash - extension: - refreshTokenDuration: 9 - requestableScopes: - - requestableScopes - - requestableScopes - tokenExchangePermitted: true - requestableScopesEnabled: true - accessTokenDuration: 7 - jwks: jwks - clientUris: - - tag: tag - value: value - - tag: tag - value: value - clientName: clientName - requestSignAlg: null - tosUris: - - tag: tag - value: value - - tag: tag - value: value - description: description - jwksUri: jwksUri - authorizationDetailsTypes: - - authorizationDetailsTypes - - authorizationDetailsTypes - userInfoEncryptionEnc: null - clientIdAlias: clientIdAlias - authorizationEncryptionAlg: null - clientRegistrationTypes: - - null - - null - loginUri: loginUri - userInfoSignAlg: null - policyUri: policyUri - customMetadata: customMetadata - tokenAuthSignAlg: null - authTimeRequired: true - idTokenEncryptionAlg: null - clientIdAliasEnabled: true - bcUserCodeRequired: true - tokenAuthMethod: null - defaultMaxAge: 2 - trustAnchorId: trustAnchorId - responseTypes: - - null - - null - sectorIdentifierUri: sectorIdentifierUri - clientId: 1 - dynamicallyRegistered: true - requestObjectRequired: true - digestAlgorithm: digestAlgorithm - entityId: entityId - requestEncryptionEnc: null - tlsClientAuthSanUri: tlsClientAuthSanUri - frontChannelRequestObjectEncryptionRequired: true - softwareId: softwareId - trustChainUpdatedAt: 2 - userInfoEncryptionAlg: null - developer: developer - attributes: - - value: value - key: key - - value: value - key: key - rsSignedRequestKeyId: rsSignedRequestKeyId - bcRequestSignAlg: null - pkceRequired: true - contacts: - - contacts - - contacts - properties: - number: - description: | - The sequential number of the client. The value of this property is assigned by Authlete. - format: int32 - readOnly: true - type: integer - serviceNumber: - description: | - The sequential number of the service of the client application. The value of this property is - assigned by Authlete. - format: int32 - readOnly: true - type: integer - developer: - description: | - The developer of the client application. - type: string - clientName: - description: | - The name of the client application. This property corresponds to `client_name` in - [OpenID Connect Dynamic Client Registration 1.0, 2. Client Metadata](https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata). - type: string - clientNames: - description: | - Client names with language tags. If the client application has different names for different - languages, this property can be used to register the names. - items: - $ref: '#/components/schemas/tagged_value' - type: array - description: - description: The description about the client application. - type: string - descriptions: - description: | - Descriptions about the client application with language tags. If the client application has different - descriptions for different languages, this property can be used to register the descriptions. - items: - $ref: '#/components/schemas/tagged_value' - type: array - clientId: - description: The client ID. The value of this property is assigned by Authlete. - format: int64 - readOnly: true - type: integer - clientSecret: - description: | - The client secret. A random 512-bit value encoded by base64url (86 letters). The value of this - property is assigned by Authlete. - - Note that Authlete issues a client secret even to a "public" client application, but the client - application should not use the client secret unless it changes its client type to "confidential". - That is, a public client application should behave as if it had not been issued a client secret. - To be specific, a token request from a public client of Authlete should not come along with a - client secret although [RFC 6749, 3.2.1. Client Authentication](https://datatracker.ietf.org/doc/html/rfc6749#section-3.2.1) - says as follows. - - > Confidential clients or other clients issued client credentials MUST authenticate with the - authorization server as described in Section 2.3 when making requests to the token endpoint. - readOnly: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/vci_offer_info_request' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/vci_offer_info_request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/vci_offer_info_response' + description: "" + "400": + content: + application/json: + example: + resultCode: A001201 + resultMessage: "[A001201] /auth/authorization, TLS must be used." + schema: + $ref: '#/components/schemas/result' + description: "" + "401": + content: + application/json: + example: + resultCode: A001202 + resultMessage: "[A001202] /auth/authorization, Authorization header\ + \ is missing." + schema: + $ref: '#/components/schemas/result' + description: "" + "403": + content: + application/json: + example: + resultCode: A001215 + resultMessage: "[A001215] /auth/authorization, The client (ID = 26837717140341)\ + \ is locked." + schema: + $ref: '#/components/schemas/result' + description: "" + "500": + content: + application/json: + example: + resultCode: A001101 + resultMessage: "[A001101] /auth/authorization, Authlete Server error." + schema: + $ref: '#/components/schemas/result' + description: "" + security: + - UseService: [] + summary: "/api/{serviceId}/vci/offer/info API" + tags: + - Vci Endpoint + /api/{serviceId}/vci/single/parse: + post: + operationId: vci_single_parse_api + parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: type: string - clientIdAlias: - description: | - The alias of the client ID. - - Note that the client ID alias is recognized only when this client's `clientIdAliasEnabled` property - is set to `true` AND the service's `clientIdAliasEnabled` property is also set to `true`. - type: string - clientIdAliasEnabled: - description: | - The flag to indicate whether the client ID alias is enabled or not. - - Note that a service also has `clientIdAliasEnabled` property. If the service's `clientIdAliasEnabled` - property is set to `false`, the client ID alias of this client is not recognized even if this - client's `clientIdAliasEnabled` property is set to `true`. - type: boolean - clientType: - $ref: '#/components/schemas/client_type' - applicationType: - $ref: '#/components/schemas/application_type' - logoUri: - description: | - The URL pointing to the logo image of the client application. - - This property corresponds to `logo_uri` in [OpenID Connect Dynamic Client Registration 1.0, 2. - Client Metadata](https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata). - type: string - logoUris: - description: | - Logo image URLs with language tags. If the client application has different logo images for - different languages, this property can be used to register URLs of the images. - items: - $ref: '#/components/schemas/tagged_value' - type: array - contacts: - description: | - An array of email addresses of people responsible for the client application. - - This property corresponds to contacts in [OpenID Connect Dynamic Client Registration 1.0, 2. Client - Metadata](https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata). - items: - type: string - type: array - tlsClientCertificateBoundAccessTokens: - description: | - The flag to indicate whether this client use TLS client certificate bound access tokens. - type: boolean - dynamicallyRegistered: - description: | - The flag to indicate whether this client has been registered dynamically. - For more details, see [RFC 7591](https://datatracker.ietf.org/doc/html/rfc7591). - readOnly: true - type: boolean - softwareId: - description: | - The unique identifier string assigned by the client developer or software publisher used by - registration endpoints to identify the client software to be dynamically registered. - - This property corresponds to the `software_id metadata` defined in [2. Client Metadata](https://datatracker.ietf.org/doc/html/rfc7591#section-2) - of [RFC 7591](https://datatracker.ietf.org/doc/html/rfc7591). + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/vci_single_parse_request' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/vci_single_parse_request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/vci_single_parse_response' + description: "" + "400": + content: + application/json: + example: + resultCode: A001201 + resultMessage: "[A001201] /auth/authorization, TLS must be used." + schema: + $ref: '#/components/schemas/result' + description: "" + "401": + content: + application/json: + example: + resultCode: A001202 + resultMessage: "[A001202] /auth/authorization, Authorization header\ + \ is missing." + schema: + $ref: '#/components/schemas/result' + description: "" + "403": + content: + application/json: + example: + resultCode: A001215 + resultMessage: "[A001215] /auth/authorization, The client (ID = 26837717140341)\ + \ is locked." + schema: + $ref: '#/components/schemas/result' + description: "" + "500": + content: + application/json: + example: + resultCode: A001101 + resultMessage: "[A001101] /auth/authorization, Authlete Server error." + schema: + $ref: '#/components/schemas/result' + description: "" + security: + - UseService: [] + summary: "/api/{serviceId}/vci/single/parse API" + tags: + - Vci Endpoint + /api/{serviceId}/vci/single/issue: + post: + operationId: vci_single_issue_api + parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: type: string - softwareVersion: - description: | - The version identifier string for the client software identified by the software ID. - - This property corresponds to the software_version metadata defined in [2. Client Metadata](https://datatracker.ietf.org/doc/html/rfc7591#section-2) - of [RFC 7591](https://datatracker.ietf.org/doc/html/rfc7591). + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/vci_single_issue_request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/vci_single_issue_response' + description: "" + "400": + content: + application/json: + example: + resultCode: A001201 + resultMessage: "[A001201] /auth/authorization, TLS must be used." + schema: + $ref: '#/components/schemas/result' + description: "" + "401": + content: + application/json: + example: + resultCode: A001202 + resultMessage: "[A001202] /auth/authorization, Authorization header\ + \ is missing." + schema: + $ref: '#/components/schemas/result' + description: "" + "403": + content: + application/json: + example: + resultCode: A001215 + resultMessage: "[A001215] /auth/authorization, The client (ID = 26837717140341)\ + \ is locked." + schema: + $ref: '#/components/schemas/result' + description: "" + "500": + content: + application/json: + example: + resultCode: A001101 + resultMessage: "[A001101] /auth/authorization, Authlete Server error." + schema: + $ref: '#/components/schemas/result' + description: "" + security: + - UseService: [] + summary: "/api/{serviceId}/vci/single/issue API" + tags: + - Vci Endpoint + /api/{serviceId}/vci/batch/parse: + post: + operationId: vci_batch_parse_api + parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: type: string - registrationAccessTokenHash: - description: | - The hash of the registration access token for this client. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/vci_batch_parse_request' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/vci_batch_parse_request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/vci_batch_parse_response' + description: "" + "400": + content: + application/json: + example: + resultCode: A001201 + resultMessage: "[A001201] /auth/authorization, TLS must be used." + schema: + $ref: '#/components/schemas/result' + description: "" + "401": + content: + application/json: + example: + resultCode: A001202 + resultMessage: "[A001202] /auth/authorization, Authorization header\ + \ is missing." + schema: + $ref: '#/components/schemas/result' + description: "" + "403": + content: + application/json: + example: + resultCode: A001215 + resultMessage: "[A001215] /auth/authorization, The client (ID = 26837717140341)\ + \ is locked." + schema: + $ref: '#/components/schemas/result' + description: "" + "500": + content: + application/json: + example: + resultCode: A001101 + resultMessage: "[A001101] /auth/authorization, Authlete Server error." + schema: + $ref: '#/components/schemas/result' + description: "" + security: + - UseService: [] + summary: "/api/{serviceId}/vci/batch/parse API" + tags: + - Vci Endpoint + /api/{serviceId}/vci/batch/issue: + post: + operationId: vci_batch_issue_api + parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: type: string - createdAt: - description: The time at which this client was created. The value is represented - as milliseconds since the UNIX epoch (1970-01-01). - format: int64 - readOnly: true - type: integer - modifiedAt: - description: The time at which this client was last modified. The value - is represented as milliseconds since the UNIX epoch (1970-01-01). - format: int64 - readOnly: true - type: integer - grantTypes: - description: | - A string array of grant types which the client application declares that it will restrict itself to using. - This property corresponds to `grant_types` in [OpenID Connect Dynamic Client Registration 1.0, - 2. Client Metadata](https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata). - items: - $ref: '#/components/schemas/grant_type' - type: array - responseTypes: - description: | - A string array of response types which the client application declares that it will restrict itself to using. - This property corresponds to `response_types` in [OpenID Connect Dynamic Client Registration 1.0, - 2. Client Metadata](https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata). - items: - $ref: '#/components/schemas/response_type' - type: array - redirectUris: - description: | - Redirect URIs that the client application uses to receive a response from the authorization endpoint. - Requirements for a redirect URI are as follows. - - **Requirements by RFC 6749** (From [RFC 6749, 3.1.2. Redirection Endpoint](https://datatracker.ietf.org/doc/html/rfc6749#section-3.1.2)) - - - Must be an absolute URI. - - Must not have a fragment component. - - **Requirements by OpenID Connect** (From "[OpenID Connect Dynamic Client Registration 1.0, 2. - Client Metadata](https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata), - application_type") - - - The scheme of the redirect URI used for Implicit Grant by a client application whose application - is `web` must be `https`. This is checked at runtime by Authlete. - - The hostname of the redirect URI used for Implicit Grant by a client application whose application - type is `web` must not be `localhost`. This is checked at runtime by Authlete. - - The scheme of the redirect URI used by a client application whose application type is `native` - must be either (1) a custom scheme or (2) `http`, which is allowed only when the hostname part - is `localhost`. This is checked at runtime by Authlete. - - **Requirements by Authlete** - - - Must consist of printable ASCII letters only. - - Must not exceed 200 letters. - - Note that Authlete allows the application type to be `null`. In other words, a client application - does not have to choose `web` or `native` as its application type. - If the application type is `null`, the requirements by OpenID Connect are not checked at runtime. - - An authorization request from a client application which has not registered any redirect URI - fails unless at least all the following conditions are satisfied. - - - The client type of the client application is `confidential`. - - The value of `response_type` request parameter is `code`. - - The authorization request has the `redirect_uri` request parameter. - - The value of `scope` request parameter does not contain `openid`. - - RFC 6749 allows partial match of redirect URI under some conditions (see [RFC 6749, 3.1.2.2. - Registration Requirements](https://datatracker.ietf.org/doc/html/rfc6749#section-3.1.2.2) for - details), but OpenID Connect requires exact match. - items: - type: string - type: array - authorizationSignAlg: - $ref: '#/components/schemas/jws_alg' - authorizationEncryptionAlg: - $ref: '#/components/schemas/jwe_alg' - authorizationEncryptionEnc: - $ref: '#/components/schemas/jwe_enc' - tokenAuthMethod: - $ref: '#/components/schemas/client_auth_method' - tokenAuthSignAlg: - $ref: '#/components/schemas/jws_alg' - selfSignedCertificateKeyId: - description: | - The key ID of a JWK containing a self-signed certificate of this client. - type: string - tlsClientAuthSubjectDn: - description: | - The string representation of the expected subject distinguished name of the certificate this - client will use in mutual TLS authentication. - - See `tls_client_auth_subject_dn` in "Mutual TLS Profiles for OAuth Clients, 2.3. Dynamic Client - Registration" for details. - type: string - tlsClientAuthSanDns: - description: | - The string representation of the expected DNS subject alternative name of the certificate this - client will use in mutual TLS authentication. - - See `tls_client_auth_san_dns` in "Mutual TLS Profiles for OAuth Clients, 2.3. Dynamic Client - Registration" for details. - type: string - tlsClientAuthSanUri: - description: | - The string representation of the expected URI subject alternative name of the certificate this - client will use in mutual TLS authentication. - - See `tls_client_auth_san_uri` in "Mutual TLS Profiles for OAuth Clients, 2.3. Dynamic Client - Registration" for details. - type: string - tlsClientAuthSanIp: - description: | - The string representation of the expected IP address subject alternative name of the certificate - this client will use in mutual TLS authentication. - - See `tls_client_auth_san_ip` in "Mutual TLS Profiles for OAuth Clients, 2.3. Dynamic Client - Registration" for details. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/vci_batch_issue_request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/vci_batch_issue_response' + description: "" + "400": + content: + application/json: + example: + resultCode: A001201 + resultMessage: "[A001201] /auth/authorization, TLS must be used." + schema: + $ref: '#/components/schemas/result' + description: "" + "401": + content: + application/json: + example: + resultCode: A001202 + resultMessage: "[A001202] /auth/authorization, Authorization header\ + \ is missing." + schema: + $ref: '#/components/schemas/result' + description: "" + "403": + content: + application/json: + example: + resultCode: A001215 + resultMessage: "[A001215] /auth/authorization, The client (ID = 26837717140341)\ + \ is locked." + schema: + $ref: '#/components/schemas/result' + description: "" + "500": + content: + application/json: + example: + resultCode: A001101 + resultMessage: "[A001101] /auth/authorization, Authlete Server error." + schema: + $ref: '#/components/schemas/result' + description: "" + security: + - UseService: [] + summary: "/api/{serviceId}/vci/batch/issue API" + tags: + - Vci Endpoint + /api/{serviceId}/vci/deferred/parse: + post: + operationId: vci_deferred_parse_api + parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: type: string - tlsClientAuthSanEmail: - description: | - The string representation of the expected email address subject alternative name of the certificate - this client will use in mutual TLS authentication. - - See `tls_client_auth_san_email` in "Mutual TLS Profiles for OAuth Clients, 2.3. Dynamic Client - Registration" for details. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/vci_deferred_parse_request' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/vci_deferred_parse_request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/vci_deferred_parse_response' + description: "" + "400": + content: + application/json: + example: + resultCode: A001201 + resultMessage: "[A001201] /auth/authorization, TLS must be used." + schema: + $ref: '#/components/schemas/result' + description: "" + "401": + content: + application/json: + example: + resultCode: A001202 + resultMessage: "[A001202] /auth/authorization, Authorization header\ + \ is missing." + schema: + $ref: '#/components/schemas/result' + description: "" + "403": + content: + application/json: + example: + resultCode: A001215 + resultMessage: "[A001215] /auth/authorization, The client (ID = 26837717140341)\ + \ is locked." + schema: + $ref: '#/components/schemas/result' + description: "" + "500": + content: + application/json: + example: + resultCode: A001101 + resultMessage: "[A001101] /auth/authorization, Authlete Server error." + schema: + $ref: '#/components/schemas/result' + description: "" + security: + - UseService: [] + summary: "/api/{serviceId}/vci/deferred/parse API" + tags: + - Vci Endpoint + /api/{serviceId}/vci/deferred/issue: + post: + operationId: vci_deferred_issue_api + parameters: + - description: A service ID. + in: path + name: serviceId + required: true + schema: type: string - parRequired: - description: | - The flag to indicate whether this client is required to use the pushed authorization request endpoint. - This property corresponds to the `require_pushed_authorization_requests` client metadata defined - in "OAuth 2.0 Pushed Authorization Requests". - type: boolean - requestObjectRequired: - description: | - The flag to indicate whether authorization requests from this client are always required to - utilize a request object by using either `request` or `request_uri` request parameter. - - If this flag is set to `true` and the service's `traditionalRequestObjectProcessingApplied` is - set to `false`, authorization requests from this client are processed as if `require_signed_request_object` - client metadata of this client is `true`. The metadata is defined in "JAR (JWT Secured Authorization Request)". - type: boolean - requestSignAlg: - $ref: '#/components/schemas/jws_alg' - requestEncryptionAlg: - $ref: '#/components/schemas/jwe_alg' - requestEncryptionEnc: - $ref: '#/components/schemas/jwe_enc' - requestUris: - description: | - An array of URLs each of which points to a request object. - - Authlete requires that URLs used as values for `request_uri` request parameter be pre-registered. - This property is used for the pre-registration. - See [OpenID Connect Core 1.0, 6.2. Passing a Request Object by Reference](https://openid.net/specs/openid-connect-core-1_0.html#RequestUriParameter) for details. - items: - type: string - type: array - defaultMaxAge: - description: | - The default maximum authentication age in seconds. This value is used when an authorization request from the client application does not have `max_age` request parameter. - - This property corresponds to `default_max_age` in - [OpenID Connect Dynamic Client Registration 1.0, 2. Client Metadata](https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata). - format: int32 - type: integer - defaultAcrs: - description: | - The default ACRs (Authentication Context Class References). This value is used when an authorization - request from the client application has neither `acr_values` request parameter nor `acr` claim - in claims request parameter. - items: - type: string - type: array - idTokenSignAlg: - $ref: '#/components/schemas/jws_alg' - idTokenEncryptionAlg: - $ref: '#/components/schemas/jwe_alg' - idTokenEncryptionEnc: - $ref: '#/components/schemas/jwe_enc' - authTimeRequired: - description: | - The flag to indicate whether this client requires `auth_time` claim to be embedded in the ID token. - - This property corresponds to `require_auth_time` in - [OpenID Connect Dynamic Client Registration 1.0, 2. Client Metadata](https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata). - type: boolean - subjectType: - $ref: '#/components/schemas/subject_type' - sectorIdentifierUri: - description: | - The value of the sector identifier URI. - This represents the `sector_identifier_uri` client metadata which is defined in - [OpenID Connect Dynamic Client Registration 1.0, 2. Client Metadata](https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata) + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/vci_deferred_issue_request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/vci_deferred_issue_response' + description: "" + "400": + content: + application/json: + example: + resultCode: A001201 + resultMessage: "[A001201] /auth/authorization, TLS must be used." + schema: + $ref: '#/components/schemas/result' + description: "" + "401": + content: + application/json: + example: + resultCode: A001202 + resultMessage: "[A001202] /auth/authorization, Authorization header\ + \ is missing." + schema: + $ref: '#/components/schemas/result' + description: "" + "403": + content: + application/json: + example: + resultCode: A001215 + resultMessage: "[A001215] /auth/authorization, The client (ID = 26837717140341)\ + \ is locked." + schema: + $ref: '#/components/schemas/result' + description: "" + "500": + content: + application/json: + example: + resultCode: A001101 + resultMessage: "[A001101] /auth/authorization, Authlete Server error." + schema: + $ref: '#/components/schemas/result' + description: "" + security: + - UseService: [] + summary: "/api/{serviceId}/vci/deferred/issue API" + tags: + - Vci Endpoint + /api/{serviceId}/auth/authorization/ticket/info: + get: + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/authorization_ticket_info_request' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/authorization_ticket_info_request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/authorization_ticket_info_response' + description: "" + "400": + content: + application/json: + example: + resultCode: A001201 + resultMessage: "[A001201] /auth/authorization, TLS must be used." + schema: + $ref: '#/components/schemas/result' + description: "" + "401": + content: + application/json: + example: + resultCode: A001202 + resultMessage: "[A001202] /auth/authorization, Authorization header\ + \ is missing." + schema: + $ref: '#/components/schemas/result' + description: "" + "403": + content: + application/json: + example: + resultCode: A001215 + resultMessage: "[A001215] /auth/authorization, The client (ID = 26837717140341)\ + \ is locked." + schema: + $ref: '#/components/schemas/result' + description: "" + "500": + content: + application/json: + example: + resultCode: A001101 + resultMessage: "[A001101] /auth/authorization, Authlete Server error." + schema: + $ref: '#/components/schemas/result' + description: "" + security: + - UseService: [] + summary: "/api/{serviceId}/auth/authorization/ticket/info API" + tags: + - Authorization Endpoint + /api/{serviceId}/auth/authorization/ticket/update: + post: + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/authorization_ticket_update_request' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/authorization_ticket_update_request' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/authorization_ticket_update_response' + description: "" + "400": + content: + application/json: + example: + resultCode: A001201 + resultMessage: "[A001201] /auth/authorization, TLS must be used." + schema: + $ref: '#/components/schemas/result' + description: "" + "401": + content: + application/json: + example: + resultCode: A001202 + resultMessage: "[A001202] /auth/authorization, Authorization header\ + \ is missing." + schema: + $ref: '#/components/schemas/result' + description: "" + "403": + content: + application/json: + example: + resultCode: A001215 + resultMessage: "[A001215] /auth/authorization, The client (ID = 26837717140341)\ + \ is locked." + schema: + $ref: '#/components/schemas/result' + description: "" + "500": + content: + application/json: + example: + resultCode: A001101 + resultMessage: "[A001101] /auth/authorization, Authlete Server error." + schema: + $ref: '#/components/schemas/result' + description: "" + security: + - UseService: [] + summary: "/api/{serviceId}/auth/authorization/ticket/update API" + tags: + - Authorization Endpoint +components: + responses: + "400": + content: + application/json: + example: + resultCode: A001201 + resultMessage: "[A001201] /auth/authorization, TLS must be used." + schema: + $ref: '#/components/schemas/result' + description: "" + "401": + content: + application/json: + example: + resultCode: A001202 + resultMessage: "[A001202] /auth/authorization, Authorization header is\ + \ missing." + schema: + $ref: '#/components/schemas/result' + description: "" + "403": + content: + application/json: + example: + resultCode: A001215 + resultMessage: "[A001215] /auth/authorization, The client (ID = 26837717140341)\ + \ is locked." + schema: + $ref: '#/components/schemas/result' + description: "" + "500": + content: + application/json: + example: + resultCode: A001101 + resultMessage: "[A001101] /auth/authorization, Authlete Server error." + schema: + $ref: '#/components/schemas/result' + description: "" + schemas: + AccessToken: + example: + createdAt: 2 + lastRefreshedAt: 7 + refreshTokenExpiresAt: 5 + clientId: 9 + accessTokenExpiresAt: 5 + subject: subject + scopes: + - scopes + - scopes + accessTokenHash: accessTokenHash + refreshTokenHash: refreshTokenHash + grantType: null + properties: + - hidden: true + value: value + key: key + - hidden: true + value: value + key: key + properties: + accessTokenHash: + description: The hash of the access token. type: string - derivedSectorIdentifier: - description: | - The sector identifier host component as derived from either the `sector_identifier_uri` or the - registered redirect URI. If no `sector_identifier_uri` is registered and multiple redirect URIs - are also registered, the value of this property is `null`. - readOnly: true + accessTokenExpiresAt: + description: The timestamp at which the access token will expire. + format: int64 + type: integer + refreshTokenHash: + description: The hash of the refresh token. type: string - jwksUri: + refreshTokenExpiresAt: + description: The timestamp at which the refresh token will expire. + format: int64 + type: integer + createdAt: description: | - The URL pointing to the JWK Set of the client application. - The content pointed to by the URL is JSON which complies with the format described in - [JSON Web Key (JWK), 5. JWK Set Format](https://datatracker.ietf.org/doc/html/rfc7517#section-5). - The JWK Set must not include private keys of the client application. - - If the client application requests encryption for ID tokens (from the authorization/token/userinfo endpoints) - and/or signs request objects, it must make available its JWK Set containing public keys for the - encryption and/or the signature at the URL of `jwksUri`. The service (Authlete) fetches the JWK - Set from the URL as necessary. - - [OpenID Connect Dynamic Client Registration 1.0](https://openid.net/specs/openid-connect-registration-1_0.html) - says that `jwks` must not be used when the client can use `jwks_uri`, but Authlete allows both - properties to be registered at the same time. However, Authlete does not use the content of `jwks` - when `jwksUri` is registered. - - This property corresponds to `jwks_uri` in [OpenID Connect Dynamic Client Registration 1.0, 2. - Client Metadata](https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata). - type: string - jwks: + The timestamp at which the access token was first created. + format: int64 + type: integer + lastRefreshedAt: description: | - The content of the JWK Set of the client application. - The format is described in - [JSON Web Key (JWK), 5. JWK Set Format](https://datatracker.ietf.org/doc/html/rfc7517#section-5). - The JWK Set must not include private keys of the client application. - - [OpenID Connect Dynamic Client Registration 1.0](https://openid.net/specs/openid-connect-registration-1_0.html) - says that `jwks` must not be used when the client can use `jwks_uri`, but Authlete allows both - properties to be registered at the same time. However, Authlete does not use the content of `jwks` - when `jwksUri` is registered. - - This property corresponds to `jwks_uri` in [OpenID Connect Dynamic Client Registration 1.0, 2. - Client Metadata](https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata). - type: string - userInfoSignAlg: - $ref: '#/components/schemas/jws_alg' - userInfoEncryptionAlg: - $ref: '#/components/schemas/jwe_alg' - userInfoEncryptionEnc: - $ref: '#/components/schemas/jwe_enc' - loginUri: + The timestamp at which the access token was last refreshed using the refresh token. + format: int64 + type: integer + clientId: description: | - The URL which a third party can use to initiate a login by the client application. - - This property corresponds to `initiate_login_uri` in - [OpenID Connect Dynamic Client Registration 1.0, 2. Client Metadata](https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata). - type: string - tosUri: + The ID of the client associated with the access token. + format: int64 + type: integer + subject: description: | - The URL pointing to the "Terms Of Service" page. - - This property corresponds to `tos_uri` in - [OpenID Connect Dynamic Client Registration 1.0, 2. Client Metadata](https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata). + The subject (= unique user ID) associated with the access token. type: string - tosUris: + grantType: + $ref: '#/components/schemas/grant_type' + scopes: description: | - URLs of "Terms Of Service" pages with language tags. - - If the client application has different "Terms Of Service" pages for different languages, - this property can be used to register the URLs. + The scopes associated with the access token. items: - $ref: '#/components/schemas/tagged_value' + type: string type: array - policyUri: + properties: description: | - The URL pointing to the page which describes the policy as to how end-user's profile data is used. - - This property corresponds to `policy_uri` in - [OpenID Connect Dynamic Client Registration 1.0, 2. Client Metadata](https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata). - type: string - policyUris: + The properties associated with the access token. + items: + $ref: '#/components/schemas/Property' + type: array + type: object + ApplicationType: + description: | + The application type. The value of this property affects the validation steps for a redirect URI. + See the description about `redirectUris` property for more details. + enum: + - WEB + - NATIVE + - null + nullable: true + type: string + AuthorizationDetails: + description: | + The authorization details. This represents the value of the `authorization_details` + request parameter in the preceding device authorization request which is defined in + "OAuth 2.0 Rich Authorization Requests". + example: + elements: + - dataTypes: + - dataTypes + - dataTypes + identifier: identifier + privileges: + - privileges + - privileges + locations: + - locations + - locations + type: type + otherFields: otherFields + actions: + - actions + - actions + - dataTypes: + - dataTypes + - dataTypes + identifier: identifier + privileges: + - privileges + - privileges + locations: + - locations + - locations + type: type + otherFields: otherFields + actions: + - actions + - actions + properties: + elements: description: | - URLs of policy pages with language tags. - If the client application has different policy pages for different languages, this property can be used to register the URLs. + Elements of this authorization details. items: - $ref: '#/components/schemas/tagged_value' + $ref: '#/components/schemas/authorization_details_element' type: array - clientUri: + type: object + AuthorizationDetailsElement: + example: + dataTypes: + - dataTypes + - dataTypes + identifier: identifier + privileges: + - privileges + - privileges + locations: + - locations + - locations + type: type + otherFields: otherFields + actions: + - actions + - actions + properties: + type: description: | - The URL pointing to the home page of the client application. + The type of this element. - This property corresponds to `client_uri` in - [OpenID Connect Dynamic Client Registration 1.0, 2. Client Metadata](https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata). + From _"OAuth 2.0 Rich Authorization Requests"_: _"The type of authorization data as a string. + This field MAY define which other elements are allowed in the request. This element is REQUIRED."_ + + This property is always NOT `null`. type: string - clientUris: + locations: description: | - Home page URLs with language tags. - If the client application has different home pages for different languages, this property can - be used to register the URLs. + The resources and/or resource servers. This property may be `null`. + + From _"OAuth 2.0 Rich Authorization Requests"_: _"An array of strings representing the location of + the resource or resource server. This is typically composed of URIs."_ + + This property may be `null`. items: - $ref: '#/components/schemas/tagged_value' + type: string type: array - bcDeliveryMode: + actions: description: | - The backchannel token delivery mode. + The actions. - This property corresponds to the `backchannel_token_delivery_mode` metadata. - The backchannel token delivery mode is defined in the specification of "CIBA (Client Initiated - Backchannel Authentication)". - type: string - bcNotificationEndpoint: - description: | - The backchannel client notification endpoint. + From _"OAuth 2.0 Rich Authorization Requests"_: _"An array of strings representing the kinds of actions + to be taken at the resource. The values of the strings are determined by the API being protected."_ - This property corresponds to the `backchannel_client_notification_endpoint` metadata. - The backchannel token delivery mode is defined in the specification of "CIBA (Client Initiated - Backchannel Authentication)". - type: string - bcRequestSignAlg: - $ref: '#/components/schemas/jws_alg' - bcUserCodeRequired: + This property may be `null`. + items: + type: string + type: array + dataTypes: description: | - The boolean flag to indicate whether a user code is required when this client makes a backchannel - authentication request. + From _"OAuth 2.0 Rich Authorization Requests"_: _"An array of strings representing the kinds of data being requested + from the resource."_ - This property corresponds to the `backchannel_user_code_parameter` metadata. - type: boolean - attributes: - description: | - The attributes of this client. + This property may be `null`. items: - $ref: '#/components/schemas/Pair' + type: string type: array - extension: - $ref: '#/components/schemas/client_extension' - authorizationDetailsTypes: + identifier: description: | - The authorization details types that this client may use as values of the `type` field in - `authorization_details`. + The identifier of a specific resource. + From _"OAuth 2.0 Rich Authorization Requests"_: _"A string identifier indicating a specific resource available at the API."_ - This property corresponds to the `authorization_details_types` metadata. See [OAuth 2.0 Rich - Authorization Requests (RAR)](https://datatracker.ietf.org/doc/draft-ietf-oauth-rar/) for details. + This property may be `null`. + type: string + privileges: + description: | + The types or levels of privilege. + From "OAuth 2.0 Rich Authorization Requests": _"An array of strings representing the types or + levels of privilege being requested at the resource."_ - Note that the property name was renamed from authorizationDataTypes to authorizationDetailsTypes - to align with the change made by the 5th draft of the RAR specification. + This property may be `null`. items: type: string type: array - customMetadata: + otherFields: description: | - The custom client metadata in JSON format. - - Standard specifications define client metadata as necessary. The following are such examples. - - * [OpenID Connect Dynamic Client Registration 1.0](https://openid.net/specs/openid-connect-registration-1_0.html) - * [RFC 7591 OAuth 2.0 Dynamic Client Registration Protocol](https://www.rfc-editor.org/rfc/rfc7591.html) - * [RFC 8705 OAuth 2.0 Mutual-TLS Client Authentication and Certificate-Bound Access Tokens](https://www.rfc-editor.org/rfc/rfc8705.html) - * [OpenID Connect Client-Initiated Backchannel Authentication Flow - Core 1.0](https://openid.net/specs/openid-client-initiated-backchannel-authentication-core-1_0.html) - * [The OAuth 2.0 Authorization Framework: JWT Secured Authorization Request (JAR)](https://datatracker.ietf.org/doc/draft-ietf-oauth-jwsreq/) - * [Financial-grade API: JWT Secured Authorization Response Mode for OAuth 2.0 (JARM)](https://openid.net/specs/openid-financial-api-jarm.html) - * [OAuth 2.0 Pushed Authorization Requests (PAR)](https://datatracker.ietf.org/doc/rfc9126/) - * [OAuth 2.0 Rich Authorization Requests (RAR)](https://datatracker.ietf.org/doc/draft-ietf-oauth-rar/) - - Standard client metadata included in Client Registration Request and Client Update Request (cf. - [OIDC DynReg](https://openid.net/specs/openid-connect-registration-1_0.html), [RFC 7591](https://www.rfc-editor.org/rfc/rfc7591.html) - and [RFC 7592](https://www.rfc-editor.org/rfc/rfc7592.html)) are, if supported by Authlete, set - to corresponding properties of the client application. For example, the value of the `client_name` - client metadata in Client Registration/Update Request is set to the clientName property. On the - other hand, unrecognized client metadata are discarded. - - By listing up custom client metadata in advance by using the `supportedCustomClientMetadata` property - of Service, Authlete can recognize them and stores their values into the database. The stored - custom client metadata values can be referenced by this property. - type: string - frontChannelRequestObjectEncryptionRequired: - description: | - The flag indicating whether encryption of request object is required when the request object - is passed through the front channel. - - This flag does not affect the processing of request objects at the Pushed Authorization Request - Endpoint, which is defined in [OAuth 2.0 Pushed Authorization Requests](https://datatracker.ietf.org/doc/rfc9126/). - Unecrypted request objects are accepted at the endpoint even if this flag is `true`. - - This flag does not indicate whether a request object is always required. There is a different - flag, `requestObjectRequired`, for the purpose. - - Even if this flag is `false`, encryption of request object is required if the `frontChannelRequestObjectEncryptionRequired` - flag of the service is `true`. - type: boolean - requestObjectEncryptionAlgMatchRequired: - description: | - The flag indicating whether the JWE alg of encrypted request object must match the `request_object_encryption_alg` - client metadata. - - The `request_object_encryption_alg` client metadata itself is defined in [OpenID Connect Dynamic - Client Registration 1.0](https://openid.net/specs/openid-connect-registration-1_0.html) as follows. - - > request_object_encryption_alg - > - > OPTIONAL. JWE [JWE] alg algorithm [JWA] the RP is declaring that it may use for encrypting Request - Objects sent to the OP. This parameter SHOULD be included when symmetric encryption will be used, - since this signals to the OP that a client_secret value needs to be returned from which the - symmetric key will be derived, that might not otherwise be returned. The RP MAY still use other - supported encryption algorithms or send unencrypted Request Objects, even when this parameter - is present. If both signing and encryption are requested, the Request Object will be signed - then encrypted, with the result being a Nested JWT, as defined in [JWT]. The default, if omitted, - is that the RP is not declaring whether it might encrypt any Request Objects. - - The point here is "The RP MAY still use other supported encryption algorithms or send unencrypted - Request Objects, even when this parameter is present." - - The property that represents the client metadata is `requestEncryptionAlg`. See the description - of `requestEncryptionAlg` for details. - - Even if this flag is `false`, the match is required if the `requestObjectEncryptionAlgMatchRequired` - flag of the service is `true`. - type: boolean - requestObjectEncryptionEncMatchRequired: - description: | - The flag indicating whether the JWE enc of encrypted request object must match the `request_object_encryption_enc` - client metadata. - - The `request_object_encryption_enc` client metadata itself is defined in [OpenID Connect Dynamic - Client Registration 1.0](https://openid.net/specs/openid-connect-registration-1_0.html) as follows. - - > request_object_encryption_enc - > - > OPTIONAL. JWE enc algorithm [JWA] the RP is declaring that it may use for encrypting Request - Objects sent to the OP. If request_object_encryption_alg is specified, the default for this - value is A128CBC-HS256. When request_object_encryption_enc is included, request_object_encryption_alg - MUST also be provided. - - The property that represents the client metadata is `requestEncryptionEnc`. See the description - of `requestEncryptionEnc` for details. - - Even if this flag is `false`, the match is required if the `requestObjectEncryptionEncMatchRequired` - flag of the service is `true`. - type: boolean - digestAlgorithm: - description: | - The digest algorithm that this client requests the server to use - when it computes digest values of external attachments, which may be referenced from within ID tokens - or userinfo responses (or any place that can have the `verified_claims` claim). - - Possible values are listed in the Hash Algorithm Registry of IANA (Internet Assigned Numbers Authority), - but the server does not necessarily support all the values there. When - this property is omitted, `sha-256` is used as the default algorithm. - - This property corresponds to the `digest_algorithm` client metadata - which was defined by the third implementer's draft of - [OpenID Connect for Identity Assurance 1.0](https://openid.net/specs/openid-connect-4-identity-assurance-1_0.html). + The RAR request in the JSON format excluding the pre-defined attributes such as `type` and `locations`. + The content and semantics are specific to the deployment and the use case implemented. type: string - singleAccessTokenPerSubject: - description: | - If `Enabled` is selected, an attempt to issue a new access token invalidates existing access tokens that are associated with the same combination of subject and client. - - Note that, however, attempts by Client Credentials Flow do not invalidate existing access tokens because access tokens issued by Client Credentials Flow are not associated with any end-user's subject. - - Even if `Disabled` is selected here, single access token per subject is effective if `singleAccessTokenPerSubject` of the `Service` this client belongs to is Enabled. - type: boolean - pkceRequired: + required: + - type + type: object + ClaimType: + enum: + - NORMAL + - AGGREGATED + - DISTRIBUTED + type: string + ClientAuthenticationMethod: + description: | + The client authentication method that the client application declares that it uses at the token + endpoint. This property corresponds to `token_endpoint_auth_method` in [OpenID Connect Dynamic + Client Registration 1.0, 2. Client Metadata](https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata). + enum: + - NONE + - CLIENT_SECRET_BASIC + - CLIENT_SECRET_POST + - CLIENT_SECRET_JWT + - PRIVATE_KEY_JWT + - TLS_CLIENT_AUTH + - SELF_SIGNED_TLS_CLIENT_AUTH + type: string + ClientExtension: + example: + refreshTokenDuration: 9 + requestableScopes: + - requestableScopes + - requestableScopes + tokenExchangePermitted: true + requestableScopesEnabled: true + accessTokenDuration: 7 + properties: + requestableScopes: description: | - The flag to indicate whether the use of Proof Key for Code Exchange (PKCE) is always required for authorization requests by Authorization Code Flow. - - If `true`, `code_challenge` request parameter is always required for authorization requests using Authorization Code Flow. + The set of scopes that the client application is allowed to request. This paramter will be one + of the following. - See [RFC 7636](https://tools.ietf.org/html/rfc7636) (Proof Key for Code Exchange by OAuth Public Clients) for details about `code_challenge` request parameter. - type: boolean - pkceS256Required: - description: | - The flag to indicate whether `S256` is always required as the code challenge method whenever [PKCE (RFC 7636)](https://tools.ietf.org/html/rfc7636) is used. + - `null` + - an empty set + - a set with at least one element - If this flag is set to `true`, `code_challenge_method=S256` must be included in the authorization request - whenever it includes the `code_challenge` request parameter. - Neither omission of the `code_challenge_method` request parameter nor use of plain (`code_challenge_method=plain`) is allowed. - type: boolean - dpopRequired: - description: | - If the DPoP is required for this client - type: boolean - automaticallyRegistered: - description: | - The flag indicating whether this client was registered by the - "automatic" client registration of OIDC Federation. - type: boolean - explicitlyRegistered: - description: | - The flag indicating whether this client was registered by the - "explicit" client registration of OIDC Federation. - type: boolean - rsRequestSigned: - description: | - The flag indicating whether this service signs responses from the resource server. - type: boolean - rsSignedRequestKeyId: - description: | - Get the key ID of a JWK containing the public key used by this client to sign requests to the resource server. - type: string - clientRegistrationTypes: - description: | - Get the client registration types that the client has declared it may use. + When the value of this parameter is `null`, it means that the set of scopes that the client + application is allowed to request is the set of the scopes that the service supports. When the + value of this parameter is an empty set, it means that the client application is not allowed to + request any scopes. When the value of this parameter is a set with at least one element, it means + that the set is the set of scopes that the client application is allowed to request. items: - $ref: '#/components/schemas/client_registration_type' + type: string type: array - organizationName: - description: "Get the human-readable name representing the organization\ - \ that manages this client. This property corresponds \nto the organization_name\ - \ client metadata that is defined in OpenID Connect Federation 1.0.\n" - type: string - signedJwksUri: - description: "Get the URI of the endpoint that returns this client's JWK\ - \ Set document in the JWT format. This property \ncorresponds to the `signed_jwks_uri`\ - \ client metadata defined in OpenID Connect Federation 1.0.\n" - type: string - entityId: + requestableScopesEnabled: description: | - the entity ID of this client. - type: string - trustAnchorId: - description: "The entity ID of the trust anchor of the trust chain that\ - \ was used when this client was registered or updated by \nthe mechanism\ - \ defined in OpenID Connect Federation 1.0\n" - type: string - trustChain: + The flag to indicate whether "Requestable Scopes per Client" is enabled or not. If `true`, you + can define the set of scopes which this client application can request. If `false`, this client + application can request any scope which is supported by the authorization server. + type: boolean + accessTokenDuration: description: | - The trust chain that was used when this client was registered or updated by the mechanism defined in - OpenID Connect Federation 1.0 - items: - type: string - type: array - trustChainExpiresAt: - description: "the expiration time of the trust chain that was used when\ - \ this client was registered or updated by the mechanism \ndefined in\ - \ OpenID Connect Federation 1.0. The value is represented as milliseconds\ - \ elapsed since the Unix epoch (1970-01-01).\n" + The value of the duration of access tokens per client in seconds. In normal cases, the value of + the service's `accessTokenDuration` property is used as the duration of access tokens issued by + the service. However, if this `accessTokenDuration` property holds a non-zero positive number + and its value is less than the duration configured by the service, the value is used as the duration + of access tokens issued to the client application. + + Note that the duration of access tokens can be controlled by the scope attribute `access_token.duration`, + too. Authlete chooses the minimum value among the candidates. format: int64 type: integer - trustChainUpdatedAt: + refreshTokenDuration: description: | - the time at which the trust chain was updated by the mechanism defined in OpenID Connect Federation 1.0 + The value of the duration of refresh tokens per client in seconds. In normal cases, the value + of the service's `refreshTokenDuration` property is used as the duration of refresh tokens issued + by the service. However, if this `refreshTokenDuration` property holds a non-zero positive number + and its value is less than the duration configured by the service, the value is used as the duration + of refresh tokens issued to the client application. + + Note that the duration of refresh tokens can be controlled by the scope attribute `refresh_token.duration`, + too. Authlete chooses the minimum value among the candidates. format: int64 type: integer - locked: - description: The flag which indicates whether this client is locked. + tokenExchangePermitted: + description: |- + Get the flag indicating whether the client is explicitly given a + permission to make token exchange requests ([RFC 8693][https://www.rfc-editor.org/rfc/rfc8693.html]) type: boolean type: object - DeliveryMode: - enum: - - PING - - POLL - - PUSH - type: string - Display: - description: | - The display mode which the client application requests by `display` request parameter. - When the authorization request does not have `display` request parameter, `PAGE` is set as the default value. - - It is ensured that the value of `display` is one of the supported display modes which are specified - by `supportedDisplays` configuration parameter of the service. If the display mode specified by the - authorization request is not supported, an error is raised. - - Values for this property correspond to the values listed in - "[OpenID Connect Core 1.0, 3.1.2.1. Authentication Request](https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest), display". - enum: - - PAGE - - POPUP - - TOUCH - - WAP - type: string - DynamicScope: - example: - name: name - value: value - properties: - name: - description: The scope name. - type: string - value: - description: The scope value. - type: string - type: object - GrantType: - description: | - The grant type of the access token when the access token was created. - enum: - - AUTHORIZATION_CODE - - IMPLICIT - - PASSWORD - - CLIENT_CREDENTIALS - - REFRESH_TOKEN - - CIBA - - DEVICE_CODE - - TOKEN_EXCHANGE - - JWT_BEARER - type: string - JweAlg: - description: | - this is the 'alg' header value for encrypted JWT tokens. - Depending upon the context, this refers to key transport scheme to be used by the client and by the server. For instance: - - as `authorizationEncryptionAlg` value, it refers to the encoding algorithm used by server for transporting they keys on JARM objects - - as `requestEncryptionAlg` value, it refers to the expected key transport encoding algorithm that server expect from client when encrypting a Request Object - - as `idTokenEncryptionAlg` value, it refers to the algorithm used by the server to key transport of id_tokens - - **Please note that some of the algorithms are more secure than others, some are not supported very well cross platforms and some (like RSA1_5) is known to be weak**. - enum: - - RSA1_5 - - RSA_OAEP - - RSA_OAEP_256 - - A128KW - - A192KW - - A256KW - - DIR - - ECDH_ES - - ECDH_ES_A128KW - - ECDH_ES_A192KW - - ECDH_ES_A256KW - - A128GCMKW - - A192GCMKW - - A256GCMKW - - PBES2_HS256_A128KW - - PBES2_HS384_A192KW - - PBES2_HS512_A256KW - type: string - JweEnc: - description: | - This is the encryption algorithm to be used when encrypting a JWT on client or server side. - Depending upon the context, this refers to encryption done by the client or by the server. For instance: - - as `authorizationEncryptionEnc` value, it refers to the encryption algorithm used by server when creating a JARM response - - as `requestEncryptionEnc` value, it refers to the expected encryption algorithm used by the client when encrypting a Request Object - - as `idTokenEncryptionEnc` value, it refers to the algorithm used by the server to encrypt id_tokens - enum: - - A128CBC_HS256 - - A192CBC_HS384 - - A256CBC_HS512 - - A128GCM - - A192GCM - - A256GCM - type: string - JwsAlg: - description: | - The signature algorithm for JWT. This value is represented on 'alg' attribute - of the header of JWT. - - it's semantics depends upon where is this defined, for instance: - - as service accessTokenSignAlg value, it defines that access token are JWT and the algorithm used to sign it. Check your [KB article](https://kb.authlete.com/en/s/oauth-and-openid-connect/a/jwt-based-access-token). - - as client authorizationSignAlg value, it represents the signature algorithm used when [creating a JARM response](https://kb.authlete.com/en/s/oauth-and-openid-connect/a/enabling-jarm). - - or as client requestSignAlg value, it specifies which is the expected signature used by [client on a Request Object](https://kb.authlete.com/en/s/oauth-and-openid-connect/a/request-objects). - enum: - - NONE - - HS256 - - HS384 - - HS512 - - RS256 - - RS384 - - RS512 - - ES256 - - ES384 - - ES512 - - PS256 - - PS384 - - PS512 - - ES256K - - EdDSA - type: string - NamedUri: - example: - name: name - uri: https://openapi-generator.tech - properties: - name: - type: string - uri: - format: uri - type: string - type: object - Pair: - example: - value: value - key: key - properties: - key: - description: The key part. - type: string - value: - description: The value part. - type: string - type: object - Prompt: - description: | - The prompt that the UI displayed to the end-user must satisfy as the minimum level. This value comes from `prompt` request parameter. - - When the authorization request does not contain `prompt` request parameter, `CONSENT` is used as the default value. - - See "[OpenID Connect Core 1.0, 3.1.2.1. Authentication Request](https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest), prompt" for `prompt` request parameter. - enum: - - NONE - - LOGIN - - CONSENT - - SELECT_ACCOUNT - type: string - Property: - example: - hidden: true - value: value - key: key - properties: - key: - description: The key part. - type: string - value: - description: The value part. - type: string - hidden: - description: |- - The flag to indicate whether this property hidden from or visible to client applications. - If `true`, this property is hidden from client applications. Otherwise, this property is visible to client applications. - type: boolean - type: object - ResponseType: - enum: - - NONE - - CODE - - TOKEN - - ID_TOKEN - - CODE_TOKEN - - CODE_ID_TOKEN - - ID_TOKEN_TOKEN - - CODE_ID_TOKEN_TOKEN - type: string - Scope: + Client: example: - name: name - description: description - attributes: - - value: value - key: key - - value: value - key: key - defaultEntry: true - descriptions: + serviceNumber: 6 + applicationType: null + bcNotificationEndpoint: bcNotificationEndpoint + tlsClientAuthSanEmail: tlsClientAuthSanEmail + modifiedAt: 5 + logoUris: - tag: tag value: value - tag: tag value: value - properties: - name: - description: The name of the scope. - type: string - defaultEntry: - description: '`true` to mark the scope as default. Scopes marked as default - are regarded as requested when an authorization request from a client - application does not contain scope request parameter. ' - type: boolean - description: - description: The description about the scope. - type: string - descriptions: - description: The descriptions about this scope in multiple languages. - items: - $ref: '#/components/schemas/tagged_value' - type: array - attributes: - description: The attributes of the scope. - items: - $ref: '#/components/schemas/Pair' - type: array - type: object - ServiceProfile: - enum: - - FAPI - - OPEN_BANKING - type: string - Service: - example: - metadata: - - value: value - key: key - - value: value - key: key - predefinedTransformedClaims: predefinedTransformedClaims - apiKey: 1 - supportedScopes: - - name: name - description: description - attributes: - - value: value - key: key - - value: value - key: key - defaultEntry: true - descriptions: - - tag: tag - value: value - - tag: tag - value: value - - name: name - description: description - attributes: - - value: value - key: key - - value: value - key: key - defaultEntry: true - descriptions: - - tag: tag - value: value - - tag: tag - value: value - idTokenSignatureKeyId: idTokenSignatureKeyId singleAccessTokenPerSubject: true + dpopRequired: true signedJwksUri: signedJwksUri - issuer: issuer - dynamicRegistrationSupported: true - number: 0 - supportedServiceProfiles: - - null - - null - authorizationResponseDuration: 7 - refreshTokenIdempotent: true - supportedDocumentsCheckMethods: - - supportedDocumentsCheckMethods - - supportedDocumentsCheckMethods - supportedClaims: - - supportedClaims - - supportedClaims - registrationManagementEndpoint: https://openapi-generator.tech - accessTokenForExternalAttachmentEmbedded: true - missingClientIdAllowed: true - userCodeLength: 7 - deviceFlowPollingInterval: 6 - developerSnsCredentials: - - apiKey: apiKey - sns: sns - apiSecret: apiSecret - - apiKey: apiKey - sns: sns - apiSecret: apiSecret - deviceFlowCodeDuration: 1 - supportedTrustFrameworks: - - supportedTrustFrameworks - - supportedTrustFrameworks - developerAuthenticationCallbackApiKey: developerAuthenticationCallbackApiKey - deviceVerificationUriComplete: https://openapi-generator.tech - refreshTokenKept: true - authenticationCallbackEndpoint: https://openapi-generator.tech - apiSecret: apiSecret - developerAuthenticationCallbackApiSecret: developerAuthenticationCallbackApiSecret - accessTokenDuration: 3 - federationSignatureKeyId: federationSignatureKeyId - backchannelUserCodeParameterSupported: true - supportedVerifiedClaims: - - supportedVerifiedClaims - - supportedVerifiedClaims - clientsPerDeveloper: 5 - unauthorizedOnClientConfigSupported: true - supportedDigestAlgorithms: - - supportedDigestAlgorithms - - supportedDigestAlgorithms - snsCredentials: - - apiKey: apiKey - sns: sns - apiSecret: apiSecret - - apiKey: apiKey - sns: sns - apiSecret: apiSecret - directRevocationEndpointEnabled: true - federationJwks: federationJwks - grantManagementActionRequired: true - requestObjectAudienceChecked: true - supportedDocuments: - - supportedDocuments - - supportedDocuments + descriptions: + - tag: tag + value: value + - tag: tag + value: value + subjectType: null + clientNames: + - tag: tag + value: value + - tag: tag + value: value + number: 0 + createdAt: 5 + automaticallyRegistered: true + clientType: null + tlsClientCertificateBoundAccessTokens: true + bcDeliveryMode: bcDeliveryMode + idTokenEncryptionEnc: null + clientSecret: clientSecret + selfSignedCertificateKeyId: selfSignedCertificateKeyId + idTokenSignAlg: null + locked: true + responseModes: + - QUERY + - QUERY + clientUri: clientUri + trustChain: + - trustChain + - trustChain + tlsClientAuthSanDns: tlsClientAuthSanDns + organizationName: organizationName + tlsClientAuthSanIp: tlsClientAuthSanIp + policyUris: + - tag: tag + value: value + - tag: tag + value: value + parRequired: true + derivedSectorIdentifier: derivedSectorIdentifier + logoUri: logoUri + requestObjectEncryptionEncMatchRequired: true + redirectUris: + - redirectUris + - redirectUris + requestEncryptionAlg: null + defaultAcrs: + - defaultAcrs + - defaultAcrs + requestObjectEncryptionAlgMatchRequired: true + trustChainExpiresAt: 3 + grantTypes: + - null + - null + authorizationEncryptionEnc: null + pkceS256Required: true + tlsClientAuthSubjectDn: tlsClientAuthSubjectDn + rsRequestSigned: true + tosUri: tosUri + requestUris: + - requestUris + - requestUris + explicitlyRegistered: true + softwareVersion: softwareVersion + authorizationSignAlg: null + registrationAccessTokenHash: registrationAccessTokenHash + extension: + refreshTokenDuration: 9 + requestableScopes: + - requestableScopes + - requestableScopes + tokenExchangePermitted: true + requestableScopesEnabled: true + accessTokenDuration: 7 jwks: jwks - tokenExpirationLinked: true - supportedCustomClientMetadata: - - supportedCustomClientMetadata - - supportedCustomClientMetadata - directAuthorizationEndpointEnabled: true - pushedAuthReqEndpoint: https://openapi-generator.tech - developerAuthenticationCallbackEndpoint: https://openapi-generator.tech - tokenEndpoint: https://openapi-generator.tech - supportedIntrospectionAuthMethods: + clientUris: + - tag: tag + value: value + - tag: tag + value: value + clientName: clientName + requestSignAlg: null + tosUris: + - tag: tag + value: value + - tag: tag + value: value + description: description + jwksUri: jwksUri + authorizationDetailsTypes: + - authorizationDetailsTypes + - authorizationDetailsTypes + userInfoEncryptionEnc: null + clientIdAlias: clientIdAlias + authorizationEncryptionAlg: null + clientRegistrationTypes: - null - null - supportedClaimTypes: + loginUri: loginUri + userInfoSignAlg: null + policyUri: policyUri + customMetadata: customMetadata + tokenAuthSignAlg: null + authTimeRequired: true + idTokenEncryptionAlg: null + clientIdAliasEnabled: true + bcUserCodeRequired: true + tokenAuthMethod: null + defaultMaxAge: 2 + trustAnchorId: trustAnchorId + responseTypes: - null - null - mutualTlsValidatePkiCertChain: true - scopeRequired: true - policyUri: https://openapi-generator.tech - supportedDocumentsVerificationMethods: - - supportedDocumentsVerificationMethods - - supportedDocumentsVerificationMethods - verifiedClaimsValidationSchemaSet: verifiedClaimsValidationSchemaSet - userInfoEndpoint: https://openapi-generator.tech - dcrScopeUsedAsRequestable: true - idTokenAudType: idTokenAudType - registrationEndpoint: https://openapi-generator.tech - supportedElectronicRecords: - - supportedElectronicRecords - - supportedElectronicRecords - deviceVerificationUri: https://openapi-generator.tech - authenticationCallbackApiSecret: authenticationCallbackApiSecret + sectorIdentifierUri: sectorIdentifierUri + clientId: 1 + credentialOfferEndpoint: credentialOfferEndpoint + credentialResponseEncryptionRequired: true + dynamicallyRegistered: true requestObjectRequired: true - backchannelAuthenticationEndpoint: https://openapi-generator.tech - serviceOwnerNumber: 6 - authorizationSignatureKeyId: authorizationSignatureKeyId - endSessionEndpoint: https://openapi-generator.tech - grantManagementEndpoint: grantManagementEndpoint - supportedUiLocales: - - supportedUiLocales - - supportedUiLocales - nbfOptional: true + digestAlgorithm: digestAlgorithm + entityId: entityId + requestEncryptionEnc: null + tlsClientAuthSanUri: tlsClientAuthSanUri + frontChannelRequestObjectEncryptionRequired: true + fapiModes: + - null + - null + softwareId: softwareId + trustChainUpdatedAt: 2 + userInfoEncryptionAlg: null attributes: - value: value key: key - value: value key: key - traditionalRequestObjectProcessingApplied: true - backchannelBindingMessageRequiredInFapi: true + rsSignedRequestKeyId: rsSignedRequestKeyId + bcRequestSignAlg: null pkceRequired: true - claimShortcutRestrictive: true - directIntrospectionEndpointEnabled: true - dcrDuplicateSoftwareIdBlocked: true - hsks: - - kty: kty - use: use - kid: kid - hsmName: hsmName - handle: handle - publicKey: publicKey - - kty: kty - use: use - kid: kid - hsmName: hsmName - handle: handle - publicKey: publicKey - jwtGrantByIdentifiableClientsOnly: true - modifiedAt: 2 - introspectionEndpoint: https://openapi-generator.tech - supportedBackchannelTokenDeliveryModes: - - null - - null - accessTokenType: accessTokenType - refreshTokenDurationReset: true - federationRegistrationEndpoint: federationRegistrationEndpoint - createdAt: 5 - supportedClientRegistrationTypes: - - null - - null - loopbackRedirectionUriVariable: true - tlsClientCertificateBoundAccessTokens: true - userCodeCharset: null - issSuppressed: true - federationConfigurationDuration: 1 - supportedVerificationMethods: - - supportedVerificationMethods - - supportedVerificationMethods - trustAnchors: - - jwks: jwks - entityId: entityId - - jwks: jwks - entityId: entityId - serviceDocumentation: https://openapi-generator.tech - revocationEndpoint: https://openapi-generator.tech - hsmEnabled: true - organizationName: organizationName - supportedDisplays: - - null - - null - parRequired: true - errorDescriptionOmitted: true - refreshTokenDurationKept: true - resourceSignatureKeyId: resourceSignatureKeyId - requestObjectEncryptionEncMatchRequired: true - jwtGrantEncryptedJwtRejected: true - trustedRootCertificates: - - trustedRootCertificates - - trustedRootCertificates - authorizationEndpoint: https://openapi-generator.tech - supportedDocumentsValidationMethods: - - supportedDocumentsValidationMethods - - supportedDocumentsValidationMethods - rsResponseSigned: true - supportedClaimLocales: - - supportedClaimLocales - - supportedClaimLocales - requestObjectEncryptionAlgMatchRequired: true - pkceS256Required: true - tokenExchangeUnsignedJwtRejected: true - tosUri: https://openapi-generator.tech - authorityHints: - - authorityHints - - authorityHints - supportedAttachments: - - null - - null - userInfoSignatureKeyId: userInfoSignatureKeyId - directUserInfoEndpointEnabled: true - supportedDocumentsMethods: - - supportedDocumentsMethods - - supportedDocumentsMethods - accessTokenSignatureKeyId: accessTokenSignatureKeyId - jwtGrantUnsignedJwtRejected: true - directTokenEndpointEnabled: true - mtlsEndpointAliases: - - name: name - uri: https://openapi-generator.tech - - name: name - uri: https://openapi-generator.tech - tokenExchangeByIdentifiableClientsOnly: true - description: description - jwksUri: https://openapi-generator.tech - pushedAuthReqDuration: 9 - supportedEvidence: - - supportedEvidence - - supportedEvidence - supportedAcrs: - - supportedAcrs - - supportedAcrs - errorUriOmitted: true - directJwksEndpointEnabled: true - supportedIdentityDocuments: - - supportedIdentityDocuments - - supportedIdentityDocuments - idTokenReissuable: true - tokenExchangeByConfidentialClientsOnly: true - supportedResponseTypes: - - null - - null - clientIdAliasEnabled: true - supportedTokenAuthMethods: - - null - - null - allowableClockSkew: 7 - deviceAuthorizationEndpoint: https://openapi-generator.tech - backchannelAuthReqIdDuration: 1 - tokenExchangeByPermittedClientsOnly: true - tokenExchangeEncryptedJwtRejected: true - supportedGrantTypes: - - null - - null - supportedAuthorizationDetailsTypes: - - supportedAuthorizationDetailsTypes - - supportedAuthorizationDetailsTypes - backchannelPollingInterval: 1 - serviceName: serviceName - accessTokenSignAlg: null - idTokenDuration: 4 - authenticationCallbackApiKey: authenticationCallbackApiKey - openidDroppedOnRefreshWithoutOfflineAccess: true - frontChannelRequestObjectEncryptionRequired: true - federationEnabled: true - refreshTokenDuration: 2 - supportedRevocationAuthMethods: - - null - - null - supportedSnses: - - null - - null - supportedDeveloperSnses: - - null - - null + contacts: + - contacts + - contacts properties: number: - description: The sequential number of the service. The value of this property - is assigned by Authlete. + description: | + The sequential number of the client. The value of this property is assigned by Authlete. format: int32 readOnly: true type: integer - serviceOwnerNumber: - description: The sequential number of the service owner of the service. - The value of this property is assigned by Authlete. + serviceNumber: + description: | + The sequential number of the service of the client application. The value of this property is + assigned by Authlete. format: int32 readOnly: true type: integer - serviceName: - description: The name of this service. - type: string - issuer: + clientName: description: | - The issuer identifier of the service. - - A URL that starts with https:// and has no query or fragment component. - - The value of this property is used as `iss` claim in an [ID token](https://openid.net/specs/openid-connect-core-1_0.html#IDToken) - and `issuer` property in the [OpenID Provider Metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). + The name of the client application. This property corresponds to `client_name` in + [OpenID Connect Dynamic Client Registration 1.0, 2. Client Metadata](https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata). type: string + clientNames: + description: | + Client names with language tags. If the client application has different names for different + languages, this property can be used to register the names. + items: + $ref: '#/components/schemas/tagged_value' + type: array description: - description: The description about the service. - type: string - apiKey: - description: The API key. The value of this property is assigned by Authlete. - format: int64 - readOnly: true - type: integer - apiSecret: - description: The API secret. A random 256-bit value encoded by base64url - (43 letters). The value of this property is assigned by Authlete. - readOnly: true + description: The description about the client application. type: string - clientsPerDeveloper: - description: The maximum number of client applications that a developer - is allowed to create. `0` means no limit. - format: int32 - readOnly: true - type: integer - clientIdAliasEnabled: - description: | - The flag to indicate whether the 'Client ID Alias' feature is enabled or not. - When a new client is created, Authlete generates a numeric value and assigns it as a client ID to the newly created client. In addition to the client ID, each client can have a client ID alias. The client ID alias is, however, recognized only when this property (`clientIdAliasEnabled`) is set to `true`. - type: boolean - metadata: + descriptions: description: | - The `metadata` of the service. The content of the returned array depends on contexts. - The predefined service metadata is listed in the following table. - - | Key | Description | - | --- | --- | - | `clientCount` | The number of client applications which belong to this service. | + Descriptions about the client application with language tags. If the client application has different + descriptions for different languages, this property can be used to register the descriptions. items: - $ref: '#/components/schemas/Pair' + $ref: '#/components/schemas/tagged_value' type: array - createdAt: - description: | - The time at which this service was created. The value is represented as milliseconds since the - UNIX epoch (`1970-01-01`). - format: int64 - readOnly: true - type: integer - modifiedAt: - description: | - The time at which this service was last modified. The value is represented as milliseconds since - the UNIX epoch (1970-01-01). + clientId: + description: The client identifier used in Authlete API calls. The value + of this property is assigned by Authlete. format: int64 readOnly: true type: integer - authenticationCallbackEndpoint: + clientSecret: description: | - A Web API endpoint for user authentication which is to be prepared on the service side. + The client secret. A random 512-bit value encoded by base64url (86 letters). The value of this + property is assigned by Authlete. - The endpoint must be implemented if you do not implement the UI at the authorization endpoint - but use the one provided by Authlete. + Note that Authlete issues a client secret even to a "public" client application, but the client + application should not use the client secret unless it changes its client type to "confidential". + That is, a public client application should behave as if it had not been issued a client secret. + To be specific, a token request from a public client of Authlete should not come along with a + client secret although [RFC 6749, 3.2.1. Client Authentication](https://datatracker.ietf.org/doc/html/rfc6749#section-3.2.1) + says as follows. - The user authentication at the authorization endpoint provided by Authlete is performed by making - a `POST` request to this endpoint. - format: uri + > Confidential clients or other clients issued client credentials MUST authenticate with the + authorization server as described in Section 2.3 when making requests to the token endpoint. + readOnly: true type: string - authenticationCallbackApiKey: + clientIdAlias: description: | - API key for basic authentication at the authentication callback endpoint. - - If the value is not empty, Authlete generates Authorization header for Basic authentication when - making a request to the authentication callback endpoint. - type: string - authenticationCallbackApiSecret: - description: API secret for `basic` authentication at the authentication - callback endpoint. + The value of the client's `client_id` property used in OAuth and OpenID Connect calls. By + default, this is a string version of the `clientId` property. type: string - supportedSnses: + clientIdAliasEnabled: + description: Deprecated. Always set to `true`. + type: boolean + clientType: + $ref: '#/components/schemas/client_type' + applicationType: + $ref: '#/components/schemas/application_type' + logoUri: description: | - SNSes you want to support 'social login' in the UI at the - authorization endpoint provided by Authlete. + The URL pointing to the logo image of the client application. - You need to register a `client` application in each SNS that is set - as this parameter and set Authlete server's `/api/sns/redirection` - as the redirection endpoint of the client application. - items: - $ref: '#/components/schemas/Sns' - type: array - snsCredentials: + This property corresponds to `logo_uri` in [OpenID Connect Dynamic Client Registration 1.0, 2. + Client Metadata](https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata). + type: string + logoUris: description: | - `SNS` credentials which Authlete uses to make requests to SNSes. The format is JSON. + Logo image URLs with language tags. If the client application has different logo images for + different languages, this property can be used to register URLs of the images. items: - $ref: '#/components/schemas/sns_credentials' + $ref: '#/components/schemas/tagged_value' type: array - supportedAcrs: + contacts: description: | - Values of acrs (authentication context class references) that the service supports. + An array of email addresses of people responsible for the client application. - The value of this property is used as `acr_values_supported` - property in the [OpenID Provider Metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). + This property corresponds to contacts in [OpenID Connect Dynamic Client Registration 1.0, 2. Client + Metadata](https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata). items: type: string - readOnly: true type: array - developerAuthenticationCallbackEndpoint: + tlsClientCertificateBoundAccessTokens: description: | - A Web API endpoint for developer authentication which is to be prepared on the server side. - - The endpoint must be implemented if you use Developer Console. + The flag to indicate whether this client use TLS client certificate bound access tokens. + type: boolean + dynamicallyRegistered: + description: | + The flag to indicate whether this client has been registered dynamically. + For more details, see [RFC 7591](https://datatracker.ietf.org/doc/html/rfc7591). + readOnly: true + type: boolean + softwareId: + description: | + The unique identifier string assigned by the client developer or software publisher used by + registration endpoints to identify the client software to be dynamically registered. - The developer authentication at the login page of Developer Console is performed by making a `POST` - request to this endpoint. - format: uri + This property corresponds to the `software_id metadata` defined in [2. Client Metadata](https://datatracker.ietf.org/doc/html/rfc7591#section-2) + of [RFC 7591](https://datatracker.ietf.org/doc/html/rfc7591). type: string - developerAuthenticationCallbackApiKey: + softwareVersion: description: | - API key for basic authentication at the developer authentication callback endpoint. + The version identifier string for the client software identified by the software ID. - If the value is not empty, Authlete generates Authorization header for Basic authentication when - making a request to the developer authentication callback endpoint. - type: string - developerAuthenticationCallbackApiSecret: - description: API secret for basic authentication at the developer authentication - callback endpoint. + This property corresponds to the software_version metadata defined in [2. Client Metadata](https://datatracker.ietf.org/doc/html/rfc7591#section-2) + of [RFC 7591](https://datatracker.ietf.org/doc/html/rfc7591). type: string - supportedDeveloperSnses: + registrationAccessTokenHash: description: | - SNSes you want to support 'social login' in the login page of Developer Console provided by Authlete. - - You need to register a client application in each SNS checked here and set Authlete server's - `/api/developer/sns/redirection` as the redirection endpoint of the client application. - items: - $ref: '#/components/schemas/Sns' - type: array - developerSnsCredentials: - description: SNS credentials which Authlete uses to make requests to SNSes. - The format is JSON. - items: - $ref: '#/components/schemas/sns_credentials' - type: array - supportedGrantTypes: + The hash of the registration access token for this client. + type: string + createdAt: + description: The time at which this client was created. The value is represented + as milliseconds since the UNIX epoch (1970-01-01). + format: int64 + readOnly: true + type: integer + modifiedAt: + description: The time at which this client was last modified. The value + is represented as milliseconds since the UNIX epoch (1970-01-01). + format: int64 + readOnly: true + type: integer + grantTypes: description: | - Values of `grant_type` request parameter that the service supports. - - The value of this property is used as `grant_types_supported property` in the - [OpenID Provider Metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). + A string array of grant types which the client application declares that it will restrict itself to using. + This property corresponds to `grant_types` in [OpenID Connect Dynamic Client Registration 1.0, + 2. Client Metadata](https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata). items: $ref: '#/components/schemas/grant_type' type: array - supportedResponseTypes: + responseTypes: description: | - Values of `response_type` request parameter that - the service supports. Valid values are listed in Response Type. - - The value of this property is used as `response_types_supported` property in the - [OpenID Provider Metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). + A string array of response types which the client application declares that it will restrict itself to using. + This property corresponds to `response_types` in [OpenID Connect Dynamic Client Registration 1.0, + 2. Client Metadata](https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata). items: $ref: '#/components/schemas/response_type' type: array - supportedAuthorizationDetailsTypes: + redirectUris: description: | - The supported data types that can be used as values of the type field in `authorization_details`. + Redirect URIs that the client application uses to receive a response from the authorization endpoint. + Requirements for a redirect URI are as follows. - This property corresponds to the `authorization_details_types_supported` metadata. See "OAuth 2.0 - Rich Authorization Requests" (RAR) for details. - items: - type: string - type: array - supportedServiceProfiles: - description: | - The profiles that this service supports. - items: - $ref: '#/components/schemas/service_profile' - type: array - errorDescriptionOmitted: - description: | - The flag to indicate whether the `error_description` response parameter is omitted. + **Requirements by RFC 6749** (From [RFC 6749, 3.1.2. Redirection Endpoint](https://datatracker.ietf.org/doc/html/rfc6749#section-3.1.2)) - According to [RFC 6749](https://tools.ietf.org/html/rfc6749), an authorization server may include - the `error_description` response parameter in error responses. + - Must be an absolute URI. + - Must not have a fragment component. - If `true`, Authlete does not embed the `error_description` response parameter in error responses. - type: boolean - errorUriOmitted: - description: | - The flag to indicate whether the `error_uri` response parameter is omitted. + **Requirements by OpenID Connect** (From "[OpenID Connect Dynamic Client Registration 1.0, 2. + Client Metadata](https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata), + application_type") - According to [RFC 6749](https://tools.ietf.org/html/rfc6749), an authorization server may include the `error_uri` response parameter in error responses. + - The scheme of the redirect URI used for Implicit Grant by a client application whose application + is `web` must be `https`. This is checked at runtime by Authlete. + - The hostname of the redirect URI used for Implicit Grant by a client application whose application + type is `web` must not be `localhost`. This is checked at runtime by Authlete. + - The scheme of the redirect URI used by a client application whose application type is `native` + must be either (1) a custom scheme or (2) `http`, which is allowed only when the hostname part + is `localhost`. This is checked at runtime by Authlete. - If `true`, Authlete does not embed the - `error_uri` response parameter in error responses. - type: boolean - authorizationEndpoint: - description: | - The authorization endpoint of the service. + **Requirements by Authlete** - A URL that starts with `https://` and has no fragment component. For example, `https://example.com/auth/authorization`. + - Must consist of printable ASCII letters only. + - Must not exceed 200 letters. - The value of this property is used as `authorization_endpoint` property in the [OpenID Provider - Metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). - format: uri - type: string - directAuthorizationEndpointEnabled: - description: | - The flag to indicate whether the direct authorization endpoint is enabled or not. + Note that Authlete allows the application type to be `null`. In other words, a client application + does not have to choose `web` or `native` as its application type. + If the application type is `null`, the requirements by OpenID Connect are not checked at runtime. - The path of the endpoint is `/api/auth/authorization/direct/service-api-key`. - type: boolean - supportedUiLocales: - description: | - UI locales that the service supports. + An authorization request from a client application which has not registered any redirect URI + fails unless at least all the following conditions are satisfied. - Each element is a language tag defined in [RFC 5646](https://tools.ietf.org/html/rfc5646). For example, `en-US` and `ja-JP`. + - The client type of the client application is `confidential`. + - The value of `response_type` request parameter is `code`. + - The authorization request has the `redirect_uri` request parameter. + - The value of `scope` request parameter does not contain `openid`. - The value of this property is used as `ui_locales_supported` property in the [OpenID Provider Metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). + RFC 6749 allows partial match of redirect URI under some conditions (see [RFC 6749, 3.1.2.2. + Registration Requirements](https://datatracker.ietf.org/doc/html/rfc6749#section-3.1.2.2) for + details), but OpenID Connect requires exact match. items: type: string type: array - supportedDisplays: + authorizationSignAlg: + $ref: '#/components/schemas/jws_alg' + authorizationEncryptionAlg: + $ref: '#/components/schemas/jwe_alg' + authorizationEncryptionEnc: + $ref: '#/components/schemas/jwe_enc' + tokenAuthMethod: + $ref: '#/components/schemas/client_auth_method' + tokenAuthSignAlg: + $ref: '#/components/schemas/jws_alg' + selfSignedCertificateKeyId: description: | - Values of `display` request parameter that service supports. - - The value of this property is used as `display_values_supported` property in the Provider Metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). - items: - $ref: '#/components/schemas/Display' - type: array - pkceRequired: + The key ID of a JWK containing a self-signed certificate of this client. + type: string + tlsClientAuthSubjectDn: description: | - The flag to indicate whether the use of Proof Key for Code Exchange (PKCE) is always required for authorization requests by Authorization Code Flow. - - If `true`, `code_challenge` request parameter is always required for authorization requests using Authorization Code Flow. + The string representation of the expected subject distinguished name of the certificate this + client will use in mutual TLS authentication. - See [RFC 7636](https://tools.ietf.org/html/rfc7636) (Proof Key for Code Exchange by OAuth Public Clients) for details about `code_challenge` request parameter. - type: boolean - pkceS256Required: + See `tls_client_auth_subject_dn` in "Mutual TLS Profiles for OAuth Clients, 2.3. Dynamic Client + Registration" for details. + type: string + tlsClientAuthSanDns: description: | - The flag to indicate whether `S256` is always required as the code challenge method whenever [PKCE (RFC 7636)](https://tools.ietf.org/html/rfc7636) is used. + The string representation of the expected DNS subject alternative name of the certificate this + client will use in mutual TLS authentication. - If this flag is set to `true`, `code_challenge_method=S256` must be included in the authorization request - whenever it includes the `code_challenge` request parameter. - Neither omission of the `code_challenge_method` request parameter nor use of plain (`code_challenge_method=plain`) is allowed. - type: boolean - authorizationResponseDuration: + See `tls_client_auth_san_dns` in "Mutual TLS Profiles for OAuth Clients, 2.3. Dynamic Client + Registration" for details. + type: string + tlsClientAuthSanUri: description: | - The duration of authorization response JWTs in seconds. + The string representation of the expected URI subject alternative name of the certificate this + client will use in mutual TLS authentication. - [Financial-grade API: JWT Secured Authorization Response Mode for OAuth 2.0 (JARM)](https://openid.net/specs/openid-financial-api-jarm.html) - defines new values for the `response_mode` request parameter. They are `query.jwt`, `fragment.jwt`, - `form_post.jwt` and `jwt`. If one of them is specified as the response mode, response parameters - from the authorization endpoint will be packed into a JWT. This property is used to compute the - value of the `exp` claim of the JWT. - format: int64 - type: integer - tokenEndpoint: + See `tls_client_auth_san_uri` in "Mutual TLS Profiles for OAuth Clients, 2.3. Dynamic Client + Registration" for details. + type: string + tlsClientAuthSanIp: description: | - The [token endpoint](https://tools.ietf.org/html/rfc6749#section-3.2) of the service. - - A URL that starts with `https://` and has not fragment component. For example, `https://example.com/auth/token`. + The string representation of the expected IP address subject alternative name of the certificate + this client will use in mutual TLS authentication. - The value of this property is used as `token_endpoint` property in the - [OpenID Provider Metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). - format: uri + See `tls_client_auth_san_ip` in "Mutual TLS Profiles for OAuth Clients, 2.3. Dynamic Client + Registration" for details. type: string - directTokenEndpointEnabled: - description: | - The flag to indicate whether the direct token endpoint is enabled or not. The path of the endpoint - is `/api/auth/token/direct/service-api-key`. - type: boolean - supportedTokenAuthMethods: + tlsClientAuthSanEmail: description: | - Client authentication methods supported by the token endpoint of the service. + The string representation of the expected email address subject alternative name of the certificate + this client will use in mutual TLS authentication. - The value of this property is used as `token_endpoint_auth_methods_supports` property in the - [OpenID Provider Metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). - items: - $ref: '#/components/schemas/client_auth_method' - type: array - missingClientIdAllowed: + See `tls_client_auth_san_email` in "Mutual TLS Profiles for OAuth Clients, 2.3. Dynamic Client + Registration" for details. + type: string + parRequired: description: | - The flag to indicate token requests from public clients without the `client_id` request parameter are allowed when the client can be guessed from `authorization_code` or `refresh_token`. - - This flag should not be set unless you have special reasons. + The flag to indicate whether this client is required to use the pushed authorization request endpoint. + This property corresponds to the `require_pushed_authorization_requests` client metadata defined + in "OAuth 2.0 Pushed Authorization Requests". type: boolean - revocationEndpoint: + requestObjectRequired: description: | - The [revocation endpoint](https://tools.ietf.org/html/rfc7009) of the service. + The flag to indicate whether authorization requests from this client are always required to + utilize a request object by using either `request` or `request_uri` request parameter. - A URL that starts with `https://`. For example, `https://example.com/auth/revocation`. - format: uri - type: string - directRevocationEndpointEnabled: - description: 'The flag to indicate whether the direct revocation endpoint - is enabled or not. The URL of the endpoint is `/api/auth/revocation/direct/service-api-key`. ' + If this flag is set to `true` and the service's `traditionalRequestObjectProcessingApplied` is + set to `false`, authorization requests from this client are processed as if `require_signed_request_object` + client metadata of this client is `true`. The metadata is defined in "JAR (JWT Secured Authorization Request)". type: boolean - supportedRevocationAuthMethods: + requestSignAlg: + $ref: '#/components/schemas/jws_alg' + requestEncryptionAlg: + $ref: '#/components/schemas/jwe_alg' + requestEncryptionEnc: + $ref: '#/components/schemas/jwe_enc' + requestUris: description: | - Client authentication methods supported at the revocation endpoint. + An array of URLs each of which points to a request object. + + Authlete requires that URLs used as values for `request_uri` request parameter be pre-registered. + This property is used for the pre-registration. + See [OpenID Connect Core 1.0, 6.2. Passing a Request Object by Reference](https://openid.net/specs/openid-connect-core-1_0.html#RequestUriParameter) for details. items: - $ref: '#/components/schemas/client_auth_method' + type: string type: array - introspectionEndpoint: - description: The URI of the introspection endpoint. - format: uri - type: string - directIntrospectionEndpointEnabled: - description: "The flag to indicate whether the direct userinfo endpoint\ - \ is enabled or not. The path of the endpoint is `/api/auth/userinfo/direct/{serviceApiKey}`. " - type: boolean - supportedIntrospectionAuthMethods: + defaultMaxAge: description: | - Client authentication methods supported at the introspection endpoint. + The default maximum authentication age in seconds. This value is used when an authorization request from the client application does not have `max_age` request parameter. + + This property corresponds to `default_max_age` in + [OpenID Connect Dynamic Client Registration 1.0, 2. Client Metadata](https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata). + format: int32 + type: integer + defaultAcrs: + description: | + The default ACRs (Authentication Context Class References). This value is used when an authorization + request from the client application has neither `acr_values` request parameter nor `acr` claim + in claims request parameter. items: - $ref: '#/components/schemas/client_auth_method' + type: string type: array - pushedAuthReqEndpoint: + idTokenSignAlg: + $ref: '#/components/schemas/jws_alg' + idTokenEncryptionAlg: + $ref: '#/components/schemas/jwe_alg' + idTokenEncryptionEnc: + $ref: '#/components/schemas/jwe_enc' + authTimeRequired: description: | - The URI of the pushed authorization request endpoint. + The flag to indicate whether this client requires `auth_time` claim to be embedded in the ID token. - This property corresponds to the `pushed_authorization_request_endpoint` metadata defined in "[5. Authorization Server Metadata](https://tools.ietf.org/html/draft-lodderstedt-oauth-par#section-5)" of OAuth 2.0 Pushed Authorization Requests. - format: uri + This property corresponds to `require_auth_time` in + [OpenID Connect Dynamic Client Registration 1.0, 2. Client Metadata](https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata). + type: boolean + subjectType: + $ref: '#/components/schemas/subject_type' + sectorIdentifierUri: + description: | + The value of the sector identifier URI. + This represents the `sector_identifier_uri` client metadata which is defined in + [OpenID Connect Dynamic Client Registration 1.0, 2. Client Metadata](https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata) type: string - pushedAuthReqDuration: + derivedSectorIdentifier: description: | - The duration of pushed authorization requests in seconds. - - [OAuth 2.0 Pushed Authorization Requests](https://tools.ietf.org/html/draft-lodderstedt-oauth-par) - defines an endpoint (called "pushed authorization request endpoint") which client applications - can register authorization requests into and get corresponding URIs (called "request URIs") from. - The issued URIs represent the registered authorization requests. The client applications can use - the URIs as the value of the `request_uri` request parameter in an authorization request. - - The property represents the duration of registered authorization requests and is used as the value - of the `expires_in` parameter in responses from the pushed authorization request endpoint. - format: int64 - type: integer - parRequired: + The sector identifier host component as derived from either the `sector_identifier_uri` or the + registered redirect URI. If no `sector_identifier_uri` is registered and multiple redirect URIs + are also registered, the value of this property is `null`. + readOnly: true + type: string + jwksUri: description: | - The flag to indicate whether this service requires that clients use the pushed authorization - request endpoint. + The URL pointing to the JWK Set of the client application. + The content pointed to by the URL is JSON which complies with the format described in + [JSON Web Key (JWK), 5. JWK Set Format](https://datatracker.ietf.org/doc/html/rfc7517#section-5). + The JWK Set must not include private keys of the client application. - This property corresponds to the `require_pushed_authorization_requests` server metadata defined - in [OAuth 2.0 Pushed Authorization Requests](https://tools.ietf.org/html/draft-lodderstedt-oauth-par). - type: boolean - requestObjectRequired: - description: | - The flag to indicate whether this service requires that authorization requests always utilize - a request object by using either request or `request_uri` request parameter. + If the client application requests encryption for ID tokens (from the authorization/token/userinfo endpoints) + and/or signs request objects, it must make available its JWK Set containing public keys for the + encryption and/or the signature at the URL of `jwksUri`. The service (Authlete) fetches the JWK + Set from the URL as necessary. - If this flag is set to `true` and the value of `traditionalRequestObjectProcessingApplied` is - `false`, the value of `require_signed_request_object` server metadata of this service is reported - as `true` in the discovery document. The metadata is defined in JAR (JWT Secured Authorization Request). - That `require_signed_request_object` is `true` means that authorization requests which don't - conform to the JAR specification are rejected. - type: boolean - traditionalRequestObjectProcessingApplied: + [OpenID Connect Dynamic Client Registration 1.0](https://openid.net/specs/openid-connect-registration-1_0.html) + says that `jwks` must not be used when the client can use `jwks_uri`, but Authlete allows both + properties to be registered at the same time. However, Authlete does not use the content of `jwks` + when `jwksUri` is registered. + + This property corresponds to `jwks_uri` in [OpenID Connect Dynamic Client Registration 1.0, 2. + Client Metadata](https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata). + type: string + jwks: description: | - The flag to indicate whether a request object is processed based on rules defined in - [OpenID Connect Core 1.0](https://openid.net/specs/openid-connect-core-1_0.html) or JAR (JWT - Secured Authorization Request). + The content of the JWK Set of the client application. + The format is described in + [JSON Web Key (JWK), 5. JWK Set Format](https://datatracker.ietf.org/doc/html/rfc7517#section-5). + The JWK Set must not include private keys of the client application. - Differences between rules in OpenID Connect Core 1.0 and ones in JAR are as follows. - - JAR requires that a request object be always -signed. - - JAR does not allow request parameters outside a request object to be referred to. - - OIDC Core 1.0 requires that response_type request parameter exist outside a request object even if the request object includes the request parameter. - - OIDC Core 1.0 requires that scope request parameter exist outside a request object if the authorization request is an - - OIDC request even if the request object includes the request parameter. + [OpenID Connect Dynamic Client Registration 1.0](https://openid.net/specs/openid-connect-registration-1_0.html) + says that `jwks` must not be used when the client can use `jwks_uri`, but Authlete allows both + properties to be registered at the same time. However, Authlete does not use the content of `jwks` + when `jwksUri` is registered. - If this flag is set to `false` and the value of `requestObjectRequired` is `true`, the value of - `require_signed_request_object` server metadata of this service - is reported as `true` in the discovery document. The metadata is defined in JAR (JWT Secured - Authorization Request). That `require_signed_request_object` is `true` means that authorization - requests which don't conform to the JAR specification are rejected. - type: boolean - mutualTlsValidatePkiCertChain: + This property corresponds to `jwks_uri` in [OpenID Connect Dynamic Client Registration 1.0, 2. + Client Metadata](https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata). + type: string + userInfoSignAlg: + $ref: '#/components/schemas/jws_alg' + userInfoEncryptionAlg: + $ref: '#/components/schemas/jwe_alg' + userInfoEncryptionEnc: + $ref: '#/components/schemas/jwe_enc' + loginUri: description: | - The flag to indicate whether this service validates certificate chains during PKI-based client mutual TLS authentication. - type: boolean - trustedRootCertificates: + The URL which a third party can use to initiate a login by the client application. + + This property corresponds to `initiate_login_uri` in + [OpenID Connect Dynamic Client Registration 1.0, 2. Client Metadata](https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata). + type: string + tosUri: description: | - The list of root certificates trusted by this service for PKI-based client mutual TLS authentication. + The URL pointing to the "Terms Of Service" page. + + This property corresponds to `tos_uri` in + [OpenID Connect Dynamic Client Registration 1.0, 2. Client Metadata](https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata). + type: string + tosUris: + description: | + URLs of "Terms Of Service" pages with language tags. + + If the client application has different "Terms Of Service" pages for different languages, + this property can be used to register the URLs. items: - type: string + $ref: '#/components/schemas/tagged_value' type: array - mtlsEndpointAliases: + policyUri: description: | - The MTLS endpoint aliases. - - This property corresponds to the mtls_endpoint_aliases metadata defined in "5. Metadata for Mutual TLS Endpoint Aliases" of [OAuth 2.0 Mutual TLS Client Authentication and Certificate-Bound Access Tokens](https://datatracker.ietf.org/doc/rfc8705/). - - The aliases will be embedded in the response from the discovery endpoint like the following. + The URL pointing to the page which describes the policy as to how end-user's profile data is used. - ```json - { - ......, - "mtls_endpoint_aliases": { - "token_endpoint": "https://mtls.example.com/token", - "revocation_endpoint": "https://mtls.example.com/revo", - "introspection_endpoint": "https://mtls.example.com/introspect" - } - } - ``` + This property corresponds to `policy_uri` in + [OpenID Connect Dynamic Client Registration 1.0, 2. Client Metadata](https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata). + type: string + policyUris: + description: | + URLs of policy pages with language tags. + If the client application has different policy pages for different languages, this property can be used to register the URLs. items: - $ref: '#/components/schemas/named_uri' + $ref: '#/components/schemas/tagged_value' type: array - accessTokenType: + clientUri: description: | - The access token type. - - This value is used as the value of `token_type` property in access token responses. If this service - complies with [RFC 6750](https://tools.ietf.org/html/rfc6750), the value of this property should - be `Bearer`. + The URL pointing to the home page of the client application. - See [RFC 6749 (OAuth 2.0), 7.1. Access Token Types](https://tools.ietf.org/html/rfc6749#section-7.1) for details. + This property corresponds to `client_uri` in + [OpenID Connect Dynamic Client Registration 1.0, 2. Client Metadata](https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata). type: string - tlsClientCertificateBoundAccessTokens: - description: | - The flag to indicate whether this service supports issuing TLS client certificate bound access tokens. - type: boolean - accessTokenDuration: + clientUris: description: | - The duration of access tokens in seconds. This value is used as the value of `expires_in` property - in access token responses. `expires_in` is defined [RFC 6749, 5.1. Successful Response](https://tools.ietf.org/html/rfc6749#section-5.1). - format: int64 - type: integer - singleAccessTokenPerSubject: + Home page URLs with language tags. + If the client application has different home pages for different languages, this property can + be used to register the URLs. + items: + $ref: '#/components/schemas/tagged_value' + type: array + bcDeliveryMode: description: | - The flag to indicate whether the number of access tokens per subject (and per client) is at most one or can be more. - - If `true`, an attempt to issue a new access token invalidates existing access tokens that are associated with the same subject and the same client. + The backchannel token delivery mode. - Note that, however, attempts by [Client Credentials Flow](https://tools.ietf.org/html/rfc6749#section-4.4) do not invalidate existing access tokens because access tokens issued by Client Credentials Flow are not associated with any end-user's subject. Also note that an attempt by [Refresh Token Flow](https://tools.ietf.org/html/rfc6749#section-6) invalidates the coupled access token only and this invalidation is always performed regardless of whether the value of this setting item is `true` or `false`. - type: boolean - accessTokenSignAlg: - $ref: '#/components/schemas/jws_alg' - accessTokenSignatureKeyId: + This property corresponds to the `backchannel_token_delivery_mode` metadata. + The backchannel token delivery mode is defined in the specification of "CIBA (Client Initiated + Backchannel Authentication)". + type: string + bcNotificationEndpoint: description: | - The key ID to identify a JWK used for signing access tokens. + The backchannel client notification endpoint. - A JWK Set can be registered as a property of a service. A JWK Set can contain 0 or more JWKs. - Authlete Server has to pick up one JWK for signing from the JWK Set when it generates a JWT-based - access token. Authlete Server searches the registered JWK Set for a JWK which satisfies conditions - for access token signature. If the number of JWK candidates which satisfy the conditions is 1, - there is no problem. On the other hand, if there exist multiple candidates, a Key ID is needed - to be specified so that Authlete Server can pick up one JWK from among the JWK candidates. + This property corresponds to the `backchannel_client_notification_endpoint` metadata. + The backchannel token delivery mode is defined in the specification of "CIBA (Client Initiated + Backchannel Authentication)". type: string - refreshTokenDuration: - description: "The duration of refresh tokens in seconds. The related specifications\ - \ have no requirements on refresh token duration, but Authlete sets expiration\ - \ for refresh tokens." - format: int64 - type: integer - refreshTokenDurationKept: - description: | - The flag to indicate whether the remaining duration of the used refresh token is taken over to - the newly issued refresh token. - type: boolean - refreshTokenDurationReset: + bcRequestSignAlg: + $ref: '#/components/schemas/jws_alg' + bcUserCodeRequired: description: | - The flag which indicates whether duration of refresh tokens are reset when they are used even - if the `refreshTokenKept` property of this service set to is `true` (= even if "Refresh Token - Continuous Use" is "Kept"). + The boolean flag to indicate whether a user code is required when this client makes a backchannel + authentication request. - This flag has no effect when the `refreshTokenKept` property is set to `false`. In other words, - if this service issues a new refresh token on every refresh token request, the refresh token - will have fresh duration (unless `refreshTokenDurationKept` is set to `true`) and this - `refreshTokenDurationReset` property is not referenced. + This property corresponds to the `backchannel_user_code_parameter` metadata. type: boolean - refreshTokenKept: + attributes: description: | - The flag to indicate whether a refresh token remains unchanged or gets renewed after its use. - - If `true`, a refresh token used to get a new access token remains valid after its use. Otherwise, if `false`, a refresh token is invalidated after its use and a new refresh token is issued. - - See [RFC 6749 6. Refreshing an Access Token](https://tools.ietf.org/html/rfc6749#section-6), as to how to get a new access token using a refresh token. - type: boolean - supportedScopes: + The attributes of this client. + items: + $ref: '#/components/schemas/Pair' + type: array + extension: + $ref: '#/components/schemas/client_extension' + authorizationDetailsTypes: description: | - Scopes supported by the service. - - Authlete strongly recommends that the service register at least the following scopes. + The authorization details types that this client may use as values of the `type` field in + `authorization_details`. - | Name | Description | - | --- | --- | - | openid | A permission to get an ID token of an end-user. The `openid` scope appears in [OpenID Connect Core 1.0, 3.1.2.1. Authentication Request, scope](https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest). Without this scope, Authlete does not allow `response_type` request parameter to have values other than code and token. | - | profile | A permission to get information about `name`, `family_name`, `given_name`, `middle_name`, `nickname`, `preferred_username`, `profile`, `picture`, `website`, `gender`, `birthdate`, `zoneinfo`, `locale` and `updated_at` from the user info endpoint. See [OpenID Connect Core 1.0, 5.4. Requesting Claims using Scope Values](https://openid.net/specs/openid-connect-core-1_0.html#ScopeClaims) for details. | - | email | A permission to get information about `email` and `email_verified` from the user info endpoint. See [OpenID Connect Core 1.0, 5.4. Requesting Claims using Scope Values](https://openid.net/specs/openid-connect-core-1_0.html#ScopeClaims) for details. | - | address | A permission to get information about address from the user info endpoint. See [OpenID Connect Core 1.0, 5.4. Requesting Claims using Scope Values](https://openid.net/specs/openid-connect-core-1_0.html#ScopeClaims) and [5.1.1. Address Claim](https://openid.net/specs/openid-connect-core-1_0.html#AddressClaim) for details. | - | phone | A permission to get information about `phone_number` and `phone_number_verified` from the user info endpoint. See [OpenID Connect Core 1.0, 5.4. Requesting Claims using Scope Values](https://openid.net/specs/openid-connect-core-1_0.html#ScopeClaims) for details. | - | offline_access | A permission to get information from the user info endpoint even when the end-user is not present. See [OpenID Connect Core 1.0, 11. Offline Access](https://openid.net/specs/openid-connect-core-1_0.html#OfflineAccess) for details. | + This property corresponds to the `authorization_details_types` metadata. See [OAuth 2.0 Rich + Authorization Requests (RAR)](https://datatracker.ietf.org/doc/draft-ietf-oauth-rar/) for details. - The value of this property is used as `scopes_supported` property in the [OpenID Provider Metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). + Note that the property name was renamed from authorizationDataTypes to authorizationDetailsTypes + to align with the change made by the 5th draft of the RAR specification. items: - $ref: '#/components/schemas/Scope' + type: string type: array - scopeRequired: + customMetadata: description: | - The flag to indicate whether requests that request no scope are rejected or not. - - When a request has no explicit `scope` parameter and the service's pre-defined default scope set is empty, - the authorization server regards the request requests no scope. When this flag is set to `true`, - requests that request no scope are rejected. - - The requirement below excerpted from [RFC 6749 Section 3.3](https://tools.ietf.org/html/rfc6749#section-3.3) - does not explicitly mention the case where the default scope set is empty. + The custom client metadata in JSON format. - > If the client omits the scope parameter when requesting authorization, the authorization server - MUST either process the request using a pre-defined default value or fail the request indicating an invalid scope. + Standard specifications define client metadata as necessary. The following are such examples. - However, if you interpret *"the default scope set exists but is empty"* as *"the default scope set does not exist"* - and want to strictly conform to the requirement above, this flag has to be `true`. - type: boolean - idTokenDuration: - description: | - 'The duration of [ID token](https://openid.net/specs/openid-connect-core-1_0.html#IDToken)s - in seconds. This value is used to calculate the value of `exp` claim in an ID token.' - format: int64 - type: integer - allowableClockSkew: - description: | - The allowable clock skew between the server and clients in seconds. + * [OpenID Connect Dynamic Client Registration 1.0](https://openid.net/specs/openid-connect-registration-1_0.html) + * [RFC 7591 OAuth 2.0 Dynamic Client Registration Protocol](https://www.rfc-editor.org/rfc/rfc7591.html) + * [RFC 8705 OAuth 2.0 Mutual-TLS Client Authentication and Certificate-Bound Access Tokens](https://www.rfc-editor.org/rfc/rfc8705.html) + * [OpenID Connect Client-Initiated Backchannel Authentication Flow - Core 1.0](https://openid.net/specs/openid-client-initiated-backchannel-authentication-core-1_0.html) + * [The OAuth 2.0 Authorization Framework: JWT Secured Authorization Request (JAR)](https://datatracker.ietf.org/doc/draft-ietf-oauth-jwsreq/) + * [Financial-grade API: JWT Secured Authorization Response Mode for OAuth 2.0 (JARM)](https://openid.net/specs/openid-financial-api-jarm.html) + * [OAuth 2.0 Pushed Authorization Requests (PAR)](https://datatracker.ietf.org/doc/rfc9126/) + * [OAuth 2.0 Rich Authorization Requests (RAR)](https://datatracker.ietf.org/doc/draft-ietf-oauth-rar/) - The clock skew is taken into consideration when time-related claims in a JWT (e.g. `exp`, `iat`, `nbf`) are verified. - format: int32 - type: integer - supportedClaimTypes: - description: | - Claim types supported by the service. Valid values are listed in Claim Type. Note that Authlete - currently doesn't provide any API to help implementations for `AGGREGATED` and `DISTRIBUTED`. + Standard client metadata included in Client Registration Request and Client Update Request (cf. + [OIDC DynReg](https://openid.net/specs/openid-connect-registration-1_0.html), [RFC 7591](https://www.rfc-editor.org/rfc/rfc7591.html) + and [RFC 7592](https://www.rfc-editor.org/rfc/rfc7592.html)) are, if supported by Authlete, set + to corresponding properties of the client application. For example, the value of the `client_name` + client metadata in Client Registration/Update Request is set to the clientName property. On the + other hand, unrecognized client metadata are discarded. - The value of this property is used as `claim_types_supported` property in the [OpenID Provider - Metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). - items: - $ref: '#/components/schemas/claim_type' - type: array - supportedClaimLocales: + By listing up custom client metadata in advance by using the `supportedCustomClientMetadata` property + of Service, Authlete can recognize them and stores their values into the database. The stored + custom client metadata values can be referenced by this property. + type: string + frontChannelRequestObjectEncryptionRequired: description: | - Claim locales that the service supports. Each element is a language tag defined in [RFC 5646](https://tools.ietf.org/html/rfc5646). - For example, `en-US` and `ja-JP`. See [OpenID Connect Core 1.0, 5.2. Languages and Scripts](https://openid.net/specs/openid-connect-core-1_0.html#ClaimsLanguagesAndScripts) - for details. + The flag indicating whether encryption of request object is required when the request object + is passed through the front channel. - The value of this property is used as `claims_locales_supported` property in the - [OpenID Provider Metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). - items: - type: string - type: array - supportedClaims: + This flag does not affect the processing of request objects at the Pushed Authorization Request + Endpoint, which is defined in [OAuth 2.0 Pushed Authorization Requests](https://datatracker.ietf.org/doc/rfc9126/). + Unecrypted request objects are accepted at the endpoint even if this flag is `true`. + + This flag does not indicate whether a request object is always required. There is a different + flag, `requestObjectRequired`, for the purpose. + + Even if this flag is `false`, encryption of request object is required if the `frontChannelRequestObjectEncryptionRequired` + flag of the service is `true`. + type: boolean + requestObjectEncryptionAlgMatchRequired: description: | - Claim names that the service supports. The standard claim names listed in [OpenID Connect Core 1.0, - 5.1. Standard Claim](https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims) should - be supported. The following is the list of standard claims. + The flag indicating whether the JWE alg of encrypted request object must match the `request_object_encryption_alg` + client metadata. - - `sub` - - `name` - - `given_name` - - `family_name` - - `middle_name` - - `nickname` - - `preferred_username` - - `profile` - - `picture` - - `website` - - `email` - - `email_verified` - - `gender` - - `birthdate` - - `zoneinfo` - - `locale` - - `phone_number` - - `phone_number_verified` - - `address` - - `updated_at` + The `request_object_encryption_alg` client metadata itself is defined in [OpenID Connect Dynamic + Client Registration 1.0](https://openid.net/specs/openid-connect-registration-1_0.html) as follows. - The value of this property is used as `claims_supported` property in the [OpenID Provider - Metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). + > request_object_encryption_alg + > + > OPTIONAL. JWE [JWE] alg algorithm [JWA] the RP is declaring that it may use for encrypting Request + Objects sent to the OP. This parameter SHOULD be included when symmetric encryption will be used, + since this signals to the OP that a client_secret value needs to be returned from which the + symmetric key will be derived, that might not otherwise be returned. The RP MAY still use other + supported encryption algorithms or send unencrypted Request Objects, even when this parameter + is present. If both signing and encryption are requested, the Request Object will be signed + then encrypted, with the result being a Nested JWT, as defined in [JWT]. The default, if omitted, + is that the RP is not declaring whether it might encrypt any Request Objects. - The service may support its original claim names. See [OpenID Connect Core 1.0, 5.1.2. Additional - Claims](https://openid.net/specs/openid-connect-core-1_0.html#AdditionalClaims). - items: - type: string - type: array - claimShortcutRestrictive: - description: | - The flag indicating whether claims specified by shortcut scopes (e.g. `profile`) are included - in the issued ID token only when no access token is issued. + The point here is "The RP MAY still use other supported encryption algorithms or send unencrypted + Request Objects, even when this parameter is present." - To strictly conform to the description below excerpted from [OpenID Connect Core 1.0 Section - 5.4](https://openid.net/specs/openid-connect-core-1_0.html#ScopeClaims), this flag has to be `true`. + The property that represents the client metadata is `requestEncryptionAlg`. See the description + of `requestEncryptionAlg` for details. - > The Claims requested by the profile, email, address, and phone scope values are returned from - the UserInfo Endpoint, as described in Section 5.3.2, when a response_type value is used that - results in an Access Token being issued. However, when no Access Token is issued (which is the - case for the response_type value id_token), the resulting Claims are returned in the ID Token. + Even if this flag is `false`, the match is required if the `requestObjectEncryptionAlgMatchRequired` + flag of the service is `true`. type: boolean - jwksUri: + requestObjectEncryptionEncMatchRequired: description: | - The URL of the service's [JSON Web Key Set](https://tools.ietf.org/html/rfc7517) document. For - example, `http://example.com/auth/jwks`. + The flag indicating whether the JWE enc of encrypted request object must match the `request_object_encryption_enc` + client metadata. - Client applications accesses this URL (1) to get the public key of the service to validate the - signature of an ID token issued by the service and (2) to get the public key of the service to - encrypt an request object of the client application. See [OpenID Connect Core 1.0, 10. Signatures - and Encryption](https://openid.net/specs/openid-connect-core-1_0.html#SigEnc) for details. + The `request_object_encryption_enc` client metadata itself is defined in [OpenID Connect Dynamic + Client Registration 1.0](https://openid.net/specs/openid-connect-registration-1_0.html) as follows. - The value of this property is used as `jwks_uri` property in the [OpenID Provider Metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). - format: uri - type: string - directJwksEndpointEnabled: - description: | - 'The flag to indicate whether the direct jwks endpoint is enabled or not. The path of the endpoint - is `/api/service/jwks/get/direct/service-api-key`. ' - type: boolean - jwks: - description: | - The content of the service's [JSON Web Key Set](https://tools.ietf.org/html/rfc7517) document. + > request_object_encryption_enc + > + > OPTIONAL. JWE enc algorithm [JWA] the RP is declaring that it may use for encrypting Request + Objects sent to the OP. If request_object_encryption_alg is specified, the default for this + value is A128CBC-HS256. When request_object_encryption_enc is included, request_object_encryption_alg + MUST also be provided. - If this property is not `null` in a `/service/create` request or a `/service/update` request, - Authlete hosts the content in the database. This property must not be `null` and must contain - pairs of public/private keys if the service wants to support asymmetric signatures for ID tokens - and asymmetric encryption for request objects. See [OpenID Connect Core 1.0, 10. Signatures and - Encryption](https://openid.net/specs/openid-connect-core-1_0.html#SigEnc) for details. - type: string - idTokenSignatureKeyId: + The property that represents the client metadata is `requestEncryptionEnc`. See the description + of `requestEncryptionEnc` for details. + + Even if this flag is `false`, the match is required if the `requestObjectEncryptionEncMatchRequired` + flag of the service is `true`. + type: boolean + digestAlgorithm: description: | - The key ID to identify a JWK used for ID token signature using an asymmetric key. + The digest algorithm that this client requests the server to use + when it computes digest values of external attachments, which may be referenced from within ID tokens + or userinfo responses (or any place that can have the `verified_claims` claim). - A JWK Set can be registered as a property of a Service. A JWK Set can contain 0 or more JWKs - (See [RFC 7517](https://tools.ietf.org/html/rfc7517) for details about JWK). Authlete Server has - to pick up one JWK for signature from the JWK Set when it generates an ID token and signature - using an asymmetric key is required. Authlete Server searches the registered JWK Set for a JWK - which satisfies conditions for ID token signature. If the number of JWK candidates which satisfy - the conditions is 1, there is no problem. On the other hand, if there exist multiple candidates, - a [Key ID](https://tools.ietf.org/html/rfc7517#section-4.5) is needed to be specified so that - Authlete Server can pick up one JWK from among the JWK candidates. + Possible values are listed in the Hash Algorithm Registry of IANA (Internet Assigned Numbers Authority), + but the server does not necessarily support all the values there. When + this property is omitted, `sha-256` is used as the default algorithm. - This `idTokenSignatureKeyId` property exists for the purpose described above. For key rotation - (OpenID Connect Core 1.0, [10.1.1. Rotation of Asymmetric Signing Keys](http://openid.net/specs/openid-connect-core-1_0.html#RotateSigKeys)), - this mechanism is needed. + This property corresponds to the `digest_algorithm` client metadata + which was defined by the third implementer's draft of + [OpenID Connect for Identity Assurance 1.0](https://openid.net/specs/openid-connect-4-identity-assurance-1_0.html). type: string - userInfoSignatureKeyId: + singleAccessTokenPerSubject: description: | - The key ID to identify a JWK used for user info signature using an asymmetric key. + If `Enabled` is selected, an attempt to issue a new access token invalidates existing access tokens that are associated with the same combination of subject and client. - A JWK Set can be registered as a property of a Service. A JWK Set can contain 0 or more JWKs - (See [RFC 7517](https://tools.ietf.org/html/rfc7517) for details about JWK). Authlete Server has - to pick up one JWK for signature from the JWK Set when it is required to sign user info (which - is returned from [userinfo endpoint](http://openid.net/specs/openid-connect-core-1_0.html#UserInfo)) - using an asymmetric key. Authlete Server searches the registered JWK Set for a JWK which satisfies - conditions for user info signature. If the number of JWK candidates which satisfy the conditions - is 1, there is no problem. On the other hand, if there exist multiple candidates, a [Key ID](https://tools.ietf.org/html/rfc7517#section-4.5) - is needed to be specified so that Authlete Server can pick up one JWK from among the JWK candidates. + Note that, however, attempts by Client Credentials Flow do not invalidate existing access tokens because access tokens issued by Client Credentials Flow are not associated with any end-user's subject. - This `userInfoSignatureKeyId` property exists for the purpose described above. For key rotation - (OpenID Connect Core 1.0, [10.1.1. Rotation of Asymmetric Signing Keys](http://openid.net/specs/openid-connect-core-1_0.html#RotateSigKeys)), - this mechanism is needed. - type: string - authorizationSignatureKeyId: + Even if `Disabled` is selected here, single access token per subject is effective if `singleAccessTokenPerSubject` of the `Service` this client belongs to is Enabled. + type: boolean + pkceRequired: description: | - The key ID to identify a JWK used for signing authorization responses using an asymmetric key. + The flag to indicate whether the use of Proof Key for Code Exchange (PKCE) is always required for authorization requests by Authorization Code Flow. - [Financial-grade API: JWT Secured Authorization Response Mode for OAuth 2.0 (JARM)](https://openid.net/specs/openid-financial-api-jarm.html) - defines new values for the `response_mode` request parameter. They are `query.jwt`, `fragment.jwt`, - `form_post.jwt` and `jwt`. If one of them is specified as the response mode, response parameters - from the authorization endpoint will be packed into a JWT. This property is used to compute the - value of the `exp` claim of the JWT. + If `true`, `code_challenge` request parameter is always required for authorization requests using Authorization Code Flow. - Authlete Server searches the JWK Set for a JWK which satisfies conditions for authorization response - signature. If the number of JWK candidates which satisfy the conditions is 1, there is no problem. - On the other hand, if there exist multiple candidates, a Key ID is needed to be specified so that - Authlete Server can pick up one JWK from among the JWK candidates. This property exists to specify - the key ID. - type: string - userInfoEndpoint: + See [RFC 7636](https://tools.ietf.org/html/rfc7636) (Proof Key for Code Exchange by OAuth Public Clients) for details about `code_challenge` request parameter. + type: boolean + pkceS256Required: description: | - The [user info endpoint](http://openid.net/specs/openid-connect-core-1_0.html#UserInfo) of the - service. A URL that starts with `https://`. For example, `https://example.com/auth/userinfo`. + The flag to indicate whether `S256` is always required as the code challenge method whenever [PKCE (RFC 7636)](https://tools.ietf.org/html/rfc7636) is used. - The value of this property is used as `userinfo_endpoint` property in the [OpenID Provider Metadata](http://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). - format: uri - type: string - directUserInfoEndpointEnabled: + If this flag is set to `true`, `code_challenge_method=S256` must be included in the authorization request + whenever it includes the `code_challenge` request parameter. + Neither omission of the `code_challenge_method` request parameter nor use of plain (`code_challenge_method=plain`) is allowed. + type: boolean + dpopRequired: description: | - The flag to indicate whether the direct userinfo endpoint is enabled or not. The path - of the endpoint is `/api/auth/userinfo/direct/service-api-key`. + If the DPoP is required for this client type: boolean - dynamicRegistrationSupported: + automaticallyRegistered: description: | - The boolean flag which indicates whether the [OAuth 2.0 Dynamic Client Registration Protocol](https://tools.ietf.org/html/rfc7591) - is supported. + The flag indicating whether this client was registered by the + "automatic" client registration of OIDC Federation. type: boolean - registrationEndpoint: + explicitlyRegistered: description: | - The [registration endpoint](http://openid.net/specs/openid-connect-registration-1_0.html#ClientRegistration) - of the service. A URL that starts with `https://`. For example, `https://example.com/auth/registration`. - - The value of this property is used as `registration_endpoint` property in the [OpenID Provider Metadata](http://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). - format: uri - type: string - registrationManagementEndpoint: + The flag indicating whether this client was registered by the + "explicit" client registration of OIDC Federation. + type: boolean + rsRequestSigned: description: | - The URI of the registration management endpoint. If dynamic client registration is supported, - and this is set, this URI will be used as the basis of the client's management endpoint by appending - `/clientid}/` to it as a path element. If this is unset, the value of `registrationEndpoint` will - be used as the URI base instead. - format: uri + The flag indicating whether this service signs responses from the resource server. + type: boolean + rsSignedRequestKeyId: + description: | + The key ID of a JWK containing the public key used by this client to sign requests to the resource server. type: string - policyUri: + clientRegistrationTypes: description: | - The URL of the "Policy" of the service. - - The value of this property is used as `op_policy_uri` property in the [OpenID Provider Metadata](http://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). - format: uri + The client registration types that the client has declared it may use. + items: + $ref: '#/components/schemas/client_registration_type' + type: array + organizationName: + description: | + The human-readable name representing the organization that manages this client. This property corresponds + to the organization_name client metadata that is defined in OpenID Connect Federation 1.0. type: string - tosUri: + signedJwksUri: description: | - The URL of the "Terms Of Service" of the service. - - The value of this property is used as `op_tos_uri` property in the [OpenID Provider Metadata](http://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). - format: uri + The URI of the endpoint that returns this client's JWK Set document in the JWT format. This property + corresponds to the `signed_jwks_uri` client metadata defined in OpenID Connect Federation 1.0. type: string - serviceDocumentation: + entityId: description: | - The URL of a page where documents for developers can be found. - - The value of this property is used as `service_documentation` property in the [OpenID Provider Metadata](http://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). - format: uri + the entity ID of this client. type: string - backchannelAuthenticationEndpoint: + trustAnchorId: description: | - The URI of backchannel authentication endpoint, which is defined in the specification of [CIBA - (Client Initiated Backchannel Authentication)](https://openid.net/specs/openid-client-initiated-backchannel-authentication-core-1_0.html). - format: uri + The entity ID of the trust anchor of the trust chain that was used when this client was registered or updated by + the mechanism defined in OpenID Connect Federation 1.0 type: string - supportedBackchannelTokenDeliveryModes: + trustChain: description: | - The supported backchannel token delivery modes. This property corresponds to the `backchannel_token_delivery_modes_supported` - metadata. - - Backchannel token delivery modes are defined in the specification of [CIBA (Client Initiated - Backchannel Authentication)](https://openid.net/specs/openid-client-initiated-backchannel-authentication-core-1_0.html). + The trust chain that was used when this client was registered or updated by the mechanism defined in + OpenID Connect Federation 1.0 items: - $ref: '#/components/schemas/delivery_mode' + type: string type: array - backchannelAuthReqIdDuration: + trustChainExpiresAt: description: | - The duration of backchannel authentication request IDs issued from the backchannel authentication - endpoint in seconds. This is used as the value of the `expires_in` property in responses from - the backchannel authentication endpoint. - format: int32 + the expiration time of the trust chain that was used when this client was registered or updated by the mechanism + defined in OpenID Connect Federation 1.0. The value is represented as milliseconds elapsed since the Unix epoch (1970-01-01). + format: int64 type: integer - backchannelPollingInterval: + trustChainUpdatedAt: description: | - The minimum interval between polling requests to the token endpoint from client applications in - seconds. This is used as the value of the `interval` property in responses from the backchannel - authentication endpoint. - format: int32 + the time at which the trust chain was updated by the mechanism defined in OpenID Connect Federation 1.0 + format: int64 type: integer - backchannelUserCodeParameterSupported: - description: | - The boolean flag which indicates whether the `user_code` request parameter is supported at the - backchannel authentication endpoint. This property corresponds to the `backchannel_user_code_parameter_supported` - metadata. - type: boolean - backchannelBindingMessageRequiredInFapi: + locked: description: | - The flag to indicate whether the `binding_message` request parameter is always required whenever - a backchannel authentication request is judged as a request for Financial-grade API. - - The FAPI-CIBA profile requires that the authorization server _"shall ensure unique authorization - context exists in the authorization request or require a `binding_message` in the authorization - request"_ (FAPI-CIBA, 5.2.2, 2). The simplest way to fulfill this requirement is to set this property - to `true`. - - If this property is set to `false`, the `binding_message` request parameter remains optional - even in FAPI context, but in exchange, your authorization server must implement a custom mechanism - that ensures each backchannel authentication request has unique context. + The flag which indicates whether this client is locked. type: boolean - deviceAuthorizationEndpoint: - description: | - The URI of the device authorization endpoint. - - Device authorization endpoint is defined in the specification of OAuth 2.0 Device Authorization Grant. - format: uri - type: string - deviceVerificationUri: + credentialOfferEndpoint: description: | - The verification URI for the device flow. This URI is used as the value of the `verification_uri` - parameter in responses from the device authorization endpoint. - format: uri + The URL of the credential offer endpoint at which this client + (wallet) receives a credential offer from the credential issuer. type: string - deviceVerificationUriComplete: + fapiModes: description: | - The verification URI for the device flow with a placeholder for a user code. This URI is used - to build the value of the `verification_uri_complete` parameter in responses from the device - authorization endpoint. - - It is expected that the URI contains a fixed string `USER_CODE` somewhere as a placeholder for - a user code. For example, like the following. - - `https://example.com/device?user\_code=USER\_CODE` + The FAPI modes for this client. - The fixed string is replaced with an actual user code when Authlete builds a verification URI - with a user code for the `verification_uri_complete` parameter. + When the value of this property is not `null`, Authlete always processes requests from this client + based on the specified FAPI modes if the FAPI feature is enabled in Authlete, the FAPI profile + is supported by the service, and the FAPI modes for the service are set to `null`. - If this URI is not set, the `verification_uri_complete` parameter won't appear in device authorization - responses. - format: uri - type: string - deviceFlowCodeDuration: - description: | - The duration of device verification codes and end-user verification codes issued from the device - authorization endpoint in seconds. This is used as the value of the `expires_in` property in responses - from the device authorization endpoint. - format: int32 - type: integer - deviceFlowPollingInterval: - description: | - The minimum interval between polling requests to the token endpoint from client applications in - seconds in device flow. This is used as the value of the `interval` property in responses from - the device authorization endpoint. - format: int32 - type: integer - userCodeCharset: - $ref: '#/components/schemas/user_code_charset' - userCodeLength: - description: | - The length of end-user verification codes (`user_code`) for Device Flow. - format: int32 - type: integer - supportedTrustFrameworks: - description: | - Trust frameworks supported by this service. This corresponds to the `trust_frameworks_supported` - [metadata](https://openid.net/specs/openid-connect-4-identity-assurance-1_0.html#rfc.section.7). - items: - type: string - type: array - supportedEvidence: - description: | - Evidence supported by this service. This corresponds to the `evidence_supported` [metadata](https://openid.net/specs/openid-connect-4-identity-assurance-1_0.html#rfc.section.7). - items: - type: string - type: array - supportedIdentityDocuments: - description: | - Identity documents supported by this service. This corresponds to the `id_documents_supported` - [metadata](https://openid.net/specs/openid-connect-4-identity-assurance-1_0.html#rfc.section.7). - items: - type: string - type: array - supportedVerificationMethods: - description: | - Verification methods supported by this service. This corresponds to the `id_documents_verification_methods_supported` - [metadata](https://openid.net/specs/openid-connect-4-identity-assurance-1_0.html#rfc.section.7). + For instance, when this property is set to an array containing `FAPI1_ADVANCED` only, Authlete + always processes requests from this client based on "Financial-grade API Security Profile 1.0 - + Part 2: Advanced" if the FAPI feature is enabled in Authlete, the FAPI profile is supported by + the service, and the FAPI modes for the service are set to `null`. items: - type: string + $ref: '#/components/schemas/fapi_mode' type: array - supportedVerifiedClaims: - description: | - Verified claims supported by this service. This corresponds to the `claims_in_verified_claims_supported` - [metadata](https://openid.net/specs/openid-connect-4-identity-assurance-1_0.html#rfc.section.7). + responseModes: + description: The response modes that this client may use. items: + enum: + - QUERY + - FRAGMENT + - FORM_POST + - JWT + - QUERY_JWT + - FRAGMENT_JWT + - FORM_POST_JWT type: string type: array - verifiedClaimsValidationSchemaSet: - $ref: '#/components/schemas/verified_claims_validation_schema' - attributes: - description: | - The attributes of this service. - items: - $ref: '#/components/schemas/Pair' - type: array - nbfOptional: - description: | - The flag indicating whether the nbf claim in the request object is optional even when the authorization - request is regarded as a FAPI-Part2 request. - - The final version of Financial-grade API was approved in January, 2021. The Part 2 of the final - version has new requirements on lifetime of request objects. They require that request objects - contain an `nbf` claim and the lifetime computed by `exp` - `nbf` be no longer than 60 minutes. - - Therefore, when an authorization request is regarded as a FAPI-Part2 request, the request object - used in the authorization request must contain an nbf claim. Otherwise, the authorization server - rejects the authorization request. - - When this flag is `true`, the `nbf` claim is treated as an optional claim even when the authorization - request is regarded as a FAPI-Part2 request. That is, the authorization server does not perform - the validation on lifetime of the request object. - - Skipping the validation is a violation of the FAPI specification. The reason why this flag has - been prepared nevertheless is that the new requirements (which do not exist in the Implementer's - Draft 2 released in October, 2018) have big impacts on deployed implementations of client - applications and Authlete thinks there should be a mechanism whereby to make the migration - from ID2 to Final smooth without breaking live systems. - type: boolean - issSuppressed: - description: | - The flag indicating whether generation of the iss response parameter is suppressed. - - "OAuth 2.0 Authorization Server Issuer Identifier in Authorization Response" has defined a new - authorization response parameter, `iss`, as a countermeasure for a certain type of mix-up attacks. - - The specification requires that the `iss` response parameter always be included in authorization - responses unless JARM (JWT Secured Authorization Response Mode) is used. - - When this flag is `true`, the authorization server does not include the `iss` response parameter - in authorization responses. By turning this flag on and off, developers of client applications - can experiment the mix-up attack and the effect of the `iss` response parameter. - - Note that this flag should not be `true` in production environment unless there are special - reasons for it. + credentialResponseEncryptionRequired: + description: True if credential responses to this client must be always + encrypted. type: boolean - supportedCustomClientMetadata: - description: | - custom client metadata supported by this service. - - Standard specifications define client metadata as necessary. The following are such examples. - - * [OpenID Connect Dynamic Client Registration 1.0](https://openid.net/specs/openid-connect-registration-1_0.html) - * [RFC 7591 OAuth 2.0 Dynamic Client Registration Protocol](https://www.rfc-editor.org/rfc/rfc7591.html) - * [RFC 8705 OAuth 2.0 Mutual-TLS Client Authentication and Certificate-Bound Access Tokens](https://www.rfc-editor.org/rfc/rfc8705.html) - * [OpenID Connect Client-Initiated Backchannel Authentication Flow - Core 1.0](https://openid.net/specs/openid-client-initiated-backchannel-authentication-core-1_0.html) - * [The OAuth 2.0 Authorization Framework: JWT Secured Authorization Request (JAR)](https://datatracker.ietf.org/doc/draft-ietf-oauth-jwsreq/) - * [Financial-grade API: JWT Secured Authorization Response Mode for OAuth 2.0 (JARM)](https://openid.net/specs/openid-financial-api-jarm.html) - * [OAuth 2.0 Pushed Authorization Requests (PAR)](https://datatracker.ietf.org/doc/rfc9126/) - * [OAuth 2.0 Rich Authorization Requests (RAR)](https://datatracker.ietf.org/doc/draft-ietf-oauth-rar/) + type: object + DeliveryMode: + enum: + - PING + - POLL + - PUSH + type: string + Display: + description: | + The display mode which the client application requests by `display` request parameter. + When the authorization request does not have `display` request parameter, `PAGE` is set as the default value. - Standard client metadata included in Client Registration Request and Client Update Request (cf. - [OIDC DynReg](https://openid.net/specs/openid-connect-registration-1_0.html), [RFC 7591](https://www.rfc-editor.org/rfc/rfc7591.html) - and [RFC 7592](https://www.rfc-editor.org/rfc/rfc7592.html)) are, if supported by Authlete, stored - into Authlete database. On the other hand, unrecognized client metadata are discarded. + It is ensured that the value of `display` is one of the supported display modes which are specified + by `supportedDisplays` configuration parameter of the service. If the display mode specified by the + authorization request is not supported, an error is raised. - By listing up custom client metadata in advance by using this property (`supportedCustomClientMetadata`), - Authlete can recognize them and stores their values into the database. The stored custom client - metadata values can be referenced by `customMetadata`. - items: - type: string - type: array - tokenExpirationLinked: - description: | - The flag indicating whether the expiration date of an access token never exceeds that of the - corresponding refresh token. - - When a new access token is issued by a refresh token request (= a token request with `grant_type=refresh_token`), - the expiration date of the access token may exceed the expiration date of the corresponding - refresh token. This behavior itself is not wrong and may happen when `refreshTokenKept` is - `true` and/or when `refreshTokenDurationKept` is `true`. - - When this flag is `true`, the expiration date of an access token never exceeds that of the corresponding - refresh token regardless of the calculated duration based on other settings such as `accessTokenDuration`, - `accessTokenDuration` in `extension` and `access_token.duration` scope attribute. + Values for this property correspond to the values listed in + "[OpenID Connect Core 1.0, 3.1.2.1. Authentication Request](https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest), display". + enum: + - PAGE + - POPUP + - TOUCH + - WAP + type: string + DynamicScope: + example: + name: name + value: value + properties: + name: + description: The scope name. + type: string + value: + description: The scope value. + type: string + type: object + GrantType: + description: | + The grant type of the access token when the access token was created. + enum: + - AUTHORIZATION_CODE + - IMPLICIT + - PASSWORD + - CLIENT_CREDENTIALS + - REFRESH_TOKEN + - CIBA + - DEVICE_CODE + - TOKEN_EXCHANGE + - JWT_BEARER + type: string + JweAlg: + description: | + this is the 'alg' header value for encrypted JWT tokens. + Depending upon the context, this refers to key transport scheme to be used by the client and by the server. For instance: + - as `authorizationEncryptionAlg` value, it refers to the encoding algorithm used by server for transporting they keys on JARM objects + - as `requestEncryptionAlg` value, it refers to the expected key transport encoding algorithm that server expect from client when encrypting a Request Object + - as `idTokenEncryptionAlg` value, it refers to the algorithm used by the server to key transport of id_tokens - It is technically possible to set a value which is bigger than the duration of refresh tokens - as the duration of access tokens although it is strange. In the case, the duration of an access - token becomes longer than the duration of the refresh token which is issued together with the - access token. Even if the duration values are configured so, if this flag is `true`, the expiration - date of the access token does not exceed that of the refresh token. That is, the duration of - the access token will be shortened, and as a result, the access token and the refresh token - will have the same expiration date. - type: boolean - frontChannelRequestObjectEncryptionRequired: - description: | - The flag indicating whether encryption of request object is required when the request object - is passed through the front channel. + **Please note that some of the algorithms are more secure than others, some are not supported very well cross platforms and some (like RSA1_5) is known to be weak**. + enum: + - RSA1_5 + - RSA_OAEP + - RSA_OAEP_256 + - A128KW + - A192KW + - A256KW + - DIR + - ECDH_ES + - ECDH_ES_A128KW + - ECDH_ES_A192KW + - ECDH_ES_A256KW + - A128GCMKW + - A192GCMKW + - A256GCMKW + - PBES2_HS256_A128KW + - PBES2_HS384_A192KW + - PBES2_HS512_A256KW + type: string + JweEnc: + description: | + This is the encryption algorithm to be used when encrypting a JWT on client or server side. + Depending upon the context, this refers to encryption done by the client or by the server. For instance: + - as `authorizationEncryptionEnc` value, it refers to the encryption algorithm used by server when creating a JARM response + - as `requestEncryptionEnc` value, it refers to the expected encryption algorithm used by the client when encrypting a Request Object + - as `idTokenEncryptionEnc` value, it refers to the algorithm used by the server to encrypt id_tokens + enum: + - A128CBC_HS256 + - A192CBC_HS384 + - A256CBC_HS512 + - A128GCM + - A192GCM + - A256GCM + type: string + JwsAlg: + description: | + The signature algorithm for JWT. This value is represented on 'alg' attribute + of the header of JWT. - This flag does not affect the processing of request objects at the Pushed Authorization Request - Endpoint, which is defined in [OAuth 2.0 Pushed Authorization Requests](https://datatracker.ietf.org/doc/rfc9126/). - Unecrypted request objects are accepted at the endpoint even if this flag is `true`. + it's semantics depends upon where is this defined, for instance: + - as service accessTokenSignAlg value, it defines that access token are JWT and the algorithm used to sign it. Check your [KB article](https://kb.authlete.com/en/s/oauth-and-openid-connect/a/jwt-based-access-token). + - as client authorizationSignAlg value, it represents the signature algorithm used when [creating a JARM response](https://kb.authlete.com/en/s/oauth-and-openid-connect/a/enabling-jarm). + - or as client requestSignAlg value, it specifies which is the expected signature used by [client on a Request Object](https://kb.authlete.com/en/s/oauth-and-openid-connect/a/request-objects). + enum: + - NONE + - HS256 + - HS384 + - HS512 + - RS256 + - RS384 + - RS512 + - ES256 + - ES384 + - ES512 + - PS256 + - PS384 + - PS512 + - ES256K + - EdDSA + type: string + NamedUri: + example: + name: name + uri: https://openapi-generator.tech + properties: + name: + type: string + uri: + format: uri + type: string + type: object + Pair: + example: + value: value + key: key + properties: + key: + description: The key part. + type: string + value: + description: The value part. + type: string + type: object + Prompt: + description: | + The prompt that the UI displayed to the end-user must satisfy as the minimum level. This value comes from `prompt` request parameter. - This flag does not indicate whether a request object is always required. There is a different - flag, `requestObjectRequired`, for the purpose. See the description of `requestObjectRequired` - for details. + When the authorization request does not contain `prompt` request parameter, `CONSENT` is used as the default value. - Even if this flag is `false`, encryption of request object is required if the `frontChannelRequestObjectEncryptionRequired` - flag of the client is `true`. + See "[OpenID Connect Core 1.0, 3.1.2.1. Authentication Request](https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest), prompt" for `prompt` request parameter. + enum: + - NONE + - LOGIN + - CONSENT + - SELECT_ACCOUNT + type: string + Property: + example: + hidden: true + value: value + key: key + properties: + key: + description: The key part. + type: string + value: + description: The value part. + type: string + hidden: + description: |- + The flag to indicate whether this property hidden from or visible to client applications. + If `true`, this property is hidden from client applications. Otherwise, this property is visible to client applications. type: boolean - requestObjectEncryptionAlgMatchRequired: - description: | - The flag indicating whether the JWE alg of encrypted request object must match the `request_object_encryption_alg` - client metadata of the client that has sent the request object. - - The request_object_encryption_alg client metadata itself is defined in [OpenID Connect Dynamic - Client Registration 1.0](https://openid.net/specs/openid-connect-registration-1_0.html) as follows. - - > request_object_encryption_alg - > - > OPTIONAL. JWE [JWE] alg algorithm [JWA] the RP is declaring that it may use for encrypting - Request Objects sent to the OP. This parameter SHOULD be included when symmetric encryption - will be used, since this signals to the OP that a client_secret value needs to be returned - from which the symmetric key will be derived, that might not otherwise be returned. The RP - MAY still use other supported encryption algorithms or send unencrypted Request Objects, even - when this parameter is present. If both signing and encryption are requested, the Request Object - will be signed then encrypted, with the result being a Nested JWT, as defined in [JWT]. The - default, if omitted, is that the RP is not declaring whether it might encrypt any Request Objects. - - The point here is "The RP MAY still use other supported encryption algorithms or send unencrypted - Request Objects, even when this parameter is present." - - The Client's property that represents the client metadata is `requestEncryptionAlg`. See the - description of `requestEncryptionAlg` for details. - - Even if this flag is `false`, the match is required if the `requestObjectEncryptionAlgMatchRequired` - flag of the client is `true`. + type: object + ResponseType: + enum: + - NONE + - CODE + - TOKEN + - ID_TOKEN + - CODE_TOKEN + - CODE_ID_TOKEN + - ID_TOKEN_TOKEN + - CODE_ID_TOKEN_TOKEN + type: string + Scope: + example: + name: name + description: description + attributes: + - value: value + key: key + - value: value + key: key + defaultEntry: true + descriptions: + - tag: tag + value: value + - tag: tag + value: value + properties: + name: + description: The name of the scope. + type: string + defaultEntry: + description: '`true` to mark the scope as default. Scopes marked as default + are regarded as requested when an authorization request from a client + application does not contain scope request parameter. ' type: boolean - requestObjectEncryptionEncMatchRequired: - description: | - The flag indicating whether the JWE `enc` of encrypted request object must match the `request_object_encryption_enc` - client metadata of the client that has sent the request object. - - The `request_object_encryption_enc` client metadata itself is defined in [OpenID Connect Dynamic - Client Registration 1.0](https://openid.net/specs/openid-connect-registration-1_0.html) as follows. - - > request_object_encryption_enc - > - > OPTIONAL. JWE enc algorithm [JWA] the RP is declaring that it may use for encrypting Request - Objects sent to the OP. If request_object_encryption_alg is specified, the default for this - value is A128CBC-HS256. When request_object_encryption_enc is included, request_object_encryption_alg - MUST also be provided. - - The Client's property that represents the client metadata is `requestEncryptionEnc`. See the - description of `requestEncryptionEnc` for details. - - Even if this flag is false, the match is required if the `requestObjectEncryptionEncMatchRequired` - flag is `true`. - type: boolean - hsmEnabled: - description: | - The flag indicating whether HSM (Hardware Security Module) support is enabled for this service. - - When this flag is `false`, keys managed in HSMs are not used even if they exist. In addition, - `/api/hsk/*` APIs reject all requests. - - Even if this flag is `true`, HSM-related features do not work if the configuration of the Authlete - server you are using does not support HSM. - type: boolean - hsks: - description: | - The information about keys managed on HSMs (Hardware Security Modules). - - This `hsks` property is output only, meaning that `hsks` in requests to `/api/service/create` - API and `/api/service/update` API do not have any effect. The contents of this property is controlled - only by `/api/hsk/*` APIs. - items: - $ref: '#/components/schemas/Hsk' - type: array - grantManagementEndpoint: - description: | - The URL of the grant management endpoint. - type: string - grantManagementActionRequired: - description: | - The flag indicating whether every authorization request (and any request serving as an authorization - request such as CIBA backchannel authentication request and device authorization request) must - include the `grant_management_action` request parameter. - - This property corresponds to the `grant_management_action_required` server metadata defined - in [Grant Management for OAuth 2.0](https://openid.net/specs/fapi-grant-management.html). - - Note that setting true to this property will result in blocking all public clients because - the specification requires that grant management be usable only by confidential clients for - security reasons. - type: boolean - unauthorizedOnClientConfigSupported: - description: | - The flag indicating whether Authlete's `/api/client/registration` API uses `UNAUTHORIZED` as - a value of the `action` response parameter when appropriate. - - The `UNAUTHORIZED` enum value was initially not defined as a possible value of the `action` - parameter in an `/api/client/registration` API response. This means that implementations of - client `configuration` endpoint were not able to conform to [RFC 7592](https://www.rfc-editor.org/rfc/rfc7592.html) - strictly. - - For backward compatibility (to avoid breaking running systems), Authlete's `/api/client/registration` - API does not return the `UNAUTHORIZED` enum value if this flag is not turned on. - - The steps an existing implementation of client configuration endpoint has to do in order to - conform to the requirement related to "401 Unauthorized" are as follows. - - 1. Update the Authlete library (e.g. authlete-java-common) your system is using. - 2. Update your implementation of client configuration endpoint so that it can handle the - `UNAUTHORIZED` action. - 3. Turn on this `unauthorizedOnClientConfigSupported` flag. - type: boolean - dcrScopeUsedAsRequestable: - description: | - The flag indicating whether the `scope` request parameter in dynamic client registration and - update requests (RFC 7591 and RFC 7592) is used as scopes that the client can request. - - Limiting the range of scopes that a client can request is achieved by listing scopes in the - `client.extension.requestableScopes` property and setting the `client.extension.requestableScopesEnabled` - property to `true`. This feature is called "requestable scopes". - - This property affects behaviors of `/api/client/registration` and other family APIs. - type: boolean - endSessionEndpoint: - description: | - The endpoint for clients ending the sessions. - - A URL that starts with `https://` and has no fragment component. For example, `https://example.com/auth/endSession`. - - The value of this property is used as `end_session_endpoint` property in the [OpenID Provider - Metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). - format: uri - type: string - loopbackRedirectionUriVariable: - description: | - The flag indicating whether the port number component of redirection URIs can be variable when - the host component indicates loopback. - - When this flag is `true`, if the host component of a redirection URI specified in an authorization - request indicates loopback (to be precise, when the host component is localhost, `127.0.0.1` - or `::1`), the port number component is ignored when the specified redirection URI is compared - to pre-registered ones. This behavior is described in [7.3. Loopback Interface Redirection]( - https://www.rfc-editor.org/rfc/rfc8252.html#section-7.3) of [RFC 8252 OAuth 2.0](https://www.rfc-editor.org/rfc/rfc8252.html) - for Native Apps. - - [3.1.2.3. Dynamic Configuration](https://www.rfc-editor.org/rfc/rfc6749.html#section-3.1.2.3) - of [RFC 6749](https://www.rfc-editor.org/rfc/rfc6749.html) states _"If the client registration - included the full redirection URI, the authorization server MUST compare the two URIs using - simple string comparison as defined in [RFC3986] Section 6.2.1."_ Also, the description of - `redirect_uri` in [3.1.2.1. Authentication Request](https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest) - of [OpenID Connect Core 1.0](https://openid.net/specs/openid-connect-core-1_0.html) states - _"This URI MUST exactly match one of the Redirection URI values for the Client pre-registered - at the OpenID Provider, with the matching performed as described in Section 6.2.1 of [RFC3986] - (**Simple String Comparison**)."_ These "Simple String Comparison" requirements are preceded - by this flag. That is, even when the conditions described in RFC 6749 and OpenID Connect Core 1.0 - are satisfied, the port number component of loopback redirection URIs can be variable when this - flag is `true`. - - [8.3. Loopback Redirect Considerations](https://www.rfc-editor.org/rfc/rfc8252.html#section-8.3) - of [RFC 8252](https://www.rfc-editor.org/rfc/rfc8252.html) states as follows. - - > While redirect URIs using localhost (i.e., `"http://localhost:{port}/{path}"`) function - similarly to loopback IP redirects described in Section 7.3, the use of localhost is NOT RECOMMENDED. - Specifying a redirect URI with the loopback IP literal rather than localhost avoids inadvertently - listening on network interfaces other than the loopback interface. It is also less susceptible - to client-side firewalls and misconfigured host name resolution on the user's device. - - However, Authlete allows the port number component to be variable in the case of `localhost`, - too. It is left to client applications whether they use `localhost` or a literal loopback IP - address (`127.0.0.1` for IPv4 or `::1` for IPv6). - - Section 7.3 and Section 8.3 of [RFC 8252](https://www.rfc-editor.org/rfc/rfc8252.html) state - that loopback redirection URIs use the `"http"` scheme, but Authlete allows the port number - component to be variable in other cases (e.g. in the case of the `"https"` scheme), too. - type: boolean - requestObjectAudienceChecked: - description: | - The flag indicating whether Authlete checks whether the `aud` claim of request objects matches - the issuer identifier of this service. - - [Section 6.1. Passing a Request Object by Value](https://openid.net/specs/openid-connect-core-1_0.html#JWTRequests) - of [OpenID Connect Core 1.0](https://openid.net/specs/openid-connect-core-1_0.html) has the following - statement. - - > The `aud` value SHOULD be or include the OP's Issuer Identifier URL. - - Likewise, [Section 4. Request Object](https://www.rfc-editor.org/rfc/rfc9101.html#section-4) of - [RFC 9101](https://www.rfc-editor.org/rfc/rfc9101.html) (The OAuth 2.0 Authorization Framework: - JWT-Secured Authorization Request (JAR)) has the following statement. - - > The value of aud should be the value of the authorization server (AS) issuer, as defined in - [RFC 8414](https://www.rfc-editor.org/rfc/rfc8414.html). - - As excerpted above, validation on the `aud` claim of request objects is optional. However, if - this flag is turned on, Authlete checks whether the `aud` claim of request objects matches the issuer - identifier of this service and raises an error if they are different. - type: boolean - accessTokenForExternalAttachmentEmbedded: - description: | - The flag indicating whether Authlete generates access tokens for - external attachments and embeds them in ID tokens and userinfo - responses. - type: boolean - authorityHints: - description: | - Identifiers of entities that can issue entity statements for this - service. This property corresponds to the `authority_hints` - property that appears in a self-signed entity statement that is - defined in OpenID Connect Federation 1.0. - items: - type: string - type: array - federationEnabled: - description: | - flag indicating whether this service supports OpenID Connect Federation 1 - type: boolean - federationJwks: - description: | - JWK Set document containing keys that are used to sign (1) self-signed - entity statement of this service and (2) the response from - `signed_jwks_uri`. - type: string - federationSignatureKeyId: - description: | - A key ID to identify a JWK used to sign the entity configuration and - the signed JWK Set. - type: string - federationConfigurationDuration: - description: | - The duration of the entity configuration in seconds. - type: integer - federationRegistrationEndpoint: - description: | - The URI of the federation registration endpoint. This property corresponds - to the `federation_registration_endpoint` server metadata that is - defined in OpenID Connect Federation 1.0. - type: string - organizationName: - description: | - The human-readable name representing the organization that operates - this service. This property corresponds to the `organization_name` - server metadata that is defined in OpenID Connect Federation 1.0. - type: string - predefinedTransformedClaims: - description: | - The transformed claims predefined by this service in JSON format. - This property corresponds to the `transformed_claims_predefined` - server metadata. - type: string - refreshTokenIdempotent: - description: | - flag indicating whether refresh token requests with the same - refresh token can be made multiple times in quick succession and - they can obtain the same renewed refresh token within the short - period. - type: boolean - signedJwksUri: - description: | - The URI of the endpoint that returns this service's JWK Set document in - the JWT format. This property corresponds to the `signed_jwks_uri` - server metadata defined in OpenID Connect Federation 1.0. + description: + description: The description about the scope. type: string - supportedAttachments: - description: | - Supported attachment types. This property corresponds to the {@code - attachments_supported} server metadata which was added by the third - implementer's draft of OpenID Connect for Identity Assurance 1.0. - items: - $ref: '#/components/schemas/attachment_type' - type: array - supportedDigestAlgorithms: - description: | - Supported algorithms used to compute digest values of external - attachments. This property corresponds to the - `digest_algorithms_supported` server metadata which was added - by the third implementer's draft of OpenID Connect for Identity - Assurance 1.0. + descriptions: + description: The descriptions about this scope in multiple languages. items: - type: string + $ref: '#/components/schemas/tagged_value' type: array - supportedDocuments: - description: | - Document types supported by this service. This property corresponds - to the `documents_supported` server metadata. + attributes: + description: The attributes of the scope. items: - type: string + $ref: '#/components/schemas/Pair' type: array - supportedDocumentsMethods: - description: | - validation and verification processes supported by this service. - This property corresponds to the `documents_methods_supported` - server metadata. - - The third implementer's draft of [OpenID Connect for Identity Assurance 1.0](https://openid.net/specs/openid-connect-4-identity-assurance-1_0.html) - renamed the - `id_documents_verification_methods_supported` server metadata to - `documents_methods_supported`. - items: - type: string - type: array - supportedDocumentsValidationMethods: - description: | - Document validation methods supported by this service. This property - corresponds to the `documents_validation_methods_supported` server - metadata which was added by the third implementer's draft of If the client omits the scope parameter when requesting authorization, the authorization server + MUST either process the request using a pre-defined default value or fail the request indicating an invalid scope. + + However, if you interpret *"the default scope set exists but is empty"* as *"the default scope set does not exist"* + and want to strictly conform to the requirement above, this flag has to be `true`. + type: boolean + idTokenDuration: + description: | + 'The duration of [ID token](https://openid.net/specs/openid-connect-core-1_0.html#IDToken)s + in seconds. This value is used to calculate the value of `exp` claim in an ID token.' + format: int64 + type: integer + allowableClockSkew: + description: | + The allowable clock skew between the server and clients in seconds. + + The clock skew is taken into consideration when time-related claims in a JWT (e.g. `exp`, `iat`, `nbf`) are verified. + format: int32 + type: integer + supportedClaimTypes: + description: | + Claim types supported by the service. Valid values are listed in Claim Type. Note that Authlete + currently doesn't provide any API to help implementations for `AGGREGATED` and `DISTRIBUTED`. + + The value of this property is used as `claim_types_supported` property in the [OpenID Provider + Metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). + items: + $ref: '#/components/schemas/claim_type' + type: array + supportedClaimLocales: + description: | + Claim locales that the service supports. Each element is a language tag defined in [RFC 5646](https://tools.ietf.org/html/rfc5646). + For example, `en-US` and `ja-JP`. See [OpenID Connect Core 1.0, 5.2. Languages and Scripts](https://openid.net/specs/openid-connect-core-1_0.html#ClaimsLanguagesAndScripts) + for details. + + The value of this property is used as `claims_locales_supported` property in the + [OpenID Provider Metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). + items: + type: string + type: array + supportedClaims: + description: | + Claim names that the service supports. The standard claim names listed in [OpenID Connect Core 1.0, + 5.1. Standard Claim](https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims) should + be supported. The following is the list of standard claims. + + - `sub` + - `name` + - `given_name` + - `family_name` + - `middle_name` + - `nickname` + - `preferred_username` + - `profile` + - `picture` + - `website` + - `email` + - `email_verified` + - `gender` + - `birthdate` + - `zoneinfo` + - `locale` + - `phone_number` + - `phone_number_verified` + - `address` + - `updated_at` + + The value of this property is used as `claims_supported` property in the [OpenID Provider + Metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). + + The service may support its original claim names. See [OpenID Connect Core 1.0, 5.1.2. Additional + Claims](https://openid.net/specs/openid-connect-core-1_0.html#AdditionalClaims). + items: + type: string + type: array + claimShortcutRestrictive: + description: | + The flag indicating whether claims specified by shortcut scopes (e.g. `profile`) are included + in the issued ID token only when no access token is issued. + + To strictly conform to the description below excerpted from [OpenID Connect Core 1.0 Section + 5.4](https://openid.net/specs/openid-connect-core-1_0.html#ScopeClaims), this flag has to be `true`. + + > The Claims requested by the profile, email, address, and phone scope values are returned from + the UserInfo Endpoint, as described in Section 5.3.2, when a response_type value is used that + results in an Access Token being issued. However, when no Access Token is issued (which is the + case for the response_type value id_token), the resulting Claims are returned in the ID Token. + type: boolean + jwksUri: + description: | + The URL of the service's [JSON Web Key Set](https://tools.ietf.org/html/rfc7517) document. For + example, `http://example.com/auth/jwks`. + + Client applications accesses this URL (1) to get the public key of the service to validate the + signature of an ID token issued by the service and (2) to get the public key of the service to + encrypt an request object of the client application. See [OpenID Connect Core 1.0, 10. Signatures + and Encryption](https://openid.net/specs/openid-connect-core-1_0.html#SigEnc) for details. + + The value of this property is used as `jwks_uri` property in the [OpenID Provider Metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). + format: uri + type: string + directJwksEndpointEnabled: + description: | + 'The flag to indicate whether the direct jwks endpoint is enabled or not. The path of the endpoint + is `/api/service/jwks/get/direct/service-api-key`. ' + type: boolean + jwks: + description: | + The content of the service's [JSON Web Key Set](https://tools.ietf.org/html/rfc7517) document. + + If this property is not `null` in a `/service/create` request or a `/service/update` request, + Authlete hosts the content in the database. This property must not be `null` and must contain + pairs of public/private keys if the service wants to support asymmetric signatures for ID tokens + and asymmetric encryption for request objects. See [OpenID Connect Core 1.0, 10. Signatures and + Encryption](https://openid.net/specs/openid-connect-core-1_0.html#SigEnc) for details. + type: string + idTokenSignatureKeyId: + description: | + The key ID to identify a JWK used for ID token signature using an asymmetric key. + + A JWK Set can be registered as a property of a Service. A JWK Set can contain 0 or more JWKs + (See [RFC 7517](https://tools.ietf.org/html/rfc7517) for details about JWK). Authlete Server has + to pick up one JWK for signature from the JWK Set when it generates an ID token and signature + using an asymmetric key is required. Authlete Server searches the registered JWK Set for a JWK + which satisfies conditions for ID token signature. If the number of JWK candidates which satisfy + the conditions is 1, there is no problem. On the other hand, if there exist multiple candidates, + a [Key ID](https://tools.ietf.org/html/rfc7517#section-4.5) is needed to be specified so that + Authlete Server can pick up one JWK from among the JWK candidates. + + This `idTokenSignatureKeyId` property exists for the purpose described above. For key rotation + (OpenID Connect Core 1.0, [10.1.1. Rotation of Asymmetric Signing Keys](http://openid.net/specs/openid-connect-core-1_0.html#RotateSigKeys)), + this mechanism is needed. + type: string + userInfoSignatureKeyId: + description: | + The key ID to identify a JWK used for user info signature using an asymmetric key. + + A JWK Set can be registered as a property of a Service. A JWK Set can contain 0 or more JWKs + (See [RFC 7517](https://tools.ietf.org/html/rfc7517) for details about JWK). Authlete Server has + to pick up one JWK for signature from the JWK Set when it is required to sign user info (which + is returned from [userinfo endpoint](http://openid.net/specs/openid-connect-core-1_0.html#UserInfo)) + using an asymmetric key. Authlete Server searches the registered JWK Set for a JWK which satisfies + conditions for user info signature. If the number of JWK candidates which satisfy the conditions + is 1, there is no problem. On the other hand, if there exist multiple candidates, a [Key ID](https://tools.ietf.org/html/rfc7517#section-4.5) + is needed to be specified so that Authlete Server can pick up one JWK from among the JWK candidates. + + This `userInfoSignatureKeyId` property exists for the purpose described above. For key rotation + (OpenID Connect Core 1.0, [10.1.1. Rotation of Asymmetric Signing Keys](http://openid.net/specs/openid-connect-core-1_0.html#RotateSigKeys)), + this mechanism is needed. + type: string + authorizationSignatureKeyId: + description: | + The key ID to identify a JWK used for signing authorization responses using an asymmetric key. + + [Financial-grade API: JWT Secured Authorization Response Mode for OAuth 2.0 (JARM)](https://openid.net/specs/openid-financial-api-jarm.html) + defines new values for the `response_mode` request parameter. They are `query.jwt`, `fragment.jwt`, + `form_post.jwt` and `jwt`. If one of them is specified as the response mode, response parameters + from the authorization endpoint will be packed into a JWT. This property is used to compute the + value of the `exp` claim of the JWT. + + Authlete Server searches the JWK Set for a JWK which satisfies conditions for authorization response + signature. If the number of JWK candidates which satisfy the conditions is 1, there is no problem. + On the other hand, if there exist multiple candidates, a Key ID is needed to be specified so that + Authlete Server can pick up one JWK from among the JWK candidates. This property exists to specify + the key ID. + type: string + userInfoEndpoint: + description: | + The [user info endpoint](http://openid.net/specs/openid-connect-core-1_0.html#UserInfo) of the + service. A URL that starts with `https://`. For example, `https://example.com/auth/userinfo`. + + The value of this property is used as `userinfo_endpoint` property in the [OpenID Provider Metadata](http://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). + format: uri + type: string + directUserInfoEndpointEnabled: + description: | + The flag to indicate whether the direct userinfo endpoint is enabled or not. The path + of the endpoint is `/api/auth/userinfo/direct/service-api-key`. + type: boolean + dynamicRegistrationSupported: + description: | + The boolean flag which indicates whether the [OAuth 2.0 Dynamic Client Registration Protocol](https://tools.ietf.org/html/rfc7591) + is supported. + type: boolean + registrationEndpoint: + description: | + The [registration endpoint](http://openid.net/specs/openid-connect-registration-1_0.html#ClientRegistration) + of the service. A URL that starts with `https://`. For example, `https://example.com/auth/registration`. + + The value of this property is used as `registration_endpoint` property in the [OpenID Provider Metadata](http://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). + format: uri + type: string + registrationManagementEndpoint: + description: | + The URI of the registration management endpoint. If dynamic client registration is supported, + and this is set, this URI will be used as the basis of the client's management endpoint by appending + `/clientid}/` to it as a path element. If this is unset, the value of `registrationEndpoint` will + be used as the URI base instead. + format: uri + type: string + policyUri: + description: | + The URL of the "Policy" of the service. + + The value of this property is used as `op_policy_uri` property in the [OpenID Provider Metadata](http://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). + format: uri + type: string + tosUri: + description: | + The URL of the "Terms Of Service" of the service. + + The value of this property is used as `op_tos_uri` property in the [OpenID Provider Metadata](http://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). + format: uri + type: string + serviceDocumentation: + description: | + The URL of a page where documents for developers can be found. + + The value of this property is used as `service_documentation` property in the [OpenID Provider Metadata](http://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). + format: uri + type: string + backchannelAuthenticationEndpoint: + description: | + The URI of backchannel authentication endpoint, which is defined in the specification of [CIBA + (Client Initiated Backchannel Authentication)](https://openid.net/specs/openid-client-initiated-backchannel-authentication-core-1_0.html). + format: uri + type: string + supportedBackchannelTokenDeliveryModes: + description: | + The supported backchannel token delivery modes. This property corresponds to the `backchannel_token_delivery_modes_supported` + metadata. + + Backchannel token delivery modes are defined in the specification of [CIBA (Client Initiated + Backchannel Authentication)](https://openid.net/specs/openid-client-initiated-backchannel-authentication-core-1_0.html). + items: + $ref: '#/components/schemas/delivery_mode' + type: array + backchannelAuthReqIdDuration: + description: | + The duration of backchannel authentication request IDs issued from the backchannel authentication + endpoint in seconds. This is used as the value of the `expires_in` property in responses from + the backchannel authentication endpoint. + format: int32 + type: integer + backchannelPollingInterval: + description: | + The minimum interval between polling requests to the token endpoint from client applications in + seconds. This is used as the value of the `interval` property in responses from the backchannel + authentication endpoint. + format: int32 + type: integer + backchannelUserCodeParameterSupported: + description: | + The boolean flag which indicates whether the `user_code` request parameter is supported at the + backchannel authentication endpoint. This property corresponds to the `backchannel_user_code_parameter_supported` + metadata. + type: boolean + backchannelBindingMessageRequiredInFapi: + description: | + The flag to indicate whether the `binding_message` request parameter is always required whenever + a backchannel authentication request is judged as a request for Financial-grade API. + + The FAPI-CIBA profile requires that the authorization server _"shall ensure unique authorization + context exists in the authorization request or require a `binding_message` in the authorization + request"_ (FAPI-CIBA, 5.2.2, 2). The simplest way to fulfill this requirement is to set this property + to `true`. + + If this property is set to `false`, the `binding_message` request parameter remains optional + even in FAPI context, but in exchange, your authorization server must implement a custom mechanism + that ensures each backchannel authentication request has unique context. + type: boolean + deviceAuthorizationEndpoint: + description: | + The URI of the device authorization endpoint. + + Device authorization endpoint is defined in the specification of OAuth 2.0 Device Authorization Grant. + format: uri + type: string + deviceVerificationUri: + description: | + The verification URI for the device flow. This URI is used as the value of the `verification_uri` + parameter in responses from the device authorization endpoint. + format: uri + type: string + deviceVerificationUriComplete: + description: | + The verification URI for the device flow with a placeholder for a user code. This URI is used + to build the value of the `verification_uri_complete` parameter in responses from the device + authorization endpoint. + + It is expected that the URI contains a fixed string `USER_CODE` somewhere as a placeholder for + a user code. For example, like the following. + + `https://example.com/device?user\_code=USER\_CODE` + + The fixed string is replaced with an actual user code when Authlete builds a verification URI + with a user code for the `verification_uri_complete` parameter. + + If this URI is not set, the `verification_uri_complete` parameter won't appear in device authorization + responses. + format: uri + type: string + deviceFlowCodeDuration: + description: | + The duration of device verification codes and end-user verification codes issued from the device + authorization endpoint in seconds. This is used as the value of the `expires_in` property in responses + from the device authorization endpoint. + format: int32 + type: integer + deviceFlowPollingInterval: + description: | + The minimum interval between polling requests to the token endpoint from client applications in + seconds in device flow. This is used as the value of the `interval` property in responses from + the device authorization endpoint. + format: int32 + type: integer + userCodeCharset: + $ref: '#/components/schemas/user_code_charset' + userCodeLength: + description: | + The length of end-user verification codes (`user_code`) for Device Flow. + format: int32 + type: integer + supportedTrustFrameworks: + description: | + Trust frameworks supported by this service. This corresponds to the `trust_frameworks_supported` + [metadata](https://openid.net/specs/openid-connect-4-identity-assurance-1_0.html#rfc.section.7). + items: + type: string + type: array + supportedEvidence: + description: | + Evidence supported by this service. This corresponds to the `evidence_supported` [metadata](https://openid.net/specs/openid-connect-4-identity-assurance-1_0.html#rfc.section.7). + items: + type: string + type: array + supportedIdentityDocuments: + description: | + Identity documents supported by this service. This corresponds to the `id_documents_supported` + [metadata](https://openid.net/specs/openid-connect-4-identity-assurance-1_0.html#rfc.section.7). + items: + type: string + type: array + supportedVerificationMethods: + description: | + Verification methods supported by this service. This corresponds to the `id_documents_verification_methods_supported` + [metadata](https://openid.net/specs/openid-connect-4-identity-assurance-1_0.html#rfc.section.7). + items: + type: string + type: array + supportedVerifiedClaims: + description: | + Verified claims supported by this service. This corresponds to the `claims_in_verified_claims_supported` + [metadata](https://openid.net/specs/openid-connect-4-identity-assurance-1_0.html#rfc.section.7). + items: + type: string + type: array + verifiedClaimsValidationSchemaSet: + $ref: '#/components/schemas/verified_claims_validation_schema' + attributes: + description: | + The attributes of this service. + items: + $ref: '#/components/schemas/Pair' + type: array + nbfOptional: + description: | + The flag indicating whether the nbf claim in the request object is optional even when the authorization + request is regarded as a FAPI-Part2 request. + + The final version of Financial-grade API was approved in January, 2021. The Part 2 of the final + version has new requirements on lifetime of request objects. They require that request objects + contain an `nbf` claim and the lifetime computed by `exp` - `nbf` be no longer than 60 minutes. + + Therefore, when an authorization request is regarded as a FAPI-Part2 request, the request object + used in the authorization request must contain an nbf claim. Otherwise, the authorization server + rejects the authorization request. + + When this flag is `true`, the `nbf` claim is treated as an optional claim even when the authorization + request is regarded as a FAPI-Part2 request. That is, the authorization server does not perform + the validation on lifetime of the request object. + + Skipping the validation is a violation of the FAPI specification. The reason why this flag has + been prepared nevertheless is that the new requirements (which do not exist in the Implementer's + Draft 2 released in October, 2018) have big impacts on deployed implementations of client + applications and Authlete thinks there should be a mechanism whereby to make the migration + from ID2 to Final smooth without breaking live systems. + type: boolean + issSuppressed: + description: | + The flag indicating whether generation of the iss response parameter is suppressed. + + "OAuth 2.0 Authorization Server Issuer Identifier in Authorization Response" has defined a new + authorization response parameter, `iss`, as a countermeasure for a certain type of mix-up attacks. + + The specification requires that the `iss` response parameter always be included in authorization + responses unless JARM (JWT Secured Authorization Response Mode) is used. + + When this flag is `true`, the authorization server does not include the `iss` response parameter + in authorization responses. By turning this flag on and off, developers of client applications + can experiment the mix-up attack and the effect of the `iss` response parameter. + + Note that this flag should not be `true` in production environment unless there are special + reasons for it. + type: boolean + supportedCustomClientMetadata: + description: | + custom client metadata supported by this service. + + Standard specifications define client metadata as necessary. The following are such examples. + + * [OpenID Connect Dynamic Client Registration 1.0](https://openid.net/specs/openid-connect-registration-1_0.html) + * [RFC 7591 OAuth 2.0 Dynamic Client Registration Protocol](https://www.rfc-editor.org/rfc/rfc7591.html) + * [RFC 8705 OAuth 2.0 Mutual-TLS Client Authentication and Certificate-Bound Access Tokens](https://www.rfc-editor.org/rfc/rfc8705.html) + * [OpenID Connect Client-Initiated Backchannel Authentication Flow - Core 1.0](https://openid.net/specs/openid-client-initiated-backchannel-authentication-core-1_0.html) + * [The OAuth 2.0 Authorization Framework: JWT Secured Authorization Request (JAR)](https://datatracker.ietf.org/doc/draft-ietf-oauth-jwsreq/) + * [Financial-grade API: JWT Secured Authorization Response Mode for OAuth 2.0 (JARM)](https://openid.net/specs/openid-financial-api-jarm.html) + * [OAuth 2.0 Pushed Authorization Requests (PAR)](https://datatracker.ietf.org/doc/rfc9126/) + * [OAuth 2.0 Rich Authorization Requests (RAR)](https://datatracker.ietf.org/doc/draft-ietf-oauth-rar/) + + Standard client metadata included in Client Registration Request and Client Update Request (cf. + [OIDC DynReg](https://openid.net/specs/openid-connect-registration-1_0.html), [RFC 7591](https://www.rfc-editor.org/rfc/rfc7591.html) + and [RFC 7592](https://www.rfc-editor.org/rfc/rfc7592.html)) are, if supported by Authlete, stored + into Authlete database. On the other hand, unrecognized client metadata are discarded. + + By listing up custom client metadata in advance by using this property (`supportedCustomClientMetadata`), + Authlete can recognize them and stores their values into the database. The stored custom client + metadata values can be referenced by `customMetadata`. + items: + type: string + type: array + tokenExpirationLinked: + description: | + The flag indicating whether the expiration date of an access token never exceeds that of the + corresponding refresh token. + + When a new access token is issued by a refresh token request (= a token request with `grant_type=refresh_token`), + the expiration date of the access token may exceed the expiration date of the corresponding + refresh token. This behavior itself is not wrong and may happen when `refreshTokenKept` is + `true` and/or when `refreshTokenDurationKept` is `true`. + + When this flag is `true`, the expiration date of an access token never exceeds that of the corresponding + refresh token regardless of the calculated duration based on other settings such as `accessTokenDuration`, + `accessTokenDuration` in `extension` and `access_token.duration` scope attribute. + + It is technically possible to set a value which is bigger than the duration of refresh tokens + as the duration of access tokens although it is strange. In the case, the duration of an access + token becomes longer than the duration of the refresh token which is issued together with the + access token. Even if the duration values are configured so, if this flag is `true`, the expiration + date of the access token does not exceed that of the refresh token. That is, the duration of + the access token will be shortened, and as a result, the access token and the refresh token + will have the same expiration date. + type: boolean + frontChannelRequestObjectEncryptionRequired: + description: | + The flag indicating whether encryption of request object is required when the request object + is passed through the front channel. + + This flag does not affect the processing of request objects at the Pushed Authorization Request + Endpoint, which is defined in [OAuth 2.0 Pushed Authorization Requests](https://datatracker.ietf.org/doc/rfc9126/). + Unecrypted request objects are accepted at the endpoint even if this flag is `true`. + + This flag does not indicate whether a request object is always required. There is a different + flag, `requestObjectRequired`, for the purpose. See the description of `requestObjectRequired` + for details. + + Even if this flag is `false`, encryption of request object is required if the `frontChannelRequestObjectEncryptionRequired` + flag of the client is `true`. + type: boolean + requestObjectEncryptionAlgMatchRequired: + description: | + The flag indicating whether the JWE alg of encrypted request object must match the `request_object_encryption_alg` + client metadata of the client that has sent the request object. + + The request_object_encryption_alg client metadata itself is defined in [OpenID Connect Dynamic + Client Registration 1.0](https://openid.net/specs/openid-connect-registration-1_0.html) as follows. + + > request_object_encryption_alg + > + > OPTIONAL. JWE [JWE] alg algorithm [JWA] the RP is declaring that it may use for encrypting + Request Objects sent to the OP. This parameter SHOULD be included when symmetric encryption + will be used, since this signals to the OP that a client_secret value needs to be returned + from which the symmetric key will be derived, that might not otherwise be returned. The RP + MAY still use other supported encryption algorithms or send unencrypted Request Objects, even + when this parameter is present. If both signing and encryption are requested, the Request Object + will be signed then encrypted, with the result being a Nested JWT, as defined in [JWT]. The + default, if omitted, is that the RP is not declaring whether it might encrypt any Request Objects. + + The point here is "The RP MAY still use other supported encryption algorithms or send unencrypted + Request Objects, even when this parameter is present." + + The Client's property that represents the client metadata is `requestEncryptionAlg`. See the + description of `requestEncryptionAlg` for details. + + Even if this flag is `false`, the match is required if the `requestObjectEncryptionAlgMatchRequired` + flag of the client is `true`. + type: boolean + requestObjectEncryptionEncMatchRequired: + description: | + The flag indicating whether the JWE `enc` of encrypted request object must match the `request_object_encryption_enc` + client metadata of the client that has sent the request object. + + The `request_object_encryption_enc` client metadata itself is defined in [OpenID Connect Dynamic + Client Registration 1.0](https://openid.net/specs/openid-connect-registration-1_0.html) as follows. + + > request_object_encryption_enc + > + > OPTIONAL. JWE enc algorithm [JWA] the RP is declaring that it may use for encrypting Request + Objects sent to the OP. If request_object_encryption_alg is specified, the default for this + value is A128CBC-HS256. When request_object_encryption_enc is included, request_object_encryption_alg + MUST also be provided. + + The Client's property that represents the client metadata is `requestEncryptionEnc`. See the + description of `requestEncryptionEnc` for details. + + Even if this flag is false, the match is required if the `requestObjectEncryptionEncMatchRequired` + flag is `true`. + type: boolean + hsmEnabled: + description: | + The flag indicating whether HSM (Hardware Security Module) support is enabled for this service. + + When this flag is `false`, keys managed in HSMs are not used even if they exist. In addition, + `/api/hsk/*` APIs reject all requests. + + Even if this flag is `true`, HSM-related features do not work if the configuration of the Authlete + server you are using does not support HSM. + type: boolean + hsks: + description: | + The information about keys managed on HSMs (Hardware Security Modules). + + This `hsks` property is output only, meaning that `hsks` in requests to `/api/service/create` + API and `/api/service/update` API do not have any effect. The contents of this property is controlled + only by `/api/hsk/*` APIs. + items: + $ref: '#/components/schemas/Hsk' + type: array + grantManagementEndpoint: + description: | + The URL of the grant management endpoint. + type: string + grantManagementActionRequired: + description: | + The flag indicating whether every authorization request (and any request serving as an authorization + request such as CIBA backchannel authentication request and device authorization request) must + include the `grant_management_action` request parameter. + + This property corresponds to the `grant_management_action_required` server metadata defined + in [Grant Management for OAuth 2.0](https://openid.net/specs/fapi-grant-management.html). + + Note that setting true to this property will result in blocking all public clients because + the specification requires that grant management be usable only by confidential clients for + security reasons. + type: boolean + unauthorizedOnClientConfigSupported: + description: | + The flag indicating whether Authlete's `/api/client/registration` API uses `UNAUTHORIZED` as + a value of the `action` response parameter when appropriate. + + The `UNAUTHORIZED` enum value was initially not defined as a possible value of the `action` + parameter in an `/api/client/registration` API response. This means that implementations of + client `configuration` endpoint were not able to conform to [RFC 7592](https://www.rfc-editor.org/rfc/rfc7592.html) + strictly. + + For backward compatibility (to avoid breaking running systems), Authlete's `/api/client/registration` + API does not return the `UNAUTHORIZED` enum value if this flag is not turned on. + + The steps an existing implementation of client configuration endpoint has to do in order to + conform to the requirement related to "401 Unauthorized" are as follows. + + 1. Update the Authlete library (e.g. authlete-java-common) your system is using. + 2. Update your implementation of client configuration endpoint so that it can handle the + `UNAUTHORIZED` action. + 3. Turn on this `unauthorizedOnClientConfigSupported` flag. + type: boolean + dcrScopeUsedAsRequestable: + description: | + The flag indicating whether the `scope` request parameter in dynamic client registration and + update requests (RFC 7591 and RFC 7592) is used as scopes that the client can request. + + Limiting the range of scopes that a client can request is achieved by listing scopes in the + `client.extension.requestableScopes` property and setting the `client.extension.requestableScopesEnabled` + property to `true`. This feature is called "requestable scopes". + + This property affects behaviors of `/api/client/registration` and other family APIs. + type: boolean + endSessionEndpoint: + description: | + The endpoint for clients ending the sessions. + + A URL that starts with `https://` and has no fragment component. For example, `https://example.com/auth/endSession`. + + The value of this property is used as `end_session_endpoint` property in the [OpenID Provider + Metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). + format: uri + type: string + loopbackRedirectionUriVariable: + description: | + The flag indicating whether the port number component of redirection URIs can be variable when + the host component indicates loopback. + + When this flag is `true`, if the host component of a redirection URI specified in an authorization + request indicates loopback (to be precise, when the host component is localhost, `127.0.0.1` + or `::1`), the port number component is ignored when the specified redirection URI is compared + to pre-registered ones. This behavior is described in [7.3. Loopback Interface Redirection]( + https://www.rfc-editor.org/rfc/rfc8252.html#section-7.3) of [RFC 8252 OAuth 2.0](https://www.rfc-editor.org/rfc/rfc8252.html) + for Native Apps. + + [3.1.2.3. Dynamic Configuration](https://www.rfc-editor.org/rfc/rfc6749.html#section-3.1.2.3) + of [RFC 6749](https://www.rfc-editor.org/rfc/rfc6749.html) states _"If the client registration + included the full redirection URI, the authorization server MUST compare the two URIs using + simple string comparison as defined in [RFC3986] Section 6.2.1."_ Also, the description of + `redirect_uri` in [3.1.2.1. Authentication Request](https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest) + of [OpenID Connect Core 1.0](https://openid.net/specs/openid-connect-core-1_0.html) states + _"This URI MUST exactly match one of the Redirection URI values for the Client pre-registered + at the OpenID Provider, with the matching performed as described in Section 6.2.1 of [RFC3986] + (**Simple String Comparison**)."_ These "Simple String Comparison" requirements are preceded + by this flag. That is, even when the conditions described in RFC 6749 and OpenID Connect Core 1.0 + are satisfied, the port number component of loopback redirection URIs can be variable when this + flag is `true`. + + [8.3. Loopback Redirect Considerations](https://www.rfc-editor.org/rfc/rfc8252.html#section-8.3) + of [RFC 8252](https://www.rfc-editor.org/rfc/rfc8252.html) states as follows. + + > While redirect URIs using localhost (i.e., `"http://localhost:{port}/{path}"`) function + similarly to loopback IP redirects described in Section 7.3, the use of localhost is NOT RECOMMENDED. + Specifying a redirect URI with the loopback IP literal rather than localhost avoids inadvertently + listening on network interfaces other than the loopback interface. It is also less susceptible + to client-side firewalls and misconfigured host name resolution on the user's device. + + However, Authlete allows the port number component to be variable in the case of `localhost`, + too. It is left to client applications whether they use `localhost` or a literal loopback IP + address (`127.0.0.1` for IPv4 or `::1` for IPv6). + + Section 7.3 and Section 8.3 of [RFC 8252](https://www.rfc-editor.org/rfc/rfc8252.html) state + that loopback redirection URIs use the `"http"` scheme, but Authlete allows the port number + component to be variable in other cases (e.g. in the case of the `"https"` scheme), too. + type: boolean + requestObjectAudienceChecked: + description: | + The flag indicating whether Authlete checks whether the `aud` claim of request objects matches + the issuer identifier of this service. + + [Section 6.1. Passing a Request Object by Value](https://openid.net/specs/openid-connect-core-1_0.html#JWTRequests) + of [OpenID Connect Core 1.0](https://openid.net/specs/openid-connect-core-1_0.html) has the following + statement. + + > The `aud` value SHOULD be or include the OP's Issuer Identifier URL. + + Likewise, [Section 4. Request Object](https://www.rfc-editor.org/rfc/rfc9101.html#section-4) of + [RFC 9101](https://www.rfc-editor.org/rfc/rfc9101.html) (The OAuth 2.0 Authorization Framework: + JWT-Secured Authorization Request (JAR)) has the following statement. + + > The value of aud should be the value of the authorization server (AS) issuer, as defined in + [RFC 8414](https://www.rfc-editor.org/rfc/rfc8414.html). + + As excerpted above, validation on the `aud` claim of request objects is optional. However, if + this flag is turned on, Authlete checks whether the `aud` claim of request objects matches the issuer + identifier of this service and raises an error if they are different. + type: boolean + accessTokenForExternalAttachmentEmbedded: + description: | + The flag indicating whether Authlete generates access tokens for + external attachments and embeds them in ID tokens and userinfo + responses. + type: boolean + authorityHints: + description: | + Identifiers of entities that can issue entity statements for this + service. This property corresponds to the `authority_hints` + property that appears in a self-signed entity statement that is + defined in OpenID Connect Federation 1.0. + items: + type: string + type: array + federationEnabled: + description: | + flag indicating whether this service supports OpenID Connect Federation 1 + type: boolean + federationJwks: + description: | + JWK Set document containing keys that are used to sign (1) self-signed + entity statement of this service and (2) the response from + `signed_jwks_uri`. + type: string + federationSignatureKeyId: + description: | + A key ID to identify a JWK used to sign the entity configuration and + the signed JWK Set. + type: string + federationConfigurationDuration: + description: | + The duration of the entity configuration in seconds. + type: integer + federationRegistrationEndpoint: + description: | + The URI of the federation registration endpoint. This property corresponds + to the `federation_registration_endpoint` server metadata that is + defined in OpenID Connect Federation 1.0. + type: string + organizationName: + description: | + The human-readable name representing the organization that operates + this service. This property corresponds to the `organization_name` + server metadata that is defined in OpenID Connect Federation 1.0. + type: string + predefinedTransformedClaims: + description: | + The transformed claims predefined by this service in JSON format. + This property corresponds to the `transformed_claims_predefined` + server metadata. + type: string + refreshTokenIdempotent: + description: | + flag indicating whether refresh token requests with the same + refresh token can be made multiple times in quick succession and + they can obtain the same renewed refresh token within the short + period. + type: boolean + signedJwksUri: + description: | + The URI of the endpoint that returns this service's JWK Set document in + the JWT format. This property corresponds to the `signed_jwks_uri` + server metadata defined in OpenID Connect Federation 1.0. + type: string + supportedAttachments: + description: | + Supported attachment types. This property corresponds to the {@code + attachments_supported} server metadata which was added by the third + implementer's draft of OpenID Connect for Identity Assurance 1.0. + items: + $ref: '#/components/schemas/attachment_type' + type: array + supportedDigestAlgorithms: + description: | + Supported algorithms used to compute digest values of external + attachments. This property corresponds to the + `digest_algorithms_supported` server metadata which was added + by the third implementer's draft of OpenID Connect for Identity + Assurance 1.0. + items: + type: string + type: array + supportedDocuments: + description: | + Document types supported by this service. This property corresponds + to the `documents_supported` server metadata. + items: + type: string + type: array + supportedDocumentsMethods: + description: | + validation and verification processes supported by this service. + This property corresponds to the `documents_methods_supported` + server metadata. + + The third implementer's draft of [OpenID Connect for Identity Assurance 1.0](https://openid.net/specs/openid-connect-4-identity-assurance-1_0.html) + renamed the + `id_documents_verification_methods_supported` server metadata to + `documents_methods_supported`. + items: + type: string + type: array + supportedDocumentsValidationMethods: + description: | + Document validation methods supported by this service. This property + corresponds to the `documents_validation_methods_supported` server + metadata which was added by the third implementer's draft of - `null` means that there is no record about granted scopes. - An empty array means that there exists a record about granted - scopes but no scope has been granted to the client application. - If the returned array holds some elements, they are the scopes - granted to the client application by the last authorization - process. -

items: type: string type: array mergedGrantedScopes: description: | - The scopes granted to the client application by all the + Get the scopes granted to the client application by all the past authorization processes. Note that revoked scopes are not included. items: type: string type: array modifiedAt: - description: Get the timestamp in milliseconds since Unix epoch at which - this record was modified. + description: |- + Get the timestamp in milliseconds since Unix epoch + at which this record was modified. format: int64 type: integer type: object @@ -17479,154 +15801,44 @@ components: - requestedVerifiedClaimsForTx - - requestedVerifiedClaimsForTx - requestedVerifiedClaimsForTx + issuableCredentials: issuableCredentials action: INTERNAL_SERVER_ERROR client: - serviceNumber: 6 - applicationType: null - bcNotificationEndpoint: bcNotificationEndpoint - tlsClientAuthSanEmail: tlsClientAuthSanEmail - modifiedAt: 5 - logoUris: - - tag: tag - value: value - - tag: tag - value: value - singleAccessTokenPerSubject: true - dpopRequired: true - signedJwksUri: signedJwksUri - descriptions: + clientId: 6 + clientName: clientName + policyUris: - tag: tag value: value - tag: tag value: value - subjectType: null - clientNames: + tosUris: - tag: tag value: value - tag: tag value: value - number: 0 - createdAt: 5 - automaticallyRegistered: true - clientType: null - tlsClientCertificateBoundAccessTokens: true - bcDeliveryMode: bcDeliveryMode - idTokenEncryptionEnc: null - clientSecret: clientSecret - selfSignedCertificateKeyId: selfSignedCertificateKeyId - idTokenSignAlg: null - locked: true - clientUri: clientUri - trustChain: - - trustChain - - trustChain - tlsClientAuthSanDns: tlsClientAuthSanDns - organizationName: organizationName - tlsClientAuthSanIp: tlsClientAuthSanIp - policyUris: + logoUris: - tag: tag value: value - tag: tag value: value - parRequired: true - derivedSectorIdentifier: derivedSectorIdentifier + description: description logoUri: logoUri - requestObjectEncryptionEncMatchRequired: true - redirectUris: - - redirectUris - - redirectUris - requestEncryptionAlg: null - defaultAcrs: - - defaultAcrs - - defaultAcrs - requestObjectEncryptionAlgMatchRequired: true - trustChainExpiresAt: 3 - grantTypes: - - null - - null - authorizationEncryptionEnc: null - pkceS256Required: true - tlsClientAuthSubjectDn: tlsClientAuthSubjectDn - rsRequestSigned: true - tosUri: tosUri - requestUris: - - requestUris - - requestUris - explicitlyRegistered: true - softwareVersion: softwareVersion - authorizationSignAlg: null - registrationAccessTokenHash: registrationAccessTokenHash - extension: - refreshTokenDuration: 9 - requestableScopes: - - requestableScopes - - requestableScopes - tokenExchangePermitted: true - requestableScopesEnabled: true - accessTokenDuration: 7 - jwks: jwks - clientUris: + clientIdAlias: clientIdAlias + descriptions: - tag: tag value: value - tag: tag value: value - clientName: clientName - requestSignAlg: null - tosUris: + clientNames: - tag: tag value: value - tag: tag value: value - description: description - jwksUri: jwksUri - authorizationDetailsTypes: - - authorizationDetailsTypes - - authorizationDetailsTypes - userInfoEncryptionEnc: null - clientIdAlias: clientIdAlias - authorizationEncryptionAlg: null - clientRegistrationTypes: - - null - - null - loginUri: loginUri - userInfoSignAlg: null + number: 0 + clientType: null policyUri: policyUri - customMetadata: customMetadata - tokenAuthSignAlg: null - authTimeRequired: true - idTokenEncryptionAlg: null + tosUri: tosUri clientIdAliasEnabled: true - bcUserCodeRequired: true - tokenAuthMethod: null - defaultMaxAge: 2 - trustAnchorId: trustAnchorId - responseTypes: - - null - - null - sectorIdentifierUri: sectorIdentifierUri - clientId: 1 - dynamicallyRegistered: true - requestObjectRequired: true - digestAlgorithm: digestAlgorithm - entityId: entityId - requestEncryptionEnc: null - tlsClientAuthSanUri: tlsClientAuthSanUri - frontChannelRequestObjectEncryptionRequired: true - softwareId: softwareId - trustChainUpdatedAt: 2 - userInfoEncryptionAlg: null - developer: developer - attributes: - - value: value - key: key - - value: value - key: key - rsSignedRequestKeyId: rsSignedRequestKeyId - bcRequestSignAlg: null - pkceRequired: true - contacts: - - contacts - - contacts requestObjectPayload: requestObjectPayload prompts: - null @@ -17687,7 +15899,7 @@ components: value: value - name: name value: value - maxAge: 0 + maxAge: 1 service: metadata: - value: value @@ -17695,7 +15907,7 @@ components: - value: value key: key predefinedTransformedClaims: predefinedTransformedClaims - apiKey: 1 + apiKey: 6 supportedScopes: - name: name description: description @@ -17732,7 +15944,7 @@ components: supportedServiceProfiles: - null - null - authorizationResponseDuration: 7 + authorizationResponseDuration: 5 refreshTokenIdempotent: true supportedDocumentsCheckMethods: - supportedDocumentsCheckMethods @@ -17743,43 +15955,29 @@ components: registrationManagementEndpoint: https://openapi-generator.tech accessTokenForExternalAttachmentEmbedded: true missingClientIdAllowed: true - userCodeLength: 7 - deviceFlowPollingInterval: 6 - developerSnsCredentials: - - apiKey: apiKey - sns: sns - apiSecret: apiSecret - - apiKey: apiKey - sns: sns - apiSecret: apiSecret + userCodeLength: 1 + deviceFlowPollingInterval: 1 deviceFlowCodeDuration: 1 supportedTrustFrameworks: - supportedTrustFrameworks - supportedTrustFrameworks - developerAuthenticationCallbackApiKey: developerAuthenticationCallbackApiKey deviceVerificationUriComplete: https://openapi-generator.tech refreshTokenKept: true + dpopNonceRequired: true + credentialJwksUri: credentialJwksUri authenticationCallbackEndpoint: https://openapi-generator.tech - apiSecret: apiSecret - developerAuthenticationCallbackApiSecret: developerAuthenticationCallbackApiSecret - accessTokenDuration: 3 + dpopNonceDuration: 4 + accessTokenDuration: 7 federationSignatureKeyId: federationSignatureKeyId backchannelUserCodeParameterSupported: true supportedVerifiedClaims: - supportedVerifiedClaims - supportedVerifiedClaims - clientsPerDeveloper: 5 unauthorizedOnClientConfigSupported: true + credentialDuration: 9 supportedDigestAlgorithms: - supportedDigestAlgorithms - supportedDigestAlgorithms - snsCredentials: - - apiKey: apiKey - sns: sns - apiSecret: apiSecret - - apiKey: apiKey - sns: sns - apiSecret: apiSecret directRevocationEndpointEnabled: true federationJwks: federationJwks grantManagementActionRequired: true @@ -17792,9 +15990,12 @@ components: supportedCustomClientMetadata: - supportedCustomClientMetadata - supportedCustomClientMetadata + credentialTransactionDuration: 5 directAuthorizationEndpointEnabled: true pushedAuthReqEndpoint: https://openapi-generator.tech - developerAuthenticationCallbackEndpoint: https://openapi-generator.tech + supportedPromptValues: + - null + - null tokenEndpoint: https://openapi-generator.tech supportedIntrospectionAuthMethods: - null @@ -17817,12 +16018,15 @@ components: - supportedElectronicRecords - supportedElectronicRecords deviceVerificationUri: https://openapi-generator.tech + credentialOfferDuration: 1 authenticationCallbackApiSecret: authenticationCallbackApiSecret requestObjectRequired: true backchannelAuthenticationEndpoint: https://openapi-generator.tech - serviceOwnerNumber: 6 authorizationSignatureKeyId: authorizationSignatureKeyId endSessionEndpoint: https://openapi-generator.tech + fapiModes: + - null + - null grantManagementEndpoint: grantManagementEndpoint supportedUiLocales: - supportedUiLocales @@ -17853,15 +16057,17 @@ components: handle: handle publicKey: publicKey jwtGrantByIdentifiableClientsOnly: true - modifiedAt: 2 + modifiedAt: 5 introspectionEndpoint: https://openapi-generator.tech supportedBackchannelTokenDeliveryModes: - null - null + introspectionSignatureKeyId: introspectionSignatureKeyId accessTokenType: accessTokenType refreshTokenDurationReset: true federationRegistrationEndpoint: federationRegistrationEndpoint - createdAt: 5 + createdAt: 1 + credentialJwks: credentialJwks supportedClientRegistrationTypes: - null - null @@ -17869,7 +16075,7 @@ components: tlsClientCertificateBoundAccessTokens: true userCodeCharset: null issSuppressed: true - federationConfigurationDuration: 1 + federationConfigurationDuration: 6 supportedVerificationMethods: - supportedVerificationMethods - supportedVerificationMethods @@ -17881,6 +16087,7 @@ components: serviceDocumentation: https://openapi-generator.tech revocationEndpoint: https://openapi-generator.tech hsmEnabled: true + verifiableCredentialsEnabled: true organizationName: organizationName supportedDisplays: - null @@ -17917,6 +16124,7 @@ components: supportedDocumentsMethods: - supportedDocumentsMethods - supportedDocumentsMethods + cnonceDuration: 7 accessTokenSignatureKeyId: accessTokenSignatureKeyId jwtGrantUnsignedJwtRejected: true directTokenEndpointEnabled: true @@ -17928,7 +16136,7 @@ components: tokenExchangeByIdentifiableClientsOnly: true description: description jwksUri: https://openapi-generator.tech - pushedAuthReqDuration: 9 + pushedAuthReqDuration: 2 supportedEvidence: - supportedEvidence - supportedEvidence @@ -17949,38 +16157,69 @@ components: supportedTokenAuthMethods: - null - null - allowableClockSkew: 7 + allowableClockSkew: 2 deviceAuthorizationEndpoint: https://openapi-generator.tech - backchannelAuthReqIdDuration: 1 + backchannelAuthReqIdDuration: 4 tokenExchangeByPermittedClientsOnly: true tokenExchangeEncryptedJwtRejected: true + preAuthorizedGrantAnonymousAccessSupported: true supportedGrantTypes: - null - null supportedAuthorizationDetailsTypes: - supportedAuthorizationDetailsTypes - supportedAuthorizationDetailsTypes - backchannelPollingInterval: 1 + backchannelPollingInterval: 7 serviceName: serviceName accessTokenSignAlg: null - idTokenDuration: 4 + userPinLength: 9 + idTokenDuration: 3 authenticationCallbackApiKey: authenticationCallbackApiKey openidDroppedOnRefreshWithoutOfflineAccess: true frontChannelRequestObjectEncryptionRequired: true federationEnabled: true - refreshTokenDuration: 2 + refreshTokenDuration: 9 supportedRevocationAuthMethods: - null - null - supportedSnses: - - null - - null - supportedDeveloperSnses: - - null - - null + credentialIssuerMetadata: + credentialIssuer: credentialIssuer + credentialEndpoint: true + deferredCredentialEndpoint: deferredCredentialEndpoint + authorizationServer: authorizationServer + batchCredentialEndpoint: 6 + credentialsSupported: true claims: - claims - claims + claimsAtUserInfo: + - claimsAtUserInfo + - claimsAtUserInfo + credentialOfferInfo: + credentialIssuer: credentialIssuer + issuerState: issuerState + identifier: identifier + credentials: credentials + authorizationCodeGrantIncluded: true + subject: subject + issuerStateIncluded: true + userPinRequired: true + authTime: 5 + credentialOffer: credentialOffer + expiresAt: 5 + userPin: userPin + acr: acr + preAuthorizedCodeGrantIncluded: true + context: context + jwtAtClaims: jwtAtClaims + preAuthorizedCode: preAuthorizedCode + properties: + - hidden: true + value: value + key: key + - hidden: true + value: value + key: key scopes: - name: name description: description @@ -18074,7 +16313,7 @@ components: - INTERACTION type: string client: - $ref: '#/components/schemas/Client' + $ref: '#/components/schemas/client_limited_authorization' display: $ref: '#/components/schemas/Display' maxAge: @@ -18447,9 +16686,26 @@ components: request object. type: string clientEntityIdUsed: - description: Flag which indicates whether the entity ID of the client was - used when the request for the access token was made. + description: | + Flag which indicates whether the entity ID of the client was used when the request for the access token was made. type: boolean + claimsAtUserInfo: + description: | + Get the list of claims that the client application requests to be + embedded in userinfo responses. The value comes from the `"scope"` + and `"claims"` request parameters of the original authorization + request. + items: + type: string + type: array + credentialOfferInfo: + $ref: '#/components/schemas/credential_offer_info' + issuableCredentials: + description: |- + Get the information about the issuable credentials that can + be obtained by presenting the access token that will be issued as a + result of the authorization request. + type: string type: object authorization_fail_request: properties: @@ -18593,6 +16849,7 @@ components: action: INTERNAL_SERVER_ERROR resultMessage: resultMessage accessToken: accessToken + ticketInfo: ticketInfo accessTokenDuration: 6 responseContent: responseContent properties: @@ -18647,6 +16904,10 @@ components: The newly issued access token in JWT format. If the service is not configured to issue JWT-based access tokens, this property is always set to `null`. type: string + ticketInfo: + description: | + The information about the ticket. + type: string type: object pushed_authorization_request: properties: @@ -18689,6 +16950,8 @@ components: type: object pushed_authorization_response: example: + dpopNonce: dpopNonce + clientAuthMethod: NONE resultCode: resultCode action: CREATED requestUri: requestUri @@ -18722,6 +16985,25 @@ components: The content that the authorization server implementation is to return to the client application. type: string + clientAuthMethod: + description: | + The client authentication method that the client application declares that it uses at the token + endpoint. This property corresponds to `token_endpoint_auth_method` in [OpenID Connect Dynamic + Client Registration 1.0, 2. Client Metadata](https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata). + enum: + - NONE + - CLIENT_SECRET_BASIC + - CLIENT_SECRET_POST + - CLIENT_SECRET_JWT + - PRIVATE_KEY_JWT + - TLS_CLIENT_AUTH + - SELF_SIGNED_TLS_CLIENT_AUTH + type: string + dpopNonce: + description: |- + Get the expected nonce value for DPoP proof JWT, which should be used + as the value of the `DPoP-Nonce` HTTP header. + type: string type: object token_request: properties: @@ -18800,6 +17082,7 @@ components: token_response: example: previousRefreshTokenUsed: true + cnonceDuration: 9 subject: subject subjectToken: subjectToken actorToken: actorToken @@ -18809,6 +17092,7 @@ components: clientIdAlias: clientIdAlias jwtAccessToken: jwtAccessToken password: password + clientAuthMethod: clientAuthMethod action: INTERNAL_SERVER_ERROR audiences: - audiences @@ -18861,6 +17145,7 @@ components: value: value key: key clientEntityIdUsed: true + cnonce: cnonce clientEntityIdUsed: true subjectTokenType: null clientId: 5 @@ -18870,6 +17155,7 @@ components: resources: - resources - resources + cnonceExpiresAt: 3 accessTokenResources: - accessTokenResources - accessTokenResources @@ -18909,14 +17195,21 @@ components: actions: - actions - actions + dpopNonce: dpopNonce refreshTokenExpiresAt: 1 refreshTokenDuration: 5 + requestedIdTokenClaims: + - requestedIdTokenClaims + - requestedIdTokenClaims idToken: idToken clientIdAliasUsed: true scopes: - scopes - scopes grantType: grantType + refreshTokenScopes: + - refreshTokenScopes + - refreshTokenScopes responseContent: responseContent properties: - hidden: true @@ -19111,6 +17404,10 @@ components: items: $ref: '#/components/schemas/Pair' type: array + clientAuthMethod: + description: | + The client authentication method that was performed at the token endpoint. + type: string grantId: description: | the value of the `grant_id` request parameter of the device authorization request. @@ -19152,9 +17449,41 @@ components: The entity ID of the client. type: string clientEntityIdUsed: - description: Flag which indicates whether the entity ID of the client was - used when the request for the access token was made. + description: | + Flag which indicates whether the entity ID of the client was used when the request for the access token was made. type: boolean + cnonceDuration: + description: | + Duration of the `c_nonce` in seconds. + format: int64 + type: integer + dpopNonce: + description: | + Get the expected nonce value for DPoP proof JWT, which should be used + as the value of the `DPoP-Nonce` HTTP header. + type: string + cnonce: + description: | + Get the `c_nonce`. + type: string + cnonceExpiresAt: + description: | + Get the time at which the `c_nonce` expires in milliseconds since + the Unix epoch (1970-01-01). + format: int64 + type: integer + requestedIdTokenClaims: + description: | + Get the names of the claims that the authorization request (which resulted + in generation of the access token) requested to be embedded in ID tokens. + items: + type: string + type: array + refreshTokenScopes: + description: Scopes associated with the refresh token. + items: + type: string + type: array type: object token_fail_request: properties: @@ -19293,6 +17622,9 @@ components: scopes: - scopes - scopes + refreshTokenScopes: + - refreshTokenScopes + - refreshTokenScopes responseContent: responseContent properties: - hidden: true @@ -19415,128 +17747,14 @@ components: The entity ID of the client. type: string clientEntityIdUsed: - description: Flag which indicates whether the entity ID of the client was - used when the request for the access token was made. - type: boolean - type: object - idtoken_reissue_request: - properties: - accessToken: - description: | -

- The value of this parameter should be (a) the value of the - "`jwtAccessToken`" parameter in a response from the - `/auth/token` API when the value is available, or (b) - the value of the "`accessToken`" parameter in the - response from the `/auth/token` API when the value of - the "`jwtAccessToken`" parameter is not available. -

- type: string - refreshToken: - description: | -

- The value of this parameter should be the value of the - "`refreshToken`" parameter in a response from the - `/auth/token` API. -

- type: string - sub: - description: | - The value that should be used as the value of the "`sub`" - claim of the ID token. - -

- This parameter is optional. When omitted, the value of the subject - associated with the access token is used. -

- type: string - claims: - description: | - Additional claims that should be embedded in the payload part of - the ID token. The format is a JSON object. - -

- This parameter is optional. -

- type: string - idtHeaderParams: - description: | - Additional parameters that should be embedded in the JWS header of - the ID token. The format is a JSON object. - -

- This parameter is optional. -

- type: string - idTokenAudType: - description: |- - The type of the "`aud`" claim of the ID token being issued. - -

- Valid values of this parameter are as follows. -

- -
- - - - - - - - - - - - - -
ValueDescription
"`array`"The type of the `aud` claim becomes an array of strings.
"`string`"The type of the `aud` claim becomes a single string.
-
- -

- This parameter is optional, and the default value on omission is - "`array`". -

- -

- This parameter takes precedence over the `idTokenAudType` property - of {@link Service} (cf. {@link Service#getIdTokenAudType()}). -

- type: string - required: - - accessToken - - refreshToken - type: object - idtoken_reissue_response: - example: - resultCode: resultCode - idToken: idToken - action: OK - resultMessage: resultMessage - responseContent: responseContent - properties: - resultCode: - description: The code which represents the result of the API call. - type: string - resultMessage: - description: A short message which explains the result of the API call. - type: string - action: - description: The next action that the implementation of the token endpoint - should take. - enum: - - OK - - INTERNAL_SERVER_ERROR - - CALLER_ERROR - type: string - responseContent: description: | - The response content that can be used as the message body of the token response that should - be returned from the token endpoint. - type: string - idToken: - description: The reissued ID token - type: string + Flag which indicates whether the entity ID of the client was used when the request for the access token was made. + type: boolean + refreshTokenScopes: + description: The scopes associated with the refresh token. May be null. + items: + type: string + type: array type: object introspection_request: properties: @@ -19645,6 +17863,7 @@ components: acr: acr sufficient: true certificateThumbprint: certificateThumbprint + issuableCredentials: issuableCredentials action: INTERNAL_SERVER_ERROR serviceAttributes: - value: value @@ -19656,6 +17875,7 @@ components: key: key - value: value key: key + cnonce: cnonce clientEntityIdUsed: true refreshable: true scopeDetails: @@ -19687,9 +17907,11 @@ components: value: value clientId: 0 grantId: grantId + forCredentialIssuance: true resources: - resources - resources + cnonceExpiresAt: 5 accessTokenResources: - accessTokenResources - accessTokenResources @@ -19728,6 +17950,7 @@ components: actions: - actions - actions + dpopNonce: dpopNonce consentedClaims: - consentedClaims - consentedClaims @@ -19953,9 +18176,28 @@ components: The entity ID of the client. type: string clientEntityIdUsed: - description: Flag which indicates whether the entity ID of the client was - used when the request for the access token was made. + description: | + Flag which indicates whether the entity ID of the client was used when the request for the access token was made. type: boolean + forCredentialIssuance: + description: The flag indicating whether the token is for credential issuance. + type: boolean + cnonce: + description: The c_nonce + type: string + cnonceExpiresAt: + description: The time at which the `c_nonce` expires. + format: int64 + type: integer + issuableCredentials: + description: The credentials that can be obtained by presenting the access + token. + type: string + dpopNonce: + description: | + The expected nonce value for DPoP proof JWT, which should be used + as the value of the `DPoP-Nonce` HTTP header. + type: string type: object standard_introspection_request: properties: @@ -20146,6 +18388,7 @@ components: - requestedVerifiedClaimsForTx - - requestedVerifiedClaimsForTx - requestedVerifiedClaimsForTx + dpopNonce: dpopNonce consentedClaims: - consentedClaims - consentedClaims @@ -20401,9 +18644,14 @@ components: The entity ID of the client. type: string clientEntityIdUsed: - description: Flag which indicates whether the entity ID of the client was - used when the request for the access token was made. + description: | + Flag which indicates whether the entity ID of the client was used when the request for the access token was made. type: boolean + dpopNonce: + description: |- + The expected nonce value for DPoP proof JWT, which should be used + as the value of the `DPoP-Nonce` HTTP header. + type: string type: object userinfo_issue_request: properties: @@ -20485,80 +18733,98 @@ components: The content-digest header of the response message type: string type: object - g_m_request: + idtoken_reissue_request: properties: accessToken: - description: An access token to introspect. - type: string - scopes: - description: | - A string array listing names of scopes which the caller (= a protected resource endpoint of the - service) requires. When the content type of the request from the service is `application/x-www-form-urlencoded`, - the format of `scopes` is a space-separated list of scope names. - - If this parameter is a non-empty array and if it contains a scope which is not covered by the - access token,`action=FORBIDDEN` with `error=insufficient_scope` is returned from Authlete. - items: - type: string - type: array - subject: description: | - A subject (= a user account managed by the service) whom the caller (= a protected resource - endpoint of the service) requires. - - If this parameter is not `null` and if the value does not match the subject who is associated - with the access token, `action=FORBIDDEN` with `error=invalid_request` is returned from Authlete. +

+ The value of this parameter should be (a) the value of the + "`jwtAccessToken`" parameter in a response from the + `/auth/token` API when the value is available, or (b) + the value of the "`accessToken`" parameter in the + response from the `/auth/token` API when the value of + the "`jwtAccessToken`" parameter is not available. +

type: string - clientCertificate: + refreshToken: description: | - Client certificate in PEM format, used to validate binding against access tokens using the TLS - client certificate confirmation method. +

+ The value of this parameter should be the value of the + "`refreshToken`" parameter in a response from the + `/auth/token` API. +

type: string - dpop: + sub: description: | - `DPoP` header presented by the client during the request to the resource server. + The value that should be used as the value of the "`sub`" + claim of the ID token. - The header contains a signed JWT which includes the public key that is paired with the private - key used to sign the JWT. See [OAuth 2.0 Demonstration of Proof-of-Possession at the Application - Layer (DPoP)](https://datatracker.ietf.org/doc/html/draft-ietf-oauth-dpop) for details. +

+ This parameter is optional. When omitted, the value of the subject + associated with the access token is used. +

type: string - htm: + claims: description: | - HTTP method of the request from the client to the protected resource endpoint. This field is - used to validate the `DPoP` header. + Additional claims that should be embedded in the payload part of + the ID token. The format is a JSON object. - See [OAuth 2.0 Demonstration of Proof-of-Possession at the Application Layer (DPoP)](https://datatracker.ietf.org/doc/html/draft-ietf-oauth-dpop) - for details. +

+ This parameter is optional. +

type: string - htu: + idtHeaderParams: description: | - URL of the protected resource endpoint. This field is used to validate the `DPoP` header. + Additional parameters that should be embedded in the JWS header of + the ID token. The format is a JSON object. + +

+ This parameter is optional. +

+ type: string + idTokenAudType: + description: |- + The type of the "`aud`" claim of the ID token being issued. + +

+ Valid values of this parameter are as follows. +

+ +
+ + + + + + + + + + + + + +
ValueDescription
"`array`"The type of the `aud` claim becomes an array of strings.
"`string`"The type of the `aud` claim becomes a single string.
+
- See [OAuth 2.0 Demonstration of Proof-of-Possession at the Application Layer (DPoP)](https://datatracker.ietf.org/doc/html/draft-ietf-oauth-dpop) - for details. - type: string - resources: - description: | - The resources specified by the `resource` request parameters in the token request. See "Resource Indicators for OAuth 2.0" for details. - items: - type: string - type: array - gmAction: - $ref: '#/components/schemas/grant_management_action' - grantId: - description: | - The value of the `grant_id` request parameter of the device authorization request. +

+ This parameter is optional, and the default value on omission is + "`array`". +

- The `grant_id` request parameter is defined in - [Grant Management for OAuth 2.0](https://openid.net/specs/fapi-grant-management.html) - , which is supported by Authlete 2.3 and newer versions. +

+ This parameter takes precedence over the `idTokenAudType` property + of {@link Service} (cf. {@link Service#getIdTokenAudType()}). +

type: string required: - - token + - accessToken + - refreshToken type: object - g_m_response: + idtoken_reissue_response: example: resultCode: resultCode + idToken: idToken action: OK resultMessage: resultMessage responseContent: responseContent @@ -20570,206 +18836,98 @@ components: description: A short message which explains the result of the API call. type: string action: - description: The next action that the authorization server implementation + description: The next action that the implementation of the token endpoint should take. enum: - OK - - NO_CONTENT - - UNAUTHORIZED - - FORBIDDEN - - NOT_FOUND + - INTERNAL_SERVER_ERROR - CALLER_ERROR - - AUTHLETE_ERROR type: string responseContent: description: | - The content that the authorization server implementation is to return to the client application. - Its format varies depending on the value of `action` parameter. + The response content that can be used as the message body of the token response that should + be returned from the token endpoint. + type: string + idToken: + description: The reissued ID token type: string type: object - service_jwks_get_response: - example: - keys: - - "{}" - - "{}" + g_m_request: properties: - keys: - description: "An array of [JWK](https://datatracker.ietf.org/doc/html/rfc7517)s." + accessToken: + description: An access token to introspect. + type: string + scopes: + description: | + A string array listing names of scopes which the caller (= a protected resource endpoint of the + service) requires. When the content type of the request from the service is `application/x-www-form-urlencoded`, + the format of `scopes` is a space-separated list of scope names. + + If this parameter is a non-empty array and if it contains a scope which is not covered by the + access token,`action=FORBIDDEN` with `error=insufficient_scope` is returned from Authlete. items: - description: | - An object representing JWK. See [RFC 7517](https://datatracker.ietf.org/doc/html/rfc7517) for more details. - type: object + type: string type: array - type: object - client_registration_request: - properties: - json: - description: | - Client metadata in JSON format that complies with [RFC 7591](https://datatracker.ietf.org/doc/html/rfc7591) - (OAuth 2.0 Dynamic Client Registration Protocol). - type: string - token: + subject: description: | - The client registration access token. Used only for GET, UPDATE, and DELETE requests. + A subject (= a user account managed by the service) whom the caller (= a protected resource + endpoint of the service) requires. + + If this parameter is not `null` and if the value does not match the subject who is associated + with the access token, `action=FORBIDDEN` with `error=invalid_request` is returned from Authlete. type: string - clientId: + clientCertificate: description: | - The client's identifier. Used for GET, UPDATE, and DELETE requests - type: string - required: - - json - type: object - client_registration_response: - example: - resultCode: resultCode - action: INTERNAL_SERVER_ERROR - client: - serviceNumber: 6 - applicationType: null - bcNotificationEndpoint: bcNotificationEndpoint - tlsClientAuthSanEmail: tlsClientAuthSanEmail - modifiedAt: 5 - logoUris: - - tag: tag - value: value - - tag: tag - value: value - singleAccessTokenPerSubject: true - dpopRequired: true - signedJwksUri: signedJwksUri - descriptions: - - tag: tag - value: value - - tag: tag - value: value - subjectType: null - clientNames: - - tag: tag - value: value - - tag: tag - value: value - number: 0 - createdAt: 5 - automaticallyRegistered: true - clientType: null - tlsClientCertificateBoundAccessTokens: true - bcDeliveryMode: bcDeliveryMode - idTokenEncryptionEnc: null - clientSecret: clientSecret - selfSignedCertificateKeyId: selfSignedCertificateKeyId - idTokenSignAlg: null - locked: true - clientUri: clientUri - trustChain: - - trustChain - - trustChain - tlsClientAuthSanDns: tlsClientAuthSanDns - organizationName: organizationName - tlsClientAuthSanIp: tlsClientAuthSanIp - policyUris: - - tag: tag - value: value - - tag: tag - value: value - parRequired: true - derivedSectorIdentifier: derivedSectorIdentifier - logoUri: logoUri - requestObjectEncryptionEncMatchRequired: true - redirectUris: - - redirectUris - - redirectUris - requestEncryptionAlg: null - defaultAcrs: - - defaultAcrs - - defaultAcrs - requestObjectEncryptionAlgMatchRequired: true - trustChainExpiresAt: 3 - grantTypes: - - null - - null - authorizationEncryptionEnc: null - pkceS256Required: true - tlsClientAuthSubjectDn: tlsClientAuthSubjectDn - rsRequestSigned: true - tosUri: tosUri - requestUris: - - requestUris - - requestUris - explicitlyRegistered: true - softwareVersion: softwareVersion - authorizationSignAlg: null - registrationAccessTokenHash: registrationAccessTokenHash - extension: - refreshTokenDuration: 9 - requestableScopes: - - requestableScopes - - requestableScopes - tokenExchangePermitted: true - requestableScopesEnabled: true - accessTokenDuration: 7 - jwks: jwks - clientUris: - - tag: tag - value: value - - tag: tag - value: value - clientName: clientName - requestSignAlg: null - tosUris: - - tag: tag - value: value - - tag: tag - value: value - description: description - jwksUri: jwksUri - authorizationDetailsTypes: - - authorizationDetailsTypes - - authorizationDetailsTypes - userInfoEncryptionEnc: null - clientIdAlias: clientIdAlias - authorizationEncryptionAlg: null - clientRegistrationTypes: - - null - - null - loginUri: loginUri - userInfoSignAlg: null - policyUri: policyUri - customMetadata: customMetadata - tokenAuthSignAlg: null - authTimeRequired: true - idTokenEncryptionAlg: null - clientIdAliasEnabled: true - bcUserCodeRequired: true - tokenAuthMethod: null - defaultMaxAge: 2 - trustAnchorId: trustAnchorId - responseTypes: - - null - - null - sectorIdentifierUri: sectorIdentifierUri - clientId: 1 - dynamicallyRegistered: true - requestObjectRequired: true - digestAlgorithm: digestAlgorithm - entityId: entityId - requestEncryptionEnc: null - tlsClientAuthSanUri: tlsClientAuthSanUri - frontChannelRequestObjectEncryptionRequired: true - softwareId: softwareId - trustChainUpdatedAt: 2 - userInfoEncryptionAlg: null - developer: developer - attributes: - - value: value - key: key - - value: value - key: key - rsSignedRequestKeyId: rsSignedRequestKeyId - bcRequestSignAlg: null - pkceRequired: true - contacts: - - contacts - - contacts + Client certificate in PEM format, used to validate binding against access tokens using the TLS + client certificate confirmation method. + type: string + dpop: + description: | + `DPoP` header presented by the client during the request to the resource server. + + The header contains a signed JWT which includes the public key that is paired with the private + key used to sign the JWT. See [OAuth 2.0 Demonstration of Proof-of-Possession at the Application + Layer (DPoP)](https://datatracker.ietf.org/doc/html/draft-ietf-oauth-dpop) for details. + type: string + htm: + description: | + HTTP method of the request from the client to the protected resource endpoint. This field is + used to validate the `DPoP` header. + + See [OAuth 2.0 Demonstration of Proof-of-Possession at the Application Layer (DPoP)](https://datatracker.ietf.org/doc/html/draft-ietf-oauth-dpop) + for details. + type: string + htu: + description: | + URL of the protected resource endpoint. This field is used to validate the `DPoP` header. + + See [OAuth 2.0 Demonstration of Proof-of-Possession at the Application Layer (DPoP)](https://datatracker.ietf.org/doc/html/draft-ietf-oauth-dpop) + for details. + type: string + resources: + description: | + The resources specified by the `resource` request parameters in the token request. See "Resource Indicators for OAuth 2.0" for details. + items: + type: string + type: array + gmAction: + $ref: '#/components/schemas/grant_management_action' + grantId: + description: | + The value of the `grant_id` request parameter of the device authorization request. + + The `grant_id` request parameter is defined in + [Grant Management for OAuth 2.0](https://openid.net/specs/fapi-grant-management.html) + , which is supported by Authlete 2.3 and newer versions. + type: string + required: + - token + type: object + g_m_response: + example: + dpopNonce: dpopNonce + resultCode: resultCode + action: OK resultMessage: resultMessage responseContent: responseContent properties: @@ -20780,35 +18938,61 @@ components: description: A short message which explains the result of the API call. type: string action: - description: | - The next action that the authorization server implementation should take. + description: The next action that the authorization server implementation + should take. enum: - - INTERNAL_SERVER_ERROR - - BAD_REQUEST - - CREATED + - OK + - NO_CONTENT + - UNAUTHORIZED + - FORBIDDEN + - NOT_FOUND + - CALLER_ERROR + - AUTHLETE_ERROR type: string responseContent: description: | The content that the authorization server implementation is to return to the client application. Its format varies depending on the value of `action` parameter. type: string - client: - $ref: '#/components/schemas/Client' + dpopNonce: + description: |- + Get the expected nonce value for DPoP proof JWT, which should be used + as the value of the `DPoP-Nonce` HTTP header. + type: string type: object - client_registration_get_request: + service_jwks_get_response: + example: + keys: + - "{}" + - "{}" properties: - clientId: + keys: + description: "An array of [JWK](https://datatracker.ietf.org/doc/html/rfc7517)s." + items: + description: | + An object representing JWK. See [RFC 7517](https://datatracker.ietf.org/doc/html/rfc7517) for more details. + type: object + type: array + type: object + client_registration_request: + properties: + json: description: | - Client ID. + Client metadata in JSON format that complies with [RFC 7591](https://datatracker.ietf.org/doc/html/rfc7591) + (OAuth 2.0 Dynamic Client Registration Protocol). type: string token: - description: Client registration access token. + description: | + The client registration access token. Used only for GET, UPDATE, and DELETE requests. + type: string + clientId: + description: | + The client's identifier. Used for GET, UPDATE, and DELETE requests type: string required: - - clientId - - token + - json type: object - client_registration_get_response: + client_registration_response: example: resultCode: resultCode action: INTERNAL_SERVER_ERROR @@ -20848,6 +19032,9 @@ components: selfSignedCertificateKeyId: selfSignedCertificateKeyId idTokenSignAlg: null locked: true + responseModes: + - QUERY + - QUERY clientUri: clientUri trustChain: - trustChain @@ -20937,6 +19124,8 @@ components: - null sectorIdentifierUri: sectorIdentifierUri clientId: 1 + credentialOfferEndpoint: credentialOfferEndpoint + credentialResponseEncryptionRequired: true dynamicallyRegistered: true requestObjectRequired: true digestAlgorithm: digestAlgorithm @@ -20944,10 +19133,12 @@ components: requestEncryptionEnc: null tlsClientAuthSanUri: tlsClientAuthSanUri frontChannelRequestObjectEncryptionRequired: true + fapiModes: + - null + - null softwareId: softwareId trustChainUpdatedAt: 2 userInfoEncryptionAlg: null - developer: developer attributes: - value: value key: key @@ -20974,8 +19165,7 @@ components: enum: - INTERNAL_SERVER_ERROR - BAD_REQUEST - - OK - - UNAUTHORIZED + - CREATED type: string responseContent: description: | @@ -21045,6 +19235,9 @@ components: selfSignedCertificateKeyId: selfSignedCertificateKeyId idTokenSignAlg: null locked: true + responseModes: + - QUERY + - QUERY clientUri: clientUri trustChain: - trustChain @@ -21134,6 +19327,8 @@ components: - null sectorIdentifierUri: sectorIdentifierUri clientId: 1 + credentialOfferEndpoint: credentialOfferEndpoint + credentialResponseEncryptionRequired: true dynamicallyRegistered: true requestObjectRequired: true digestAlgorithm: digestAlgorithm @@ -21141,10 +19336,12 @@ components: requestEncryptionEnc: null tlsClientAuthSanUri: tlsClientAuthSanUri frontChannelRequestObjectEncryptionRequired: true + fapiModes: + - null + - null softwareId: softwareId trustChainUpdatedAt: 2 userInfoEncryptionAlg: null - developer: developer attributes: - value: value key: key @@ -21235,6 +19432,9 @@ components: selfSignedCertificateKeyId: selfSignedCertificateKeyId idTokenSignAlg: null locked: true + responseModes: + - QUERY + - QUERY clientUri: clientUri trustChain: - trustChain @@ -21324,6 +19524,8 @@ components: - null sectorIdentifierUri: sectorIdentifierUri clientId: 1 + credentialOfferEndpoint: credentialOfferEndpoint + credentialResponseEncryptionRequired: true dynamicallyRegistered: true requestObjectRequired: true digestAlgorithm: digestAlgorithm @@ -21331,10 +19533,12 @@ components: requestEncryptionEnc: null tlsClientAuthSanUri: tlsClientAuthSanUri frontChannelRequestObjectEncryptionRequired: true + fapiModes: + - null + - null softwareId: softwareId trustChainUpdatedAt: 2 userInfoEncryptionAlg: null - developer: developer attributes: - value: value key: key @@ -21372,46 +19576,6 @@ components: client: $ref: '#/components/schemas/Client' type: object - client_extension_requestable_scopes_get_response: - example: - requestableScopes: - - requestableScopes - - requestableScopes - properties: - requestableScopes: - items: - type: string - type: array - type: object - client_extension_requestable_scopes_update_request: - properties: - requestableScopes: - description: |- - The set of scopes that the client application is allowed to request. - This parameter will be one of the following. Details are described in the description. - - - null - - an empty set - - a set with at least one element - - If this parameter contains scopes that the service does not support, those scopes are just - ignored. Also, if this parameter is `null` or is not included in the request, it is equivalent - to calling `/client/extension/requestable_scopes/delete` API. - items: - type: string - type: array - type: object - client_extension_requestable_scopes_update_response: - example: - requestableScopes: - - requestableScopes - - requestableScopes - properties: - requestableScopes: - items: - type: string - type: array - type: object backchannel_authentication_request: properties: parameters: @@ -21475,6 +19639,7 @@ components: claimNames: - claimNames - claimNames + clientAuthMethod: clientAuthMethod deliveryMode: null action: INTERNAL_SERVER_ERROR serviceAttributes: @@ -21776,6 +19941,10 @@ components: type: array deliveryMode: $ref: '#/components/schemas/delivery_mode' + clientAuthMethod: + description: | + The client authentication method that was performed. + type: string gmAction: $ref: '#/components/schemas/grant_management_action' grantId: @@ -22988,172 +21157,43 @@ components: properties: resultCode: description: The code which represents the result of the API call. - type: string - resultMessage: - description: A short message which explains the result of the API call. - type: string - action: - description: | - The next action that the authorization server implementation should take. - enum: - - SERVER_ERROR - - USER_CODE_NOT_EXIST - - USER_CODE_EXPIRED - - INVALID_REQUEST - - SUCCESS - type: string - type: object - token_get_list_response: - example: - subject: subject - start: 0 - client: - serviceNumber: 6 - applicationType: null - bcNotificationEndpoint: bcNotificationEndpoint - tlsClientAuthSanEmail: tlsClientAuthSanEmail - modifiedAt: 5 - logoUris: - - tag: tag - value: value - - tag: tag - value: value - singleAccessTokenPerSubject: true - dpopRequired: true - signedJwksUri: signedJwksUri - descriptions: - - tag: tag - value: value - - tag: tag - value: value - subjectType: null - clientNames: - - tag: tag - value: value - - tag: tag - value: value - number: 0 - createdAt: 5 - automaticallyRegistered: true - clientType: null - tlsClientCertificateBoundAccessTokens: true - bcDeliveryMode: bcDeliveryMode - idTokenEncryptionEnc: null - clientSecret: clientSecret - selfSignedCertificateKeyId: selfSignedCertificateKeyId - idTokenSignAlg: null - locked: true - clientUri: clientUri - trustChain: - - trustChain - - trustChain - tlsClientAuthSanDns: tlsClientAuthSanDns - organizationName: organizationName - tlsClientAuthSanIp: tlsClientAuthSanIp - policyUris: - - tag: tag - value: value - - tag: tag - value: value - parRequired: true - derivedSectorIdentifier: derivedSectorIdentifier - logoUri: logoUri - requestObjectEncryptionEncMatchRequired: true - redirectUris: - - redirectUris - - redirectUris - requestEncryptionAlg: null - defaultAcrs: - - defaultAcrs - - defaultAcrs - requestObjectEncryptionAlgMatchRequired: true - trustChainExpiresAt: 3 - grantTypes: - - null - - null - authorizationEncryptionEnc: null - pkceS256Required: true - tlsClientAuthSubjectDn: tlsClientAuthSubjectDn - rsRequestSigned: true - tosUri: tosUri - requestUris: - - requestUris - - requestUris - explicitlyRegistered: true - softwareVersion: softwareVersion - authorizationSignAlg: null - registrationAccessTokenHash: registrationAccessTokenHash - extension: - refreshTokenDuration: 9 - requestableScopes: - - requestableScopes - - requestableScopes - tokenExchangePermitted: true - requestableScopesEnabled: true - accessTokenDuration: 7 - jwks: jwks - clientUris: + type: string + resultMessage: + description: A short message which explains the result of the API call. + type: string + action: + description: | + The next action that the authorization server implementation should take. + enum: + - SERVER_ERROR + - USER_CODE_NOT_EXIST + - USER_CODE_EXPIRED + - INVALID_REQUEST + - SUCCESS + type: string + type: object + token_get_list_response: + example: + subject: subject + start: 0 + client: + clientNames: - tag: tag value: value - tag: tag value: value + number: 5 + clientId: 5 + clientType: null clientName: clientName - requestSignAlg: null - tosUris: + description: description + clientIdAlias: clientIdAlias + clientIdAliasEnabled: true + descriptions: - tag: tag value: value - tag: tag value: value - description: description - jwksUri: jwksUri - authorizationDetailsTypes: - - authorizationDetailsTypes - - authorizationDetailsTypes - userInfoEncryptionEnc: null - clientIdAlias: clientIdAlias - authorizationEncryptionAlg: null - clientRegistrationTypes: - - null - - null - loginUri: loginUri - userInfoSignAlg: null - policyUri: policyUri - customMetadata: customMetadata - tokenAuthSignAlg: null - authTimeRequired: true - idTokenEncryptionAlg: null - clientIdAliasEnabled: true - bcUserCodeRequired: true - tokenAuthMethod: null - defaultMaxAge: 2 - trustAnchorId: trustAnchorId - responseTypes: - - null - - null - sectorIdentifierUri: sectorIdentifierUri - clientId: 1 - dynamicallyRegistered: true - requestObjectRequired: true - digestAlgorithm: digestAlgorithm - entityId: entityId - requestEncryptionEnc: null - tlsClientAuthSanUri: tlsClientAuthSanUri - frontChannelRequestObjectEncryptionRequired: true - softwareId: softwareId - trustChainUpdatedAt: 2 - userInfoEncryptionAlg: null - developer: developer - attributes: - - value: value - key: key - - value: value - key: key - rsSignedRequestKeyId: rsSignedRequestKeyId - bcRequestSignAlg: null - pkceRequired: true - contacts: - - contacts - - contacts end: 6 totalCount: 1 accessTokens: @@ -23196,241 +21236,883 @@ components: value: value key: key properties: - start: + start: + description: | + Start index of search results (inclusive). + format: int32 + type: integer + end: + description: | + End index of search results (exclusive). + format: int32 + type: integer + totalCount: + description: | + Unique ID of a client developer. + format: int32 + type: integer + client: + $ref: '#/components/schemas/client_limited' + subject: + description: | + Unique user ID of an end-user. + type: string + accessTokens: + description: | + An array of access tokens. + items: + $ref: '#/components/schemas/access_token' + type: array + type: object + token_create_request: + properties: + grantType: + $ref: '#/components/schemas/grant_type' + clientId: + description: | + The ID of the client application which will be associated with a newly created access token. + format: int64 + type: integer + subject: + description: | + The subject (= unique identifier) of the user who will be associated with a newly created access + token. This parameter is required unless the grant type is `CLIENT_CREDENTIALS`. The value must + consist of only ASCII characters and its length must not exceed 100. + type: string + scopes: + description: | + The scopes which will be associated with a newly created access token. Scopes that are not supported + by the service cannot be specified and requesting them will cause an error. + items: + type: string + type: array + accessTokenDuration: + description: | + The duration of a newly created access token in seconds. If the value is 0, the duration is determined + according to the settings of the service. + format: int64 + type: integer + refreshTokenDuration: + description: | + The duration of a newly created refresh token in seconds. If the value is 0, the duration is + determined according to the settings of the service. + + A refresh token is not created (1) if the service does not support `REFRESH_TOKEN`, or (2) if the + specified grant type is either `IMPLICIT`or `CLIENT_CREDENTIALS`. + format: int64 + type: integer + properties: + description: | + Extra properties to associate with a newly created access token. Note that properties parameter + is accepted only when the HTTP method of the request is POST and Content-Type of the request is + `application/json`, so don't use `GET` method or `application/x-www-form-urlencoded` if you want + to specify properties. + items: + $ref: '#/components/schemas/Property' + type: array + clientIdAliasUsed: + description: | + A boolean request parameter which indicates whether to emulate that the client ID alias is used + instead of the original numeric client ID when a new access token is created. + + This has an effect only on the value of the aud claim in a response from [UserInfo endpoint](https://openid.net/specs/openid-connect-core-1_0.html#UserInfo). + When you access the UserInfo endpoint (which is expected to be implemented using Authlete's + `/api/auth/userinfo` API and `/api/auth/userinfo/issue` API) with an access token which has been + created using Authlete's `/api/auth/token/create` API with this property (`clientIdAliasUsed`) + `true`, the client ID alias is used as the value of the aud claim in a response from the UserInfo + endpoint. + + Note that if a client ID alias is not assigned to the client when Authlete's `/api/auth/token/create` + API is called, this property (`clientIdAliasUsed`) has no effect (it is always regarded as `false`). + type: boolean + accessToken: + description: | + The value of the new access token. + + The `/api/auth/token/create` API generates an access token. Therefore, callers of the API do not + have to specify values of newly created access tokens. However, in some cases, for example, if + you want to migrate existing access tokens from an old system to Authlete, you may want to specify + values of access tokens. In such a case, you can specify the value of a newly created access token + by passing a non-null value as the value of accessToken request parameter. The implementation + of the `/api/auth/token/create` uses the value of the accessToken request parameter instead of + generating a new value when the request parameter holds a non-null value. + + Note that if the hash value of the specified access token already exists in Authlete's database, + the access token cannot be inserted and the `/api/auth/token/create` API will report an error. + type: string + refreshToken: + description: | + The value of the new refresh token. + + The `/api/auth/token/create` API may generate a refresh token. Therefore, callers of the API do + not have to specify values of newly created refresh tokens. However, in some cases, for example, + if you want to migrate existing refresh tokens from an old system to Authlete, you may want to + specify values of refresh tokens. In such a case, you can specify the value of a newly created + refresh token by passing a non-null value as the value of refreshToken request parameter. The + implementation of the `/api/auth/token/create` uses the value of the refreshToken request parameter + instead of generating a new value when the request parameter holds a non-null value. + + Note that if the hash value of the specified refresh token already exists in Authlete's database, + the refresh token cannot be inserted and the `/api/auth/token/create` API will report an error. + type: string + accessTokenPersistent: + description: | + Get whether the access token expires or not. By default, all access tokens expire after a period + of time determined by their service. + + If this request parameter is `true`, then the access token will not automatically expire and must + be revoked or deleted manually at the service. If this request parameter is true, the `accessTokenDuration` + request parameter is ignored. + type: boolean + certificateThumbprint: + description: | + The thumbprint of the MTLS certificate bound to this token. If this property is set, a certificate + with the corresponding value MUST be presented with the access token when it is used by a client. + The value of this property must be a SHA256 certificate thumbprint, base64url encoded. + type: string + dpopKeyThumbprint: + description: | + The thumbprint of the public key used for DPoP presentation of this token. If this property is + set, a DPoP proof signed with the corresponding private key MUST be presented with the access + token when it is used by a client. Additionally, the token's `token_type` will be set to 'DPoP'. + type: string + authorizationDetails: + $ref: '#/components/schemas/authz_details' + resources: + description: | + The value of the resources to associate with the token. This property represents the value of + one or more `resource` request parameters which is defined in "RFC8707 Resource Indicators for + OAuth 2.0". + items: + format: uri + type: string + type: array + forExternalAttachment: + description: | + the flag which indicates whether the access token is for an external + attachment. + type: boolean + jwtAtClaims: + description: | + Additional claims that are added to the payload part of the JWT access token. + type: string + acr: + description: "The Authentication Context Class Reference of the user authentication\ + \ that the authorization server performed \nduring the course of issuing\ + \ the access token.\n" + type: string + authTime: + description: | + The time when the user authentication was performed during the course of issuing the access token. + format: int64 + type: integer + clientEntityIdUsed: + description: Flag which indicates whether the entity ID of the client was + used when the request for the access token was made. + type: boolean + required: + - clientId + - grantType + type: object + token_create_response: + example: + clientId: 0 + tokenId: tokenId + subject: subject + resultCode: resultCode + forExternalAttachment: true + resultMessage: resultMessage + accessToken: accessToken + expiresAt: 6 + expiresIn: 1 + authorizationDetails: + elements: + - dataTypes: + - dataTypes + - dataTypes + identifier: identifier + privileges: + - privileges + - privileges + locations: + - locations + - locations + type: type + otherFields: otherFields + actions: + - actions + - actions + - dataTypes: + - dataTypes + - dataTypes + identifier: identifier + privileges: + - privileges + - privileges + locations: + - locations + - locations + type: type + otherFields: otherFields + actions: + - actions + - actions + jwtAccessToken: jwtAccessToken + action: INTERNAL_SERVER_ERROR + scopes: + - scopes + - scopes + grantType: grantType + tokenType: tokenType + refreshTokenScopes: + - refreshTokenScopes + - refreshTokenScopes + properties: + - hidden: true + value: value + key: key + - hidden: true + value: value + key: key + refreshToken: refreshToken + properties: + resultCode: + description: The code which represents the result of the API call. + type: string + resultMessage: + description: A short message which explains the result of the API call. + type: string + action: + description: The next action that the authorization server implementation + should take. + enum: + - INTERNAL_SERVER_ERROR + - BAD_REQUEST + - FORBIDDEN + - OK + type: string + accessToken: + description: The newly issued access token. + type: string + clientId: description: | - Start index of search results (inclusive). - format: int32 + The ID of the client application associated with the access token. + format: int64 type: integer - end: + expiresAt: description: | - End index of search results (exclusive). - format: int32 + The time at which the access token expires. + format: int64 type: integer - totalCount: + expiresIn: description: | - Unique ID of a client developer. - format: int32 + The duration of the newly issued access token in seconds. + format: int64 type: integer - client: - $ref: '#/components/schemas/Client' + grantType: + description: | + The grant type for the newly issued access token. + type: string + properties: + description: | + The extra properties associated with the access token. + items: + $ref: '#/components/schemas/Property' + type: array + refreshToken: + description: | + The newly issued refresh token. + type: string + scopes: + description: | + Scopes which are associated with the access token. + items: + type: string + type: array subject: description: | - Unique user ID of an end-user. + The subject (= unique identifier) of the user associated with the newly issued access + token. type: string - accessTokens: + tokenType: description: | - An array of access tokens. + The token type of the access token. + type: string + jwtAccessToken: + description: | + If the authorization server is configured to issue JWT-based access tokens (= if `Service.accessTokenSignAlg` + is set to a `non-null` value), a JWT-based access token is issued along with the original + random-string one. + type: string + authorizationDetails: + $ref: '#/components/schemas/authz_details' + forExternalAttachment: + description: | + the flag which indicates whether the access token is for an external + attachment. + type: boolean + tokenId: + description: | + Set the unique token identifier. + type: string + refreshTokenScopes: + description: The scopes associated with the refresh token. May be null. items: - $ref: '#/components/schemas/access_token' + type: string type: array type: object - token_create_request: + token_update_request: + properties: + accessToken: + description: | + An access token. + type: string + accessTokenExpiresAt: + description: | + A new date at which the access token will expire in milliseconds since the Unix epoch (1970-01-01). + If the `accessTokenExpiresAt` request parameter is not included in a request or its value is 0 + (or negative), the expiration date of the access token is not changed. + format: int64 + type: integer + scopes: + description: | + A new set of scopes assigned to the access token. Scopes that are not supported by the service + and those that the client application associated with the access token is not allowed to request + are ignored on the server side. If the `scopes` request parameter is not included in a request or + its value is `null`, the scopes of the access token are not changed. Note that `properties` parameter + is accepted only when `Content-Type` of the request is `application/json`, so don't use `application/x-www-form-urlencoded` + if you want to specify `properties`. + items: + type: string + type: array + properties: + description: | + A new set of properties assigned to the access token. If the `properties` request parameter is + not included in a request or its value is null, the properties of the access token are not changed. + items: + $ref: '#/components/schemas/Property' + type: array + accessTokenExpiresAtUpdatedOnScopeUpdate: + description: | + A boolean request parameter which indicates whether the API attempts to update the expiration + date of the access token when the scopes linked to the access token are changed by this request. + type: boolean + accessTokenHash: + description: | + The hash of the access token value. Used when the hash of the token is known (perhaps from lookup) + but the value of the token itself is not. The value of the `accessToken` parameter takes precedence. + type: string + accessTokenValueUpdated: + description: | + A boolean request parameter which indicates whether to update the value of the access token in + the data store. If this parameter is set to `true` then a new access token value is generated + by the server and returned in the response. + type: boolean + accessTokenPersistent: + description: | + The flag which indicates whether the access token expires or not. By default, all access tokens + expire after a period of time determined by their service. If this request parameter is `true` + then the access token will not automatically expire and must be revoked or deleted manually at + the service. + + If this request parameter is `true`, the `accessTokenExpiresAt` request parameter is ignored. + If this request parameter is `false`, the `accessTokenExpiresAt` request parameter is processed + normally. + type: boolean + certificateThumbprint: + description: | + The thumbprint of the MTLS certificate bound to this token. If this property is set, a certificate + with the corresponding value MUST be presented with the access token when it is used by a client. + The value of this property must be a SHA256 certificate thumbprint, base64url encoded. + type: string + dpopKeyThumbprint: + description: | + The thumbprint of the public key used for DPoP presentation of this token. If this property is + set, a DPoP proof signed with the corresponding private key MUST be presented with the access + token when it is used by a client. Additionally, the token's `token_type` will be set to 'DPoP'. + type: string + authorizationDetails: + $ref: '#/components/schemas/authz_details' + forExternalAttachment: + description: | + the flag which indicates whether the access token is for an external + attachment. + type: boolean + required: + - accessToken + type: object + token_update_response: + example: + authorizationDetails: + elements: + - dataTypes: + - dataTypes + - dataTypes + identifier: identifier + privileges: + - privileges + - privileges + locations: + - locations + - locations + type: type + otherFields: otherFields + actions: + - actions + - actions + - dataTypes: + - dataTypes + - dataTypes + identifier: identifier + privileges: + - privileges + - privileges + locations: + - locations + - locations + type: type + otherFields: otherFields + actions: + - actions + - actions + refreshTokenExpiresAt: 6 + tokenId: tokenId + accessTokenExpiresAt: 0 + resultCode: resultCode + action: INTERNAL_SERVER_ERROR + forExternalAttachment: true + scopes: + - scopes + - scopes + resultMessage: resultMessage + accessToken: accessToken + tokenType: tokenType + properties: + - hidden: true + value: value + key: key + - hidden: true + value: value + key: key properties: - grantType: - $ref: '#/components/schemas/grant_type' - clientId: + resultCode: + description: The code which represents the result of the API call. + type: string + resultMessage: + description: A short message which explains the result of the API call. + type: string + action: + description: The next action that the authorization server implementation + should take. + enum: + - INTERNAL_SERVER_ERROR + - BAD_REQUEST + - FORBIDDEN + - NOT_FOUND + - OK + type: string + accessToken: + description: The access token which has been specified by the request. + type: string + accessTokenExpiresAt: description: | - The ID of the client application which will be associated with a newly created access token. + The date at which the access token will expire. format: int64 type: integer - subject: + properties: description: | - The subject (= unique identifier) of the user who will be associated with a newly created access - token. This parameter is required unless the grant type is `CLIENT_CREDENTIALS`. The value must - consist of only ASCII characters and its length must not exceed 100. - type: string + The extra properties associated with the access token. + items: + $ref: '#/components/schemas/Property' + type: array scopes: description: | - The scopes which will be associated with a newly created access token. Scopes that are not supported - by the service cannot be specified and requesting them will cause an error. + The scopes associated with the access token. items: type: string type: array - accessTokenDuration: + authorizationDetails: + $ref: '#/components/schemas/authz_details' + tokenType: description: | - The duration of a newly created access token in seconds. If the value is 0, the duration is determined - according to the settings of the service. - format: int64 - type: integer - refreshTokenDuration: + The token type associated with the access token. + type: string + forExternalAttachment: description: | - The duration of a newly created refresh token in seconds. If the value is 0, the duration is - determined according to the settings of the service. - - A refresh token is not created (1) if the service does not support `REFRESH_TOKEN`, or (2) if the - specified grant type is either `IMPLICIT`or `CLIENT_CREDENTIALS`. + the flag which indicates whether the access token is for an external + attachment. + type: boolean + tokenId: + description: | + Set the unique token identifier. + type: string + refreshTokenExpiresAt: + description: |- + The datetime at which the newly issued refresh token will expire. + The value is represented in milliseconds since the Unix epoch (1970-01-01). format: int64 type: integer - properties: - description: | - Extra properties to associate with a newly created access token. Note that properties parameter - is accepted only when the HTTP method of the request is POST and Content-Type of the request is - `application/json`, so don't use `GET` method or `application/x-www-form-urlencoded` if you want - to specify properties. - items: - $ref: '#/components/schemas/Property' - type: array - clientIdAliasUsed: + type: object + token_revoke_request: + properties: + accessTokenIdentifier: description: | - A boolean request parameter which indicates whether to emulate that the client ID alias is used - instead of the original numeric client ID when a new access token is created. - - This has an effect only on the value of the aud claim in a response from [UserInfo endpoint](https://openid.net/specs/openid-connect-core-1_0.html#UserInfo). - When you access the UserInfo endpoint (which is expected to be implemented using Authlete's - `/api/auth/userinfo` API and `/api/auth/userinfo/issue` API) with an access token which has been - created using Authlete's `/api/auth/token/create` API with this property (`clientIdAliasUsed`) - `true`, the client ID alias is used as the value of the aud claim in a response from the UserInfo - endpoint. + The identifier of an access token to revoke - Note that if a client ID alias is not assigned to the client when Authlete's `/api/auth/token/create` - API is called, this property (`clientIdAliasUsed`) has no effect (it is always regarded as `false`). - type: boolean - accessToken: + The hash of an access token is recognized as an identifier as well as the access token itself. + type: string + refreshTokenIdentifier: description: | - The value of the new access token. - - The `/api/auth/token/create` API generates an access token. Therefore, callers of the API do not - have to specify values of newly created access tokens. However, in some cases, for example, if - you want to migrate existing access tokens from an old system to Authlete, you may want to specify - values of access tokens. In such a case, you can specify the value of a newly created access token - by passing a non-null value as the value of accessToken request parameter. The implementation - of the `/api/auth/token/create` uses the value of the accessToken request parameter instead of - generating a new value when the request parameter holds a non-null value. + The identifier of a refresh token to revoke. - Note that if the hash value of the specified access token already exists in Authlete's database, - the access token cannot be inserted and the `/api/auth/token/create` API will report an error. + The hash of a refresh token is recognized as an identifier as well as the refresh token itself. type: string - refreshToken: + clientIdentifier: description: | - The value of the new refresh token. - - The `/api/auth/token/create` API may generate a refresh token. Therefore, callers of the API do - not have to specify values of newly created refresh tokens. However, in some cases, for example, - if you want to migrate existing refresh tokens from an old system to Authlete, you may want to - specify values of refresh tokens. In such a case, you can specify the value of a newly created - refresh token by passing a non-null value as the value of refreshToken request parameter. The - implementation of the `/api/auth/token/create` uses the value of the refreshToken request parameter - instead of generating a new value when the request parameter holds a non-null value. + The client ID of the access token to be revoked. - Note that if the hash value of the specified refresh token already exists in Authlete's database, - the refresh token cannot be inserted and the `/api/auth/token/create` API will report an error. + Both the numeric client ID and the alias are recognized as an identifier + of a client. type: string - accessTokenPersistent: + subject: description: | - Get whether the access token expires or not. By default, all access tokens expire after a period - of time determined by their service. - - If this request parameter is `true`, then the access token will not automatically expire and must - be revoked or deleted manually at the service. If this request parameter is true, the `accessTokenDuration` - request parameter is ignored. - type: boolean - certificateThumbprint: + The subject of a resource owner. + type: string + type: object + token_revoke_response: + example: + resultCode: resultCode + count: 0 + resultMessage: resultMessage + properties: + resultCode: + description: The code which represents the result of the API call. + type: string + resultMessage: + description: A short message which explains the result of the API call. + type: string + count: + description: The number of tokens revoked + type: integer + type: object + token_create_batch_request: + items: + $ref: '#/components/schemas/token_create_batch_request_inner' + type: array + token_create_batch_response: + example: + requestId: requestId + resultCode: resultCode + resultMessage: resultMessage + properties: + resultCode: + description: The code which represents the result of the API call. + type: string + resultMessage: + description: A short message which explains the result of the API call. + type: string + requestId: + description: The ID for the requested batch operation. + type: string + type: object + token_create_batch_status_response: + example: + resultCode: resultCode + resultMessage: resultMessage + status: + result: null + createdAt: 6 + errorDescription: errorDescription + requestId: requestId + modifiedAt: 1 + tokenCount: 0 + errorCode: errorCode + batchKind: batchKind + properties: + resultCode: + description: The code which represents the result of the API call. + type: string + resultMessage: + description: A short message which explains the result of the API call. + type: string + status: + $ref: '#/components/schemas/token_batch_status' + type: object + jose_verify_request: + properties: + jose: description: | - The thumbprint of the MTLS certificate bound to this token. If this property is set, a certificate - with the corresponding value MUST be presented with the access token when it is used by a client. - The value of this property must be a SHA256 certificate thumbprint, base64url encoded. + A JOSE object. type: string - dpopKeyThumbprint: + mandatoryClaims: description: | - The thumbprint of the public key used for DPoP presentation of this token. If this property is - set, a DPoP proof signed with the corresponding private key MUST be presented with the access - token when it is used by a client. Additionally, the token's `token_type` will be set to 'DPoP'. + Mandatory claims that are required to be included in the JOSE object. type: string - authorizationDetails: - $ref: '#/components/schemas/authz_details' - resources: + clockSkew: + description: | + Allowable clock skew in seconds. + format: int32 + type: integer + clientIdentifier: + description: | + The identifier of the client application whose keys are required for verification of the JOSE + object. + type: string + signedByClient: + description: |- + The flag which indicates whether the signature of the JOSE object has been signed by a client + application with the client's private key or a shared symmetric key. + type: boolean + required: + - jose + type: object + jose_verify_response: + example: + valid: true + invalidClaims: + - invalidClaims + - invalidClaims + signatureValid: true + missingClaims: + - missingClaims + - missingClaims + errorDescriptions: + - errorDescriptions + - errorDescriptions + resultCode: resultCode + resultMessage: resultMessage + properties: + resultCode: + description: The code which represents the result of the API call. + type: string + resultMessage: + description: A short message which explains the result of the API call. + type: string + valid: + description: | + The result of the verification on the JOSE object. + type: boolean + signatureValid: + description: | + The result of the signature verification. + type: boolean + missingClaims: description: | - The value of the resources to associate with the token. This property represents the value of - one or more `resource` request parameters which is defined in "RFC8707 Resource Indicators for - OAuth 2.0". + The list of missing claims. items: - format: uri type: string type: array - forExternalAttachment: + invalidClaims: description: | - the flag which indicates whether the access token is for an external - attachment. - type: boolean - jwtAtClaims: + The list of invalid claims. + items: + type: string + type: array + errorDescriptions: description: | - Additional claims that are added to the payload part of the JWT access token. + The list of error messages. + items: + type: string + type: array + type: object + federation_configuration_response: + example: + resultCode: resultCode + action: OK + resultMessage: resultMessage + responseContent: responseContent + properties: + resultCode: + description: The code which represents the result of the API call. type: string - acr: - description: "The Authentication Context Class Reference of the user authentication\ - \ that the authorization server performed \nduring the course of issuing\ - \ the access token.\n" + resultMessage: + description: A short message which explains the result of the API call. type: string - authTime: + action: + description: The next action that the authorization server implementation + should take. + enum: + - OK + - NOT_FOUND + - INTERNAL_SERVER_ERROR + type: string + responseContent: description: | - The time when the user authentication was performed during the course of issuing the access token. - format: int64 - type: integer - clientEntityIdUsed: - description: Flag which indicates whether the entity ID of the client was - used when the request for the access token was made. - type: boolean - required: - - clientId - - grantType + The content that the authorization server implementation is to return to the client application. + Its format varies depending on the value of `action` parameter. + type: string type: object - token_create_response: + federation_registration_request: + properties: + entityConfiguration: + description: | + The entity configuration of a relying party. + type: string + trustChain: + description: | + The trust chain of a relying party. + type: string + type: object + federation_registration_response: example: - clientId: 0 - subject: subject resultCode: resultCode - forExternalAttachment: true - resultMessage: resultMessage - accessToken: accessToken - expiresAt: 6 - expiresIn: 1 - authorizationDetails: - elements: - - dataTypes: - - dataTypes - - dataTypes - identifier: identifier - privileges: - - privileges - - privileges - locations: - - locations - - locations - type: type - otherFields: otherFields - actions: - - actions - - actions - - dataTypes: - - dataTypes - - dataTypes - identifier: identifier - privileges: - - privileges - - privileges - locations: - - locations - - locations - type: type - otherFields: otherFields - actions: - - actions - - actions - jwtAccessToken: jwtAccessToken - action: INTERNAL_SERVER_ERROR - scopes: - - scopes - - scopes - grantType: grantType - tokenType: tokenType - properties: - - hidden: true - value: value - key: key - - hidden: true - value: value - key: key - refreshToken: refreshToken + action: OK + client: + serviceNumber: 6 + applicationType: null + bcNotificationEndpoint: bcNotificationEndpoint + tlsClientAuthSanEmail: tlsClientAuthSanEmail + modifiedAt: 5 + logoUris: + - tag: tag + value: value + - tag: tag + value: value + singleAccessTokenPerSubject: true + dpopRequired: true + signedJwksUri: signedJwksUri + descriptions: + - tag: tag + value: value + - tag: tag + value: value + subjectType: null + clientNames: + - tag: tag + value: value + - tag: tag + value: value + number: 0 + createdAt: 5 + automaticallyRegistered: true + clientType: null + tlsClientCertificateBoundAccessTokens: true + bcDeliveryMode: bcDeliveryMode + idTokenEncryptionEnc: null + clientSecret: clientSecret + selfSignedCertificateKeyId: selfSignedCertificateKeyId + idTokenSignAlg: null + locked: true + responseModes: + - QUERY + - QUERY + clientUri: clientUri + trustChain: + - trustChain + - trustChain + tlsClientAuthSanDns: tlsClientAuthSanDns + organizationName: organizationName + tlsClientAuthSanIp: tlsClientAuthSanIp + policyUris: + - tag: tag + value: value + - tag: tag + value: value + parRequired: true + derivedSectorIdentifier: derivedSectorIdentifier + logoUri: logoUri + requestObjectEncryptionEncMatchRequired: true + redirectUris: + - redirectUris + - redirectUris + requestEncryptionAlg: null + defaultAcrs: + - defaultAcrs + - defaultAcrs + requestObjectEncryptionAlgMatchRequired: true + trustChainExpiresAt: 3 + grantTypes: + - null + - null + authorizationEncryptionEnc: null + pkceS256Required: true + tlsClientAuthSubjectDn: tlsClientAuthSubjectDn + rsRequestSigned: true + tosUri: tosUri + requestUris: + - requestUris + - requestUris + explicitlyRegistered: true + softwareVersion: softwareVersion + authorizationSignAlg: null + registrationAccessTokenHash: registrationAccessTokenHash + extension: + refreshTokenDuration: 9 + requestableScopes: + - requestableScopes + - requestableScopes + tokenExchangePermitted: true + requestableScopesEnabled: true + accessTokenDuration: 7 + jwks: jwks + clientUris: + - tag: tag + value: value + - tag: tag + value: value + clientName: clientName + requestSignAlg: null + tosUris: + - tag: tag + value: value + - tag: tag + value: value + description: description + jwksUri: jwksUri + authorizationDetailsTypes: + - authorizationDetailsTypes + - authorizationDetailsTypes + userInfoEncryptionEnc: null + clientIdAlias: clientIdAlias + authorizationEncryptionAlg: null + clientRegistrationTypes: + - null + - null + loginUri: loginUri + userInfoSignAlg: null + policyUri: policyUri + customMetadata: customMetadata + tokenAuthSignAlg: null + authTimeRequired: true + idTokenEncryptionAlg: null + clientIdAliasEnabled: true + bcUserCodeRequired: true + tokenAuthMethod: null + defaultMaxAge: 2 + trustAnchorId: trustAnchorId + responseTypes: + - null + - null + sectorIdentifierUri: sectorIdentifierUri + clientId: 1 + credentialOfferEndpoint: credentialOfferEndpoint + credentialResponseEncryptionRequired: true + dynamicallyRegistered: true + requestObjectRequired: true + digestAlgorithm: digestAlgorithm + entityId: entityId + requestEncryptionEnc: null + tlsClientAuthSanUri: tlsClientAuthSanUri + frontChannelRequestObjectEncryptionRequired: true + fapiModes: + - null + - null + softwareId: softwareId + trustChainUpdatedAt: 2 + userInfoEncryptionAlg: null + attributes: + - value: value + key: key + - value: value + key: key + rsSignedRequestKeyId: rsSignedRequestKeyId + bcRequestSignAlg: null + pkceRequired: true + contacts: + - contacts + - contacts + resultMessage: resultMessage + responseContent: responseContent properties: resultCode: description: The code which represents the result of the API call. @@ -23442,204 +22124,121 @@ components: description: The next action that the authorization server implementation should take. enum: - - INTERNAL_SERVER_ERROR - - BAD_REQUEST - - FORBIDDEN - OK + - BAD_REQUEST + - NOT_FOUND + - INTERNAL_SERVER_ERROR type: string - accessToken: - description: The newly issued access token. - type: string - clientId: - description: | - The ID of the client application associated with the access token. - format: int64 - type: integer - expiresAt: - description: | - The time at which the access token expires. - format: int64 - type: integer - expiresIn: - description: | - The duration of the newly issued access token in seconds. - format: int64 - type: integer - grantType: + responseContent: description: | - The grant type for the newly issued access token. + The content that the authorization server implementation can use as the value of `WWW-Authenticate` + header on errors. type: string - properties: - description: | - The extra properties associated with the access token. + client: + $ref: '#/components/schemas/Client' + type: object + info_response: + example: + features: + - features + - features + version: version + properties: + version: + description: The server version. + type: string + features: + description: the features that the server supports. items: - $ref: '#/components/schemas/Property' + type: string type: array - refreshToken: - description: | - The newly issued refresh token. - type: string - scopes: - description: | - Scopes which are associated with the access token. + required: + - features + - version + type: object + client_extension_requestable_scopes_get_response: + example: + requestableScopes: + - requestableScopes + - requestableScopes + properties: + requestableScopes: items: type: string type: array - subject: - description: | - The subject (= unique identifier) of the user associated with the newly issued access - token. - type: string - tokenType: - description: | - The token type of the access token. - type: string - jwtAccessToken: - description: | - If the authorization server is configured to issue JWT-based access tokens (= if `Service.accessTokenSignAlg` - is set to a `non-null` value), a JWT-based access token is issued along with the original - random-string one. - type: string - authorizationDetails: - $ref: '#/components/schemas/authz_details' - forExternalAttachment: - description: |- - the flag which indicates whether the access token is for an external - attachment. - type: boolean type: object - token_update_request: + client_extension_requestable_scopes_update_request: properties: - accessToken: - description: | - An access token. - type: string - accessTokenExpiresAt: - description: | - A new date at which the access token will expire in milliseconds since the Unix epoch (1970-01-01). - If the `accessTokenExpiresAt` request parameter is not included in a request or its value is 0 - (or negative), the expiration date of the access token is not changed. - format: int64 - type: integer - scopes: - description: | - A new set of scopes assigned to the access token. Scopes that are not supported by the service - and those that the client application associated with the access token is not allowed to request - are ignored on the server side. If the `scopes` request parameter is not included in a request or - its value is `null`, the scopes of the access token are not changed. Note that `properties` parameter - is accepted only when `Content-Type` of the request is `application/json`, so don't use `application/x-www-form-urlencoded` - if you want to specify `properties`. + requestableScopes: + description: |- + The set of scopes that the client application is allowed to request. + This parameter will be one of the following. Details are described in the description. + + - null + - an empty set + - a set with at least one element + + If this parameter contains scopes that the service does not support, those scopes are just + ignored. Also, if this parameter is `null` or is not included in the request, it is equivalent + to calling `/client/extension/requestable_scopes/delete` API. items: type: string type: array - properties: - description: | - A new set of properties assigned to the access token. If the `properties` request parameter is - not included in a request or its value is null, the properties of the access token are not changed. + type: object + client_extension_requestable_scopes_update_response: + example: + requestableScopes: + - requestableScopes + - requestableScopes + properties: + requestableScopes: items: - $ref: '#/components/schemas/Property' + type: string type: array - accessTokenExpiresAtUpdatedOnScopeUpdate: - description: | - A boolean request parameter which indicates whether the API attempts to update the expiration - date of the access token when the scopes linked to the access token are changed by this request. - type: boolean - accessTokenHash: + type: object + hsk_create_request: + properties: + kty: description: | - The hash of the access token value. Used when the hash of the token is known (perhaps from lookup) - but the value of the token itself is not. The value of the `accessToken` parameter takes precedence. + The key type (EC or RSA) type: string - accessTokenValueUpdated: - description: | - A boolean request parameter which indicates whether to update the value of the access token in - the data store. If this parameter is set to `true` then a new access token value is generated - by the server and returned in the response. - type: boolean - accessTokenPersistent: - description: | - The flag which indicates whether the access token expires or not. By default, all access tokens - expire after a period of time determined by their service. If this request parameter is `true` - then the access token will not automatically expire and must be revoked or deleted manually at - the service. - - If this request parameter is `true`, the `accessTokenExpiresAt` request parameter is ignored. - If this request parameter is `false`, the `accessTokenExpiresAt` request parameter is processed - normally. - type: boolean - certificateThumbprint: + use: + description: "The key on the HSM. \nWhen the key use is \"sig\" (signature),\ + \ the private key on the HSM is used to sign data and the corresponding\ + \ public key is used to verify the signature.\nWhen the key use is \"\ + enc\" (encryption), the private key on the HSM is used to decrypt encrypted\ + \ data which have been encrypted with the corresponding public key\n" + type: string + kid: description: | - The thumbprint of the MTLS certificate bound to this token. If this property is set, a certificate - with the corresponding value MUST be presented with the access token when it is used by a client. - The value of this property must be a SHA256 certificate thumbprint, base64url encoded. + Key ID for the key on the HSM. type: string - dpopKeyThumbprint: + hsmName: description: | - The thumbprint of the public key used for DPoP presentation of this token. If this property is - set, a DPoP proof signed with the corresponding private key MUST be presented with the access - token when it is used by a client. Additionally, the token's `token_type` will be set to 'DPoP'. + The name of the HSM. + The identifier for the HSM that sits behind the Authlete server. For example, "google". type: string - authorizationDetails: - $ref: '#/components/schemas/authz_details' - forExternalAttachment: + handle: description: | - the flag which indicates whether the access token is for an external - attachment. - type: boolean - required: - - accessToken - type: object - token_update_response: - example: - authorizationDetails: - elements: - - dataTypes: - - dataTypes - - dataTypes - identifier: identifier - privileges: - - privileges - - privileges - locations: - - locations - - locations - type: type - otherFields: otherFields - actions: - - actions - - actions - - dataTypes: - - dataTypes - - dataTypes - identifier: identifier - privileges: - - privileges - - privileges - locations: - - locations - - locations - type: type - otherFields: otherFields - actions: - - actions - - actions - refreshTokenExpiresAt: 6 - accessTokenExpiresAt: 0 + The handle for the key on the HSM. + A handle is a base64url-encoded 256-bit random value (43 letters) which is assigned by Authlete on the call of the /api/hsk/create API + type: string + publicKey: + description: The public key that corresponds to the key on the HSM. + type: string + type: object + hsk_create_response: + example: + hsk: + kty: kty + use: use + kid: kid + hsmName: hsmName + handle: handle + publicKey: publicKey resultCode: resultCode - action: INTERNAL_SERVER_ERROR - forExternalAttachment: true - scopes: - - scopes - - scopes + action: SUCCESS resultMessage: resultMessage - accessToken: accessToken - tokenType: tokenType - properties: - - hidden: true - value: value - key: key - - hidden: true - value: value - key: key properties: resultCode: description: The code which represents the result of the API call. @@ -23648,81 +22247,93 @@ components: description: A short message which explains the result of the API call. type: string action: - description: The next action that the authorization server implementation - should take. + description: Result of the API call enum: - - INTERNAL_SERVER_ERROR - - BAD_REQUEST - - FORBIDDEN + - SUCCESS + - INVALID_REQUEST - NOT_FOUND - - OK + - SERVER_ERROR type: string - accessToken: - description: The access token which has been specified by the request. + hsk: + $ref: '#/components/schemas/Hsk' + type: object + hsk_delete_response: + example: + hsk: + kty: kty + use: use + kid: kid + hsmName: hsmName + handle: handle + publicKey: publicKey + resultCode: resultCode + action: SUCCESS + resultMessage: resultMessage + properties: + resultCode: + description: The code which represents the result of the API call. type: string - accessTokenExpiresAt: - description: | - The date at which the access token will expire. - format: int64 - type: integer - properties: - description: | - The extra properties associated with the access token. - items: - $ref: '#/components/schemas/Property' - type: array - scopes: - description: | - The scopes associated with the access token. - items: - type: string - type: array - authorizationDetails: - $ref: '#/components/schemas/authz_details' - tokenType: - description: | - The token type associated with the access token. + resultMessage: + description: A short message which explains the result of the API call. type: string - forExternalAttachment: - description: | - the flag which indicates whether the access token is for an external - attachment. - type: boolean - refreshTokenExpiresAt: - description: The date at which the refresh token will expire. - format: int64 - type: integer + action: + description: Result of the API call + enum: + - SUCCESS + - INVALID_REQUEST + - NOT_FOUND + - SERVER_ERROR + type: string + hsk: + $ref: '#/components/schemas/Hsk' type: object - token_revoke_request: + hsk_get_response: + example: + hsk: + kty: kty + use: use + kid: kid + hsmName: hsmName + handle: handle + publicKey: publicKey + resultCode: resultCode + action: SUCCESS + resultMessage: resultMessage properties: - accessTokenIdentifier: - description: | - The identifier of an access token to revoke - - The hash of an access token is recognized as an identifier as well as the access token itself. - type: string - refreshTokenIdentifier: - description: | - The identifier of a refresh token to revoke. - - The hash of a refresh token is recognized as an identifier as well as the refresh token itself. + resultCode: + description: The code which represents the result of the API call. type: string - clientIdentifier: - description: | - The client ID of the access token to be revoked. - - Both the numeric client ID and the alias are recognized as an identifier - of a client. + resultMessage: + description: A short message which explains the result of the API call. type: string - subject: - description: | - The subject of a resource owner. + action: + description: Result of the API call + enum: + - SUCCESS + - INVALID_REQUEST + - NOT_FOUND + - SERVER_ERROR type: string + hsk: + $ref: '#/components/schemas/Hsk' type: object - token_revoke_response: + hsk_get_list_response: example: + hsks: + - kty: kty + use: use + kid: kid + hsmName: hsmName + handle: handle + publicKey: publicKey + - kty: kty + use: use + kid: kid + hsmName: hsmName + handle: handle + publicKey: publicKey resultCode: resultCode - count: 0 + action: SUCCESS resultMessage: resultMessage properties: resultCode: @@ -23731,53 +22342,114 @@ components: resultMessage: description: A short message which explains the result of the API call. type: string - count: - description: The number of tokens revoked - type: integer + action: + description: Result of the API call + enum: + - SUCCESS + - INVALID_REQUEST + - SERVER_ERROR + type: string + hsks: + description: List of HSK + items: + $ref: '#/components/schemas/Hsk' + type: array type: object - jose_verify_request: + vci_metadata_request: properties: - jose: - description: | - A JOSE object. + pretty: + description: |- + The flag indicating whether the metadata is written in the pretty + format or not. + type: boolean + required: + - pretty + type: object + vci_metadata_response: + example: + resultCode: resultCode + action: OK + resultMessage: resultMessage + responseContent: responseContent + properties: + resultCode: + description: The code which represents the result of the API call. type: string - mandatoryClaims: - description: | - Mandatory claims that are required to be included in the JOSE object. + resultMessage: + description: A short message which explains the result of the API call. type: string - clockSkew: - description: | - Allowable clock skew in seconds. - format: int32 - type: integer - clientIdentifier: + action: description: | - The identifier of the client application whose keys are required for verification of the JOSE - object. + The next action that the implementation of the credential issuer + metadata endpoint (`/.well-known/openid-credential-issuer`) + should take after getting a response from Authlete's + `/vci/metadata` API. + enum: + - OK + - NOT_FOUND + - INTERNAL_SERVER_ERROR type: string - signedByClient: + responseContent: description: |- - The flag which indicates whether the signature of the JOSE object has been signed by a client - application with the client's private key or a shared symmetric key. + Get the content that the implementation of the credential issuer + metadata endpoint should use when it constructs a response. + type: string + type: object + vci_jwtissuer_request: + properties: + pretty: + description: |- + The flag indicating whether the metadata is written in the pretty + format or not. type: boolean required: - - jose + - pretty type: object - jose_verify_response: + vci_jwtissuer_response: + example: + resultCode: resultCode + action: OK + resultMessage: resultMessage + responseContent: responseContent + properties: + resultCode: + description: The code which represents the result of the API call. + type: string + resultMessage: + description: A short message which explains the result of the API call. + type: string + action: + description: | + The next action that the implementation of the JWT issuer metadata + endpoint (`/.well-known/jwt-issuer`) should take after getting + a response from Authlete's `/vci/jwtissuer` API. + enum: + - OK + - NOT_FOUND + - INTERNAL_SERVER_ERROR + type: string + responseContent: + description: |- + Get the content that the implementation of the credential issuer + metadata endpoint should use when it constructs a response. + type: string + type: object + vci_jwks_request: + properties: + pretty: + description: |- + The flag indicating whether the metadata is written in the pretty + format or not. + type: boolean + required: + - pretty + type: object + vci_jwks_response: example: - valid: true - invalidClaims: - - invalidClaims - - invalidClaims - signatureValid: true - missingClaims: - - missingClaims - - missingClaims - errorDescriptions: - - errorDescriptions - - errorDescriptions resultCode: resultCode + action: OK resultMessage: resultMessage + responseContent: responseContent properties: resultCode: description: The code which represents the result of the API call. @@ -23785,39 +22457,116 @@ components: resultMessage: description: A short message which explains the result of the API call. type: string - valid: + action: description: | - The result of the verification on the JOSE object. + The next action that the implementation of the JWK Set document + endpoint of the credential issuer should take after getting a + response from Authlete's `/vci/jwks` API. + enum: + - OK + - NOT_FOUND + - INTERNAL_SERVER_ERROR + type: string + responseContent: + description: |- + Get the content that the implementation of the credential issuer + metadata endpoint should use when it constructs a response. + type: string + type: object + vci_offer_create_request: + properties: + credentials: + description: The value of the `credentials` object in the JSON format. + type: string + authorizationCodeGrantIncluded: + description: | + The flag indicating whether the `authorization_code` object is + included in the `grants` object. type: boolean - signatureValid: + issuerStateIncluded: description: | - The result of the signature verification. + The flag indicating whether the `issuer_state` property is + included in the `authorization_code` object in the `grants` + object. type: boolean - missingClaims: + preAuthorizedCodeGrantIncluded: description: | - The list of missing claims. - items: - type: string - type: array - invalidClaims: + The flag to include the + `urn:ietf:params:oauth:grant-type:pre-authorized_code` object + in the `grants` object. + type: boolean + userPinRequired: description: | - The list of invalid claims. + The value of the `user_pin_required` property in the + `urn:ietf:params:oauth:grant-type:pre-authorized_code` object in + the `grants` object. + type: boolean + userPinLength: + description: The length of the user PIN to generate. + format: int32 + type: integer + subject: + description: The subject associated with the credential offer. + type: string + duration: + description: The duration of the credential offer. + format: int64 + type: integer + context: + description: The general-purpose arbitrary string. + type: string + properties: + description: Extra properties to associate with the credential offer. items: - type: string + $ref: '#/components/schemas/Property' type: array - errorDescriptions: + jwtAtClaims: description: | - The list of error messages. - items: - type: string - type: array + Additional claims that are added to the payload part of the JWT + access token. + type: string + authTime: + description: | + The time at which the user authentication was performed during + the course of issuing the credential offer. + format: int64 + type: integer + acr: + description: |- + The Authentication Context Class Reference of the user authentication + performed during the course of issuing the credential offer. + type: string type: object - federation_configuration_response: + vci_offer_create_response: example: resultCode: resultCode - action: OK + action: CREATED resultMessage: resultMessage - responseContent: responseContent + info: + credentialIssuer: credentialIssuer + issuerState: issuerState + identifier: identifier + credentials: credentials + authorizationCodeGrantIncluded: true + subject: subject + issuerStateIncluded: true + userPinRequired: true + authTime: 5 + credentialOffer: credentialOffer + expiresAt: 5 + userPin: userPin + acr: acr + preAuthorizedCodeGrantIncluded: true + context: context + jwtAtClaims: jwtAtClaims + preAuthorizedCode: preAuthorizedCode + properties: + - hidden: true + value: value + key: key + - hidden: true + value: value + key: key properties: resultCode: description: The code which represents the result of the API call. @@ -23826,183 +22575,91 @@ components: description: A short message which explains the result of the API call. type: string action: - description: The next action that the authorization server implementation - should take. + description: The result of the `/vci/offer/create` API call. enum: - - OK - - NOT_FOUND - - INTERNAL_SERVER_ERROR - type: string - responseContent: - description: | - The content that the authorization server implementation is to return to the client application. - Its format varies depending on the value of `action` parameter. + - CREATED + - FORBIDDEN + - CALLER_ERROR + - AUTHLETE_ERROR type: string + info: + $ref: '#/components/schemas/credential_offer_info' type: object - federation_registration_request: + vci_offer_info_request: properties: - entityConfiguration: - description: | - The entity configuration of a relying party. - type: string - trustChain: - description: | - The trust chain of a relying party. + identifier: + description: The identifier of the credential offer. type: string type: object - federation_registration_response: + vci_offer_info_response: example: resultCode: resultCode action: OK - client: - serviceNumber: 6 - applicationType: null - bcNotificationEndpoint: bcNotificationEndpoint - tlsClientAuthSanEmail: tlsClientAuthSanEmail - modifiedAt: 5 - logoUris: - - tag: tag - value: value - - tag: tag - value: value - singleAccessTokenPerSubject: true - dpopRequired: true - signedJwksUri: signedJwksUri - descriptions: - - tag: tag - value: value - - tag: tag - value: value - subjectType: null - clientNames: - - tag: tag - value: value - - tag: tag - value: value - number: 0 - createdAt: 5 - automaticallyRegistered: true - clientType: null - tlsClientCertificateBoundAccessTokens: true - bcDeliveryMode: bcDeliveryMode - idTokenEncryptionEnc: null - clientSecret: clientSecret - selfSignedCertificateKeyId: selfSignedCertificateKeyId - idTokenSignAlg: null - locked: true - clientUri: clientUri - trustChain: - - trustChain - - trustChain - tlsClientAuthSanDns: tlsClientAuthSanDns - organizationName: organizationName - tlsClientAuthSanIp: tlsClientAuthSanIp - policyUris: - - tag: tag - value: value - - tag: tag - value: value - parRequired: true - derivedSectorIdentifier: derivedSectorIdentifier - logoUri: logoUri - requestObjectEncryptionEncMatchRequired: true - redirectUris: - - redirectUris - - redirectUris - requestEncryptionAlg: null - defaultAcrs: - - defaultAcrs - - defaultAcrs - requestObjectEncryptionAlgMatchRequired: true - trustChainExpiresAt: 3 - grantTypes: - - null - - null - authorizationEncryptionEnc: null - pkceS256Required: true - tlsClientAuthSubjectDn: tlsClientAuthSubjectDn - rsRequestSigned: true - tosUri: tosUri - requestUris: - - requestUris - - requestUris - explicitlyRegistered: true - softwareVersion: softwareVersion - authorizationSignAlg: null - registrationAccessTokenHash: registrationAccessTokenHash - extension: - refreshTokenDuration: 9 - requestableScopes: - - requestableScopes - - requestableScopes - tokenExchangePermitted: true - requestableScopesEnabled: true - accessTokenDuration: 7 - jwks: jwks - clientUris: - - tag: tag - value: value - - tag: tag - value: value - clientName: clientName - requestSignAlg: null - tosUris: - - tag: tag - value: value - - tag: tag + resultMessage: resultMessage + info: + credentialIssuer: credentialIssuer + issuerState: issuerState + identifier: identifier + credentials: credentials + authorizationCodeGrantIncluded: true + subject: subject + issuerStateIncluded: true + userPinRequired: true + authTime: 5 + credentialOffer: credentialOffer + expiresAt: 5 + userPin: userPin + acr: acr + preAuthorizedCodeGrantIncluded: true + context: context + jwtAtClaims: jwtAtClaims + preAuthorizedCode: preAuthorizedCode + properties: + - hidden: true value: value - description: description - jwksUri: jwksUri - authorizationDetailsTypes: - - authorizationDetailsTypes - - authorizationDetailsTypes - userInfoEncryptionEnc: null - clientIdAlias: clientIdAlias - authorizationEncryptionAlg: null - clientRegistrationTypes: - - null - - null - loginUri: loginUri - userInfoSignAlg: null - policyUri: policyUri - customMetadata: customMetadata - tokenAuthSignAlg: null - authTimeRequired: true - idTokenEncryptionAlg: null - clientIdAliasEnabled: true - bcUserCodeRequired: true - tokenAuthMethod: null - defaultMaxAge: 2 - trustAnchorId: trustAnchorId - responseTypes: - - null - - null - sectorIdentifierUri: sectorIdentifierUri - clientId: 1 - dynamicallyRegistered: true - requestObjectRequired: true - digestAlgorithm: digestAlgorithm - entityId: entityId - requestEncryptionEnc: null - tlsClientAuthSanUri: tlsClientAuthSanUri - frontChannelRequestObjectEncryptionRequired: true - softwareId: softwareId - trustChainUpdatedAt: 2 - userInfoEncryptionAlg: null - developer: developer - attributes: - - value: value key: key - - value: value + - hidden: true + value: value key: key - rsSignedRequestKeyId: rsSignedRequestKeyId - bcRequestSignAlg: null - pkceRequired: true - contacts: - - contacts - - contacts + properties: + resultCode: + description: The code which represents the result of the API call. + type: string + resultMessage: + description: A short message which explains the result of the API call. + type: string + action: + description: The result of the `/vci/offer/info` API call. + enum: + - OK + - FORBIDDEN + - NOT_FOUND + - CALLER_ERROR + - AUTHLETE_ERROR + type: string + info: + $ref: '#/components/schemas/credential_offer_info' + type: object + vci_single_parse_request: + properties: + accessToken: + description: The access token that came along with the credential request. + type: string + requestContent: + description: The message body of the credential request. + type: string + type: object + vci_single_parse_response: + example: + resultCode: resultCode + action: OK resultMessage: resultMessage responseContent: responseContent + info: + bindingKey: bindingKey + identifier: identifier + format: format + details: details properties: resultCode: description: The code which represents the result of the API call. @@ -24011,84 +22668,177 @@ components: description: A short message which explains the result of the API call. type: string action: - description: The next action that the authorization server implementation - should take. + description: The next action that the credential endpoint should take. enum: - OK - BAD_REQUEST - - NOT_FOUND + - UNAUTHORIZED + - FORBIDDEN + - INTERNAL_SERVER_ERROR + type: string + responseContent: + description: The content of the response to the request sender. + type: string + info: + $ref: '#/components/schemas/credential_request_info' + type: object + vci_single_issue_request: + properties: + accessToken: + description: The access token that came along with the credential request. + type: string + order: + $ref: '#/components/schemas/credential_issuance_order' + type: object + vci_single_issue_response: + example: + resultCode: resultCode + action: OK + resultMessage: resultMessage + responseContent: responseContent + transactionId: transactionId + properties: + resultCode: + description: The code which represents the result of the API call. + type: string + resultMessage: + description: A short message which explains the result of the API call. + type: string + action: + description: | + The next action that the implementation of the credential endpoint + should take. + enum: + - OK + - ACCEPTED + - UNAUTHORIZED + - FORBIDDEN - INTERNAL_SERVER_ERROR + - CALLER_ERROR type: string responseContent: description: | - The content that the authorization server implementation can use as the value of `WWW-Authenticate` - header on errors. + The content of the response that the implementation of the credential + endpoint should return. + type: string + transactionId: + description: The issued transaction ID. type: string - client: - $ref: '#/components/schemas/Client' type: object - info_response: + vci_batch_parse_request: + properties: + accessToken: + description: The access token that came along with the credential request. + type: string + requestContent: + description: The message body of the batch credential request. + type: string + type: object + vci_batch_parse_response: example: - features: - - features - - features - version: version + resultCode: resultCode + action: OK + resultMessage: resultMessage + responseContent: responseContent + info: + - bindingKey: bindingKey + identifier: identifier + format: format + details: details + - bindingKey: bindingKey + identifier: identifier + format: format + details: details properties: - version: - description: The server version. + resultCode: + description: The code which represents the result of the API call. type: string - features: - description: the features that the server supports. + resultMessage: + description: A short message which explains the result of the API call. + type: string + action: + description: The next action that the batch credential endpoint should take. + enum: + - OK + - BAD_REQUEST + - UNAUTHORIZED + - FORBIDDEN + - INTERNAL_SERVER_ERROR + type: string + responseContent: + description: The content of the response to the request sender. + type: string + info: + description: | + Information about the credential requests in the batch credential + request. items: - type: string + $ref: '#/components/schemas/credential_request_info' type: array - required: - - features - - version type: object - hsk_create_request: + vci_batch_issue_request: properties: - kty: - description: | - The key type (EC or RSA) + accessToken: + description: The access token that came along with the credential request. type: string - use: - description: "The key on the HSM. \nWhen the key use is \"sig\" (signature),\ - \ the private key on the HSM is used to sign data and the corresponding\ - \ public key is used to verify the signature.\nWhen the key use is \"\ - enc\" (encryption), the private key on the HSM is used to decrypt encrypted\ - \ data which have been encrypted with the corresponding public key\n" + orders: + description: The instructions for issuance of credentials and/or transaction + IDs. + items: + $ref: '#/components/schemas/credential_issuance_order' + type: array + type: object + vci_batch_issue_response: + example: + resultCode: resultCode + action: OK + resultMessage: resultMessage + responseContent: responseContent + properties: + resultCode: + description: The code which represents the result of the API call. type: string - kid: - description: | - Key ID for the key on the HSM. + resultMessage: + description: A short message which explains the result of the API call. type: string - hsmName: + action: description: | - The name of the HSM. - The identifier for the HSM that sits behind the Authlete server. For example, "google". + The next action that the implementation of the batch credential + endpoint should take. + enum: + - OK + - UNAUTHORIZED + - FORBIDDEN + - INTERNAL_SERVER_ERROR + - CALLER_ERROR type: string - handle: + responseContent: description: | - The handle for the key on the HSM. - A handle is a base64url-encoded 256-bit random value (43 letters) which is assigned by Authlete on the call of the /api/hsk/create API + The content of the response that the implementation of the batch + credential endpoint should return. type: string - publicKey: - description: The public key that corresponds to the key on the HSM. + type: object + vci_deferred_parse_request: + properties: + accessToken: + description: The access token that came along with the deferred credential + request. + type: string + requestContent: + description: The message body of the deferred credential request. type: string type: object - hsk_create_response: + vci_deferred_parse_response: example: - hsk: - kty: kty - use: use - kid: kid - hsmName: hsmName - handle: handle - publicKey: publicKey resultCode: resultCode - action: SUCCESS + action: OK resultMessage: resultMessage + responseContent: responseContent + info: + bindingKey: bindingKey + identifier: identifier + format: format + details: details properties: resultCode: description: The code which represents the result of the API call. @@ -24097,28 +22847,32 @@ components: description: A short message which explains the result of the API call. type: string action: - description: Result of the API call + description: The next action that the deferred credential endpoint should + take. enum: - - SUCCESS - - INVALID_REQUEST - - NOT_FOUND - - SERVER_ERROR + - OK + - BAD_REQUEST + - UNAUTHORIZED + - FORBIDDEN + - INTERNAL_SERVER_ERROR type: string - hsk: - $ref: '#/components/schemas/Hsk' + responseContent: + description: The content of the response to the request sender. + type: string + info: + $ref: '#/components/schemas/credential_request_info' type: object - hsk_delete_response: + vci_deferred_issue_request: + properties: + order: + $ref: '#/components/schemas/credential_issuance_order' + type: object + vci_deferred_issue_response: example: - hsk: - kty: kty - use: use - kid: kid - hsmName: hsmName - handle: handle - publicKey: publicKey resultCode: resultCode - action: SUCCESS + action: OK resultMessage: resultMessage + responseContent: responseContent properties: resultCode: description: The code which represents the result of the API call. @@ -24127,83 +22881,91 @@ components: description: A short message which explains the result of the API call. type: string action: - description: Result of the API call + description: | + The next action that the implementation of the deferred credential + endpoint should take. enum: - - SUCCESS - - INVALID_REQUEST - - NOT_FOUND - - SERVER_ERROR + - OK + - FORBIDDEN + - INTERNAL_SERVER_ERROR + - CALLER_ERROR + type: string + responseContent: + description: |- + The content of the response that the implementation of the deferred + credential endpoint should return. type: string - hsk: - $ref: '#/components/schemas/Hsk' type: object - hsk_get_response: + authorization_ticket_info_request: + properties: + ticket: + description: The ticket that has been issued from the `/auth/authorization` + API. + type: string + required: + - ticket + type: object + authorization_ticket_info_response: example: - hsk: - kty: kty - use: use - kid: kid - hsmName: hsmName - handle: handle - publicKey: publicKey resultCode: resultCode - action: SUCCESS + action: OK resultMessage: resultMessage + info: info properties: + info: + description: Information about the ticket. + type: string + action: + description: The result of the `/auth/authorization/ticket/info` API call. + enum: + - OK + - NOT_FOUND + - CALLER_ERROR + - AUTHLETE_ERROR + type: string resultCode: description: The code which represents the result of the API call. type: string resultMessage: description: A short message which explains the result of the API call. type: string - action: - description: Result of the API call - enum: - - SUCCESS - - INVALID_REQUEST - - NOT_FOUND - - SERVER_ERROR + type: object + authorization_ticket_update_request: + properties: + ticket: + description: The ticket. type: string - hsk: - $ref: '#/components/schemas/Hsk' + info: + description: The information about the ticket. + type: string + required: + - info + - ticket type: object - hsk_get_list_response: + authorization_ticket_update_response: example: - hsks: - - kty: kty - use: use - kid: kid - hsmName: hsmName - handle: handle - publicKey: publicKey - - kty: kty - use: use - kid: kid - hsmName: hsmName - handle: handle - publicKey: publicKey resultCode: resultCode - action: SUCCESS + action: OK resultMessage: resultMessage + info: info properties: + info: + description: Information about the ticket. + type: string + action: + description: The result of the /auth/authorization/ticket/info API call. + enum: + - OK + - NOT_FOUND + - CALLER_ERROR + - AUTHLETE_ERROR + type: string resultCode: description: The code which represents the result of the API call. type: string resultMessage: description: A short message which explains the result of the API call. type: string - action: - description: Result of the API call - enum: - - SUCCESS - - INVALID_REQUEST - - SERVER_ERROR - type: string - hsks: - description: List of HSK - items: - $ref: '#/components/schemas/Hsk' - type: array type: object access_token: example: @@ -24630,6 +23392,15 @@ components: - AUTOMATIC - EXPLICIT type: string + fapi_mode: + enum: + - FAPI1_ADVANCED + - FAPI1_BASELINE + - FAPI2_MESSAGE_SIGNING_AUTH_REQ + - FAPI2_MESSAGE_SIGNING_AUTH_RES + - FAPI2_MESSAGE_SIGNING_INTROSPECTION_RES + - FAPI2_SECURITY + type: string delivery_mode: enum: - PING @@ -24664,62 +23435,433 @@ components: - FAPI - OPEN_BANKING type: string - sns_credentials: + user_code_charset: + description: | + The character set for end-user verification codes (`user_code`) for Device Flow. + enum: + - BASE20 + - NUMERIC + type: string + verified_claims_validation_schema: + description: | + The verified claims validation schema set. + enum: + - standard + - standard+id_document + - null + nullable: true + type: string + attachment_type: + description: | + Supported attachment types. This property corresponds to the `attachments_supported` + server metadata which was added by the third implementer's draft of OpenID Connect + for Identity Assurance 1.0. + enum: + - EMBEDDED + - EXTERNAL + type: string + trust_anchor: + example: + jwks: jwks + entityId: entityId + properties: + entityId: + description: | + the entity ID of the trust anchor + type: string + jwks: + description: | + the JWK Set document containing public keys of the trust anchor + type: string + type: object + credential_issuer_metadata: example: - apiKey: apiKey - sns: sns - apiSecret: apiSecret + credentialIssuer: credentialIssuer + credentialEndpoint: true + deferredCredentialEndpoint: deferredCredentialEndpoint + authorizationServer: authorizationServer + batchCredentialEndpoint: 6 + credentialsSupported: true + properties: + credentialIssuer: + description: The identifier of a credential request. + type: string + authorizationServer: + description: | + The identifier of the authorization server that the credential issuer + relies on for authorization. + type: string + credentialEndpoint: + description: The URL of the credential endpoint of the credential issuer. + type: boolean + batchCredentialEndpoint: + description: The URL of the batch credential endpoint of the credential + issuer. + format: int64 + type: integer + deferredCredentialEndpoint: + description: The URL of the deferred credential endpoint of the credential + issuer. + type: string + credentialsSupported: + description: A JSON array describing supported credentials. + type: boolean + type: object + sns_credentials: properties: sns: description: SNS. type: string - apiKey: - description: API key. + apiKey: + description: API key. + type: string + apiSecret: + description: API secret. + type: string + type: object + credential_offer_info: + example: + credentialIssuer: credentialIssuer + issuerState: issuerState + identifier: identifier + credentials: credentials + authorizationCodeGrantIncluded: true + subject: subject + issuerStateIncluded: true + userPinRequired: true + authTime: 5 + credentialOffer: credentialOffer + expiresAt: 5 + userPin: userPin + acr: acr + preAuthorizedCodeGrantIncluded: true + context: context + jwtAtClaims: jwtAtClaims + preAuthorizedCode: preAuthorizedCode + properties: + - hidden: true + value: value + key: key + - hidden: true + value: value + key: key + properties: + identifier: + description: The identifier of the credential offer. + type: string + credentialOffer: + description: The credential offer in the JSON format. + type: string + credentialIssuer: + description: The identifier of the credential issuer. + type: string + credentials: + description: The value of the `credentials` object in the JSON format. + type: string + authorizationCodeGrantIncluded: + description: | + The flag indicating whether the `authorization_code` object is + included in the `grants` object. + type: boolean + issuerStateIncluded: + description: | + The flag indicating whether the `issuer_state` property is + included in the `authorization_code` object in the `grants` + object. + type: boolean + issuerState: + description: | + The value of the `issuer_state` property in the + `authorization_code` object in the `grants` object. + type: string + preAuthorizedCodeGrantIncluded: + description: | + The flag indicating whether the + `urn:ietf:params:oauth:grant-type:pre-authorized_code` object is + included in the `grants` object. + type: boolean + preAuthorizedCode: + description: | + The value of the `pre-authorized_code` property in the + `urn:ietf:params:oauth:grant-type:pre-authorized_code` object in + the `grants` object. + type: string + userPinRequired: + description: | + The value of the `user_pin_required` property in the + `urn:ietf:params:oauth:grant-type:pre-authorized_code` object in + the `grants` object. + type: boolean + userPin: + description: The value of the user PIN associated with the credential offer. + type: string + subject: + description: The subject associated with the credential offer. + type: string + expiresAt: + description: The time at which the credential offer will expire. + format: int64 + type: integer + context: + description: The general-purpose arbitrary string. + type: string + properties: + description: Extra properties to associate with the credential offer. + items: + $ref: '#/components/schemas/Property' + type: array + jwtAtClaims: + description: | + Additional claims that are added to the payload part of the JWT + access token. + type: string + authTime: + description: | + The time at which the user authentication was performed during + the course of issuing the credential offer. + format: int64 + type: integer + acr: + description: |- + The Authentication Context Class Reference of the user authentication + performed during the course of issuing the credential offer. + type: string + type: object + credential_request_info: + example: + bindingKey: bindingKey + identifier: identifier + format: format + details: details + properties: + identifier: + description: The identifier of the credential offer. + type: string + format: + description: The value of the format parameter in the credential request. + type: string + bindingKey: + description: The binding key specified by the proof in the credential request. + type: string + details: + description: The details about the credential request. + type: string + type: object + credential_issuance_order: + properties: + requestIdentifier: + description: The identifier of a credential request. + type: string + credentialPayload: + description: The additional payload that will be added into a credential + to be issued. + type: string + issuanceDeferred: + description: The flag indicating whether to defer credential issuance. + type: boolean + credentialDuration: + description: The duration of a credential to be issued. + format: int64 + type: integer + signingKeyId: + description: |- + The key ID of a private key that should be used for signing a credential + to be issued. + type: string + type: object + api_result_code: + type: object + client_limited: + example: + clientNames: + - tag: tag + value: value + - tag: tag + value: value + number: 5 + clientId: 5 + clientType: null + clientName: clientName + description: description + clientIdAlias: clientIdAlias + clientIdAliasEnabled: true + descriptions: + - tag: tag + value: value + - tag: tag + value: value + properties: + number: + description: | + The sequential number of the client. The value of this property is assigned by Authlete. + format: int32 + readOnly: true + type: integer + clientName: + description: | + The name of the client application. This property corresponds to `client_name` in + [OpenID Connect Dynamic Client Registration 1.0, 2. Client Metadata](https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata). + type: string + clientNames: + description: | + Client names with language tags. If the client application has different names for different + languages, this property can be used to register the names. + items: + $ref: '#/components/schemas/tagged_value' + type: array + description: + description: The description about the client application. + type: string + descriptions: + description: | + Descriptions about the client application with language tags. If the client application has different + descriptions for different languages, this property can be used to register the descriptions. + items: + $ref: '#/components/schemas/tagged_value' + type: array + clientId: + description: The client identifier used in Authlete API calls. The value + of this property is assigned by Authlete. + format: int64 + readOnly: true + type: integer + clientIdAlias: + description: | + The value of the client's `client_id` property used in OAuth and OpenID Connect calls. By + default, this is a string version of the `clientId` property. + type: string + clientIdAliasEnabled: + description: Deprecated. Always set to `true`. + type: boolean + clientType: + $ref: '#/components/schemas/client_type' + type: object + client_limited_authorization: + example: + clientId: 6 + clientName: clientName + policyUris: + - tag: tag + value: value + - tag: tag + value: value + tosUris: + - tag: tag + value: value + - tag: tag + value: value + logoUris: + - tag: tag + value: value + - tag: tag + value: value + description: description + logoUri: logoUri + clientIdAlias: clientIdAlias + descriptions: + - tag: tag + value: value + - tag: tag + value: value + clientNames: + - tag: tag + value: value + - tag: tag + value: value + number: 0 + clientType: null + policyUri: policyUri + tosUri: tosUri + clientIdAliasEnabled: true + properties: + number: + description: | + The sequential number of the client. The value of this property is assigned by Authlete. + format: int32 + readOnly: true + type: integer + clientName: + description: | + The name of the client application. This property corresponds to `client_name` in + [OpenID Connect Dynamic Client Registration 1.0, 2. Client Metadata](https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata). + type: string + clientNames: + description: | + Client names with language tags. If the client application has different names for different + languages, this property can be used to register the names. + items: + $ref: '#/components/schemas/tagged_value' + type: array + description: + description: The description about the client application. type: string - apiSecret: - description: API secret. + descriptions: + description: | + Descriptions about the client application with language tags. If the client application has different + descriptions for different languages, this property can be used to register the descriptions. + items: + $ref: '#/components/schemas/tagged_value' + type: array + clientId: + description: The client identifier used in Authlete API calls. The value + of this property is assigned by Authlete. + format: int64 + readOnly: true + type: integer + clientIdAlias: + description: | + The value of the client's `client_id` property used in OAuth and OpenID Connect calls. By + default, this is a string version of the `clientId` property. type: string - type: object - user_code_charset: - description: | - The character set for end-user verification codes (`user_code`) for Device Flow. - enum: - - BASE20 - - NUMERIC - type: string - verified_claims_validation_schema: - description: | - The verified claims validation schema set. - enum: - - standard - - standard+id_document - - null - nullable: true - type: string - attachment_type: - description: | - Supported attachment types. This property corresponds to the `attachments_supported` - server metadata which was added by the third implementer's draft of OpenID Connect - for Identity Assurance 1.0. - enum: - - EMBEDDED - - EXTERNAL - type: string - trust_anchor: - example: - jwks: jwks - entityId: entityId - properties: - entityId: + clientIdAliasEnabled: + description: Deprecated. Always set to `true`. + type: boolean + clientType: + $ref: '#/components/schemas/client_type' + logoUri: description: | - the entity ID of the trust anchor + The URL pointing to the logo image of the client application. + + This property corresponds to `logo_uri` in [OpenID Connect Dynamic Client Registration 1.0, 2. + Client Metadata](https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata). type: string - jwks: + logoUris: description: | - the JWK Set document containing public keys of the trust anchor + Logo image URLs with language tags. If the client application has different logo images for + different languages, this property can be used to register URLs of the images. + items: + $ref: '#/components/schemas/tagged_value' + type: array + tosUri: + description: | + The URL pointing to the "Terms Of Service" page. + + This property corresponds to `tos_uri` in + [OpenID Connect Dynamic Client Registration 1.0, 2. Client Metadata](https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata). type: string - type: object - api_result_code: + tosUris: + description: | + URLs of "Terms Of Service" pages with language tags. + + If the client application has different "Terms Of Service" pages for different languages, + this property can be used to register the URLs. + items: + $ref: '#/components/schemas/tagged_value' + type: array + policyUri: + description: | + The URL pointing to the page which describes the policy as to how end-user's profile data is used. + + This property corresponds to `policy_uri` in + [OpenID Connect Dynamic Client Registration 1.0, 2. Client Metadata](https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata). + type: string + policyUris: + description: | + URLs of policy pages with language tags. + If the client application has different policy pages for different languages, this property can be used to register the URLs. + items: + $ref: '#/components/schemas/tagged_value' + type: array type: object grant_management_action: description: | @@ -24888,6 +24030,44 @@ components: used when the request for the access token was made. type: boolean type: object + token_batch_status: + example: + result: null + createdAt: 6 + errorDescription: errorDescription + requestId: requestId + modifiedAt: 1 + tokenCount: 0 + errorCode: errorCode + batchKind: batchKind + properties: + batchKind: + description: The kind of the batch. + type: string + requestId: + description: The request ID associated with the status. + type: string + result: + $ref: '#/components/schemas/token_batch_status_result' + tokenCount: + description: The number of access tokens processed by the batch. + format: int64 + type: integer + errorCode: + description: The error code for the batch operation + type: string + errorDescription: + description: The error description for the batch operation + type: string + createdAt: + description: The time when this status was created + format: int64 + type: integer + modifiedAt: + description: The time when this status was modified + format: int64 + type: integer + type: object grant_scope: example: resource: @@ -24906,14 +24086,218 @@ components: type: string type: array type: object + token_batch_status_result: + enum: + - FAILED + - SUCCEED + type: string + service_get_api_200_response: + oneOf: + - $ref: '#/components/schemas/Service' + - $ref: '#/components/schemas/service_limited' + service_get_list_api_200_response: + oneOf: + - $ref: '#/components/schemas/service_get_list_response' + - $ref: '#/components/schemas/service_get_list_limited_response' + client_get_list_api_200_response: + oneOf: + - $ref: '#/components/schemas/client_get_list_response' + - $ref: '#/components/schemas/client_get_list_limited_response' + token_create_batch_request_inner: + properties: + grantType: + $ref: '#/components/schemas/grant_type' + clientId: + description: | + The ID of the client application which will be associated with a newly created access token. + format: int64 + type: integer + subject: + description: | + The subject (= unique identifier) of the user who will be associated with a newly created access + token. This parameter is required unless the grant type is `CLIENT_CREDENTIALS`. The value must + consist of only ASCII characters and its length must not exceed 100. + type: string + scopes: + description: | + The scopes which will be associated with a newly created access token. Scopes that are not supported + by the service cannot be specified and requesting them will cause an error. + items: + type: string + type: array + accessTokenDuration: + description: | + The duration of a newly created access token in seconds. If the value is 0, the duration is determined + according to the settings of the service. + format: int64 + type: integer + refreshTokenDuration: + description: | + The duration of a newly created refresh token in seconds. If the value is 0, the duration is + determined according to the settings of the service. + + A refresh token is not created (1) if the service does not support `REFRESH_TOKEN`, or (2) if the + specified grant type is either `IMPLICIT`or `CLIENT_CREDENTIALS`. + format: int64 + type: integer + properties: + description: | + Extra properties to associate with a newly created access token. Note that properties parameter + is accepted only when the HTTP method of the request is POST and Content-Type of the request is + `application/json`, so don't use `GET` method or `application/x-www-form-urlencoded` if you want + to specify properties. + items: + $ref: '#/components/schemas/Property' + type: array + clientIdAliasUsed: + description: | + A boolean request parameter which indicates whether to emulate that the client ID alias is used + instead of the original numeric client ID when a new access token is created. + + This has an effect only on the value of the aud claim in a response from [UserInfo endpoint](https://openid.net/specs/openid-connect-core-1_0.html#UserInfo). + When you access the UserInfo endpoint (which is expected to be implemented using Authlete's + `/api/auth/userinfo` API and `/api/auth/userinfo/issue` API) with an access token which has been + created using Authlete's `/api/auth/token/create/batch` API with this property (`clientIdAliasUsed`) + `true`, the client ID alias is used as the value of the aud claim in a response from the UserInfo + endpoint. + + Note that if a client ID alias is not assigned to the client when Authlete's `/api/auth/token/create/batch` + API is called, this property (`clientIdAliasUsed`) has no effect (it is always regarded as `false`). + type: boolean + accessToken: + description: "The value of the new access token. you must specify the value\ + \ of a newly created access token by \npassing a non-null value as the\ + \ value of accessToken request parameter.\n" + type: string + refreshToken: + description: "The value of the new refresh token. This is required under\ + \ some conditions such as when the service \nsupports the refresh token\ + \ flow.\n" + type: string + accessTokenPersistent: + description: | + Get whether the access token expires or not. By default, all access tokens expire after a period + of time determined by their service. + + If this request parameter is `true`, then the access token will not automatically expire and must + be revoked or deleted manually at the service. If this request parameter is true, the `accessTokenDuration` + request parameter is ignored. + type: boolean + certificateThumbprint: + description: | + The thumbprint of the MTLS certificate bound to this token. If this property is set, a certificate + with the corresponding value MUST be presented with the access token when it is used by a client. + The value of this property must be a SHA256 certificate thumbprint, base64url encoded. + type: string + dpopKeyThumbprint: + description: | + The thumbprint of the public key used for DPoP presentation of this token. If this property is + set, a DPoP proof signed with the corresponding private key MUST be presented with the access + token when it is used by a client. Additionally, the token's `token_type` will be set to 'DPoP'. + type: string + authorizationDetails: + $ref: '#/components/schemas/authz_details' + resources: + description: | + The value of the resources to associate with the token. This property represents the value of + one or more `resource` request parameters which is defined in "RFC8707 Resource Indicators for + OAuth 2.0". + items: + format: uri + type: string + type: array + forExternalAttachment: + description: | + the flag which indicates whether the access token is for an external + attachment. + type: boolean + jwtAtClaims: + description: | + Additional claims that are added to the payload part of the JWT access token. + type: string + acr: + description: "The Authentication Context Class Reference of the user authentication\ + \ that the authorization server performed \nduring the course of issuing\ + \ the access token.\n" + type: string + authTime: + description: | + The time when the user authentication was performed during the course of issuing the access token. + format: int64 + type: integer + clientEntityIdUsed: + description: | + Flag which indicates whether the entity ID of the client was used when the request for the access token was made. + type: boolean + required: + - accessToken + - clientId + - grantType + type: object securitySchemes: - ServiceOwnerCredentials: - description: Set **Service Owner API Key** as **Username** and **Service Owner - API Secret** as **Password**. - scheme: basic + Admin: + description: Set **access token**. A token with the `ADMIN` access right for + this Authlete instance. + scheme: bearer + type: http + DeleteService: + description: Set **access token**. A token with at least the `DELETE_SERVICE` + access right for this Authlete instance. Can also be a token with `ADMIN` + access. + scheme: bearer + type: http + CreateService: + description: Set **access token**. A token with at least the `CREATE_SERVICE` + access right for this Authlete instance. Can also be a token with `ADMIN` + access. + scheme: bearer + type: http + ViewDefaultService: + description: Set **access token**. A token with at least the `VIEW_DEFAULT_SERVICE` + access right for this Authlete instance. Can also be a token with `CREATE_SERVICE` + or `ADMIN` access. + scheme: bearer + type: http + ModifyService: + description: Set **access token**. A token with at least the `MODIFY_SERVICE` + access right for the service indicated by `serviceId`. Can also be a token + with `ADMIN` access for this Authlete instance. + scheme: bearer + type: http + CreateClient: + description: Set **access token**. A token with at least the `CREATE_CLIENT` + access right for the service indicated by `serviceId`. Can also be a token + with `MODIFY_SERVICE` for the service indicated by `serviceId` or `ADMIN` + access for this Authlete instance. + scheme: bearer + type: http + ViewService: + description: "Set **access token**. A token with at least the `VIEW_SERVICE`\ + \ access right for the service indicated by `serviceId`. Can also be a token\ + \ with `USE_SERVICE`, `CREATE_CLIENT`, or `MODIFY_SERVICE` for the service\ + \ indicated by `serviceId` or `ADMIN` access for this Authlete instance." + scheme: bearer + type: http + ModifyClient: + description: Set **access token**. A token with at least the `MODIFY_CLIENT` + access right for the client indicated by `clientId` of the service indicated + by `serviceId`. Can also be a token with `CREATE_CLIENT` or `MODIFY_SERVICE` + for the service indicated by `serviceId` or `ADMIN` access for this Authlete + instance. + scheme: bearer + type: http + ViewClient: + description: "Set **access token**. A token with at least the `VIEW_CLIENT`\ + \ access right for the client indicated by `clientId` of the service indicated\ + \ by `serviceId`. Can also be a token with `MODIFY_CLIENT` for the client\ + \ indicated by `clientId` of the service indicated by `serviceId`; `VIEW_SERVICE`,\ + \ `USE_SERVICE`, `CREATE_CLIENT` or `MODIFY_SERVICE` for the service indicated\ + \ by `serviceId`; or `ADMIN` access for this Authlete instance." + scheme: bearer type: http - ServiceCredentials: - description: Set **Service API Key** as **Username** and **Service API Secret** - as **Password**. - scheme: basic + UseService: + description: Set **access token**. A token with at least `USE_SERVICE` access + rights for this service. A **service access token** from the console will + have sufficient access. + scheme: bearer type: http diff --git a/api_authorization_endpoint.go b/api_authorization_endpoint.go index c844517..45dfebe 100644 --- a/api_authorization_endpoint.go +++ b/api_authorization_endpoint.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. @@ -16,13 +16,38 @@ import ( "io/ioutil" "net/http" "net/url" + "strings" ) type AuthorizationEndpointApi interface { /* - AuthAuthorizationApi /api/auth/authorization API + ApiServiceIdAuthAuthorizationTicketInfoGet /api/{serviceId}/auth/authorization/ticket/info API + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @return ApiApiServiceIdAuthAuthorizationTicketInfoGetRequest + */ + ApiServiceIdAuthAuthorizationTicketInfoGet(ctx context.Context) ApiApiServiceIdAuthAuthorizationTicketInfoGetRequest + + // ApiServiceIdAuthAuthorizationTicketInfoGetExecute executes the request + // @return AuthorizationTicketInfoResponse + ApiServiceIdAuthAuthorizationTicketInfoGetExecute(r ApiApiServiceIdAuthAuthorizationTicketInfoGetRequest) (*AuthorizationTicketInfoResponse, *http.Response, error) + + /* + ApiServiceIdAuthAuthorizationTicketUpdatePost /api/{serviceId}/auth/authorization/ticket/update API + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @return ApiApiServiceIdAuthAuthorizationTicketUpdatePostRequest + */ + ApiServiceIdAuthAuthorizationTicketUpdatePost(ctx context.Context) ApiApiServiceIdAuthAuthorizationTicketUpdatePostRequest + + // ApiServiceIdAuthAuthorizationTicketUpdatePostExecute executes the request + // @return AuthorizationTicketUpdateResponse + ApiServiceIdAuthAuthorizationTicketUpdatePostExecute(r ApiApiServiceIdAuthAuthorizationTicketUpdatePostRequest) (*AuthorizationTicketUpdateResponse, *http.Response, error) + + /* + AuthAuthorizationApi /api/{serviceId}/auth/authorization API This API parses request parameters of an authorization request and returns necessary data for the authorization server implementation to process the authorization request further. @@ -560,16 +585,17 @@ above in the description for the case of `action=NO_INTERACTION`. @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiAuthAuthorizationApiRequest */ - AuthAuthorizationApi(ctx context.Context) ApiAuthAuthorizationApiRequest + AuthAuthorizationApi(ctx context.Context, serviceId string) ApiAuthAuthorizationApiRequest // AuthAuthorizationApiExecute executes the request // @return AuthorizationResponse AuthAuthorizationApiExecute(r ApiAuthAuthorizationApiRequest) (*AuthorizationResponse, *http.Response, error) /* - AuthAuthorizationFailApi /api/auth/authorization/fail API + AuthAuthorizationFailApi /api/{serviceId}/auth/authorization/fail API This API generates a content of an error authorization response that the authorization server implementation returns to the client application. @@ -684,16 +710,17 @@ Pragma: no-cache @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiAuthAuthorizationFailApiRequest */ - AuthAuthorizationFailApi(ctx context.Context) ApiAuthAuthorizationFailApiRequest + AuthAuthorizationFailApi(ctx context.Context, serviceId string) ApiAuthAuthorizationFailApiRequest // AuthAuthorizationFailApiExecute executes the request // @return AuthorizationFailResponse AuthAuthorizationFailApiExecute(r ApiAuthAuthorizationFailApiRequest) (*AuthorizationFailResponse, *http.Response, error) /* - AuthAuthorizationIssueApi /api/auth/authorization/issue API + AuthAuthorizationIssueApi /api/{serviceId}/auth/authorization/issue API This API parses request parameters of an authorization request and returns necessary data for the authorization server implementation to process the authorization request further. @@ -811,9 +838,10 @@ Pragma: no-cache @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiAuthAuthorizationIssueApiRequest */ - AuthAuthorizationIssueApi(ctx context.Context) ApiAuthAuthorizationIssueApiRequest + AuthAuthorizationIssueApi(ctx context.Context, serviceId string) ApiAuthAuthorizationIssueApiRequest // AuthAuthorizationIssueApiExecute executes the request // @return AuthorizationIssueResponse @@ -823,9 +851,312 @@ Pragma: no-cache // AuthorizationEndpointApiService AuthorizationEndpointApi service type AuthorizationEndpointApiService service +type ApiApiServiceIdAuthAuthorizationTicketInfoGetRequest struct { + ctx context.Context + ApiService AuthorizationEndpointApi + authorizationTicketInfoRequest *AuthorizationTicketInfoRequest +} + +func (r ApiApiServiceIdAuthAuthorizationTicketInfoGetRequest) AuthorizationTicketInfoRequest(authorizationTicketInfoRequest AuthorizationTicketInfoRequest) ApiApiServiceIdAuthAuthorizationTicketInfoGetRequest { + r.authorizationTicketInfoRequest = &authorizationTicketInfoRequest + return r +} + +func (r ApiApiServiceIdAuthAuthorizationTicketInfoGetRequest) Execute() (*AuthorizationTicketInfoResponse, *http.Response, error) { + return r.ApiService.ApiServiceIdAuthAuthorizationTicketInfoGetExecute(r) +} + +/* +ApiServiceIdAuthAuthorizationTicketInfoGet /api/{serviceId}/auth/authorization/ticket/info API + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @return ApiApiServiceIdAuthAuthorizationTicketInfoGetRequest +*/ +func (a *AuthorizationEndpointApiService) ApiServiceIdAuthAuthorizationTicketInfoGet(ctx context.Context) ApiApiServiceIdAuthAuthorizationTicketInfoGetRequest { + return ApiApiServiceIdAuthAuthorizationTicketInfoGetRequest{ + ApiService: a, + ctx: ctx, + } +} + +// Execute executes the request +// @return AuthorizationTicketInfoResponse +func (a *AuthorizationEndpointApiService) ApiServiceIdAuthAuthorizationTicketInfoGetExecute(r ApiApiServiceIdAuthAuthorizationTicketInfoGetRequest) (*AuthorizationTicketInfoResponse, *http.Response, error) { + var ( + localVarHTTPMethod = http.MethodGet + localVarPostBody interface{} + formFiles []formFile + localVarReturnValue *AuthorizationTicketInfoResponse + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "AuthorizationEndpointApiService.ApiServiceIdAuthAuthorizationTicketInfoGet") + if err != nil { + return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/api/{serviceId}/auth/authorization/ticket/info" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + if r.authorizationTicketInfoRequest == nil { + return localVarReturnValue, nil, reportError("authorizationTicketInfoRequest is required and must be specified") + } + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json", "application/x-www-form-urlencoded"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + // body params + localVarPostBody = r.authorizationTicketInfoRequest + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = ioutil.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 400 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type ApiApiServiceIdAuthAuthorizationTicketUpdatePostRequest struct { + ctx context.Context + ApiService AuthorizationEndpointApi + authorizationTicketUpdateRequest *AuthorizationTicketUpdateRequest +} + +func (r ApiApiServiceIdAuthAuthorizationTicketUpdatePostRequest) AuthorizationTicketUpdateRequest(authorizationTicketUpdateRequest AuthorizationTicketUpdateRequest) ApiApiServiceIdAuthAuthorizationTicketUpdatePostRequest { + r.authorizationTicketUpdateRequest = &authorizationTicketUpdateRequest + return r +} + +func (r ApiApiServiceIdAuthAuthorizationTicketUpdatePostRequest) Execute() (*AuthorizationTicketUpdateResponse, *http.Response, error) { + return r.ApiService.ApiServiceIdAuthAuthorizationTicketUpdatePostExecute(r) +} + +/* +ApiServiceIdAuthAuthorizationTicketUpdatePost /api/{serviceId}/auth/authorization/ticket/update API + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @return ApiApiServiceIdAuthAuthorizationTicketUpdatePostRequest +*/ +func (a *AuthorizationEndpointApiService) ApiServiceIdAuthAuthorizationTicketUpdatePost(ctx context.Context) ApiApiServiceIdAuthAuthorizationTicketUpdatePostRequest { + return ApiApiServiceIdAuthAuthorizationTicketUpdatePostRequest{ + ApiService: a, + ctx: ctx, + } +} + +// Execute executes the request +// @return AuthorizationTicketUpdateResponse +func (a *AuthorizationEndpointApiService) ApiServiceIdAuthAuthorizationTicketUpdatePostExecute(r ApiApiServiceIdAuthAuthorizationTicketUpdatePostRequest) (*AuthorizationTicketUpdateResponse, *http.Response, error) { + var ( + localVarHTTPMethod = http.MethodPost + localVarPostBody interface{} + formFiles []formFile + localVarReturnValue *AuthorizationTicketUpdateResponse + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "AuthorizationEndpointApiService.ApiServiceIdAuthAuthorizationTicketUpdatePost") + if err != nil { + return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/api/{serviceId}/auth/authorization/ticket/update" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + if r.authorizationTicketUpdateRequest == nil { + return localVarReturnValue, nil, reportError("authorizationTicketUpdateRequest is required and must be specified") + } + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json", "application/x-www-form-urlencoded"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + // body params + localVarPostBody = r.authorizationTicketUpdateRequest + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = ioutil.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 400 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + type ApiAuthAuthorizationApiRequest struct { ctx context.Context ApiService AuthorizationEndpointApi + serviceId string authorizationRequest *AuthorizationRequest } @@ -839,7 +1170,7 @@ func (r ApiAuthAuthorizationApiRequest) Execute() (*AuthorizationResponse, *http } /* -AuthAuthorizationApi /api/auth/authorization API +AuthAuthorizationApi /api/{serviceId}/auth/authorization API This API parses request parameters of an authorization request and returns necessary data for the authorization server implementation to process the authorization request further. @@ -1377,12 +1708,14 @@ above in the description for the case of `action=NO_INTERACTION`. @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiAuthAuthorizationApiRequest */ -func (a *AuthorizationEndpointApiService) AuthAuthorizationApi(ctx context.Context) ApiAuthAuthorizationApiRequest { +func (a *AuthorizationEndpointApiService) AuthAuthorizationApi(ctx context.Context, serviceId string) ApiAuthAuthorizationApiRequest { return ApiAuthAuthorizationApiRequest{ ApiService: a, ctx: ctx, + serviceId: serviceId, } } @@ -1401,7 +1734,8 @@ func (a *AuthorizationEndpointApiService) AuthAuthorizationApiExecute(r ApiAuthA return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/api/auth/authorization" + localVarPath := localBasePath + "/api/{serviceId}/auth/authorization" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := url.Values{} @@ -1512,6 +1846,7 @@ func (a *AuthorizationEndpointApiService) AuthAuthorizationApiExecute(r ApiAuthA type ApiAuthAuthorizationFailApiRequest struct { ctx context.Context ApiService AuthorizationEndpointApi + serviceId string authorizationFailRequest *AuthorizationFailRequest } @@ -1525,7 +1860,7 @@ func (r ApiAuthAuthorizationFailApiRequest) Execute() (*AuthorizationFailRespons } /* -AuthAuthorizationFailApi /api/auth/authorization/fail API +AuthAuthorizationFailApi /api/{serviceId}/auth/authorization/fail API This API generates a content of an error authorization response that the authorization server implementation returns to the client application. @@ -1640,12 +1975,14 @@ Pragma: no-cache @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiAuthAuthorizationFailApiRequest */ -func (a *AuthorizationEndpointApiService) AuthAuthorizationFailApi(ctx context.Context) ApiAuthAuthorizationFailApiRequest { +func (a *AuthorizationEndpointApiService) AuthAuthorizationFailApi(ctx context.Context, serviceId string) ApiAuthAuthorizationFailApiRequest { return ApiAuthAuthorizationFailApiRequest{ ApiService: a, ctx: ctx, + serviceId: serviceId, } } @@ -1664,7 +2001,8 @@ func (a *AuthorizationEndpointApiService) AuthAuthorizationFailApiExecute(r ApiA return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/api/auth/authorization/fail" + localVarPath := localBasePath + "/api/{serviceId}/auth/authorization/fail" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := url.Values{} @@ -1775,6 +2113,7 @@ func (a *AuthorizationEndpointApiService) AuthAuthorizationFailApiExecute(r ApiA type ApiAuthAuthorizationIssueApiRequest struct { ctx context.Context ApiService AuthorizationEndpointApi + serviceId string authorizationIssueRequest *AuthorizationIssueRequest } @@ -1788,7 +2127,7 @@ func (r ApiAuthAuthorizationIssueApiRequest) Execute() (*AuthorizationIssueRespo } /* -AuthAuthorizationIssueApi /api/auth/authorization/issue API +AuthAuthorizationIssueApi /api/{serviceId}/auth/authorization/issue API This API parses request parameters of an authorization request and returns necessary data for the authorization server implementation to process the authorization request further. @@ -1906,12 +2245,14 @@ Pragma: no-cache @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiAuthAuthorizationIssueApiRequest */ -func (a *AuthorizationEndpointApiService) AuthAuthorizationIssueApi(ctx context.Context) ApiAuthAuthorizationIssueApiRequest { +func (a *AuthorizationEndpointApiService) AuthAuthorizationIssueApi(ctx context.Context, serviceId string) ApiAuthAuthorizationIssueApiRequest { return ApiAuthAuthorizationIssueApiRequest{ ApiService: a, ctx: ctx, + serviceId: serviceId, } } @@ -1930,7 +2271,8 @@ func (a *AuthorizationEndpointApiService) AuthAuthorizationIssueApiExecute(r Api return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/api/auth/authorization/issue" + localVarPath := localBasePath + "/api/{serviceId}/auth/authorization/issue" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := url.Values{} diff --git a/api_ciba.go b/api_ciba.go index ee8b74c..aa37a0a 100644 --- a/api_ciba.go +++ b/api_ciba.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. @@ -16,13 +16,14 @@ import ( "io/ioutil" "net/http" "net/url" + "strings" ) type CIBAApi interface { /* - BackchannelAuthenticationApi /api/backchannel/authentication API + BackchannelAuthenticationApi /api/{serviceId}/backchannel/authentication API This API parses request parameters of a [backchannel authentication request](https://openid.net/specs/openid-client-initiated-backchannel-authentication-core-1_0.html#auth_request) and returns necessary data for the authorization server implementation to process the backchannel @@ -337,16 +338,17 @@ not have to be changed to support CIBA. @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiBackchannelAuthenticationApiRequest */ - BackchannelAuthenticationApi(ctx context.Context) ApiBackchannelAuthenticationApiRequest + BackchannelAuthenticationApi(ctx context.Context, serviceId string) ApiBackchannelAuthenticationApiRequest // BackchannelAuthenticationApiExecute executes the request // @return BackchannelAuthenticationResponse BackchannelAuthenticationApiExecute(r ApiBackchannelAuthenticationApiRequest) (*BackchannelAuthenticationResponse, *http.Response, error) /* - BackchannelAuthenticationCompleteApi /api/backchannel/authentication/complete API + BackchannelAuthenticationCompleteApi /api/{serviceId}/backchannel/authentication/complete API This API returns information about what action the authorization server should take after it receives the result of end-user's decision about whether the end-user has approved or rejected a client application's @@ -459,16 +461,17 @@ Content-Type: application/json @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiBackchannelAuthenticationCompleteApiRequest */ - BackchannelAuthenticationCompleteApi(ctx context.Context) ApiBackchannelAuthenticationCompleteApiRequest + BackchannelAuthenticationCompleteApi(ctx context.Context, serviceId string) ApiBackchannelAuthenticationCompleteApiRequest // BackchannelAuthenticationCompleteApiExecute executes the request // @return BackchannelAuthenticationCompleteResponse BackchannelAuthenticationCompleteApiExecute(r ApiBackchannelAuthenticationCompleteApiRequest) (*BackchannelAuthenticationCompleteResponse, *http.Response, error) /* - BackchannelAuthenticationFailApi /api/backchannel/authentication/fail API + BackchannelAuthenticationFailApi /api/{serviceId}/backchannel/authentication/fail API The API prepares JSON that contains an error. The JSON should be used as the response body of the response which is returned to the client from the [backchannel authentication endpoint](https://openid.net/specs/openid-client-initiated-backchannel-authentication-core-1_0.html#auth_backchannel_endpoint). @@ -509,16 +512,17 @@ server implementation should return a "403 Forbidden" response to the client app @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiBackchannelAuthenticationFailApiRequest */ - BackchannelAuthenticationFailApi(ctx context.Context) ApiBackchannelAuthenticationFailApiRequest + BackchannelAuthenticationFailApi(ctx context.Context, serviceId string) ApiBackchannelAuthenticationFailApiRequest // BackchannelAuthenticationFailApiExecute executes the request // @return BackchannelAuthenticationFailResponse BackchannelAuthenticationFailApiExecute(r ApiBackchannelAuthenticationFailApiRequest) (*BackchannelAuthenticationFailResponse, *http.Response, error) /* - BackchannelAuthenticationIssueApi /api/backchannel/authentication/issue API + BackchannelAuthenticationIssueApi /api/{serviceId}/backchannel/authentication/issue API This API prepares JSON that contains an `auth_req_id`. The JSON should be used as the response body of the response which is returned to the client from the [backchannel authentication endpoint](https://openid.net/specs/openid-client-initiated-backchannel-authentication-core-1_0.html#auth_backchannel_endpoint) @@ -612,9 +616,10 @@ Pragma: no-cache @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiBackchannelAuthenticationIssueApiRequest */ - BackchannelAuthenticationIssueApi(ctx context.Context) ApiBackchannelAuthenticationIssueApiRequest + BackchannelAuthenticationIssueApi(ctx context.Context, serviceId string) ApiBackchannelAuthenticationIssueApiRequest // BackchannelAuthenticationIssueApiExecute executes the request // @return BackchannelAuthenticationIssueResponse @@ -627,6 +632,7 @@ type CIBAApiService service type ApiBackchannelAuthenticationApiRequest struct { ctx context.Context ApiService CIBAApi + serviceId string backchannelAuthenticationRequest *BackchannelAuthenticationRequest } @@ -640,7 +646,7 @@ func (r ApiBackchannelAuthenticationApiRequest) Execute() (*BackchannelAuthentic } /* -BackchannelAuthenticationApi /api/backchannel/authentication API +BackchannelAuthenticationApi /api/{serviceId}/backchannel/authentication API This API parses request parameters of a [backchannel authentication request](https://openid.net/specs/openid-client-initiated-backchannel-authentication-core-1_0.html#auth_request) and returns necessary data for the authorization server implementation to process the backchannel @@ -955,12 +961,14 @@ not have to be changed to support CIBA. @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiBackchannelAuthenticationApiRequest */ -func (a *CIBAApiService) BackchannelAuthenticationApi(ctx context.Context) ApiBackchannelAuthenticationApiRequest { +func (a *CIBAApiService) BackchannelAuthenticationApi(ctx context.Context, serviceId string) ApiBackchannelAuthenticationApiRequest { return ApiBackchannelAuthenticationApiRequest{ ApiService: a, ctx: ctx, + serviceId: serviceId, } } @@ -979,7 +987,8 @@ func (a *CIBAApiService) BackchannelAuthenticationApiExecute(r ApiBackchannelAut return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/api/backchannel/authentication" + localVarPath := localBasePath + "/api/{serviceId}/backchannel/authentication" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := url.Values{} @@ -1090,6 +1099,7 @@ func (a *CIBAApiService) BackchannelAuthenticationApiExecute(r ApiBackchannelAut type ApiBackchannelAuthenticationCompleteApiRequest struct { ctx context.Context ApiService CIBAApi + serviceId string backchannelAuthenticationCompleteRequest *BackchannelAuthenticationCompleteRequest } @@ -1103,7 +1113,7 @@ func (r ApiBackchannelAuthenticationCompleteApiRequest) Execute() (*BackchannelA } /* -BackchannelAuthenticationCompleteApi /api/backchannel/authentication/complete API +BackchannelAuthenticationCompleteApi /api/{serviceId}/backchannel/authentication/complete API This API returns information about what action the authorization server should take after it receives the result of end-user's decision about whether the end-user has approved or rejected a client application's @@ -1216,12 +1226,14 @@ Content-Type: application/json @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiBackchannelAuthenticationCompleteApiRequest */ -func (a *CIBAApiService) BackchannelAuthenticationCompleteApi(ctx context.Context) ApiBackchannelAuthenticationCompleteApiRequest { +func (a *CIBAApiService) BackchannelAuthenticationCompleteApi(ctx context.Context, serviceId string) ApiBackchannelAuthenticationCompleteApiRequest { return ApiBackchannelAuthenticationCompleteApiRequest{ ApiService: a, ctx: ctx, + serviceId: serviceId, } } @@ -1240,7 +1252,8 @@ func (a *CIBAApiService) BackchannelAuthenticationCompleteApiExecute(r ApiBackch return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/api/backchannel/authentication/complete" + localVarPath := localBasePath + "/api/{serviceId}/backchannel/authentication/complete" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := url.Values{} @@ -1351,6 +1364,7 @@ func (a *CIBAApiService) BackchannelAuthenticationCompleteApiExecute(r ApiBackch type ApiBackchannelAuthenticationFailApiRequest struct { ctx context.Context ApiService CIBAApi + serviceId string backchannelAuthenticationFailRequest *BackchannelAuthenticationFailRequest } @@ -1364,7 +1378,7 @@ func (r ApiBackchannelAuthenticationFailApiRequest) Execute() (*BackchannelAuthe } /* -BackchannelAuthenticationFailApi /api/backchannel/authentication/fail API +BackchannelAuthenticationFailApi /api/{serviceId}/backchannel/authentication/fail API The API prepares JSON that contains an error. The JSON should be used as the response body of the response which is returned to the client from the [backchannel authentication endpoint](https://openid.net/specs/openid-client-initiated-backchannel-authentication-core-1_0.html#auth_backchannel_endpoint). @@ -1405,12 +1419,14 @@ server implementation should return a "403 Forbidden" response to the client app @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiBackchannelAuthenticationFailApiRequest */ -func (a *CIBAApiService) BackchannelAuthenticationFailApi(ctx context.Context) ApiBackchannelAuthenticationFailApiRequest { +func (a *CIBAApiService) BackchannelAuthenticationFailApi(ctx context.Context, serviceId string) ApiBackchannelAuthenticationFailApiRequest { return ApiBackchannelAuthenticationFailApiRequest{ ApiService: a, ctx: ctx, + serviceId: serviceId, } } @@ -1429,7 +1445,8 @@ func (a *CIBAApiService) BackchannelAuthenticationFailApiExecute(r ApiBackchanne return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/api/backchannel/authentication/fail" + localVarPath := localBasePath + "/api/{serviceId}/backchannel/authentication/fail" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := url.Values{} @@ -1540,6 +1557,7 @@ func (a *CIBAApiService) BackchannelAuthenticationFailApiExecute(r ApiBackchanne type ApiBackchannelAuthenticationIssueApiRequest struct { ctx context.Context ApiService CIBAApi + serviceId string backchannelAuthenticationIssueRequest *BackchannelAuthenticationIssueRequest } @@ -1553,7 +1571,7 @@ func (r ApiBackchannelAuthenticationIssueApiRequest) Execute() (*BackchannelAuth } /* -BackchannelAuthenticationIssueApi /api/backchannel/authentication/issue API +BackchannelAuthenticationIssueApi /api/{serviceId}/backchannel/authentication/issue API This API prepares JSON that contains an `auth_req_id`. The JSON should be used as the response body of the response which is returned to the client from the [backchannel authentication endpoint](https://openid.net/specs/openid-client-initiated-backchannel-authentication-core-1_0.html#auth_backchannel_endpoint) @@ -1647,12 +1665,14 @@ Pragma: no-cache @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiBackchannelAuthenticationIssueApiRequest */ -func (a *CIBAApiService) BackchannelAuthenticationIssueApi(ctx context.Context) ApiBackchannelAuthenticationIssueApiRequest { +func (a *CIBAApiService) BackchannelAuthenticationIssueApi(ctx context.Context, serviceId string) ApiBackchannelAuthenticationIssueApiRequest { return ApiBackchannelAuthenticationIssueApiRequest{ ApiService: a, ctx: ctx, + serviceId: serviceId, } } @@ -1671,7 +1691,8 @@ func (a *CIBAApiService) BackchannelAuthenticationIssueApiExecute(r ApiBackchann return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/api/backchannel/authentication/issue" + localVarPath := localBasePath + "/api/{serviceId}/backchannel/authentication/issue" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := url.Values{} diff --git a/api_client_extension.go b/api_client_extension.go index 60a5459..4fed6bb 100644 --- a/api_client_extension.go +++ b/api_client_extension.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. @@ -23,47 +23,50 @@ import ( type ClientExtensionApi interface { /* - ClientExtensionRequestablesScopesDeleteApi /api/client/extension/requestable_scopes/delete/{clientId} API + ClientExtensionRequestablesScopesDeleteApi /api/{serviceId}/client/extension/requestable_scopes/delete/{clientId} API Delete a requestable scopes of a client @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @param clientId A client ID. @return ApiClientExtensionRequestablesScopesDeleteApiRequest */ - ClientExtensionRequestablesScopesDeleteApi(ctx context.Context, clientId string) ApiClientExtensionRequestablesScopesDeleteApiRequest + ClientExtensionRequestablesScopesDeleteApi(ctx context.Context, serviceId string, clientId string) ApiClientExtensionRequestablesScopesDeleteApiRequest // ClientExtensionRequestablesScopesDeleteApiExecute executes the request ClientExtensionRequestablesScopesDeleteApiExecute(r ApiClientExtensionRequestablesScopesDeleteApiRequest) (*http.Response, error) /* - ClientExtensionRequestablesScopesGetApi /api/client/extension/requestable_scopes/get/{clientId} API + ClientExtensionRequestablesScopesGetApi /api/{serviceId}/client/extension/requestable_scopes/get/{clientId} API Get the requestable scopes per client @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @param clientId A client ID. @return ApiClientExtensionRequestablesScopesGetApiRequest */ - ClientExtensionRequestablesScopesGetApi(ctx context.Context, clientId string) ApiClientExtensionRequestablesScopesGetApiRequest + ClientExtensionRequestablesScopesGetApi(ctx context.Context, serviceId string, clientId string) ApiClientExtensionRequestablesScopesGetApiRequest // ClientExtensionRequestablesScopesGetApiExecute executes the request // @return ClientExtensionRequestableScopesGetResponse ClientExtensionRequestablesScopesGetApiExecute(r ApiClientExtensionRequestablesScopesGetApiRequest) (*ClientExtensionRequestableScopesGetResponse, *http.Response, error) /* - ClientExtensionRequestablesScopesUpdateApi /api/client/extension/requestable_scopes/update/{clientId} API + ClientExtensionRequestablesScopesUpdateApi /api/{serviceId}/client/extension/requestable_scopes/update/{clientId} API Update requestable scopes of a client @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @param clientId A client ID. @return ApiClientExtensionRequestablesScopesUpdateApiRequest */ - ClientExtensionRequestablesScopesUpdateApi(ctx context.Context, clientId string) ApiClientExtensionRequestablesScopesUpdateApiRequest + ClientExtensionRequestablesScopesUpdateApi(ctx context.Context, serviceId string, clientId string) ApiClientExtensionRequestablesScopesUpdateApiRequest // ClientExtensionRequestablesScopesUpdateApiExecute executes the request // @return ClientExtensionRequestableScopesUpdateResponse @@ -76,6 +79,7 @@ type ClientExtensionApiService service type ApiClientExtensionRequestablesScopesDeleteApiRequest struct { ctx context.Context ApiService ClientExtensionApi + serviceId string clientId string } @@ -84,19 +88,21 @@ func (r ApiClientExtensionRequestablesScopesDeleteApiRequest) Execute() (*http.R } /* -ClientExtensionRequestablesScopesDeleteApi /api/client/extension/requestable_scopes/delete/{clientId} API +ClientExtensionRequestablesScopesDeleteApi /api/{serviceId}/client/extension/requestable_scopes/delete/{clientId} API Delete a requestable scopes of a client @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @param clientId A client ID. @return ApiClientExtensionRequestablesScopesDeleteApiRequest */ -func (a *ClientExtensionApiService) ClientExtensionRequestablesScopesDeleteApi(ctx context.Context, clientId string) ApiClientExtensionRequestablesScopesDeleteApiRequest { +func (a *ClientExtensionApiService) ClientExtensionRequestablesScopesDeleteApi(ctx context.Context, serviceId string, clientId string) ApiClientExtensionRequestablesScopesDeleteApiRequest { return ApiClientExtensionRequestablesScopesDeleteApiRequest{ ApiService: a, ctx: ctx, + serviceId: serviceId, clientId: clientId, } } @@ -114,7 +120,8 @@ func (a *ClientExtensionApiService) ClientExtensionRequestablesScopesDeleteApiEx return nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/api/client/extension/requestable_scopes/delete/{clientId}" + localVarPath := localBasePath + "/api/{serviceId}/client/extension/requestable_scopes/delete/{clientId}" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) localVarPath = strings.Replace(localVarPath, "{"+"clientId"+"}", url.PathEscape(parameterValueToString(r.clientId, "clientId")), -1) localVarHeaderParams := make(map[string]string) @@ -212,6 +219,7 @@ func (a *ClientExtensionApiService) ClientExtensionRequestablesScopesDeleteApiEx type ApiClientExtensionRequestablesScopesGetApiRequest struct { ctx context.Context ApiService ClientExtensionApi + serviceId string clientId string } @@ -220,19 +228,21 @@ func (r ApiClientExtensionRequestablesScopesGetApiRequest) Execute() (*ClientExt } /* -ClientExtensionRequestablesScopesGetApi /api/client/extension/requestable_scopes/get/{clientId} API +ClientExtensionRequestablesScopesGetApi /api/{serviceId}/client/extension/requestable_scopes/get/{clientId} API Get the requestable scopes per client @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @param clientId A client ID. @return ApiClientExtensionRequestablesScopesGetApiRequest */ -func (a *ClientExtensionApiService) ClientExtensionRequestablesScopesGetApi(ctx context.Context, clientId string) ApiClientExtensionRequestablesScopesGetApiRequest { +func (a *ClientExtensionApiService) ClientExtensionRequestablesScopesGetApi(ctx context.Context, serviceId string, clientId string) ApiClientExtensionRequestablesScopesGetApiRequest { return ApiClientExtensionRequestablesScopesGetApiRequest{ ApiService: a, ctx: ctx, + serviceId: serviceId, clientId: clientId, } } @@ -252,7 +262,8 @@ func (a *ClientExtensionApiService) ClientExtensionRequestablesScopesGetApiExecu return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/api/client/extension/requestable_scopes/get/{clientId}" + localVarPath := localBasePath + "/api/{serviceId}/client/extension/requestable_scopes/get/{clientId}" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) localVarPath = strings.Replace(localVarPath, "{"+"clientId"+"}", url.PathEscape(parameterValueToString(r.clientId, "clientId")), -1) localVarHeaderParams := make(map[string]string) @@ -359,6 +370,7 @@ func (a *ClientExtensionApiService) ClientExtensionRequestablesScopesGetApiExecu type ApiClientExtensionRequestablesScopesUpdateApiRequest struct { ctx context.Context ApiService ClientExtensionApi + serviceId string clientId string clientExtensionRequestableScopesUpdateRequest *ClientExtensionRequestableScopesUpdateRequest } @@ -373,19 +385,21 @@ func (r ApiClientExtensionRequestablesScopesUpdateApiRequest) Execute() (*Client } /* -ClientExtensionRequestablesScopesUpdateApi /api/client/extension/requestable_scopes/update/{clientId} API +ClientExtensionRequestablesScopesUpdateApi /api/{serviceId}/client/extension/requestable_scopes/update/{clientId} API Update requestable scopes of a client @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @param clientId A client ID. @return ApiClientExtensionRequestablesScopesUpdateApiRequest */ -func (a *ClientExtensionApiService) ClientExtensionRequestablesScopesUpdateApi(ctx context.Context, clientId string) ApiClientExtensionRequestablesScopesUpdateApiRequest { +func (a *ClientExtensionApiService) ClientExtensionRequestablesScopesUpdateApi(ctx context.Context, serviceId string, clientId string) ApiClientExtensionRequestablesScopesUpdateApiRequest { return ApiClientExtensionRequestablesScopesUpdateApiRequest{ ApiService: a, ctx: ctx, + serviceId: serviceId, clientId: clientId, } } @@ -405,7 +419,8 @@ func (a *ClientExtensionApiService) ClientExtensionRequestablesScopesUpdateApiEx return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/api/client/extension/requestable_scopes/update/{clientId}" + localVarPath := localBasePath + "/api/{serviceId}/client/extension/requestable_scopes/update/{clientId}" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) localVarPath = strings.Replace(localVarPath, "{"+"clientId"+"}", url.PathEscape(parameterValueToString(r.clientId, "clientId")), -1) localVarHeaderParams := make(map[string]string) diff --git a/api_client_management.go b/api_client_management.go index ced73ed..53ffcff 100644 --- a/api_client_management.go +++ b/api_client_management.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. @@ -23,7 +23,7 @@ import ( type ClientManagementApi interface { /* - ClientAuthorizationDeleteApi /api/client/authorization/delete/{clientId}/{subject} API + ClientAuthorizationDeleteApi /api/{serviceId}/client/authorization/delete/{clientId}/{subject} API Delete all existing access tokens issued to a client application by an end-user. @@ -31,18 +31,19 @@ The subject parameter is required and can be provided either in the path or as a @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @param clientId A client ID. @param subject Unique user ID of an end-user. @return ApiClientAuthorizationDeleteApiRequest */ - ClientAuthorizationDeleteApi(ctx context.Context, clientId string, subject string) ApiClientAuthorizationDeleteApiRequest + ClientAuthorizationDeleteApi(ctx context.Context, serviceId string, clientId string, subject string) ApiClientAuthorizationDeleteApiRequest // ClientAuthorizationDeleteApiExecute executes the request // @return ClientAuthorizationDeleteResponse ClientAuthorizationDeleteApiExecute(r ApiClientAuthorizationDeleteApiRequest) (*ClientAuthorizationDeleteResponse, *http.Response, error) /* - ClientAuthorizationGetListApi /api/client/authorization/get/list/{subject} API + ClientAuthorizationGetListApi /api/{serviceId}/client/authorization/get/list/{subject} API Get a list of client applications that an end-user has authorized. @@ -50,110 +51,121 @@ The subject parameter is required and can be provided either in the path or as a @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @param subject Unique user ID of an end-user. @return ApiClientAuthorizationGetListApiRequest */ - ClientAuthorizationGetListApi(ctx context.Context, subject string) ApiClientAuthorizationGetListApiRequest + ClientAuthorizationGetListApi(ctx context.Context, serviceId string, subject string) ApiClientAuthorizationGetListApiRequest // ClientAuthorizationGetListApiExecute executes the request // @return ClientAuthorizationGetListResponse ClientAuthorizationGetListApiExecute(r ApiClientAuthorizationGetListApiRequest) (*ClientAuthorizationGetListResponse, *http.Response, error) /* - ClientAuthorizationUpdateApi /api/client/authorization/update/{clientId} API + ClientAuthorizationUpdateApi /api/{serviceId}/client/authorization/update/{clientId} API Update attributes of all existing access tokens given to a client application. @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @param clientId A client ID. @return ApiClientAuthorizationUpdateApiRequest */ - ClientAuthorizationUpdateApi(ctx context.Context, clientId string) ApiClientAuthorizationUpdateApiRequest + ClientAuthorizationUpdateApi(ctx context.Context, serviceId string, clientId string) ApiClientAuthorizationUpdateApiRequest // ClientAuthorizationUpdateApiExecute executes the request // @return ClientAuthorizationUpdateResponse ClientAuthorizationUpdateApiExecute(r ApiClientAuthorizationUpdateApiRequest) (*ClientAuthorizationUpdateResponse, *http.Response, error) /* - ClientCreateApi /api/client/create API + ClientCreateApi /api/{serviceId}/client/create API Create a new client. @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiClientCreateApiRequest */ - ClientCreateApi(ctx context.Context) ApiClientCreateApiRequest + ClientCreateApi(ctx context.Context, serviceId string) ApiClientCreateApiRequest // ClientCreateApiExecute executes the request // @return Client ClientCreateApiExecute(r ApiClientCreateApiRequest) (*Client, *http.Response, error) /* - ClientDeleteApi /api/client/delete/{clientId} API + ClientDeleteApi /api/{serviceId}/client/delete/{clientId} API Delete a client. @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @param clientId The client ID. @return ApiClientDeleteApiRequest */ - ClientDeleteApi(ctx context.Context, clientId string) ApiClientDeleteApiRequest + ClientDeleteApi(ctx context.Context, serviceId string, clientId string) ApiClientDeleteApiRequest // ClientDeleteApiExecute executes the request ClientDeleteApiExecute(r ApiClientDeleteApiRequest) (*http.Response, error) /* - ClientFlagUpdateApi /api/client/lock_flag/update/{clientIdentifier} API + ClientFlagUpdateApi /api/{serviceId}/client/lock_flag/update/{clientIdentifier} API Lock and unlock a client @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @param clientIdentifier A client ID. @return ApiClientFlagUpdateApiRequest */ - ClientFlagUpdateApi(ctx context.Context, clientIdentifier string) ApiClientFlagUpdateApiRequest + ClientFlagUpdateApi(ctx context.Context, serviceId string, clientIdentifier string) ApiClientFlagUpdateApiRequest // ClientFlagUpdateApiExecute executes the request // @return ClientFlagUpdateResponse ClientFlagUpdateApiExecute(r ApiClientFlagUpdateApiRequest) (*ClientFlagUpdateResponse, *http.Response, error) /* - ClientGetApi /api/client/get/{clientId} API + ClientGetApi /api/{serviceId}/client/get/{clientId} API Get a client. @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @param clientId A client ID. @return ApiClientGetApiRequest */ - ClientGetApi(ctx context.Context, clientId string) ApiClientGetApiRequest + ClientGetApi(ctx context.Context, serviceId string, clientId string) ApiClientGetApiRequest // ClientGetApiExecute executes the request // @return Client ClientGetApiExecute(r ApiClientGetApiRequest) (*Client, *http.Response, error) /* - ClientGetListApi /api/client/get/list API + ClientGetListApi /api/{serviceId}/client/get/list API - Get a list of clients. + Get a list of clients on a service. + +If the access token can view a full service (including an admin), all clients within the +service are returned. Otherwise, only clients that the access token can view within the +service are returned. @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiClientGetListApiRequest */ - ClientGetListApi(ctx context.Context) ApiClientGetListApiRequest + ClientGetListApi(ctx context.Context, serviceId string) ApiClientGetListApiRequest // ClientGetListApiExecute executes the request - // @return ClientGetListResponse - ClientGetListApiExecute(r ApiClientGetListApiRequest) (*ClientGetListResponse, *http.Response, error) + // @return ClientGetListApi200Response + ClientGetListApiExecute(r ApiClientGetListApiRequest) (*ClientGetListApi200Response, *http.Response, error) /* - ClientGrantedScopesDeleteApi /api/client/granted_scopes/delete/{clientId}/{subject} API + ClientGrantedScopesDeleteApi /api/{serviceId}/client/granted_scopes/delete/{clientId}/{subject} API Delete the set of scopes that an end-user has granted to a client application. @@ -169,18 +181,19 @@ The subject parameter is required and can be provided either in the path or as a @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @param clientId A client ID. @param subject Unique user ID of an end-user. @return ApiClientGrantedScopesDeleteApiRequest */ - ClientGrantedScopesDeleteApi(ctx context.Context, clientId string, subject string) ApiClientGrantedScopesDeleteApiRequest + ClientGrantedScopesDeleteApi(ctx context.Context, serviceId string, clientId string, subject string) ApiClientGrantedScopesDeleteApiRequest // ClientGrantedScopesDeleteApiExecute executes the request // @return ClientGrantedScopesDeleteResponse ClientGrantedScopesDeleteApiExecute(r ApiClientGrantedScopesDeleteApiRequest) (*ClientGrantedScopesDeleteResponse, *http.Response, error) /* - ClientGrantedScopesGetApi /api/client/granted_scopes/get/{clientId}/{subject} API + ClientGrantedScopesGetApi /api/{serviceId}/client/granted_scopes/get/{clientId}/{subject} API Get the set of scopes that a user has granted to a client application. @@ -211,18 +224,19 @@ The subject parameter is required and can be provided either in the path or as a @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @param clientId A client ID. @param subject Unique user ID of an end-user. @return ApiClientGrantedScopesGetApiRequest */ - ClientGrantedScopesGetApi(ctx context.Context, clientId string, subject string) ApiClientGrantedScopesGetApiRequest + ClientGrantedScopesGetApi(ctx context.Context, serviceId string, clientId string, subject string) ApiClientGrantedScopesGetApiRequest // ClientGrantedScopesGetApiExecute executes the request - // @return ClientGrantedScopesGetResponse - ClientGrantedScopesGetApiExecute(r ApiClientGrantedScopesGetApiRequest) (*ClientGrantedScopesGetResponse, *http.Response, error) + // @return ClientAuthorizationDeleteResponse + ClientGrantedScopesGetApiExecute(r ApiClientGrantedScopesGetApiRequest) (*ClientAuthorizationDeleteResponse, *http.Response, error) /* - ClientSecretRefreshApi /api/client/secret/refresh API + ClientSecretRefreshApi /api/{serviceId}/client/secret/refresh API Refresh the client secret of a client. A new value of the client secret will be generated by the Authlete server. @@ -231,17 +245,18 @@ If you want to specify a new value, use `/api/client/secret/update` API. @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @param clientIdentifier The client ID or the client ID alias of a client. @return ApiClientSecretRefreshApiRequest */ - ClientSecretRefreshApi(ctx context.Context, clientIdentifier string) ApiClientSecretRefreshApiRequest + ClientSecretRefreshApi(ctx context.Context, serviceId string, clientIdentifier string) ApiClientSecretRefreshApiRequest // ClientSecretRefreshApiExecute executes the request // @return ClientSecretRefreshResponse ClientSecretRefreshApiExecute(r ApiClientSecretRefreshApiRequest) (*ClientSecretRefreshResponse, *http.Response, error) /* - ClientSecretUpdateApi /api/client/secret/update API + ClientSecretUpdateApi /api/{serviceId}/client/secret/update API Update the client secret of a client. @@ -250,26 +265,28 @@ API. @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @param clientIdentifier The client ID or the client ID alias of a client. @return ApiClientSecretUpdateApiRequest */ - ClientSecretUpdateApi(ctx context.Context, clientIdentifier string) ApiClientSecretUpdateApiRequest + ClientSecretUpdateApi(ctx context.Context, serviceId string, clientIdentifier string) ApiClientSecretUpdateApiRequest // ClientSecretUpdateApiExecute executes the request // @return ClientSecretUpdateResponse ClientSecretUpdateApiExecute(r ApiClientSecretUpdateApiRequest) (*ClientSecretUpdateResponse, *http.Response, error) /* - ClientUpdateApi /api/client/update/{clientId} API + ClientUpdateApi /api/{serviceId}/client/update/{clientId} API Update a client. @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @param clientId A client ID. @return ApiClientUpdateApiRequest */ - ClientUpdateApi(ctx context.Context, clientId string) ApiClientUpdateApiRequest + ClientUpdateApi(ctx context.Context, serviceId string, clientId string) ApiClientUpdateApiRequest // ClientUpdateApiExecute executes the request // @return Client @@ -282,6 +299,7 @@ type ClientManagementApiService service type ApiClientAuthorizationDeleteApiRequest struct { ctx context.Context ApiService ClientManagementApi + serviceId string clientId string subject string subject2 *string @@ -298,7 +316,7 @@ func (r ApiClientAuthorizationDeleteApiRequest) Execute() (*ClientAuthorizationD } /* -ClientAuthorizationDeleteApi /api/client/authorization/delete/{clientId}/{subject} API +ClientAuthorizationDeleteApi /api/{serviceId}/client/authorization/delete/{clientId}/{subject} API Delete all existing access tokens issued to a client application by an end-user. @@ -306,14 +324,16 @@ The subject parameter is required and can be provided either in the path or as a @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @param clientId A client ID. @param subject Unique user ID of an end-user. @return ApiClientAuthorizationDeleteApiRequest */ -func (a *ClientManagementApiService) ClientAuthorizationDeleteApi(ctx context.Context, clientId string, subject string) ApiClientAuthorizationDeleteApiRequest { +func (a *ClientManagementApiService) ClientAuthorizationDeleteApi(ctx context.Context, serviceId string, clientId string, subject string) ApiClientAuthorizationDeleteApiRequest { return ApiClientAuthorizationDeleteApiRequest{ ApiService: a, ctx: ctx, + serviceId: serviceId, clientId: clientId, subject: subject, } @@ -334,7 +354,8 @@ func (a *ClientManagementApiService) ClientAuthorizationDeleteApiExecute(r ApiCl return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/api/client/authorization/delete/{clientId}" + localVarPath := localBasePath + "/api/{serviceId}/client/authorization/delete/{clientId}" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) localVarPath = strings.Replace(localVarPath, "{"+"clientId"+"}", url.PathEscape(parameterValueToString(r.clientId, "clientId")), -1) localVarPath = strings.Replace(localVarPath, "{"+"subject"+"}", url.PathEscape(parameterValueToString(r.subject, "subject")), -1) @@ -446,6 +467,7 @@ func (a *ClientManagementApiService) ClientAuthorizationDeleteApiExecute(r ApiCl type ApiClientAuthorizationGetListApiRequest struct { ctx context.Context ApiService ClientManagementApi + serviceId string subject string subject2 *string developer *string @@ -482,7 +504,7 @@ func (r ApiClientAuthorizationGetListApiRequest) Execute() (*ClientAuthorization } /* -ClientAuthorizationGetListApi /api/client/authorization/get/list/{subject} API +ClientAuthorizationGetListApi /api/{serviceId}/client/authorization/get/list/{subject} API Get a list of client applications that an end-user has authorized. @@ -490,13 +512,15 @@ The subject parameter is required and can be provided either in the path or as a @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @param subject Unique user ID of an end-user. @return ApiClientAuthorizationGetListApiRequest */ -func (a *ClientManagementApiService) ClientAuthorizationGetListApi(ctx context.Context, subject string) ApiClientAuthorizationGetListApiRequest { +func (a *ClientManagementApiService) ClientAuthorizationGetListApi(ctx context.Context, serviceId string, subject string) ApiClientAuthorizationGetListApiRequest { return ApiClientAuthorizationGetListApiRequest{ ApiService: a, ctx: ctx, + serviceId: serviceId, subject: subject, } } @@ -516,7 +540,8 @@ func (a *ClientManagementApiService) ClientAuthorizationGetListApiExecute(r ApiC return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/api/client/authorization/get/list" + localVarPath := localBasePath + "/api/{serviceId}/client/authorization/get/list" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) localVarPath = strings.Replace(localVarPath, "{"+"subject"+"}", url.PathEscape(parameterValueToString(r.subject, "subject")), -1) localVarHeaderParams := make(map[string]string) @@ -636,6 +661,7 @@ func (a *ClientManagementApiService) ClientAuthorizationGetListApiExecute(r ApiC type ApiClientAuthorizationUpdateApiRequest struct { ctx context.Context ApiService ClientManagementApi + serviceId string clientId string clientAuthorizationUpdateRequest *ClientAuthorizationUpdateRequest } @@ -650,19 +676,21 @@ func (r ApiClientAuthorizationUpdateApiRequest) Execute() (*ClientAuthorizationU } /* -ClientAuthorizationUpdateApi /api/client/authorization/update/{clientId} API +ClientAuthorizationUpdateApi /api/{serviceId}/client/authorization/update/{clientId} API Update attributes of all existing access tokens given to a client application. @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @param clientId A client ID. @return ApiClientAuthorizationUpdateApiRequest */ -func (a *ClientManagementApiService) ClientAuthorizationUpdateApi(ctx context.Context, clientId string) ApiClientAuthorizationUpdateApiRequest { +func (a *ClientManagementApiService) ClientAuthorizationUpdateApi(ctx context.Context, serviceId string, clientId string) ApiClientAuthorizationUpdateApiRequest { return ApiClientAuthorizationUpdateApiRequest{ ApiService: a, ctx: ctx, + serviceId: serviceId, clientId: clientId, } } @@ -682,7 +710,8 @@ func (a *ClientManagementApiService) ClientAuthorizationUpdateApiExecute(r ApiCl return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/api/client/authorization/update/{clientId}" + localVarPath := localBasePath + "/api/{serviceId}/client/authorization/update/{clientId}" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) localVarPath = strings.Replace(localVarPath, "{"+"clientId"+"}", url.PathEscape(parameterValueToString(r.clientId, "clientId")), -1) localVarHeaderParams := make(map[string]string) @@ -791,6 +820,7 @@ func (a *ClientManagementApiService) ClientAuthorizationUpdateApiExecute(r ApiCl type ApiClientCreateApiRequest struct { ctx context.Context ApiService ClientManagementApi + serviceId string client *Client } @@ -804,18 +834,20 @@ func (r ApiClientCreateApiRequest) Execute() (*Client, *http.Response, error) { } /* -ClientCreateApi /api/client/create API +ClientCreateApi /api/{serviceId}/client/create API Create a new client. @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiClientCreateApiRequest */ -func (a *ClientManagementApiService) ClientCreateApi(ctx context.Context) ApiClientCreateApiRequest { +func (a *ClientManagementApiService) ClientCreateApi(ctx context.Context, serviceId string) ApiClientCreateApiRequest { return ApiClientCreateApiRequest{ ApiService: a, ctx: ctx, + serviceId: serviceId, } } @@ -834,7 +866,8 @@ func (a *ClientManagementApiService) ClientCreateApiExecute(r ApiClientCreateApi return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/api/client/create" + localVarPath := localBasePath + "/api/{serviceId}/client/create" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := url.Values{} @@ -942,6 +975,7 @@ func (a *ClientManagementApiService) ClientCreateApiExecute(r ApiClientCreateApi type ApiClientDeleteApiRequest struct { ctx context.Context ApiService ClientManagementApi + serviceId string clientId string } @@ -950,19 +984,21 @@ func (r ApiClientDeleteApiRequest) Execute() (*http.Response, error) { } /* -ClientDeleteApi /api/client/delete/{clientId} API +ClientDeleteApi /api/{serviceId}/client/delete/{clientId} API Delete a client. @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @param clientId The client ID. @return ApiClientDeleteApiRequest */ -func (a *ClientManagementApiService) ClientDeleteApi(ctx context.Context, clientId string) ApiClientDeleteApiRequest { +func (a *ClientManagementApiService) ClientDeleteApi(ctx context.Context, serviceId string, clientId string) ApiClientDeleteApiRequest { return ApiClientDeleteApiRequest{ ApiService: a, ctx: ctx, + serviceId: serviceId, clientId: clientId, } } @@ -980,7 +1016,8 @@ func (a *ClientManagementApiService) ClientDeleteApiExecute(r ApiClientDeleteApi return nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/api/client/delete/{clientId}" + localVarPath := localBasePath + "/api/{serviceId}/client/delete/{clientId}" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) localVarPath = strings.Replace(localVarPath, "{"+"clientId"+"}", url.PathEscape(parameterValueToString(r.clientId, "clientId")), -1) localVarHeaderParams := make(map[string]string) @@ -1078,6 +1115,7 @@ func (a *ClientManagementApiService) ClientDeleteApiExecute(r ApiClientDeleteApi type ApiClientFlagUpdateApiRequest struct { ctx context.Context ApiService ClientManagementApi + serviceId string clientIdentifier string clientFlagUpdateRequest *ClientFlagUpdateRequest } @@ -1092,19 +1130,21 @@ func (r ApiClientFlagUpdateApiRequest) Execute() (*ClientFlagUpdateResponse, *ht } /* -ClientFlagUpdateApi /api/client/lock_flag/update/{clientIdentifier} API +ClientFlagUpdateApi /api/{serviceId}/client/lock_flag/update/{clientIdentifier} API Lock and unlock a client @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @param clientIdentifier A client ID. @return ApiClientFlagUpdateApiRequest */ -func (a *ClientManagementApiService) ClientFlagUpdateApi(ctx context.Context, clientIdentifier string) ApiClientFlagUpdateApiRequest { +func (a *ClientManagementApiService) ClientFlagUpdateApi(ctx context.Context, serviceId string, clientIdentifier string) ApiClientFlagUpdateApiRequest { return ApiClientFlagUpdateApiRequest{ ApiService: a, ctx: ctx, + serviceId: serviceId, clientIdentifier: clientIdentifier, } } @@ -1124,7 +1164,8 @@ func (a *ClientManagementApiService) ClientFlagUpdateApiExecute(r ApiClientFlagU return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/api/client/lock_flag/update/{clientIdentifier}" + localVarPath := localBasePath + "/api/{serviceId}/client/lock_flag/update/{clientIdentifier}" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) localVarPath = strings.Replace(localVarPath, "{"+"clientIdentifier"+"}", url.PathEscape(parameterValueToString(r.clientIdentifier, "clientIdentifier")), -1) localVarHeaderParams := make(map[string]string) @@ -1233,6 +1274,7 @@ func (a *ClientManagementApiService) ClientFlagUpdateApiExecute(r ApiClientFlagU type ApiClientGetApiRequest struct { ctx context.Context ApiService ClientManagementApi + serviceId string clientId string } @@ -1241,19 +1283,21 @@ func (r ApiClientGetApiRequest) Execute() (*Client, *http.Response, error) { } /* -ClientGetApi /api/client/get/{clientId} API +ClientGetApi /api/{serviceId}/client/get/{clientId} API Get a client. @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @param clientId A client ID. @return ApiClientGetApiRequest */ -func (a *ClientManagementApiService) ClientGetApi(ctx context.Context, clientId string) ApiClientGetApiRequest { +func (a *ClientManagementApiService) ClientGetApi(ctx context.Context, serviceId string, clientId string) ApiClientGetApiRequest { return ApiClientGetApiRequest{ ApiService: a, ctx: ctx, + serviceId: serviceId, clientId: clientId, } } @@ -1273,7 +1317,8 @@ func (a *ClientManagementApiService) ClientGetApiExecute(r ApiClientGetApiReques return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/api/client/get/{clientId}" + localVarPath := localBasePath + "/api/{serviceId}/client/get/{clientId}" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) localVarPath = strings.Replace(localVarPath, "{"+"clientId"+"}", url.PathEscape(parameterValueToString(r.clientId, "clientId")), -1) localVarHeaderParams := make(map[string]string) @@ -1380,6 +1425,7 @@ func (a *ClientManagementApiService) ClientGetApiExecute(r ApiClientGetApiReques type ApiClientGetListApiRequest struct { ctx context.Context ApiService ClientManagementApi + serviceId string developer *string start *int32 end *int32 @@ -1403,34 +1449,40 @@ func (r ApiClientGetListApiRequest) End(end int32) ApiClientGetListApiRequest { return r } -func (r ApiClientGetListApiRequest) Execute() (*ClientGetListResponse, *http.Response, error) { +func (r ApiClientGetListApiRequest) Execute() (*ClientGetListApi200Response, *http.Response, error) { return r.ApiService.ClientGetListApiExecute(r) } /* -ClientGetListApi /api/client/get/list API +ClientGetListApi /api/{serviceId}/client/get/list API + +Get a list of clients on a service. -Get a list of clients. +If the access token can view a full service (including an admin), all clients within the +service are returned. Otherwise, only clients that the access token can view within the +service are returned. @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiClientGetListApiRequest */ -func (a *ClientManagementApiService) ClientGetListApi(ctx context.Context) ApiClientGetListApiRequest { +func (a *ClientManagementApiService) ClientGetListApi(ctx context.Context, serviceId string) ApiClientGetListApiRequest { return ApiClientGetListApiRequest{ ApiService: a, ctx: ctx, + serviceId: serviceId, } } // Execute executes the request -// @return ClientGetListResponse -func (a *ClientManagementApiService) ClientGetListApiExecute(r ApiClientGetListApiRequest) (*ClientGetListResponse, *http.Response, error) { +// @return ClientGetListApi200Response +func (a *ClientManagementApiService) ClientGetListApiExecute(r ApiClientGetListApiRequest) (*ClientGetListApi200Response, *http.Response, error) { var ( localVarHTTPMethod = http.MethodGet localVarPostBody interface{} formFiles []formFile - localVarReturnValue *ClientGetListResponse + localVarReturnValue *ClientGetListApi200Response ) localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "ClientManagementApiService.ClientGetListApi") @@ -1438,7 +1490,8 @@ func (a *ClientManagementApiService) ClientGetListApiExecute(r ApiClientGetListA return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/api/client/get/list" + localVarPath := localBasePath + "/api/{serviceId}/client/get/list" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := url.Values{} @@ -1553,6 +1606,7 @@ func (a *ClientManagementApiService) ClientGetListApiExecute(r ApiClientGetListA type ApiClientGrantedScopesDeleteApiRequest struct { ctx context.Context ApiService ClientManagementApi + serviceId string clientId string subject string subject2 *string @@ -1569,7 +1623,7 @@ func (r ApiClientGrantedScopesDeleteApiRequest) Execute() (*ClientGrantedScopesD } /* -ClientGrantedScopesDeleteApi /api/client/granted_scopes/delete/{clientId}/{subject} API +ClientGrantedScopesDeleteApi /api/{serviceId}/client/granted_scopes/delete/{clientId}/{subject} API Delete the set of scopes that an end-user has granted to a client application. @@ -1585,14 +1639,16 @@ The subject parameter is required and can be provided either in the path or as a @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @param clientId A client ID. @param subject Unique user ID of an end-user. @return ApiClientGrantedScopesDeleteApiRequest */ -func (a *ClientManagementApiService) ClientGrantedScopesDeleteApi(ctx context.Context, clientId string, subject string) ApiClientGrantedScopesDeleteApiRequest { +func (a *ClientManagementApiService) ClientGrantedScopesDeleteApi(ctx context.Context, serviceId string, clientId string, subject string) ApiClientGrantedScopesDeleteApiRequest { return ApiClientGrantedScopesDeleteApiRequest{ ApiService: a, ctx: ctx, + serviceId: serviceId, clientId: clientId, subject: subject, } @@ -1613,7 +1669,8 @@ func (a *ClientManagementApiService) ClientGrantedScopesDeleteApiExecute(r ApiCl return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/api/client/granted_scopes/delete/{clientId}" + localVarPath := localBasePath + "/api/{serviceId}/client/granted_scopes/delete/{clientId}" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) localVarPath = strings.Replace(localVarPath, "{"+"clientId"+"}", url.PathEscape(parameterValueToString(r.clientId, "clientId")), -1) localVarPath = strings.Replace(localVarPath, "{"+"subject"+"}", url.PathEscape(parameterValueToString(r.subject, "subject")), -1) @@ -1725,6 +1782,7 @@ func (a *ClientManagementApiService) ClientGrantedScopesDeleteApiExecute(r ApiCl type ApiClientGrantedScopesGetApiRequest struct { ctx context.Context ApiService ClientManagementApi + serviceId string clientId string subject string subject2 *string @@ -1736,12 +1794,12 @@ func (r ApiClientGrantedScopesGetApiRequest) Subject2(subject2 string) ApiClient return r } -func (r ApiClientGrantedScopesGetApiRequest) Execute() (*ClientGrantedScopesGetResponse, *http.Response, error) { +func (r ApiClientGrantedScopesGetApiRequest) Execute() (*ClientAuthorizationDeleteResponse, *http.Response, error) { return r.ApiService.ClientGrantedScopesGetApiExecute(r) } /* -ClientGrantedScopesGetApi /api/client/granted_scopes/get/{clientId}/{subject} API +ClientGrantedScopesGetApi /api/{serviceId}/client/granted_scopes/get/{clientId}/{subject} API Get the set of scopes that a user has granted to a client application. @@ -1772,27 +1830,29 @@ The subject parameter is required and can be provided either in the path or as a @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @param clientId A client ID. @param subject Unique user ID of an end-user. @return ApiClientGrantedScopesGetApiRequest */ -func (a *ClientManagementApiService) ClientGrantedScopesGetApi(ctx context.Context, clientId string, subject string) ApiClientGrantedScopesGetApiRequest { +func (a *ClientManagementApiService) ClientGrantedScopesGetApi(ctx context.Context, serviceId string, clientId string, subject string) ApiClientGrantedScopesGetApiRequest { return ApiClientGrantedScopesGetApiRequest{ ApiService: a, ctx: ctx, + serviceId: serviceId, clientId: clientId, subject: subject, } } // Execute executes the request -// @return ClientGrantedScopesGetResponse -func (a *ClientManagementApiService) ClientGrantedScopesGetApiExecute(r ApiClientGrantedScopesGetApiRequest) (*ClientGrantedScopesGetResponse, *http.Response, error) { +// @return ClientAuthorizationDeleteResponse +func (a *ClientManagementApiService) ClientGrantedScopesGetApiExecute(r ApiClientGrantedScopesGetApiRequest) (*ClientAuthorizationDeleteResponse, *http.Response, error) { var ( localVarHTTPMethod = http.MethodGet localVarPostBody interface{} formFiles []formFile - localVarReturnValue *ClientGrantedScopesGetResponse + localVarReturnValue *ClientAuthorizationDeleteResponse ) localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "ClientManagementApiService.ClientGrantedScopesGetApi") @@ -1800,7 +1860,8 @@ func (a *ClientManagementApiService) ClientGrantedScopesGetApiExecute(r ApiClien return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/api/client/granted_scopes/get/{clientId}" + localVarPath := localBasePath + "/api/{serviceId}/client/granted_scopes/get/{clientId}" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) localVarPath = strings.Replace(localVarPath, "{"+"clientId"+"}", url.PathEscape(parameterValueToString(r.clientId, "clientId")), -1) localVarPath = strings.Replace(localVarPath, "{"+"subject"+"}", url.PathEscape(parameterValueToString(r.subject, "subject")), -1) @@ -1912,6 +1973,7 @@ func (a *ClientManagementApiService) ClientGrantedScopesGetApiExecute(r ApiClien type ApiClientSecretRefreshApiRequest struct { ctx context.Context ApiService ClientManagementApi + serviceId string clientIdentifier string } @@ -1920,7 +1982,7 @@ func (r ApiClientSecretRefreshApiRequest) Execute() (*ClientSecretRefreshRespons } /* -ClientSecretRefreshApi /api/client/secret/refresh API +ClientSecretRefreshApi /api/{serviceId}/client/secret/refresh API Refresh the client secret of a client. A new value of the client secret will be generated by the Authlete server. @@ -1929,13 +1991,15 @@ If you want to specify a new value, use `/api/client/secret/update` API. @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @param clientIdentifier The client ID or the client ID alias of a client. @return ApiClientSecretRefreshApiRequest */ -func (a *ClientManagementApiService) ClientSecretRefreshApi(ctx context.Context, clientIdentifier string) ApiClientSecretRefreshApiRequest { +func (a *ClientManagementApiService) ClientSecretRefreshApi(ctx context.Context, serviceId string, clientIdentifier string) ApiClientSecretRefreshApiRequest { return ApiClientSecretRefreshApiRequest{ ApiService: a, ctx: ctx, + serviceId: serviceId, clientIdentifier: clientIdentifier, } } @@ -1955,7 +2019,8 @@ func (a *ClientManagementApiService) ClientSecretRefreshApiExecute(r ApiClientSe return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/api/client/secret/refresh/{clientIdentifier}" + localVarPath := localBasePath + "/api/{serviceId}/client/secret/refresh/{clientIdentifier}" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) localVarPath = strings.Replace(localVarPath, "{"+"clientIdentifier"+"}", url.PathEscape(parameterValueToString(r.clientIdentifier, "clientIdentifier")), -1) localVarHeaderParams := make(map[string]string) @@ -2062,6 +2127,7 @@ func (a *ClientManagementApiService) ClientSecretRefreshApiExecute(r ApiClientSe type ApiClientSecretUpdateApiRequest struct { ctx context.Context ApiService ClientManagementApi + serviceId string clientIdentifier string clientSecretUpdateRequest *ClientSecretUpdateRequest } @@ -2076,7 +2142,7 @@ func (r ApiClientSecretUpdateApiRequest) Execute() (*ClientSecretUpdateResponse, } /* -ClientSecretUpdateApi /api/client/secret/update API +ClientSecretUpdateApi /api/{serviceId}/client/secret/update API Update the client secret of a client. @@ -2085,13 +2151,15 @@ API. @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @param clientIdentifier The client ID or the client ID alias of a client. @return ApiClientSecretUpdateApiRequest */ -func (a *ClientManagementApiService) ClientSecretUpdateApi(ctx context.Context, clientIdentifier string) ApiClientSecretUpdateApiRequest { +func (a *ClientManagementApiService) ClientSecretUpdateApi(ctx context.Context, serviceId string, clientIdentifier string) ApiClientSecretUpdateApiRequest { return ApiClientSecretUpdateApiRequest{ ApiService: a, ctx: ctx, + serviceId: serviceId, clientIdentifier: clientIdentifier, } } @@ -2111,7 +2179,8 @@ func (a *ClientManagementApiService) ClientSecretUpdateApiExecute(r ApiClientSec return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/api/client/secret/update/{clientIdentifier}" + localVarPath := localBasePath + "/api/{serviceId}/client/secret/update/{clientIdentifier}" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) localVarPath = strings.Replace(localVarPath, "{"+"clientIdentifier"+"}", url.PathEscape(parameterValueToString(r.clientIdentifier, "clientIdentifier")), -1) localVarHeaderParams := make(map[string]string) @@ -2223,6 +2292,7 @@ func (a *ClientManagementApiService) ClientSecretUpdateApiExecute(r ApiClientSec type ApiClientUpdateApiRequest struct { ctx context.Context ApiService ClientManagementApi + serviceId string clientId string client *Client } @@ -2237,19 +2307,21 @@ func (r ApiClientUpdateApiRequest) Execute() (*Client, *http.Response, error) { } /* -ClientUpdateApi /api/client/update/{clientId} API +ClientUpdateApi /api/{serviceId}/client/update/{clientId} API Update a client. @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @param clientId A client ID. @return ApiClientUpdateApiRequest */ -func (a *ClientManagementApiService) ClientUpdateApi(ctx context.Context, clientId string) ApiClientUpdateApiRequest { +func (a *ClientManagementApiService) ClientUpdateApi(ctx context.Context, serviceId string, clientId string) ApiClientUpdateApiRequest { return ApiClientUpdateApiRequest{ ApiService: a, ctx: ctx, + serviceId: serviceId, clientId: clientId, } } @@ -2269,7 +2341,8 @@ func (a *ClientManagementApiService) ClientUpdateApiExecute(r ApiClientUpdateApi return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/api/client/update/{clientId}" + localVarPath := localBasePath + "/api/{serviceId}/client/update/{clientId}" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) localVarPath = strings.Replace(localVarPath, "{"+"clientId"+"}", url.PathEscape(parameterValueToString(r.clientId, "clientId")), -1) localVarHeaderParams := make(map[string]string) diff --git a/api_configuration_endpoint.go b/api_configuration_endpoint.go index 7bc2fdf..90a80d4 100644 --- a/api_configuration_endpoint.go +++ b/api_configuration_endpoint.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. @@ -16,13 +16,14 @@ import ( "io/ioutil" "net/http" "net/url" + "strings" ) type ConfigurationEndpointApi interface { /* - ServiceConfigurationApi /api/service/configuration API + ServiceConfigurationApi /api/{serviceId}/service/configuration API This API gathers configuration information about a service. @@ -40,9 +41,10 @@ in OpenID Connect Discovery 1.0. @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiServiceConfigurationApiRequest */ - ServiceConfigurationApi(ctx context.Context) ApiServiceConfigurationApiRequest + ServiceConfigurationApi(ctx context.Context, serviceId string) ApiServiceConfigurationApiRequest // ServiceConfigurationApiExecute executes the request // @return map[string]interface{} @@ -55,6 +57,7 @@ type ConfigurationEndpointApiService service type ApiServiceConfigurationApiRequest struct { ctx context.Context ApiService ConfigurationEndpointApi + serviceId string pretty *bool patch *string } @@ -76,7 +79,7 @@ func (r ApiServiceConfigurationApiRequest) Execute() (map[string]interface{}, *h } /* -ServiceConfigurationApi /api/service/configuration API +ServiceConfigurationApi /api/{serviceId}/service/configuration API This API gathers configuration information about a service. @@ -94,12 +97,14 @@ in OpenID Connect Discovery 1.0. @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiServiceConfigurationApiRequest */ -func (a *ConfigurationEndpointApiService) ServiceConfigurationApi(ctx context.Context) ApiServiceConfigurationApiRequest { +func (a *ConfigurationEndpointApiService) ServiceConfigurationApi(ctx context.Context, serviceId string) ApiServiceConfigurationApiRequest { return ApiServiceConfigurationApiRequest{ ApiService: a, ctx: ctx, + serviceId: serviceId, } } @@ -118,7 +123,8 @@ func (a *ConfigurationEndpointApiService) ServiceConfigurationApiExecute(r ApiSe return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/api/service/configuration" + localVarPath := localBasePath + "/api/{serviceId}/service/configuration" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := url.Values{} diff --git a/api_default.go b/api_default.go index b49f696..b769fb9 100644 --- a/api_default.go +++ b/api_default.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/api_device_flow.go b/api_device_flow.go index be5d554..d46a6ba 100644 --- a/api_device_flow.go +++ b/api_device_flow.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. @@ -16,13 +16,14 @@ import ( "io/ioutil" "net/http" "net/url" + "strings" ) type DeviceFlowApi interface { /* - DeviceAuthorizationApi /api/device/authorization API + DeviceAuthorizationApi /api/{serviceId}/device/authorization API This API parses request parameters of a [device authorization request](https://datatracker.ietf.org/doc/html/rfc8628#section-3.1) and returns necessary data for the authorization server implementation to process the device authorization @@ -123,16 +124,17 @@ and return to the client application. @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiDeviceAuthorizationApiRequest */ - DeviceAuthorizationApi(ctx context.Context) ApiDeviceAuthorizationApiRequest + DeviceAuthorizationApi(ctx context.Context, serviceId string) ApiDeviceAuthorizationApiRequest // DeviceAuthorizationApiExecute executes the request // @return DeviceAuthorizationResponse DeviceAuthorizationApiExecute(r ApiDeviceAuthorizationApiRequest) (*DeviceAuthorizationResponse, *http.Response, error) /* - DeviceCompleteApi /api/device/complete API + DeviceCompleteApi /api/{serviceId}/device/complete API This API returns information about what action the authorization server should take after it receives the result of end-user's decision about whether the end-user has approved or rejected a client @@ -207,16 +209,17 @@ using. @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiDeviceCompleteApiRequest */ - DeviceCompleteApi(ctx context.Context) ApiDeviceCompleteApiRequest + DeviceCompleteApi(ctx context.Context, serviceId string) ApiDeviceCompleteApiRequest // DeviceCompleteApiExecute executes the request // @return DeviceCompleteResponse DeviceCompleteApiExecute(r ApiDeviceCompleteApiRequest) (*DeviceCompleteResponse, *http.Response, error) /* - DeviceVerificationApi /api/device/verification API + DeviceVerificationApi /api/{serviceId}/device/verification API The API returns information associated with a user code. @@ -262,9 +265,10 @@ to ask whether she approves or rejects the authorization request from the device @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiDeviceVerificationApiRequest */ - DeviceVerificationApi(ctx context.Context) ApiDeviceVerificationApiRequest + DeviceVerificationApi(ctx context.Context, serviceId string) ApiDeviceVerificationApiRequest // DeviceVerificationApiExecute executes the request // @return DeviceVerificationResponse @@ -277,6 +281,7 @@ type DeviceFlowApiService service type ApiDeviceAuthorizationApiRequest struct { ctx context.Context ApiService DeviceFlowApi + serviceId string deviceAuthorizationRequest *DeviceAuthorizationRequest } @@ -290,7 +295,7 @@ func (r ApiDeviceAuthorizationApiRequest) Execute() (*DeviceAuthorizationRespons } /* -DeviceAuthorizationApi /api/device/authorization API +DeviceAuthorizationApi /api/{serviceId}/device/authorization API This API parses request parameters of a [device authorization request](https://datatracker.ietf.org/doc/html/rfc8628#section-3.1) and returns necessary data for the authorization server implementation to process the device authorization @@ -391,12 +396,14 @@ and return to the client application. @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiDeviceAuthorizationApiRequest */ -func (a *DeviceFlowApiService) DeviceAuthorizationApi(ctx context.Context) ApiDeviceAuthorizationApiRequest { +func (a *DeviceFlowApiService) DeviceAuthorizationApi(ctx context.Context, serviceId string) ApiDeviceAuthorizationApiRequest { return ApiDeviceAuthorizationApiRequest{ ApiService: a, ctx: ctx, + serviceId: serviceId, } } @@ -415,7 +422,8 @@ func (a *DeviceFlowApiService) DeviceAuthorizationApiExecute(r ApiDeviceAuthoriz return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/api/device/authorization" + localVarPath := localBasePath + "/api/{serviceId}/device/authorization" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := url.Values{} @@ -526,6 +534,7 @@ func (a *DeviceFlowApiService) DeviceAuthorizationApiExecute(r ApiDeviceAuthoriz type ApiDeviceCompleteApiRequest struct { ctx context.Context ApiService DeviceFlowApi + serviceId string deviceCompleteRequest *DeviceCompleteRequest } @@ -539,7 +548,7 @@ func (r ApiDeviceCompleteApiRequest) Execute() (*DeviceCompleteResponse, *http.R } /* -DeviceCompleteApi /api/device/complete API +DeviceCompleteApi /api/{serviceId}/device/complete API This API returns information about what action the authorization server should take after it receives the result of end-user's decision about whether the end-user has approved or rejected a client @@ -614,12 +623,14 @@ using. @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiDeviceCompleteApiRequest */ -func (a *DeviceFlowApiService) DeviceCompleteApi(ctx context.Context) ApiDeviceCompleteApiRequest { +func (a *DeviceFlowApiService) DeviceCompleteApi(ctx context.Context, serviceId string) ApiDeviceCompleteApiRequest { return ApiDeviceCompleteApiRequest{ ApiService: a, ctx: ctx, + serviceId: serviceId, } } @@ -638,7 +649,8 @@ func (a *DeviceFlowApiService) DeviceCompleteApiExecute(r ApiDeviceCompleteApiRe return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/api/device/complete" + localVarPath := localBasePath + "/api/{serviceId}/device/complete" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := url.Values{} @@ -749,6 +761,7 @@ func (a *DeviceFlowApiService) DeviceCompleteApiExecute(r ApiDeviceCompleteApiRe type ApiDeviceVerificationApiRequest struct { ctx context.Context ApiService DeviceFlowApi + serviceId string deviceVerificationRequest *DeviceVerificationRequest } @@ -762,7 +775,7 @@ func (r ApiDeviceVerificationApiRequest) Execute() (*DeviceVerificationResponse, } /* -DeviceVerificationApi /api/device/verification API +DeviceVerificationApi /api/{serviceId}/device/verification API The API returns information associated with a user code. @@ -808,12 +821,14 @@ to ask whether she approves or rejects the authorization request from the device @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiDeviceVerificationApiRequest */ -func (a *DeviceFlowApiService) DeviceVerificationApi(ctx context.Context) ApiDeviceVerificationApiRequest { +func (a *DeviceFlowApiService) DeviceVerificationApi(ctx context.Context, serviceId string) ApiDeviceVerificationApiRequest { return ApiDeviceVerificationApiRequest{ ApiService: a, ctx: ctx, + serviceId: serviceId, } } @@ -832,7 +847,8 @@ func (a *DeviceFlowApiService) DeviceVerificationApiExecute(r ApiDeviceVerificat return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/api/device/verification" + localVarPath := localBasePath + "/api/{serviceId}/device/verification" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := url.Values{} diff --git a/api_dynamic_client_registration.go b/api_dynamic_client_registration.go index efbb61f..e284ff1 100644 --- a/api_dynamic_client_registration.go +++ b/api_dynamic_client_registration.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. @@ -16,13 +16,14 @@ import ( "io/ioutil" "net/http" "net/url" + "strings" ) type DynamicClientRegistrationApi interface { /* - ClientRegistrationApi /api/client/registration API + ClientRegistrationApi /api/{serviceId}/client/registration API Register a client. This API is supposed to be used to implement a client registration endpoint that complies with [RFC 7591](https://datatracker.ietf.org/doc/html/rfc7591) (OAuth 2.0 Dynamic Client @@ -110,16 +111,17 @@ Pragma: no-cache @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiClientRegistrationApiRequest */ - ClientRegistrationApi(ctx context.Context) ApiClientRegistrationApiRequest + ClientRegistrationApi(ctx context.Context, serviceId string) ApiClientRegistrationApiRequest // ClientRegistrationApiExecute executes the request // @return ClientRegistrationResponse ClientRegistrationApiExecute(r ApiClientRegistrationApiRequest) (*ClientRegistrationResponse, *http.Response, error) /* - ClientRegistrationDeleteApi /api/client/registration/delete API + ClientRegistrationDeleteApi /api/{serviceId}/client/registration/delete API Delete a dynamically registered client. This API is supposed to be used to implement a client registration management endpoint that complies with [RFC 7592](https://datatracker.ietf.org/doc/html/rfc7592) @@ -229,16 +231,17 @@ Pragma: no-cache @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiClientRegistrationDeleteApiRequest */ - ClientRegistrationDeleteApi(ctx context.Context) ApiClientRegistrationDeleteApiRequest + ClientRegistrationDeleteApi(ctx context.Context, serviceId string) ApiClientRegistrationDeleteApiRequest // ClientRegistrationDeleteApiExecute executes the request // @return ClientRegistrationDeleteResponse ClientRegistrationDeleteApiExecute(r ApiClientRegistrationDeleteApiRequest) (*ClientRegistrationDeleteResponse, *http.Response, error) /* - ClientRegistrationGetApi /api/client/registration/get API + ClientRegistrationGetApi /api/{serviceId}/client/registration/get API Get a dynamically registered client. This API is supposed to be used to implement a client registration management endpoint that complies with [RFC 7592](https://datatracker.ietf.org/doc/html/rfc7592) @@ -353,16 +356,17 @@ Pragma: no-cache @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiClientRegistrationGetApiRequest */ - ClientRegistrationGetApi(ctx context.Context) ApiClientRegistrationGetApiRequest + ClientRegistrationGetApi(ctx context.Context, serviceId string) ApiClientRegistrationGetApiRequest // ClientRegistrationGetApiExecute executes the request - // @return ClientRegistrationGetResponse - ClientRegistrationGetApiExecute(r ApiClientRegistrationGetApiRequest) (*ClientRegistrationGetResponse, *http.Response, error) + // @return ClientRegistrationResponse + ClientRegistrationGetApiExecute(r ApiClientRegistrationGetApiRequest) (*ClientRegistrationResponse, *http.Response, error) /* - ClientRegistrationUpdateApi /api/client/registration/update API + ClientRegistrationUpdateApi /api/{serviceId}/client/registration/update API Update a dynamically registered client. This API is supposed to be used to implement a client registration management endpoint that complies with [RFC 7592](https://datatracker.ietf.org/doc/html/rfc7592) @@ -477,9 +481,10 @@ Pragma: no-cache @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiClientRegistrationUpdateApiRequest */ - ClientRegistrationUpdateApi(ctx context.Context) ApiClientRegistrationUpdateApiRequest + ClientRegistrationUpdateApi(ctx context.Context, serviceId string) ApiClientRegistrationUpdateApiRequest // ClientRegistrationUpdateApiExecute executes the request // @return ClientRegistrationUpdateResponse @@ -492,6 +497,7 @@ type DynamicClientRegistrationApiService service type ApiClientRegistrationApiRequest struct { ctx context.Context ApiService DynamicClientRegistrationApi + serviceId string clientRegistrationRequest *ClientRegistrationRequest } @@ -505,7 +511,7 @@ func (r ApiClientRegistrationApiRequest) Execute() (*ClientRegistrationResponse, } /* -ClientRegistrationApi /api/client/registration API +ClientRegistrationApi /api/{serviceId}/client/registration API Register a client. This API is supposed to be used to implement a client registration endpoint that complies with [RFC 7591](https://datatracker.ietf.org/doc/html/rfc7591) (OAuth 2.0 Dynamic Client @@ -593,12 +599,14 @@ Pragma: no-cache @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiClientRegistrationApiRequest */ -func (a *DynamicClientRegistrationApiService) ClientRegistrationApi(ctx context.Context) ApiClientRegistrationApiRequest { +func (a *DynamicClientRegistrationApiService) ClientRegistrationApi(ctx context.Context, serviceId string) ApiClientRegistrationApiRequest { return ApiClientRegistrationApiRequest{ ApiService: a, ctx: ctx, + serviceId: serviceId, } } @@ -617,7 +625,8 @@ func (a *DynamicClientRegistrationApiService) ClientRegistrationApiExecute(r Api return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/api/client/registration" + localVarPath := localBasePath + "/api/{serviceId}/client/registration" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := url.Values{} @@ -728,6 +737,7 @@ func (a *DynamicClientRegistrationApiService) ClientRegistrationApiExecute(r Api type ApiClientRegistrationDeleteApiRequest struct { ctx context.Context ApiService DynamicClientRegistrationApi + serviceId string clientRegistrationDeleteRequest *ClientRegistrationDeleteRequest } @@ -741,7 +751,7 @@ func (r ApiClientRegistrationDeleteApiRequest) Execute() (*ClientRegistrationDel } /* -ClientRegistrationDeleteApi /api/client/registration/delete API +ClientRegistrationDeleteApi /api/{serviceId}/client/registration/delete API Delete a dynamically registered client. This API is supposed to be used to implement a client registration management endpoint that complies with [RFC 7592](https://datatracker.ietf.org/doc/html/rfc7592) @@ -851,12 +861,14 @@ Pragma: no-cache @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiClientRegistrationDeleteApiRequest */ -func (a *DynamicClientRegistrationApiService) ClientRegistrationDeleteApi(ctx context.Context) ApiClientRegistrationDeleteApiRequest { +func (a *DynamicClientRegistrationApiService) ClientRegistrationDeleteApi(ctx context.Context, serviceId string) ApiClientRegistrationDeleteApiRequest { return ApiClientRegistrationDeleteApiRequest{ ApiService: a, ctx: ctx, + serviceId: serviceId, } } @@ -875,7 +887,8 @@ func (a *DynamicClientRegistrationApiService) ClientRegistrationDeleteApiExecute return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/api/client/registration/delete" + localVarPath := localBasePath + "/api/{serviceId}/client/registration/delete" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := url.Values{} @@ -986,20 +999,21 @@ func (a *DynamicClientRegistrationApiService) ClientRegistrationDeleteApiExecute type ApiClientRegistrationGetApiRequest struct { ctx context.Context ApiService DynamicClientRegistrationApi - clientRegistrationGetRequest *ClientRegistrationGetRequest + serviceId string + clientRegistrationRequest *ClientRegistrationRequest } -func (r ApiClientRegistrationGetApiRequest) ClientRegistrationGetRequest(clientRegistrationGetRequest ClientRegistrationGetRequest) ApiClientRegistrationGetApiRequest { - r.clientRegistrationGetRequest = &clientRegistrationGetRequest +func (r ApiClientRegistrationGetApiRequest) ClientRegistrationRequest(clientRegistrationRequest ClientRegistrationRequest) ApiClientRegistrationGetApiRequest { + r.clientRegistrationRequest = &clientRegistrationRequest return r } -func (r ApiClientRegistrationGetApiRequest) Execute() (*ClientRegistrationGetResponse, *http.Response, error) { +func (r ApiClientRegistrationGetApiRequest) Execute() (*ClientRegistrationResponse, *http.Response, error) { return r.ApiService.ClientRegistrationGetApiExecute(r) } /* -ClientRegistrationGetApi /api/client/registration/get API +ClientRegistrationGetApi /api/{serviceId}/client/registration/get API Get a dynamically registered client. This API is supposed to be used to implement a client registration management endpoint that complies with [RFC 7592](https://datatracker.ietf.org/doc/html/rfc7592) @@ -1114,23 +1128,25 @@ Pragma: no-cache @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiClientRegistrationGetApiRequest */ -func (a *DynamicClientRegistrationApiService) ClientRegistrationGetApi(ctx context.Context) ApiClientRegistrationGetApiRequest { +func (a *DynamicClientRegistrationApiService) ClientRegistrationGetApi(ctx context.Context, serviceId string) ApiClientRegistrationGetApiRequest { return ApiClientRegistrationGetApiRequest{ ApiService: a, ctx: ctx, + serviceId: serviceId, } } // Execute executes the request -// @return ClientRegistrationGetResponse -func (a *DynamicClientRegistrationApiService) ClientRegistrationGetApiExecute(r ApiClientRegistrationGetApiRequest) (*ClientRegistrationGetResponse, *http.Response, error) { +// @return ClientRegistrationResponse +func (a *DynamicClientRegistrationApiService) ClientRegistrationGetApiExecute(r ApiClientRegistrationGetApiRequest) (*ClientRegistrationResponse, *http.Response, error) { var ( localVarHTTPMethod = http.MethodPost localVarPostBody interface{} formFiles []formFile - localVarReturnValue *ClientRegistrationGetResponse + localVarReturnValue *ClientRegistrationResponse ) localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "DynamicClientRegistrationApiService.ClientRegistrationGetApi") @@ -1138,13 +1154,14 @@ func (a *DynamicClientRegistrationApiService) ClientRegistrationGetApiExecute(r return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/api/client/registration/get" + localVarPath := localBasePath + "/api/{serviceId}/client/registration/get" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := url.Values{} localVarFormParams := url.Values{} - if r.clientRegistrationGetRequest == nil { - return localVarReturnValue, nil, reportError("clientRegistrationGetRequest is required and must be specified") + if r.clientRegistrationRequest == nil { + return localVarReturnValue, nil, reportError("clientRegistrationRequest is required and must be specified") } // to determine the Content-Type header @@ -1165,7 +1182,7 @@ func (a *DynamicClientRegistrationApiService) ClientRegistrationGetApiExecute(r localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept } // body params - localVarPostBody = r.clientRegistrationGetRequest + localVarPostBody = r.clientRegistrationRequest req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) if err != nil { return localVarReturnValue, nil, err @@ -1249,6 +1266,7 @@ func (a *DynamicClientRegistrationApiService) ClientRegistrationGetApiExecute(r type ApiClientRegistrationUpdateApiRequest struct { ctx context.Context ApiService DynamicClientRegistrationApi + serviceId string clientRegistrationUpdateRequest *ClientRegistrationUpdateRequest } @@ -1262,7 +1280,7 @@ func (r ApiClientRegistrationUpdateApiRequest) Execute() (*ClientRegistrationUpd } /* -ClientRegistrationUpdateApi /api/client/registration/update API +ClientRegistrationUpdateApi /api/{serviceId}/client/registration/update API Update a dynamically registered client. This API is supposed to be used to implement a client registration management endpoint that complies with [RFC 7592](https://datatracker.ietf.org/doc/html/rfc7592) @@ -1377,12 +1395,14 @@ Pragma: no-cache @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiClientRegistrationUpdateApiRequest */ -func (a *DynamicClientRegistrationApiService) ClientRegistrationUpdateApi(ctx context.Context) ApiClientRegistrationUpdateApiRequest { +func (a *DynamicClientRegistrationApiService) ClientRegistrationUpdateApi(ctx context.Context, serviceId string) ApiClientRegistrationUpdateApiRequest { return ApiClientRegistrationUpdateApiRequest{ ApiService: a, ctx: ctx, + serviceId: serviceId, } } @@ -1401,7 +1421,8 @@ func (a *DynamicClientRegistrationApiService) ClientRegistrationUpdateApiExecute return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/api/client/registration/update" + localVarPath := localBasePath + "/api/{serviceId}/client/registration/update" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := url.Values{} diff --git a/api_federation_endpoint.go b/api_federation_endpoint.go index 75b4b39..bc723cb 100644 --- a/api_federation_endpoint.go +++ b/api_federation_endpoint.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. @@ -16,13 +16,14 @@ import ( "io/ioutil" "net/http" "net/url" + "strings" ) type FederationEndpointApi interface { /* - FederationConfigurationApi /api/federation/configuration API + FederationConfigurationApi /api/{serviceId}/federation/configuration API This API gathers the federation configuration about a service. @@ -109,16 +110,17 @@ Content-Type: application/entity-statement+jwt @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiFederationConfigurationApiRequest */ - FederationConfigurationApi(ctx context.Context) ApiFederationConfigurationApiRequest + FederationConfigurationApi(ctx context.Context, serviceId string) ApiFederationConfigurationApiRequest // FederationConfigurationApiExecute executes the request // @return FederationConfigurationResponse FederationConfigurationApiExecute(r ApiFederationConfigurationApiRequest) (*FederationConfigurationResponse, *http.Response, error) /* - FederationRegistrationApi /api/federation/registration API + FederationRegistrationApi /api/{serviceId}/federation/registration API The Authlete API is for implementations of the federation registration endpoint that accepts "explicit client registration". Its details are @@ -159,9 +161,10 @@ federation registration endpoint should call Authlete's @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiFederationRegistrationApiRequest */ - FederationRegistrationApi(ctx context.Context) ApiFederationRegistrationApiRequest + FederationRegistrationApi(ctx context.Context, serviceId string) ApiFederationRegistrationApiRequest // FederationRegistrationApiExecute executes the request // @return FederationRegistrationResponse @@ -174,6 +177,7 @@ type FederationEndpointApiService service type ApiFederationConfigurationApiRequest struct { ctx context.Context ApiService FederationEndpointApi + serviceId string body *map[string]interface{} } @@ -187,7 +191,7 @@ func (r ApiFederationConfigurationApiRequest) Execute() (*FederationConfiguratio } /* -FederationConfigurationApi /api/federation/configuration API +FederationConfigurationApi /api/{serviceId}/federation/configuration API This API gathers the federation configuration about a service. @@ -274,12 +278,14 @@ Content-Type: application/entity-statement+jwt @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiFederationConfigurationApiRequest */ -func (a *FederationEndpointApiService) FederationConfigurationApi(ctx context.Context) ApiFederationConfigurationApiRequest { +func (a *FederationEndpointApiService) FederationConfigurationApi(ctx context.Context, serviceId string) ApiFederationConfigurationApiRequest { return ApiFederationConfigurationApiRequest{ ApiService: a, ctx: ctx, + serviceId: serviceId, } } @@ -298,7 +304,8 @@ func (a *FederationEndpointApiService) FederationConfigurationApiExecute(r ApiFe return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/api/federation/configuration" + localVarPath := localBasePath + "/api/{serviceId}/federation/configuration" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := url.Values{} @@ -406,6 +413,7 @@ func (a *FederationEndpointApiService) FederationConfigurationApiExecute(r ApiFe type ApiFederationRegistrationApiRequest struct { ctx context.Context ApiService FederationEndpointApi + serviceId string federationRegistrationRequest *FederationRegistrationRequest } @@ -419,7 +427,7 @@ func (r ApiFederationRegistrationApiRequest) Execute() (*FederationRegistrationR } /* -FederationRegistrationApi /api/federation/registration API +FederationRegistrationApi /api/{serviceId}/federation/registration API The Authlete API is for implementations of the federation registration endpoint that accepts "explicit client registration". Its details are @@ -460,12 +468,14 @@ federation registration endpoint should call Authlete's @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiFederationRegistrationApiRequest */ -func (a *FederationEndpointApiService) FederationRegistrationApi(ctx context.Context) ApiFederationRegistrationApiRequest { +func (a *FederationEndpointApiService) FederationRegistrationApi(ctx context.Context, serviceId string) ApiFederationRegistrationApiRequest { return ApiFederationRegistrationApiRequest{ ApiService: a, ctx: ctx, + serviceId: serviceId, } } @@ -484,7 +494,8 @@ func (a *FederationEndpointApiService) FederationRegistrationApiExecute(r ApiFed return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/api/federation/registration" + localVarPath := localBasePath + "/api/{serviceId}/federation/registration" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := url.Values{} diff --git a/api_grant_management_endpoint.go b/api_grant_management_endpoint.go index 5ac9258..52d5ca4 100644 --- a/api_grant_management_endpoint.go +++ b/api_grant_management_endpoint.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. @@ -16,22 +16,24 @@ import ( "io/ioutil" "net/http" "net/url" + "strings" ) type GrantManagementEndpointApi interface { /* - GrantMApi /api/gm API + GrantMApi /api/{serviceId}/gm API The API is for the implementation of the grant management endpoint which is defined in "
Grant Management for OAuth 2.0". @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiGrantMApiRequest */ - GrantMApi(ctx context.Context) ApiGrantMApiRequest + GrantMApi(ctx context.Context, serviceId string) ApiGrantMApiRequest // GrantMApiExecute executes the request // @return GMResponse @@ -44,6 +46,7 @@ type GrantManagementEndpointApiService service type ApiGrantMApiRequest struct { ctx context.Context ApiService GrantManagementEndpointApi + serviceId string gMRequest *GMRequest } @@ -57,19 +60,21 @@ func (r ApiGrantMApiRequest) Execute() (*GMResponse, *http.Response, error) { } /* -GrantMApi /api/gm API +GrantMApi /api/{serviceId}/gm API The API is for the implementation of the grant management endpoint which is defined in "Grant Management for OAuth 2.0". @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiGrantMApiRequest */ -func (a *GrantManagementEndpointApiService) GrantMApi(ctx context.Context) ApiGrantMApiRequest { +func (a *GrantManagementEndpointApiService) GrantMApi(ctx context.Context, serviceId string) ApiGrantMApiRequest { return ApiGrantMApiRequest{ ApiService: a, ctx: ctx, + serviceId: serviceId, } } @@ -88,7 +93,8 @@ func (a *GrantManagementEndpointApiService) GrantMApiExecute(r ApiGrantMApiReque return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/api/gm" + localVarPath := localBasePath + "/api/{serviceId}/gm" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := url.Values{} diff --git a/api_hsk_operations.go b/api_hsk_operations.go index 7a07c8e..38eb8b6 100644 --- a/api_hsk_operations.go +++ b/api_hsk_operations.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. @@ -23,50 +23,54 @@ import ( type HskOperationsApi interface { /* - HskCreateApi /api/hsk/create API + HskCreateApi /api/{serviceId}/hsk/create API @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiHskCreateApiRequest */ - HskCreateApi(ctx context.Context) ApiHskCreateApiRequest + HskCreateApi(ctx context.Context, serviceId string) ApiHskCreateApiRequest // HskCreateApiExecute executes the request // @return HskCreateResponse HskCreateApiExecute(r ApiHskCreateApiRequest) (*HskCreateResponse, *http.Response, error) /* - HskDeleteApi /api/hsk/delete/{handle} API + HskDeleteApi /api/{serviceId}/hsk/delete/{handle} API @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @param handle @return ApiHskDeleteApiRequest */ - HskDeleteApi(ctx context.Context, handle string) ApiHskDeleteApiRequest + HskDeleteApi(ctx context.Context, serviceId string, handle string) ApiHskDeleteApiRequest // HskDeleteApiExecute executes the request // @return HskDeleteResponse HskDeleteApiExecute(r ApiHskDeleteApiRequest) (*HskDeleteResponse, *http.Response, error) /* - HskGetApi /api/hsk/get/{handle} API + HskGetApi /api/{serviceId}/hsk/get/{handle} API @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @param handle @return ApiHskGetApiRequest */ - HskGetApi(ctx context.Context, handle string) ApiHskGetApiRequest + HskGetApi(ctx context.Context, serviceId string, handle string) ApiHskGetApiRequest // HskGetApiExecute executes the request // @return HskGetResponse HskGetApiExecute(r ApiHskGetApiRequest) (*HskGetResponse, *http.Response, error) /* - HskGetListApi /api/hsk/get/list API + HskGetListApi /api/{serviceId}/hsk/get/list API @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiHskGetListApiRequest */ - HskGetListApi(ctx context.Context) ApiHskGetListApiRequest + HskGetListApi(ctx context.Context, serviceId string) ApiHskGetListApiRequest // HskGetListApiExecute executes the request // @return HskGetListResponse @@ -79,6 +83,7 @@ type HskOperationsApiService service type ApiHskCreateApiRequest struct { ctx context.Context ApiService HskOperationsApi + serviceId string hskCreateRequest *HskCreateRequest } @@ -92,15 +97,17 @@ func (r ApiHskCreateApiRequest) Execute() (*HskCreateResponse, *http.Response, e } /* -HskCreateApi /api/hsk/create API +HskCreateApi /api/{serviceId}/hsk/create API @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiHskCreateApiRequest */ -func (a *HskOperationsApiService) HskCreateApi(ctx context.Context) ApiHskCreateApiRequest { +func (a *HskOperationsApiService) HskCreateApi(ctx context.Context, serviceId string) ApiHskCreateApiRequest { return ApiHskCreateApiRequest{ ApiService: a, ctx: ctx, + serviceId: serviceId, } } @@ -119,7 +126,8 @@ func (a *HskOperationsApiService) HskCreateApiExecute(r ApiHskCreateApiRequest) return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/api/hsk/create" + localVarPath := localBasePath + "/api/{serviceId}/hsk/create" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := url.Values{} @@ -230,6 +238,7 @@ func (a *HskOperationsApiService) HskCreateApiExecute(r ApiHskCreateApiRequest) type ApiHskDeleteApiRequest struct { ctx context.Context ApiService HskOperationsApi + serviceId string handle string } @@ -238,16 +247,18 @@ func (r ApiHskDeleteApiRequest) Execute() (*HskDeleteResponse, *http.Response, e } /* -HskDeleteApi /api/hsk/delete/{handle} API +HskDeleteApi /api/{serviceId}/hsk/delete/{handle} API @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @param handle @return ApiHskDeleteApiRequest */ -func (a *HskOperationsApiService) HskDeleteApi(ctx context.Context, handle string) ApiHskDeleteApiRequest { +func (a *HskOperationsApiService) HskDeleteApi(ctx context.Context, serviceId string, handle string) ApiHskDeleteApiRequest { return ApiHskDeleteApiRequest{ ApiService: a, ctx: ctx, + serviceId: serviceId, handle: handle, } } @@ -267,7 +278,8 @@ func (a *HskOperationsApiService) HskDeleteApiExecute(r ApiHskDeleteApiRequest) return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/api/hsk/delete/{handle}" + localVarPath := localBasePath + "/api/{serviceId}/hsk/delete/{handle}" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) localVarPath = strings.Replace(localVarPath, "{"+"handle"+"}", url.PathEscape(parameterValueToString(r.handle, "handle")), -1) localVarHeaderParams := make(map[string]string) @@ -374,6 +386,7 @@ func (a *HskOperationsApiService) HskDeleteApiExecute(r ApiHskDeleteApiRequest) type ApiHskGetApiRequest struct { ctx context.Context ApiService HskOperationsApi + serviceId string handle string } @@ -382,16 +395,18 @@ func (r ApiHskGetApiRequest) Execute() (*HskGetResponse, *http.Response, error) } /* -HskGetApi /api/hsk/get/{handle} API +HskGetApi /api/{serviceId}/hsk/get/{handle} API @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @param handle @return ApiHskGetApiRequest */ -func (a *HskOperationsApiService) HskGetApi(ctx context.Context, handle string) ApiHskGetApiRequest { +func (a *HskOperationsApiService) HskGetApi(ctx context.Context, serviceId string, handle string) ApiHskGetApiRequest { return ApiHskGetApiRequest{ ApiService: a, ctx: ctx, + serviceId: serviceId, handle: handle, } } @@ -411,7 +426,8 @@ func (a *HskOperationsApiService) HskGetApiExecute(r ApiHskGetApiRequest) (*HskG return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/api/hsk/get/{handle}" + localVarPath := localBasePath + "/api/{serviceId}/hsk/get/{handle}" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) localVarPath = strings.Replace(localVarPath, "{"+"handle"+"}", url.PathEscape(parameterValueToString(r.handle, "handle")), -1) localVarHeaderParams := make(map[string]string) @@ -518,6 +534,7 @@ func (a *HskOperationsApiService) HskGetApiExecute(r ApiHskGetApiRequest) (*HskG type ApiHskGetListApiRequest struct { ctx context.Context ApiService HskOperationsApi + serviceId string } func (r ApiHskGetListApiRequest) Execute() (*HskGetListResponse, *http.Response, error) { @@ -525,15 +542,17 @@ func (r ApiHskGetListApiRequest) Execute() (*HskGetListResponse, *http.Response, } /* -HskGetListApi /api/hsk/get/list API +HskGetListApi /api/{serviceId}/hsk/get/list API @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiHskGetListApiRequest */ -func (a *HskOperationsApiService) HskGetListApi(ctx context.Context) ApiHskGetListApiRequest { +func (a *HskOperationsApiService) HskGetListApi(ctx context.Context, serviceId string) ApiHskGetListApiRequest { return ApiHskGetListApiRequest{ ApiService: a, ctx: ctx, + serviceId: serviceId, } } @@ -552,7 +571,8 @@ func (a *HskOperationsApiService) HskGetListApiExecute(r ApiHskGetListApiRequest return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/api/hsk/get/list" + localVarPath := localBasePath + "/api/{serviceId}/hsk/get/list" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := url.Values{} diff --git a/api_introspection_endpoint.go b/api_introspection_endpoint.go index d555590..4efc846 100644 --- a/api_introspection_endpoint.go +++ b/api_introspection_endpoint.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. @@ -16,13 +16,14 @@ import ( "io/ioutil" "net/http" "net/url" + "strings" ) type IntrospectionEndpointApi interface { /* - AuthIntrospectionApi /api/auth/introspection API + AuthIntrospectionApi /api/{serviceId}/auth/introspection API This API gathers information about an access token. @@ -192,16 +193,17 @@ may be different. @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiAuthIntrospectionApiRequest */ - AuthIntrospectionApi(ctx context.Context) ApiAuthIntrospectionApiRequest + AuthIntrospectionApi(ctx context.Context, serviceId string) ApiAuthIntrospectionApiRequest // AuthIntrospectionApiExecute executes the request // @return IntrospectionResponse AuthIntrospectionApiExecute(r ApiAuthIntrospectionApiRequest) (*IntrospectionResponse, *http.Response, error) /* - AuthIntrospectionStandardApi /api/auth/introspection/standard API + AuthIntrospectionStandardApi /api/{serviceId}/auth/introspection/standard API This API exists to help your authorization server provide its own introspection API which complies with [RFC 7662](https://tools.ietf.org/html/rfc7662) (OAuth 2.0 Token Introspection). @@ -301,9 +303,10 @@ request does not satisfy authorization requirements imposed by your introspectio @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiAuthIntrospectionStandardApiRequest */ - AuthIntrospectionStandardApi(ctx context.Context) ApiAuthIntrospectionStandardApiRequest + AuthIntrospectionStandardApi(ctx context.Context, serviceId string) ApiAuthIntrospectionStandardApiRequest // AuthIntrospectionStandardApiExecute executes the request // @return StandardIntrospectionResponse @@ -316,6 +319,7 @@ type IntrospectionEndpointApiService service type ApiAuthIntrospectionApiRequest struct { ctx context.Context ApiService IntrospectionEndpointApi + serviceId string introspectionRequest *IntrospectionRequest } @@ -329,7 +333,7 @@ func (r ApiAuthIntrospectionApiRequest) Execute() (*IntrospectionResponse, *http } /* -AuthIntrospectionApi /api/auth/introspection API +AuthIntrospectionApi /api/{serviceId}/auth/introspection API This API gathers information about an access token. @@ -499,12 +503,14 @@ may be different. @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiAuthIntrospectionApiRequest */ -func (a *IntrospectionEndpointApiService) AuthIntrospectionApi(ctx context.Context) ApiAuthIntrospectionApiRequest { +func (a *IntrospectionEndpointApiService) AuthIntrospectionApi(ctx context.Context, serviceId string) ApiAuthIntrospectionApiRequest { return ApiAuthIntrospectionApiRequest{ ApiService: a, ctx: ctx, + serviceId: serviceId, } } @@ -523,7 +529,8 @@ func (a *IntrospectionEndpointApiService) AuthIntrospectionApiExecute(r ApiAuthI return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/api/auth/introspection" + localVarPath := localBasePath + "/api/{serviceId}/auth/introspection" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := url.Values{} @@ -634,6 +641,7 @@ func (a *IntrospectionEndpointApiService) AuthIntrospectionApiExecute(r ApiAuthI type ApiAuthIntrospectionStandardApiRequest struct { ctx context.Context ApiService IntrospectionEndpointApi + serviceId string standardIntrospectionRequest *StandardIntrospectionRequest } @@ -647,7 +655,7 @@ func (r ApiAuthIntrospectionStandardApiRequest) Execute() (*StandardIntrospectio } /* -AuthIntrospectionStandardApi /api/auth/introspection/standard API +AuthIntrospectionStandardApi /api/{serviceId}/auth/introspection/standard API This API exists to help your authorization server provide its own introspection API which complies with [RFC 7662](https://tools.ietf.org/html/rfc7662) (OAuth 2.0 Token Introspection). @@ -747,12 +755,14 @@ request does not satisfy authorization requirements imposed by your introspectio @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiAuthIntrospectionStandardApiRequest */ -func (a *IntrospectionEndpointApiService) AuthIntrospectionStandardApi(ctx context.Context) ApiAuthIntrospectionStandardApiRequest { +func (a *IntrospectionEndpointApiService) AuthIntrospectionStandardApi(ctx context.Context, serviceId string) ApiAuthIntrospectionStandardApiRequest { return ApiAuthIntrospectionStandardApiRequest{ ApiService: a, ctx: ctx, + serviceId: serviceId, } } @@ -771,7 +781,8 @@ func (a *IntrospectionEndpointApiService) AuthIntrospectionStandardApiExecute(r return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/api/auth/introspection/standard" + localVarPath := localBasePath + "/api/{serviceId}/auth/introspection/standard" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := url.Values{} diff --git a/api_jose_object.go b/api_jose_object.go index 3a9af3b..c3f714f 100644 --- a/api_jose_object.go +++ b/api_jose_object.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. @@ -16,21 +16,23 @@ import ( "io/ioutil" "net/http" "net/url" + "strings" ) type JoseObjectApi interface { /* - JoseVerifyApi /api/jose/verify API + JoseVerifyApi /api/{serviceId}/jose/verify API This API verifies a JOSE object. @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiJoseVerifyApiRequest */ - JoseVerifyApi(ctx context.Context) ApiJoseVerifyApiRequest + JoseVerifyApi(ctx context.Context, serviceId string) ApiJoseVerifyApiRequest // JoseVerifyApiExecute executes the request // @return JoseVerifyResponse @@ -43,6 +45,7 @@ type JoseObjectApiService service type ApiJoseVerifyApiRequest struct { ctx context.Context ApiService JoseObjectApi + serviceId string joseVerifyRequest *JoseVerifyRequest } @@ -56,18 +59,20 @@ func (r ApiJoseVerifyApiRequest) Execute() (*JoseVerifyResponse, *http.Response, } /* -JoseVerifyApi /api/jose/verify API +JoseVerifyApi /api/{serviceId}/jose/verify API This API verifies a JOSE object. @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiJoseVerifyApiRequest */ -func (a *JoseObjectApiService) JoseVerifyApi(ctx context.Context) ApiJoseVerifyApiRequest { +func (a *JoseObjectApiService) JoseVerifyApi(ctx context.Context, serviceId string) ApiJoseVerifyApiRequest { return ApiJoseVerifyApiRequest{ ApiService: a, ctx: ctx, + serviceId: serviceId, } } @@ -86,7 +91,8 @@ func (a *JoseObjectApiService) JoseVerifyApiExecute(r ApiJoseVerifyApiRequest) ( return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/api/jose/verify" + localVarPath := localBasePath + "/api/{serviceId}/jose/verify" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := url.Values{} diff --git a/api_jwk_set_endpoint.go b/api_jwk_set_endpoint.go index 8a7a73f..b7475c2 100644 --- a/api_jwk_set_endpoint.go +++ b/api_jwk_set_endpoint.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. @@ -16,13 +16,14 @@ import ( "io/ioutil" "net/http" "net/url" + "strings" ) type JWKSetEndpointApi interface { /* - ServiceJwksGetApi /api/service/jwks/get API + ServiceJwksGetApi /api/{serviceId}/service/jwks/get API This API gathers JWK Set information for a service so that its client applications can verify signatures by the service and encrypt their requests to the service. @@ -41,9 +42,10 @@ if the service supports [OpenID Connect Discovery 1.0](https://openid.net/specs/ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiServiceJwksGetApiRequest */ - ServiceJwksGetApi(ctx context.Context) ApiServiceJwksGetApiRequest + ServiceJwksGetApi(ctx context.Context, serviceId string) ApiServiceJwksGetApiRequest // ServiceJwksGetApiExecute executes the request // @return ServiceJwksGetResponse @@ -56,6 +58,7 @@ type JWKSetEndpointApiService service type ApiServiceJwksGetApiRequest struct { ctx context.Context ApiService JWKSetEndpointApi + serviceId string includePrivateKeys *bool pretty *bool } @@ -77,7 +80,7 @@ func (r ApiServiceJwksGetApiRequest) Execute() (*ServiceJwksGetResponse, *http.R } /* -ServiceJwksGetApi /api/service/jwks/get API +ServiceJwksGetApi /api/{serviceId}/service/jwks/get API This API gathers JWK Set information for a service so that its client applications can verify signatures by the service and encrypt their requests to the service. @@ -96,12 +99,14 @@ if the service supports [OpenID Connect Discovery 1.0](https://openid.net/specs/ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiServiceJwksGetApiRequest */ -func (a *JWKSetEndpointApiService) ServiceJwksGetApi(ctx context.Context) ApiServiceJwksGetApiRequest { +func (a *JWKSetEndpointApiService) ServiceJwksGetApi(ctx context.Context, serviceId string) ApiServiceJwksGetApiRequest { return ApiServiceJwksGetApiRequest{ ApiService: a, ctx: ctx, + serviceId: serviceId, } } @@ -120,7 +125,8 @@ func (a *JWKSetEndpointApiService) ServiceJwksGetApiExecute(r ApiServiceJwksGetA return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/api/service/jwks/get" + localVarPath := localBasePath + "/api/{serviceId}/service/jwks/get" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := url.Values{} diff --git a/api_pushed_authorization_endpoint.go b/api_pushed_authorization_endpoint.go index 2eedeb6..43b04bb 100644 --- a/api_pushed_authorization_endpoint.go +++ b/api_pushed_authorization_endpoint.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. @@ -16,21 +16,23 @@ import ( "io/ioutil" "net/http" "net/url" + "strings" ) type PushedAuthorizationEndpointApi interface { /* - PushedAuthReqApi /api/pushed_auth_req API + PushedAuthReqApi /api/{serviceId}/pushed_auth_req API This API creates a pushed request authorization. It authenticates the client and creates a authorization_uri to be returned by the authorization server. @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiPushedAuthReqApiRequest */ - PushedAuthReqApi(ctx context.Context) ApiPushedAuthReqApiRequest + PushedAuthReqApi(ctx context.Context, serviceId string) ApiPushedAuthReqApiRequest // PushedAuthReqApiExecute executes the request // @return PushedAuthorizationResponse @@ -43,6 +45,7 @@ type PushedAuthorizationEndpointApiService service type ApiPushedAuthReqApiRequest struct { ctx context.Context ApiService PushedAuthorizationEndpointApi + serviceId string pushedAuthorizationRequest *PushedAuthorizationRequest } @@ -56,18 +59,20 @@ func (r ApiPushedAuthReqApiRequest) Execute() (*PushedAuthorizationResponse, *ht } /* -PushedAuthReqApi /api/pushed_auth_req API +PushedAuthReqApi /api/{serviceId}/pushed_auth_req API This API creates a pushed request authorization. It authenticates the client and creates a authorization_uri to be returned by the authorization server. @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiPushedAuthReqApiRequest */ -func (a *PushedAuthorizationEndpointApiService) PushedAuthReqApi(ctx context.Context) ApiPushedAuthReqApiRequest { +func (a *PushedAuthorizationEndpointApiService) PushedAuthReqApi(ctx context.Context, serviceId string) ApiPushedAuthReqApiRequest { return ApiPushedAuthReqApiRequest{ ApiService: a, ctx: ctx, + serviceId: serviceId, } } @@ -86,7 +91,8 @@ func (a *PushedAuthorizationEndpointApiService) PushedAuthReqApiExecute(r ApiPus return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/api/pushed_auth_req" + localVarPath := localBasePath + "/api/{serviceId}/pushed_auth_req" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := url.Values{} diff --git a/api_revocation_endpoint.go b/api_revocation_endpoint.go index 80dfabf..d5e7d01 100644 --- a/api_revocation_endpoint.go +++ b/api_revocation_endpoint.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. @@ -16,13 +16,14 @@ import ( "io/ioutil" "net/http" "net/url" + "strings" ) type RevocationEndpointApi interface { /* - AuthRevocationApi /api/auth/revocation API + AuthRevocationApi /api/{serviceId}/auth/revocation API This API revokes access tokens and refresh tokens. @@ -159,9 +160,10 @@ Pragma: no-cache @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiAuthRevocationApiRequest */ - AuthRevocationApi(ctx context.Context) ApiAuthRevocationApiRequest + AuthRevocationApi(ctx context.Context, serviceId string) ApiAuthRevocationApiRequest // AuthRevocationApiExecute executes the request // @return RevocationResponse @@ -174,6 +176,7 @@ type RevocationEndpointApiService service type ApiAuthRevocationApiRequest struct { ctx context.Context ApiService RevocationEndpointApi + serviceId string revocationRequest *RevocationRequest } @@ -187,7 +190,7 @@ func (r ApiAuthRevocationApiRequest) Execute() (*RevocationResponse, *http.Respo } /* -AuthRevocationApi /api/auth/revocation API +AuthRevocationApi /api/{serviceId}/auth/revocation API This API revokes access tokens and refresh tokens. @@ -324,12 +327,14 @@ Pragma: no-cache @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiAuthRevocationApiRequest */ -func (a *RevocationEndpointApiService) AuthRevocationApi(ctx context.Context) ApiAuthRevocationApiRequest { +func (a *RevocationEndpointApiService) AuthRevocationApi(ctx context.Context, serviceId string) ApiAuthRevocationApiRequest { return ApiAuthRevocationApiRequest{ ApiService: a, ctx: ctx, + serviceId: serviceId, } } @@ -348,7 +353,8 @@ func (a *RevocationEndpointApiService) AuthRevocationApiExecute(r ApiAuthRevocat return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/api/auth/revocation" + localVarPath := localBasePath + "/api/{serviceId}/auth/revocation" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := url.Values{} diff --git a/api_server_metadata.go b/api_server_metadata.go index 80db00d..d27cd40 100644 --- a/api_server_metadata.go +++ b/api_server_metadata.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/api_service_management.go b/api_service_management.go index ea29fcc..53a43eb 100644 --- a/api_service_management.go +++ b/api_service_management.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. @@ -38,41 +38,51 @@ type ServiceManagementApi interface { ServiceCreateApiExecute(r ApiServiceCreateApiRequest) (*Service, *http.Response, error) /* - ServiceDeleteApi /api/service/delete/{serviceApiKey} API + ServiceDeleteApi /api/{serviceId}/service/delete API Delete a service. @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - @param serviceApiKey The API key of the target service. + @param serviceId A service ID. @return ApiServiceDeleteApiRequest */ - ServiceDeleteApi(ctx context.Context, serviceApiKey string) ApiServiceDeleteApiRequest + ServiceDeleteApi(ctx context.Context, serviceId string) ApiServiceDeleteApiRequest // ServiceDeleteApiExecute executes the request ServiceDeleteApiExecute(r ApiServiceDeleteApiRequest) (*http.Response, error) /* - ServiceGetApi /api/service/get/{serviceApiKey} API + ServiceGetApi /api/{serviceId}/service/get API Get a service. +If the access token can only view or modify clients underneath this service, but does not +have access to view this service directly, a limited view of the service will be returned. + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - @param serviceApiKey The API key of a service. + @param serviceId A service ID. @return ApiServiceGetApiRequest */ - ServiceGetApi(ctx context.Context, serviceApiKey string) ApiServiceGetApiRequest + ServiceGetApi(ctx context.Context, serviceId string) ApiServiceGetApiRequest // ServiceGetApiExecute executes the request - // @return Service - ServiceGetApiExecute(r ApiServiceGetApiRequest) (*Service, *http.Response, error) + // @return ServiceGetApi200Response + ServiceGetApiExecute(r ApiServiceGetApiRequest) (*ServiceGetApi200Response, *http.Response, error) /* ServiceGetListApi /api/service/get/list API Get a list of services. +If the access token can only view or modify clients underneath a service, but does not +have access to view that service directly, a limited view of the service will be returned. +Otherwise, all properties of the service are returned. + +If the access token is an administrative token, this returns a list of all services on the Authlete instance. +Otherwise, all services that the access token can view, even in a limited fashion, are returned. + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return ApiServiceGetListApiRequest @@ -80,20 +90,20 @@ type ServiceManagementApi interface { ServiceGetListApi(ctx context.Context) ApiServiceGetListApiRequest // ServiceGetListApiExecute executes the request - // @return ServiceGetListResponse - ServiceGetListApiExecute(r ApiServiceGetListApiRequest) (*ServiceGetListResponse, *http.Response, error) + // @return ServiceGetListApi200Response + ServiceGetListApiExecute(r ApiServiceGetListApiRequest) (*ServiceGetListApi200Response, *http.Response, error) /* - ServiceUpdateApi /api/service/update/{serviceApiKey} API + ServiceUpdateApi /api/{serviceId}/service/update API Update a service. @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - @param serviceApiKey The API key of the target service. + @param serviceId A service ID. @return ApiServiceUpdateApiRequest */ - ServiceUpdateApi(ctx context.Context, serviceApiKey string) ApiServiceUpdateApiRequest + ServiceUpdateApi(ctx context.Context, serviceId string) ApiServiceUpdateApiRequest // ServiceUpdateApiExecute executes the request // @return Service @@ -257,7 +267,7 @@ func (a *ServiceManagementApiService) ServiceCreateApiExecute(r ApiServiceCreate type ApiServiceDeleteApiRequest struct { ctx context.Context ApiService ServiceManagementApi - serviceApiKey string + serviceId string } func (r ApiServiceDeleteApiRequest) Execute() (*http.Response, error) { @@ -265,20 +275,20 @@ func (r ApiServiceDeleteApiRequest) Execute() (*http.Response, error) { } /* -ServiceDeleteApi /api/service/delete/{serviceApiKey} API +ServiceDeleteApi /api/{serviceId}/service/delete API Delete a service. @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - @param serviceApiKey The API key of the target service. + @param serviceId A service ID. @return ApiServiceDeleteApiRequest */ -func (a *ServiceManagementApiService) ServiceDeleteApi(ctx context.Context, serviceApiKey string) ApiServiceDeleteApiRequest { +func (a *ServiceManagementApiService) ServiceDeleteApi(ctx context.Context, serviceId string) ApiServiceDeleteApiRequest { return ApiServiceDeleteApiRequest{ ApiService: a, ctx: ctx, - serviceApiKey: serviceApiKey, + serviceId: serviceId, } } @@ -295,8 +305,8 @@ func (a *ServiceManagementApiService) ServiceDeleteApiExecute(r ApiServiceDelete return nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/api/service/delete/{serviceApiKey}" - localVarPath = strings.Replace(localVarPath, "{"+"serviceApiKey"+"}", url.PathEscape(parameterValueToString(r.serviceApiKey, "serviceApiKey")), -1) + localVarPath := localBasePath + "/api/{serviceId}/service/delete" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := url.Values{} @@ -393,39 +403,42 @@ func (a *ServiceManagementApiService) ServiceDeleteApiExecute(r ApiServiceDelete type ApiServiceGetApiRequest struct { ctx context.Context ApiService ServiceManagementApi - serviceApiKey string + serviceId string } -func (r ApiServiceGetApiRequest) Execute() (*Service, *http.Response, error) { +func (r ApiServiceGetApiRequest) Execute() (*ServiceGetApi200Response, *http.Response, error) { return r.ApiService.ServiceGetApiExecute(r) } /* -ServiceGetApi /api/service/get/{serviceApiKey} API +ServiceGetApi /api/{serviceId}/service/get API Get a service. +If the access token can only view or modify clients underneath this service, but does not +have access to view this service directly, a limited view of the service will be returned. + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - @param serviceApiKey The API key of a service. + @param serviceId A service ID. @return ApiServiceGetApiRequest */ -func (a *ServiceManagementApiService) ServiceGetApi(ctx context.Context, serviceApiKey string) ApiServiceGetApiRequest { +func (a *ServiceManagementApiService) ServiceGetApi(ctx context.Context, serviceId string) ApiServiceGetApiRequest { return ApiServiceGetApiRequest{ ApiService: a, ctx: ctx, - serviceApiKey: serviceApiKey, + serviceId: serviceId, } } // Execute executes the request -// @return Service -func (a *ServiceManagementApiService) ServiceGetApiExecute(r ApiServiceGetApiRequest) (*Service, *http.Response, error) { +// @return ServiceGetApi200Response +func (a *ServiceManagementApiService) ServiceGetApiExecute(r ApiServiceGetApiRequest) (*ServiceGetApi200Response, *http.Response, error) { var ( localVarHTTPMethod = http.MethodGet localVarPostBody interface{} formFiles []formFile - localVarReturnValue *Service + localVarReturnValue *ServiceGetApi200Response ) localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "ServiceManagementApiService.ServiceGetApi") @@ -433,8 +446,8 @@ func (a *ServiceManagementApiService) ServiceGetApiExecute(r ApiServiceGetApiReq return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/api/service/get/{serviceApiKey}" - localVarPath = strings.Replace(localVarPath, "{"+"serviceApiKey"+"}", url.PathEscape(parameterValueToString(r.serviceApiKey, "serviceApiKey")), -1) + localVarPath := localBasePath + "/api/{serviceId}/service/get" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := url.Values{} @@ -556,7 +569,7 @@ func (r ApiServiceGetListApiRequest) End(end int32) ApiServiceGetListApiRequest return r } -func (r ApiServiceGetListApiRequest) Execute() (*ServiceGetListResponse, *http.Response, error) { +func (r ApiServiceGetListApiRequest) Execute() (*ServiceGetListApi200Response, *http.Response, error) { return r.ApiService.ServiceGetListApiExecute(r) } @@ -565,6 +578,13 @@ ServiceGetListApi /api/service/get/list API Get a list of services. +If the access token can only view or modify clients underneath a service, but does not +have access to view that service directly, a limited view of the service will be returned. +Otherwise, all properties of the service are returned. + +If the access token is an administrative token, this returns a list of all services on the Authlete instance. +Otherwise, all services that the access token can view, even in a limited fashion, are returned. + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return ApiServiceGetListApiRequest @@ -577,13 +597,13 @@ func (a *ServiceManagementApiService) ServiceGetListApi(ctx context.Context) Api } // Execute executes the request -// @return ServiceGetListResponse -func (a *ServiceManagementApiService) ServiceGetListApiExecute(r ApiServiceGetListApiRequest) (*ServiceGetListResponse, *http.Response, error) { +// @return ServiceGetListApi200Response +func (a *ServiceManagementApiService) ServiceGetListApiExecute(r ApiServiceGetListApiRequest) (*ServiceGetListApi200Response, *http.Response, error) { var ( localVarHTTPMethod = http.MethodGet localVarPostBody interface{} formFiles []formFile - localVarReturnValue *ServiceGetListResponse + localVarReturnValue *ServiceGetListApi200Response ) localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "ServiceManagementApiService.ServiceGetListApi") @@ -703,7 +723,7 @@ func (a *ServiceManagementApiService) ServiceGetListApiExecute(r ApiServiceGetLi type ApiServiceUpdateApiRequest struct { ctx context.Context ApiService ServiceManagementApi - serviceApiKey string + serviceId string service *Service } @@ -717,20 +737,20 @@ func (r ApiServiceUpdateApiRequest) Execute() (*Service, *http.Response, error) } /* -ServiceUpdateApi /api/service/update/{serviceApiKey} API +ServiceUpdateApi /api/{serviceId}/service/update API Update a service. @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - @param serviceApiKey The API key of the target service. + @param serviceId A service ID. @return ApiServiceUpdateApiRequest */ -func (a *ServiceManagementApiService) ServiceUpdateApi(ctx context.Context, serviceApiKey string) ApiServiceUpdateApiRequest { +func (a *ServiceManagementApiService) ServiceUpdateApi(ctx context.Context, serviceId string) ApiServiceUpdateApiRequest { return ApiServiceUpdateApiRequest{ ApiService: a, ctx: ctx, - serviceApiKey: serviceApiKey, + serviceId: serviceId, } } @@ -749,8 +769,8 @@ func (a *ServiceManagementApiService) ServiceUpdateApiExecute(r ApiServiceUpdate return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/api/service/update/{serviceApiKey}" - localVarPath = strings.Replace(localVarPath, "{"+"serviceApiKey"+"}", url.PathEscape(parameterValueToString(r.serviceApiKey, "serviceApiKey")), -1) + localVarPath := localBasePath + "/api/{serviceId}/service/update" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := url.Values{} diff --git a/api_token_endpoint.go b/api_token_endpoint.go index fd906fe..a014337 100644 --- a/api_token_endpoint.go +++ b/api_token_endpoint.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. @@ -16,13 +16,14 @@ import ( "io/ioutil" "net/http" "net/url" + "strings" ) type TokenEndpointApi interface { /* - AuthTokenApi /api/auth/token API + AuthTokenApi /api/{serviceId}/auth/token API This API parses request parameters of an authorization request and returns necessary data for the authorization server implementation to process the authorization request further. @@ -224,7 +225,7 @@ Pragma: no-cache {responseContent} ``` - + **TOKEN_EXCHANGE (Authlete 2.3 onwards)** When the value of `"action"` is `"TOKEN_EXCHANGE"`, it means @@ -255,7 +256,7 @@ request parameter according to their respective token types as shown below. **Token Validation Steps** -*Token Type: `urn:ietf:params:oauth:token-type:jwt`* +*Token Type: `urn:ietf:params:oauth:token-type:jwt`* 1. Confirm that the format conforms to the JWT specification [RFC 7519][https://www.rfc-editor.org/rfc/rfc7519.html]. 2. Check if the JWT is encrypted and if it is encrypted, then (a) reject @@ -465,21 +466,22 @@ Cache-Control: no-cache, no-store Finally, note again that Authlete does not verify the signature of the JWT specified by the `assertion` request parameter. You must verify the signature by yourself. - + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiAuthTokenApiRequest */ - AuthTokenApi(ctx context.Context) ApiAuthTokenApiRequest + AuthTokenApi(ctx context.Context, serviceId string) ApiAuthTokenApiRequest // AuthTokenApiExecute executes the request // @return TokenResponse AuthTokenApiExecute(r ApiAuthTokenApiRequest) (*TokenResponse, *http.Response, error) /* - AuthTokenFailApi /api/auth/token/fail API + AuthTokenFailApi /api/{serviceId}/auth/token/fail API This API generates a content of an error token response that the authorization server implementation returns to the client application. @@ -553,16 +555,17 @@ Pragma: no-cache @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiAuthTokenFailApiRequest */ - AuthTokenFailApi(ctx context.Context) ApiAuthTokenFailApiRequest + AuthTokenFailApi(ctx context.Context, serviceId string) ApiAuthTokenFailApiRequest // AuthTokenFailApiExecute executes the request // @return TokenFailResponse AuthTokenFailApiExecute(r ApiAuthTokenFailApiRequest) (*TokenFailResponse, *http.Response, error) /* - AuthTokenIssueApi /api/auth/token/issue API + AuthTokenIssueApi /api/{serviceId}/auth/token/issue API This API generates a content of a successful token response that the authorization server implementation returns to the client application. @@ -636,13 +639,35 @@ Pragma: no-cache @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiAuthTokenIssueApiRequest */ - AuthTokenIssueApi(ctx context.Context) ApiAuthTokenIssueApiRequest + AuthTokenIssueApi(ctx context.Context, serviceId string) ApiAuthTokenIssueApiRequest // AuthTokenIssueApiExecute executes the request // @return TokenIssueResponse AuthTokenIssueApiExecute(r ApiAuthTokenIssueApiRequest) (*TokenIssueResponse, *http.Response, error) + + /* + IdtokenReissueApi /api/{serviceId}/idtoken/reissue API + + The API is expected to be called only when the value of the `action` +parameter in a response from the `/auth/token` API is {@link +TokenResponse.Action#ID_TOKEN_REISSUABLE ID_TOKEN_REISSUABLE}. The purpose +of the `/idtoken/reissue` API is to generate a token response that +includes a new ID token together with a new access token and a refresh +token. + + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. + @return ApiIdtokenReissueApiRequest + */ + IdtokenReissueApi(ctx context.Context, serviceId string) ApiIdtokenReissueApiRequest + + // IdtokenReissueApiExecute executes the request + // @return IdtokenReissueResponse + IdtokenReissueApiExecute(r ApiIdtokenReissueApiRequest) (*IdtokenReissueResponse, *http.Response, error) } // TokenEndpointApiService TokenEndpointApi service @@ -651,6 +676,7 @@ type TokenEndpointApiService service type ApiAuthTokenApiRequest struct { ctx context.Context ApiService TokenEndpointApi + serviceId string tokenRequest *TokenRequest } @@ -664,7 +690,7 @@ func (r ApiAuthTokenApiRequest) Execute() (*TokenResponse, *http.Response, error } /* -AuthTokenApi /api/auth/token API +AuthTokenApi /api/{serviceId}/auth/token API This API parses request parameters of an authorization request and returns necessary data for the authorization server implementation to process the authorization request further. @@ -866,7 +892,7 @@ Pragma: no-cache {responseContent} ``` - + **TOKEN_EXCHANGE (Authlete 2.3 onwards)** When the value of `"action"` is `"TOKEN_EXCHANGE"`, it means @@ -897,7 +923,7 @@ request parameter according to their respective token types as shown below. **Token Validation Steps** -*Token Type: `urn:ietf:params:oauth:token-type:jwt`* +*Token Type: `urn:ietf:params:oauth:token-type:jwt`* 1. Confirm that the format conforms to the JWT specification [RFC 7519][https://www.rfc-editor.org/rfc/rfc7519.html]. 2. Check if the JWT is encrypted and if it is encrypted, then (a) reject @@ -1107,17 +1133,19 @@ Cache-Control: no-cache, no-store Finally, note again that Authlete does not verify the signature of the JWT specified by the `assertion` request parameter. You must verify the signature by yourself. - + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiAuthTokenApiRequest */ -func (a *TokenEndpointApiService) AuthTokenApi(ctx context.Context) ApiAuthTokenApiRequest { +func (a *TokenEndpointApiService) AuthTokenApi(ctx context.Context, serviceId string) ApiAuthTokenApiRequest { return ApiAuthTokenApiRequest{ ApiService: a, ctx: ctx, + serviceId: serviceId, } } @@ -1136,7 +1164,8 @@ func (a *TokenEndpointApiService) AuthTokenApiExecute(r ApiAuthTokenApiRequest) return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/api/auth/token" + localVarPath := localBasePath + "/api/{serviceId}/auth/token" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := url.Values{} @@ -1247,6 +1276,7 @@ func (a *TokenEndpointApiService) AuthTokenApiExecute(r ApiAuthTokenApiRequest) type ApiAuthTokenFailApiRequest struct { ctx context.Context ApiService TokenEndpointApi + serviceId string tokenFailRequest *TokenFailRequest } @@ -1260,7 +1290,7 @@ func (r ApiAuthTokenFailApiRequest) Execute() (*TokenFailResponse, *http.Respons } /* -AuthTokenFailApi /api/auth/token/fail API +AuthTokenFailApi /api/{serviceId}/auth/token/fail API This API generates a content of an error token response that the authorization server implementation returns to the client application. @@ -1334,12 +1364,14 @@ Pragma: no-cache @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiAuthTokenFailApiRequest */ -func (a *TokenEndpointApiService) AuthTokenFailApi(ctx context.Context) ApiAuthTokenFailApiRequest { +func (a *TokenEndpointApiService) AuthTokenFailApi(ctx context.Context, serviceId string) ApiAuthTokenFailApiRequest { return ApiAuthTokenFailApiRequest{ ApiService: a, ctx: ctx, + serviceId: serviceId, } } @@ -1358,7 +1390,8 @@ func (a *TokenEndpointApiService) AuthTokenFailApiExecute(r ApiAuthTokenFailApiR return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/api/auth/token/fail" + localVarPath := localBasePath + "/api/{serviceId}/auth/token/fail" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := url.Values{} @@ -1469,6 +1502,7 @@ func (a *TokenEndpointApiService) AuthTokenFailApiExecute(r ApiAuthTokenFailApiR type ApiAuthTokenIssueApiRequest struct { ctx context.Context ApiService TokenEndpointApi + serviceId string tokenIssueRequest *TokenIssueRequest } @@ -1482,7 +1516,7 @@ func (r ApiAuthTokenIssueApiRequest) Execute() (*TokenIssueResponse, *http.Respo } /* -AuthTokenIssueApi /api/auth/token/issue API +AuthTokenIssueApi /api/{serviceId}/auth/token/issue API This API generates a content of a successful token response that the authorization server implementation returns to the client application. @@ -1556,12 +1590,14 @@ Pragma: no-cache @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiAuthTokenIssueApiRequest */ -func (a *TokenEndpointApiService) AuthTokenIssueApi(ctx context.Context) ApiAuthTokenIssueApiRequest { +func (a *TokenEndpointApiService) AuthTokenIssueApi(ctx context.Context, serviceId string) ApiAuthTokenIssueApiRequest { return ApiAuthTokenIssueApiRequest{ ApiService: a, ctx: ctx, + serviceId: serviceId, } } @@ -1580,7 +1616,8 @@ func (a *TokenEndpointApiService) AuthTokenIssueApiExecute(r ApiAuthTokenIssueAp return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/api/auth/token/issue" + localVarPath := localBasePath + "/api/{serviceId}/auth/token/issue" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := url.Values{} @@ -1687,3 +1724,163 @@ func (a *TokenEndpointApiService) AuthTokenIssueApiExecute(r ApiAuthTokenIssueAp return localVarReturnValue, localVarHTTPResponse, nil } + +type ApiIdtokenReissueApiRequest struct { + ctx context.Context + ApiService TokenEndpointApi + serviceId string + idtokenReissueRequest *IdtokenReissueRequest +} + +func (r ApiIdtokenReissueApiRequest) IdtokenReissueRequest(idtokenReissueRequest IdtokenReissueRequest) ApiIdtokenReissueApiRequest { + r.idtokenReissueRequest = &idtokenReissueRequest + return r +} + +func (r ApiIdtokenReissueApiRequest) Execute() (*IdtokenReissueResponse, *http.Response, error) { + return r.ApiService.IdtokenReissueApiExecute(r) +} + +/* +IdtokenReissueApi /api/{serviceId}/idtoken/reissue API + +The API is expected to be called only when the value of the `action` +parameter in a response from the `/auth/token` API is {@link +TokenResponse.Action#ID_TOKEN_REISSUABLE ID_TOKEN_REISSUABLE}. The purpose +of the `/idtoken/reissue` API is to generate a token response that +includes a new ID token together with a new access token and a refresh +token. + + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. + @return ApiIdtokenReissueApiRequest +*/ +func (a *TokenEndpointApiService) IdtokenReissueApi(ctx context.Context, serviceId string) ApiIdtokenReissueApiRequest { + return ApiIdtokenReissueApiRequest{ + ApiService: a, + ctx: ctx, + serviceId: serviceId, + } +} + +// Execute executes the request +// @return IdtokenReissueResponse +func (a *TokenEndpointApiService) IdtokenReissueApiExecute(r ApiIdtokenReissueApiRequest) (*IdtokenReissueResponse, *http.Response, error) { + var ( + localVarHTTPMethod = http.MethodPost + localVarPostBody interface{} + formFiles []formFile + localVarReturnValue *IdtokenReissueResponse + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "TokenEndpointApiService.IdtokenReissueApi") + if err != nil { + return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/api/{serviceId}/idtoken/reissue" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + // body params + localVarPostBody = r.idtokenReissueRequest + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = ioutil.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 400 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} diff --git a/api_token_operations.go b/api_token_operations.go index 990d26c..20bdc7d 100644 --- a/api_token_operations.go +++ b/api_token_operations.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. @@ -23,75 +23,113 @@ import ( type TokenOperationsApi interface { /* - AuthTokenCreateApi /api/auth/token/create API + AuthTokenCreateApi /api/{serviceId}/auth/token/create API Create an access token. @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiAuthTokenCreateApiRequest */ - AuthTokenCreateApi(ctx context.Context) ApiAuthTokenCreateApiRequest + AuthTokenCreateApi(ctx context.Context, serviceId string) ApiAuthTokenCreateApiRequest // AuthTokenCreateApiExecute executes the request // @return TokenCreateResponse AuthTokenCreateApiExecute(r ApiAuthTokenCreateApiRequest) (*TokenCreateResponse, *http.Response, error) /* - AuthTokenDeleteApi /api/auth/token/delete API + AuthTokenCreateBatchApi /api/{serviceId}/auth/token/create/batch API + + Start a batch process to create multiple tokens. + + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. + @return ApiAuthTokenCreateBatchApiRequest + */ + AuthTokenCreateBatchApi(ctx context.Context, serviceId string) ApiAuthTokenCreateBatchApiRequest + + // AuthTokenCreateBatchApiExecute executes the request + // @return TokenCreateBatchResponse + AuthTokenCreateBatchApiExecute(r ApiAuthTokenCreateBatchApiRequest) (*TokenCreateBatchResponse, *http.Response, error) + + /* + AuthTokenCreateBatchStatusApi /api/{serviceId}/auth/token/create/batch/status/{requestId} API + + Retrieves the status of a batch token creation process specified by the given request Id. + + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. + @param requestId A request ID. + @return ApiAuthTokenCreateBatchStatusApiRequest + */ + AuthTokenCreateBatchStatusApi(ctx context.Context, serviceId string, requestId string) ApiAuthTokenCreateBatchStatusApiRequest + + // AuthTokenCreateBatchStatusApiExecute executes the request + // @return TokenCreateBatchStatusResponse + AuthTokenCreateBatchStatusApiExecute(r ApiAuthTokenCreateBatchStatusApiRequest) (*TokenCreateBatchStatusResponse, *http.Response, error) + + /* + AuthTokenDeleteApi /api/{serviceId}/auth/token/delete API Delete an access token. @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @param accessTokenIdentifier The identifier of an existing access token. The identifier is the value of the access token or the value of the hash of the access token. @return ApiAuthTokenDeleteApiRequest */ - AuthTokenDeleteApi(ctx context.Context, accessTokenIdentifier string) ApiAuthTokenDeleteApiRequest + AuthTokenDeleteApi(ctx context.Context, serviceId string, accessTokenIdentifier string) ApiAuthTokenDeleteApiRequest // AuthTokenDeleteApiExecute executes the request AuthTokenDeleteApiExecute(r ApiAuthTokenDeleteApiRequest) (*http.Response, error) /* - AuthTokenGetListApi /api/auth/token/get/list API + AuthTokenGetListApi /api/{serviceId}/auth/token/get/list API Get a list of client applications that an end-user has authorized. @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiAuthTokenGetListApiRequest */ - AuthTokenGetListApi(ctx context.Context) ApiAuthTokenGetListApiRequest + AuthTokenGetListApi(ctx context.Context, serviceId string) ApiAuthTokenGetListApiRequest // AuthTokenGetListApiExecute executes the request // @return TokenGetListResponse AuthTokenGetListApiExecute(r ApiAuthTokenGetListApiRequest) (*TokenGetListResponse, *http.Response, error) /* - AuthTokenRevokeApi /api/auth/token/revoke API + AuthTokenRevokeApi /api/{serviceId}/auth/token/revoke API Revoke an access token. @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiAuthTokenRevokeApiRequest */ - AuthTokenRevokeApi(ctx context.Context) ApiAuthTokenRevokeApiRequest + AuthTokenRevokeApi(ctx context.Context, serviceId string) ApiAuthTokenRevokeApiRequest // AuthTokenRevokeApiExecute executes the request // @return TokenRevokeResponse AuthTokenRevokeApiExecute(r ApiAuthTokenRevokeApiRequest) (*TokenRevokeResponse, *http.Response, error) /* - AuthTokenUpdateApi /api/auth/token/update API + AuthTokenUpdateApi /api/{serviceId}/auth/token/update API Update an access token. @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiAuthTokenUpdateApiRequest */ - AuthTokenUpdateApi(ctx context.Context) ApiAuthTokenUpdateApiRequest + AuthTokenUpdateApi(ctx context.Context, serviceId string) ApiAuthTokenUpdateApiRequest // AuthTokenUpdateApiExecute executes the request // @return TokenUpdateResponse @@ -104,6 +142,7 @@ type TokenOperationsApiService service type ApiAuthTokenCreateApiRequest struct { ctx context.Context ApiService TokenOperationsApi + serviceId string tokenCreateRequest *TokenCreateRequest } @@ -117,18 +156,20 @@ func (r ApiAuthTokenCreateApiRequest) Execute() (*TokenCreateResponse, *http.Res } /* -AuthTokenCreateApi /api/auth/token/create API +AuthTokenCreateApi /api/{serviceId}/auth/token/create API Create an access token. @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiAuthTokenCreateApiRequest */ -func (a *TokenOperationsApiService) AuthTokenCreateApi(ctx context.Context) ApiAuthTokenCreateApiRequest { +func (a *TokenOperationsApiService) AuthTokenCreateApi(ctx context.Context, serviceId string) ApiAuthTokenCreateApiRequest { return ApiAuthTokenCreateApiRequest{ ApiService: a, ctx: ctx, + serviceId: serviceId, } } @@ -147,7 +188,8 @@ func (a *TokenOperationsApiService) AuthTokenCreateApiExecute(r ApiAuthTokenCrea return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/api/auth/token/create" + localVarPath := localBasePath + "/api/{serviceId}/auth/token/create" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := url.Values{} @@ -255,9 +297,330 @@ func (a *TokenOperationsApiService) AuthTokenCreateApiExecute(r ApiAuthTokenCrea return localVarReturnValue, localVarHTTPResponse, nil } +type ApiAuthTokenCreateBatchApiRequest struct { + ctx context.Context + ApiService TokenOperationsApi + serviceId string + tokenCreateBatchRequestInner *[]TokenCreateBatchRequestInner +} + +func (r ApiAuthTokenCreateBatchApiRequest) TokenCreateBatchRequestInner(tokenCreateBatchRequestInner []TokenCreateBatchRequestInner) ApiAuthTokenCreateBatchApiRequest { + r.tokenCreateBatchRequestInner = &tokenCreateBatchRequestInner + return r +} + +func (r ApiAuthTokenCreateBatchApiRequest) Execute() (*TokenCreateBatchResponse, *http.Response, error) { + return r.ApiService.AuthTokenCreateBatchApiExecute(r) +} + +/* +AuthTokenCreateBatchApi /api/{serviceId}/auth/token/create/batch API + +Start a batch process to create multiple tokens. + + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. + @return ApiAuthTokenCreateBatchApiRequest +*/ +func (a *TokenOperationsApiService) AuthTokenCreateBatchApi(ctx context.Context, serviceId string) ApiAuthTokenCreateBatchApiRequest { + return ApiAuthTokenCreateBatchApiRequest{ + ApiService: a, + ctx: ctx, + serviceId: serviceId, + } +} + +// Execute executes the request +// @return TokenCreateBatchResponse +func (a *TokenOperationsApiService) AuthTokenCreateBatchApiExecute(r ApiAuthTokenCreateBatchApiRequest) (*TokenCreateBatchResponse, *http.Response, error) { + var ( + localVarHTTPMethod = http.MethodPost + localVarPostBody interface{} + formFiles []formFile + localVarReturnValue *TokenCreateBatchResponse + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "TokenOperationsApiService.AuthTokenCreateBatchApi") + if err != nil { + return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/api/{serviceId}/auth/token/create/batch" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + if r.tokenCreateBatchRequestInner == nil { + return localVarReturnValue, nil, reportError("tokenCreateBatchRequestInner is required and must be specified") + } + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + // body params + localVarPostBody = r.tokenCreateBatchRequestInner + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = ioutil.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 400 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type ApiAuthTokenCreateBatchStatusApiRequest struct { + ctx context.Context + ApiService TokenOperationsApi + serviceId string + requestId string +} + +func (r ApiAuthTokenCreateBatchStatusApiRequest) Execute() (*TokenCreateBatchStatusResponse, *http.Response, error) { + return r.ApiService.AuthTokenCreateBatchStatusApiExecute(r) +} + +/* +AuthTokenCreateBatchStatusApi /api/{serviceId}/auth/token/create/batch/status/{requestId} API + +Retrieves the status of a batch token creation process specified by the given request Id. + + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. + @param requestId A request ID. + @return ApiAuthTokenCreateBatchStatusApiRequest +*/ +func (a *TokenOperationsApiService) AuthTokenCreateBatchStatusApi(ctx context.Context, serviceId string, requestId string) ApiAuthTokenCreateBatchStatusApiRequest { + return ApiAuthTokenCreateBatchStatusApiRequest{ + ApiService: a, + ctx: ctx, + serviceId: serviceId, + requestId: requestId, + } +} + +// Execute executes the request +// @return TokenCreateBatchStatusResponse +func (a *TokenOperationsApiService) AuthTokenCreateBatchStatusApiExecute(r ApiAuthTokenCreateBatchStatusApiRequest) (*TokenCreateBatchStatusResponse, *http.Response, error) { + var ( + localVarHTTPMethod = http.MethodPost + localVarPostBody interface{} + formFiles []formFile + localVarReturnValue *TokenCreateBatchStatusResponse + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "TokenOperationsApiService.AuthTokenCreateBatchStatusApi") + if err != nil { + return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/api/{serviceId}/auth/token/create/batch/status/{requestId}" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"requestId"+"}", url.PathEscape(parameterValueToString(r.requestId, "requestId")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = ioutil.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 400 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 404 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + type ApiAuthTokenDeleteApiRequest struct { ctx context.Context ApiService TokenOperationsApi + serviceId string accessTokenIdentifier string } @@ -266,19 +629,21 @@ func (r ApiAuthTokenDeleteApiRequest) Execute() (*http.Response, error) { } /* -AuthTokenDeleteApi /api/auth/token/delete API +AuthTokenDeleteApi /api/{serviceId}/auth/token/delete API Delete an access token. @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @param accessTokenIdentifier The identifier of an existing access token. The identifier is the value of the access token or the value of the hash of the access token. @return ApiAuthTokenDeleteApiRequest */ -func (a *TokenOperationsApiService) AuthTokenDeleteApi(ctx context.Context, accessTokenIdentifier string) ApiAuthTokenDeleteApiRequest { +func (a *TokenOperationsApiService) AuthTokenDeleteApi(ctx context.Context, serviceId string, accessTokenIdentifier string) ApiAuthTokenDeleteApiRequest { return ApiAuthTokenDeleteApiRequest{ ApiService: a, ctx: ctx, + serviceId: serviceId, accessTokenIdentifier: accessTokenIdentifier, } } @@ -296,7 +661,8 @@ func (a *TokenOperationsApiService) AuthTokenDeleteApiExecute(r ApiAuthTokenDele return nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/api/auth/token/delete/{accessTokenIdentifier}" + localVarPath := localBasePath + "/api/{serviceId}/auth/token/delete/{accessTokenIdentifier}" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) localVarPath = strings.Replace(localVarPath, "{"+"accessTokenIdentifier"+"}", url.PathEscape(parameterValueToString(r.accessTokenIdentifier, "accessTokenIdentifier")), -1) localVarHeaderParams := make(map[string]string) @@ -394,6 +760,7 @@ func (a *TokenOperationsApiService) AuthTokenDeleteApiExecute(r ApiAuthTokenDele type ApiAuthTokenGetListApiRequest struct { ctx context.Context ApiService TokenOperationsApi + serviceId string clientIdentifier *string subject *string start *int32 @@ -429,18 +796,20 @@ func (r ApiAuthTokenGetListApiRequest) Execute() (*TokenGetListResponse, *http.R } /* -AuthTokenGetListApi /api/auth/token/get/list API +AuthTokenGetListApi /api/{serviceId}/auth/token/get/list API Get a list of client applications that an end-user has authorized. @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiAuthTokenGetListApiRequest */ -func (a *TokenOperationsApiService) AuthTokenGetListApi(ctx context.Context) ApiAuthTokenGetListApiRequest { +func (a *TokenOperationsApiService) AuthTokenGetListApi(ctx context.Context, serviceId string) ApiAuthTokenGetListApiRequest { return ApiAuthTokenGetListApiRequest{ ApiService: a, ctx: ctx, + serviceId: serviceId, } } @@ -459,7 +828,8 @@ func (a *TokenOperationsApiService) AuthTokenGetListApiExecute(r ApiAuthTokenGet return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/api/auth/token/get/list" + localVarPath := localBasePath + "/api/{serviceId}/auth/token/get/list" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := url.Values{} @@ -577,6 +947,7 @@ func (a *TokenOperationsApiService) AuthTokenGetListApiExecute(r ApiAuthTokenGet type ApiAuthTokenRevokeApiRequest struct { ctx context.Context ApiService TokenOperationsApi + serviceId string tokenRevokeRequest *TokenRevokeRequest } @@ -590,18 +961,20 @@ func (r ApiAuthTokenRevokeApiRequest) Execute() (*TokenRevokeResponse, *http.Res } /* -AuthTokenRevokeApi /api/auth/token/revoke API +AuthTokenRevokeApi /api/{serviceId}/auth/token/revoke API Revoke an access token. @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiAuthTokenRevokeApiRequest */ -func (a *TokenOperationsApiService) AuthTokenRevokeApi(ctx context.Context) ApiAuthTokenRevokeApiRequest { +func (a *TokenOperationsApiService) AuthTokenRevokeApi(ctx context.Context, serviceId string) ApiAuthTokenRevokeApiRequest { return ApiAuthTokenRevokeApiRequest{ ApiService: a, ctx: ctx, + serviceId: serviceId, } } @@ -620,7 +993,8 @@ func (a *TokenOperationsApiService) AuthTokenRevokeApiExecute(r ApiAuthTokenRevo return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/api/auth/token/revoke" + localVarPath := localBasePath + "/api/{serviceId}/auth/token/revoke" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := url.Values{} @@ -731,6 +1105,7 @@ func (a *TokenOperationsApiService) AuthTokenRevokeApiExecute(r ApiAuthTokenRevo type ApiAuthTokenUpdateApiRequest struct { ctx context.Context ApiService TokenOperationsApi + serviceId string tokenUpdateRequest *TokenUpdateRequest } @@ -744,18 +1119,20 @@ func (r ApiAuthTokenUpdateApiRequest) Execute() (*TokenUpdateResponse, *http.Res } /* -AuthTokenUpdateApi /api/auth/token/update API +AuthTokenUpdateApi /api/{serviceId}/auth/token/update API Update an access token. @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiAuthTokenUpdateApiRequest */ -func (a *TokenOperationsApiService) AuthTokenUpdateApi(ctx context.Context) ApiAuthTokenUpdateApiRequest { +func (a *TokenOperationsApiService) AuthTokenUpdateApi(ctx context.Context, serviceId string) ApiAuthTokenUpdateApiRequest { return ApiAuthTokenUpdateApiRequest{ ApiService: a, ctx: ctx, + serviceId: serviceId, } } @@ -774,7 +1151,8 @@ func (a *TokenOperationsApiService) AuthTokenUpdateApiExecute(r ApiAuthTokenUpda return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/api/auth/token/update" + localVarPath := localBasePath + "/api/{serviceId}/auth/token/update" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := url.Values{} diff --git a/api_user_info_endpoint.go b/api_user_info_endpoint.go index a697de1..72502d9 100644 --- a/api_user_info_endpoint.go +++ b/api_user_info_endpoint.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. @@ -16,13 +16,14 @@ import ( "io/ioutil" "net/http" "net/url" + "strings" ) type UserInfoEndpointApi interface { /* - AuthUserinfoApi /api/auth/userinfo API + AuthUserinfoApi /api/{serviceId}/auth/userinfo API This API gathers information about a user. @@ -168,16 +169,17 @@ Pragma: no-cache @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiAuthUserinfoApiRequest */ - AuthUserinfoApi(ctx context.Context) ApiAuthUserinfoApiRequest + AuthUserinfoApi(ctx context.Context, serviceId string) ApiAuthUserinfoApiRequest // AuthUserinfoApiExecute executes the request // @return UserinfoResponse AuthUserinfoApiExecute(r ApiAuthUserinfoApiRequest) (*UserinfoResponse, *http.Response, error) /* - AuthUserinfoIssueApi /api/auth/userinfo/issue API + AuthUserinfoIssueApi /api/{serviceId}/auth/userinfo/issue API This API generates an ID token. @@ -331,9 +333,10 @@ Content-Type: application/jwt @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiAuthUserinfoIssueApiRequest */ - AuthUserinfoIssueApi(ctx context.Context) ApiAuthUserinfoIssueApiRequest + AuthUserinfoIssueApi(ctx context.Context, serviceId string) ApiAuthUserinfoIssueApiRequest // AuthUserinfoIssueApiExecute executes the request // @return UserinfoIssueResponse @@ -346,6 +349,7 @@ type UserInfoEndpointApiService service type ApiAuthUserinfoApiRequest struct { ctx context.Context ApiService UserInfoEndpointApi + serviceId string userinfoRequest *UserinfoRequest } @@ -359,7 +363,7 @@ func (r ApiAuthUserinfoApiRequest) Execute() (*UserinfoResponse, *http.Response, } /* -AuthUserinfoApi /api/auth/userinfo API +AuthUserinfoApi /api/{serviceId}/auth/userinfo API This API gathers information about a user. @@ -505,12 +509,14 @@ Pragma: no-cache @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiAuthUserinfoApiRequest */ -func (a *UserInfoEndpointApiService) AuthUserinfoApi(ctx context.Context) ApiAuthUserinfoApiRequest { +func (a *UserInfoEndpointApiService) AuthUserinfoApi(ctx context.Context, serviceId string) ApiAuthUserinfoApiRequest { return ApiAuthUserinfoApiRequest{ ApiService: a, ctx: ctx, + serviceId: serviceId, } } @@ -529,7 +535,8 @@ func (a *UserInfoEndpointApiService) AuthUserinfoApiExecute(r ApiAuthUserinfoApi return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/api/auth/userinfo" + localVarPath := localBasePath + "/api/{serviceId}/auth/userinfo" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := url.Values{} @@ -640,6 +647,7 @@ func (a *UserInfoEndpointApiService) AuthUserinfoApiExecute(r ApiAuthUserinfoApi type ApiAuthUserinfoIssueApiRequest struct { ctx context.Context ApiService UserInfoEndpointApi + serviceId string userinfoIssueRequest *UserinfoIssueRequest } @@ -653,7 +661,7 @@ func (r ApiAuthUserinfoIssueApiRequest) Execute() (*UserinfoIssueResponse, *http } /* -AuthUserinfoIssueApi /api/auth/userinfo/issue API +AuthUserinfoIssueApi /api/{serviceId}/auth/userinfo/issue API This API generates an ID token. @@ -807,12 +815,14 @@ Content-Type: application/jwt @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. @return ApiAuthUserinfoIssueApiRequest */ -func (a *UserInfoEndpointApiService) AuthUserinfoIssueApi(ctx context.Context) ApiAuthUserinfoIssueApiRequest { +func (a *UserInfoEndpointApiService) AuthUserinfoIssueApi(ctx context.Context, serviceId string) ApiAuthUserinfoIssueApiRequest { return ApiAuthUserinfoIssueApiRequest{ ApiService: a, ctx: ctx, + serviceId: serviceId, } } @@ -831,7 +841,8 @@ func (a *UserInfoEndpointApiService) AuthUserinfoIssueApiExecute(r ApiAuthUserin return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/api/auth/userinfo/issue" + localVarPath := localBasePath + "/api/{serviceId}/auth/userinfo/issue" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := url.Values{} diff --git a/api_vci_endpoint.go b/api_vci_endpoint.go new file mode 100644 index 0000000..8086761 --- /dev/null +++ b/api_vci_endpoint.go @@ -0,0 +1,1875 @@ +/* +Authlete API + +Authlete API Document. + +API version: 3.0.0 +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package authlete + +import ( + "bytes" + "context" + "io/ioutil" + "net/http" + "net/url" + "strings" +) + + +type VciEndpointApi interface { + + /* + VciBatchIssueApi /api/{serviceId}/vci/batch/issue API + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. + @return ApiVciBatchIssueApiRequest + */ + VciBatchIssueApi(ctx context.Context, serviceId string) ApiVciBatchIssueApiRequest + + // VciBatchIssueApiExecute executes the request + // @return VciBatchIssueResponse + VciBatchIssueApiExecute(r ApiVciBatchIssueApiRequest) (*VciBatchIssueResponse, *http.Response, error) + + /* + VciBatchParseApi /api/{serviceId}/vci/batch/parse API + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. + @return ApiVciBatchParseApiRequest + */ + VciBatchParseApi(ctx context.Context, serviceId string) ApiVciBatchParseApiRequest + + // VciBatchParseApiExecute executes the request + // @return VciBatchParseResponse + VciBatchParseApiExecute(r ApiVciBatchParseApiRequest) (*VciBatchParseResponse, *http.Response, error) + + /* + VciDeferredIssueApi /api/{serviceId}/vci/deferred/issue API + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. + @return ApiVciDeferredIssueApiRequest + */ + VciDeferredIssueApi(ctx context.Context, serviceId string) ApiVciDeferredIssueApiRequest + + // VciDeferredIssueApiExecute executes the request + // @return VciDeferredIssueResponse + VciDeferredIssueApiExecute(r ApiVciDeferredIssueApiRequest) (*VciDeferredIssueResponse, *http.Response, error) + + /* + VciDeferredParseApi /api/{serviceId}/vci/deferred/parse API + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. + @return ApiVciDeferredParseApiRequest + */ + VciDeferredParseApi(ctx context.Context, serviceId string) ApiVciDeferredParseApiRequest + + // VciDeferredParseApiExecute executes the request + // @return VciDeferredParseResponse + VciDeferredParseApiExecute(r ApiVciDeferredParseApiRequest) (*VciDeferredParseResponse, *http.Response, error) + + /* + VciJwksApi /api/{serviceId}/vci/jwks API + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. + @return ApiVciJwksApiRequest + */ + VciJwksApi(ctx context.Context, serviceId string) ApiVciJwksApiRequest + + // VciJwksApiExecute executes the request + // @return VciJwksResponse + VciJwksApiExecute(r ApiVciJwksApiRequest) (*VciJwksResponse, *http.Response, error) + + /* + VciJwtissuerApi /api/{serviceId}/vci/jwtissuer API + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. + @return ApiVciJwtissuerApiRequest + */ + VciJwtissuerApi(ctx context.Context, serviceId string) ApiVciJwtissuerApiRequest + + // VciJwtissuerApiExecute executes the request + // @return VciJwtissuerResponse + VciJwtissuerApiExecute(r ApiVciJwtissuerApiRequest) (*VciJwtissuerResponse, *http.Response, error) + + /* + VciMetadataApi /api/{serviceId}/vci/metadata API + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. + @return ApiVciMetadataApiRequest + */ + VciMetadataApi(ctx context.Context, serviceId string) ApiVciMetadataApiRequest + + // VciMetadataApiExecute executes the request + // @return VciMetadataResponse + VciMetadataApiExecute(r ApiVciMetadataApiRequest) (*VciMetadataResponse, *http.Response, error) + + /* + VciOfferCreateApi /api/{serviceId}/vci/offer/create API + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. + @return ApiVciOfferCreateApiRequest + */ + VciOfferCreateApi(ctx context.Context, serviceId string) ApiVciOfferCreateApiRequest + + // VciOfferCreateApiExecute executes the request + // @return VciOfferCreateResponse + VciOfferCreateApiExecute(r ApiVciOfferCreateApiRequest) (*VciOfferCreateResponse, *http.Response, error) + + /* + VciOfferInfoApi /api/{serviceId}/vci/offer/info API + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. + @return ApiVciOfferInfoApiRequest + */ + VciOfferInfoApi(ctx context.Context, serviceId string) ApiVciOfferInfoApiRequest + + // VciOfferInfoApiExecute executes the request + // @return VciOfferInfoResponse + VciOfferInfoApiExecute(r ApiVciOfferInfoApiRequest) (*VciOfferInfoResponse, *http.Response, error) + + /* + VciSingleIssueApi /api/{serviceId}/vci/single/issue API + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. + @return ApiVciSingleIssueApiRequest + */ + VciSingleIssueApi(ctx context.Context, serviceId string) ApiVciSingleIssueApiRequest + + // VciSingleIssueApiExecute executes the request + // @return VciSingleIssueResponse + VciSingleIssueApiExecute(r ApiVciSingleIssueApiRequest) (*VciSingleIssueResponse, *http.Response, error) + + /* + VciSingleParseApi /api/{serviceId}/vci/single/parse API + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. + @return ApiVciSingleParseApiRequest + */ + VciSingleParseApi(ctx context.Context, serviceId string) ApiVciSingleParseApiRequest + + // VciSingleParseApiExecute executes the request + // @return VciSingleParseResponse + VciSingleParseApiExecute(r ApiVciSingleParseApiRequest) (*VciSingleParseResponse, *http.Response, error) +} + +// VciEndpointApiService VciEndpointApi service +type VciEndpointApiService service + +type ApiVciBatchIssueApiRequest struct { + ctx context.Context + ApiService VciEndpointApi + serviceId string + vciBatchIssueRequest *VciBatchIssueRequest +} + +func (r ApiVciBatchIssueApiRequest) VciBatchIssueRequest(vciBatchIssueRequest VciBatchIssueRequest) ApiVciBatchIssueApiRequest { + r.vciBatchIssueRequest = &vciBatchIssueRequest + return r +} + +func (r ApiVciBatchIssueApiRequest) Execute() (*VciBatchIssueResponse, *http.Response, error) { + return r.ApiService.VciBatchIssueApiExecute(r) +} + +/* +VciBatchIssueApi /api/{serviceId}/vci/batch/issue API + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. + @return ApiVciBatchIssueApiRequest +*/ +func (a *VciEndpointApiService) VciBatchIssueApi(ctx context.Context, serviceId string) ApiVciBatchIssueApiRequest { + return ApiVciBatchIssueApiRequest{ + ApiService: a, + ctx: ctx, + serviceId: serviceId, + } +} + +// Execute executes the request +// @return VciBatchIssueResponse +func (a *VciEndpointApiService) VciBatchIssueApiExecute(r ApiVciBatchIssueApiRequest) (*VciBatchIssueResponse, *http.Response, error) { + var ( + localVarHTTPMethod = http.MethodPost + localVarPostBody interface{} + formFiles []formFile + localVarReturnValue *VciBatchIssueResponse + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "VciEndpointApiService.VciBatchIssueApi") + if err != nil { + return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/api/{serviceId}/vci/batch/issue" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + if r.vciBatchIssueRequest == nil { + return localVarReturnValue, nil, reportError("vciBatchIssueRequest is required and must be specified") + } + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + // body params + localVarPostBody = r.vciBatchIssueRequest + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = ioutil.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 400 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type ApiVciBatchParseApiRequest struct { + ctx context.Context + ApiService VciEndpointApi + serviceId string + vciBatchParseRequest *VciBatchParseRequest +} + +func (r ApiVciBatchParseApiRequest) VciBatchParseRequest(vciBatchParseRequest VciBatchParseRequest) ApiVciBatchParseApiRequest { + r.vciBatchParseRequest = &vciBatchParseRequest + return r +} + +func (r ApiVciBatchParseApiRequest) Execute() (*VciBatchParseResponse, *http.Response, error) { + return r.ApiService.VciBatchParseApiExecute(r) +} + +/* +VciBatchParseApi /api/{serviceId}/vci/batch/parse API + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. + @return ApiVciBatchParseApiRequest +*/ +func (a *VciEndpointApiService) VciBatchParseApi(ctx context.Context, serviceId string) ApiVciBatchParseApiRequest { + return ApiVciBatchParseApiRequest{ + ApiService: a, + ctx: ctx, + serviceId: serviceId, + } +} + +// Execute executes the request +// @return VciBatchParseResponse +func (a *VciEndpointApiService) VciBatchParseApiExecute(r ApiVciBatchParseApiRequest) (*VciBatchParseResponse, *http.Response, error) { + var ( + localVarHTTPMethod = http.MethodPost + localVarPostBody interface{} + formFiles []formFile + localVarReturnValue *VciBatchParseResponse + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "VciEndpointApiService.VciBatchParseApi") + if err != nil { + return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/api/{serviceId}/vci/batch/parse" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + if r.vciBatchParseRequest == nil { + return localVarReturnValue, nil, reportError("vciBatchParseRequest is required and must be specified") + } + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json", "application/x-www-form-urlencoded"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + // body params + localVarPostBody = r.vciBatchParseRequest + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = ioutil.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 400 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type ApiVciDeferredIssueApiRequest struct { + ctx context.Context + ApiService VciEndpointApi + serviceId string + vciDeferredIssueRequest *VciDeferredIssueRequest +} + +func (r ApiVciDeferredIssueApiRequest) VciDeferredIssueRequest(vciDeferredIssueRequest VciDeferredIssueRequest) ApiVciDeferredIssueApiRequest { + r.vciDeferredIssueRequest = &vciDeferredIssueRequest + return r +} + +func (r ApiVciDeferredIssueApiRequest) Execute() (*VciDeferredIssueResponse, *http.Response, error) { + return r.ApiService.VciDeferredIssueApiExecute(r) +} + +/* +VciDeferredIssueApi /api/{serviceId}/vci/deferred/issue API + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. + @return ApiVciDeferredIssueApiRequest +*/ +func (a *VciEndpointApiService) VciDeferredIssueApi(ctx context.Context, serviceId string) ApiVciDeferredIssueApiRequest { + return ApiVciDeferredIssueApiRequest{ + ApiService: a, + ctx: ctx, + serviceId: serviceId, + } +} + +// Execute executes the request +// @return VciDeferredIssueResponse +func (a *VciEndpointApiService) VciDeferredIssueApiExecute(r ApiVciDeferredIssueApiRequest) (*VciDeferredIssueResponse, *http.Response, error) { + var ( + localVarHTTPMethod = http.MethodPost + localVarPostBody interface{} + formFiles []formFile + localVarReturnValue *VciDeferredIssueResponse + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "VciEndpointApiService.VciDeferredIssueApi") + if err != nil { + return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/api/{serviceId}/vci/deferred/issue" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + if r.vciDeferredIssueRequest == nil { + return localVarReturnValue, nil, reportError("vciDeferredIssueRequest is required and must be specified") + } + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + // body params + localVarPostBody = r.vciDeferredIssueRequest + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = ioutil.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 400 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type ApiVciDeferredParseApiRequest struct { + ctx context.Context + ApiService VciEndpointApi + serviceId string + vciDeferredParseRequest *VciDeferredParseRequest +} + +func (r ApiVciDeferredParseApiRequest) VciDeferredParseRequest(vciDeferredParseRequest VciDeferredParseRequest) ApiVciDeferredParseApiRequest { + r.vciDeferredParseRequest = &vciDeferredParseRequest + return r +} + +func (r ApiVciDeferredParseApiRequest) Execute() (*VciDeferredParseResponse, *http.Response, error) { + return r.ApiService.VciDeferredParseApiExecute(r) +} + +/* +VciDeferredParseApi /api/{serviceId}/vci/deferred/parse API + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. + @return ApiVciDeferredParseApiRequest +*/ +func (a *VciEndpointApiService) VciDeferredParseApi(ctx context.Context, serviceId string) ApiVciDeferredParseApiRequest { + return ApiVciDeferredParseApiRequest{ + ApiService: a, + ctx: ctx, + serviceId: serviceId, + } +} + +// Execute executes the request +// @return VciDeferredParseResponse +func (a *VciEndpointApiService) VciDeferredParseApiExecute(r ApiVciDeferredParseApiRequest) (*VciDeferredParseResponse, *http.Response, error) { + var ( + localVarHTTPMethod = http.MethodPost + localVarPostBody interface{} + formFiles []formFile + localVarReturnValue *VciDeferredParseResponse + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "VciEndpointApiService.VciDeferredParseApi") + if err != nil { + return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/api/{serviceId}/vci/deferred/parse" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + if r.vciDeferredParseRequest == nil { + return localVarReturnValue, nil, reportError("vciDeferredParseRequest is required and must be specified") + } + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json", "application/x-www-form-urlencoded"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + // body params + localVarPostBody = r.vciDeferredParseRequest + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = ioutil.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 400 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type ApiVciJwksApiRequest struct { + ctx context.Context + ApiService VciEndpointApi + serviceId string + vciJwksRequest *VciJwksRequest +} + +func (r ApiVciJwksApiRequest) VciJwksRequest(vciJwksRequest VciJwksRequest) ApiVciJwksApiRequest { + r.vciJwksRequest = &vciJwksRequest + return r +} + +func (r ApiVciJwksApiRequest) Execute() (*VciJwksResponse, *http.Response, error) { + return r.ApiService.VciJwksApiExecute(r) +} + +/* +VciJwksApi /api/{serviceId}/vci/jwks API + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. + @return ApiVciJwksApiRequest +*/ +func (a *VciEndpointApiService) VciJwksApi(ctx context.Context, serviceId string) ApiVciJwksApiRequest { + return ApiVciJwksApiRequest{ + ApiService: a, + ctx: ctx, + serviceId: serviceId, + } +} + +// Execute executes the request +// @return VciJwksResponse +func (a *VciEndpointApiService) VciJwksApiExecute(r ApiVciJwksApiRequest) (*VciJwksResponse, *http.Response, error) { + var ( + localVarHTTPMethod = http.MethodPost + localVarPostBody interface{} + formFiles []formFile + localVarReturnValue *VciJwksResponse + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "VciEndpointApiService.VciJwksApi") + if err != nil { + return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/api/{serviceId}/vci/jwks" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + if r.vciJwksRequest == nil { + return localVarReturnValue, nil, reportError("vciJwksRequest is required and must be specified") + } + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json", "application/x-www-form-urlencoded"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + // body params + localVarPostBody = r.vciJwksRequest + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = ioutil.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 400 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type ApiVciJwtissuerApiRequest struct { + ctx context.Context + ApiService VciEndpointApi + serviceId string + vciJwtissuerRequest *VciJwtissuerRequest +} + +func (r ApiVciJwtissuerApiRequest) VciJwtissuerRequest(vciJwtissuerRequest VciJwtissuerRequest) ApiVciJwtissuerApiRequest { + r.vciJwtissuerRequest = &vciJwtissuerRequest + return r +} + +func (r ApiVciJwtissuerApiRequest) Execute() (*VciJwtissuerResponse, *http.Response, error) { + return r.ApiService.VciJwtissuerApiExecute(r) +} + +/* +VciJwtissuerApi /api/{serviceId}/vci/jwtissuer API + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. + @return ApiVciJwtissuerApiRequest +*/ +func (a *VciEndpointApiService) VciJwtissuerApi(ctx context.Context, serviceId string) ApiVciJwtissuerApiRequest { + return ApiVciJwtissuerApiRequest{ + ApiService: a, + ctx: ctx, + serviceId: serviceId, + } +} + +// Execute executes the request +// @return VciJwtissuerResponse +func (a *VciEndpointApiService) VciJwtissuerApiExecute(r ApiVciJwtissuerApiRequest) (*VciJwtissuerResponse, *http.Response, error) { + var ( + localVarHTTPMethod = http.MethodPost + localVarPostBody interface{} + formFiles []formFile + localVarReturnValue *VciJwtissuerResponse + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "VciEndpointApiService.VciJwtissuerApi") + if err != nil { + return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/api/{serviceId}/vci/jwtissuer" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + if r.vciJwtissuerRequest == nil { + return localVarReturnValue, nil, reportError("vciJwtissuerRequest is required and must be specified") + } + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json", "application/x-www-form-urlencoded"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + // body params + localVarPostBody = r.vciJwtissuerRequest + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = ioutil.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 400 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type ApiVciMetadataApiRequest struct { + ctx context.Context + ApiService VciEndpointApi + serviceId string + vciMetadataRequest *VciMetadataRequest +} + +func (r ApiVciMetadataApiRequest) VciMetadataRequest(vciMetadataRequest VciMetadataRequest) ApiVciMetadataApiRequest { + r.vciMetadataRequest = &vciMetadataRequest + return r +} + +func (r ApiVciMetadataApiRequest) Execute() (*VciMetadataResponse, *http.Response, error) { + return r.ApiService.VciMetadataApiExecute(r) +} + +/* +VciMetadataApi /api/{serviceId}/vci/metadata API + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. + @return ApiVciMetadataApiRequest +*/ +func (a *VciEndpointApiService) VciMetadataApi(ctx context.Context, serviceId string) ApiVciMetadataApiRequest { + return ApiVciMetadataApiRequest{ + ApiService: a, + ctx: ctx, + serviceId: serviceId, + } +} + +// Execute executes the request +// @return VciMetadataResponse +func (a *VciEndpointApiService) VciMetadataApiExecute(r ApiVciMetadataApiRequest) (*VciMetadataResponse, *http.Response, error) { + var ( + localVarHTTPMethod = http.MethodPost + localVarPostBody interface{} + formFiles []formFile + localVarReturnValue *VciMetadataResponse + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "VciEndpointApiService.VciMetadataApi") + if err != nil { + return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/api/{serviceId}/vci/metadata" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + if r.vciMetadataRequest == nil { + return localVarReturnValue, nil, reportError("vciMetadataRequest is required and must be specified") + } + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json", "application/x-www-form-urlencoded"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + // body params + localVarPostBody = r.vciMetadataRequest + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = ioutil.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 400 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type ApiVciOfferCreateApiRequest struct { + ctx context.Context + ApiService VciEndpointApi + serviceId string + vciOfferCreateRequest *VciOfferCreateRequest +} + +func (r ApiVciOfferCreateApiRequest) VciOfferCreateRequest(vciOfferCreateRequest VciOfferCreateRequest) ApiVciOfferCreateApiRequest { + r.vciOfferCreateRequest = &vciOfferCreateRequest + return r +} + +func (r ApiVciOfferCreateApiRequest) Execute() (*VciOfferCreateResponse, *http.Response, error) { + return r.ApiService.VciOfferCreateApiExecute(r) +} + +/* +VciOfferCreateApi /api/{serviceId}/vci/offer/create API + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. + @return ApiVciOfferCreateApiRequest +*/ +func (a *VciEndpointApiService) VciOfferCreateApi(ctx context.Context, serviceId string) ApiVciOfferCreateApiRequest { + return ApiVciOfferCreateApiRequest{ + ApiService: a, + ctx: ctx, + serviceId: serviceId, + } +} + +// Execute executes the request +// @return VciOfferCreateResponse +func (a *VciEndpointApiService) VciOfferCreateApiExecute(r ApiVciOfferCreateApiRequest) (*VciOfferCreateResponse, *http.Response, error) { + var ( + localVarHTTPMethod = http.MethodPost + localVarPostBody interface{} + formFiles []formFile + localVarReturnValue *VciOfferCreateResponse + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "VciEndpointApiService.VciOfferCreateApi") + if err != nil { + return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/api/{serviceId}/vci/offer/create" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + if r.vciOfferCreateRequest == nil { + return localVarReturnValue, nil, reportError("vciOfferCreateRequest is required and must be specified") + } + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json", "application/x-www-form-urlencoded"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + // body params + localVarPostBody = r.vciOfferCreateRequest + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = ioutil.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 400 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type ApiVciOfferInfoApiRequest struct { + ctx context.Context + ApiService VciEndpointApi + serviceId string + vciOfferInfoRequest *VciOfferInfoRequest +} + +func (r ApiVciOfferInfoApiRequest) VciOfferInfoRequest(vciOfferInfoRequest VciOfferInfoRequest) ApiVciOfferInfoApiRequest { + r.vciOfferInfoRequest = &vciOfferInfoRequest + return r +} + +func (r ApiVciOfferInfoApiRequest) Execute() (*VciOfferInfoResponse, *http.Response, error) { + return r.ApiService.VciOfferInfoApiExecute(r) +} + +/* +VciOfferInfoApi /api/{serviceId}/vci/offer/info API + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. + @return ApiVciOfferInfoApiRequest +*/ +func (a *VciEndpointApiService) VciOfferInfoApi(ctx context.Context, serviceId string) ApiVciOfferInfoApiRequest { + return ApiVciOfferInfoApiRequest{ + ApiService: a, + ctx: ctx, + serviceId: serviceId, + } +} + +// Execute executes the request +// @return VciOfferInfoResponse +func (a *VciEndpointApiService) VciOfferInfoApiExecute(r ApiVciOfferInfoApiRequest) (*VciOfferInfoResponse, *http.Response, error) { + var ( + localVarHTTPMethod = http.MethodPost + localVarPostBody interface{} + formFiles []formFile + localVarReturnValue *VciOfferInfoResponse + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "VciEndpointApiService.VciOfferInfoApi") + if err != nil { + return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/api/{serviceId}/vci/offer/info" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + if r.vciOfferInfoRequest == nil { + return localVarReturnValue, nil, reportError("vciOfferInfoRequest is required and must be specified") + } + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json", "application/x-www-form-urlencoded"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + // body params + localVarPostBody = r.vciOfferInfoRequest + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = ioutil.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 400 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type ApiVciSingleIssueApiRequest struct { + ctx context.Context + ApiService VciEndpointApi + serviceId string + vciSingleIssueRequest *VciSingleIssueRequest +} + +func (r ApiVciSingleIssueApiRequest) VciSingleIssueRequest(vciSingleIssueRequest VciSingleIssueRequest) ApiVciSingleIssueApiRequest { + r.vciSingleIssueRequest = &vciSingleIssueRequest + return r +} + +func (r ApiVciSingleIssueApiRequest) Execute() (*VciSingleIssueResponse, *http.Response, error) { + return r.ApiService.VciSingleIssueApiExecute(r) +} + +/* +VciSingleIssueApi /api/{serviceId}/vci/single/issue API + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. + @return ApiVciSingleIssueApiRequest +*/ +func (a *VciEndpointApiService) VciSingleIssueApi(ctx context.Context, serviceId string) ApiVciSingleIssueApiRequest { + return ApiVciSingleIssueApiRequest{ + ApiService: a, + ctx: ctx, + serviceId: serviceId, + } +} + +// Execute executes the request +// @return VciSingleIssueResponse +func (a *VciEndpointApiService) VciSingleIssueApiExecute(r ApiVciSingleIssueApiRequest) (*VciSingleIssueResponse, *http.Response, error) { + var ( + localVarHTTPMethod = http.MethodPost + localVarPostBody interface{} + formFiles []formFile + localVarReturnValue *VciSingleIssueResponse + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "VciEndpointApiService.VciSingleIssueApi") + if err != nil { + return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/api/{serviceId}/vci/single/issue" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + if r.vciSingleIssueRequest == nil { + return localVarReturnValue, nil, reportError("vciSingleIssueRequest is required and must be specified") + } + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + // body params + localVarPostBody = r.vciSingleIssueRequest + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = ioutil.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 400 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type ApiVciSingleParseApiRequest struct { + ctx context.Context + ApiService VciEndpointApi + serviceId string + vciSingleParseRequest *VciSingleParseRequest +} + +func (r ApiVciSingleParseApiRequest) VciSingleParseRequest(vciSingleParseRequest VciSingleParseRequest) ApiVciSingleParseApiRequest { + r.vciSingleParseRequest = &vciSingleParseRequest + return r +} + +func (r ApiVciSingleParseApiRequest) Execute() (*VciSingleParseResponse, *http.Response, error) { + return r.ApiService.VciSingleParseApiExecute(r) +} + +/* +VciSingleParseApi /api/{serviceId}/vci/single/parse API + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param serviceId A service ID. + @return ApiVciSingleParseApiRequest +*/ +func (a *VciEndpointApiService) VciSingleParseApi(ctx context.Context, serviceId string) ApiVciSingleParseApiRequest { + return ApiVciSingleParseApiRequest{ + ApiService: a, + ctx: ctx, + serviceId: serviceId, + } +} + +// Execute executes the request +// @return VciSingleParseResponse +func (a *VciEndpointApiService) VciSingleParseApiExecute(r ApiVciSingleParseApiRequest) (*VciSingleParseResponse, *http.Response, error) { + var ( + localVarHTTPMethod = http.MethodPost + localVarPostBody interface{} + formFiles []formFile + localVarReturnValue *VciSingleParseResponse + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "VciEndpointApiService.VciSingleParseApi") + if err != nil { + return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/api/{serviceId}/vci/single/parse" + localVarPath = strings.Replace(localVarPath, "{"+"serviceId"+"}", url.PathEscape(parameterValueToString(r.serviceId, "serviceId")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + if r.vciSingleParseRequest == nil { + return localVarReturnValue, nil, reportError("vciSingleParseRequest is required and must be specified") + } + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json", "application/x-www-form-urlencoded"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + // body params + localVarPostBody = r.vciSingleParseRequest + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = ioutil.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 400 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v Result + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} diff --git a/client.go b/client.go index c1d5e59..b508f73 100644 --- a/client.go +++ b/client.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. @@ -42,7 +42,7 @@ var ( queryDescape = strings.NewReplacer( "%5B", "[", "%5D", "]" ) ) -// APIClient manages communication with the Authlete API API v2.3.12 +// APIClient manages communication with the Authlete API API v3.0.0 // In most cases there should be only one, shared, APIClient. type APIClient struct { cfg *Configuration @@ -72,8 +72,6 @@ type APIClient struct { HskOperationsApi HskOperationsApi - IDTokenEndpointApi IDTokenEndpointApi - IntrospectionEndpointApi IntrospectionEndpointApi JWKSetEndpointApi JWKSetEndpointApi @@ -93,6 +91,8 @@ type APIClient struct { TokenOperationsApi TokenOperationsApi UserInfoEndpointApi UserInfoEndpointApi + + VciEndpointApi VciEndpointApi } type service struct { @@ -122,7 +122,6 @@ func NewAPIClient(cfg *Configuration) *APIClient { c.FederationEndpointApi = (*FederationEndpointApiService)(&c.common) c.GrantManagementEndpointApi = (*GrantManagementEndpointApiService)(&c.common) c.HskOperationsApi = (*HskOperationsApiService)(&c.common) - c.IDTokenEndpointApi = (*IDTokenEndpointApiService)(&c.common) c.IntrospectionEndpointApi = (*IntrospectionEndpointApiService)(&c.common) c.JWKSetEndpointApi = (*JWKSetEndpointApiService)(&c.common) c.JoseObjectApi = (*JoseObjectApiService)(&c.common) @@ -133,6 +132,7 @@ func NewAPIClient(cfg *Configuration) *APIClient { c.TokenEndpointApi = (*TokenEndpointApiService)(&c.common) c.TokenOperationsApi = (*TokenOperationsApiService)(&c.common) c.UserInfoEndpointApi = (*UserInfoEndpointApiService)(&c.common) + c.VciEndpointApi = (*VciEndpointApiService)(&c.common) return c } @@ -473,9 +473,9 @@ func (c *APIClient) prepareRequest( // Walk through any authentication. - // Basic HTTP Authentication - if auth, ok := ctx.Value(ContextBasicAuth).(BasicAuth); ok { - localVarRequest.SetBasicAuth(auth.UserName, auth.Password) + // AccessToken Authentication + if auth, ok := ctx.Value(ContextAccessToken).(string); ok { + localVarRequest.Header.Add("Authorization", "Bearer "+auth) } } diff --git a/configuration.go b/configuration.go index 64d7568..dcc5abe 100644 --- a/configuration.go +++ b/configuration.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. @@ -28,8 +28,8 @@ func (c contextKey) String() string { } var ( - // ContextBasicAuth takes BasicAuth as authentication for the request. - ContextBasicAuth = contextKey("basic") + // ContextAccessToken takes a string oauth2 access token as authentication for the request. + ContextAccessToken = contextKey("accesstoken") // ContextServerIndex uses a server configuration from the index. ContextServerIndex = contextKey("serverIndex") @@ -89,12 +89,12 @@ type Configuration struct { func NewConfiguration() *Configuration { cfg := &Configuration{ DefaultHeader: make(map[string]string), - UserAgent: "OpenAPI-Generator/2.3/go", + UserAgent: "OpenAPI-Generator/3.0/go", Debug: false, Servers: ServerConfigurations{ { - URL: "https://api.authlete.com", - Description: "Shared production server.", + URL: "https://beta.authlete.com", + Description: "Beta Shared server.", }, }, OperationServers: map[string]ServerConfigurations{ diff --git a/docs/AuthorizationEndpointApi.md b/docs/AuthorizationEndpointApi.md index 35c0071..eaeeb39 100644 --- a/docs/AuthorizationEndpointApi.md +++ b/docs/AuthorizationEndpointApi.md @@ -1,20 +1,150 @@ # \AuthorizationEndpointApi -All URIs are relative to *https://api.authlete.com* +All URIs are relative to *https://beta.authlete.com* Method | HTTP request | Description ------------- | ------------- | ------------- -[**AuthAuthorizationApi**](AuthorizationEndpointApi.md#AuthAuthorizationApi) | **Post** /api/auth/authorization | /api/auth/authorization API -[**AuthAuthorizationFailApi**](AuthorizationEndpointApi.md#AuthAuthorizationFailApi) | **Post** /api/auth/authorization/fail | /api/auth/authorization/fail API -[**AuthAuthorizationIssueApi**](AuthorizationEndpointApi.md#AuthAuthorizationIssueApi) | **Post** /api/auth/authorization/issue | /api/auth/authorization/issue API +[**ApiServiceIdAuthAuthorizationTicketInfoGet**](AuthorizationEndpointApi.md#ApiServiceIdAuthAuthorizationTicketInfoGet) | **Get** /api/{serviceId}/auth/authorization/ticket/info | /api/{serviceId}/auth/authorization/ticket/info API +[**ApiServiceIdAuthAuthorizationTicketUpdatePost**](AuthorizationEndpointApi.md#ApiServiceIdAuthAuthorizationTicketUpdatePost) | **Post** /api/{serviceId}/auth/authorization/ticket/update | /api/{serviceId}/auth/authorization/ticket/update API +[**AuthAuthorizationApi**](AuthorizationEndpointApi.md#AuthAuthorizationApi) | **Post** /api/{serviceId}/auth/authorization | /api/{serviceId}/auth/authorization API +[**AuthAuthorizationFailApi**](AuthorizationEndpointApi.md#AuthAuthorizationFailApi) | **Post** /api/{serviceId}/auth/authorization/fail | /api/{serviceId}/auth/authorization/fail API +[**AuthAuthorizationIssueApi**](AuthorizationEndpointApi.md#AuthAuthorizationIssueApi) | **Post** /api/{serviceId}/auth/authorization/issue | /api/{serviceId}/auth/authorization/issue API +## ApiServiceIdAuthAuthorizationTicketInfoGet + +> AuthorizationTicketInfoResponse ApiServiceIdAuthAuthorizationTicketInfoGet(ctx).AuthorizationTicketInfoRequest(authorizationTicketInfoRequest).Execute() + +/api/{serviceId}/auth/authorization/ticket/info API + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "./openapi" +) + +func main() { + authorizationTicketInfoRequest := *openapiclient.NewAuthorizationTicketInfoRequest("Ticket_example") // AuthorizationTicketInfoRequest | + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.AuthorizationEndpointApi.ApiServiceIdAuthAuthorizationTicketInfoGet(context.Background()).AuthorizationTicketInfoRequest(authorizationTicketInfoRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AuthorizationEndpointApi.ApiServiceIdAuthAuthorizationTicketInfoGet``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ApiServiceIdAuthAuthorizationTicketInfoGet`: AuthorizationTicketInfoResponse + fmt.Fprintf(os.Stdout, "Response from `AuthorizationEndpointApi.ApiServiceIdAuthAuthorizationTicketInfoGet`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiApiServiceIdAuthAuthorizationTicketInfoGetRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **authorizationTicketInfoRequest** | [**AuthorizationTicketInfoRequest**](AuthorizationTicketInfoRequest.md) | | + +### Return type + +[**AuthorizationTicketInfoResponse**](AuthorizationTicketInfoResponse.md) + +### Authorization + +[UseService](../README.md#UseService) + +### HTTP request headers + +- **Content-Type**: application/json, application/x-www-form-urlencoded +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ApiServiceIdAuthAuthorizationTicketUpdatePost + +> AuthorizationTicketUpdateResponse ApiServiceIdAuthAuthorizationTicketUpdatePost(ctx).AuthorizationTicketUpdateRequest(authorizationTicketUpdateRequest).Execute() + +/api/{serviceId}/auth/authorization/ticket/update API + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "./openapi" +) + +func main() { + authorizationTicketUpdateRequest := *openapiclient.NewAuthorizationTicketUpdateRequest("Ticket_example", "Info_example") // AuthorizationTicketUpdateRequest | + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.AuthorizationEndpointApi.ApiServiceIdAuthAuthorizationTicketUpdatePost(context.Background()).AuthorizationTicketUpdateRequest(authorizationTicketUpdateRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AuthorizationEndpointApi.ApiServiceIdAuthAuthorizationTicketUpdatePost``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ApiServiceIdAuthAuthorizationTicketUpdatePost`: AuthorizationTicketUpdateResponse + fmt.Fprintf(os.Stdout, "Response from `AuthorizationEndpointApi.ApiServiceIdAuthAuthorizationTicketUpdatePost`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiApiServiceIdAuthAuthorizationTicketUpdatePostRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **authorizationTicketUpdateRequest** | [**AuthorizationTicketUpdateRequest**](AuthorizationTicketUpdateRequest.md) | | + +### Return type + +[**AuthorizationTicketUpdateResponse**](AuthorizationTicketUpdateResponse.md) + +### Authorization + +[UseService](../README.md#UseService) + +### HTTP request headers + +- **Content-Type**: application/json, application/x-www-form-urlencoded +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + ## AuthAuthorizationApi -> AuthorizationResponse AuthAuthorizationApi(ctx).AuthorizationRequest(authorizationRequest).Execute() +> AuthorizationResponse AuthAuthorizationApi(ctx, serviceId).AuthorizationRequest(authorizationRequest).Execute() -/api/auth/authorization API +/api/{serviceId}/auth/authorization API @@ -31,11 +161,12 @@ import ( ) func main() { + serviceId := "serviceId_example" // string | A service ID. authorizationRequest := *openapiclient.NewAuthorizationRequest("Parameters_example") // AuthorizationRequest | configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.AuthorizationEndpointApi.AuthAuthorizationApi(context.Background()).AuthorizationRequest(authorizationRequest).Execute() + resp, r, err := apiClient.AuthorizationEndpointApi.AuthAuthorizationApi(context.Background(), serviceId).AuthorizationRequest(authorizationRequest).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `AuthorizationEndpointApi.AuthAuthorizationApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -48,6 +179,10 @@ func main() { ### Path Parameters +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | ### Other Parameters @@ -56,6 +191,7 @@ Other parameters are passed through a pointer to a apiAuthAuthorizationApiReques Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **authorizationRequest** | [**AuthorizationRequest**](AuthorizationRequest.md) | | ### Return type @@ -64,7 +200,7 @@ Name | Type | Description | Notes ### Authorization -[ServiceCredentials](../README.md#ServiceCredentials) +[UseService](../README.md#UseService) ### HTTP request headers @@ -78,9 +214,9 @@ Name | Type | Description | Notes ## AuthAuthorizationFailApi -> AuthorizationFailResponse AuthAuthorizationFailApi(ctx).AuthorizationFailRequest(authorizationFailRequest).Execute() +> AuthorizationFailResponse AuthAuthorizationFailApi(ctx, serviceId).AuthorizationFailRequest(authorizationFailRequest).Execute() -/api/auth/authorization/fail API +/api/{serviceId}/auth/authorization/fail API @@ -97,11 +233,12 @@ import ( ) func main() { + serviceId := "serviceId_example" // string | A service ID. authorizationFailRequest := *openapiclient.NewAuthorizationFailRequest("Ticket_example", "Reason_example") // AuthorizationFailRequest | configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.AuthorizationEndpointApi.AuthAuthorizationFailApi(context.Background()).AuthorizationFailRequest(authorizationFailRequest).Execute() + resp, r, err := apiClient.AuthorizationEndpointApi.AuthAuthorizationFailApi(context.Background(), serviceId).AuthorizationFailRequest(authorizationFailRequest).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `AuthorizationEndpointApi.AuthAuthorizationFailApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -114,6 +251,10 @@ func main() { ### Path Parameters +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | ### Other Parameters @@ -122,6 +263,7 @@ Other parameters are passed through a pointer to a apiAuthAuthorizationFailApiRe Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **authorizationFailRequest** | [**AuthorizationFailRequest**](AuthorizationFailRequest.md) | | ### Return type @@ -130,7 +272,7 @@ Name | Type | Description | Notes ### Authorization -[ServiceCredentials](../README.md#ServiceCredentials) +[UseService](../README.md#UseService) ### HTTP request headers @@ -144,9 +286,9 @@ Name | Type | Description | Notes ## AuthAuthorizationIssueApi -> AuthorizationIssueResponse AuthAuthorizationIssueApi(ctx).AuthorizationIssueRequest(authorizationIssueRequest).Execute() +> AuthorizationIssueResponse AuthAuthorizationIssueApi(ctx, serviceId).AuthorizationIssueRequest(authorizationIssueRequest).Execute() -/api/auth/authorization/issue API +/api/{serviceId}/auth/authorization/issue API @@ -163,11 +305,12 @@ import ( ) func main() { + serviceId := "serviceId_example" // string | A service ID. authorizationIssueRequest := *openapiclient.NewAuthorizationIssueRequest("Ticket_example", "Subject_example") // AuthorizationIssueRequest | configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.AuthorizationEndpointApi.AuthAuthorizationIssueApi(context.Background()).AuthorizationIssueRequest(authorizationIssueRequest).Execute() + resp, r, err := apiClient.AuthorizationEndpointApi.AuthAuthorizationIssueApi(context.Background(), serviceId).AuthorizationIssueRequest(authorizationIssueRequest).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `AuthorizationEndpointApi.AuthAuthorizationIssueApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -180,6 +323,10 @@ func main() { ### Path Parameters +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | ### Other Parameters @@ -188,6 +335,7 @@ Other parameters are passed through a pointer to a apiAuthAuthorizationIssueApiR Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **authorizationIssueRequest** | [**AuthorizationIssueRequest**](AuthorizationIssueRequest.md) | | ### Return type @@ -196,7 +344,7 @@ Name | Type | Description | Notes ### Authorization -[ServiceCredentials](../README.md#ServiceCredentials) +[UseService](../README.md#UseService) ### HTTP request headers diff --git a/docs/AuthorizationIssueResponse.md b/docs/AuthorizationIssueResponse.md index e3336c0..3582b49 100644 --- a/docs/AuthorizationIssueResponse.md +++ b/docs/AuthorizationIssueResponse.md @@ -14,6 +14,7 @@ Name | Type | Description | Notes **IdToken** | Pointer to **string** | The newly issued ID token. Note that an ID token is issued from an authorization endpoint only when `response_type` contains `id_token`. | [optional] **AuthorizationCode** | Pointer to **string** | The newly issued authorization code. Note that an authorization code is issued only when `response_type` contains code. | [optional] **JwtAccessToken** | Pointer to **string** | The newly issued access token in JWT format. If the service is not configured to issue JWT-based access tokens, this property is always set to `null`. | [optional] +**TicketInfo** | Pointer to **string** | The information about the ticket. | [optional] ## Methods @@ -284,6 +285,31 @@ SetJwtAccessToken sets JwtAccessToken field to given value. HasJwtAccessToken returns a boolean if a field has been set. +### GetTicketInfo + +`func (o *AuthorizationIssueResponse) GetTicketInfo() string` + +GetTicketInfo returns the TicketInfo field if non-nil, zero value otherwise. + +### GetTicketInfoOk + +`func (o *AuthorizationIssueResponse) GetTicketInfoOk() (*string, bool)` + +GetTicketInfoOk returns a tuple with the TicketInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTicketInfo + +`func (o *AuthorizationIssueResponse) SetTicketInfo(v string)` + +SetTicketInfo sets TicketInfo field to given value. + +### HasTicketInfo + +`func (o *AuthorizationIssueResponse) HasTicketInfo() bool` + +HasTicketInfo returns a boolean if a field has been set. + [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/AuthorizationResponse.md b/docs/AuthorizationResponse.md index 8bf6849..48604c6 100644 --- a/docs/AuthorizationResponse.md +++ b/docs/AuthorizationResponse.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **ResultCode** | Pointer to **string** | The code which represents the result of the API call. | [optional] **ResultMessage** | Pointer to **string** | A short message which explains the result of the API call. | [optional] **Action** | Pointer to **string** | The next action that the authorization server implementation should take. | [optional] -**Client** | Pointer to [**Client**](Client.md) | | [optional] +**Client** | Pointer to [**ClientLimitedAuthorization**](ClientLimitedAuthorization.md) | | [optional] **Display** | Pointer to [**Display**](Display.md) | | [optional] **MaxAge** | Pointer to **int32** | The maximum authentication age. This value comes from `max_age` request parameter, or `defaultMaxAge` configuration parameter of the client application when the authorization request does not contain `max_age` request parameter. See \"[OpenID Connect Core 1.0, 3.1.2.1. Authentication Request](https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest), max_age\" for `max_age` request parameter, and see \"[OpenID Connect Dynamic Client Registration 1.0, 2. Client Metadata](https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata), default_max_age\" for `defaultMaxAge` configuration parameter. | [optional] **Service** | Pointer to [**Service**](Service.md) | | [optional] @@ -38,7 +38,10 @@ Name | Type | Description | Notes **RequestedClaimsForTx** | Pointer to **[]string** | Get names of claims that are requested indirectly by <i>\"transformed claims\"</i>. <p> A client application can request <i>\"transformed claims\"</i> by adding names of transformed claims in the `claims` request parameter. The following is an example of the `claims` request parameter that requests a predefined transformed claim named `18_or_over` and a transformed claim named `nationality_usa` to be embedded in the response from the userinfo endpoint. </p> ```json { \"transformed_claims\": { \"nationality_usa\": { \"claim\": \"nationalities\", \"fn\": [ [ \"eq\", \"USA\" ], \"any\" ] } }, \"userinfo\": { \"::18_or_over\": null, \":nationality_usa\": null } } ``` The example above assumes that a transformed claim named `18_or_over` is predefined by the authorization server like below. ```json { \"18_or_over\": { \"claim\": \"birthdate\", \"fn\": [ \"years_ago\", [ \"gte\", 18 ] ] } } ``` In the example, the `nationalities` claim is requested indirectly by the `nationality_usa` transformed claim. Likewise, the `birthdate` claim is requested indirectly by the `18_or_over` transformed claim. When the `claims` request parameter of an authorization request is like the example above, this `requestedClaimsForTx` property will hold the following value. ```json [ \"birthdate\", \"nationalities\" ] ``` It is expected that the authorization server implementation prepares values of the listed claims and passes them as the value of the `claimsForTx` request parameter when it calls the `/api/auth/userinfo/issue` API. The following is an example of the value of the `claimsForTx` request parameter. ```json { \"birthdate\": \"1970-01-23\", \"nationalities\": [ \"DEU\", \"USA\" ] } ``` | [optional] **RequestedVerifiedClaimsForTx** | Pointer to **[][]string** | Names of verified claims that will be referenced when transformed claims are computed. | [optional] **TransformedClaims** | Pointer to **string** | the value of the `transformed_claims` property in the `claims` request parameter of an authorization request or in the `claims` property in a request object. | [optional] -**ClientEntityIdUsed** | Pointer to **bool** | Flag which indicates whether the entity ID of the client was used when the request for the access token was made. | [optional] +**ClientEntityIdUsed** | Pointer to **bool** | Flag which indicates whether the entity ID of the client was used when the request for the access token was made. | [optional] +**ClaimsAtUserInfo** | Pointer to **[]string** | Get the list of claims that the client application requests to be embedded in userinfo responses. The value comes from the `\"scope\"` and `\"claims\"` request parameters of the original authorization request. | [optional] +**CredentialOfferInfo** | Pointer to [**CredentialOfferInfo**](CredentialOfferInfo.md) | | [optional] +**IssuableCredentials** | Pointer to **string** | Get the information about the <b>issuable credentials</b> that can be obtained by presenting the access token that will be issued as a result of the authorization request. | [optional] ## Methods @@ -136,20 +139,20 @@ HasAction returns a boolean if a field has been set. ### GetClient -`func (o *AuthorizationResponse) GetClient() Client` +`func (o *AuthorizationResponse) GetClient() ClientLimitedAuthorization` GetClient returns the Client field if non-nil, zero value otherwise. ### GetClientOk -`func (o *AuthorizationResponse) GetClientOk() (*Client, bool)` +`func (o *AuthorizationResponse) GetClientOk() (*ClientLimitedAuthorization, bool)` GetClientOk returns a tuple with the Client field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### SetClient -`func (o *AuthorizationResponse) SetClient(v Client)` +`func (o *AuthorizationResponse) SetClient(v ClientLimitedAuthorization)` SetClient sets Client field to given value. @@ -934,6 +937,81 @@ SetClientEntityIdUsed sets ClientEntityIdUsed field to given value. HasClientEntityIdUsed returns a boolean if a field has been set. +### GetClaimsAtUserInfo + +`func (o *AuthorizationResponse) GetClaimsAtUserInfo() []string` + +GetClaimsAtUserInfo returns the ClaimsAtUserInfo field if non-nil, zero value otherwise. + +### GetClaimsAtUserInfoOk + +`func (o *AuthorizationResponse) GetClaimsAtUserInfoOk() (*[]string, bool)` + +GetClaimsAtUserInfoOk returns a tuple with the ClaimsAtUserInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClaimsAtUserInfo + +`func (o *AuthorizationResponse) SetClaimsAtUserInfo(v []string)` + +SetClaimsAtUserInfo sets ClaimsAtUserInfo field to given value. + +### HasClaimsAtUserInfo + +`func (o *AuthorizationResponse) HasClaimsAtUserInfo() bool` + +HasClaimsAtUserInfo returns a boolean if a field has been set. + +### GetCredentialOfferInfo + +`func (o *AuthorizationResponse) GetCredentialOfferInfo() CredentialOfferInfo` + +GetCredentialOfferInfo returns the CredentialOfferInfo field if non-nil, zero value otherwise. + +### GetCredentialOfferInfoOk + +`func (o *AuthorizationResponse) GetCredentialOfferInfoOk() (*CredentialOfferInfo, bool)` + +GetCredentialOfferInfoOk returns a tuple with the CredentialOfferInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCredentialOfferInfo + +`func (o *AuthorizationResponse) SetCredentialOfferInfo(v CredentialOfferInfo)` + +SetCredentialOfferInfo sets CredentialOfferInfo field to given value. + +### HasCredentialOfferInfo + +`func (o *AuthorizationResponse) HasCredentialOfferInfo() bool` + +HasCredentialOfferInfo returns a boolean if a field has been set. + +### GetIssuableCredentials + +`func (o *AuthorizationResponse) GetIssuableCredentials() string` + +GetIssuableCredentials returns the IssuableCredentials field if non-nil, zero value otherwise. + +### GetIssuableCredentialsOk + +`func (o *AuthorizationResponse) GetIssuableCredentialsOk() (*string, bool)` + +GetIssuableCredentialsOk returns a tuple with the IssuableCredentials field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIssuableCredentials + +`func (o *AuthorizationResponse) SetIssuableCredentials(v string)` + +SetIssuableCredentials sets IssuableCredentials field to given value. + +### HasIssuableCredentials + +`func (o *AuthorizationResponse) HasIssuableCredentials() bool` + +HasIssuableCredentials returns a boolean if a field has been set. + [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/AuthorizationTicketInfoRequest.md b/docs/AuthorizationTicketInfoRequest.md new file mode 100644 index 0000000..57ecff9 --- /dev/null +++ b/docs/AuthorizationTicketInfoRequest.md @@ -0,0 +1,51 @@ +# AuthorizationTicketInfoRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Ticket** | **string** | The ticket that has been issued from the `/auth/authorization` API. | + +## Methods + +### NewAuthorizationTicketInfoRequest + +`func NewAuthorizationTicketInfoRequest(ticket string, ) *AuthorizationTicketInfoRequest` + +NewAuthorizationTicketInfoRequest instantiates a new AuthorizationTicketInfoRequest object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewAuthorizationTicketInfoRequestWithDefaults + +`func NewAuthorizationTicketInfoRequestWithDefaults() *AuthorizationTicketInfoRequest` + +NewAuthorizationTicketInfoRequestWithDefaults instantiates a new AuthorizationTicketInfoRequest object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetTicket + +`func (o *AuthorizationTicketInfoRequest) GetTicket() string` + +GetTicket returns the Ticket field if non-nil, zero value otherwise. + +### GetTicketOk + +`func (o *AuthorizationTicketInfoRequest) GetTicketOk() (*string, bool)` + +GetTicketOk returns a tuple with the Ticket field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTicket + +`func (o *AuthorizationTicketInfoRequest) SetTicket(v string)` + +SetTicket sets Ticket field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/AuthorizationTicketInfoResponse.md b/docs/AuthorizationTicketInfoResponse.md new file mode 100644 index 0000000..e7e9aa1 --- /dev/null +++ b/docs/AuthorizationTicketInfoResponse.md @@ -0,0 +1,134 @@ +# AuthorizationTicketInfoResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Info** | Pointer to **string** | Information about the ticket. | [optional] +**Action** | Pointer to **string** | The result of the `/auth/authorization/ticket/info` API call. | [optional] +**ResultCode** | Pointer to **string** | The code which represents the result of the API call. | [optional] +**ResultMessage** | Pointer to **string** | A short message which explains the result of the API call. | [optional] + +## Methods + +### NewAuthorizationTicketInfoResponse + +`func NewAuthorizationTicketInfoResponse() *AuthorizationTicketInfoResponse` + +NewAuthorizationTicketInfoResponse instantiates a new AuthorizationTicketInfoResponse object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewAuthorizationTicketInfoResponseWithDefaults + +`func NewAuthorizationTicketInfoResponseWithDefaults() *AuthorizationTicketInfoResponse` + +NewAuthorizationTicketInfoResponseWithDefaults instantiates a new AuthorizationTicketInfoResponse object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetInfo + +`func (o *AuthorizationTicketInfoResponse) GetInfo() string` + +GetInfo returns the Info field if non-nil, zero value otherwise. + +### GetInfoOk + +`func (o *AuthorizationTicketInfoResponse) GetInfoOk() (*string, bool)` + +GetInfoOk returns a tuple with the Info field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInfo + +`func (o *AuthorizationTicketInfoResponse) SetInfo(v string)` + +SetInfo sets Info field to given value. + +### HasInfo + +`func (o *AuthorizationTicketInfoResponse) HasInfo() bool` + +HasInfo returns a boolean if a field has been set. + +### GetAction + +`func (o *AuthorizationTicketInfoResponse) GetAction() string` + +GetAction returns the Action field if non-nil, zero value otherwise. + +### GetActionOk + +`func (o *AuthorizationTicketInfoResponse) GetActionOk() (*string, bool)` + +GetActionOk returns a tuple with the Action field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAction + +`func (o *AuthorizationTicketInfoResponse) SetAction(v string)` + +SetAction sets Action field to given value. + +### HasAction + +`func (o *AuthorizationTicketInfoResponse) HasAction() bool` + +HasAction returns a boolean if a field has been set. + +### GetResultCode + +`func (o *AuthorizationTicketInfoResponse) GetResultCode() string` + +GetResultCode returns the ResultCode field if non-nil, zero value otherwise. + +### GetResultCodeOk + +`func (o *AuthorizationTicketInfoResponse) GetResultCodeOk() (*string, bool)` + +GetResultCodeOk returns a tuple with the ResultCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResultCode + +`func (o *AuthorizationTicketInfoResponse) SetResultCode(v string)` + +SetResultCode sets ResultCode field to given value. + +### HasResultCode + +`func (o *AuthorizationTicketInfoResponse) HasResultCode() bool` + +HasResultCode returns a boolean if a field has been set. + +### GetResultMessage + +`func (o *AuthorizationTicketInfoResponse) GetResultMessage() string` + +GetResultMessage returns the ResultMessage field if non-nil, zero value otherwise. + +### GetResultMessageOk + +`func (o *AuthorizationTicketInfoResponse) GetResultMessageOk() (*string, bool)` + +GetResultMessageOk returns a tuple with the ResultMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResultMessage + +`func (o *AuthorizationTicketInfoResponse) SetResultMessage(v string)` + +SetResultMessage sets ResultMessage field to given value. + +### HasResultMessage + +`func (o *AuthorizationTicketInfoResponse) HasResultMessage() bool` + +HasResultMessage returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/AuthorizationTicketUpdateRequest.md b/docs/AuthorizationTicketUpdateRequest.md new file mode 100644 index 0000000..3ba444b --- /dev/null +++ b/docs/AuthorizationTicketUpdateRequest.md @@ -0,0 +1,72 @@ +# AuthorizationTicketUpdateRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Ticket** | **string** | The ticket. | +**Info** | **string** | The information about the ticket. | + +## Methods + +### NewAuthorizationTicketUpdateRequest + +`func NewAuthorizationTicketUpdateRequest(ticket string, info string, ) *AuthorizationTicketUpdateRequest` + +NewAuthorizationTicketUpdateRequest instantiates a new AuthorizationTicketUpdateRequest object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewAuthorizationTicketUpdateRequestWithDefaults + +`func NewAuthorizationTicketUpdateRequestWithDefaults() *AuthorizationTicketUpdateRequest` + +NewAuthorizationTicketUpdateRequestWithDefaults instantiates a new AuthorizationTicketUpdateRequest object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetTicket + +`func (o *AuthorizationTicketUpdateRequest) GetTicket() string` + +GetTicket returns the Ticket field if non-nil, zero value otherwise. + +### GetTicketOk + +`func (o *AuthorizationTicketUpdateRequest) GetTicketOk() (*string, bool)` + +GetTicketOk returns a tuple with the Ticket field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTicket + +`func (o *AuthorizationTicketUpdateRequest) SetTicket(v string)` + +SetTicket sets Ticket field to given value. + + +### GetInfo + +`func (o *AuthorizationTicketUpdateRequest) GetInfo() string` + +GetInfo returns the Info field if non-nil, zero value otherwise. + +### GetInfoOk + +`func (o *AuthorizationTicketUpdateRequest) GetInfoOk() (*string, bool)` + +GetInfoOk returns a tuple with the Info field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInfo + +`func (o *AuthorizationTicketUpdateRequest) SetInfo(v string)` + +SetInfo sets Info field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/AuthorizationTicketUpdateResponse.md b/docs/AuthorizationTicketUpdateResponse.md new file mode 100644 index 0000000..13942ad --- /dev/null +++ b/docs/AuthorizationTicketUpdateResponse.md @@ -0,0 +1,134 @@ +# AuthorizationTicketUpdateResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Info** | Pointer to **string** | Information about the ticket. | [optional] +**Action** | Pointer to **string** | The result of the /auth/authorization/ticket/info API call. | [optional] +**ResultCode** | Pointer to **string** | The code which represents the result of the API call. | [optional] +**ResultMessage** | Pointer to **string** | A short message which explains the result of the API call. | [optional] + +## Methods + +### NewAuthorizationTicketUpdateResponse + +`func NewAuthorizationTicketUpdateResponse() *AuthorizationTicketUpdateResponse` + +NewAuthorizationTicketUpdateResponse instantiates a new AuthorizationTicketUpdateResponse object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewAuthorizationTicketUpdateResponseWithDefaults + +`func NewAuthorizationTicketUpdateResponseWithDefaults() *AuthorizationTicketUpdateResponse` + +NewAuthorizationTicketUpdateResponseWithDefaults instantiates a new AuthorizationTicketUpdateResponse object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetInfo + +`func (o *AuthorizationTicketUpdateResponse) GetInfo() string` + +GetInfo returns the Info field if non-nil, zero value otherwise. + +### GetInfoOk + +`func (o *AuthorizationTicketUpdateResponse) GetInfoOk() (*string, bool)` + +GetInfoOk returns a tuple with the Info field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInfo + +`func (o *AuthorizationTicketUpdateResponse) SetInfo(v string)` + +SetInfo sets Info field to given value. + +### HasInfo + +`func (o *AuthorizationTicketUpdateResponse) HasInfo() bool` + +HasInfo returns a boolean if a field has been set. + +### GetAction + +`func (o *AuthorizationTicketUpdateResponse) GetAction() string` + +GetAction returns the Action field if non-nil, zero value otherwise. + +### GetActionOk + +`func (o *AuthorizationTicketUpdateResponse) GetActionOk() (*string, bool)` + +GetActionOk returns a tuple with the Action field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAction + +`func (o *AuthorizationTicketUpdateResponse) SetAction(v string)` + +SetAction sets Action field to given value. + +### HasAction + +`func (o *AuthorizationTicketUpdateResponse) HasAction() bool` + +HasAction returns a boolean if a field has been set. + +### GetResultCode + +`func (o *AuthorizationTicketUpdateResponse) GetResultCode() string` + +GetResultCode returns the ResultCode field if non-nil, zero value otherwise. + +### GetResultCodeOk + +`func (o *AuthorizationTicketUpdateResponse) GetResultCodeOk() (*string, bool)` + +GetResultCodeOk returns a tuple with the ResultCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResultCode + +`func (o *AuthorizationTicketUpdateResponse) SetResultCode(v string)` + +SetResultCode sets ResultCode field to given value. + +### HasResultCode + +`func (o *AuthorizationTicketUpdateResponse) HasResultCode() bool` + +HasResultCode returns a boolean if a field has been set. + +### GetResultMessage + +`func (o *AuthorizationTicketUpdateResponse) GetResultMessage() string` + +GetResultMessage returns the ResultMessage field if non-nil, zero value otherwise. + +### GetResultMessageOk + +`func (o *AuthorizationTicketUpdateResponse) GetResultMessageOk() (*string, bool)` + +GetResultMessageOk returns a tuple with the ResultMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResultMessage + +`func (o *AuthorizationTicketUpdateResponse) SetResultMessage(v string)` + +SetResultMessage sets ResultMessage field to given value. + +### HasResultMessage + +`func (o *AuthorizationTicketUpdateResponse) HasResultMessage() bool` + +HasResultMessage returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/BackchannelAuthenticationResponse.md b/docs/BackchannelAuthenticationResponse.md index d0987b7..8a5f636 100644 --- a/docs/BackchannelAuthenticationResponse.md +++ b/docs/BackchannelAuthenticationResponse.md @@ -32,6 +32,7 @@ Name | Type | Description | Notes **ClientAttributes** | Pointer to [**[]Pair**](Pair.md) | The attributes of the client. | [optional] **DynamicScopes** | Pointer to [**[]DynamicScope**](DynamicScope.md) | The dynamic scopes which the client application requested by the scope request parameter. | [optional] **DeliveryMode** | Pointer to [**DeliveryMode**](DeliveryMode.md) | | [optional] +**ClientAuthMethod** | Pointer to **string** | The client authentication method that was performed. | [optional] **GmAction** | Pointer to [**GrantManagementAction**](GrantManagementAction.md) | | [optional] **GrantId** | Pointer to **string** | the value of the `grant_id` request parameter of the device authorization request. The `grant_id` request parameter is defined in [Grant Management for OAuth 2.0](https://openid.net/specs/fapi-grant-management.html) , which is supported by Authlete 2.3 and newer versions. | [optional] **Grant** | Pointer to [**Grant**](Grant.md) | | [optional] @@ -758,6 +759,31 @@ SetDeliveryMode sets DeliveryMode field to given value. HasDeliveryMode returns a boolean if a field has been set. +### GetClientAuthMethod + +`func (o *BackchannelAuthenticationResponse) GetClientAuthMethod() string` + +GetClientAuthMethod returns the ClientAuthMethod field if non-nil, zero value otherwise. + +### GetClientAuthMethodOk + +`func (o *BackchannelAuthenticationResponse) GetClientAuthMethodOk() (*string, bool)` + +GetClientAuthMethodOk returns a tuple with the ClientAuthMethod field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientAuthMethod + +`func (o *BackchannelAuthenticationResponse) SetClientAuthMethod(v string)` + +SetClientAuthMethod sets ClientAuthMethod field to given value. + +### HasClientAuthMethod + +`func (o *BackchannelAuthenticationResponse) HasClientAuthMethod() bool` + +HasClientAuthMethod returns a boolean if a field has been set. + ### GetGmAction `func (o *BackchannelAuthenticationResponse) GetGmAction() GrantManagementAction` diff --git a/docs/CIBAApi.md b/docs/CIBAApi.md index c43d585..44fb277 100644 --- a/docs/CIBAApi.md +++ b/docs/CIBAApi.md @@ -1,21 +1,21 @@ # \CIBAApi -All URIs are relative to *https://api.authlete.com* +All URIs are relative to *https://beta.authlete.com* Method | HTTP request | Description ------------- | ------------- | ------------- -[**BackchannelAuthenticationApi**](CIBAApi.md#BackchannelAuthenticationApi) | **Post** /api/backchannel/authentication | /api/backchannel/authentication API -[**BackchannelAuthenticationCompleteApi**](CIBAApi.md#BackchannelAuthenticationCompleteApi) | **Post** /api/backchannel/authentication/complete | /api/backchannel/authentication/complete API -[**BackchannelAuthenticationFailApi**](CIBAApi.md#BackchannelAuthenticationFailApi) | **Post** /api/backchannel/authentication/fail | /api/backchannel/authentication/fail API -[**BackchannelAuthenticationIssueApi**](CIBAApi.md#BackchannelAuthenticationIssueApi) | **Post** /api/backchannel/authentication/issue | /api/backchannel/authentication/issue API +[**BackchannelAuthenticationApi**](CIBAApi.md#BackchannelAuthenticationApi) | **Post** /api/{serviceId}/backchannel/authentication | /api/{serviceId}/backchannel/authentication API +[**BackchannelAuthenticationCompleteApi**](CIBAApi.md#BackchannelAuthenticationCompleteApi) | **Post** /api/{serviceId}/backchannel/authentication/complete | /api/{serviceId}/backchannel/authentication/complete API +[**BackchannelAuthenticationFailApi**](CIBAApi.md#BackchannelAuthenticationFailApi) | **Post** /api/{serviceId}/backchannel/authentication/fail | /api/{serviceId}/backchannel/authentication/fail API +[**BackchannelAuthenticationIssueApi**](CIBAApi.md#BackchannelAuthenticationIssueApi) | **Post** /api/{serviceId}/backchannel/authentication/issue | /api/{serviceId}/backchannel/authentication/issue API ## BackchannelAuthenticationApi -> BackchannelAuthenticationResponse BackchannelAuthenticationApi(ctx).BackchannelAuthenticationRequest(backchannelAuthenticationRequest).Execute() +> BackchannelAuthenticationResponse BackchannelAuthenticationApi(ctx, serviceId).BackchannelAuthenticationRequest(backchannelAuthenticationRequest).Execute() -/api/backchannel/authentication API +/api/{serviceId}/backchannel/authentication API @@ -32,11 +32,12 @@ import ( ) func main() { + serviceId := "serviceId_example" // string | A service ID. backchannelAuthenticationRequest := *openapiclient.NewBackchannelAuthenticationRequest("Parameters_example") // BackchannelAuthenticationRequest | configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.CIBAApi.BackchannelAuthenticationApi(context.Background()).BackchannelAuthenticationRequest(backchannelAuthenticationRequest).Execute() + resp, r, err := apiClient.CIBAApi.BackchannelAuthenticationApi(context.Background(), serviceId).BackchannelAuthenticationRequest(backchannelAuthenticationRequest).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `CIBAApi.BackchannelAuthenticationApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -49,6 +50,10 @@ func main() { ### Path Parameters +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | ### Other Parameters @@ -57,6 +62,7 @@ Other parameters are passed through a pointer to a apiBackchannelAuthenticationA Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **backchannelAuthenticationRequest** | [**BackchannelAuthenticationRequest**](BackchannelAuthenticationRequest.md) | | ### Return type @@ -65,7 +71,7 @@ Name | Type | Description | Notes ### Authorization -[ServiceCredentials](../README.md#ServiceCredentials) +[UseService](../README.md#UseService) ### HTTP request headers @@ -79,9 +85,9 @@ Name | Type | Description | Notes ## BackchannelAuthenticationCompleteApi -> BackchannelAuthenticationCompleteResponse BackchannelAuthenticationCompleteApi(ctx).BackchannelAuthenticationCompleteRequest(backchannelAuthenticationCompleteRequest).Execute() +> BackchannelAuthenticationCompleteResponse BackchannelAuthenticationCompleteApi(ctx, serviceId).BackchannelAuthenticationCompleteRequest(backchannelAuthenticationCompleteRequest).Execute() -/api/backchannel/authentication/complete API +/api/{serviceId}/backchannel/authentication/complete API @@ -98,11 +104,12 @@ import ( ) func main() { + serviceId := "serviceId_example" // string | A service ID. backchannelAuthenticationCompleteRequest := *openapiclient.NewBackchannelAuthenticationCompleteRequest("Ticket_example", "Result_example", "Subject_example") // BackchannelAuthenticationCompleteRequest | configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.CIBAApi.BackchannelAuthenticationCompleteApi(context.Background()).BackchannelAuthenticationCompleteRequest(backchannelAuthenticationCompleteRequest).Execute() + resp, r, err := apiClient.CIBAApi.BackchannelAuthenticationCompleteApi(context.Background(), serviceId).BackchannelAuthenticationCompleteRequest(backchannelAuthenticationCompleteRequest).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `CIBAApi.BackchannelAuthenticationCompleteApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -115,6 +122,10 @@ func main() { ### Path Parameters +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | ### Other Parameters @@ -123,6 +134,7 @@ Other parameters are passed through a pointer to a apiBackchannelAuthenticationC Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **backchannelAuthenticationCompleteRequest** | [**BackchannelAuthenticationCompleteRequest**](BackchannelAuthenticationCompleteRequest.md) | | ### Return type @@ -131,7 +143,7 @@ Name | Type | Description | Notes ### Authorization -[ServiceCredentials](../README.md#ServiceCredentials) +[UseService](../README.md#UseService) ### HTTP request headers @@ -145,9 +157,9 @@ Name | Type | Description | Notes ## BackchannelAuthenticationFailApi -> BackchannelAuthenticationFailResponse BackchannelAuthenticationFailApi(ctx).BackchannelAuthenticationFailRequest(backchannelAuthenticationFailRequest).Execute() +> BackchannelAuthenticationFailResponse BackchannelAuthenticationFailApi(ctx, serviceId).BackchannelAuthenticationFailRequest(backchannelAuthenticationFailRequest).Execute() -/api/backchannel/authentication/fail API +/api/{serviceId}/backchannel/authentication/fail API @@ -164,11 +176,12 @@ import ( ) func main() { + serviceId := "serviceId_example" // string | A service ID. backchannelAuthenticationFailRequest := *openapiclient.NewBackchannelAuthenticationFailRequest("Ticket_example", "Reason_example") // BackchannelAuthenticationFailRequest | configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.CIBAApi.BackchannelAuthenticationFailApi(context.Background()).BackchannelAuthenticationFailRequest(backchannelAuthenticationFailRequest).Execute() + resp, r, err := apiClient.CIBAApi.BackchannelAuthenticationFailApi(context.Background(), serviceId).BackchannelAuthenticationFailRequest(backchannelAuthenticationFailRequest).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `CIBAApi.BackchannelAuthenticationFailApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -181,6 +194,10 @@ func main() { ### Path Parameters +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | ### Other Parameters @@ -189,6 +206,7 @@ Other parameters are passed through a pointer to a apiBackchannelAuthenticationF Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **backchannelAuthenticationFailRequest** | [**BackchannelAuthenticationFailRequest**](BackchannelAuthenticationFailRequest.md) | | ### Return type @@ -197,7 +215,7 @@ Name | Type | Description | Notes ### Authorization -[ServiceCredentials](../README.md#ServiceCredentials) +[UseService](../README.md#UseService) ### HTTP request headers @@ -211,9 +229,9 @@ Name | Type | Description | Notes ## BackchannelAuthenticationIssueApi -> BackchannelAuthenticationIssueResponse BackchannelAuthenticationIssueApi(ctx).BackchannelAuthenticationIssueRequest(backchannelAuthenticationIssueRequest).Execute() +> BackchannelAuthenticationIssueResponse BackchannelAuthenticationIssueApi(ctx, serviceId).BackchannelAuthenticationIssueRequest(backchannelAuthenticationIssueRequest).Execute() -/api/backchannel/authentication/issue API +/api/{serviceId}/backchannel/authentication/issue API @@ -230,11 +248,12 @@ import ( ) func main() { + serviceId := "serviceId_example" // string | A service ID. backchannelAuthenticationIssueRequest := *openapiclient.NewBackchannelAuthenticationIssueRequest("Ticket_example") // BackchannelAuthenticationIssueRequest | configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.CIBAApi.BackchannelAuthenticationIssueApi(context.Background()).BackchannelAuthenticationIssueRequest(backchannelAuthenticationIssueRequest).Execute() + resp, r, err := apiClient.CIBAApi.BackchannelAuthenticationIssueApi(context.Background(), serviceId).BackchannelAuthenticationIssueRequest(backchannelAuthenticationIssueRequest).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `CIBAApi.BackchannelAuthenticationIssueApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -247,6 +266,10 @@ func main() { ### Path Parameters +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | ### Other Parameters @@ -255,6 +278,7 @@ Other parameters are passed through a pointer to a apiBackchannelAuthenticationI Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **backchannelAuthenticationIssueRequest** | [**BackchannelAuthenticationIssueRequest**](BackchannelAuthenticationIssueRequest.md) | | ### Return type @@ -263,7 +287,7 @@ Name | Type | Description | Notes ### Authorization -[ServiceCredentials](../README.md#ServiceCredentials) +[UseService](../README.md#UseService) ### HTTP request headers diff --git a/docs/Client.md b/docs/Client.md index 9b308b0..765a38a 100644 --- a/docs/Client.md +++ b/docs/Client.md @@ -6,15 +6,14 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Number** | Pointer to **int32** | The sequential number of the client. The value of this property is assigned by Authlete. | [optional] [readonly] **ServiceNumber** | Pointer to **int32** | The sequential number of the service of the client application. The value of this property is assigned by Authlete. | [optional] [readonly] -**Developer** | Pointer to **string** | The developer of the client application. | [optional] **ClientName** | Pointer to **string** | The name of the client application. This property corresponds to `client_name` in [OpenID Connect Dynamic Client Registration 1.0, 2. Client Metadata](https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata). | [optional] **ClientNames** | Pointer to [**[]TaggedValue**](TaggedValue.md) | Client names with language tags. If the client application has different names for different languages, this property can be used to register the names. | [optional] **Description** | Pointer to **string** | The description about the client application. | [optional] **Descriptions** | Pointer to [**[]TaggedValue**](TaggedValue.md) | Descriptions about the client application with language tags. If the client application has different descriptions for different languages, this property can be used to register the descriptions. | [optional] -**ClientId** | Pointer to **int64** | The client ID. The value of this property is assigned by Authlete. | [optional] [readonly] +**ClientId** | Pointer to **int64** | The client identifier used in Authlete API calls. The value of this property is assigned by Authlete. | [optional] [readonly] **ClientSecret** | Pointer to **string** | The client secret. A random 512-bit value encoded by base64url (86 letters). The value of this property is assigned by Authlete. Note that Authlete issues a client secret even to a \"public\" client application, but the client application should not use the client secret unless it changes its client type to \"confidential\". That is, a public client application should behave as if it had not been issued a client secret. To be specific, a token request from a public client of Authlete should not come along with a client secret although [RFC 6749, 3.2.1. Client Authentication](https://datatracker.ietf.org/doc/html/rfc6749#section-3.2.1) says as follows. > Confidential clients or other clients issued client credentials MUST authenticate with the authorization server as described in Section 2.3 when making requests to the token endpoint. | [optional] [readonly] -**ClientIdAlias** | Pointer to **string** | The alias of the client ID. Note that the client ID alias is recognized only when this client's `clientIdAliasEnabled` property is set to `true` AND the service's `clientIdAliasEnabled` property is also set to `true`. | [optional] -**ClientIdAliasEnabled** | Pointer to **bool** | The flag to indicate whether the client ID alias is enabled or not. Note that a service also has `clientIdAliasEnabled` property. If the service's `clientIdAliasEnabled` property is set to `false`, the client ID alias of this client is not recognized even if this client's `clientIdAliasEnabled` property is set to `true`. | [optional] +**ClientIdAlias** | Pointer to **string** | The value of the client's `client_id` property used in OAuth and OpenID Connect calls. By default, this is a string version of the `clientId` property. | [optional] +**ClientIdAliasEnabled** | Pointer to **bool** | Deprecated. Always set to `true`. | [optional] **ClientType** | Pointer to [**ClientType**](ClientType.md) | | [optional] **ApplicationType** | Pointer to [**NullableApplicationType**](ApplicationType.md) | | [optional] **LogoUri** | Pointer to **string** | The URL pointing to the logo image of the client application. This property corresponds to `logo_uri` in [OpenID Connect Dynamic Client Registration 1.0, 2. Client Metadata](https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata). | [optional] @@ -87,16 +86,20 @@ Name | Type | Description | Notes **AutomaticallyRegistered** | Pointer to **bool** | The flag indicating whether this client was registered by the \"automatic\" client registration of OIDC Federation. | [optional] **ExplicitlyRegistered** | Pointer to **bool** | The flag indicating whether this client was registered by the \"explicit\" client registration of OIDC Federation. | [optional] **RsRequestSigned** | Pointer to **bool** | The flag indicating whether this service signs responses from the resource server. | [optional] -**RsSignedRequestKeyId** | Pointer to **string** | Get the key ID of a JWK containing the public key used by this client to sign requests to the resource server. | [optional] -**ClientRegistrationTypes** | Pointer to [**[]ClientRegistrationType**](ClientRegistrationType.md) | Get the client registration types that the client has declared it may use. | [optional] -**OrganizationName** | Pointer to **string** | Get the human-readable name representing the organization that manages this client. This property corresponds to the organization_name client metadata that is defined in OpenID Connect Federation 1.0. | [optional] -**SignedJwksUri** | Pointer to **string** | Get the URI of the endpoint that returns this client's JWK Set document in the JWT format. This property corresponds to the `signed_jwks_uri` client metadata defined in OpenID Connect Federation 1.0. | [optional] +**RsSignedRequestKeyId** | Pointer to **string** | The key ID of a JWK containing the public key used by this client to sign requests to the resource server. | [optional] +**ClientRegistrationTypes** | Pointer to [**[]ClientRegistrationType**](ClientRegistrationType.md) | The client registration types that the client has declared it may use. | [optional] +**OrganizationName** | Pointer to **string** | The human-readable name representing the organization that manages this client. This property corresponds to the organization_name client metadata that is defined in OpenID Connect Federation 1.0. | [optional] +**SignedJwksUri** | Pointer to **string** | The URI of the endpoint that returns this client's JWK Set document in the JWT format. This property corresponds to the `signed_jwks_uri` client metadata defined in OpenID Connect Federation 1.0. | [optional] **EntityId** | Pointer to **string** | the entity ID of this client. | [optional] -**TrustAnchorId** | Pointer to **string** | The entity ID of the trust anchor of the trust chain that was used when this client was registered or updated by the mechanism defined in OpenID Connect Federation 1.0 | [optional] +**TrustAnchorId** | Pointer to **string** | The entity ID of the trust anchor of the trust chain that was used when this client was registered or updated by the mechanism defined in OpenID Connect Federation 1.0 | [optional] **TrustChain** | Pointer to **[]string** | The trust chain that was used when this client was registered or updated by the mechanism defined in OpenID Connect Federation 1.0 | [optional] -**TrustChainExpiresAt** | Pointer to **int64** | the expiration time of the trust chain that was used when this client was registered or updated by the mechanism defined in OpenID Connect Federation 1.0. The value is represented as milliseconds elapsed since the Unix epoch (1970-01-01). | [optional] +**TrustChainExpiresAt** | Pointer to **int64** | the expiration time of the trust chain that was used when this client was registered or updated by the mechanism defined in OpenID Connect Federation 1.0. The value is represented as milliseconds elapsed since the Unix epoch (1970-01-01). | [optional] **TrustChainUpdatedAt** | Pointer to **int64** | the time at which the trust chain was updated by the mechanism defined in OpenID Connect Federation 1.0 | [optional] -**Locked** | Pointer to **bool** | The flag which indicates whether this client is locked. | [optional] +**Locked** | Pointer to **bool** | The flag which indicates whether this client is locked. | [optional] +**CredentialOfferEndpoint** | Pointer to **string** | The URL of the credential offer endpoint at which this client (wallet) receives a credential offer from the credential issuer. | [optional] +**FapiModes** | Pointer to [**[]FapiMode**](FapiMode.md) | The FAPI modes for this client. When the value of this property is not `null`, Authlete always processes requests from this client based on the specified FAPI modes if the FAPI feature is enabled in Authlete, the FAPI profile is supported by the service, and the FAPI modes for the service are set to `null`. For instance, when this property is set to an array containing `FAPI1_ADVANCED` only, Authlete always processes requests from this client based on \"Financial-grade API Security Profile 1.0 - Part 2: Advanced\" if the FAPI feature is enabled in Authlete, the FAPI profile is supported by the service, and the FAPI modes for the service are set to `null`. | [optional] +**ResponseModes** | Pointer to **[]string** | The response modes that this client may use. | [optional] +**CredentialResponseEncryptionRequired** | Pointer to **bool** | True if credential responses to this client must be always encrypted. | [optional] ## Methods @@ -167,31 +170,6 @@ SetServiceNumber sets ServiceNumber field to given value. HasServiceNumber returns a boolean if a field has been set. -### GetDeveloper - -`func (o *Client) GetDeveloper() string` - -GetDeveloper returns the Developer field if non-nil, zero value otherwise. - -### GetDeveloperOk - -`func (o *Client) GetDeveloperOk() (*string, bool)` - -GetDeveloperOk returns a tuple with the Developer field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### SetDeveloper - -`func (o *Client) SetDeveloper(v string)` - -SetDeveloper sets Developer field to given value. - -### HasDeveloper - -`func (o *Client) HasDeveloper() bool` - -HasDeveloper returns a boolean if a field has been set. - ### GetClientName `func (o *Client) GetClientName() string` @@ -2452,6 +2430,106 @@ SetLocked sets Locked field to given value. HasLocked returns a boolean if a field has been set. +### GetCredentialOfferEndpoint + +`func (o *Client) GetCredentialOfferEndpoint() string` + +GetCredentialOfferEndpoint returns the CredentialOfferEndpoint field if non-nil, zero value otherwise. + +### GetCredentialOfferEndpointOk + +`func (o *Client) GetCredentialOfferEndpointOk() (*string, bool)` + +GetCredentialOfferEndpointOk returns a tuple with the CredentialOfferEndpoint field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCredentialOfferEndpoint + +`func (o *Client) SetCredentialOfferEndpoint(v string)` + +SetCredentialOfferEndpoint sets CredentialOfferEndpoint field to given value. + +### HasCredentialOfferEndpoint + +`func (o *Client) HasCredentialOfferEndpoint() bool` + +HasCredentialOfferEndpoint returns a boolean if a field has been set. + +### GetFapiModes + +`func (o *Client) GetFapiModes() []FapiMode` + +GetFapiModes returns the FapiModes field if non-nil, zero value otherwise. + +### GetFapiModesOk + +`func (o *Client) GetFapiModesOk() (*[]FapiMode, bool)` + +GetFapiModesOk returns a tuple with the FapiModes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFapiModes + +`func (o *Client) SetFapiModes(v []FapiMode)` + +SetFapiModes sets FapiModes field to given value. + +### HasFapiModes + +`func (o *Client) HasFapiModes() bool` + +HasFapiModes returns a boolean if a field has been set. + +### GetResponseModes + +`func (o *Client) GetResponseModes() []string` + +GetResponseModes returns the ResponseModes field if non-nil, zero value otherwise. + +### GetResponseModesOk + +`func (o *Client) GetResponseModesOk() (*[]string, bool)` + +GetResponseModesOk returns a tuple with the ResponseModes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResponseModes + +`func (o *Client) SetResponseModes(v []string)` + +SetResponseModes sets ResponseModes field to given value. + +### HasResponseModes + +`func (o *Client) HasResponseModes() bool` + +HasResponseModes returns a boolean if a field has been set. + +### GetCredentialResponseEncryptionRequired + +`func (o *Client) GetCredentialResponseEncryptionRequired() bool` + +GetCredentialResponseEncryptionRequired returns the CredentialResponseEncryptionRequired field if non-nil, zero value otherwise. + +### GetCredentialResponseEncryptionRequiredOk + +`func (o *Client) GetCredentialResponseEncryptionRequiredOk() (*bool, bool)` + +GetCredentialResponseEncryptionRequiredOk returns a tuple with the CredentialResponseEncryptionRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCredentialResponseEncryptionRequired + +`func (o *Client) SetCredentialResponseEncryptionRequired(v bool)` + +SetCredentialResponseEncryptionRequired sets CredentialResponseEncryptionRequired field to given value. + +### HasCredentialResponseEncryptionRequired + +`func (o *Client) HasCredentialResponseEncryptionRequired() bool` + +HasCredentialResponseEncryptionRequired returns a boolean if a field has been set. + [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ClientAuthorizationDeleteResponse.md b/docs/ClientAuthorizationDeleteResponse.md index 18e9c3f..fd81c1c 100644 --- a/docs/ClientAuthorizationDeleteResponse.md +++ b/docs/ClientAuthorizationDeleteResponse.md @@ -6,6 +6,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **ResultCode** | Pointer to **string** | The code which represents the result of the API call. | [optional] **ResultMessage** | Pointer to **string** | A short message which explains the result of the API call. | [optional] +**ServiceApiKey** | Pointer to **int64** | A short message which explains the result of the API call. | [optional] +**ClientId** | Pointer to **int64** | Get the client ID. | [optional] +**Subject** | Pointer to **string** | Get the subject (= unique identifier) of the user who has granted authorization to the client. | [optional] +**LatestGrantedScopes** | Pointer to **[]string** | Get the scopes granted to the client application by the last authorization process by the user (who is identified by the subject). | [optional] +**MergedGrantedScopes** | Pointer to **[]string** | Get the scopes granted to the client application by all the past authorization processes. Note that revoked scopes are not included. | [optional] +**ModifiedAt** | Pointer to **int64** | Get the timestamp in milliseconds since Unix epoch at which this record was modified. | [optional] ## Methods @@ -76,6 +82,156 @@ SetResultMessage sets ResultMessage field to given value. HasResultMessage returns a boolean if a field has been set. +### GetServiceApiKey + +`func (o *ClientAuthorizationDeleteResponse) GetServiceApiKey() int64` + +GetServiceApiKey returns the ServiceApiKey field if non-nil, zero value otherwise. + +### GetServiceApiKeyOk + +`func (o *ClientAuthorizationDeleteResponse) GetServiceApiKeyOk() (*int64, bool)` + +GetServiceApiKeyOk returns a tuple with the ServiceApiKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetServiceApiKey + +`func (o *ClientAuthorizationDeleteResponse) SetServiceApiKey(v int64)` + +SetServiceApiKey sets ServiceApiKey field to given value. + +### HasServiceApiKey + +`func (o *ClientAuthorizationDeleteResponse) HasServiceApiKey() bool` + +HasServiceApiKey returns a boolean if a field has been set. + +### GetClientId + +`func (o *ClientAuthorizationDeleteResponse) GetClientId() int64` + +GetClientId returns the ClientId field if non-nil, zero value otherwise. + +### GetClientIdOk + +`func (o *ClientAuthorizationDeleteResponse) GetClientIdOk() (*int64, bool)` + +GetClientIdOk returns a tuple with the ClientId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientId + +`func (o *ClientAuthorizationDeleteResponse) SetClientId(v int64)` + +SetClientId sets ClientId field to given value. + +### HasClientId + +`func (o *ClientAuthorizationDeleteResponse) HasClientId() bool` + +HasClientId returns a boolean if a field has been set. + +### GetSubject + +`func (o *ClientAuthorizationDeleteResponse) GetSubject() string` + +GetSubject returns the Subject field if non-nil, zero value otherwise. + +### GetSubjectOk + +`func (o *ClientAuthorizationDeleteResponse) GetSubjectOk() (*string, bool)` + +GetSubjectOk returns a tuple with the Subject field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSubject + +`func (o *ClientAuthorizationDeleteResponse) SetSubject(v string)` + +SetSubject sets Subject field to given value. + +### HasSubject + +`func (o *ClientAuthorizationDeleteResponse) HasSubject() bool` + +HasSubject returns a boolean if a field has been set. + +### GetLatestGrantedScopes + +`func (o *ClientAuthorizationDeleteResponse) GetLatestGrantedScopes() []string` + +GetLatestGrantedScopes returns the LatestGrantedScopes field if non-nil, zero value otherwise. + +### GetLatestGrantedScopesOk + +`func (o *ClientAuthorizationDeleteResponse) GetLatestGrantedScopesOk() (*[]string, bool)` + +GetLatestGrantedScopesOk returns a tuple with the LatestGrantedScopes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLatestGrantedScopes + +`func (o *ClientAuthorizationDeleteResponse) SetLatestGrantedScopes(v []string)` + +SetLatestGrantedScopes sets LatestGrantedScopes field to given value. + +### HasLatestGrantedScopes + +`func (o *ClientAuthorizationDeleteResponse) HasLatestGrantedScopes() bool` + +HasLatestGrantedScopes returns a boolean if a field has been set. + +### GetMergedGrantedScopes + +`func (o *ClientAuthorizationDeleteResponse) GetMergedGrantedScopes() []string` + +GetMergedGrantedScopes returns the MergedGrantedScopes field if non-nil, zero value otherwise. + +### GetMergedGrantedScopesOk + +`func (o *ClientAuthorizationDeleteResponse) GetMergedGrantedScopesOk() (*[]string, bool)` + +GetMergedGrantedScopesOk returns a tuple with the MergedGrantedScopes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMergedGrantedScopes + +`func (o *ClientAuthorizationDeleteResponse) SetMergedGrantedScopes(v []string)` + +SetMergedGrantedScopes sets MergedGrantedScopes field to given value. + +### HasMergedGrantedScopes + +`func (o *ClientAuthorizationDeleteResponse) HasMergedGrantedScopes() bool` + +HasMergedGrantedScopes returns a boolean if a field has been set. + +### GetModifiedAt + +`func (o *ClientAuthorizationDeleteResponse) GetModifiedAt() int64` + +GetModifiedAt returns the ModifiedAt field if non-nil, zero value otherwise. + +### GetModifiedAtOk + +`func (o *ClientAuthorizationDeleteResponse) GetModifiedAtOk() (*int64, bool)` + +GetModifiedAtOk returns a tuple with the ModifiedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModifiedAt + +`func (o *ClientAuthorizationDeleteResponse) SetModifiedAt(v int64)` + +SetModifiedAt sets ModifiedAt field to given value. + +### HasModifiedAt + +`func (o *ClientAuthorizationDeleteResponse) HasModifiedAt() bool` + +HasModifiedAt returns a boolean if a field has been set. + [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ClientAuthorizationGetListResponse.md b/docs/ClientAuthorizationGetListResponse.md index 8434263..0e85524 100644 --- a/docs/ClientAuthorizationGetListResponse.md +++ b/docs/ClientAuthorizationGetListResponse.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **Developer** | Pointer to **string** | Unique ID of a client developer. | [optional] **Subject** | Pointer to **string** | Unique user ID of an end-user. | [optional] **TotalCount** | Pointer to **int32** | Unique ID of a client developer. | [optional] -**Clients** | Pointer to [**[]Client**](Client.md) | An array of clients. | [optional] +**Clients** | Pointer to [**[]ClientLimited**](ClientLimited.md) | An array of clients. | [optional] ## Methods @@ -157,20 +157,20 @@ HasTotalCount returns a boolean if a field has been set. ### GetClients -`func (o *ClientAuthorizationGetListResponse) GetClients() []Client` +`func (o *ClientAuthorizationGetListResponse) GetClients() []ClientLimited` GetClients returns the Clients field if non-nil, zero value otherwise. ### GetClientsOk -`func (o *ClientAuthorizationGetListResponse) GetClientsOk() (*[]Client, bool)` +`func (o *ClientAuthorizationGetListResponse) GetClientsOk() (*[]ClientLimited, bool)` GetClientsOk returns a tuple with the Clients field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### SetClients -`func (o *ClientAuthorizationGetListResponse) SetClients(v []Client)` +`func (o *ClientAuthorizationGetListResponse) SetClients(v []ClientLimited)` SetClients sets Clients field to given value. diff --git a/docs/ClientExtensionApi.md b/docs/ClientExtensionApi.md index 5258f3a..77b3758 100644 --- a/docs/ClientExtensionApi.md +++ b/docs/ClientExtensionApi.md @@ -1,20 +1,20 @@ # \ClientExtensionApi -All URIs are relative to *https://api.authlete.com* +All URIs are relative to *https://beta.authlete.com* Method | HTTP request | Description ------------- | ------------- | ------------- -[**ClientExtensionRequestablesScopesDeleteApi**](ClientExtensionApi.md#ClientExtensionRequestablesScopesDeleteApi) | **Delete** /api/client/extension/requestable_scopes/delete/{clientId} | /api/client/extension/requestable_scopes/delete/{clientId} API -[**ClientExtensionRequestablesScopesGetApi**](ClientExtensionApi.md#ClientExtensionRequestablesScopesGetApi) | **Get** /api/client/extension/requestable_scopes/get/{clientId} | /api/client/extension/requestable_scopes/get/{clientId} API -[**ClientExtensionRequestablesScopesUpdateApi**](ClientExtensionApi.md#ClientExtensionRequestablesScopesUpdateApi) | **Put** /api/client/extension/requestable_scopes/update/{clientId} | /api/client/extension/requestable_scopes/update/{clientId} API +[**ClientExtensionRequestablesScopesDeleteApi**](ClientExtensionApi.md#ClientExtensionRequestablesScopesDeleteApi) | **Delete** /api/{serviceId}/client/extension/requestable_scopes/delete/{clientId} | /api/{serviceId}/client/extension/requestable_scopes/delete/{clientId} API +[**ClientExtensionRequestablesScopesGetApi**](ClientExtensionApi.md#ClientExtensionRequestablesScopesGetApi) | **Get** /api/{serviceId}/client/extension/requestable_scopes/get/{clientId} | /api/{serviceId}/client/extension/requestable_scopes/get/{clientId} API +[**ClientExtensionRequestablesScopesUpdateApi**](ClientExtensionApi.md#ClientExtensionRequestablesScopesUpdateApi) | **Put** /api/{serviceId}/client/extension/requestable_scopes/update/{clientId} | /api/{serviceId}/client/extension/requestable_scopes/update/{clientId} API ## ClientExtensionRequestablesScopesDeleteApi -> ClientExtensionRequestablesScopesDeleteApi(ctx, clientId).Execute() +> ClientExtensionRequestablesScopesDeleteApi(ctx, serviceId, clientId).Execute() -/api/client/extension/requestable_scopes/delete/{clientId} API +/api/{serviceId}/client/extension/requestable_scopes/delete/{clientId} API @@ -31,11 +31,12 @@ import ( ) func main() { + serviceId := "serviceId_example" // string | A service ID. clientId := "clientId_example" // string | A client ID. configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.ClientExtensionApi.ClientExtensionRequestablesScopesDeleteApi(context.Background(), clientId).Execute() + resp, r, err := apiClient.ClientExtensionApi.ClientExtensionRequestablesScopesDeleteApi(context.Background(), serviceId, clientId).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ClientExtensionApi.ClientExtensionRequestablesScopesDeleteApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -49,6 +50,7 @@ func main() { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | **clientId** | **string** | A client ID. | ### Other Parameters @@ -60,13 +62,14 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + ### Return type (empty response body) ### Authorization -[ServiceCredentials](../README.md#ServiceCredentials) +[ModifyService](../README.md#ModifyService) ### HTTP request headers @@ -80,9 +83,9 @@ Name | Type | Description | Notes ## ClientExtensionRequestablesScopesGetApi -> ClientExtensionRequestableScopesGetResponse ClientExtensionRequestablesScopesGetApi(ctx, clientId).Execute() +> ClientExtensionRequestableScopesGetResponse ClientExtensionRequestablesScopesGetApi(ctx, serviceId, clientId).Execute() -/api/client/extension/requestable_scopes/get/{clientId} API +/api/{serviceId}/client/extension/requestable_scopes/get/{clientId} API @@ -99,11 +102,12 @@ import ( ) func main() { + serviceId := "serviceId_example" // string | A service ID. clientId := "clientId_example" // string | A client ID. configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.ClientExtensionApi.ClientExtensionRequestablesScopesGetApi(context.Background(), clientId).Execute() + resp, r, err := apiClient.ClientExtensionApi.ClientExtensionRequestablesScopesGetApi(context.Background(), serviceId, clientId).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ClientExtensionApi.ClientExtensionRequestablesScopesGetApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -119,6 +123,7 @@ func main() { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | **clientId** | **string** | A client ID. | ### Other Parameters @@ -130,13 +135,14 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + ### Return type [**ClientExtensionRequestableScopesGetResponse**](ClientExtensionRequestableScopesGetResponse.md) ### Authorization -[ServiceCredentials](../README.md#ServiceCredentials) +[ViewClient](../README.md#ViewClient) ### HTTP request headers @@ -150,9 +156,9 @@ Name | Type | Description | Notes ## ClientExtensionRequestablesScopesUpdateApi -> ClientExtensionRequestableScopesUpdateResponse ClientExtensionRequestablesScopesUpdateApi(ctx, clientId).ClientExtensionRequestableScopesUpdateRequest(clientExtensionRequestableScopesUpdateRequest).Execute() +> ClientExtensionRequestableScopesUpdateResponse ClientExtensionRequestablesScopesUpdateApi(ctx, serviceId, clientId).ClientExtensionRequestableScopesUpdateRequest(clientExtensionRequestableScopesUpdateRequest).Execute() -/api/client/extension/requestable_scopes/update/{clientId} API +/api/{serviceId}/client/extension/requestable_scopes/update/{clientId} API @@ -169,12 +175,13 @@ import ( ) func main() { + serviceId := "serviceId_example" // string | A service ID. clientId := "clientId_example" // string | A client ID. clientExtensionRequestableScopesUpdateRequest := *openapiclient.NewClientExtensionRequestableScopesUpdateRequest() // ClientExtensionRequestableScopesUpdateRequest | configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.ClientExtensionApi.ClientExtensionRequestablesScopesUpdateApi(context.Background(), clientId).ClientExtensionRequestableScopesUpdateRequest(clientExtensionRequestableScopesUpdateRequest).Execute() + resp, r, err := apiClient.ClientExtensionApi.ClientExtensionRequestablesScopesUpdateApi(context.Background(), serviceId, clientId).ClientExtensionRequestableScopesUpdateRequest(clientExtensionRequestableScopesUpdateRequest).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ClientExtensionApi.ClientExtensionRequestablesScopesUpdateApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -190,6 +197,7 @@ func main() { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | **clientId** | **string** | A client ID. | ### Other Parameters @@ -200,6 +208,7 @@ Other parameters are passed through a pointer to a apiClientExtensionRequestable Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **clientExtensionRequestableScopesUpdateRequest** | [**ClientExtensionRequestableScopesUpdateRequest**](ClientExtensionRequestableScopesUpdateRequest.md) | | ### Return type @@ -208,7 +217,7 @@ Name | Type | Description | Notes ### Authorization -[ServiceCredentials](../README.md#ServiceCredentials) +[ModifyClient](../README.md#ModifyClient) ### HTTP request headers diff --git a/docs/ClientGetListApi200Response.md b/docs/ClientGetListApi200Response.md new file mode 100644 index 0000000..b073176 --- /dev/null +++ b/docs/ClientGetListApi200Response.md @@ -0,0 +1,134 @@ +# ClientGetListApi200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Start** | Pointer to **int32** | Start index (inclusive) of the result set of the query. | [optional] +**End** | Pointer to **int32** | End index (exclusive) of the result set of the query. | [optional] +**TotalCount** | Pointer to **int32** | Total number of clients that belong to the service. This doesn't mean the number of clients contained in the response. | [optional] +**Clients** | Pointer to [**[]ClientLimited**](ClientLimited.md) | An array of clients. | [optional] + +## Methods + +### NewClientGetListApi200Response + +`func NewClientGetListApi200Response() *ClientGetListApi200Response` + +NewClientGetListApi200Response instantiates a new ClientGetListApi200Response object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewClientGetListApi200ResponseWithDefaults + +`func NewClientGetListApi200ResponseWithDefaults() *ClientGetListApi200Response` + +NewClientGetListApi200ResponseWithDefaults instantiates a new ClientGetListApi200Response object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetStart + +`func (o *ClientGetListApi200Response) GetStart() int32` + +GetStart returns the Start field if non-nil, zero value otherwise. + +### GetStartOk + +`func (o *ClientGetListApi200Response) GetStartOk() (*int32, bool)` + +GetStartOk returns a tuple with the Start field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStart + +`func (o *ClientGetListApi200Response) SetStart(v int32)` + +SetStart sets Start field to given value. + +### HasStart + +`func (o *ClientGetListApi200Response) HasStart() bool` + +HasStart returns a boolean if a field has been set. + +### GetEnd + +`func (o *ClientGetListApi200Response) GetEnd() int32` + +GetEnd returns the End field if non-nil, zero value otherwise. + +### GetEndOk + +`func (o *ClientGetListApi200Response) GetEndOk() (*int32, bool)` + +GetEndOk returns a tuple with the End field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnd + +`func (o *ClientGetListApi200Response) SetEnd(v int32)` + +SetEnd sets End field to given value. + +### HasEnd + +`func (o *ClientGetListApi200Response) HasEnd() bool` + +HasEnd returns a boolean if a field has been set. + +### GetTotalCount + +`func (o *ClientGetListApi200Response) GetTotalCount() int32` + +GetTotalCount returns the TotalCount field if non-nil, zero value otherwise. + +### GetTotalCountOk + +`func (o *ClientGetListApi200Response) GetTotalCountOk() (*int32, bool)` + +GetTotalCountOk returns a tuple with the TotalCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCount + +`func (o *ClientGetListApi200Response) SetTotalCount(v int32)` + +SetTotalCount sets TotalCount field to given value. + +### HasTotalCount + +`func (o *ClientGetListApi200Response) HasTotalCount() bool` + +HasTotalCount returns a boolean if a field has been set. + +### GetClients + +`func (o *ClientGetListApi200Response) GetClients() []ClientLimited` + +GetClients returns the Clients field if non-nil, zero value otherwise. + +### GetClientsOk + +`func (o *ClientGetListApi200Response) GetClientsOk() (*[]ClientLimited, bool)` + +GetClientsOk returns a tuple with the Clients field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClients + +`func (o *ClientGetListApi200Response) SetClients(v []ClientLimited)` + +SetClients sets Clients field to given value. + +### HasClients + +`func (o *ClientGetListApi200Response) HasClients() bool` + +HasClients returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ClientGetListLimitedResponse.md b/docs/ClientGetListLimitedResponse.md new file mode 100644 index 0000000..06c9d88 --- /dev/null +++ b/docs/ClientGetListLimitedResponse.md @@ -0,0 +1,134 @@ +# ClientGetListLimitedResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Start** | Pointer to **int32** | Start index (inclusive) of the result set of the query. | [optional] +**End** | Pointer to **int32** | End index (exclusive) of the result set of the query. | [optional] +**TotalCount** | Pointer to **int32** | Total number of clients that belong to the service. This doesn't mean the number of clients contained in the response. | [optional] +**Clients** | Pointer to [**[]ClientLimited**](ClientLimited.md) | An array of clients. | [optional] + +## Methods + +### NewClientGetListLimitedResponse + +`func NewClientGetListLimitedResponse() *ClientGetListLimitedResponse` + +NewClientGetListLimitedResponse instantiates a new ClientGetListLimitedResponse object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewClientGetListLimitedResponseWithDefaults + +`func NewClientGetListLimitedResponseWithDefaults() *ClientGetListLimitedResponse` + +NewClientGetListLimitedResponseWithDefaults instantiates a new ClientGetListLimitedResponse object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetStart + +`func (o *ClientGetListLimitedResponse) GetStart() int32` + +GetStart returns the Start field if non-nil, zero value otherwise. + +### GetStartOk + +`func (o *ClientGetListLimitedResponse) GetStartOk() (*int32, bool)` + +GetStartOk returns a tuple with the Start field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStart + +`func (o *ClientGetListLimitedResponse) SetStart(v int32)` + +SetStart sets Start field to given value. + +### HasStart + +`func (o *ClientGetListLimitedResponse) HasStart() bool` + +HasStart returns a boolean if a field has been set. + +### GetEnd + +`func (o *ClientGetListLimitedResponse) GetEnd() int32` + +GetEnd returns the End field if non-nil, zero value otherwise. + +### GetEndOk + +`func (o *ClientGetListLimitedResponse) GetEndOk() (*int32, bool)` + +GetEndOk returns a tuple with the End field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnd + +`func (o *ClientGetListLimitedResponse) SetEnd(v int32)` + +SetEnd sets End field to given value. + +### HasEnd + +`func (o *ClientGetListLimitedResponse) HasEnd() bool` + +HasEnd returns a boolean if a field has been set. + +### GetTotalCount + +`func (o *ClientGetListLimitedResponse) GetTotalCount() int32` + +GetTotalCount returns the TotalCount field if non-nil, zero value otherwise. + +### GetTotalCountOk + +`func (o *ClientGetListLimitedResponse) GetTotalCountOk() (*int32, bool)` + +GetTotalCountOk returns a tuple with the TotalCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCount + +`func (o *ClientGetListLimitedResponse) SetTotalCount(v int32)` + +SetTotalCount sets TotalCount field to given value. + +### HasTotalCount + +`func (o *ClientGetListLimitedResponse) HasTotalCount() bool` + +HasTotalCount returns a boolean if a field has been set. + +### GetClients + +`func (o *ClientGetListLimitedResponse) GetClients() []ClientLimited` + +GetClients returns the Clients field if non-nil, zero value otherwise. + +### GetClientsOk + +`func (o *ClientGetListLimitedResponse) GetClientsOk() (*[]ClientLimited, bool)` + +GetClientsOk returns a tuple with the Clients field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClients + +`func (o *ClientGetListLimitedResponse) SetClients(v []ClientLimited)` + +SetClients sets Clients field to given value. + +### HasClients + +`func (o *ClientGetListLimitedResponse) HasClients() bool` + +HasClients returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ClientGetListResponse.md b/docs/ClientGetListResponse.md index fc0a3fd..514ec4a 100644 --- a/docs/ClientGetListResponse.md +++ b/docs/ClientGetListResponse.md @@ -4,7 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Developer** | Pointer to **string** | The developer of the client applications. If the request did not contain `developer` request parameter, this property is set to `null`. | [optional] **Start** | Pointer to **int32** | Start index (inclusive) of the result set of the query. | [optional] **End** | Pointer to **int32** | End index (exclusive) of the result set of the query. | [optional] **TotalCount** | Pointer to **int32** | Total number of clients that belong to the service. This doesn't mean the number of clients contained in the response. | [optional] @@ -29,31 +28,6 @@ NewClientGetListResponseWithDefaults instantiates a new ClientGetListResponse ob This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set -### GetDeveloper - -`func (o *ClientGetListResponse) GetDeveloper() string` - -GetDeveloper returns the Developer field if non-nil, zero value otherwise. - -### GetDeveloperOk - -`func (o *ClientGetListResponse) GetDeveloperOk() (*string, bool)` - -GetDeveloperOk returns a tuple with the Developer field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### SetDeveloper - -`func (o *ClientGetListResponse) SetDeveloper(v string)` - -SetDeveloper sets Developer field to given value. - -### HasDeveloper - -`func (o *ClientGetListResponse) HasDeveloper() bool` - -HasDeveloper returns a boolean if a field has been set. - ### GetStart `func (o *ClientGetListResponse) GetStart() int32` diff --git a/docs/ClientLimited.md b/docs/ClientLimited.md new file mode 100644 index 0000000..9d8d2fe --- /dev/null +++ b/docs/ClientLimited.md @@ -0,0 +1,264 @@ +# ClientLimited + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Number** | Pointer to **int32** | The sequential number of the client. The value of this property is assigned by Authlete. | [optional] [readonly] +**ClientName** | Pointer to **string** | The name of the client application. This property corresponds to `client_name` in [OpenID Connect Dynamic Client Registration 1.0, 2. Client Metadata](https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata). | [optional] +**ClientNames** | Pointer to [**[]TaggedValue**](TaggedValue.md) | Client names with language tags. If the client application has different names for different languages, this property can be used to register the names. | [optional] +**Description** | Pointer to **string** | The description about the client application. | [optional] +**Descriptions** | Pointer to [**[]TaggedValue**](TaggedValue.md) | Descriptions about the client application with language tags. If the client application has different descriptions for different languages, this property can be used to register the descriptions. | [optional] +**ClientId** | Pointer to **int64** | The client identifier used in Authlete API calls. The value of this property is assigned by Authlete. | [optional] [readonly] +**ClientIdAlias** | Pointer to **string** | The value of the client's `client_id` property used in OAuth and OpenID Connect calls. By default, this is a string version of the `clientId` property. | [optional] +**ClientIdAliasEnabled** | Pointer to **bool** | Deprecated. Always set to `true`. | [optional] +**ClientType** | Pointer to [**ClientType**](ClientType.md) | | [optional] + +## Methods + +### NewClientLimited + +`func NewClientLimited() *ClientLimited` + +NewClientLimited instantiates a new ClientLimited object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewClientLimitedWithDefaults + +`func NewClientLimitedWithDefaults() *ClientLimited` + +NewClientLimitedWithDefaults instantiates a new ClientLimited object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetNumber + +`func (o *ClientLimited) GetNumber() int32` + +GetNumber returns the Number field if non-nil, zero value otherwise. + +### GetNumberOk + +`func (o *ClientLimited) GetNumberOk() (*int32, bool)` + +GetNumberOk returns a tuple with the Number field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNumber + +`func (o *ClientLimited) SetNumber(v int32)` + +SetNumber sets Number field to given value. + +### HasNumber + +`func (o *ClientLimited) HasNumber() bool` + +HasNumber returns a boolean if a field has been set. + +### GetClientName + +`func (o *ClientLimited) GetClientName() string` + +GetClientName returns the ClientName field if non-nil, zero value otherwise. + +### GetClientNameOk + +`func (o *ClientLimited) GetClientNameOk() (*string, bool)` + +GetClientNameOk returns a tuple with the ClientName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientName + +`func (o *ClientLimited) SetClientName(v string)` + +SetClientName sets ClientName field to given value. + +### HasClientName + +`func (o *ClientLimited) HasClientName() bool` + +HasClientName returns a boolean if a field has been set. + +### GetClientNames + +`func (o *ClientLimited) GetClientNames() []TaggedValue` + +GetClientNames returns the ClientNames field if non-nil, zero value otherwise. + +### GetClientNamesOk + +`func (o *ClientLimited) GetClientNamesOk() (*[]TaggedValue, bool)` + +GetClientNamesOk returns a tuple with the ClientNames field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientNames + +`func (o *ClientLimited) SetClientNames(v []TaggedValue)` + +SetClientNames sets ClientNames field to given value. + +### HasClientNames + +`func (o *ClientLimited) HasClientNames() bool` + +HasClientNames returns a boolean if a field has been set. + +### GetDescription + +`func (o *ClientLimited) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ClientLimited) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ClientLimited) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ClientLimited) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetDescriptions + +`func (o *ClientLimited) GetDescriptions() []TaggedValue` + +GetDescriptions returns the Descriptions field if non-nil, zero value otherwise. + +### GetDescriptionsOk + +`func (o *ClientLimited) GetDescriptionsOk() (*[]TaggedValue, bool)` + +GetDescriptionsOk returns a tuple with the Descriptions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescriptions + +`func (o *ClientLimited) SetDescriptions(v []TaggedValue)` + +SetDescriptions sets Descriptions field to given value. + +### HasDescriptions + +`func (o *ClientLimited) HasDescriptions() bool` + +HasDescriptions returns a boolean if a field has been set. + +### GetClientId + +`func (o *ClientLimited) GetClientId() int64` + +GetClientId returns the ClientId field if non-nil, zero value otherwise. + +### GetClientIdOk + +`func (o *ClientLimited) GetClientIdOk() (*int64, bool)` + +GetClientIdOk returns a tuple with the ClientId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientId + +`func (o *ClientLimited) SetClientId(v int64)` + +SetClientId sets ClientId field to given value. + +### HasClientId + +`func (o *ClientLimited) HasClientId() bool` + +HasClientId returns a boolean if a field has been set. + +### GetClientIdAlias + +`func (o *ClientLimited) GetClientIdAlias() string` + +GetClientIdAlias returns the ClientIdAlias field if non-nil, zero value otherwise. + +### GetClientIdAliasOk + +`func (o *ClientLimited) GetClientIdAliasOk() (*string, bool)` + +GetClientIdAliasOk returns a tuple with the ClientIdAlias field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientIdAlias + +`func (o *ClientLimited) SetClientIdAlias(v string)` + +SetClientIdAlias sets ClientIdAlias field to given value. + +### HasClientIdAlias + +`func (o *ClientLimited) HasClientIdAlias() bool` + +HasClientIdAlias returns a boolean if a field has been set. + +### GetClientIdAliasEnabled + +`func (o *ClientLimited) GetClientIdAliasEnabled() bool` + +GetClientIdAliasEnabled returns the ClientIdAliasEnabled field if non-nil, zero value otherwise. + +### GetClientIdAliasEnabledOk + +`func (o *ClientLimited) GetClientIdAliasEnabledOk() (*bool, bool)` + +GetClientIdAliasEnabledOk returns a tuple with the ClientIdAliasEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientIdAliasEnabled + +`func (o *ClientLimited) SetClientIdAliasEnabled(v bool)` + +SetClientIdAliasEnabled sets ClientIdAliasEnabled field to given value. + +### HasClientIdAliasEnabled + +`func (o *ClientLimited) HasClientIdAliasEnabled() bool` + +HasClientIdAliasEnabled returns a boolean if a field has been set. + +### GetClientType + +`func (o *ClientLimited) GetClientType() ClientType` + +GetClientType returns the ClientType field if non-nil, zero value otherwise. + +### GetClientTypeOk + +`func (o *ClientLimited) GetClientTypeOk() (*ClientType, bool)` + +GetClientTypeOk returns a tuple with the ClientType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientType + +`func (o *ClientLimited) SetClientType(v ClientType)` + +SetClientType sets ClientType field to given value. + +### HasClientType + +`func (o *ClientLimited) HasClientType() bool` + +HasClientType returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ClientLimitedAuthorization.md b/docs/ClientLimitedAuthorization.md new file mode 100644 index 0000000..5c891cf --- /dev/null +++ b/docs/ClientLimitedAuthorization.md @@ -0,0 +1,420 @@ +# ClientLimitedAuthorization + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Number** | Pointer to **int32** | The sequential number of the client. The value of this property is assigned by Authlete. | [optional] [readonly] +**ClientName** | Pointer to **string** | The name of the client application. This property corresponds to `client_name` in [OpenID Connect Dynamic Client Registration 1.0, 2. Client Metadata](https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata). | [optional] +**ClientNames** | Pointer to [**[]TaggedValue**](TaggedValue.md) | Client names with language tags. If the client application has different names for different languages, this property can be used to register the names. | [optional] +**Description** | Pointer to **string** | The description about the client application. | [optional] +**Descriptions** | Pointer to [**[]TaggedValue**](TaggedValue.md) | Descriptions about the client application with language tags. If the client application has different descriptions for different languages, this property can be used to register the descriptions. | [optional] +**ClientId** | Pointer to **int64** | The client identifier used in Authlete API calls. The value of this property is assigned by Authlete. | [optional] [readonly] +**ClientIdAlias** | Pointer to **string** | The value of the client's `client_id` property used in OAuth and OpenID Connect calls. By default, this is a string version of the `clientId` property. | [optional] +**ClientIdAliasEnabled** | Pointer to **bool** | Deprecated. Always set to `true`. | [optional] +**ClientType** | Pointer to [**ClientType**](ClientType.md) | | [optional] +**LogoUri** | Pointer to **string** | The URL pointing to the logo image of the client application. This property corresponds to `logo_uri` in [OpenID Connect Dynamic Client Registration 1.0, 2. Client Metadata](https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata). | [optional] +**LogoUris** | Pointer to [**[]TaggedValue**](TaggedValue.md) | Logo image URLs with language tags. If the client application has different logo images for different languages, this property can be used to register URLs of the images. | [optional] +**TosUri** | Pointer to **string** | The URL pointing to the \"Terms Of Service\" page. This property corresponds to `tos_uri` in [OpenID Connect Dynamic Client Registration 1.0, 2. Client Metadata](https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata). | [optional] +**TosUris** | Pointer to [**[]TaggedValue**](TaggedValue.md) | URLs of \"Terms Of Service\" pages with language tags. If the client application has different \"Terms Of Service\" pages for different languages, this property can be used to register the URLs. | [optional] +**PolicyUri** | Pointer to **string** | The URL pointing to the page which describes the policy as to how end-user's profile data is used. This property corresponds to `policy_uri` in [OpenID Connect Dynamic Client Registration 1.0, 2. Client Metadata](https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata). | [optional] +**PolicyUris** | Pointer to [**[]TaggedValue**](TaggedValue.md) | URLs of policy pages with language tags. If the client application has different policy pages for different languages, this property can be used to register the URLs. | [optional] + +## Methods + +### NewClientLimitedAuthorization + +`func NewClientLimitedAuthorization() *ClientLimitedAuthorization` + +NewClientLimitedAuthorization instantiates a new ClientLimitedAuthorization object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewClientLimitedAuthorizationWithDefaults + +`func NewClientLimitedAuthorizationWithDefaults() *ClientLimitedAuthorization` + +NewClientLimitedAuthorizationWithDefaults instantiates a new ClientLimitedAuthorization object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetNumber + +`func (o *ClientLimitedAuthorization) GetNumber() int32` + +GetNumber returns the Number field if non-nil, zero value otherwise. + +### GetNumberOk + +`func (o *ClientLimitedAuthorization) GetNumberOk() (*int32, bool)` + +GetNumberOk returns a tuple with the Number field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNumber + +`func (o *ClientLimitedAuthorization) SetNumber(v int32)` + +SetNumber sets Number field to given value. + +### HasNumber + +`func (o *ClientLimitedAuthorization) HasNumber() bool` + +HasNumber returns a boolean if a field has been set. + +### GetClientName + +`func (o *ClientLimitedAuthorization) GetClientName() string` + +GetClientName returns the ClientName field if non-nil, zero value otherwise. + +### GetClientNameOk + +`func (o *ClientLimitedAuthorization) GetClientNameOk() (*string, bool)` + +GetClientNameOk returns a tuple with the ClientName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientName + +`func (o *ClientLimitedAuthorization) SetClientName(v string)` + +SetClientName sets ClientName field to given value. + +### HasClientName + +`func (o *ClientLimitedAuthorization) HasClientName() bool` + +HasClientName returns a boolean if a field has been set. + +### GetClientNames + +`func (o *ClientLimitedAuthorization) GetClientNames() []TaggedValue` + +GetClientNames returns the ClientNames field if non-nil, zero value otherwise. + +### GetClientNamesOk + +`func (o *ClientLimitedAuthorization) GetClientNamesOk() (*[]TaggedValue, bool)` + +GetClientNamesOk returns a tuple with the ClientNames field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientNames + +`func (o *ClientLimitedAuthorization) SetClientNames(v []TaggedValue)` + +SetClientNames sets ClientNames field to given value. + +### HasClientNames + +`func (o *ClientLimitedAuthorization) HasClientNames() bool` + +HasClientNames returns a boolean if a field has been set. + +### GetDescription + +`func (o *ClientLimitedAuthorization) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ClientLimitedAuthorization) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ClientLimitedAuthorization) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ClientLimitedAuthorization) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetDescriptions + +`func (o *ClientLimitedAuthorization) GetDescriptions() []TaggedValue` + +GetDescriptions returns the Descriptions field if non-nil, zero value otherwise. + +### GetDescriptionsOk + +`func (o *ClientLimitedAuthorization) GetDescriptionsOk() (*[]TaggedValue, bool)` + +GetDescriptionsOk returns a tuple with the Descriptions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescriptions + +`func (o *ClientLimitedAuthorization) SetDescriptions(v []TaggedValue)` + +SetDescriptions sets Descriptions field to given value. + +### HasDescriptions + +`func (o *ClientLimitedAuthorization) HasDescriptions() bool` + +HasDescriptions returns a boolean if a field has been set. + +### GetClientId + +`func (o *ClientLimitedAuthorization) GetClientId() int64` + +GetClientId returns the ClientId field if non-nil, zero value otherwise. + +### GetClientIdOk + +`func (o *ClientLimitedAuthorization) GetClientIdOk() (*int64, bool)` + +GetClientIdOk returns a tuple with the ClientId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientId + +`func (o *ClientLimitedAuthorization) SetClientId(v int64)` + +SetClientId sets ClientId field to given value. + +### HasClientId + +`func (o *ClientLimitedAuthorization) HasClientId() bool` + +HasClientId returns a boolean if a field has been set. + +### GetClientIdAlias + +`func (o *ClientLimitedAuthorization) GetClientIdAlias() string` + +GetClientIdAlias returns the ClientIdAlias field if non-nil, zero value otherwise. + +### GetClientIdAliasOk + +`func (o *ClientLimitedAuthorization) GetClientIdAliasOk() (*string, bool)` + +GetClientIdAliasOk returns a tuple with the ClientIdAlias field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientIdAlias + +`func (o *ClientLimitedAuthorization) SetClientIdAlias(v string)` + +SetClientIdAlias sets ClientIdAlias field to given value. + +### HasClientIdAlias + +`func (o *ClientLimitedAuthorization) HasClientIdAlias() bool` + +HasClientIdAlias returns a boolean if a field has been set. + +### GetClientIdAliasEnabled + +`func (o *ClientLimitedAuthorization) GetClientIdAliasEnabled() bool` + +GetClientIdAliasEnabled returns the ClientIdAliasEnabled field if non-nil, zero value otherwise. + +### GetClientIdAliasEnabledOk + +`func (o *ClientLimitedAuthorization) GetClientIdAliasEnabledOk() (*bool, bool)` + +GetClientIdAliasEnabledOk returns a tuple with the ClientIdAliasEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientIdAliasEnabled + +`func (o *ClientLimitedAuthorization) SetClientIdAliasEnabled(v bool)` + +SetClientIdAliasEnabled sets ClientIdAliasEnabled field to given value. + +### HasClientIdAliasEnabled + +`func (o *ClientLimitedAuthorization) HasClientIdAliasEnabled() bool` + +HasClientIdAliasEnabled returns a boolean if a field has been set. + +### GetClientType + +`func (o *ClientLimitedAuthorization) GetClientType() ClientType` + +GetClientType returns the ClientType field if non-nil, zero value otherwise. + +### GetClientTypeOk + +`func (o *ClientLimitedAuthorization) GetClientTypeOk() (*ClientType, bool)` + +GetClientTypeOk returns a tuple with the ClientType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientType + +`func (o *ClientLimitedAuthorization) SetClientType(v ClientType)` + +SetClientType sets ClientType field to given value. + +### HasClientType + +`func (o *ClientLimitedAuthorization) HasClientType() bool` + +HasClientType returns a boolean if a field has been set. + +### GetLogoUri + +`func (o *ClientLimitedAuthorization) GetLogoUri() string` + +GetLogoUri returns the LogoUri field if non-nil, zero value otherwise. + +### GetLogoUriOk + +`func (o *ClientLimitedAuthorization) GetLogoUriOk() (*string, bool)` + +GetLogoUriOk returns a tuple with the LogoUri field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLogoUri + +`func (o *ClientLimitedAuthorization) SetLogoUri(v string)` + +SetLogoUri sets LogoUri field to given value. + +### HasLogoUri + +`func (o *ClientLimitedAuthorization) HasLogoUri() bool` + +HasLogoUri returns a boolean if a field has been set. + +### GetLogoUris + +`func (o *ClientLimitedAuthorization) GetLogoUris() []TaggedValue` + +GetLogoUris returns the LogoUris field if non-nil, zero value otherwise. + +### GetLogoUrisOk + +`func (o *ClientLimitedAuthorization) GetLogoUrisOk() (*[]TaggedValue, bool)` + +GetLogoUrisOk returns a tuple with the LogoUris field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLogoUris + +`func (o *ClientLimitedAuthorization) SetLogoUris(v []TaggedValue)` + +SetLogoUris sets LogoUris field to given value. + +### HasLogoUris + +`func (o *ClientLimitedAuthorization) HasLogoUris() bool` + +HasLogoUris returns a boolean if a field has been set. + +### GetTosUri + +`func (o *ClientLimitedAuthorization) GetTosUri() string` + +GetTosUri returns the TosUri field if non-nil, zero value otherwise. + +### GetTosUriOk + +`func (o *ClientLimitedAuthorization) GetTosUriOk() (*string, bool)` + +GetTosUriOk returns a tuple with the TosUri field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTosUri + +`func (o *ClientLimitedAuthorization) SetTosUri(v string)` + +SetTosUri sets TosUri field to given value. + +### HasTosUri + +`func (o *ClientLimitedAuthorization) HasTosUri() bool` + +HasTosUri returns a boolean if a field has been set. + +### GetTosUris + +`func (o *ClientLimitedAuthorization) GetTosUris() []TaggedValue` + +GetTosUris returns the TosUris field if non-nil, zero value otherwise. + +### GetTosUrisOk + +`func (o *ClientLimitedAuthorization) GetTosUrisOk() (*[]TaggedValue, bool)` + +GetTosUrisOk returns a tuple with the TosUris field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTosUris + +`func (o *ClientLimitedAuthorization) SetTosUris(v []TaggedValue)` + +SetTosUris sets TosUris field to given value. + +### HasTosUris + +`func (o *ClientLimitedAuthorization) HasTosUris() bool` + +HasTosUris returns a boolean if a field has been set. + +### GetPolicyUri + +`func (o *ClientLimitedAuthorization) GetPolicyUri() string` + +GetPolicyUri returns the PolicyUri field if non-nil, zero value otherwise. + +### GetPolicyUriOk + +`func (o *ClientLimitedAuthorization) GetPolicyUriOk() (*string, bool)` + +GetPolicyUriOk returns a tuple with the PolicyUri field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPolicyUri + +`func (o *ClientLimitedAuthorization) SetPolicyUri(v string)` + +SetPolicyUri sets PolicyUri field to given value. + +### HasPolicyUri + +`func (o *ClientLimitedAuthorization) HasPolicyUri() bool` + +HasPolicyUri returns a boolean if a field has been set. + +### GetPolicyUris + +`func (o *ClientLimitedAuthorization) GetPolicyUris() []TaggedValue` + +GetPolicyUris returns the PolicyUris field if non-nil, zero value otherwise. + +### GetPolicyUrisOk + +`func (o *ClientLimitedAuthorization) GetPolicyUrisOk() (*[]TaggedValue, bool)` + +GetPolicyUrisOk returns a tuple with the PolicyUris field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPolicyUris + +`func (o *ClientLimitedAuthorization) SetPolicyUris(v []TaggedValue)` + +SetPolicyUris sets PolicyUris field to given value. + +### HasPolicyUris + +`func (o *ClientLimitedAuthorization) HasPolicyUris() bool` + +HasPolicyUris returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ClientManagementApi.md b/docs/ClientManagementApi.md index 57a5076..55cc11c 100644 --- a/docs/ClientManagementApi.md +++ b/docs/ClientManagementApi.md @@ -1,30 +1,30 @@ # \ClientManagementApi -All URIs are relative to *https://api.authlete.com* +All URIs are relative to *https://beta.authlete.com* Method | HTTP request | Description ------------- | ------------- | ------------- -[**ClientAuthorizationDeleteApi**](ClientManagementApi.md#ClientAuthorizationDeleteApi) | **Delete** /api/client/authorization/delete/{clientId} | /api/client/authorization/delete/{clientId}/{subject} API -[**ClientAuthorizationGetListApi**](ClientManagementApi.md#ClientAuthorizationGetListApi) | **Get** /api/client/authorization/get/list | /api/client/authorization/get/list/{subject} API -[**ClientAuthorizationUpdateApi**](ClientManagementApi.md#ClientAuthorizationUpdateApi) | **Post** /api/client/authorization/update/{clientId} | /api/client/authorization/update/{clientId} API -[**ClientCreateApi**](ClientManagementApi.md#ClientCreateApi) | **Post** /api/client/create | /api/client/create API -[**ClientDeleteApi**](ClientManagementApi.md#ClientDeleteApi) | **Delete** /api/client/delete/{clientId} | /api/client/delete/{clientId} API -[**ClientFlagUpdateApi**](ClientManagementApi.md#ClientFlagUpdateApi) | **Post** /api/client/lock_flag/update/{clientIdentifier} | /api/client/lock_flag/update/{clientIdentifier} API -[**ClientGetApi**](ClientManagementApi.md#ClientGetApi) | **Get** /api/client/get/{clientId} | /api/client/get/{clientId} API -[**ClientGetListApi**](ClientManagementApi.md#ClientGetListApi) | **Get** /api/client/get/list | /api/client/get/list API -[**ClientGrantedScopesDeleteApi**](ClientManagementApi.md#ClientGrantedScopesDeleteApi) | **Delete** /api/client/granted_scopes/delete/{clientId} | /api/client/granted_scopes/delete/{clientId}/{subject} API -[**ClientGrantedScopesGetApi**](ClientManagementApi.md#ClientGrantedScopesGetApi) | **Get** /api/client/granted_scopes/get/{clientId} | /api/client/granted_scopes/get/{clientId}/{subject} API -[**ClientSecretRefreshApi**](ClientManagementApi.md#ClientSecretRefreshApi) | **Get** /api/client/secret/refresh/{clientIdentifier} | /api/client/secret/refresh API -[**ClientSecretUpdateApi**](ClientManagementApi.md#ClientSecretUpdateApi) | **Post** /api/client/secret/update/{clientIdentifier} | /api/client/secret/update API -[**ClientUpdateApi**](ClientManagementApi.md#ClientUpdateApi) | **Post** /api/client/update/{clientId} | /api/client/update/{clientId} API +[**ClientAuthorizationDeleteApi**](ClientManagementApi.md#ClientAuthorizationDeleteApi) | **Delete** /api/{serviceId}/client/authorization/delete/{clientId} | /api/{serviceId}/client/authorization/delete/{clientId}/{subject} API +[**ClientAuthorizationGetListApi**](ClientManagementApi.md#ClientAuthorizationGetListApi) | **Get** /api/{serviceId}/client/authorization/get/list | /api/{serviceId}/client/authorization/get/list/{subject} API +[**ClientAuthorizationUpdateApi**](ClientManagementApi.md#ClientAuthorizationUpdateApi) | **Post** /api/{serviceId}/client/authorization/update/{clientId} | /api/{serviceId}/client/authorization/update/{clientId} API +[**ClientCreateApi**](ClientManagementApi.md#ClientCreateApi) | **Post** /api/{serviceId}/client/create | /api/{serviceId}/client/create API +[**ClientDeleteApi**](ClientManagementApi.md#ClientDeleteApi) | **Delete** /api/{serviceId}/client/delete/{clientId} | /api/{serviceId}/client/delete/{clientId} API +[**ClientFlagUpdateApi**](ClientManagementApi.md#ClientFlagUpdateApi) | **Post** /api/{serviceId}/client/lock_flag/update/{clientIdentifier} | /api/{serviceId}/client/lock_flag/update/{clientIdentifier} API +[**ClientGetApi**](ClientManagementApi.md#ClientGetApi) | **Get** /api/{serviceId}/client/get/{clientId} | /api/{serviceId}/client/get/{clientId} API +[**ClientGetListApi**](ClientManagementApi.md#ClientGetListApi) | **Get** /api/{serviceId}/client/get/list | /api/{serviceId}/client/get/list API +[**ClientGrantedScopesDeleteApi**](ClientManagementApi.md#ClientGrantedScopesDeleteApi) | **Delete** /api/{serviceId}/client/granted_scopes/delete/{clientId} | /api/{serviceId}/client/granted_scopes/delete/{clientId}/{subject} API +[**ClientGrantedScopesGetApi**](ClientManagementApi.md#ClientGrantedScopesGetApi) | **Get** /api/{serviceId}/client/granted_scopes/get/{clientId} | /api/{serviceId}/client/granted_scopes/get/{clientId}/{subject} API +[**ClientSecretRefreshApi**](ClientManagementApi.md#ClientSecretRefreshApi) | **Get** /api/{serviceId}/client/secret/refresh/{clientIdentifier} | /api/{serviceId}/client/secret/refresh API +[**ClientSecretUpdateApi**](ClientManagementApi.md#ClientSecretUpdateApi) | **Post** /api/{serviceId}/client/secret/update/{clientIdentifier} | /api/{serviceId}/client/secret/update API +[**ClientUpdateApi**](ClientManagementApi.md#ClientUpdateApi) | **Post** /api/{serviceId}/client/update/{clientId} | /api/{serviceId}/client/update/{clientId} API ## ClientAuthorizationDeleteApi -> ClientAuthorizationDeleteResponse ClientAuthorizationDeleteApi(ctx, clientId, subject).Subject2(subject2).Execute() +> ClientAuthorizationDeleteResponse ClientAuthorizationDeleteApi(ctx, serviceId, clientId, subject).Subject2(subject2).Execute() -/api/client/authorization/delete/{clientId}/{subject} API +/api/{serviceId}/client/authorization/delete/{clientId}/{subject} API @@ -41,13 +41,14 @@ import ( ) func main() { + serviceId := "serviceId_example" // string | A service ID. clientId := "clientId_example" // string | A client ID. subject := "subject_example" // string | Unique user ID of an end-user. subject2 := "subject_example" // string | Unique user ID of an end-user. configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.ClientManagementApi.ClientAuthorizationDeleteApi(context.Background(), clientId, subject).Subject2(subject2).Execute() + resp, r, err := apiClient.ClientManagementApi.ClientAuthorizationDeleteApi(context.Background(), serviceId, clientId, subject).Subject2(subject2).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ClientManagementApi.ClientAuthorizationDeleteApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -63,6 +64,7 @@ func main() { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | **clientId** | **string** | A client ID. | **subject** | **string** | Unique user ID of an end-user. | @@ -75,6 +77,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **subject2** | **string** | Unique user ID of an end-user. | ### Return type @@ -83,7 +86,7 @@ Name | Type | Description | Notes ### Authorization -[ServiceCredentials](../README.md#ServiceCredentials) +[ModifyClient](../README.md#ModifyClient) ### HTTP request headers @@ -97,9 +100,9 @@ Name | Type | Description | Notes ## ClientAuthorizationGetListApi -> ClientAuthorizationGetListResponse ClientAuthorizationGetListApi(ctx, subject).Subject2(subject2).Developer(developer).Start(start).End(end).Execute() +> ClientAuthorizationGetListResponse ClientAuthorizationGetListApi(ctx, serviceId, subject).Subject2(subject2).Developer(developer).Start(start).End(end).Execute() -/api/client/authorization/get/list/{subject} API +/api/{serviceId}/client/authorization/get/list/{subject} API @@ -116,6 +119,7 @@ import ( ) func main() { + serviceId := "serviceId_example" // string | A service ID. subject := "subject_example" // string | Unique user ID of an end-user. subject2 := "subject_example" // string | Unique user ID of an end-user. developer := "developer_example" // string | Unique ID of a client developer. (optional) @@ -124,7 +128,7 @@ func main() { configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.ClientManagementApi.ClientAuthorizationGetListApi(context.Background(), subject).Subject2(subject2).Developer(developer).Start(start).End(end).Execute() + resp, r, err := apiClient.ClientManagementApi.ClientAuthorizationGetListApi(context.Background(), serviceId, subject).Subject2(subject2).Developer(developer).Start(start).End(end).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ClientManagementApi.ClientAuthorizationGetListApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -140,6 +144,7 @@ func main() { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | **subject** | **string** | Unique user ID of an end-user. | ### Other Parameters @@ -150,6 +155,7 @@ Other parameters are passed through a pointer to a apiClientAuthorizationGetList Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **subject2** | **string** | Unique user ID of an end-user. | **developer** | **string** | Unique ID of a client developer. | **start** | **int32** | Start index of search results (inclusive). The default value is 0. | @@ -161,7 +167,7 @@ Name | Type | Description | Notes ### Authorization -[ServiceCredentials](../README.md#ServiceCredentials) +[ModifyClient](../README.md#ModifyClient) ### HTTP request headers @@ -175,9 +181,9 @@ Name | Type | Description | Notes ## ClientAuthorizationUpdateApi -> ClientAuthorizationUpdateResponse ClientAuthorizationUpdateApi(ctx, clientId).ClientAuthorizationUpdateRequest(clientAuthorizationUpdateRequest).Execute() +> ClientAuthorizationUpdateResponse ClientAuthorizationUpdateApi(ctx, serviceId, clientId).ClientAuthorizationUpdateRequest(clientAuthorizationUpdateRequest).Execute() -/api/client/authorization/update/{clientId} API +/api/{serviceId}/client/authorization/update/{clientId} API @@ -194,12 +200,13 @@ import ( ) func main() { + serviceId := "serviceId_example" // string | A service ID. clientId := "clientId_example" // string | A client ID. clientAuthorizationUpdateRequest := *openapiclient.NewClientAuthorizationUpdateRequest("Subject_example") // ClientAuthorizationUpdateRequest | (optional) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.ClientManagementApi.ClientAuthorizationUpdateApi(context.Background(), clientId).ClientAuthorizationUpdateRequest(clientAuthorizationUpdateRequest).Execute() + resp, r, err := apiClient.ClientManagementApi.ClientAuthorizationUpdateApi(context.Background(), serviceId, clientId).ClientAuthorizationUpdateRequest(clientAuthorizationUpdateRequest).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ClientManagementApi.ClientAuthorizationUpdateApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -215,6 +222,7 @@ func main() { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | **clientId** | **string** | A client ID. | ### Other Parameters @@ -225,6 +233,7 @@ Other parameters are passed through a pointer to a apiClientAuthorizationUpdateA Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **clientAuthorizationUpdateRequest** | [**ClientAuthorizationUpdateRequest**](ClientAuthorizationUpdateRequest.md) | | ### Return type @@ -233,7 +242,7 @@ Name | Type | Description | Notes ### Authorization -[ServiceCredentials](../README.md#ServiceCredentials) +[ModifyClient](../README.md#ModifyClient) ### HTTP request headers @@ -247,9 +256,9 @@ Name | Type | Description | Notes ## ClientCreateApi -> Client ClientCreateApi(ctx).Client(client).Execute() +> Client ClientCreateApi(ctx, serviceId).Client(client).Execute() -/api/client/create API +/api/{serviceId}/client/create API @@ -266,11 +275,12 @@ import ( ) func main() { + serviceId := "serviceId_example" // string | A service ID. client := *openapiclient.NewClient() // Client | (optional) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.ClientManagementApi.ClientCreateApi(context.Background()).Client(client).Execute() + resp, r, err := apiClient.ClientManagementApi.ClientCreateApi(context.Background(), serviceId).Client(client).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ClientManagementApi.ClientCreateApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -283,6 +293,10 @@ func main() { ### Path Parameters +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | ### Other Parameters @@ -291,6 +305,7 @@ Other parameters are passed through a pointer to a apiClientCreateApiRequest str Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **client** | [**Client**](Client.md) | | ### Return type @@ -299,7 +314,7 @@ Name | Type | Description | Notes ### Authorization -[ServiceCredentials](../README.md#ServiceCredentials) +[CreateClient](../README.md#CreateClient) ### HTTP request headers @@ -313,9 +328,9 @@ Name | Type | Description | Notes ## ClientDeleteApi -> ClientDeleteApi(ctx, clientId).Execute() +> ClientDeleteApi(ctx, serviceId, clientId).Execute() -/api/client/delete/{clientId} API +/api/{serviceId}/client/delete/{clientId} API @@ -332,11 +347,12 @@ import ( ) func main() { + serviceId := "serviceId_example" // string | A service ID. clientId := "clientId_example" // string | The client ID. configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.ClientManagementApi.ClientDeleteApi(context.Background(), clientId).Execute() + resp, r, err := apiClient.ClientManagementApi.ClientDeleteApi(context.Background(), serviceId, clientId).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ClientManagementApi.ClientDeleteApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -350,6 +366,7 @@ func main() { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | **clientId** | **string** | The client ID. | ### Other Parameters @@ -361,13 +378,14 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + ### Return type (empty response body) ### Authorization -[ServiceCredentials](../README.md#ServiceCredentials) +[ModifyClient](../README.md#ModifyClient) ### HTTP request headers @@ -381,9 +399,9 @@ Name | Type | Description | Notes ## ClientFlagUpdateApi -> ClientFlagUpdateResponse ClientFlagUpdateApi(ctx, clientIdentifier).ClientFlagUpdateRequest(clientFlagUpdateRequest).Execute() +> ClientFlagUpdateResponse ClientFlagUpdateApi(ctx, serviceId, clientIdentifier).ClientFlagUpdateRequest(clientFlagUpdateRequest).Execute() -/api/client/lock_flag/update/{clientIdentifier} API +/api/{serviceId}/client/lock_flag/update/{clientIdentifier} API @@ -400,12 +418,13 @@ import ( ) func main() { + serviceId := "serviceId_example" // string | A service ID. clientIdentifier := "clientIdentifier_example" // string | A client ID. clientFlagUpdateRequest := *openapiclient.NewClientFlagUpdateRequest(false) // ClientFlagUpdateRequest | (optional) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.ClientManagementApi.ClientFlagUpdateApi(context.Background(), clientIdentifier).ClientFlagUpdateRequest(clientFlagUpdateRequest).Execute() + resp, r, err := apiClient.ClientManagementApi.ClientFlagUpdateApi(context.Background(), serviceId, clientIdentifier).ClientFlagUpdateRequest(clientFlagUpdateRequest).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ClientManagementApi.ClientFlagUpdateApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -421,6 +440,7 @@ func main() { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | **clientIdentifier** | **string** | A client ID. | ### Other Parameters @@ -431,6 +451,7 @@ Other parameters are passed through a pointer to a apiClientFlagUpdateApiRequest Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **clientFlagUpdateRequest** | [**ClientFlagUpdateRequest**](ClientFlagUpdateRequest.md) | | ### Return type @@ -439,7 +460,7 @@ Name | Type | Description | Notes ### Authorization -[ServiceCredentials](../README.md#ServiceCredentials) +[ModifyClient](../README.md#ModifyClient) ### HTTP request headers @@ -453,9 +474,9 @@ Name | Type | Description | Notes ## ClientGetApi -> Client ClientGetApi(ctx, clientId).Execute() +> Client ClientGetApi(ctx, serviceId, clientId).Execute() -/api/client/get/{clientId} API +/api/{serviceId}/client/get/{clientId} API @@ -472,11 +493,12 @@ import ( ) func main() { + serviceId := "serviceId_example" // string | A service ID. clientId := "clientId_example" // string | A client ID. configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.ClientManagementApi.ClientGetApi(context.Background(), clientId).Execute() + resp, r, err := apiClient.ClientManagementApi.ClientGetApi(context.Background(), serviceId, clientId).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ClientManagementApi.ClientGetApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -492,6 +514,7 @@ func main() { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | **clientId** | **string** | A client ID. | ### Other Parameters @@ -503,13 +526,14 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + ### Return type [**Client**](Client.md) ### Authorization -[ServiceCredentials](../README.md#ServiceCredentials) +[ViewClient](../README.md#ViewClient) ### HTTP request headers @@ -523,9 +547,9 @@ Name | Type | Description | Notes ## ClientGetListApi -> ClientGetListResponse ClientGetListApi(ctx).Developer(developer).Start(start).End(end).Execute() +> ClientGetListApi200Response ClientGetListApi(ctx, serviceId).Developer(developer).Start(start).End(end).Execute() -/api/client/get/list API +/api/{serviceId}/client/get/list API @@ -542,18 +566,19 @@ import ( ) func main() { + serviceId := "serviceId_example" // string | A service ID. developer := "developer_example" // string | The developer of client applications. The default value is null. If this parameter is not set to `null`, client application of the specified developer are returned. Otherwise, all client applications that belong to the service are returned. (optional) start := int32(56) // int32 | Start index (inclusive) of the result set. The default value is 0. Must not be a negative number. (optional) end := int32(56) // int32 | End index (exclusive) of the result set. The default value is 5. Must not be a negative number. (optional) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.ClientManagementApi.ClientGetListApi(context.Background()).Developer(developer).Start(start).End(end).Execute() + resp, r, err := apiClient.ClientManagementApi.ClientGetListApi(context.Background(), serviceId).Developer(developer).Start(start).End(end).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ClientManagementApi.ClientGetListApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } - // response from `ClientGetListApi`: ClientGetListResponse + // response from `ClientGetListApi`: ClientGetListApi200Response fmt.Fprintf(os.Stdout, "Response from `ClientManagementApi.ClientGetListApi`: %v\n", resp) } ``` @@ -561,6 +586,10 @@ func main() { ### Path Parameters +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | ### Other Parameters @@ -569,17 +598,18 @@ Other parameters are passed through a pointer to a apiClientGetListApiRequest st Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **developer** | **string** | The developer of client applications. The default value is null. If this parameter is not set to `null`, client application of the specified developer are returned. Otherwise, all client applications that belong to the service are returned. | **start** | **int32** | Start index (inclusive) of the result set. The default value is 0. Must not be a negative number. | **end** | **int32** | End index (exclusive) of the result set. The default value is 5. Must not be a negative number. | ### Return type -[**ClientGetListResponse**](ClientGetListResponse.md) +[**ClientGetListApi200Response**](ClientGetListApi200Response.md) ### Authorization -[ServiceCredentials](../README.md#ServiceCredentials) +[ViewClient](../README.md#ViewClient), [ViewService](../README.md#ViewService) ### HTTP request headers @@ -593,9 +623,9 @@ Name | Type | Description | Notes ## ClientGrantedScopesDeleteApi -> ClientGrantedScopesDeleteResponse ClientGrantedScopesDeleteApi(ctx, clientId, subject).Subject2(subject2).Execute() +> ClientGrantedScopesDeleteResponse ClientGrantedScopesDeleteApi(ctx, serviceId, clientId, subject).Subject2(subject2).Execute() -/api/client/granted_scopes/delete/{clientId}/{subject} API +/api/{serviceId}/client/granted_scopes/delete/{clientId}/{subject} API @@ -612,13 +642,14 @@ import ( ) func main() { + serviceId := "serviceId_example" // string | A service ID. clientId := "clientId_example" // string | A client ID. subject := "subject_example" // string | Unique user ID of an end-user. subject2 := "subject_example" // string | Unique user ID of an end-user. configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.ClientManagementApi.ClientGrantedScopesDeleteApi(context.Background(), clientId, subject).Subject2(subject2).Execute() + resp, r, err := apiClient.ClientManagementApi.ClientGrantedScopesDeleteApi(context.Background(), serviceId, clientId, subject).Subject2(subject2).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ClientManagementApi.ClientGrantedScopesDeleteApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -634,6 +665,7 @@ func main() { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | **clientId** | **string** | A client ID. | **subject** | **string** | Unique user ID of an end-user. | @@ -646,6 +678,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **subject2** | **string** | Unique user ID of an end-user. | ### Return type @@ -654,7 +687,7 @@ Name | Type | Description | Notes ### Authorization -[ServiceCredentials](../README.md#ServiceCredentials) +[ModifyClient](../README.md#ModifyClient) ### HTTP request headers @@ -668,9 +701,9 @@ Name | Type | Description | Notes ## ClientGrantedScopesGetApi -> ClientGrantedScopesGetResponse ClientGrantedScopesGetApi(ctx, clientId, subject).Subject2(subject2).Execute() +> ClientAuthorizationDeleteResponse ClientGrantedScopesGetApi(ctx, serviceId, clientId, subject).Subject2(subject2).Execute() -/api/client/granted_scopes/get/{clientId}/{subject} API +/api/{serviceId}/client/granted_scopes/get/{clientId}/{subject} API @@ -687,18 +720,19 @@ import ( ) func main() { + serviceId := "serviceId_example" // string | A service ID. clientId := "clientId_example" // string | A client ID. subject := "subject_example" // string | Unique user ID of an end-user. subject2 := "subject_example" // string | Unique user ID of an end-user. configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.ClientManagementApi.ClientGrantedScopesGetApi(context.Background(), clientId, subject).Subject2(subject2).Execute() + resp, r, err := apiClient.ClientManagementApi.ClientGrantedScopesGetApi(context.Background(), serviceId, clientId, subject).Subject2(subject2).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ClientManagementApi.ClientGrantedScopesGetApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } - // response from `ClientGrantedScopesGetApi`: ClientGrantedScopesGetResponse + // response from `ClientGrantedScopesGetApi`: ClientAuthorizationDeleteResponse fmt.Fprintf(os.Stdout, "Response from `ClientManagementApi.ClientGrantedScopesGetApi`: %v\n", resp) } ``` @@ -709,6 +743,7 @@ func main() { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | **clientId** | **string** | A client ID. | **subject** | **string** | Unique user ID of an end-user. | @@ -721,15 +756,16 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **subject2** | **string** | Unique user ID of an end-user. | ### Return type -[**ClientGrantedScopesGetResponse**](ClientGrantedScopesGetResponse.md) +[**ClientAuthorizationDeleteResponse**](ClientAuthorizationDeleteResponse.md) ### Authorization -[ServiceCredentials](../README.md#ServiceCredentials) +[ViewClient](../README.md#ViewClient) ### HTTP request headers @@ -743,9 +779,9 @@ Name | Type | Description | Notes ## ClientSecretRefreshApi -> ClientSecretRefreshResponse ClientSecretRefreshApi(ctx, clientIdentifier).Execute() +> ClientSecretRefreshResponse ClientSecretRefreshApi(ctx, serviceId, clientIdentifier).Execute() -/api/client/secret/refresh API +/api/{serviceId}/client/secret/refresh API @@ -762,11 +798,12 @@ import ( ) func main() { + serviceId := "serviceId_example" // string | A service ID. clientIdentifier := "clientIdentifier_example" // string | The client ID or the client ID alias of a client. configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.ClientManagementApi.ClientSecretRefreshApi(context.Background(), clientIdentifier).Execute() + resp, r, err := apiClient.ClientManagementApi.ClientSecretRefreshApi(context.Background(), serviceId, clientIdentifier).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ClientManagementApi.ClientSecretRefreshApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -782,6 +819,7 @@ func main() { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | **clientIdentifier** | **string** | The client ID or the client ID alias of a client. | ### Other Parameters @@ -793,13 +831,14 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + ### Return type [**ClientSecretRefreshResponse**](ClientSecretRefreshResponse.md) ### Authorization -[ServiceCredentials](../README.md#ServiceCredentials) +[ModifyClient](../README.md#ModifyClient) ### HTTP request headers @@ -813,9 +852,9 @@ Name | Type | Description | Notes ## ClientSecretUpdateApi -> ClientSecretUpdateResponse ClientSecretUpdateApi(ctx, clientIdentifier).ClientSecretUpdateRequest(clientSecretUpdateRequest).Execute() +> ClientSecretUpdateResponse ClientSecretUpdateApi(ctx, serviceId, clientIdentifier).ClientSecretUpdateRequest(clientSecretUpdateRequest).Execute() -/api/client/secret/update API +/api/{serviceId}/client/secret/update API @@ -832,12 +871,13 @@ import ( ) func main() { + serviceId := "serviceId_example" // string | A service ID. clientIdentifier := "clientIdentifier_example" // string | The client ID or the client ID alias of a client. clientSecretUpdateRequest := *openapiclient.NewClientSecretUpdateRequest("ClientSecret_example") // ClientSecretUpdateRequest | configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.ClientManagementApi.ClientSecretUpdateApi(context.Background(), clientIdentifier).ClientSecretUpdateRequest(clientSecretUpdateRequest).Execute() + resp, r, err := apiClient.ClientManagementApi.ClientSecretUpdateApi(context.Background(), serviceId, clientIdentifier).ClientSecretUpdateRequest(clientSecretUpdateRequest).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ClientManagementApi.ClientSecretUpdateApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -853,6 +893,7 @@ func main() { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | **clientIdentifier** | **string** | The client ID or the client ID alias of a client. | ### Other Parameters @@ -863,6 +904,7 @@ Other parameters are passed through a pointer to a apiClientSecretUpdateApiReque Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **clientSecretUpdateRequest** | [**ClientSecretUpdateRequest**](ClientSecretUpdateRequest.md) | | ### Return type @@ -871,7 +913,7 @@ Name | Type | Description | Notes ### Authorization -[ServiceCredentials](../README.md#ServiceCredentials) +No authorization required ### HTTP request headers @@ -885,9 +927,9 @@ Name | Type | Description | Notes ## ClientUpdateApi -> Client ClientUpdateApi(ctx, clientId).Client(client).Execute() +> Client ClientUpdateApi(ctx, serviceId, clientId).Client(client).Execute() -/api/client/update/{clientId} API +/api/{serviceId}/client/update/{clientId} API @@ -904,12 +946,13 @@ import ( ) func main() { + serviceId := "serviceId_example" // string | A service ID. clientId := "clientId_example" // string | A client ID. client := *openapiclient.NewClient() // Client | (optional) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.ClientManagementApi.ClientUpdateApi(context.Background(), clientId).Client(client).Execute() + resp, r, err := apiClient.ClientManagementApi.ClientUpdateApi(context.Background(), serviceId, clientId).Client(client).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ClientManagementApi.ClientUpdateApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -925,6 +968,7 @@ func main() { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | **clientId** | **string** | A client ID. | ### Other Parameters @@ -935,6 +979,7 @@ Other parameters are passed through a pointer to a apiClientUpdateApiRequest str Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **client** | [**Client**](Client.md) | | ### Return type @@ -943,7 +988,7 @@ Name | Type | Description | Notes ### Authorization -[ServiceCredentials](../README.md#ServiceCredentials) +[ModifyClient](../README.md#ModifyClient) ### HTTP request headers diff --git a/docs/ConfigurationEndpointApi.md b/docs/ConfigurationEndpointApi.md index b1d89b2..24a9a48 100644 --- a/docs/ConfigurationEndpointApi.md +++ b/docs/ConfigurationEndpointApi.md @@ -1,18 +1,18 @@ # \ConfigurationEndpointApi -All URIs are relative to *https://api.authlete.com* +All URIs are relative to *https://beta.authlete.com* Method | HTTP request | Description ------------- | ------------- | ------------- -[**ServiceConfigurationApi**](ConfigurationEndpointApi.md#ServiceConfigurationApi) | **Get** /api/service/configuration | /api/service/configuration API +[**ServiceConfigurationApi**](ConfigurationEndpointApi.md#ServiceConfigurationApi) | **Get** /api/{serviceId}/service/configuration | /api/{serviceId}/service/configuration API ## ServiceConfigurationApi -> map[string]interface{} ServiceConfigurationApi(ctx).Pretty(pretty).Patch(patch).Execute() +> map[string]interface{} ServiceConfigurationApi(ctx, serviceId).Pretty(pretty).Patch(patch).Execute() -/api/service/configuration API +/api/{serviceId}/service/configuration API @@ -29,12 +29,13 @@ import ( ) func main() { + serviceId := "serviceId_example" // string | A service ID. pretty := true // bool | This boolean value indicates whether the JSON in the response should be formatted or not. If `true`, the JSON in the response is pretty-formatted. The default value is `false`. (optional) patch := "patch_example" // string | Get the JSON Patch [RFC 6902 JavaScript Object Notation (JSON) Patch](https://www.rfc-editor.org/rfc/rfc6902) to be applied. (optional) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.ConfigurationEndpointApi.ServiceConfigurationApi(context.Background()).Pretty(pretty).Patch(patch).Execute() + resp, r, err := apiClient.ConfigurationEndpointApi.ServiceConfigurationApi(context.Background(), serviceId).Pretty(pretty).Patch(patch).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationEndpointApi.ServiceConfigurationApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -47,6 +48,10 @@ func main() { ### Path Parameters +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | ### Other Parameters @@ -55,6 +60,7 @@ Other parameters are passed through a pointer to a apiServiceConfigurationApiReq Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **pretty** | **bool** | This boolean value indicates whether the JSON in the response should be formatted or not. If `true`, the JSON in the response is pretty-formatted. The default value is `false`. | **patch** | **string** | Get the JSON Patch [RFC 6902 JavaScript Object Notation (JSON) Patch](https://www.rfc-editor.org/rfc/rfc6902) to be applied. | @@ -64,7 +70,7 @@ Name | Type | Description | Notes ### Authorization -[ServiceCredentials](../README.md#ServiceCredentials) +[UseService](../README.md#UseService) ### HTTP request headers diff --git a/docs/CredentialIssuanceOrder.md b/docs/CredentialIssuanceOrder.md new file mode 100644 index 0000000..80fa250 --- /dev/null +++ b/docs/CredentialIssuanceOrder.md @@ -0,0 +1,160 @@ +# CredentialIssuanceOrder + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestIdentifier** | Pointer to **string** | The identifier of a credential request. | [optional] +**CredentialPayload** | Pointer to **string** | The additional payload that will be added into a credential to be issued. | [optional] +**IssuanceDeferred** | Pointer to **bool** | The flag indicating whether to defer credential issuance. | [optional] +**CredentialDuration** | Pointer to **int64** | The duration of a credential to be issued. | [optional] +**SigningKeyId** | Pointer to **string** | The key ID of a private key that should be used for signing a credential to be issued. | [optional] + +## Methods + +### NewCredentialIssuanceOrder + +`func NewCredentialIssuanceOrder() *CredentialIssuanceOrder` + +NewCredentialIssuanceOrder instantiates a new CredentialIssuanceOrder object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCredentialIssuanceOrderWithDefaults + +`func NewCredentialIssuanceOrderWithDefaults() *CredentialIssuanceOrder` + +NewCredentialIssuanceOrderWithDefaults instantiates a new CredentialIssuanceOrder object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetRequestIdentifier + +`func (o *CredentialIssuanceOrder) GetRequestIdentifier() string` + +GetRequestIdentifier returns the RequestIdentifier field if non-nil, zero value otherwise. + +### GetRequestIdentifierOk + +`func (o *CredentialIssuanceOrder) GetRequestIdentifierOk() (*string, bool)` + +GetRequestIdentifierOk returns a tuple with the RequestIdentifier field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestIdentifier + +`func (o *CredentialIssuanceOrder) SetRequestIdentifier(v string)` + +SetRequestIdentifier sets RequestIdentifier field to given value. + +### HasRequestIdentifier + +`func (o *CredentialIssuanceOrder) HasRequestIdentifier() bool` + +HasRequestIdentifier returns a boolean if a field has been set. + +### GetCredentialPayload + +`func (o *CredentialIssuanceOrder) GetCredentialPayload() string` + +GetCredentialPayload returns the CredentialPayload field if non-nil, zero value otherwise. + +### GetCredentialPayloadOk + +`func (o *CredentialIssuanceOrder) GetCredentialPayloadOk() (*string, bool)` + +GetCredentialPayloadOk returns a tuple with the CredentialPayload field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCredentialPayload + +`func (o *CredentialIssuanceOrder) SetCredentialPayload(v string)` + +SetCredentialPayload sets CredentialPayload field to given value. + +### HasCredentialPayload + +`func (o *CredentialIssuanceOrder) HasCredentialPayload() bool` + +HasCredentialPayload returns a boolean if a field has been set. + +### GetIssuanceDeferred + +`func (o *CredentialIssuanceOrder) GetIssuanceDeferred() bool` + +GetIssuanceDeferred returns the IssuanceDeferred field if non-nil, zero value otherwise. + +### GetIssuanceDeferredOk + +`func (o *CredentialIssuanceOrder) GetIssuanceDeferredOk() (*bool, bool)` + +GetIssuanceDeferredOk returns a tuple with the IssuanceDeferred field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIssuanceDeferred + +`func (o *CredentialIssuanceOrder) SetIssuanceDeferred(v bool)` + +SetIssuanceDeferred sets IssuanceDeferred field to given value. + +### HasIssuanceDeferred + +`func (o *CredentialIssuanceOrder) HasIssuanceDeferred() bool` + +HasIssuanceDeferred returns a boolean if a field has been set. + +### GetCredentialDuration + +`func (o *CredentialIssuanceOrder) GetCredentialDuration() int64` + +GetCredentialDuration returns the CredentialDuration field if non-nil, zero value otherwise. + +### GetCredentialDurationOk + +`func (o *CredentialIssuanceOrder) GetCredentialDurationOk() (*int64, bool)` + +GetCredentialDurationOk returns a tuple with the CredentialDuration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCredentialDuration + +`func (o *CredentialIssuanceOrder) SetCredentialDuration(v int64)` + +SetCredentialDuration sets CredentialDuration field to given value. + +### HasCredentialDuration + +`func (o *CredentialIssuanceOrder) HasCredentialDuration() bool` + +HasCredentialDuration returns a boolean if a field has been set. + +### GetSigningKeyId + +`func (o *CredentialIssuanceOrder) GetSigningKeyId() string` + +GetSigningKeyId returns the SigningKeyId field if non-nil, zero value otherwise. + +### GetSigningKeyIdOk + +`func (o *CredentialIssuanceOrder) GetSigningKeyIdOk() (*string, bool)` + +GetSigningKeyIdOk returns a tuple with the SigningKeyId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSigningKeyId + +`func (o *CredentialIssuanceOrder) SetSigningKeyId(v string)` + +SetSigningKeyId sets SigningKeyId field to given value. + +### HasSigningKeyId + +`func (o *CredentialIssuanceOrder) HasSigningKeyId() bool` + +HasSigningKeyId returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CredentialIssuerMetadata.md b/docs/CredentialIssuerMetadata.md new file mode 100644 index 0000000..13bb735 --- /dev/null +++ b/docs/CredentialIssuerMetadata.md @@ -0,0 +1,186 @@ +# CredentialIssuerMetadata + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CredentialIssuer** | Pointer to **string** | The identifier of a credential request. | [optional] +**AuthorizationServer** | Pointer to **string** | The identifier of the authorization server that the credential issuer relies on for authorization. | [optional] +**CredentialEndpoint** | Pointer to **bool** | The URL of the credential endpoint of the credential issuer. | [optional] +**BatchCredentialEndpoint** | Pointer to **int64** | The URL of the batch credential endpoint of the credential issuer. | [optional] +**DeferredCredentialEndpoint** | Pointer to **string** | The URL of the deferred credential endpoint of the credential issuer. | [optional] +**CredentialsSupported** | Pointer to **bool** | A JSON array describing supported credentials. | [optional] + +## Methods + +### NewCredentialIssuerMetadata + +`func NewCredentialIssuerMetadata() *CredentialIssuerMetadata` + +NewCredentialIssuerMetadata instantiates a new CredentialIssuerMetadata object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCredentialIssuerMetadataWithDefaults + +`func NewCredentialIssuerMetadataWithDefaults() *CredentialIssuerMetadata` + +NewCredentialIssuerMetadataWithDefaults instantiates a new CredentialIssuerMetadata object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCredentialIssuer + +`func (o *CredentialIssuerMetadata) GetCredentialIssuer() string` + +GetCredentialIssuer returns the CredentialIssuer field if non-nil, zero value otherwise. + +### GetCredentialIssuerOk + +`func (o *CredentialIssuerMetadata) GetCredentialIssuerOk() (*string, bool)` + +GetCredentialIssuerOk returns a tuple with the CredentialIssuer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCredentialIssuer + +`func (o *CredentialIssuerMetadata) SetCredentialIssuer(v string)` + +SetCredentialIssuer sets CredentialIssuer field to given value. + +### HasCredentialIssuer + +`func (o *CredentialIssuerMetadata) HasCredentialIssuer() bool` + +HasCredentialIssuer returns a boolean if a field has been set. + +### GetAuthorizationServer + +`func (o *CredentialIssuerMetadata) GetAuthorizationServer() string` + +GetAuthorizationServer returns the AuthorizationServer field if non-nil, zero value otherwise. + +### GetAuthorizationServerOk + +`func (o *CredentialIssuerMetadata) GetAuthorizationServerOk() (*string, bool)` + +GetAuthorizationServerOk returns a tuple with the AuthorizationServer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthorizationServer + +`func (o *CredentialIssuerMetadata) SetAuthorizationServer(v string)` + +SetAuthorizationServer sets AuthorizationServer field to given value. + +### HasAuthorizationServer + +`func (o *CredentialIssuerMetadata) HasAuthorizationServer() bool` + +HasAuthorizationServer returns a boolean if a field has been set. + +### GetCredentialEndpoint + +`func (o *CredentialIssuerMetadata) GetCredentialEndpoint() bool` + +GetCredentialEndpoint returns the CredentialEndpoint field if non-nil, zero value otherwise. + +### GetCredentialEndpointOk + +`func (o *CredentialIssuerMetadata) GetCredentialEndpointOk() (*bool, bool)` + +GetCredentialEndpointOk returns a tuple with the CredentialEndpoint field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCredentialEndpoint + +`func (o *CredentialIssuerMetadata) SetCredentialEndpoint(v bool)` + +SetCredentialEndpoint sets CredentialEndpoint field to given value. + +### HasCredentialEndpoint + +`func (o *CredentialIssuerMetadata) HasCredentialEndpoint() bool` + +HasCredentialEndpoint returns a boolean if a field has been set. + +### GetBatchCredentialEndpoint + +`func (o *CredentialIssuerMetadata) GetBatchCredentialEndpoint() int64` + +GetBatchCredentialEndpoint returns the BatchCredentialEndpoint field if non-nil, zero value otherwise. + +### GetBatchCredentialEndpointOk + +`func (o *CredentialIssuerMetadata) GetBatchCredentialEndpointOk() (*int64, bool)` + +GetBatchCredentialEndpointOk returns a tuple with the BatchCredentialEndpoint field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBatchCredentialEndpoint + +`func (o *CredentialIssuerMetadata) SetBatchCredentialEndpoint(v int64)` + +SetBatchCredentialEndpoint sets BatchCredentialEndpoint field to given value. + +### HasBatchCredentialEndpoint + +`func (o *CredentialIssuerMetadata) HasBatchCredentialEndpoint() bool` + +HasBatchCredentialEndpoint returns a boolean if a field has been set. + +### GetDeferredCredentialEndpoint + +`func (o *CredentialIssuerMetadata) GetDeferredCredentialEndpoint() string` + +GetDeferredCredentialEndpoint returns the DeferredCredentialEndpoint field if non-nil, zero value otherwise. + +### GetDeferredCredentialEndpointOk + +`func (o *CredentialIssuerMetadata) GetDeferredCredentialEndpointOk() (*string, bool)` + +GetDeferredCredentialEndpointOk returns a tuple with the DeferredCredentialEndpoint field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeferredCredentialEndpoint + +`func (o *CredentialIssuerMetadata) SetDeferredCredentialEndpoint(v string)` + +SetDeferredCredentialEndpoint sets DeferredCredentialEndpoint field to given value. + +### HasDeferredCredentialEndpoint + +`func (o *CredentialIssuerMetadata) HasDeferredCredentialEndpoint() bool` + +HasDeferredCredentialEndpoint returns a boolean if a field has been set. + +### GetCredentialsSupported + +`func (o *CredentialIssuerMetadata) GetCredentialsSupported() bool` + +GetCredentialsSupported returns the CredentialsSupported field if non-nil, zero value otherwise. + +### GetCredentialsSupportedOk + +`func (o *CredentialIssuerMetadata) GetCredentialsSupportedOk() (*bool, bool)` + +GetCredentialsSupportedOk returns a tuple with the CredentialsSupported field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCredentialsSupported + +`func (o *CredentialIssuerMetadata) SetCredentialsSupported(v bool)` + +SetCredentialsSupported sets CredentialsSupported field to given value. + +### HasCredentialsSupported + +`func (o *CredentialIssuerMetadata) HasCredentialsSupported() bool` + +HasCredentialsSupported returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CredentialOfferInfo.md b/docs/CredentialOfferInfo.md new file mode 100644 index 0000000..ad3553f --- /dev/null +++ b/docs/CredentialOfferInfo.md @@ -0,0 +1,498 @@ +# CredentialOfferInfo + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identifier** | Pointer to **string** | The identifier of the credential offer. | [optional] +**CredentialOffer** | Pointer to **string** | The credential offer in the JSON format. | [optional] +**CredentialIssuer** | Pointer to **string** | The identifier of the credential issuer. | [optional] +**Credentials** | Pointer to **string** | The value of the `credentials` object in the JSON format. | [optional] +**AuthorizationCodeGrantIncluded** | Pointer to **bool** | The flag indicating whether the `authorization_code` object is included in the `grants` object. | [optional] +**IssuerStateIncluded** | Pointer to **bool** | The flag indicating whether the `issuer_state` property is included in the `authorization_code` object in the `grants` object. | [optional] +**IssuerState** | Pointer to **string** | The value of the `issuer_state` property in the `authorization_code` object in the `grants` object. | [optional] +**PreAuthorizedCodeGrantIncluded** | Pointer to **bool** | The flag indicating whether the `urn:ietf:params:oauth:grant-type:pre-authorized_code` object is included in the `grants` object. | [optional] +**PreAuthorizedCode** | Pointer to **string** | The value of the `pre-authorized_code` property in the `urn:ietf:params:oauth:grant-type:pre-authorized_code` object in the `grants` object. | [optional] +**UserPinRequired** | Pointer to **bool** | The value of the `user_pin_required` property in the `urn:ietf:params:oauth:grant-type:pre-authorized_code` object in the `grants` object. | [optional] +**UserPin** | Pointer to **string** | The value of the user PIN associated with the credential offer. | [optional] +**Subject** | Pointer to **string** | The subject associated with the credential offer. | [optional] +**ExpiresAt** | Pointer to **int64** | The time at which the credential offer will expire. | [optional] +**Context** | Pointer to **string** | The general-purpose arbitrary string. | [optional] +**Properties** | Pointer to [**[]Property**](Property.md) | Extra properties to associate with the credential offer. | [optional] +**JwtAtClaims** | Pointer to **string** | Additional claims that are added to the payload part of the JWT access token. | [optional] +**AuthTime** | Pointer to **int64** | The time at which the user authentication was performed during the course of issuing the credential offer. | [optional] +**Acr** | Pointer to **string** | The Authentication Context Class Reference of the user authentication performed during the course of issuing the credential offer. | [optional] + +## Methods + +### NewCredentialOfferInfo + +`func NewCredentialOfferInfo() *CredentialOfferInfo` + +NewCredentialOfferInfo instantiates a new CredentialOfferInfo object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCredentialOfferInfoWithDefaults + +`func NewCredentialOfferInfoWithDefaults() *CredentialOfferInfo` + +NewCredentialOfferInfoWithDefaults instantiates a new CredentialOfferInfo object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetIdentifier + +`func (o *CredentialOfferInfo) GetIdentifier() string` + +GetIdentifier returns the Identifier field if non-nil, zero value otherwise. + +### GetIdentifierOk + +`func (o *CredentialOfferInfo) GetIdentifierOk() (*string, bool)` + +GetIdentifierOk returns a tuple with the Identifier field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentifier + +`func (o *CredentialOfferInfo) SetIdentifier(v string)` + +SetIdentifier sets Identifier field to given value. + +### HasIdentifier + +`func (o *CredentialOfferInfo) HasIdentifier() bool` + +HasIdentifier returns a boolean if a field has been set. + +### GetCredentialOffer + +`func (o *CredentialOfferInfo) GetCredentialOffer() string` + +GetCredentialOffer returns the CredentialOffer field if non-nil, zero value otherwise. + +### GetCredentialOfferOk + +`func (o *CredentialOfferInfo) GetCredentialOfferOk() (*string, bool)` + +GetCredentialOfferOk returns a tuple with the CredentialOffer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCredentialOffer + +`func (o *CredentialOfferInfo) SetCredentialOffer(v string)` + +SetCredentialOffer sets CredentialOffer field to given value. + +### HasCredentialOffer + +`func (o *CredentialOfferInfo) HasCredentialOffer() bool` + +HasCredentialOffer returns a boolean if a field has been set. + +### GetCredentialIssuer + +`func (o *CredentialOfferInfo) GetCredentialIssuer() string` + +GetCredentialIssuer returns the CredentialIssuer field if non-nil, zero value otherwise. + +### GetCredentialIssuerOk + +`func (o *CredentialOfferInfo) GetCredentialIssuerOk() (*string, bool)` + +GetCredentialIssuerOk returns a tuple with the CredentialIssuer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCredentialIssuer + +`func (o *CredentialOfferInfo) SetCredentialIssuer(v string)` + +SetCredentialIssuer sets CredentialIssuer field to given value. + +### HasCredentialIssuer + +`func (o *CredentialOfferInfo) HasCredentialIssuer() bool` + +HasCredentialIssuer returns a boolean if a field has been set. + +### GetCredentials + +`func (o *CredentialOfferInfo) GetCredentials() string` + +GetCredentials returns the Credentials field if non-nil, zero value otherwise. + +### GetCredentialsOk + +`func (o *CredentialOfferInfo) GetCredentialsOk() (*string, bool)` + +GetCredentialsOk returns a tuple with the Credentials field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCredentials + +`func (o *CredentialOfferInfo) SetCredentials(v string)` + +SetCredentials sets Credentials field to given value. + +### HasCredentials + +`func (o *CredentialOfferInfo) HasCredentials() bool` + +HasCredentials returns a boolean if a field has been set. + +### GetAuthorizationCodeGrantIncluded + +`func (o *CredentialOfferInfo) GetAuthorizationCodeGrantIncluded() bool` + +GetAuthorizationCodeGrantIncluded returns the AuthorizationCodeGrantIncluded field if non-nil, zero value otherwise. + +### GetAuthorizationCodeGrantIncludedOk + +`func (o *CredentialOfferInfo) GetAuthorizationCodeGrantIncludedOk() (*bool, bool)` + +GetAuthorizationCodeGrantIncludedOk returns a tuple with the AuthorizationCodeGrantIncluded field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthorizationCodeGrantIncluded + +`func (o *CredentialOfferInfo) SetAuthorizationCodeGrantIncluded(v bool)` + +SetAuthorizationCodeGrantIncluded sets AuthorizationCodeGrantIncluded field to given value. + +### HasAuthorizationCodeGrantIncluded + +`func (o *CredentialOfferInfo) HasAuthorizationCodeGrantIncluded() bool` + +HasAuthorizationCodeGrantIncluded returns a boolean if a field has been set. + +### GetIssuerStateIncluded + +`func (o *CredentialOfferInfo) GetIssuerStateIncluded() bool` + +GetIssuerStateIncluded returns the IssuerStateIncluded field if non-nil, zero value otherwise. + +### GetIssuerStateIncludedOk + +`func (o *CredentialOfferInfo) GetIssuerStateIncludedOk() (*bool, bool)` + +GetIssuerStateIncludedOk returns a tuple with the IssuerStateIncluded field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIssuerStateIncluded + +`func (o *CredentialOfferInfo) SetIssuerStateIncluded(v bool)` + +SetIssuerStateIncluded sets IssuerStateIncluded field to given value. + +### HasIssuerStateIncluded + +`func (o *CredentialOfferInfo) HasIssuerStateIncluded() bool` + +HasIssuerStateIncluded returns a boolean if a field has been set. + +### GetIssuerState + +`func (o *CredentialOfferInfo) GetIssuerState() string` + +GetIssuerState returns the IssuerState field if non-nil, zero value otherwise. + +### GetIssuerStateOk + +`func (o *CredentialOfferInfo) GetIssuerStateOk() (*string, bool)` + +GetIssuerStateOk returns a tuple with the IssuerState field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIssuerState + +`func (o *CredentialOfferInfo) SetIssuerState(v string)` + +SetIssuerState sets IssuerState field to given value. + +### HasIssuerState + +`func (o *CredentialOfferInfo) HasIssuerState() bool` + +HasIssuerState returns a boolean if a field has been set. + +### GetPreAuthorizedCodeGrantIncluded + +`func (o *CredentialOfferInfo) GetPreAuthorizedCodeGrantIncluded() bool` + +GetPreAuthorizedCodeGrantIncluded returns the PreAuthorizedCodeGrantIncluded field if non-nil, zero value otherwise. + +### GetPreAuthorizedCodeGrantIncludedOk + +`func (o *CredentialOfferInfo) GetPreAuthorizedCodeGrantIncludedOk() (*bool, bool)` + +GetPreAuthorizedCodeGrantIncludedOk returns a tuple with the PreAuthorizedCodeGrantIncluded field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPreAuthorizedCodeGrantIncluded + +`func (o *CredentialOfferInfo) SetPreAuthorizedCodeGrantIncluded(v bool)` + +SetPreAuthorizedCodeGrantIncluded sets PreAuthorizedCodeGrantIncluded field to given value. + +### HasPreAuthorizedCodeGrantIncluded + +`func (o *CredentialOfferInfo) HasPreAuthorizedCodeGrantIncluded() bool` + +HasPreAuthorizedCodeGrantIncluded returns a boolean if a field has been set. + +### GetPreAuthorizedCode + +`func (o *CredentialOfferInfo) GetPreAuthorizedCode() string` + +GetPreAuthorizedCode returns the PreAuthorizedCode field if non-nil, zero value otherwise. + +### GetPreAuthorizedCodeOk + +`func (o *CredentialOfferInfo) GetPreAuthorizedCodeOk() (*string, bool)` + +GetPreAuthorizedCodeOk returns a tuple with the PreAuthorizedCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPreAuthorizedCode + +`func (o *CredentialOfferInfo) SetPreAuthorizedCode(v string)` + +SetPreAuthorizedCode sets PreAuthorizedCode field to given value. + +### HasPreAuthorizedCode + +`func (o *CredentialOfferInfo) HasPreAuthorizedCode() bool` + +HasPreAuthorizedCode returns a boolean if a field has been set. + +### GetUserPinRequired + +`func (o *CredentialOfferInfo) GetUserPinRequired() bool` + +GetUserPinRequired returns the UserPinRequired field if non-nil, zero value otherwise. + +### GetUserPinRequiredOk + +`func (o *CredentialOfferInfo) GetUserPinRequiredOk() (*bool, bool)` + +GetUserPinRequiredOk returns a tuple with the UserPinRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserPinRequired + +`func (o *CredentialOfferInfo) SetUserPinRequired(v bool)` + +SetUserPinRequired sets UserPinRequired field to given value. + +### HasUserPinRequired + +`func (o *CredentialOfferInfo) HasUserPinRequired() bool` + +HasUserPinRequired returns a boolean if a field has been set. + +### GetUserPin + +`func (o *CredentialOfferInfo) GetUserPin() string` + +GetUserPin returns the UserPin field if non-nil, zero value otherwise. + +### GetUserPinOk + +`func (o *CredentialOfferInfo) GetUserPinOk() (*string, bool)` + +GetUserPinOk returns a tuple with the UserPin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserPin + +`func (o *CredentialOfferInfo) SetUserPin(v string)` + +SetUserPin sets UserPin field to given value. + +### HasUserPin + +`func (o *CredentialOfferInfo) HasUserPin() bool` + +HasUserPin returns a boolean if a field has been set. + +### GetSubject + +`func (o *CredentialOfferInfo) GetSubject() string` + +GetSubject returns the Subject field if non-nil, zero value otherwise. + +### GetSubjectOk + +`func (o *CredentialOfferInfo) GetSubjectOk() (*string, bool)` + +GetSubjectOk returns a tuple with the Subject field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSubject + +`func (o *CredentialOfferInfo) SetSubject(v string)` + +SetSubject sets Subject field to given value. + +### HasSubject + +`func (o *CredentialOfferInfo) HasSubject() bool` + +HasSubject returns a boolean if a field has been set. + +### GetExpiresAt + +`func (o *CredentialOfferInfo) GetExpiresAt() int64` + +GetExpiresAt returns the ExpiresAt field if non-nil, zero value otherwise. + +### GetExpiresAtOk + +`func (o *CredentialOfferInfo) GetExpiresAtOk() (*int64, bool)` + +GetExpiresAtOk returns a tuple with the ExpiresAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpiresAt + +`func (o *CredentialOfferInfo) SetExpiresAt(v int64)` + +SetExpiresAt sets ExpiresAt field to given value. + +### HasExpiresAt + +`func (o *CredentialOfferInfo) HasExpiresAt() bool` + +HasExpiresAt returns a boolean if a field has been set. + +### GetContext + +`func (o *CredentialOfferInfo) GetContext() string` + +GetContext returns the Context field if non-nil, zero value otherwise. + +### GetContextOk + +`func (o *CredentialOfferInfo) GetContextOk() (*string, bool)` + +GetContextOk returns a tuple with the Context field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContext + +`func (o *CredentialOfferInfo) SetContext(v string)` + +SetContext sets Context field to given value. + +### HasContext + +`func (o *CredentialOfferInfo) HasContext() bool` + +HasContext returns a boolean if a field has been set. + +### GetProperties + +`func (o *CredentialOfferInfo) GetProperties() []Property` + +GetProperties returns the Properties field if non-nil, zero value otherwise. + +### GetPropertiesOk + +`func (o *CredentialOfferInfo) GetPropertiesOk() (*[]Property, bool)` + +GetPropertiesOk returns a tuple with the Properties field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProperties + +`func (o *CredentialOfferInfo) SetProperties(v []Property)` + +SetProperties sets Properties field to given value. + +### HasProperties + +`func (o *CredentialOfferInfo) HasProperties() bool` + +HasProperties returns a boolean if a field has been set. + +### GetJwtAtClaims + +`func (o *CredentialOfferInfo) GetJwtAtClaims() string` + +GetJwtAtClaims returns the JwtAtClaims field if non-nil, zero value otherwise. + +### GetJwtAtClaimsOk + +`func (o *CredentialOfferInfo) GetJwtAtClaimsOk() (*string, bool)` + +GetJwtAtClaimsOk returns a tuple with the JwtAtClaims field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetJwtAtClaims + +`func (o *CredentialOfferInfo) SetJwtAtClaims(v string)` + +SetJwtAtClaims sets JwtAtClaims field to given value. + +### HasJwtAtClaims + +`func (o *CredentialOfferInfo) HasJwtAtClaims() bool` + +HasJwtAtClaims returns a boolean if a field has been set. + +### GetAuthTime + +`func (o *CredentialOfferInfo) GetAuthTime() int64` + +GetAuthTime returns the AuthTime field if non-nil, zero value otherwise. + +### GetAuthTimeOk + +`func (o *CredentialOfferInfo) GetAuthTimeOk() (*int64, bool)` + +GetAuthTimeOk returns a tuple with the AuthTime field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthTime + +`func (o *CredentialOfferInfo) SetAuthTime(v int64)` + +SetAuthTime sets AuthTime field to given value. + +### HasAuthTime + +`func (o *CredentialOfferInfo) HasAuthTime() bool` + +HasAuthTime returns a boolean if a field has been set. + +### GetAcr + +`func (o *CredentialOfferInfo) GetAcr() string` + +GetAcr returns the Acr field if non-nil, zero value otherwise. + +### GetAcrOk + +`func (o *CredentialOfferInfo) GetAcrOk() (*string, bool)` + +GetAcrOk returns a tuple with the Acr field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAcr + +`func (o *CredentialOfferInfo) SetAcr(v string)` + +SetAcr sets Acr field to given value. + +### HasAcr + +`func (o *CredentialOfferInfo) HasAcr() bool` + +HasAcr returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CredentialRequestInfo.md b/docs/CredentialRequestInfo.md new file mode 100644 index 0000000..8c752ae --- /dev/null +++ b/docs/CredentialRequestInfo.md @@ -0,0 +1,134 @@ +# CredentialRequestInfo + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identifier** | Pointer to **string** | The identifier of the credential offer. | [optional] +**Format** | Pointer to **string** | The value of the format parameter in the credential request. | [optional] +**BindingKey** | Pointer to **string** | The binding key specified by the proof in the credential request. | [optional] +**Details** | Pointer to **string** | The details about the credential request. | [optional] + +## Methods + +### NewCredentialRequestInfo + +`func NewCredentialRequestInfo() *CredentialRequestInfo` + +NewCredentialRequestInfo instantiates a new CredentialRequestInfo object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCredentialRequestInfoWithDefaults + +`func NewCredentialRequestInfoWithDefaults() *CredentialRequestInfo` + +NewCredentialRequestInfoWithDefaults instantiates a new CredentialRequestInfo object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetIdentifier + +`func (o *CredentialRequestInfo) GetIdentifier() string` + +GetIdentifier returns the Identifier field if non-nil, zero value otherwise. + +### GetIdentifierOk + +`func (o *CredentialRequestInfo) GetIdentifierOk() (*string, bool)` + +GetIdentifierOk returns a tuple with the Identifier field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentifier + +`func (o *CredentialRequestInfo) SetIdentifier(v string)` + +SetIdentifier sets Identifier field to given value. + +### HasIdentifier + +`func (o *CredentialRequestInfo) HasIdentifier() bool` + +HasIdentifier returns a boolean if a field has been set. + +### GetFormat + +`func (o *CredentialRequestInfo) GetFormat() string` + +GetFormat returns the Format field if non-nil, zero value otherwise. + +### GetFormatOk + +`func (o *CredentialRequestInfo) GetFormatOk() (*string, bool)` + +GetFormatOk returns a tuple with the Format field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormat + +`func (o *CredentialRequestInfo) SetFormat(v string)` + +SetFormat sets Format field to given value. + +### HasFormat + +`func (o *CredentialRequestInfo) HasFormat() bool` + +HasFormat returns a boolean if a field has been set. + +### GetBindingKey + +`func (o *CredentialRequestInfo) GetBindingKey() string` + +GetBindingKey returns the BindingKey field if non-nil, zero value otherwise. + +### GetBindingKeyOk + +`func (o *CredentialRequestInfo) GetBindingKeyOk() (*string, bool)` + +GetBindingKeyOk returns a tuple with the BindingKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBindingKey + +`func (o *CredentialRequestInfo) SetBindingKey(v string)` + +SetBindingKey sets BindingKey field to given value. + +### HasBindingKey + +`func (o *CredentialRequestInfo) HasBindingKey() bool` + +HasBindingKey returns a boolean if a field has been set. + +### GetDetails + +`func (o *CredentialRequestInfo) GetDetails() string` + +GetDetails returns the Details field if non-nil, zero value otherwise. + +### GetDetailsOk + +`func (o *CredentialRequestInfo) GetDetailsOk() (*string, bool)` + +GetDetailsOk returns a tuple with the Details field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDetails + +`func (o *CredentialRequestInfo) SetDetails(v string)` + +SetDetails sets Details field to given value. + +### HasDetails + +`func (o *CredentialRequestInfo) HasDetails() bool` + +HasDetails returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/DefaultApi.md b/docs/DefaultApi.md index baeda01..97a00c5 100644 --- a/docs/DefaultApi.md +++ b/docs/DefaultApi.md @@ -1,6 +1,6 @@ # \DefaultApi -All URIs are relative to *https://api.authlete.com* +All URIs are relative to *https://beta.authlete.com* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -55,7 +55,7 @@ Other parameters are passed through a pointer to a apiMiscEchoApiRequest struct ### Authorization -[ServiceCredentials](../README.md#ServiceCredentials) +No authorization required ### HTTP request headers diff --git a/docs/DeviceFlowApi.md b/docs/DeviceFlowApi.md index 31dfdba..5c94d80 100644 --- a/docs/DeviceFlowApi.md +++ b/docs/DeviceFlowApi.md @@ -1,20 +1,20 @@ # \DeviceFlowApi -All URIs are relative to *https://api.authlete.com* +All URIs are relative to *https://beta.authlete.com* Method | HTTP request | Description ------------- | ------------- | ------------- -[**DeviceAuthorizationApi**](DeviceFlowApi.md#DeviceAuthorizationApi) | **Post** /api/device/authorization | /api/device/authorization API -[**DeviceCompleteApi**](DeviceFlowApi.md#DeviceCompleteApi) | **Post** /api/device/complete | /api/device/complete API -[**DeviceVerificationApi**](DeviceFlowApi.md#DeviceVerificationApi) | **Post** /api/device/verification | /api/device/verification API +[**DeviceAuthorizationApi**](DeviceFlowApi.md#DeviceAuthorizationApi) | **Post** /api/{serviceId}/device/authorization | /api/{serviceId}/device/authorization API +[**DeviceCompleteApi**](DeviceFlowApi.md#DeviceCompleteApi) | **Post** /api/{serviceId}/device/complete | /api/{serviceId}/device/complete API +[**DeviceVerificationApi**](DeviceFlowApi.md#DeviceVerificationApi) | **Post** /api/{serviceId}/device/verification | /api/{serviceId}/device/verification API ## DeviceAuthorizationApi -> DeviceAuthorizationResponse DeviceAuthorizationApi(ctx).DeviceAuthorizationRequest(deviceAuthorizationRequest).Execute() +> DeviceAuthorizationResponse DeviceAuthorizationApi(ctx, serviceId).DeviceAuthorizationRequest(deviceAuthorizationRequest).Execute() -/api/device/authorization API +/api/{serviceId}/device/authorization API @@ -31,11 +31,12 @@ import ( ) func main() { + serviceId := "serviceId_example" // string | A service ID. deviceAuthorizationRequest := *openapiclient.NewDeviceAuthorizationRequest("Parameters_example") // DeviceAuthorizationRequest | configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.DeviceFlowApi.DeviceAuthorizationApi(context.Background()).DeviceAuthorizationRequest(deviceAuthorizationRequest).Execute() + resp, r, err := apiClient.DeviceFlowApi.DeviceAuthorizationApi(context.Background(), serviceId).DeviceAuthorizationRequest(deviceAuthorizationRequest).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `DeviceFlowApi.DeviceAuthorizationApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -48,6 +49,10 @@ func main() { ### Path Parameters +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | ### Other Parameters @@ -56,6 +61,7 @@ Other parameters are passed through a pointer to a apiDeviceAuthorizationApiRequ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **deviceAuthorizationRequest** | [**DeviceAuthorizationRequest**](DeviceAuthorizationRequest.md) | | ### Return type @@ -64,7 +70,7 @@ Name | Type | Description | Notes ### Authorization -[ServiceCredentials](../README.md#ServiceCredentials) +[UseService](../README.md#UseService) ### HTTP request headers @@ -78,9 +84,9 @@ Name | Type | Description | Notes ## DeviceCompleteApi -> DeviceCompleteResponse DeviceCompleteApi(ctx).DeviceCompleteRequest(deviceCompleteRequest).Execute() +> DeviceCompleteResponse DeviceCompleteApi(ctx, serviceId).DeviceCompleteRequest(deviceCompleteRequest).Execute() -/api/device/complete API +/api/{serviceId}/device/complete API @@ -97,11 +103,12 @@ import ( ) func main() { + serviceId := "serviceId_example" // string | A service ID. deviceCompleteRequest := *openapiclient.NewDeviceCompleteRequest("UserCode_example", "Result_example", "Subject_example") // DeviceCompleteRequest | configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.DeviceFlowApi.DeviceCompleteApi(context.Background()).DeviceCompleteRequest(deviceCompleteRequest).Execute() + resp, r, err := apiClient.DeviceFlowApi.DeviceCompleteApi(context.Background(), serviceId).DeviceCompleteRequest(deviceCompleteRequest).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `DeviceFlowApi.DeviceCompleteApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -114,6 +121,10 @@ func main() { ### Path Parameters +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | ### Other Parameters @@ -122,6 +133,7 @@ Other parameters are passed through a pointer to a apiDeviceCompleteApiRequest s Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **deviceCompleteRequest** | [**DeviceCompleteRequest**](DeviceCompleteRequest.md) | | ### Return type @@ -130,7 +142,7 @@ Name | Type | Description | Notes ### Authorization -[ServiceCredentials](../README.md#ServiceCredentials) +[UseService](../README.md#UseService) ### HTTP request headers @@ -144,9 +156,9 @@ Name | Type | Description | Notes ## DeviceVerificationApi -> DeviceVerificationResponse DeviceVerificationApi(ctx).DeviceVerificationRequest(deviceVerificationRequest).Execute() +> DeviceVerificationResponse DeviceVerificationApi(ctx, serviceId).DeviceVerificationRequest(deviceVerificationRequest).Execute() -/api/device/verification API +/api/{serviceId}/device/verification API @@ -163,11 +175,12 @@ import ( ) func main() { + serviceId := "serviceId_example" // string | A service ID. deviceVerificationRequest := *openapiclient.NewDeviceVerificationRequest("UserCode_example") // DeviceVerificationRequest | configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.DeviceFlowApi.DeviceVerificationApi(context.Background()).DeviceVerificationRequest(deviceVerificationRequest).Execute() + resp, r, err := apiClient.DeviceFlowApi.DeviceVerificationApi(context.Background(), serviceId).DeviceVerificationRequest(deviceVerificationRequest).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `DeviceFlowApi.DeviceVerificationApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -180,6 +193,10 @@ func main() { ### Path Parameters +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | ### Other Parameters @@ -188,6 +205,7 @@ Other parameters are passed through a pointer to a apiDeviceVerificationApiReque Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **deviceVerificationRequest** | [**DeviceVerificationRequest**](DeviceVerificationRequest.md) | | ### Return type @@ -196,7 +214,7 @@ Name | Type | Description | Notes ### Authorization -[ServiceCredentials](../README.md#ServiceCredentials) +[UseService](../README.md#UseService) ### HTTP request headers diff --git a/docs/DynamicClientRegistrationApi.md b/docs/DynamicClientRegistrationApi.md index fd378e3..fdea3d2 100644 --- a/docs/DynamicClientRegistrationApi.md +++ b/docs/DynamicClientRegistrationApi.md @@ -1,21 +1,21 @@ # \DynamicClientRegistrationApi -All URIs are relative to *https://api.authlete.com* +All URIs are relative to *https://beta.authlete.com* Method | HTTP request | Description ------------- | ------------- | ------------- -[**ClientRegistrationApi**](DynamicClientRegistrationApi.md#ClientRegistrationApi) | **Post** /api/client/registration | /api/client/registration API -[**ClientRegistrationDeleteApi**](DynamicClientRegistrationApi.md#ClientRegistrationDeleteApi) | **Post** /api/client/registration/delete | /api/client/registration/delete API -[**ClientRegistrationGetApi**](DynamicClientRegistrationApi.md#ClientRegistrationGetApi) | **Post** /api/client/registration/get | /api/client/registration/get API -[**ClientRegistrationUpdateApi**](DynamicClientRegistrationApi.md#ClientRegistrationUpdateApi) | **Post** /api/client/registration/update | /api/client/registration/update API +[**ClientRegistrationApi**](DynamicClientRegistrationApi.md#ClientRegistrationApi) | **Post** /api/{serviceId}/client/registration | /api/{serviceId}/client/registration API +[**ClientRegistrationDeleteApi**](DynamicClientRegistrationApi.md#ClientRegistrationDeleteApi) | **Post** /api/{serviceId}/client/registration/delete | /api/{serviceId}/client/registration/delete API +[**ClientRegistrationGetApi**](DynamicClientRegistrationApi.md#ClientRegistrationGetApi) | **Post** /api/{serviceId}/client/registration/get | /api/{serviceId}/client/registration/get API +[**ClientRegistrationUpdateApi**](DynamicClientRegistrationApi.md#ClientRegistrationUpdateApi) | **Post** /api/{serviceId}/client/registration/update | /api/{serviceId}/client/registration/update API ## ClientRegistrationApi -> ClientRegistrationResponse ClientRegistrationApi(ctx).ClientRegistrationRequest(clientRegistrationRequest).Execute() +> ClientRegistrationResponse ClientRegistrationApi(ctx, serviceId).ClientRegistrationRequest(clientRegistrationRequest).Execute() -/api/client/registration API +/api/{serviceId}/client/registration API @@ -32,11 +32,12 @@ import ( ) func main() { + serviceId := "serviceId_example" // string | A service ID. clientRegistrationRequest := *openapiclient.NewClientRegistrationRequest("Json_example") // ClientRegistrationRequest | configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.DynamicClientRegistrationApi.ClientRegistrationApi(context.Background()).ClientRegistrationRequest(clientRegistrationRequest).Execute() + resp, r, err := apiClient.DynamicClientRegistrationApi.ClientRegistrationApi(context.Background(), serviceId).ClientRegistrationRequest(clientRegistrationRequest).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `DynamicClientRegistrationApi.ClientRegistrationApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -49,6 +50,10 @@ func main() { ### Path Parameters +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | ### Other Parameters @@ -57,6 +62,7 @@ Other parameters are passed through a pointer to a apiClientRegistrationApiReque Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **clientRegistrationRequest** | [**ClientRegistrationRequest**](ClientRegistrationRequest.md) | | ### Return type @@ -65,7 +71,7 @@ Name | Type | Description | Notes ### Authorization -[ServiceCredentials](../README.md#ServiceCredentials) +[UseService](../README.md#UseService) ### HTTP request headers @@ -79,9 +85,9 @@ Name | Type | Description | Notes ## ClientRegistrationDeleteApi -> ClientRegistrationDeleteResponse ClientRegistrationDeleteApi(ctx).ClientRegistrationDeleteRequest(clientRegistrationDeleteRequest).Execute() +> ClientRegistrationDeleteResponse ClientRegistrationDeleteApi(ctx, serviceId).ClientRegistrationDeleteRequest(clientRegistrationDeleteRequest).Execute() -/api/client/registration/delete API +/api/{serviceId}/client/registration/delete API @@ -98,11 +104,12 @@ import ( ) func main() { + serviceId := "serviceId_example" // string | A service ID. clientRegistrationDeleteRequest := *openapiclient.NewClientRegistrationDeleteRequest("ClientId_example", "Token_example") // ClientRegistrationDeleteRequest | configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.DynamicClientRegistrationApi.ClientRegistrationDeleteApi(context.Background()).ClientRegistrationDeleteRequest(clientRegistrationDeleteRequest).Execute() + resp, r, err := apiClient.DynamicClientRegistrationApi.ClientRegistrationDeleteApi(context.Background(), serviceId).ClientRegistrationDeleteRequest(clientRegistrationDeleteRequest).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `DynamicClientRegistrationApi.ClientRegistrationDeleteApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -115,6 +122,10 @@ func main() { ### Path Parameters +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | ### Other Parameters @@ -123,6 +134,7 @@ Other parameters are passed through a pointer to a apiClientRegistrationDeleteAp Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **clientRegistrationDeleteRequest** | [**ClientRegistrationDeleteRequest**](ClientRegistrationDeleteRequest.md) | | ### Return type @@ -131,7 +143,7 @@ Name | Type | Description | Notes ### Authorization -[ServiceCredentials](../README.md#ServiceCredentials) +[UseService](../README.md#UseService) ### HTTP request headers @@ -145,9 +157,9 @@ Name | Type | Description | Notes ## ClientRegistrationGetApi -> ClientRegistrationGetResponse ClientRegistrationGetApi(ctx).ClientRegistrationGetRequest(clientRegistrationGetRequest).Execute() +> ClientRegistrationResponse ClientRegistrationGetApi(ctx, serviceId).ClientRegistrationRequest(clientRegistrationRequest).Execute() -/api/client/registration/get API +/api/{serviceId}/client/registration/get API @@ -164,16 +176,17 @@ import ( ) func main() { - clientRegistrationGetRequest := *openapiclient.NewClientRegistrationGetRequest("ClientId_example", "Token_example") // ClientRegistrationGetRequest | + serviceId := "serviceId_example" // string | A service ID. + clientRegistrationRequest := *openapiclient.NewClientRegistrationRequest("Json_example") // ClientRegistrationRequest | configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.DynamicClientRegistrationApi.ClientRegistrationGetApi(context.Background()).ClientRegistrationGetRequest(clientRegistrationGetRequest).Execute() + resp, r, err := apiClient.DynamicClientRegistrationApi.ClientRegistrationGetApi(context.Background(), serviceId).ClientRegistrationRequest(clientRegistrationRequest).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `DynamicClientRegistrationApi.ClientRegistrationGetApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } - // response from `ClientRegistrationGetApi`: ClientRegistrationGetResponse + // response from `ClientRegistrationGetApi`: ClientRegistrationResponse fmt.Fprintf(os.Stdout, "Response from `DynamicClientRegistrationApi.ClientRegistrationGetApi`: %v\n", resp) } ``` @@ -181,6 +194,10 @@ func main() { ### Path Parameters +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | ### Other Parameters @@ -189,15 +206,16 @@ Other parameters are passed through a pointer to a apiClientRegistrationGetApiRe Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **clientRegistrationGetRequest** | [**ClientRegistrationGetRequest**](ClientRegistrationGetRequest.md) | | + + **clientRegistrationRequest** | [**ClientRegistrationRequest**](ClientRegistrationRequest.md) | | ### Return type -[**ClientRegistrationGetResponse**](ClientRegistrationGetResponse.md) +[**ClientRegistrationResponse**](ClientRegistrationResponse.md) ### Authorization -[ServiceCredentials](../README.md#ServiceCredentials) +[UseService](../README.md#UseService) ### HTTP request headers @@ -211,9 +229,9 @@ Name | Type | Description | Notes ## ClientRegistrationUpdateApi -> ClientRegistrationUpdateResponse ClientRegistrationUpdateApi(ctx).ClientRegistrationUpdateRequest(clientRegistrationUpdateRequest).Execute() +> ClientRegistrationUpdateResponse ClientRegistrationUpdateApi(ctx, serviceId).ClientRegistrationUpdateRequest(clientRegistrationUpdateRequest).Execute() -/api/client/registration/update API +/api/{serviceId}/client/registration/update API @@ -230,11 +248,12 @@ import ( ) func main() { + serviceId := "serviceId_example" // string | A service ID. clientRegistrationUpdateRequest := *openapiclient.NewClientRegistrationUpdateRequest("ClientId_example", "Token_example", "Json_example") // ClientRegistrationUpdateRequest | configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.DynamicClientRegistrationApi.ClientRegistrationUpdateApi(context.Background()).ClientRegistrationUpdateRequest(clientRegistrationUpdateRequest).Execute() + resp, r, err := apiClient.DynamicClientRegistrationApi.ClientRegistrationUpdateApi(context.Background(), serviceId).ClientRegistrationUpdateRequest(clientRegistrationUpdateRequest).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `DynamicClientRegistrationApi.ClientRegistrationUpdateApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -247,6 +266,10 @@ func main() { ### Path Parameters +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | ### Other Parameters @@ -255,6 +278,7 @@ Other parameters are passed through a pointer to a apiClientRegistrationUpdateAp Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **clientRegistrationUpdateRequest** | [**ClientRegistrationUpdateRequest**](ClientRegistrationUpdateRequest.md) | | ### Return type @@ -263,7 +287,7 @@ Name | Type | Description | Notes ### Authorization -[ServiceCredentials](../README.md#ServiceCredentials) +[UseService](../README.md#UseService) ### HTTP request headers diff --git a/docs/FapiMode.md b/docs/FapiMode.md new file mode 100644 index 0000000..a6397ba --- /dev/null +++ b/docs/FapiMode.md @@ -0,0 +1,21 @@ +# FapiMode + +## Enum + + +* `FAPI1_ADVANCED` (value: `"FAPI1_ADVANCED"`) + +* `FAPI1_BASELINE` (value: `"FAPI1_BASELINE"`) + +* `FAPI2_MESSAGE_SIGNING_AUTH_REQ` (value: `"FAPI2_MESSAGE_SIGNING_AUTH_REQ"`) + +* `FAPI2_MESSAGE_SIGNING_AUTH_RES` (value: `"FAPI2_MESSAGE_SIGNING_AUTH_RES"`) + +* `FAPI2_MESSAGE_SIGNING_INTROSPECTION_RES` (value: `"FAPI2_MESSAGE_SIGNING_INTROSPECTION_RES"`) + +* `FAPI2_SECURITY` (value: `"FAPI2_SECURITY"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/FederationEndpointApi.md b/docs/FederationEndpointApi.md index 814d012..8d853db 100644 --- a/docs/FederationEndpointApi.md +++ b/docs/FederationEndpointApi.md @@ -1,19 +1,19 @@ # \FederationEndpointApi -All URIs are relative to *https://api.authlete.com* +All URIs are relative to *https://beta.authlete.com* Method | HTTP request | Description ------------- | ------------- | ------------- -[**FederationConfigurationApi**](FederationEndpointApi.md#FederationConfigurationApi) | **Post** /api/federation/configuration | /api/federation/configuration API -[**FederationRegistrationApi**](FederationEndpointApi.md#FederationRegistrationApi) | **Post** /api/federation/registration | /api/federation/registration API +[**FederationConfigurationApi**](FederationEndpointApi.md#FederationConfigurationApi) | **Post** /api/{serviceId}/federation/configuration | /api/{serviceId}/federation/configuration API +[**FederationRegistrationApi**](FederationEndpointApi.md#FederationRegistrationApi) | **Post** /api/{serviceId}/federation/registration | /api/{serviceId}/federation/registration API ## FederationConfigurationApi -> FederationConfigurationResponse FederationConfigurationApi(ctx).Body(body).Execute() +> FederationConfigurationResponse FederationConfigurationApi(ctx, serviceId).Body(body).Execute() -/api/federation/configuration API +/api/{serviceId}/federation/configuration API @@ -30,11 +30,12 @@ import ( ) func main() { + serviceId := "serviceId_example" // string | A service ID. body := map[string]interface{}{ ... } // map[string]interface{} | (optional) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.FederationEndpointApi.FederationConfigurationApi(context.Background()).Body(body).Execute() + resp, r, err := apiClient.FederationEndpointApi.FederationConfigurationApi(context.Background(), serviceId).Body(body).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `FederationEndpointApi.FederationConfigurationApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -47,6 +48,10 @@ func main() { ### Path Parameters +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | ### Other Parameters @@ -55,6 +60,7 @@ Other parameters are passed through a pointer to a apiFederationConfigurationApi Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **body** | **map[string]interface{}** | | ### Return type @@ -63,7 +69,7 @@ Name | Type | Description | Notes ### Authorization -[ServiceCredentials](../README.md#ServiceCredentials) +[UseService](../README.md#UseService) ### HTTP request headers @@ -77,9 +83,9 @@ Name | Type | Description | Notes ## FederationRegistrationApi -> FederationRegistrationResponse FederationRegistrationApi(ctx).FederationRegistrationRequest(federationRegistrationRequest).Execute() +> FederationRegistrationResponse FederationRegistrationApi(ctx, serviceId).FederationRegistrationRequest(federationRegistrationRequest).Execute() -/api/federation/registration API +/api/{serviceId}/federation/registration API @@ -96,11 +102,12 @@ import ( ) func main() { + serviceId := "serviceId_example" // string | A service ID. federationRegistrationRequest := *openapiclient.NewFederationRegistrationRequest() // FederationRegistrationRequest | configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.FederationEndpointApi.FederationRegistrationApi(context.Background()).FederationRegistrationRequest(federationRegistrationRequest).Execute() + resp, r, err := apiClient.FederationEndpointApi.FederationRegistrationApi(context.Background(), serviceId).FederationRegistrationRequest(federationRegistrationRequest).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `FederationEndpointApi.FederationRegistrationApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -113,6 +120,10 @@ func main() { ### Path Parameters +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | ### Other Parameters @@ -121,6 +132,7 @@ Other parameters are passed through a pointer to a apiFederationRegistrationApiR Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **federationRegistrationRequest** | [**FederationRegistrationRequest**](FederationRegistrationRequest.md) | | ### Return type @@ -129,7 +141,7 @@ Name | Type | Description | Notes ### Authorization -[ServiceCredentials](../README.md#ServiceCredentials) +[UseService](../README.md#UseService) ### HTTP request headers diff --git a/docs/GMResponse.md b/docs/GMResponse.md index d6df87a..01f7bef 100644 --- a/docs/GMResponse.md +++ b/docs/GMResponse.md @@ -8,6 +8,7 @@ Name | Type | Description | Notes **ResultMessage** | Pointer to **string** | A short message which explains the result of the API call. | [optional] **Action** | Pointer to **string** | The next action that the authorization server implementation should take. | [optional] **ResponseContent** | Pointer to **string** | The content that the authorization server implementation is to return to the client application. Its format varies depending on the value of `action` parameter. | [optional] +**DpopNonce** | Pointer to **string** | Get the expected nonce value for DPoP proof JWT, which should be used as the value of the `DPoP-Nonce` HTTP header. | [optional] ## Methods @@ -128,6 +129,31 @@ SetResponseContent sets ResponseContent field to given value. HasResponseContent returns a boolean if a field has been set. +### GetDpopNonce + +`func (o *GMResponse) GetDpopNonce() string` + +GetDpopNonce returns the DpopNonce field if non-nil, zero value otherwise. + +### GetDpopNonceOk + +`func (o *GMResponse) GetDpopNonceOk() (*string, bool)` + +GetDpopNonceOk returns a tuple with the DpopNonce field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDpopNonce + +`func (o *GMResponse) SetDpopNonce(v string)` + +SetDpopNonce sets DpopNonce field to given value. + +### HasDpopNonce + +`func (o *GMResponse) HasDpopNonce() bool` + +HasDpopNonce returns a boolean if a field has been set. + [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/GrantManagementEndpointApi.md b/docs/GrantManagementEndpointApi.md index c39dd5b..59a800a 100644 --- a/docs/GrantManagementEndpointApi.md +++ b/docs/GrantManagementEndpointApi.md @@ -1,18 +1,18 @@ # \GrantManagementEndpointApi -All URIs are relative to *https://api.authlete.com* +All URIs are relative to *https://beta.authlete.com* Method | HTTP request | Description ------------- | ------------- | ------------- -[**GrantMApi**](GrantManagementEndpointApi.md#GrantMApi) | **Post** /api/gm | /api/gm API +[**GrantMApi**](GrantManagementEndpointApi.md#GrantMApi) | **Post** /api/{serviceId}/gm | /api/{serviceId}/gm API ## GrantMApi -> GMResponse GrantMApi(ctx).GMRequest(gMRequest).Execute() +> GMResponse GrantMApi(ctx, serviceId).GMRequest(gMRequest).Execute() -/api/gm API +/api/{serviceId}/gm API @@ -29,11 +29,12 @@ import ( ) func main() { + serviceId := "serviceId_example" // string | A service ID. gMRequest := *openapiclient.NewGMRequest() // GMRequest | configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.GrantManagementEndpointApi.GrantMApi(context.Background()).GMRequest(gMRequest).Execute() + resp, r, err := apiClient.GrantManagementEndpointApi.GrantMApi(context.Background(), serviceId).GMRequest(gMRequest).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `GrantManagementEndpointApi.GrantMApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -46,6 +47,10 @@ func main() { ### Path Parameters +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | ### Other Parameters @@ -54,6 +59,7 @@ Other parameters are passed through a pointer to a apiGrantMApiRequest struct vi Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **gMRequest** | [**GMRequest**](GMRequest.md) | | ### Return type @@ -62,7 +68,7 @@ Name | Type | Description | Notes ### Authorization -[ServiceCredentials](../README.md#ServiceCredentials) +[UseService](../README.md#UseService) ### HTTP request headers diff --git a/docs/HskOperationsApi.md b/docs/HskOperationsApi.md index 8a82194..ba1b29e 100644 --- a/docs/HskOperationsApi.md +++ b/docs/HskOperationsApi.md @@ -1,21 +1,21 @@ # \HskOperationsApi -All URIs are relative to *https://api.authlete.com* +All URIs are relative to *https://beta.authlete.com* Method | HTTP request | Description ------------- | ------------- | ------------- -[**HskCreateApi**](HskOperationsApi.md#HskCreateApi) | **Post** /api/hsk/create | /api/hsk/create API -[**HskDeleteApi**](HskOperationsApi.md#HskDeleteApi) | **Delete** /api/hsk/delete/{handle} | /api/hsk/delete/{handle} API -[**HskGetApi**](HskOperationsApi.md#HskGetApi) | **Get** /api/hsk/get/{handle} | /api/hsk/get/{handle} API -[**HskGetListApi**](HskOperationsApi.md#HskGetListApi) | **Get** /api/hsk/get/list | /api/hsk/get/list API +[**HskCreateApi**](HskOperationsApi.md#HskCreateApi) | **Post** /api/{serviceId}/hsk/create | /api/{serviceId}/hsk/create API +[**HskDeleteApi**](HskOperationsApi.md#HskDeleteApi) | **Delete** /api/{serviceId}/hsk/delete/{handle} | /api/{serviceId}/hsk/delete/{handle} API +[**HskGetApi**](HskOperationsApi.md#HskGetApi) | **Get** /api/{serviceId}/hsk/get/{handle} | /api/{serviceId}/hsk/get/{handle} API +[**HskGetListApi**](HskOperationsApi.md#HskGetListApi) | **Get** /api/{serviceId}/hsk/get/list | /api/{serviceId}/hsk/get/list API ## HskCreateApi -> HskCreateResponse HskCreateApi(ctx).HskCreateRequest(hskCreateRequest).Execute() +> HskCreateResponse HskCreateApi(ctx, serviceId).HskCreateRequest(hskCreateRequest).Execute() -/api/hsk/create API +/api/{serviceId}/hsk/create API ### Example @@ -30,11 +30,12 @@ import ( ) func main() { + serviceId := "serviceId_example" // string | A service ID. hskCreateRequest := *openapiclient.NewHskCreateRequest() // HskCreateRequest | configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.HskOperationsApi.HskCreateApi(context.Background()).HskCreateRequest(hskCreateRequest).Execute() + resp, r, err := apiClient.HskOperationsApi.HskCreateApi(context.Background(), serviceId).HskCreateRequest(hskCreateRequest).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `HskOperationsApi.HskCreateApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -47,6 +48,10 @@ func main() { ### Path Parameters +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | ### Other Parameters @@ -55,6 +60,7 @@ Other parameters are passed through a pointer to a apiHskCreateApiRequest struct Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **hskCreateRequest** | [**HskCreateRequest**](HskCreateRequest.md) | | ### Return type @@ -63,7 +69,7 @@ Name | Type | Description | Notes ### Authorization -[ServiceOwnerCredentials](../README.md#ServiceOwnerCredentials) +[ModifyService](../README.md#ModifyService) ### HTTP request headers @@ -77,9 +83,9 @@ Name | Type | Description | Notes ## HskDeleteApi -> HskDeleteResponse HskDeleteApi(ctx, handle).Execute() +> HskDeleteResponse HskDeleteApi(ctx, serviceId, handle).Execute() -/api/hsk/delete/{handle} API +/api/{serviceId}/hsk/delete/{handle} API ### Example @@ -94,11 +100,12 @@ import ( ) func main() { + serviceId := "serviceId_example" // string | A service ID. handle := "handle_example" // string | configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.HskOperationsApi.HskDeleteApi(context.Background(), handle).Execute() + resp, r, err := apiClient.HskOperationsApi.HskDeleteApi(context.Background(), serviceId, handle).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `HskOperationsApi.HskDeleteApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -114,6 +121,7 @@ func main() { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | **handle** | **string** | | ### Other Parameters @@ -125,13 +133,14 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + ### Return type [**HskDeleteResponse**](HskDeleteResponse.md) ### Authorization -[ServiceOwnerCredentials](../README.md#ServiceOwnerCredentials) +[ModifyService](../README.md#ModifyService) ### HTTP request headers @@ -145,9 +154,9 @@ Name | Type | Description | Notes ## HskGetApi -> HskGetResponse HskGetApi(ctx, handle).Execute() +> HskGetResponse HskGetApi(ctx, serviceId, handle).Execute() -/api/hsk/get/{handle} API +/api/{serviceId}/hsk/get/{handle} API ### Example @@ -162,11 +171,12 @@ import ( ) func main() { + serviceId := "serviceId_example" // string | A service ID. handle := "handle_example" // string | configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.HskOperationsApi.HskGetApi(context.Background(), handle).Execute() + resp, r, err := apiClient.HskOperationsApi.HskGetApi(context.Background(), serviceId, handle).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `HskOperationsApi.HskGetApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -182,6 +192,7 @@ func main() { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | **handle** | **string** | | ### Other Parameters @@ -193,13 +204,14 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + ### Return type [**HskGetResponse**](HskGetResponse.md) ### Authorization -[ServiceOwnerCredentials](../README.md#ServiceOwnerCredentials) +[UseService](../README.md#UseService) ### HTTP request headers @@ -213,9 +225,9 @@ Name | Type | Description | Notes ## HskGetListApi -> HskGetListResponse HskGetListApi(ctx).Execute() +> HskGetListResponse HskGetListApi(ctx, serviceId).Execute() -/api/hsk/get/list API +/api/{serviceId}/hsk/get/list API ### Example @@ -230,10 +242,11 @@ import ( ) func main() { + serviceId := "serviceId_example" // string | A service ID. configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.HskOperationsApi.HskGetListApi(context.Background()).Execute() + resp, r, err := apiClient.HskOperationsApi.HskGetListApi(context.Background(), serviceId).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `HskOperationsApi.HskGetListApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -245,20 +258,28 @@ func main() { ### Path Parameters -This endpoint does not need any parameter. + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | ### Other Parameters Other parameters are passed through a pointer to a apiHskGetListApiRequest struct via the builder pattern +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + ### Return type [**HskGetListResponse**](HskGetListResponse.md) ### Authorization -[ServiceOwnerCredentials](../README.md#ServiceOwnerCredentials) +[UseService](../README.md#UseService) ### HTTP request headers diff --git a/docs/IntrospectionEndpointApi.md b/docs/IntrospectionEndpointApi.md index 724ffcc..079ac7f 100644 --- a/docs/IntrospectionEndpointApi.md +++ b/docs/IntrospectionEndpointApi.md @@ -1,19 +1,19 @@ # \IntrospectionEndpointApi -All URIs are relative to *https://api.authlete.com* +All URIs are relative to *https://beta.authlete.com* Method | HTTP request | Description ------------- | ------------- | ------------- -[**AuthIntrospectionApi**](IntrospectionEndpointApi.md#AuthIntrospectionApi) | **Post** /api/auth/introspection | /api/auth/introspection API -[**AuthIntrospectionStandardApi**](IntrospectionEndpointApi.md#AuthIntrospectionStandardApi) | **Post** /api/auth/introspection/standard | /api/auth/introspection/standard API +[**AuthIntrospectionApi**](IntrospectionEndpointApi.md#AuthIntrospectionApi) | **Post** /api/{serviceId}/auth/introspection | /api/{serviceId}/auth/introspection API +[**AuthIntrospectionStandardApi**](IntrospectionEndpointApi.md#AuthIntrospectionStandardApi) | **Post** /api/{serviceId}/auth/introspection/standard | /api/{serviceId}/auth/introspection/standard API ## AuthIntrospectionApi -> IntrospectionResponse AuthIntrospectionApi(ctx).IntrospectionRequest(introspectionRequest).Execute() +> IntrospectionResponse AuthIntrospectionApi(ctx, serviceId).IntrospectionRequest(introspectionRequest).Execute() -/api/auth/introspection API +/api/{serviceId}/auth/introspection API @@ -30,11 +30,12 @@ import ( ) func main() { + serviceId := "serviceId_example" // string | A service ID. introspectionRequest := *openapiclient.NewIntrospectionRequest("Token_example") // IntrospectionRequest | configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.IntrospectionEndpointApi.AuthIntrospectionApi(context.Background()).IntrospectionRequest(introspectionRequest).Execute() + resp, r, err := apiClient.IntrospectionEndpointApi.AuthIntrospectionApi(context.Background(), serviceId).IntrospectionRequest(introspectionRequest).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `IntrospectionEndpointApi.AuthIntrospectionApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -47,6 +48,10 @@ func main() { ### Path Parameters +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | ### Other Parameters @@ -55,6 +60,7 @@ Other parameters are passed through a pointer to a apiAuthIntrospectionApiReques Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **introspectionRequest** | [**IntrospectionRequest**](IntrospectionRequest.md) | | ### Return type @@ -63,7 +69,7 @@ Name | Type | Description | Notes ### Authorization -[ServiceCredentials](../README.md#ServiceCredentials) +[UseService](../README.md#UseService) ### HTTP request headers @@ -77,9 +83,9 @@ Name | Type | Description | Notes ## AuthIntrospectionStandardApi -> StandardIntrospectionResponse AuthIntrospectionStandardApi(ctx).StandardIntrospectionRequest(standardIntrospectionRequest).Execute() +> StandardIntrospectionResponse AuthIntrospectionStandardApi(ctx, serviceId).StandardIntrospectionRequest(standardIntrospectionRequest).Execute() -/api/auth/introspection/standard API +/api/{serviceId}/auth/introspection/standard API @@ -96,11 +102,12 @@ import ( ) func main() { + serviceId := "serviceId_example" // string | A service ID. standardIntrospectionRequest := *openapiclient.NewStandardIntrospectionRequest("Parameters_example") // StandardIntrospectionRequest | configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.IntrospectionEndpointApi.AuthIntrospectionStandardApi(context.Background()).StandardIntrospectionRequest(standardIntrospectionRequest).Execute() + resp, r, err := apiClient.IntrospectionEndpointApi.AuthIntrospectionStandardApi(context.Background(), serviceId).StandardIntrospectionRequest(standardIntrospectionRequest).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `IntrospectionEndpointApi.AuthIntrospectionStandardApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -113,6 +120,10 @@ func main() { ### Path Parameters +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | ### Other Parameters @@ -121,6 +132,7 @@ Other parameters are passed through a pointer to a apiAuthIntrospectionStandardA Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **standardIntrospectionRequest** | [**StandardIntrospectionRequest**](StandardIntrospectionRequest.md) | | ### Return type @@ -129,7 +141,7 @@ Name | Type | Description | Notes ### Authorization -[ServiceCredentials](../README.md#ServiceCredentials) +[UseService](../README.md#UseService) ### HTTP request headers diff --git a/docs/IntrospectionResponse.md b/docs/IntrospectionResponse.md index cc5c0aa..13aa69b 100644 --- a/docs/IntrospectionResponse.md +++ b/docs/IntrospectionResponse.md @@ -34,7 +34,12 @@ Name | Type | Description | Notes **Acr** | Pointer to **string** | The Authentication Context Class Reference of the user authentication that the authorization server performed during the course of issuing the access token. | [optional] **AuthTime** | Pointer to **int64** | The time when the user authentication was performed during the course of issuing the access token. | [optional] **ClientEntityId** | Pointer to **string** | The entity ID of the client. | [optional] -**ClientEntityIdUsed** | Pointer to **bool** | Flag which indicates whether the entity ID of the client was used when the request for the access token was made. | [optional] +**ClientEntityIdUsed** | Pointer to **bool** | Flag which indicates whether the entity ID of the client was used when the request for the access token was made. | [optional] +**ForCredentialIssuance** | Pointer to **bool** | The flag indicating whether the token is for credential issuance. | [optional] +**Cnonce** | Pointer to **string** | The c_nonce | [optional] +**CnonceExpiresAt** | Pointer to **int64** | The time at which the `c_nonce` expires. | [optional] +**IssuableCredentials** | Pointer to **string** | The credentials that can be obtained by presenting the access token. | [optional] +**DpopNonce** | Pointer to **string** | The expected nonce value for DPoP proof JWT, which should be used as the value of the `DPoP-Nonce` HTTP header. | [optional] ## Methods @@ -830,6 +835,131 @@ SetClientEntityIdUsed sets ClientEntityIdUsed field to given value. HasClientEntityIdUsed returns a boolean if a field has been set. +### GetForCredentialIssuance + +`func (o *IntrospectionResponse) GetForCredentialIssuance() bool` + +GetForCredentialIssuance returns the ForCredentialIssuance field if non-nil, zero value otherwise. + +### GetForCredentialIssuanceOk + +`func (o *IntrospectionResponse) GetForCredentialIssuanceOk() (*bool, bool)` + +GetForCredentialIssuanceOk returns a tuple with the ForCredentialIssuance field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetForCredentialIssuance + +`func (o *IntrospectionResponse) SetForCredentialIssuance(v bool)` + +SetForCredentialIssuance sets ForCredentialIssuance field to given value. + +### HasForCredentialIssuance + +`func (o *IntrospectionResponse) HasForCredentialIssuance() bool` + +HasForCredentialIssuance returns a boolean if a field has been set. + +### GetCnonce + +`func (o *IntrospectionResponse) GetCnonce() string` + +GetCnonce returns the Cnonce field if non-nil, zero value otherwise. + +### GetCnonceOk + +`func (o *IntrospectionResponse) GetCnonceOk() (*string, bool)` + +GetCnonceOk returns a tuple with the Cnonce field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCnonce + +`func (o *IntrospectionResponse) SetCnonce(v string)` + +SetCnonce sets Cnonce field to given value. + +### HasCnonce + +`func (o *IntrospectionResponse) HasCnonce() bool` + +HasCnonce returns a boolean if a field has been set. + +### GetCnonceExpiresAt + +`func (o *IntrospectionResponse) GetCnonceExpiresAt() int64` + +GetCnonceExpiresAt returns the CnonceExpiresAt field if non-nil, zero value otherwise. + +### GetCnonceExpiresAtOk + +`func (o *IntrospectionResponse) GetCnonceExpiresAtOk() (*int64, bool)` + +GetCnonceExpiresAtOk returns a tuple with the CnonceExpiresAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCnonceExpiresAt + +`func (o *IntrospectionResponse) SetCnonceExpiresAt(v int64)` + +SetCnonceExpiresAt sets CnonceExpiresAt field to given value. + +### HasCnonceExpiresAt + +`func (o *IntrospectionResponse) HasCnonceExpiresAt() bool` + +HasCnonceExpiresAt returns a boolean if a field has been set. + +### GetIssuableCredentials + +`func (o *IntrospectionResponse) GetIssuableCredentials() string` + +GetIssuableCredentials returns the IssuableCredentials field if non-nil, zero value otherwise. + +### GetIssuableCredentialsOk + +`func (o *IntrospectionResponse) GetIssuableCredentialsOk() (*string, bool)` + +GetIssuableCredentialsOk returns a tuple with the IssuableCredentials field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIssuableCredentials + +`func (o *IntrospectionResponse) SetIssuableCredentials(v string)` + +SetIssuableCredentials sets IssuableCredentials field to given value. + +### HasIssuableCredentials + +`func (o *IntrospectionResponse) HasIssuableCredentials() bool` + +HasIssuableCredentials returns a boolean if a field has been set. + +### GetDpopNonce + +`func (o *IntrospectionResponse) GetDpopNonce() string` + +GetDpopNonce returns the DpopNonce field if non-nil, zero value otherwise. + +### GetDpopNonceOk + +`func (o *IntrospectionResponse) GetDpopNonceOk() (*string, bool)` + +GetDpopNonceOk returns a tuple with the DpopNonce field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDpopNonce + +`func (o *IntrospectionResponse) SetDpopNonce(v string)` + +SetDpopNonce sets DpopNonce field to given value. + +### HasDpopNonce + +`func (o *IntrospectionResponse) HasDpopNonce() bool` + +HasDpopNonce returns a boolean if a field has been set. + [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/JWKSetEndpointApi.md b/docs/JWKSetEndpointApi.md index c0d1a4b..32416c5 100644 --- a/docs/JWKSetEndpointApi.md +++ b/docs/JWKSetEndpointApi.md @@ -1,18 +1,18 @@ # \JWKSetEndpointApi -All URIs are relative to *https://api.authlete.com* +All URIs are relative to *https://beta.authlete.com* Method | HTTP request | Description ------------- | ------------- | ------------- -[**ServiceJwksGetApi**](JWKSetEndpointApi.md#ServiceJwksGetApi) | **Get** /api/service/jwks/get | /api/service/jwks/get API +[**ServiceJwksGetApi**](JWKSetEndpointApi.md#ServiceJwksGetApi) | **Get** /api/{serviceId}/service/jwks/get | /api/{serviceId}/service/jwks/get API ## ServiceJwksGetApi -> ServiceJwksGetResponse ServiceJwksGetApi(ctx).IncludePrivateKeys(includePrivateKeys).Pretty(pretty).Execute() +> ServiceJwksGetResponse ServiceJwksGetApi(ctx, serviceId).IncludePrivateKeys(includePrivateKeys).Pretty(pretty).Execute() -/api/service/jwks/get API +/api/{serviceId}/service/jwks/get API @@ -29,12 +29,13 @@ import ( ) func main() { + serviceId := "serviceId_example" // string | A service ID. includePrivateKeys := true // bool | The boolean value that indicates whether the response should include the private keys associated with the service or not. If `true`, the private keys are included in the response. The default value is `false`. (optional) pretty := true // bool | This boolean value indicates whether the JSON in the response should be formatted or not. If `true`, the JSON in the response is pretty-formatted. The default value is `false`. (optional) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.JWKSetEndpointApi.ServiceJwksGetApi(context.Background()).IncludePrivateKeys(includePrivateKeys).Pretty(pretty).Execute() + resp, r, err := apiClient.JWKSetEndpointApi.ServiceJwksGetApi(context.Background(), serviceId).IncludePrivateKeys(includePrivateKeys).Pretty(pretty).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `JWKSetEndpointApi.ServiceJwksGetApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -47,6 +48,10 @@ func main() { ### Path Parameters +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | ### Other Parameters @@ -55,6 +60,7 @@ Other parameters are passed through a pointer to a apiServiceJwksGetApiRequest s Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **includePrivateKeys** | **bool** | The boolean value that indicates whether the response should include the private keys associated with the service or not. If `true`, the private keys are included in the response. The default value is `false`. | **pretty** | **bool** | This boolean value indicates whether the JSON in the response should be formatted or not. If `true`, the JSON in the response is pretty-formatted. The default value is `false`. | @@ -64,7 +70,7 @@ Name | Type | Description | Notes ### Authorization -[ServiceCredentials](../README.md#ServiceCredentials) +[UseService](../README.md#UseService) ### HTTP request headers diff --git a/docs/JoseObjectApi.md b/docs/JoseObjectApi.md index 4b1b6ac..2593422 100644 --- a/docs/JoseObjectApi.md +++ b/docs/JoseObjectApi.md @@ -1,18 +1,18 @@ # \JoseObjectApi -All URIs are relative to *https://api.authlete.com* +All URIs are relative to *https://beta.authlete.com* Method | HTTP request | Description ------------- | ------------- | ------------- -[**JoseVerifyApi**](JoseObjectApi.md#JoseVerifyApi) | **Post** /api/jose/verify | /api/jose/verify API +[**JoseVerifyApi**](JoseObjectApi.md#JoseVerifyApi) | **Post** /api/{serviceId}/jose/verify | /api/{serviceId}/jose/verify API ## JoseVerifyApi -> JoseVerifyResponse JoseVerifyApi(ctx).JoseVerifyRequest(joseVerifyRequest).Execute() +> JoseVerifyResponse JoseVerifyApi(ctx, serviceId).JoseVerifyRequest(joseVerifyRequest).Execute() -/api/jose/verify API +/api/{serviceId}/jose/verify API @@ -29,11 +29,12 @@ import ( ) func main() { + serviceId := "serviceId_example" // string | A service ID. joseVerifyRequest := *openapiclient.NewJoseVerifyRequest("Jose_example") // JoseVerifyRequest | (optional) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.JoseObjectApi.JoseVerifyApi(context.Background()).JoseVerifyRequest(joseVerifyRequest).Execute() + resp, r, err := apiClient.JoseObjectApi.JoseVerifyApi(context.Background(), serviceId).JoseVerifyRequest(joseVerifyRequest).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `JoseObjectApi.JoseVerifyApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -46,6 +47,10 @@ func main() { ### Path Parameters +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | ### Other Parameters @@ -54,6 +59,7 @@ Other parameters are passed through a pointer to a apiJoseVerifyApiRequest struc Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **joseVerifyRequest** | [**JoseVerifyRequest**](JoseVerifyRequest.md) | | ### Return type @@ -62,7 +68,7 @@ Name | Type | Description | Notes ### Authorization -[ServiceOwnerCredentials](../README.md#ServiceOwnerCredentials) +[UseService](../README.md#UseService) ### HTTP request headers diff --git a/docs/PushedAuthorizationEndpointApi.md b/docs/PushedAuthorizationEndpointApi.md index d6e79a6..9cc70da 100644 --- a/docs/PushedAuthorizationEndpointApi.md +++ b/docs/PushedAuthorizationEndpointApi.md @@ -1,18 +1,18 @@ # \PushedAuthorizationEndpointApi -All URIs are relative to *https://api.authlete.com* +All URIs are relative to *https://beta.authlete.com* Method | HTTP request | Description ------------- | ------------- | ------------- -[**PushedAuthReqApi**](PushedAuthorizationEndpointApi.md#PushedAuthReqApi) | **Post** /api/pushed_auth_req | /api/pushed_auth_req API +[**PushedAuthReqApi**](PushedAuthorizationEndpointApi.md#PushedAuthReqApi) | **Post** /api/{serviceId}/pushed_auth_req | /api/{serviceId}/pushed_auth_req API ## PushedAuthReqApi -> PushedAuthorizationResponse PushedAuthReqApi(ctx).PushedAuthorizationRequest(pushedAuthorizationRequest).Execute() +> PushedAuthorizationResponse PushedAuthReqApi(ctx, serviceId).PushedAuthorizationRequest(pushedAuthorizationRequest).Execute() -/api/pushed_auth_req API +/api/{serviceId}/pushed_auth_req API @@ -29,11 +29,12 @@ import ( ) func main() { + serviceId := "serviceId_example" // string | A service ID. pushedAuthorizationRequest := *openapiclient.NewPushedAuthorizationRequest("Parameters_example") // PushedAuthorizationRequest | configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.PushedAuthorizationEndpointApi.PushedAuthReqApi(context.Background()).PushedAuthorizationRequest(pushedAuthorizationRequest).Execute() + resp, r, err := apiClient.PushedAuthorizationEndpointApi.PushedAuthReqApi(context.Background(), serviceId).PushedAuthorizationRequest(pushedAuthorizationRequest).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `PushedAuthorizationEndpointApi.PushedAuthReqApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -46,6 +47,10 @@ func main() { ### Path Parameters +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | ### Other Parameters @@ -54,6 +59,7 @@ Other parameters are passed through a pointer to a apiPushedAuthReqApiRequest st Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **pushedAuthorizationRequest** | [**PushedAuthorizationRequest**](PushedAuthorizationRequest.md) | | ### Return type @@ -62,7 +68,7 @@ Name | Type | Description | Notes ### Authorization -[ServiceCredentials](../README.md#ServiceCredentials) +[UseService](../README.md#UseService) ### HTTP request headers diff --git a/docs/PushedAuthorizationResponse.md b/docs/PushedAuthorizationResponse.md index addc66d..0c9a348 100644 --- a/docs/PushedAuthorizationResponse.md +++ b/docs/PushedAuthorizationResponse.md @@ -9,6 +9,8 @@ Name | Type | Description | Notes **Action** | Pointer to **string** | The next action that the authorization server implementation should take. Any other value other than \"CREATED\" should be handled as unsuccessful result. | [optional] **RequestUri** | Pointer to **string** | The request_uri created to the client to be used as request_uri on the authorize call. | [optional] **ResponseContent** | Pointer to **string** | The content that the authorization server implementation is to return to the client application. | [optional] +**ClientAuthMethod** | Pointer to **string** | The client authentication method that the client application declares that it uses at the token endpoint. This property corresponds to `token_endpoint_auth_method` in [OpenID Connect Dynamic Client Registration 1.0, 2. Client Metadata](https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata). | [optional] +**DpopNonce** | Pointer to **string** | Get the expected nonce value for DPoP proof JWT, which should be used as the value of the `DPoP-Nonce` HTTP header. | [optional] ## Methods @@ -154,6 +156,56 @@ SetResponseContent sets ResponseContent field to given value. HasResponseContent returns a boolean if a field has been set. +### GetClientAuthMethod + +`func (o *PushedAuthorizationResponse) GetClientAuthMethod() string` + +GetClientAuthMethod returns the ClientAuthMethod field if non-nil, zero value otherwise. + +### GetClientAuthMethodOk + +`func (o *PushedAuthorizationResponse) GetClientAuthMethodOk() (*string, bool)` + +GetClientAuthMethodOk returns a tuple with the ClientAuthMethod field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientAuthMethod + +`func (o *PushedAuthorizationResponse) SetClientAuthMethod(v string)` + +SetClientAuthMethod sets ClientAuthMethod field to given value. + +### HasClientAuthMethod + +`func (o *PushedAuthorizationResponse) HasClientAuthMethod() bool` + +HasClientAuthMethod returns a boolean if a field has been set. + +### GetDpopNonce + +`func (o *PushedAuthorizationResponse) GetDpopNonce() string` + +GetDpopNonce returns the DpopNonce field if non-nil, zero value otherwise. + +### GetDpopNonceOk + +`func (o *PushedAuthorizationResponse) GetDpopNonceOk() (*string, bool)` + +GetDpopNonceOk returns a tuple with the DpopNonce field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDpopNonce + +`func (o *PushedAuthorizationResponse) SetDpopNonce(v string)` + +SetDpopNonce sets DpopNonce field to given value. + +### HasDpopNonce + +`func (o *PushedAuthorizationResponse) HasDpopNonce() bool` + +HasDpopNonce returns a boolean if a field has been set. + [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/RevocationEndpointApi.md b/docs/RevocationEndpointApi.md index a8b4c7c..50561fd 100644 --- a/docs/RevocationEndpointApi.md +++ b/docs/RevocationEndpointApi.md @@ -1,18 +1,18 @@ # \RevocationEndpointApi -All URIs are relative to *https://api.authlete.com* +All URIs are relative to *https://beta.authlete.com* Method | HTTP request | Description ------------- | ------------- | ------------- -[**AuthRevocationApi**](RevocationEndpointApi.md#AuthRevocationApi) | **Post** /api/auth/revocation | /api/auth/revocation API +[**AuthRevocationApi**](RevocationEndpointApi.md#AuthRevocationApi) | **Post** /api/{serviceId}/auth/revocation | /api/{serviceId}/auth/revocation API ## AuthRevocationApi -> RevocationResponse AuthRevocationApi(ctx).RevocationRequest(revocationRequest).Execute() +> RevocationResponse AuthRevocationApi(ctx, serviceId).RevocationRequest(revocationRequest).Execute() -/api/auth/revocation API +/api/{serviceId}/auth/revocation API @@ -29,11 +29,12 @@ import ( ) func main() { + serviceId := "serviceId_example" // string | A service ID. revocationRequest := *openapiclient.NewRevocationRequest("Parameters_example") // RevocationRequest | configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.RevocationEndpointApi.AuthRevocationApi(context.Background()).RevocationRequest(revocationRequest).Execute() + resp, r, err := apiClient.RevocationEndpointApi.AuthRevocationApi(context.Background(), serviceId).RevocationRequest(revocationRequest).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `RevocationEndpointApi.AuthRevocationApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -46,6 +47,10 @@ func main() { ### Path Parameters +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | ### Other Parameters @@ -54,6 +59,7 @@ Other parameters are passed through a pointer to a apiAuthRevocationApiRequest s Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **revocationRequest** | [**RevocationRequest**](RevocationRequest.md) | | ### Return type @@ -62,7 +68,7 @@ Name | Type | Description | Notes ### Authorization -[ServiceCredentials](../README.md#ServiceCredentials) +[UseService](../README.md#UseService) ### HTTP request headers diff --git a/docs/ServerMetadataApi.md b/docs/ServerMetadataApi.md index 3efb49d..31a4aa1 100644 --- a/docs/ServerMetadataApi.md +++ b/docs/ServerMetadataApi.md @@ -1,6 +1,6 @@ # \ServerMetadataApi -All URIs are relative to *https://api.authlete.com* +All URIs are relative to *https://beta.authlete.com* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -57,7 +57,7 @@ Other parameters are passed through a pointer to a apiInfoApiRequest struct via ### Authorization -[ServiceCredentials](../README.md#ServiceCredentials) +No authorization required ### HTTP request headers diff --git a/docs/Service.md b/docs/Service.md index 0128ae7..3bc0455 100644 --- a/docs/Service.md +++ b/docs/Service.md @@ -5,28 +5,18 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Number** | Pointer to **int32** | The sequential number of the service. The value of this property is assigned by Authlete. | [optional] [readonly] -**ServiceOwnerNumber** | Pointer to **int32** | The sequential number of the service owner of the service. The value of this property is assigned by Authlete. | [optional] [readonly] **ServiceName** | Pointer to **string** | The name of this service. | [optional] **Issuer** | Pointer to **string** | The issuer identifier of the service. A URL that starts with https:// and has no query or fragment component. The value of this property is used as `iss` claim in an [ID token](https://openid.net/specs/openid-connect-core-1_0.html#IDToken) and `issuer` property in the [OpenID Provider Metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). | [optional] **Description** | Pointer to **string** | The description about the service. | [optional] -**ApiKey** | Pointer to **int64** | The API key. The value of this property is assigned by Authlete. | [optional] [readonly] -**ApiSecret** | Pointer to **string** | The API secret. A random 256-bit value encoded by base64url (43 letters). The value of this property is assigned by Authlete. | [optional] [readonly] -**ClientsPerDeveloper** | Pointer to **int32** | The maximum number of client applications that a developer is allowed to create. `0` means no limit. | [optional] [readonly] -**ClientIdAliasEnabled** | Pointer to **bool** | The flag to indicate whether the 'Client ID Alias' feature is enabled or not. When a new client is created, Authlete generates a numeric value and assigns it as a client ID to the newly created client. In addition to the client ID, each client can have a client ID alias. The client ID alias is, however, recognized only when this property (`clientIdAliasEnabled`) is set to `true`. | [optional] +**ApiKey** | Pointer to **int64** | The service ID used in Authlete API calls. The value of this property is assigned by Authlete. | [optional] [readonly] +**ClientIdAliasEnabled** | Pointer to **bool** | Deprecated. Always `true`. | [optional] **Metadata** | Pointer to [**[]Pair**](Pair.md) | The `metadata` of the service. The content of the returned array depends on contexts. The predefined service metadata is listed in the following table. | Key | Description | | --- | --- | | `clientCount` | The number of client applications which belong to this service. | | [optional] **CreatedAt** | Pointer to **int64** | The time at which this service was created. The value is represented as milliseconds since the UNIX epoch (`1970-01-01`). | [optional] [readonly] **ModifiedAt** | Pointer to **int64** | The time at which this service was last modified. The value is represented as milliseconds since the UNIX epoch (1970-01-01). | [optional] [readonly] **AuthenticationCallbackEndpoint** | Pointer to **string** | A Web API endpoint for user authentication which is to be prepared on the service side. The endpoint must be implemented if you do not implement the UI at the authorization endpoint but use the one provided by Authlete. The user authentication at the authorization endpoint provided by Authlete is performed by making a `POST` request to this endpoint. | [optional] **AuthenticationCallbackApiKey** | Pointer to **string** | API key for basic authentication at the authentication callback endpoint. If the value is not empty, Authlete generates Authorization header for Basic authentication when making a request to the authentication callback endpoint. | [optional] **AuthenticationCallbackApiSecret** | Pointer to **string** | API secret for `basic` authentication at the authentication callback endpoint. | [optional] -**SupportedSnses** | Pointer to [**[]Sns**](Sns.md) | SNSes you want to support 'social login' in the UI at the authorization endpoint provided by Authlete. You need to register a `client` application in each SNS that is set as this parameter and set Authlete server's `/api/sns/redirection` as the redirection endpoint of the client application. | [optional] -**SnsCredentials** | Pointer to [**[]SnsCredentials**](SnsCredentials.md) | `SNS` credentials which Authlete uses to make requests to SNSes. The format is JSON. | [optional] **SupportedAcrs** | Pointer to **[]string** | Values of acrs (authentication context class references) that the service supports. The value of this property is used as `acr_values_supported` property in the [OpenID Provider Metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). | [optional] [readonly] -**DeveloperAuthenticationCallbackEndpoint** | Pointer to **string** | A Web API endpoint for developer authentication which is to be prepared on the server side. The endpoint must be implemented if you use Developer Console. The developer authentication at the login page of Developer Console is performed by making a `POST` request to this endpoint. | [optional] -**DeveloperAuthenticationCallbackApiKey** | Pointer to **string** | API key for basic authentication at the developer authentication callback endpoint. If the value is not empty, Authlete generates Authorization header for Basic authentication when making a request to the developer authentication callback endpoint. | [optional] -**DeveloperAuthenticationCallbackApiSecret** | Pointer to **string** | API secret for basic authentication at the developer authentication callback endpoint. | [optional] -**SupportedDeveloperSnses** | Pointer to [**[]Sns**](Sns.md) | SNSes you want to support 'social login' in the login page of Developer Console provided by Authlete. You need to register a client application in each SNS checked here and set Authlete server's `/api/developer/sns/redirection` as the redirection endpoint of the client application. | [optional] -**DeveloperSnsCredentials** | Pointer to [**[]SnsCredentials**](SnsCredentials.md) | SNS credentials which Authlete uses to make requests to SNSes. The format is JSON. | [optional] **SupportedGrantTypes** | Pointer to [**[]GrantType**](GrantType.md) | Values of `grant_type` request parameter that the service supports. The value of this property is used as `grant_types_supported property` in the [OpenID Provider Metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). | [optional] **SupportedResponseTypes** | Pointer to [**[]ResponseType**](ResponseType.md) | Values of `response_type` request parameter that the service supports. Valid values are listed in Response Type. The value of this property is used as `response_types_supported` property in the [OpenID Provider Metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). | [optional] **SupportedAuthorizationDetailsTypes** | Pointer to **[]string** | The supported data types that can be used as values of the type field in `authorization_details`. This property corresponds to the `authorization_details_types_supported` metadata. See \"OAuth 2.0 Rich Authorization Requests\" (RAR) for details. | [optional] @@ -155,12 +145,27 @@ Name | Type | Description | Notes **JwtGrantUnsignedJwtRejected** | Pointer to **bool** | The flag indicating whether to reject token requests that use an unsigned JWT as an authorization grant with the grant type \"urn:ietf:params:oauth:grant-type:jwt-bearer\". | [optional] **DcrDuplicateSoftwareIdBlocked** | Pointer to **bool** | The flag indicating whether to block DCR (Dynamic Client Registration) requests whose \"software_id\" has already been used previously. | [optional] **TrustAnchors** | Pointer to [**[]TrustAnchor**](TrustAnchor.md) | The trust anchors that are referenced when this service resolves trust chains of relying parties. If this property is empty, client registration fails regardless of whether its type is `automatic` or `explicit`. It means that OpenID Connect Federation 1.0 does not work. | [optional] -**OpenidDroppedOnRefreshWithoutOfflineAccess** | Pointer to **bool** | The flag indicating whether the openid scope should be dropped from scopes list assigned to access token issued when a refresh token grant is used. | [optional] +**OpenidDroppedOnRefreshWithoutOfflineAccess** | Pointer to **bool** | The flag indicating whether the openid scope should be dropped from scopes list assigned to access token issued when a refresh token grant is used. | [optional] **SupportedDocumentsCheckMethods** | Pointer to **[]string** | Supported document check methods. This property corresponds to the `documents_check_methods_supported` server metadata which was added by the fourth implementer's draft of OpenID Connect for Identity Assurance 1.0. | [optional] **RsResponseSigned** | Pointer to **bool** | The flag indicating whether this service signs responses from the resource server. | [optional] -**ResourceSignatureKeyId** | Pointer to **string** | Get the key ID of a JWK containing the public key used by this client to sign requests to the resource server. | [optional] -**IdTokenAudType** | Pointer to **string** | The type of the `aud` claim in ID tokens. | [optional] -**IdTokenReissuable** | Pointer to **bool** | The flag indicating whether to enable the feature of ID token reissuance in the refresh token flow. | [optional] +**CnonceDuration** | Pointer to **int64** | The duration of `c_nonce`. | [optional] +**DpopNonceRequired** | Pointer to **bool** | Whether to require DPoP proof JWTs to include the `nonce` claim whenever they are presented. | [optional] +**VerifiableCredentialsEnabled** | Pointer to **bool** | Get the flag indicating whether the feature of Verifiable Credentials for this service is enabled or not. | [optional] +**CredentialJwksUri** | Pointer to **string** | The URL at which the JWK Set document of the credential issuer is exposed. | [optional] +**CredentialOfferDuration** | Pointer to **int64** | The default duration of credential offers in seconds. | [optional] +**DpopNonceDuration** | Pointer to **int64** | The duration of nonce values for DPoP proof JWTs in seconds. | [optional] +**PreAuthorizedGrantAnonymousAccessSupported** | Pointer to **bool** | The flag indicating whether token requests using the pre-authorized code grant flow by unidentifiable clients are allowed. | [optional] +**CredentialTransactionDuration** | Pointer to **int64** | The duration of transaction ID in seconds that may be issued as a result of a credential request or a batch credential request. | [optional] +**IntrospectionSignatureKeyId** | Pointer to **string** | The key ID of the key for signing introspection responses. | [optional] +**ResourceSignatureKeyId** | Pointer to **string** | The key ID of the key for signing introspection responses. | [optional] +**UserPinLength** | Pointer to **int32** | The default length of user PINs. | [optional] +**SupportedPromptValues** | Pointer to [**[]Prompt**](Prompt.md) | The supported `prompt` values. | [optional] +**IdTokenReissuable** | Pointer to **bool** | The flag indicating whether to enable the feature of ID token reissuance in the refresh token flow. | [optional] +**CredentialJwks** | Pointer to **string** | The JWK Set document containing private keys that are used to sign verifiable credentials. | [optional] +**FapiModes** | Pointer to [**[]FapiMode**](FapiMode.md) | FAPI modes for this service. When the value of this property is not `null`, Authlete always processes requests to this service based on the specified FAPI modes if the FAPI feature is enabled in Authlete and the FAPI profile is supported by this service. For instance, when this property is set to an array containing `FAPI1_ADVANCED` only, Authlete always processes requests to this service based on \"Financial-grade API Security Profile 1.0 - Part 2: Advanced\" if the FAPI feature is enabled in Authlete and the FAPI profile is supported by this service. | [optional] +**CredentialDuration** | Pointer to **int64** | The default duration of verifiable credentials in seconds. | [optional] +**CredentialIssuerMetadata** | Pointer to [**CredentialIssuerMetadata**](CredentialIssuerMetadata.md) | | [optional] +**IdTokenAudType** | Pointer to **string** | The type of the `aud` claim in ID tokens. | [optional] ## Methods @@ -206,31 +211,6 @@ SetNumber sets Number field to given value. HasNumber returns a boolean if a field has been set. -### GetServiceOwnerNumber - -`func (o *Service) GetServiceOwnerNumber() int32` - -GetServiceOwnerNumber returns the ServiceOwnerNumber field if non-nil, zero value otherwise. - -### GetServiceOwnerNumberOk - -`func (o *Service) GetServiceOwnerNumberOk() (*int32, bool)` - -GetServiceOwnerNumberOk returns a tuple with the ServiceOwnerNumber field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### SetServiceOwnerNumber - -`func (o *Service) SetServiceOwnerNumber(v int32)` - -SetServiceOwnerNumber sets ServiceOwnerNumber field to given value. - -### HasServiceOwnerNumber - -`func (o *Service) HasServiceOwnerNumber() bool` - -HasServiceOwnerNumber returns a boolean if a field has been set. - ### GetServiceName `func (o *Service) GetServiceName() string` @@ -331,56 +311,6 @@ SetApiKey sets ApiKey field to given value. HasApiKey returns a boolean if a field has been set. -### GetApiSecret - -`func (o *Service) GetApiSecret() string` - -GetApiSecret returns the ApiSecret field if non-nil, zero value otherwise. - -### GetApiSecretOk - -`func (o *Service) GetApiSecretOk() (*string, bool)` - -GetApiSecretOk returns a tuple with the ApiSecret field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### SetApiSecret - -`func (o *Service) SetApiSecret(v string)` - -SetApiSecret sets ApiSecret field to given value. - -### HasApiSecret - -`func (o *Service) HasApiSecret() bool` - -HasApiSecret returns a boolean if a field has been set. - -### GetClientsPerDeveloper - -`func (o *Service) GetClientsPerDeveloper() int32` - -GetClientsPerDeveloper returns the ClientsPerDeveloper field if non-nil, zero value otherwise. - -### GetClientsPerDeveloperOk - -`func (o *Service) GetClientsPerDeveloperOk() (*int32, bool)` - -GetClientsPerDeveloperOk returns a tuple with the ClientsPerDeveloper field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### SetClientsPerDeveloper - -`func (o *Service) SetClientsPerDeveloper(v int32)` - -SetClientsPerDeveloper sets ClientsPerDeveloper field to given value. - -### HasClientsPerDeveloper - -`func (o *Service) HasClientsPerDeveloper() bool` - -HasClientsPerDeveloper returns a boolean if a field has been set. - ### GetClientIdAliasEnabled `func (o *Service) GetClientIdAliasEnabled() bool` @@ -556,56 +486,6 @@ SetAuthenticationCallbackApiSecret sets AuthenticationCallbackApiSecret field to HasAuthenticationCallbackApiSecret returns a boolean if a field has been set. -### GetSupportedSnses - -`func (o *Service) GetSupportedSnses() []Sns` - -GetSupportedSnses returns the SupportedSnses field if non-nil, zero value otherwise. - -### GetSupportedSnsesOk - -`func (o *Service) GetSupportedSnsesOk() (*[]Sns, bool)` - -GetSupportedSnsesOk returns a tuple with the SupportedSnses field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### SetSupportedSnses - -`func (o *Service) SetSupportedSnses(v []Sns)` - -SetSupportedSnses sets SupportedSnses field to given value. - -### HasSupportedSnses - -`func (o *Service) HasSupportedSnses() bool` - -HasSupportedSnses returns a boolean if a field has been set. - -### GetSnsCredentials - -`func (o *Service) GetSnsCredentials() []SnsCredentials` - -GetSnsCredentials returns the SnsCredentials field if non-nil, zero value otherwise. - -### GetSnsCredentialsOk - -`func (o *Service) GetSnsCredentialsOk() (*[]SnsCredentials, bool)` - -GetSnsCredentialsOk returns a tuple with the SnsCredentials field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### SetSnsCredentials - -`func (o *Service) SetSnsCredentials(v []SnsCredentials)` - -SetSnsCredentials sets SnsCredentials field to given value. - -### HasSnsCredentials - -`func (o *Service) HasSnsCredentials() bool` - -HasSnsCredentials returns a boolean if a field has been set. - ### GetSupportedAcrs `func (o *Service) GetSupportedAcrs() []string` @@ -631,131 +511,6 @@ SetSupportedAcrs sets SupportedAcrs field to given value. HasSupportedAcrs returns a boolean if a field has been set. -### GetDeveloperAuthenticationCallbackEndpoint - -`func (o *Service) GetDeveloperAuthenticationCallbackEndpoint() string` - -GetDeveloperAuthenticationCallbackEndpoint returns the DeveloperAuthenticationCallbackEndpoint field if non-nil, zero value otherwise. - -### GetDeveloperAuthenticationCallbackEndpointOk - -`func (o *Service) GetDeveloperAuthenticationCallbackEndpointOk() (*string, bool)` - -GetDeveloperAuthenticationCallbackEndpointOk returns a tuple with the DeveloperAuthenticationCallbackEndpoint field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### SetDeveloperAuthenticationCallbackEndpoint - -`func (o *Service) SetDeveloperAuthenticationCallbackEndpoint(v string)` - -SetDeveloperAuthenticationCallbackEndpoint sets DeveloperAuthenticationCallbackEndpoint field to given value. - -### HasDeveloperAuthenticationCallbackEndpoint - -`func (o *Service) HasDeveloperAuthenticationCallbackEndpoint() bool` - -HasDeveloperAuthenticationCallbackEndpoint returns a boolean if a field has been set. - -### GetDeveloperAuthenticationCallbackApiKey - -`func (o *Service) GetDeveloperAuthenticationCallbackApiKey() string` - -GetDeveloperAuthenticationCallbackApiKey returns the DeveloperAuthenticationCallbackApiKey field if non-nil, zero value otherwise. - -### GetDeveloperAuthenticationCallbackApiKeyOk - -`func (o *Service) GetDeveloperAuthenticationCallbackApiKeyOk() (*string, bool)` - -GetDeveloperAuthenticationCallbackApiKeyOk returns a tuple with the DeveloperAuthenticationCallbackApiKey field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### SetDeveloperAuthenticationCallbackApiKey - -`func (o *Service) SetDeveloperAuthenticationCallbackApiKey(v string)` - -SetDeveloperAuthenticationCallbackApiKey sets DeveloperAuthenticationCallbackApiKey field to given value. - -### HasDeveloperAuthenticationCallbackApiKey - -`func (o *Service) HasDeveloperAuthenticationCallbackApiKey() bool` - -HasDeveloperAuthenticationCallbackApiKey returns a boolean if a field has been set. - -### GetDeveloperAuthenticationCallbackApiSecret - -`func (o *Service) GetDeveloperAuthenticationCallbackApiSecret() string` - -GetDeveloperAuthenticationCallbackApiSecret returns the DeveloperAuthenticationCallbackApiSecret field if non-nil, zero value otherwise. - -### GetDeveloperAuthenticationCallbackApiSecretOk - -`func (o *Service) GetDeveloperAuthenticationCallbackApiSecretOk() (*string, bool)` - -GetDeveloperAuthenticationCallbackApiSecretOk returns a tuple with the DeveloperAuthenticationCallbackApiSecret field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### SetDeveloperAuthenticationCallbackApiSecret - -`func (o *Service) SetDeveloperAuthenticationCallbackApiSecret(v string)` - -SetDeveloperAuthenticationCallbackApiSecret sets DeveloperAuthenticationCallbackApiSecret field to given value. - -### HasDeveloperAuthenticationCallbackApiSecret - -`func (o *Service) HasDeveloperAuthenticationCallbackApiSecret() bool` - -HasDeveloperAuthenticationCallbackApiSecret returns a boolean if a field has been set. - -### GetSupportedDeveloperSnses - -`func (o *Service) GetSupportedDeveloperSnses() []Sns` - -GetSupportedDeveloperSnses returns the SupportedDeveloperSnses field if non-nil, zero value otherwise. - -### GetSupportedDeveloperSnsesOk - -`func (o *Service) GetSupportedDeveloperSnsesOk() (*[]Sns, bool)` - -GetSupportedDeveloperSnsesOk returns a tuple with the SupportedDeveloperSnses field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### SetSupportedDeveloperSnses - -`func (o *Service) SetSupportedDeveloperSnses(v []Sns)` - -SetSupportedDeveloperSnses sets SupportedDeveloperSnses field to given value. - -### HasSupportedDeveloperSnses - -`func (o *Service) HasSupportedDeveloperSnses() bool` - -HasSupportedDeveloperSnses returns a boolean if a field has been set. - -### GetDeveloperSnsCredentials - -`func (o *Service) GetDeveloperSnsCredentials() []SnsCredentials` - -GetDeveloperSnsCredentials returns the DeveloperSnsCredentials field if non-nil, zero value otherwise. - -### GetDeveloperSnsCredentialsOk - -`func (o *Service) GetDeveloperSnsCredentialsOk() (*[]SnsCredentials, bool)` - -GetDeveloperSnsCredentialsOk returns a tuple with the DeveloperSnsCredentials field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### SetDeveloperSnsCredentials - -`func (o *Service) SetDeveloperSnsCredentials(v []SnsCredentials)` - -SetDeveloperSnsCredentials sets DeveloperSnsCredentials field to given value. - -### HasDeveloperSnsCredentials - -`func (o *Service) HasDeveloperSnsCredentials() bool` - -HasDeveloperSnsCredentials returns a boolean if a field has been set. - ### GetSupportedGrantTypes `func (o *Service) GetSupportedGrantTypes() []GrantType` @@ -4041,6 +3796,231 @@ SetRsResponseSigned sets RsResponseSigned field to given value. HasRsResponseSigned returns a boolean if a field has been set. +### GetCnonceDuration + +`func (o *Service) GetCnonceDuration() int64` + +GetCnonceDuration returns the CnonceDuration field if non-nil, zero value otherwise. + +### GetCnonceDurationOk + +`func (o *Service) GetCnonceDurationOk() (*int64, bool)` + +GetCnonceDurationOk returns a tuple with the CnonceDuration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCnonceDuration + +`func (o *Service) SetCnonceDuration(v int64)` + +SetCnonceDuration sets CnonceDuration field to given value. + +### HasCnonceDuration + +`func (o *Service) HasCnonceDuration() bool` + +HasCnonceDuration returns a boolean if a field has been set. + +### GetDpopNonceRequired + +`func (o *Service) GetDpopNonceRequired() bool` + +GetDpopNonceRequired returns the DpopNonceRequired field if non-nil, zero value otherwise. + +### GetDpopNonceRequiredOk + +`func (o *Service) GetDpopNonceRequiredOk() (*bool, bool)` + +GetDpopNonceRequiredOk returns a tuple with the DpopNonceRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDpopNonceRequired + +`func (o *Service) SetDpopNonceRequired(v bool)` + +SetDpopNonceRequired sets DpopNonceRequired field to given value. + +### HasDpopNonceRequired + +`func (o *Service) HasDpopNonceRequired() bool` + +HasDpopNonceRequired returns a boolean if a field has been set. + +### GetVerifiableCredentialsEnabled + +`func (o *Service) GetVerifiableCredentialsEnabled() bool` + +GetVerifiableCredentialsEnabled returns the VerifiableCredentialsEnabled field if non-nil, zero value otherwise. + +### GetVerifiableCredentialsEnabledOk + +`func (o *Service) GetVerifiableCredentialsEnabledOk() (*bool, bool)` + +GetVerifiableCredentialsEnabledOk returns a tuple with the VerifiableCredentialsEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVerifiableCredentialsEnabled + +`func (o *Service) SetVerifiableCredentialsEnabled(v bool)` + +SetVerifiableCredentialsEnabled sets VerifiableCredentialsEnabled field to given value. + +### HasVerifiableCredentialsEnabled + +`func (o *Service) HasVerifiableCredentialsEnabled() bool` + +HasVerifiableCredentialsEnabled returns a boolean if a field has been set. + +### GetCredentialJwksUri + +`func (o *Service) GetCredentialJwksUri() string` + +GetCredentialJwksUri returns the CredentialJwksUri field if non-nil, zero value otherwise. + +### GetCredentialJwksUriOk + +`func (o *Service) GetCredentialJwksUriOk() (*string, bool)` + +GetCredentialJwksUriOk returns a tuple with the CredentialJwksUri field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCredentialJwksUri + +`func (o *Service) SetCredentialJwksUri(v string)` + +SetCredentialJwksUri sets CredentialJwksUri field to given value. + +### HasCredentialJwksUri + +`func (o *Service) HasCredentialJwksUri() bool` + +HasCredentialJwksUri returns a boolean if a field has been set. + +### GetCredentialOfferDuration + +`func (o *Service) GetCredentialOfferDuration() int64` + +GetCredentialOfferDuration returns the CredentialOfferDuration field if non-nil, zero value otherwise. + +### GetCredentialOfferDurationOk + +`func (o *Service) GetCredentialOfferDurationOk() (*int64, bool)` + +GetCredentialOfferDurationOk returns a tuple with the CredentialOfferDuration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCredentialOfferDuration + +`func (o *Service) SetCredentialOfferDuration(v int64)` + +SetCredentialOfferDuration sets CredentialOfferDuration field to given value. + +### HasCredentialOfferDuration + +`func (o *Service) HasCredentialOfferDuration() bool` + +HasCredentialOfferDuration returns a boolean if a field has been set. + +### GetDpopNonceDuration + +`func (o *Service) GetDpopNonceDuration() int64` + +GetDpopNonceDuration returns the DpopNonceDuration field if non-nil, zero value otherwise. + +### GetDpopNonceDurationOk + +`func (o *Service) GetDpopNonceDurationOk() (*int64, bool)` + +GetDpopNonceDurationOk returns a tuple with the DpopNonceDuration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDpopNonceDuration + +`func (o *Service) SetDpopNonceDuration(v int64)` + +SetDpopNonceDuration sets DpopNonceDuration field to given value. + +### HasDpopNonceDuration + +`func (o *Service) HasDpopNonceDuration() bool` + +HasDpopNonceDuration returns a boolean if a field has been set. + +### GetPreAuthorizedGrantAnonymousAccessSupported + +`func (o *Service) GetPreAuthorizedGrantAnonymousAccessSupported() bool` + +GetPreAuthorizedGrantAnonymousAccessSupported returns the PreAuthorizedGrantAnonymousAccessSupported field if non-nil, zero value otherwise. + +### GetPreAuthorizedGrantAnonymousAccessSupportedOk + +`func (o *Service) GetPreAuthorizedGrantAnonymousAccessSupportedOk() (*bool, bool)` + +GetPreAuthorizedGrantAnonymousAccessSupportedOk returns a tuple with the PreAuthorizedGrantAnonymousAccessSupported field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPreAuthorizedGrantAnonymousAccessSupported + +`func (o *Service) SetPreAuthorizedGrantAnonymousAccessSupported(v bool)` + +SetPreAuthorizedGrantAnonymousAccessSupported sets PreAuthorizedGrantAnonymousAccessSupported field to given value. + +### HasPreAuthorizedGrantAnonymousAccessSupported + +`func (o *Service) HasPreAuthorizedGrantAnonymousAccessSupported() bool` + +HasPreAuthorizedGrantAnonymousAccessSupported returns a boolean if a field has been set. + +### GetCredentialTransactionDuration + +`func (o *Service) GetCredentialTransactionDuration() int64` + +GetCredentialTransactionDuration returns the CredentialTransactionDuration field if non-nil, zero value otherwise. + +### GetCredentialTransactionDurationOk + +`func (o *Service) GetCredentialTransactionDurationOk() (*int64, bool)` + +GetCredentialTransactionDurationOk returns a tuple with the CredentialTransactionDuration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCredentialTransactionDuration + +`func (o *Service) SetCredentialTransactionDuration(v int64)` + +SetCredentialTransactionDuration sets CredentialTransactionDuration field to given value. + +### HasCredentialTransactionDuration + +`func (o *Service) HasCredentialTransactionDuration() bool` + +HasCredentialTransactionDuration returns a boolean if a field has been set. + +### GetIntrospectionSignatureKeyId + +`func (o *Service) GetIntrospectionSignatureKeyId() string` + +GetIntrospectionSignatureKeyId returns the IntrospectionSignatureKeyId field if non-nil, zero value otherwise. + +### GetIntrospectionSignatureKeyIdOk + +`func (o *Service) GetIntrospectionSignatureKeyIdOk() (*string, bool)` + +GetIntrospectionSignatureKeyIdOk returns a tuple with the IntrospectionSignatureKeyId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIntrospectionSignatureKeyId + +`func (o *Service) SetIntrospectionSignatureKeyId(v string)` + +SetIntrospectionSignatureKeyId sets IntrospectionSignatureKeyId field to given value. + +### HasIntrospectionSignatureKeyId + +`func (o *Service) HasIntrospectionSignatureKeyId() bool` + +HasIntrospectionSignatureKeyId returns a boolean if a field has been set. + ### GetResourceSignatureKeyId `func (o *Service) GetResourceSignatureKeyId() string` @@ -4066,30 +4046,55 @@ SetResourceSignatureKeyId sets ResourceSignatureKeyId field to given value. HasResourceSignatureKeyId returns a boolean if a field has been set. -### GetIdTokenAudType +### GetUserPinLength -`func (o *Service) GetIdTokenAudType() string` +`func (o *Service) GetUserPinLength() int32` -GetIdTokenAudType returns the IdTokenAudType field if non-nil, zero value otherwise. +GetUserPinLength returns the UserPinLength field if non-nil, zero value otherwise. -### GetIdTokenAudTypeOk +### GetUserPinLengthOk -`func (o *Service) GetIdTokenAudTypeOk() (*string, bool)` +`func (o *Service) GetUserPinLengthOk() (*int32, bool)` -GetIdTokenAudTypeOk returns a tuple with the IdTokenAudType field if it's non-nil, zero value otherwise +GetUserPinLengthOk returns a tuple with the UserPinLength field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. -### SetIdTokenAudType +### SetUserPinLength -`func (o *Service) SetIdTokenAudType(v string)` +`func (o *Service) SetUserPinLength(v int32)` -SetIdTokenAudType sets IdTokenAudType field to given value. +SetUserPinLength sets UserPinLength field to given value. -### HasIdTokenAudType +### HasUserPinLength -`func (o *Service) HasIdTokenAudType() bool` +`func (o *Service) HasUserPinLength() bool` -HasIdTokenAudType returns a boolean if a field has been set. +HasUserPinLength returns a boolean if a field has been set. + +### GetSupportedPromptValues + +`func (o *Service) GetSupportedPromptValues() []Prompt` + +GetSupportedPromptValues returns the SupportedPromptValues field if non-nil, zero value otherwise. + +### GetSupportedPromptValuesOk + +`func (o *Service) GetSupportedPromptValuesOk() (*[]Prompt, bool)` + +GetSupportedPromptValuesOk returns a tuple with the SupportedPromptValues field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSupportedPromptValues + +`func (o *Service) SetSupportedPromptValues(v []Prompt)` + +SetSupportedPromptValues sets SupportedPromptValues field to given value. + +### HasSupportedPromptValues + +`func (o *Service) HasSupportedPromptValues() bool` + +HasSupportedPromptValues returns a boolean if a field has been set. ### GetIdTokenReissuable @@ -4116,6 +4121,131 @@ SetIdTokenReissuable sets IdTokenReissuable field to given value. HasIdTokenReissuable returns a boolean if a field has been set. +### GetCredentialJwks + +`func (o *Service) GetCredentialJwks() string` + +GetCredentialJwks returns the CredentialJwks field if non-nil, zero value otherwise. + +### GetCredentialJwksOk + +`func (o *Service) GetCredentialJwksOk() (*string, bool)` + +GetCredentialJwksOk returns a tuple with the CredentialJwks field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCredentialJwks + +`func (o *Service) SetCredentialJwks(v string)` + +SetCredentialJwks sets CredentialJwks field to given value. + +### HasCredentialJwks + +`func (o *Service) HasCredentialJwks() bool` + +HasCredentialJwks returns a boolean if a field has been set. + +### GetFapiModes + +`func (o *Service) GetFapiModes() []FapiMode` + +GetFapiModes returns the FapiModes field if non-nil, zero value otherwise. + +### GetFapiModesOk + +`func (o *Service) GetFapiModesOk() (*[]FapiMode, bool)` + +GetFapiModesOk returns a tuple with the FapiModes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFapiModes + +`func (o *Service) SetFapiModes(v []FapiMode)` + +SetFapiModes sets FapiModes field to given value. + +### HasFapiModes + +`func (o *Service) HasFapiModes() bool` + +HasFapiModes returns a boolean if a field has been set. + +### GetCredentialDuration + +`func (o *Service) GetCredentialDuration() int64` + +GetCredentialDuration returns the CredentialDuration field if non-nil, zero value otherwise. + +### GetCredentialDurationOk + +`func (o *Service) GetCredentialDurationOk() (*int64, bool)` + +GetCredentialDurationOk returns a tuple with the CredentialDuration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCredentialDuration + +`func (o *Service) SetCredentialDuration(v int64)` + +SetCredentialDuration sets CredentialDuration field to given value. + +### HasCredentialDuration + +`func (o *Service) HasCredentialDuration() bool` + +HasCredentialDuration returns a boolean if a field has been set. + +### GetCredentialIssuerMetadata + +`func (o *Service) GetCredentialIssuerMetadata() CredentialIssuerMetadata` + +GetCredentialIssuerMetadata returns the CredentialIssuerMetadata field if non-nil, zero value otherwise. + +### GetCredentialIssuerMetadataOk + +`func (o *Service) GetCredentialIssuerMetadataOk() (*CredentialIssuerMetadata, bool)` + +GetCredentialIssuerMetadataOk returns a tuple with the CredentialIssuerMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCredentialIssuerMetadata + +`func (o *Service) SetCredentialIssuerMetadata(v CredentialIssuerMetadata)` + +SetCredentialIssuerMetadata sets CredentialIssuerMetadata field to given value. + +### HasCredentialIssuerMetadata + +`func (o *Service) HasCredentialIssuerMetadata() bool` + +HasCredentialIssuerMetadata returns a boolean if a field has been set. + +### GetIdTokenAudType + +`func (o *Service) GetIdTokenAudType() string` + +GetIdTokenAudType returns the IdTokenAudType field if non-nil, zero value otherwise. + +### GetIdTokenAudTypeOk + +`func (o *Service) GetIdTokenAudTypeOk() (*string, bool)` + +GetIdTokenAudTypeOk returns a tuple with the IdTokenAudType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdTokenAudType + +`func (o *Service) SetIdTokenAudType(v string)` + +SetIdTokenAudType sets IdTokenAudType field to given value. + +### HasIdTokenAudType + +`func (o *Service) HasIdTokenAudType() bool` + +HasIdTokenAudType returns a boolean if a field has been set. + [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ServiceGetApi200Response.md b/docs/ServiceGetApi200Response.md new file mode 100644 index 0000000..735a59f --- /dev/null +++ b/docs/ServiceGetApi200Response.md @@ -0,0 +1,4252 @@ +# ServiceGetApi200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Number** | Pointer to **int32** | The sequential number of the service. The value of this property is assigned by Authlete. | [optional] [readonly] +**ServiceName** | Pointer to **string** | The name of this service. | [optional] +**Issuer** | Pointer to **string** | The issuer identifier of the service. A URL that starts with https:// and has no query or fragment component. The value of this property is used as `iss` claim in an [ID token](https://openid.net/specs/openid-connect-core-1_0.html#IDToken) and `issuer` property in the [OpenID Provider Metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). | [optional] +**Description** | Pointer to **string** | The description about the service. | [optional] +**ApiKey** | Pointer to **int64** | The service ID used in Authlete API calls. The value of this property is assigned by Authlete. | [optional] [readonly] +**ClientIdAliasEnabled** | Pointer to **bool** | Deprecated. Always `true`. | [optional] +**Metadata** | Pointer to [**[]Pair**](Pair.md) | The `metadata` of the service. The content of the returned array depends on contexts. The predefined service metadata is listed in the following table. | Key | Description | | --- | --- | | `clientCount` | The number of client applications which belong to this service. | | [optional] +**CreatedAt** | Pointer to **int64** | The time at which this service was created. The value is represented as milliseconds since the UNIX epoch (`1970-01-01`). | [optional] [readonly] +**ModifiedAt** | Pointer to **int64** | The time at which this service was last modified. The value is represented as milliseconds since the UNIX epoch (1970-01-01). | [optional] [readonly] +**AuthenticationCallbackEndpoint** | Pointer to **string** | A Web API endpoint for user authentication which is to be prepared on the service side. The endpoint must be implemented if you do not implement the UI at the authorization endpoint but use the one provided by Authlete. The user authentication at the authorization endpoint provided by Authlete is performed by making a `POST` request to this endpoint. | [optional] +**AuthenticationCallbackApiKey** | Pointer to **string** | API key for basic authentication at the authentication callback endpoint. If the value is not empty, Authlete generates Authorization header for Basic authentication when making a request to the authentication callback endpoint. | [optional] +**AuthenticationCallbackApiSecret** | Pointer to **string** | API secret for `basic` authentication at the authentication callback endpoint. | [optional] +**SupportedAcrs** | Pointer to **[]string** | Values of acrs (authentication context class references) that the service supports. The value of this property is used as `acr_values_supported` property in the [OpenID Provider Metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). | [optional] [readonly] +**SupportedGrantTypes** | Pointer to [**[]GrantType**](GrantType.md) | Values of `grant_type` request parameter that the service supports. The value of this property is used as `grant_types_supported property` in the [OpenID Provider Metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). | [optional] +**SupportedResponseTypes** | Pointer to [**[]ResponseType**](ResponseType.md) | Values of `response_type` request parameter that the service supports. Valid values are listed in Response Type. The value of this property is used as `response_types_supported` property in the [OpenID Provider Metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). | [optional] +**SupportedAuthorizationDetailsTypes** | Pointer to **[]string** | The supported data types that can be used as values of the type field in `authorization_details`. This property corresponds to the `authorization_details_types_supported` metadata. See \"OAuth 2.0 Rich Authorization Requests\" (RAR) for details. | [optional] +**SupportedServiceProfiles** | Pointer to [**[]ServiceProfile**](ServiceProfile.md) | The profiles that this service supports. | [optional] +**ErrorDescriptionOmitted** | Pointer to **bool** | The flag to indicate whether the `error_description` response parameter is omitted. According to [RFC 6749](https://tools.ietf.org/html/rfc6749), an authorization server may include the `error_description` response parameter in error responses. If `true`, Authlete does not embed the `error_description` response parameter in error responses. | [optional] +**ErrorUriOmitted** | Pointer to **bool** | The flag to indicate whether the `error_uri` response parameter is omitted. According to [RFC 6749](https://tools.ietf.org/html/rfc6749), an authorization server may include the `error_uri` response parameter in error responses. If `true`, Authlete does not embed the `error_uri` response parameter in error responses. | [optional] +**AuthorizationEndpoint** | Pointer to **string** | The authorization endpoint of the service. A URL that starts with `https://` and has no fragment component. For example, `https://example.com/auth/authorization`. The value of this property is used as `authorization_endpoint` property in the [OpenID Provider Metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). | [optional] +**DirectAuthorizationEndpointEnabled** | Pointer to **bool** | The flag to indicate whether the direct authorization endpoint is enabled or not. The path of the endpoint is `/api/auth/authorization/direct/service-api-key`. | [optional] +**SupportedUiLocales** | Pointer to **[]string** | UI locales that the service supports. Each element is a language tag defined in [RFC 5646](https://tools.ietf.org/html/rfc5646). For example, `en-US` and `ja-JP`. The value of this property is used as `ui_locales_supported` property in the [OpenID Provider Metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). | [optional] +**SupportedDisplays** | Pointer to [**[]Display**](Display.md) | Values of `display` request parameter that service supports. The value of this property is used as `display_values_supported` property in the Provider Metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). | [optional] +**PkceRequired** | Pointer to **bool** | The flag to indicate whether the use of Proof Key for Code Exchange (PKCE) is always required for authorization requests by Authorization Code Flow. If `true`, `code_challenge` request parameter is always required for authorization requests using Authorization Code Flow. See [RFC 7636](https://tools.ietf.org/html/rfc7636) (Proof Key for Code Exchange by OAuth Public Clients) for details about `code_challenge` request parameter. | [optional] +**PkceS256Required** | Pointer to **bool** | The flag to indicate whether `S256` is always required as the code challenge method whenever [PKCE (RFC 7636)](https://tools.ietf.org/html/rfc7636) is used. If this flag is set to `true`, `code_challenge_method=S256` must be included in the authorization request whenever it includes the `code_challenge` request parameter. Neither omission of the `code_challenge_method` request parameter nor use of plain (`code_challenge_method=plain`) is allowed. | [optional] +**AuthorizationResponseDuration** | Pointer to **int64** | The duration of authorization response JWTs in seconds. [Financial-grade API: JWT Secured Authorization Response Mode for OAuth 2.0 (JARM)](https://openid.net/specs/openid-financial-api-jarm.html) defines new values for the `response_mode` request parameter. They are `query.jwt`, `fragment.jwt`, `form_post.jwt` and `jwt`. If one of them is specified as the response mode, response parameters from the authorization endpoint will be packed into a JWT. This property is used to compute the value of the `exp` claim of the JWT. | [optional] +**TokenEndpoint** | Pointer to **string** | The [token endpoint](https://tools.ietf.org/html/rfc6749#section-3.2) of the service. A URL that starts with `https://` and has not fragment component. For example, `https://example.com/auth/token`. The value of this property is used as `token_endpoint` property in the [OpenID Provider Metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). | [optional] +**DirectTokenEndpointEnabled** | Pointer to **bool** | The flag to indicate whether the direct token endpoint is enabled or not. The path of the endpoint is `/api/auth/token/direct/service-api-key`. | [optional] +**SupportedTokenAuthMethods** | Pointer to [**[]ClientAuthMethod**](ClientAuthMethod.md) | Client authentication methods supported by the token endpoint of the service. The value of this property is used as `token_endpoint_auth_methods_supports` property in the [OpenID Provider Metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). | [optional] +**MissingClientIdAllowed** | Pointer to **bool** | The flag to indicate token requests from public clients without the `client_id` request parameter are allowed when the client can be guessed from `authorization_code` or `refresh_token`. This flag should not be set unless you have special reasons. | [optional] +**RevocationEndpoint** | Pointer to **string** | The [revocation endpoint](https://tools.ietf.org/html/rfc7009) of the service. A URL that starts with `https://`. For example, `https://example.com/auth/revocation`. | [optional] +**DirectRevocationEndpointEnabled** | Pointer to **bool** | The flag to indicate whether the direct revocation endpoint is enabled or not. The URL of the endpoint is `/api/auth/revocation/direct/service-api-key`. | [optional] +**SupportedRevocationAuthMethods** | Pointer to [**[]ClientAuthMethod**](ClientAuthMethod.md) | Client authentication methods supported at the revocation endpoint. | [optional] +**IntrospectionEndpoint** | Pointer to **string** | The URI of the introspection endpoint. | [optional] +**DirectIntrospectionEndpointEnabled** | Pointer to **bool** | The flag to indicate whether the direct userinfo endpoint is enabled or not. The path of the endpoint is `/api/auth/userinfo/direct/{serviceApiKey}`. | [optional] +**SupportedIntrospectionAuthMethods** | Pointer to [**[]ClientAuthMethod**](ClientAuthMethod.md) | Client authentication methods supported at the introspection endpoint. | [optional] +**PushedAuthReqEndpoint** | Pointer to **string** | The URI of the pushed authorization request endpoint. This property corresponds to the `pushed_authorization_request_endpoint` metadata defined in \"[5. Authorization Server Metadata](https://tools.ietf.org/html/draft-lodderstedt-oauth-par#section-5)\" of OAuth 2.0 Pushed Authorization Requests. | [optional] +**PushedAuthReqDuration** | Pointer to **int64** | The duration of pushed authorization requests in seconds. [OAuth 2.0 Pushed Authorization Requests](https://tools.ietf.org/html/draft-lodderstedt-oauth-par) defines an endpoint (called \"pushed authorization request endpoint\") which client applications can register authorization requests into and get corresponding URIs (called \"request URIs\") from. The issued URIs represent the registered authorization requests. The client applications can use the URIs as the value of the `request_uri` request parameter in an authorization request. The property represents the duration of registered authorization requests and is used as the value of the `expires_in` parameter in responses from the pushed authorization request endpoint. | [optional] +**ParRequired** | Pointer to **bool** | The flag to indicate whether this service requires that clients use the pushed authorization request endpoint. This property corresponds to the `require_pushed_authorization_requests` server metadata defined in [OAuth 2.0 Pushed Authorization Requests](https://tools.ietf.org/html/draft-lodderstedt-oauth-par). | [optional] +**RequestObjectRequired** | Pointer to **bool** | The flag to indicate whether this service requires that authorization requests always utilize a request object by using either request or `request_uri` request parameter. If this flag is set to `true` and the value of `traditionalRequestObjectProcessingApplied` is `false`, the value of `require_signed_request_object` server metadata of this service is reported as `true` in the discovery document. The metadata is defined in JAR (JWT Secured Authorization Request). That `require_signed_request_object` is `true` means that authorization requests which don't conform to the JAR specification are rejected. | [optional] +**TraditionalRequestObjectProcessingApplied** | Pointer to **bool** | The flag to indicate whether a request object is processed based on rules defined in [OpenID Connect Core 1.0](https://openid.net/specs/openid-connect-core-1_0.html) or JAR (JWT Secured Authorization Request). Differences between rules in OpenID Connect Core 1.0 and ones in JAR are as follows. - JAR requires that a request object be always -signed. - JAR does not allow request parameters outside a request object to be referred to. - OIDC Core 1.0 requires that response_type request parameter exist outside a request object even if the request object includes the request parameter. - OIDC Core 1.0 requires that scope request parameter exist outside a request object if the authorization request is an - OIDC request even if the request object includes the request parameter. If this flag is set to `false` and the value of `requestObjectRequired` is `true`, the value of `require_signed_request_object` server metadata of this service is reported as `true` in the discovery document. The metadata is defined in JAR (JWT Secured Authorization Request). That `require_signed_request_object` is `true` means that authorization requests which don't conform to the JAR specification are rejected. | [optional] +**MutualTlsValidatePkiCertChain** | Pointer to **bool** | The flag to indicate whether this service validates certificate chains during PKI-based client mutual TLS authentication. | [optional] +**TrustedRootCertificates** | Pointer to **[]string** | The list of root certificates trusted by this service for PKI-based client mutual TLS authentication. | [optional] +**MtlsEndpointAliases** | Pointer to [**[]NamedUri**](NamedUri.md) | The MTLS endpoint aliases. This property corresponds to the mtls_endpoint_aliases metadata defined in \"5. Metadata for Mutual TLS Endpoint Aliases\" of [OAuth 2.0 Mutual TLS Client Authentication and Certificate-Bound Access Tokens](https://datatracker.ietf.org/doc/rfc8705/). The aliases will be embedded in the response from the discovery endpoint like the following. ```json { ......, \"mtls_endpoint_aliases\": { \"token_endpoint\": \"https://mtls.example.com/token\", \"revocation_endpoint\": \"https://mtls.example.com/revo\", \"introspection_endpoint\": \"https://mtls.example.com/introspect\" } } ``` | [optional] +**AccessTokenType** | Pointer to **string** | The access token type. This value is used as the value of `token_type` property in access token responses. If this service complies with [RFC 6750](https://tools.ietf.org/html/rfc6750), the value of this property should be `Bearer`. See [RFC 6749 (OAuth 2.0), 7.1. Access Token Types](https://tools.ietf.org/html/rfc6749#section-7.1) for details. | [optional] +**TlsClientCertificateBoundAccessTokens** | Pointer to **bool** | The flag to indicate whether this service supports issuing TLS client certificate bound access tokens. | [optional] +**AccessTokenDuration** | Pointer to **int64** | The duration of access tokens in seconds. This value is used as the value of `expires_in` property in access token responses. `expires_in` is defined [RFC 6749, 5.1. Successful Response](https://tools.ietf.org/html/rfc6749#section-5.1). | [optional] +**SingleAccessTokenPerSubject** | Pointer to **bool** | The flag to indicate whether the number of access tokens per subject (and per client) is at most one or can be more. If `true`, an attempt to issue a new access token invalidates existing access tokens that are associated with the same subject and the same client. Note that, however, attempts by [Client Credentials Flow](https://tools.ietf.org/html/rfc6749#section-4.4) do not invalidate existing access tokens because access tokens issued by Client Credentials Flow are not associated with any end-user's subject. Also note that an attempt by [Refresh Token Flow](https://tools.ietf.org/html/rfc6749#section-6) invalidates the coupled access token only and this invalidation is always performed regardless of whether the value of this setting item is `true` or `false`. | [optional] +**AccessTokenSignAlg** | Pointer to [**JwsAlg**](JwsAlg.md) | | [optional] +**AccessTokenSignatureKeyId** | Pointer to **string** | The key ID to identify a JWK used for signing access tokens. A JWK Set can be registered as a property of a service. A JWK Set can contain 0 or more JWKs. Authlete Server has to pick up one JWK for signing from the JWK Set when it generates a JWT-based access token. Authlete Server searches the registered JWK Set for a JWK which satisfies conditions for access token signature. If the number of JWK candidates which satisfy the conditions is 1, there is no problem. On the other hand, if there exist multiple candidates, a Key ID is needed to be specified so that Authlete Server can pick up one JWK from among the JWK candidates. | [optional] +**RefreshTokenDuration** | Pointer to **int64** | The duration of refresh tokens in seconds. The related specifications have no requirements on refresh token duration, but Authlete sets expiration for refresh tokens. | [optional] +**RefreshTokenDurationKept** | Pointer to **bool** | The flag to indicate whether the remaining duration of the used refresh token is taken over to the newly issued refresh token. | [optional] +**RefreshTokenDurationReset** | Pointer to **bool** | The flag which indicates whether duration of refresh tokens are reset when they are used even if the `refreshTokenKept` property of this service set to is `true` (= even if \"Refresh Token Continuous Use\" is \"Kept\"). This flag has no effect when the `refreshTokenKept` property is set to `false`. In other words, if this service issues a new refresh token on every refresh token request, the refresh token will have fresh duration (unless `refreshTokenDurationKept` is set to `true`) and this `refreshTokenDurationReset` property is not referenced. | [optional] +**RefreshTokenKept** | Pointer to **bool** | The flag to indicate whether a refresh token remains unchanged or gets renewed after its use. If `true`, a refresh token used to get a new access token remains valid after its use. Otherwise, if `false`, a refresh token is invalidated after its use and a new refresh token is issued. See [RFC 6749 6. Refreshing an Access Token](https://tools.ietf.org/html/rfc6749#section-6), as to how to get a new access token using a refresh token. | [optional] +**SupportedScopes** | Pointer to [**[]Scope**](Scope.md) | Scopes supported by the service. Authlete strongly recommends that the service register at least the following scopes. | Name | Description | | --- | --- | | openid | A permission to get an ID token of an end-user. The `openid` scope appears in [OpenID Connect Core 1.0, 3.1.2.1. Authentication Request, scope](https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest). Without this scope, Authlete does not allow `response_type` request parameter to have values other than code and token. | | profile | A permission to get information about `name`, `family_name`, `given_name`, `middle_name`, `nickname`, `preferred_username`, `profile`, `picture`, `website`, `gender`, `birthdate`, `zoneinfo`, `locale` and `updated_at` from the user info endpoint. See [OpenID Connect Core 1.0, 5.4. Requesting Claims using Scope Values](https://openid.net/specs/openid-connect-core-1_0.html#ScopeClaims) for details. | | email | A permission to get information about `email` and `email_verified` from the user info endpoint. See [OpenID Connect Core 1.0, 5.4. Requesting Claims using Scope Values](https://openid.net/specs/openid-connect-core-1_0.html#ScopeClaims) for details. | | address | A permission to get information about address from the user info endpoint. See [OpenID Connect Core 1.0, 5.4. Requesting Claims using Scope Values](https://openid.net/specs/openid-connect-core-1_0.html#ScopeClaims) and [5.1.1. Address Claim](https://openid.net/specs/openid-connect-core-1_0.html#AddressClaim) for details. | | phone | A permission to get information about `phone_number` and `phone_number_verified` from the user info endpoint. See [OpenID Connect Core 1.0, 5.4. Requesting Claims using Scope Values](https://openid.net/specs/openid-connect-core-1_0.html#ScopeClaims) for details. | | offline_access | A permission to get information from the user info endpoint even when the end-user is not present. See [OpenID Connect Core 1.0, 11. Offline Access](https://openid.net/specs/openid-connect-core-1_0.html#OfflineAccess) for details. | The value of this property is used as `scopes_supported` property in the [OpenID Provider Metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). | [optional] +**ScopeRequired** | Pointer to **bool** | The flag to indicate whether requests that request no scope are rejected or not. When a request has no explicit `scope` parameter and the service's pre-defined default scope set is empty, the authorization server regards the request requests no scope. When this flag is set to `true`, requests that request no scope are rejected. The requirement below excerpted from [RFC 6749 Section 3.3](https://tools.ietf.org/html/rfc6749#section-3.3) does not explicitly mention the case where the default scope set is empty. > If the client omits the scope parameter when requesting authorization, the authorization server MUST either process the request using a pre-defined default value or fail the request indicating an invalid scope. However, if you interpret *\"the default scope set exists but is empty\"* as *\"the default scope set does not exist\"* and want to strictly conform to the requirement above, this flag has to be `true`. | [optional] +**IdTokenDuration** | Pointer to **int64** | 'The duration of [ID token](https://openid.net/specs/openid-connect-core-1_0.html#IDToken)s in seconds. This value is used to calculate the value of `exp` claim in an ID token.' | [optional] +**AllowableClockSkew** | Pointer to **int32** | The allowable clock skew between the server and clients in seconds. The clock skew is taken into consideration when time-related claims in a JWT (e.g. `exp`, `iat`, `nbf`) are verified. | [optional] +**SupportedClaimTypes** | Pointer to [**[]ClaimType**](ClaimType.md) | Claim types supported by the service. Valid values are listed in Claim Type. Note that Authlete currently doesn't provide any API to help implementations for `AGGREGATED` and `DISTRIBUTED`. The value of this property is used as `claim_types_supported` property in the [OpenID Provider Metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). | [optional] +**SupportedClaimLocales** | Pointer to **[]string** | Claim locales that the service supports. Each element is a language tag defined in [RFC 5646](https://tools.ietf.org/html/rfc5646). For example, `en-US` and `ja-JP`. See [OpenID Connect Core 1.0, 5.2. Languages and Scripts](https://openid.net/specs/openid-connect-core-1_0.html#ClaimsLanguagesAndScripts) for details. The value of this property is used as `claims_locales_supported` property in the [OpenID Provider Metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). | [optional] +**SupportedClaims** | Pointer to **[]string** | Claim names that the service supports. The standard claim names listed in [OpenID Connect Core 1.0, 5.1. Standard Claim](https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims) should be supported. The following is the list of standard claims. - `sub` - `name` - `given_name` - `family_name` - `middle_name` - `nickname` - `preferred_username` - `profile` - `picture` - `website` - `email` - `email_verified` - `gender` - `birthdate` - `zoneinfo` - `locale` - `phone_number` - `phone_number_verified` - `address` - `updated_at` The value of this property is used as `claims_supported` property in the [OpenID Provider Metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). The service may support its original claim names. See [OpenID Connect Core 1.0, 5.1.2. Additional Claims](https://openid.net/specs/openid-connect-core-1_0.html#AdditionalClaims). | [optional] +**ClaimShortcutRestrictive** | Pointer to **bool** | The flag indicating whether claims specified by shortcut scopes (e.g. `profile`) are included in the issued ID token only when no access token is issued. To strictly conform to the description below excerpted from [OpenID Connect Core 1.0 Section 5.4](https://openid.net/specs/openid-connect-core-1_0.html#ScopeClaims), this flag has to be `true`. > The Claims requested by the profile, email, address, and phone scope values are returned from the UserInfo Endpoint, as described in Section 5.3.2, when a response_type value is used that results in an Access Token being issued. However, when no Access Token is issued (which is the case for the response_type value id_token), the resulting Claims are returned in the ID Token. | [optional] +**JwksUri** | Pointer to **string** | The URL of the service's [JSON Web Key Set](https://tools.ietf.org/html/rfc7517) document. For example, `http://example.com/auth/jwks`. Client applications accesses this URL (1) to get the public key of the service to validate the signature of an ID token issued by the service and (2) to get the public key of the service to encrypt an request object of the client application. See [OpenID Connect Core 1.0, 10. Signatures and Encryption](https://openid.net/specs/openid-connect-core-1_0.html#SigEnc) for details. The value of this property is used as `jwks_uri` property in the [OpenID Provider Metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). | [optional] +**DirectJwksEndpointEnabled** | Pointer to **bool** | 'The flag to indicate whether the direct jwks endpoint is enabled or not. The path of the endpoint is `/api/service/jwks/get/direct/service-api-key`. ' | [optional] +**Jwks** | Pointer to **string** | The content of the service's [JSON Web Key Set](https://tools.ietf.org/html/rfc7517) document. If this property is not `null` in a `/service/create` request or a `/service/update` request, Authlete hosts the content in the database. This property must not be `null` and must contain pairs of public/private keys if the service wants to support asymmetric signatures for ID tokens and asymmetric encryption for request objects. See [OpenID Connect Core 1.0, 10. Signatures and Encryption](https://openid.net/specs/openid-connect-core-1_0.html#SigEnc) for details. | [optional] +**IdTokenSignatureKeyId** | Pointer to **string** | The key ID to identify a JWK used for ID token signature using an asymmetric key. A JWK Set can be registered as a property of a Service. A JWK Set can contain 0 or more JWKs (See [RFC 7517](https://tools.ietf.org/html/rfc7517) for details about JWK). Authlete Server has to pick up one JWK for signature from the JWK Set when it generates an ID token and signature using an asymmetric key is required. Authlete Server searches the registered JWK Set for a JWK which satisfies conditions for ID token signature. If the number of JWK candidates which satisfy the conditions is 1, there is no problem. On the other hand, if there exist multiple candidates, a [Key ID](https://tools.ietf.org/html/rfc7517#section-4.5) is needed to be specified so that Authlete Server can pick up one JWK from among the JWK candidates. This `idTokenSignatureKeyId` property exists for the purpose described above. For key rotation (OpenID Connect Core 1.0, [10.1.1. Rotation of Asymmetric Signing Keys](http://openid.net/specs/openid-connect-core-1_0.html#RotateSigKeys)), this mechanism is needed. | [optional] +**UserInfoSignatureKeyId** | Pointer to **string** | The key ID to identify a JWK used for user info signature using an asymmetric key. A JWK Set can be registered as a property of a Service. A JWK Set can contain 0 or more JWKs (See [RFC 7517](https://tools.ietf.org/html/rfc7517) for details about JWK). Authlete Server has to pick up one JWK for signature from the JWK Set when it is required to sign user info (which is returned from [userinfo endpoint](http://openid.net/specs/openid-connect-core-1_0.html#UserInfo)) using an asymmetric key. Authlete Server searches the registered JWK Set for a JWK which satisfies conditions for user info signature. If the number of JWK candidates which satisfy the conditions is 1, there is no problem. On the other hand, if there exist multiple candidates, a [Key ID](https://tools.ietf.org/html/rfc7517#section-4.5) is needed to be specified so that Authlete Server can pick up one JWK from among the JWK candidates. This `userInfoSignatureKeyId` property exists for the purpose described above. For key rotation (OpenID Connect Core 1.0, [10.1.1. Rotation of Asymmetric Signing Keys](http://openid.net/specs/openid-connect-core-1_0.html#RotateSigKeys)), this mechanism is needed. | [optional] +**AuthorizationSignatureKeyId** | Pointer to **string** | The key ID to identify a JWK used for signing authorization responses using an asymmetric key. [Financial-grade API: JWT Secured Authorization Response Mode for OAuth 2.0 (JARM)](https://openid.net/specs/openid-financial-api-jarm.html) defines new values for the `response_mode` request parameter. They are `query.jwt`, `fragment.jwt`, `form_post.jwt` and `jwt`. If one of them is specified as the response mode, response parameters from the authorization endpoint will be packed into a JWT. This property is used to compute the value of the `exp` claim of the JWT. Authlete Server searches the JWK Set for a JWK which satisfies conditions for authorization response signature. If the number of JWK candidates which satisfy the conditions is 1, there is no problem. On the other hand, if there exist multiple candidates, a Key ID is needed to be specified so that Authlete Server can pick up one JWK from among the JWK candidates. This property exists to specify the key ID. | [optional] +**UserInfoEndpoint** | Pointer to **string** | The [user info endpoint](http://openid.net/specs/openid-connect-core-1_0.html#UserInfo) of the service. A URL that starts with `https://`. For example, `https://example.com/auth/userinfo`. The value of this property is used as `userinfo_endpoint` property in the [OpenID Provider Metadata](http://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). | [optional] +**DirectUserInfoEndpointEnabled** | Pointer to **bool** | The flag to indicate whether the direct userinfo endpoint is enabled or not. The path of the endpoint is `/api/auth/userinfo/direct/service-api-key`. | [optional] +**DynamicRegistrationSupported** | Pointer to **bool** | The boolean flag which indicates whether the [OAuth 2.0 Dynamic Client Registration Protocol](https://tools.ietf.org/html/rfc7591) is supported. | [optional] +**RegistrationEndpoint** | Pointer to **string** | The [registration endpoint](http://openid.net/specs/openid-connect-registration-1_0.html#ClientRegistration) of the service. A URL that starts with `https://`. For example, `https://example.com/auth/registration`. The value of this property is used as `registration_endpoint` property in the [OpenID Provider Metadata](http://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). | [optional] +**RegistrationManagementEndpoint** | Pointer to **string** | The URI of the registration management endpoint. If dynamic client registration is supported, and this is set, this URI will be used as the basis of the client's management endpoint by appending `/clientid}/` to it as a path element. If this is unset, the value of `registrationEndpoint` will be used as the URI base instead. | [optional] +**PolicyUri** | Pointer to **string** | The URL of the \"Policy\" of the service. The value of this property is used as `op_policy_uri` property in the [OpenID Provider Metadata](http://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). | [optional] +**TosUri** | Pointer to **string** | The URL of the \"Terms Of Service\" of the service. The value of this property is used as `op_tos_uri` property in the [OpenID Provider Metadata](http://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). | [optional] +**ServiceDocumentation** | Pointer to **string** | The URL of a page where documents for developers can be found. The value of this property is used as `service_documentation` property in the [OpenID Provider Metadata](http://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). | [optional] +**BackchannelAuthenticationEndpoint** | Pointer to **string** | The URI of backchannel authentication endpoint, which is defined in the specification of [CIBA (Client Initiated Backchannel Authentication)](https://openid.net/specs/openid-client-initiated-backchannel-authentication-core-1_0.html). | [optional] +**SupportedBackchannelTokenDeliveryModes** | Pointer to [**[]DeliveryMode**](DeliveryMode.md) | The supported backchannel token delivery modes. This property corresponds to the `backchannel_token_delivery_modes_supported` metadata. Backchannel token delivery modes are defined in the specification of [CIBA (Client Initiated Backchannel Authentication)](https://openid.net/specs/openid-client-initiated-backchannel-authentication-core-1_0.html). | [optional] +**BackchannelAuthReqIdDuration** | Pointer to **int32** | The duration of backchannel authentication request IDs issued from the backchannel authentication endpoint in seconds. This is used as the value of the `expires_in` property in responses from the backchannel authentication endpoint. | [optional] +**BackchannelPollingInterval** | Pointer to **int32** | The minimum interval between polling requests to the token endpoint from client applications in seconds. This is used as the value of the `interval` property in responses from the backchannel authentication endpoint. | [optional] +**BackchannelUserCodeParameterSupported** | Pointer to **bool** | The boolean flag which indicates whether the `user_code` request parameter is supported at the backchannel authentication endpoint. This property corresponds to the `backchannel_user_code_parameter_supported` metadata. | [optional] +**BackchannelBindingMessageRequiredInFapi** | Pointer to **bool** | The flag to indicate whether the `binding_message` request parameter is always required whenever a backchannel authentication request is judged as a request for Financial-grade API. The FAPI-CIBA profile requires that the authorization server _\"shall ensure unique authorization context exists in the authorization request or require a `binding_message` in the authorization request\"_ (FAPI-CIBA, 5.2.2, 2). The simplest way to fulfill this requirement is to set this property to `true`. If this property is set to `false`, the `binding_message` request parameter remains optional even in FAPI context, but in exchange, your authorization server must implement a custom mechanism that ensures each backchannel authentication request has unique context. | [optional] +**DeviceAuthorizationEndpoint** | Pointer to **string** | The URI of the device authorization endpoint. Device authorization endpoint is defined in the specification of OAuth 2.0 Device Authorization Grant. | [optional] +**DeviceVerificationUri** | Pointer to **string** | The verification URI for the device flow. This URI is used as the value of the `verification_uri` parameter in responses from the device authorization endpoint. | [optional] +**DeviceVerificationUriComplete** | Pointer to **string** | The verification URI for the device flow with a placeholder for a user code. This URI is used to build the value of the `verification_uri_complete` parameter in responses from the device authorization endpoint. It is expected that the URI contains a fixed string `USER_CODE` somewhere as a placeholder for a user code. For example, like the following. `https://example.com/device?user\\_code=USER\\_CODE` The fixed string is replaced with an actual user code when Authlete builds a verification URI with a user code for the `verification_uri_complete` parameter. If this URI is not set, the `verification_uri_complete` parameter won't appear in device authorization responses. | [optional] +**DeviceFlowCodeDuration** | Pointer to **int32** | The duration of device verification codes and end-user verification codes issued from the device authorization endpoint in seconds. This is used as the value of the `expires_in` property in responses from the device authorization endpoint. | [optional] +**DeviceFlowPollingInterval** | Pointer to **int32** | The minimum interval between polling requests to the token endpoint from client applications in seconds in device flow. This is used as the value of the `interval` property in responses from the device authorization endpoint. | [optional] +**UserCodeCharset** | Pointer to [**UserCodeCharset**](UserCodeCharset.md) | | [optional] +**UserCodeLength** | Pointer to **int32** | The length of end-user verification codes (`user_code`) for Device Flow. | [optional] +**SupportedTrustFrameworks** | Pointer to **[]string** | Trust frameworks supported by this service. This corresponds to the `trust_frameworks_supported` [metadata](https://openid.net/specs/openid-connect-4-identity-assurance-1_0.html#rfc.section.7). | [optional] +**SupportedEvidence** | Pointer to **[]string** | Evidence supported by this service. This corresponds to the `evidence_supported` [metadata](https://openid.net/specs/openid-connect-4-identity-assurance-1_0.html#rfc.section.7). | [optional] +**SupportedIdentityDocuments** | Pointer to **[]string** | Identity documents supported by this service. This corresponds to the `id_documents_supported` [metadata](https://openid.net/specs/openid-connect-4-identity-assurance-1_0.html#rfc.section.7). | [optional] +**SupportedVerificationMethods** | Pointer to **[]string** | Verification methods supported by this service. This corresponds to the `id_documents_verification_methods_supported` [metadata](https://openid.net/specs/openid-connect-4-identity-assurance-1_0.html#rfc.section.7). | [optional] +**SupportedVerifiedClaims** | Pointer to **[]string** | Verified claims supported by this service. This corresponds to the `claims_in_verified_claims_supported` [metadata](https://openid.net/specs/openid-connect-4-identity-assurance-1_0.html#rfc.section.7). | [optional] +**VerifiedClaimsValidationSchemaSet** | Pointer to [**NullableVerifiedClaimsValidationSchema**](VerifiedClaimsValidationSchema.md) | OIDC4IDA / verifiedClaimsValidationSchemaSet | [optional] +**Attributes** | Pointer to [**[]Pair**](Pair.md) | The attributes of this service. | [optional] +**NbfOptional** | Pointer to **bool** | The flag indicating whether the nbf claim in the request object is optional even when the authorization request is regarded as a FAPI-Part2 request. The final version of Financial-grade API was approved in January, 2021. The Part 2 of the final version has new requirements on lifetime of request objects. They require that request objects contain an `nbf` claim and the lifetime computed by `exp` - `nbf` be no longer than 60 minutes. Therefore, when an authorization request is regarded as a FAPI-Part2 request, the request object used in the authorization request must contain an nbf claim. Otherwise, the authorization server rejects the authorization request. When this flag is `true`, the `nbf` claim is treated as an optional claim even when the authorization request is regarded as a FAPI-Part2 request. That is, the authorization server does not perform the validation on lifetime of the request object. Skipping the validation is a violation of the FAPI specification. The reason why this flag has been prepared nevertheless is that the new requirements (which do not exist in the Implementer's Draft 2 released in October, 2018) have big impacts on deployed implementations of client applications and Authlete thinks there should be a mechanism whereby to make the migration from ID2 to Final smooth without breaking live systems. | [optional] +**IssSuppressed** | Pointer to **bool** | The flag indicating whether generation of the iss response parameter is suppressed. \"OAuth 2.0 Authorization Server Issuer Identifier in Authorization Response\" has defined a new authorization response parameter, `iss`, as a countermeasure for a certain type of mix-up attacks. The specification requires that the `iss` response parameter always be included in authorization responses unless JARM (JWT Secured Authorization Response Mode) is used. When this flag is `true`, the authorization server does not include the `iss` response parameter in authorization responses. By turning this flag on and off, developers of client applications can experiment the mix-up attack and the effect of the `iss` response parameter. Note that this flag should not be `true` in production environment unless there are special reasons for it. | [optional] +**SupportedCustomClientMetadata** | Pointer to **[]string** | custom client metadata supported by this service. Standard specifications define client metadata as necessary. The following are such examples. * [OpenID Connect Dynamic Client Registration 1.0](https://openid.net/specs/openid-connect-registration-1_0.html) * [RFC 7591 OAuth 2.0 Dynamic Client Registration Protocol](https://www.rfc-editor.org/rfc/rfc7591.html) * [RFC 8705 OAuth 2.0 Mutual-TLS Client Authentication and Certificate-Bound Access Tokens](https://www.rfc-editor.org/rfc/rfc8705.html) * [OpenID Connect Client-Initiated Backchannel Authentication Flow - Core 1.0](https://openid.net/specs/openid-client-initiated-backchannel-authentication-core-1_0.html) * [The OAuth 2.0 Authorization Framework: JWT Secured Authorization Request (JAR)](https://datatracker.ietf.org/doc/draft-ietf-oauth-jwsreq/) * [Financial-grade API: JWT Secured Authorization Response Mode for OAuth 2.0 (JARM)](https://openid.net/specs/openid-financial-api-jarm.html) * [OAuth 2.0 Pushed Authorization Requests (PAR)](https://datatracker.ietf.org/doc/rfc9126/) * [OAuth 2.0 Rich Authorization Requests (RAR)](https://datatracker.ietf.org/doc/draft-ietf-oauth-rar/) Standard client metadata included in Client Registration Request and Client Update Request (cf. [OIDC DynReg](https://openid.net/specs/openid-connect-registration-1_0.html), [RFC 7591](https://www.rfc-editor.org/rfc/rfc7591.html) and [RFC 7592](https://www.rfc-editor.org/rfc/rfc7592.html)) are, if supported by Authlete, stored into Authlete database. On the other hand, unrecognized client metadata are discarded. By listing up custom client metadata in advance by using this property (`supportedCustomClientMetadata`), Authlete can recognize them and stores their values into the database. The stored custom client metadata values can be referenced by `customMetadata`. | [optional] +**TokenExpirationLinked** | Pointer to **bool** | The flag indicating whether the expiration date of an access token never exceeds that of the corresponding refresh token. When a new access token is issued by a refresh token request (= a token request with `grant_type=refresh_token`), the expiration date of the access token may exceed the expiration date of the corresponding refresh token. This behavior itself is not wrong and may happen when `refreshTokenKept` is `true` and/or when `refreshTokenDurationKept` is `true`. When this flag is `true`, the expiration date of an access token never exceeds that of the corresponding refresh token regardless of the calculated duration based on other settings such as `accessTokenDuration`, `accessTokenDuration` in `extension` and `access_token.duration` scope attribute. It is technically possible to set a value which is bigger than the duration of refresh tokens as the duration of access tokens although it is strange. In the case, the duration of an access token becomes longer than the duration of the refresh token which is issued together with the access token. Even if the duration values are configured so, if this flag is `true`, the expiration date of the access token does not exceed that of the refresh token. That is, the duration of the access token will be shortened, and as a result, the access token and the refresh token will have the same expiration date. | [optional] +**FrontChannelRequestObjectEncryptionRequired** | Pointer to **bool** | The flag indicating whether encryption of request object is required when the request object is passed through the front channel. This flag does not affect the processing of request objects at the Pushed Authorization Request Endpoint, which is defined in [OAuth 2.0 Pushed Authorization Requests](https://datatracker.ietf.org/doc/rfc9126/). Unecrypted request objects are accepted at the endpoint even if this flag is `true`. This flag does not indicate whether a request object is always required. There is a different flag, `requestObjectRequired`, for the purpose. See the description of `requestObjectRequired` for details. Even if this flag is `false`, encryption of request object is required if the `frontChannelRequestObjectEncryptionRequired` flag of the client is `true`. | [optional] +**RequestObjectEncryptionAlgMatchRequired** | Pointer to **bool** | The flag indicating whether the JWE alg of encrypted request object must match the `request_object_encryption_alg` client metadata of the client that has sent the request object. The request_object_encryption_alg client metadata itself is defined in [OpenID Connect Dynamic Client Registration 1.0](https://openid.net/specs/openid-connect-registration-1_0.html) as follows. > request_object_encryption_alg > > OPTIONAL. JWE [JWE] alg algorithm [JWA] the RP is declaring that it may use for encrypting Request Objects sent to the OP. This parameter SHOULD be included when symmetric encryption will be used, since this signals to the OP that a client_secret value needs to be returned from which the symmetric key will be derived, that might not otherwise be returned. The RP MAY still use other supported encryption algorithms or send unencrypted Request Objects, even when this parameter is present. If both signing and encryption are requested, the Request Object will be signed then encrypted, with the result being a Nested JWT, as defined in [JWT]. The default, if omitted, is that the RP is not declaring whether it might encrypt any Request Objects. The point here is \"The RP MAY still use other supported encryption algorithms or send unencrypted Request Objects, even when this parameter is present.\" The Client's property that represents the client metadata is `requestEncryptionAlg`. See the description of `requestEncryptionAlg` for details. Even if this flag is `false`, the match is required if the `requestObjectEncryptionAlgMatchRequired` flag of the client is `true`. | [optional] +**RequestObjectEncryptionEncMatchRequired** | Pointer to **bool** | The flag indicating whether the JWE `enc` of encrypted request object must match the `request_object_encryption_enc` client metadata of the client that has sent the request object. The `request_object_encryption_enc` client metadata itself is defined in [OpenID Connect Dynamic Client Registration 1.0](https://openid.net/specs/openid-connect-registration-1_0.html) as follows. > request_object_encryption_enc > > OPTIONAL. JWE enc algorithm [JWA] the RP is declaring that it may use for encrypting Request Objects sent to the OP. If request_object_encryption_alg is specified, the default for this value is A128CBC-HS256. When request_object_encryption_enc is included, request_object_encryption_alg MUST also be provided. The Client's property that represents the client metadata is `requestEncryptionEnc`. See the description of `requestEncryptionEnc` for details. Even if this flag is false, the match is required if the `requestObjectEncryptionEncMatchRequired` flag is `true`. | [optional] +**HsmEnabled** | Pointer to **bool** | The flag indicating whether HSM (Hardware Security Module) support is enabled for this service. When this flag is `false`, keys managed in HSMs are not used even if they exist. In addition, `/api/hsk/_*` APIs reject all requests. Even if this flag is `true`, HSM-related features do not work if the configuration of the Authlete server you are using does not support HSM. | [optional] +**Hsks** | Pointer to [**[]Hsk**](Hsk.md) | The information about keys managed on HSMs (Hardware Security Modules). This `hsks` property is output only, meaning that `hsks` in requests to `/api/service/create` API and `/api/service/update` API do not have any effect. The contents of this property is controlled only by `/api/hsk/_*` APIs. | [optional] +**GrantManagementEndpoint** | Pointer to **string** | The URL of the grant management endpoint. | [optional] +**GrantManagementActionRequired** | Pointer to **bool** | The flag indicating whether every authorization request (and any request serving as an authorization request such as CIBA backchannel authentication request and device authorization request) must include the `grant_management_action` request parameter. This property corresponds to the `grant_management_action_required` server metadata defined in [Grant Management for OAuth 2.0](https://openid.net/specs/fapi-grant-management.html). Note that setting true to this property will result in blocking all public clients because the specification requires that grant management be usable only by confidential clients for security reasons. | [optional] +**UnauthorizedOnClientConfigSupported** | Pointer to **bool** | The flag indicating whether Authlete's `/api/client/registration` API uses `UNAUTHORIZED` as a value of the `action` response parameter when appropriate. The `UNAUTHORIZED` enum value was initially not defined as a possible value of the `action` parameter in an `/api/client/registration` API response. This means that implementations of client `configuration` endpoint were not able to conform to [RFC 7592](https://www.rfc-editor.org/rfc/rfc7592.html) strictly. For backward compatibility (to avoid breaking running systems), Authlete's `/api/client/registration` API does not return the `UNAUTHORIZED` enum value if this flag is not turned on. The steps an existing implementation of client configuration endpoint has to do in order to conform to the requirement related to \"401 Unauthorized\" are as follows. 1. Update the Authlete library (e.g. authlete-java-common) your system is using. 2. Update your implementation of client configuration endpoint so that it can handle the `UNAUTHORIZED` action. 3. Turn on this `unauthorizedOnClientConfigSupported` flag. | [optional] +**DcrScopeUsedAsRequestable** | Pointer to **bool** | The flag indicating whether the `scope` request parameter in dynamic client registration and update requests (RFC 7591 and RFC 7592) is used as scopes that the client can request. Limiting the range of scopes that a client can request is achieved by listing scopes in the `client.extension.requestableScopes` property and setting the `client.extension.requestableScopesEnabled` property to `true`. This feature is called \"requestable scopes\". This property affects behaviors of `/api/client/registration` and other family APIs. | [optional] +**EndSessionEndpoint** | Pointer to **string** | The endpoint for clients ending the sessions. A URL that starts with `https://` and has no fragment component. For example, `https://example.com/auth/endSession`. The value of this property is used as `end_session_endpoint` property in the [OpenID Provider Metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). | [optional] +**LoopbackRedirectionUriVariable** | Pointer to **bool** | The flag indicating whether the port number component of redirection URIs can be variable when the host component indicates loopback. When this flag is `true`, if the host component of a redirection URI specified in an authorization request indicates loopback (to be precise, when the host component is localhost, `127.0.0.1` or `::1`), the port number component is ignored when the specified redirection URI is compared to pre-registered ones. This behavior is described in [7.3. Loopback Interface Redirection]( https://www.rfc-editor.org/rfc/rfc8252.html#section-7.3) of [RFC 8252 OAuth 2.0](https://www.rfc-editor.org/rfc/rfc8252.html) for Native Apps. [3.1.2.3. Dynamic Configuration](https://www.rfc-editor.org/rfc/rfc6749.html#section-3.1.2.3) of [RFC 6749](https://www.rfc-editor.org/rfc/rfc6749.html) states _\"If the client registration included the full redirection URI, the authorization server MUST compare the two URIs using simple string comparison as defined in [RFC3986] Section 6.2.1.\"_ Also, the description of `redirect_uri` in [3.1.2.1. Authentication Request](https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest) of [OpenID Connect Core 1.0](https://openid.net/specs/openid-connect-core-1_0.html) states _\"This URI MUST exactly match one of the Redirection URI values for the Client pre-registered at the OpenID Provider, with the matching performed as described in Section 6.2.1 of [RFC3986] (**Simple String Comparison**).\"_ These \"Simple String Comparison\" requirements are preceded by this flag. That is, even when the conditions described in RFC 6749 and OpenID Connect Core 1.0 are satisfied, the port number component of loopback redirection URIs can be variable when this flag is `true`. [8.3. Loopback Redirect Considerations](https://www.rfc-editor.org/rfc/rfc8252.html#section-8.3) of [RFC 8252](https://www.rfc-editor.org/rfc/rfc8252.html) states as follows. > While redirect URIs using localhost (i.e., `\"http://localhost:{port}/{path}\"`) function similarly to loopback IP redirects described in Section 7.3, the use of localhost is NOT RECOMMENDED. Specifying a redirect URI with the loopback IP literal rather than localhost avoids inadvertently listening on network interfaces other than the loopback interface. It is also less susceptible to client-side firewalls and misconfigured host name resolution on the user's device. However, Authlete allows the port number component to be variable in the case of `localhost`, too. It is left to client applications whether they use `localhost` or a literal loopback IP address (`127.0.0.1` for IPv4 or `::1` for IPv6). Section 7.3 and Section 8.3 of [RFC 8252](https://www.rfc-editor.org/rfc/rfc8252.html) state that loopback redirection URIs use the `\"http\"` scheme, but Authlete allows the port number component to be variable in other cases (e.g. in the case of the `\"https\"` scheme), too. | [optional] +**RequestObjectAudienceChecked** | Pointer to **bool** | The flag indicating whether Authlete checks whether the `aud` claim of request objects matches the issuer identifier of this service. [Section 6.1. Passing a Request Object by Value](https://openid.net/specs/openid-connect-core-1_0.html#JWTRequests) of [OpenID Connect Core 1.0](https://openid.net/specs/openid-connect-core-1_0.html) has the following statement. > The `aud` value SHOULD be or include the OP's Issuer Identifier URL. Likewise, [Section 4. Request Object](https://www.rfc-editor.org/rfc/rfc9101.html#section-4) of [RFC 9101](https://www.rfc-editor.org/rfc/rfc9101.html) (The OAuth 2.0 Authorization Framework: JWT-Secured Authorization Request (JAR)) has the following statement. > The value of aud should be the value of the authorization server (AS) issuer, as defined in [RFC 8414](https://www.rfc-editor.org/rfc/rfc8414.html). As excerpted above, validation on the `aud` claim of request objects is optional. However, if this flag is turned on, Authlete checks whether the `aud` claim of request objects matches the issuer identifier of this service and raises an error if they are different. | [optional] +**AccessTokenForExternalAttachmentEmbedded** | Pointer to **bool** | The flag indicating whether Authlete generates access tokens for external attachments and embeds them in ID tokens and userinfo responses. | [optional] +**AuthorityHints** | Pointer to **[]string** | Identifiers of entities that can issue entity statements for this service. This property corresponds to the `authority_hints` property that appears in a self-signed entity statement that is defined in OpenID Connect Federation 1.0. | [optional] +**FederationEnabled** | Pointer to **bool** | flag indicating whether this service supports OpenID Connect Federation 1 | [optional] +**FederationJwks** | Pointer to **string** | JWK Set document containing keys that are used to sign (1) self-signed entity statement of this service and (2) the response from `signed_jwks_uri`. | [optional] +**FederationSignatureKeyId** | Pointer to **string** | A key ID to identify a JWK used to sign the entity configuration and the signed JWK Set. | [optional] +**FederationConfigurationDuration** | Pointer to **int32** | The duration of the entity configuration in seconds. | [optional] +**FederationRegistrationEndpoint** | Pointer to **string** | The URI of the federation registration endpoint. This property corresponds to the `federation_registration_endpoint` server metadata that is defined in OpenID Connect Federation 1.0. | [optional] +**OrganizationName** | Pointer to **string** | The human-readable name representing the organization that operates this service. This property corresponds to the `organization_name` server metadata that is defined in OpenID Connect Federation 1.0. | [optional] +**PredefinedTransformedClaims** | Pointer to **string** | The transformed claims predefined by this service in JSON format. This property corresponds to the `transformed_claims_predefined` server metadata. | [optional] +**RefreshTokenIdempotent** | Pointer to **bool** | flag indicating whether refresh token requests with the same refresh token can be made multiple times in quick succession and they can obtain the same renewed refresh token within the short period. | [optional] +**SignedJwksUri** | Pointer to **string** | The URI of the endpoint that returns this service's JWK Set document in the JWT format. This property corresponds to the `signed_jwks_uri` server metadata defined in OpenID Connect Federation 1.0. | [optional] +**SupportedAttachments** | Pointer to [**[]AttachmentType**](AttachmentType.md) | Supported attachment types. This property corresponds to the {@code attachments_supported} server metadata which was added by the third implementer's draft of OpenID Connect for Identity Assurance 1.0. | [optional] +**SupportedDigestAlgorithms** | Pointer to **[]string** | Supported algorithms used to compute digest values of external attachments. This property corresponds to the `digest_algorithms_supported` server metadata which was added by the third implementer's draft of OpenID Connect for Identity Assurance 1.0. | [optional] +**SupportedDocuments** | Pointer to **[]string** | Document types supported by this service. This property corresponds to the `documents_supported` server metadata. | [optional] +**SupportedDocumentsMethods** | Pointer to **[]string** | validation and verification processes supported by this service. This property corresponds to the `documents_methods_supported` server metadata. The third implementer's draft of [OpenID Connect for Identity Assurance 1.0](https://openid.net/specs/openid-connect-4-identity-assurance-1_0.html) renamed the `id_documents_verification_methods_supported` server metadata to `documents_methods_supported`. | [optional] +**SupportedDocumentsValidationMethods** | Pointer to **[]string** | Document validation methods supported by this service. This property corresponds to the `documents_validation_methods_supported` server metadata which was added by the third implementer's draft of <a href= [OpenID Connect for Identity Assurance 1.0](https://openid.net/specs/openid-connect-4-identity-assurance-1_0.html) | [optional] +**SupportedDocumentsVerificationMethods** | Pointer to **[]string** | Document verification methods supported by this service. This property corresponds to the `documents_verification_methods_supported` server metadata which was added by the third implementer's draft of [OpenID Connect for Identity Assurance 1.0](https://openid.net/specs/openid-connect-4-identity-assurance-1_0.html) | [optional] +**SupportedElectronicRecords** | Pointer to **[]string** | Electronic record types supported by this service. This property corresponds to the `electronic_records_supported` server metadata which was added by the third implementer's draft of [OpenID Connect for Identity Assurance 1.0](https://openid.net/specs/openid-connect-4-identity-assurance-1_0.html) | [optional] +**SupportedClientRegistrationTypes** | Pointer to [**[]ClientRegistrationType**](ClientRegistrationType.md) | | [optional] +**TokenExchangeByIdentifiableClientsOnly** | Pointer to **bool** | The flag indicating whether to prohibit unidentifiable clients from making token exchange requests. | [optional] +**TokenExchangeByConfidentialClientsOnly** | Pointer to **bool** | The flag indicating whether to prohibit public clients from making token exchange requests. | [optional] +**TokenExchangeByPermittedClientsOnly** | Pointer to **bool** | The flag indicating whether to prohibit clients that have no explicit permission from making token exchange requests. | [optional] +**TokenExchangeEncryptedJwtRejected** | Pointer to **bool** | The flag indicating whether to reject token exchange requests which use encrypted JWTs as input tokens. | [optional] +**TokenExchangeUnsignedJwtRejected** | Pointer to **bool** | The flag indicating whether to reject token exchange requests which use unsigned JWTs as input tokens. | [optional] +**JwtGrantByIdentifiableClientsOnly** | Pointer to **bool** | The flag indicating whether to prohibit unidentifiable clients from using the grant type \"urn:ietf:params:oauth:grant-type:jwt-bearer\". | [optional] +**JwtGrantEncryptedJwtRejected** | Pointer to **bool** | The flag indicating whether to reject token requests that use an encrypted JWT as an authorization grant with the grant type \"urn:ietf:params:oauth:grant-type:jwt-bearer\". | [optional] +**JwtGrantUnsignedJwtRejected** | Pointer to **bool** | The flag indicating whether to reject token requests that use an unsigned JWT as an authorization grant with the grant type \"urn:ietf:params:oauth:grant-type:jwt-bearer\". | [optional] +**DcrDuplicateSoftwareIdBlocked** | Pointer to **bool** | The flag indicating whether to block DCR (Dynamic Client Registration) requests whose \"software_id\" has already been used previously. | [optional] +**TrustAnchors** | Pointer to [**[]TrustAnchor**](TrustAnchor.md) | The trust anchors that are referenced when this service resolves trust chains of relying parties. If this property is empty, client registration fails regardless of whether its type is `automatic` or `explicit`. It means that OpenID Connect Federation 1.0 does not work. | [optional] +**OpenidDroppedOnRefreshWithoutOfflineAccess** | Pointer to **bool** | The flag indicating whether the openid scope should be dropped from scopes list assigned to access token issued when a refresh token grant is used. | [optional] +**SupportedDocumentsCheckMethods** | Pointer to **[]string** | Supported document check methods. This property corresponds to the `documents_check_methods_supported` server metadata which was added by the fourth implementer's draft of OpenID Connect for Identity Assurance 1.0. | [optional] +**RsResponseSigned** | Pointer to **bool** | The flag indicating whether this service signs responses from the resource server. | [optional] +**CnonceDuration** | Pointer to **int64** | The duration of `c_nonce`. | [optional] +**DpopNonceRequired** | Pointer to **bool** | Whether to require DPoP proof JWTs to include the `nonce` claim whenever they are presented. | [optional] +**VerifiableCredentialsEnabled** | Pointer to **bool** | Get the flag indicating whether the feature of Verifiable Credentials for this service is enabled or not. | [optional] +**CredentialJwksUri** | Pointer to **string** | The URL at which the JWK Set document of the credential issuer is exposed. | [optional] +**CredentialOfferDuration** | Pointer to **int64** | The default duration of credential offers in seconds. | [optional] +**DpopNonceDuration** | Pointer to **int64** | The duration of nonce values for DPoP proof JWTs in seconds. | [optional] +**PreAuthorizedGrantAnonymousAccessSupported** | Pointer to **bool** | The flag indicating whether token requests using the pre-authorized code grant flow by unidentifiable clients are allowed. | [optional] +**CredentialTransactionDuration** | Pointer to **int64** | The duration of transaction ID in seconds that may be issued as a result of a credential request or a batch credential request. | [optional] +**IntrospectionSignatureKeyId** | Pointer to **string** | The key ID of the key for signing introspection responses. | [optional] +**ResourceSignatureKeyId** | Pointer to **string** | The key ID of the key for signing introspection responses. | [optional] +**UserPinLength** | Pointer to **int32** | The default length of user PINs. | [optional] +**SupportedPromptValues** | Pointer to [**[]Prompt**](Prompt.md) | The supported `prompt` values. | [optional] +**IdTokenReissuable** | Pointer to **bool** | The flag indicating whether to enable the feature of ID token reissuance in the refresh token flow. | [optional] +**CredentialJwks** | Pointer to **string** | The JWK Set document containing private keys that are used to sign verifiable credentials. | [optional] +**FapiModes** | Pointer to [**[]FapiMode**](FapiMode.md) | FAPI modes for this service. When the value of this property is not `null`, Authlete always processes requests to this service based on the specified FAPI modes if the FAPI feature is enabled in Authlete and the FAPI profile is supported by this service. For instance, when this property is set to an array containing `FAPI1_ADVANCED` only, Authlete always processes requests to this service based on \"Financial-grade API Security Profile 1.0 - Part 2: Advanced\" if the FAPI feature is enabled in Authlete and the FAPI profile is supported by this service. | [optional] +**CredentialDuration** | Pointer to **int64** | The default duration of verifiable credentials in seconds. | [optional] +**CredentialIssuerMetadata** | Pointer to [**CredentialIssuerMetadata**](CredentialIssuerMetadata.md) | | [optional] +**IdTokenAudType** | Pointer to **string** | The type of the `aud` claim in ID tokens. | [optional] + +## Methods + +### NewServiceGetApi200Response + +`func NewServiceGetApi200Response() *ServiceGetApi200Response` + +NewServiceGetApi200Response instantiates a new ServiceGetApi200Response object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewServiceGetApi200ResponseWithDefaults + +`func NewServiceGetApi200ResponseWithDefaults() *ServiceGetApi200Response` + +NewServiceGetApi200ResponseWithDefaults instantiates a new ServiceGetApi200Response object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetNumber + +`func (o *ServiceGetApi200Response) GetNumber() int32` + +GetNumber returns the Number field if non-nil, zero value otherwise. + +### GetNumberOk + +`func (o *ServiceGetApi200Response) GetNumberOk() (*int32, bool)` + +GetNumberOk returns a tuple with the Number field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNumber + +`func (o *ServiceGetApi200Response) SetNumber(v int32)` + +SetNumber sets Number field to given value. + +### HasNumber + +`func (o *ServiceGetApi200Response) HasNumber() bool` + +HasNumber returns a boolean if a field has been set. + +### GetServiceName + +`func (o *ServiceGetApi200Response) GetServiceName() string` + +GetServiceName returns the ServiceName field if non-nil, zero value otherwise. + +### GetServiceNameOk + +`func (o *ServiceGetApi200Response) GetServiceNameOk() (*string, bool)` + +GetServiceNameOk returns a tuple with the ServiceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetServiceName + +`func (o *ServiceGetApi200Response) SetServiceName(v string)` + +SetServiceName sets ServiceName field to given value. + +### HasServiceName + +`func (o *ServiceGetApi200Response) HasServiceName() bool` + +HasServiceName returns a boolean if a field has been set. + +### GetIssuer + +`func (o *ServiceGetApi200Response) GetIssuer() string` + +GetIssuer returns the Issuer field if non-nil, zero value otherwise. + +### GetIssuerOk + +`func (o *ServiceGetApi200Response) GetIssuerOk() (*string, bool)` + +GetIssuerOk returns a tuple with the Issuer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIssuer + +`func (o *ServiceGetApi200Response) SetIssuer(v string)` + +SetIssuer sets Issuer field to given value. + +### HasIssuer + +`func (o *ServiceGetApi200Response) HasIssuer() bool` + +HasIssuer returns a boolean if a field has been set. + +### GetDescription + +`func (o *ServiceGetApi200Response) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ServiceGetApi200Response) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ServiceGetApi200Response) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ServiceGetApi200Response) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetApiKey + +`func (o *ServiceGetApi200Response) GetApiKey() int64` + +GetApiKey returns the ApiKey field if non-nil, zero value otherwise. + +### GetApiKeyOk + +`func (o *ServiceGetApi200Response) GetApiKeyOk() (*int64, bool)` + +GetApiKeyOk returns a tuple with the ApiKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApiKey + +`func (o *ServiceGetApi200Response) SetApiKey(v int64)` + +SetApiKey sets ApiKey field to given value. + +### HasApiKey + +`func (o *ServiceGetApi200Response) HasApiKey() bool` + +HasApiKey returns a boolean if a field has been set. + +### GetClientIdAliasEnabled + +`func (o *ServiceGetApi200Response) GetClientIdAliasEnabled() bool` + +GetClientIdAliasEnabled returns the ClientIdAliasEnabled field if non-nil, zero value otherwise. + +### GetClientIdAliasEnabledOk + +`func (o *ServiceGetApi200Response) GetClientIdAliasEnabledOk() (*bool, bool)` + +GetClientIdAliasEnabledOk returns a tuple with the ClientIdAliasEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientIdAliasEnabled + +`func (o *ServiceGetApi200Response) SetClientIdAliasEnabled(v bool)` + +SetClientIdAliasEnabled sets ClientIdAliasEnabled field to given value. + +### HasClientIdAliasEnabled + +`func (o *ServiceGetApi200Response) HasClientIdAliasEnabled() bool` + +HasClientIdAliasEnabled returns a boolean if a field has been set. + +### GetMetadata + +`func (o *ServiceGetApi200Response) GetMetadata() []Pair` + +GetMetadata returns the Metadata field if non-nil, zero value otherwise. + +### GetMetadataOk + +`func (o *ServiceGetApi200Response) GetMetadataOk() (*[]Pair, bool)` + +GetMetadataOk returns a tuple with the Metadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetadata + +`func (o *ServiceGetApi200Response) SetMetadata(v []Pair)` + +SetMetadata sets Metadata field to given value. + +### HasMetadata + +`func (o *ServiceGetApi200Response) HasMetadata() bool` + +HasMetadata returns a boolean if a field has been set. + +### GetCreatedAt + +`func (o *ServiceGetApi200Response) GetCreatedAt() int64` + +GetCreatedAt returns the CreatedAt field if non-nil, zero value otherwise. + +### GetCreatedAtOk + +`func (o *ServiceGetApi200Response) GetCreatedAtOk() (*int64, bool)` + +GetCreatedAtOk returns a tuple with the CreatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedAt + +`func (o *ServiceGetApi200Response) SetCreatedAt(v int64)` + +SetCreatedAt sets CreatedAt field to given value. + +### HasCreatedAt + +`func (o *ServiceGetApi200Response) HasCreatedAt() bool` + +HasCreatedAt returns a boolean if a field has been set. + +### GetModifiedAt + +`func (o *ServiceGetApi200Response) GetModifiedAt() int64` + +GetModifiedAt returns the ModifiedAt field if non-nil, zero value otherwise. + +### GetModifiedAtOk + +`func (o *ServiceGetApi200Response) GetModifiedAtOk() (*int64, bool)` + +GetModifiedAtOk returns a tuple with the ModifiedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModifiedAt + +`func (o *ServiceGetApi200Response) SetModifiedAt(v int64)` + +SetModifiedAt sets ModifiedAt field to given value. + +### HasModifiedAt + +`func (o *ServiceGetApi200Response) HasModifiedAt() bool` + +HasModifiedAt returns a boolean if a field has been set. + +### GetAuthenticationCallbackEndpoint + +`func (o *ServiceGetApi200Response) GetAuthenticationCallbackEndpoint() string` + +GetAuthenticationCallbackEndpoint returns the AuthenticationCallbackEndpoint field if non-nil, zero value otherwise. + +### GetAuthenticationCallbackEndpointOk + +`func (o *ServiceGetApi200Response) GetAuthenticationCallbackEndpointOk() (*string, bool)` + +GetAuthenticationCallbackEndpointOk returns a tuple with the AuthenticationCallbackEndpoint field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthenticationCallbackEndpoint + +`func (o *ServiceGetApi200Response) SetAuthenticationCallbackEndpoint(v string)` + +SetAuthenticationCallbackEndpoint sets AuthenticationCallbackEndpoint field to given value. + +### HasAuthenticationCallbackEndpoint + +`func (o *ServiceGetApi200Response) HasAuthenticationCallbackEndpoint() bool` + +HasAuthenticationCallbackEndpoint returns a boolean if a field has been set. + +### GetAuthenticationCallbackApiKey + +`func (o *ServiceGetApi200Response) GetAuthenticationCallbackApiKey() string` + +GetAuthenticationCallbackApiKey returns the AuthenticationCallbackApiKey field if non-nil, zero value otherwise. + +### GetAuthenticationCallbackApiKeyOk + +`func (o *ServiceGetApi200Response) GetAuthenticationCallbackApiKeyOk() (*string, bool)` + +GetAuthenticationCallbackApiKeyOk returns a tuple with the AuthenticationCallbackApiKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthenticationCallbackApiKey + +`func (o *ServiceGetApi200Response) SetAuthenticationCallbackApiKey(v string)` + +SetAuthenticationCallbackApiKey sets AuthenticationCallbackApiKey field to given value. + +### HasAuthenticationCallbackApiKey + +`func (o *ServiceGetApi200Response) HasAuthenticationCallbackApiKey() bool` + +HasAuthenticationCallbackApiKey returns a boolean if a field has been set. + +### GetAuthenticationCallbackApiSecret + +`func (o *ServiceGetApi200Response) GetAuthenticationCallbackApiSecret() string` + +GetAuthenticationCallbackApiSecret returns the AuthenticationCallbackApiSecret field if non-nil, zero value otherwise. + +### GetAuthenticationCallbackApiSecretOk + +`func (o *ServiceGetApi200Response) GetAuthenticationCallbackApiSecretOk() (*string, bool)` + +GetAuthenticationCallbackApiSecretOk returns a tuple with the AuthenticationCallbackApiSecret field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthenticationCallbackApiSecret + +`func (o *ServiceGetApi200Response) SetAuthenticationCallbackApiSecret(v string)` + +SetAuthenticationCallbackApiSecret sets AuthenticationCallbackApiSecret field to given value. + +### HasAuthenticationCallbackApiSecret + +`func (o *ServiceGetApi200Response) HasAuthenticationCallbackApiSecret() bool` + +HasAuthenticationCallbackApiSecret returns a boolean if a field has been set. + +### GetSupportedAcrs + +`func (o *ServiceGetApi200Response) GetSupportedAcrs() []string` + +GetSupportedAcrs returns the SupportedAcrs field if non-nil, zero value otherwise. + +### GetSupportedAcrsOk + +`func (o *ServiceGetApi200Response) GetSupportedAcrsOk() (*[]string, bool)` + +GetSupportedAcrsOk returns a tuple with the SupportedAcrs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSupportedAcrs + +`func (o *ServiceGetApi200Response) SetSupportedAcrs(v []string)` + +SetSupportedAcrs sets SupportedAcrs field to given value. + +### HasSupportedAcrs + +`func (o *ServiceGetApi200Response) HasSupportedAcrs() bool` + +HasSupportedAcrs returns a boolean if a field has been set. + +### GetSupportedGrantTypes + +`func (o *ServiceGetApi200Response) GetSupportedGrantTypes() []GrantType` + +GetSupportedGrantTypes returns the SupportedGrantTypes field if non-nil, zero value otherwise. + +### GetSupportedGrantTypesOk + +`func (o *ServiceGetApi200Response) GetSupportedGrantTypesOk() (*[]GrantType, bool)` + +GetSupportedGrantTypesOk returns a tuple with the SupportedGrantTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSupportedGrantTypes + +`func (o *ServiceGetApi200Response) SetSupportedGrantTypes(v []GrantType)` + +SetSupportedGrantTypes sets SupportedGrantTypes field to given value. + +### HasSupportedGrantTypes + +`func (o *ServiceGetApi200Response) HasSupportedGrantTypes() bool` + +HasSupportedGrantTypes returns a boolean if a field has been set. + +### GetSupportedResponseTypes + +`func (o *ServiceGetApi200Response) GetSupportedResponseTypes() []ResponseType` + +GetSupportedResponseTypes returns the SupportedResponseTypes field if non-nil, zero value otherwise. + +### GetSupportedResponseTypesOk + +`func (o *ServiceGetApi200Response) GetSupportedResponseTypesOk() (*[]ResponseType, bool)` + +GetSupportedResponseTypesOk returns a tuple with the SupportedResponseTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSupportedResponseTypes + +`func (o *ServiceGetApi200Response) SetSupportedResponseTypes(v []ResponseType)` + +SetSupportedResponseTypes sets SupportedResponseTypes field to given value. + +### HasSupportedResponseTypes + +`func (o *ServiceGetApi200Response) HasSupportedResponseTypes() bool` + +HasSupportedResponseTypes returns a boolean if a field has been set. + +### GetSupportedAuthorizationDetailsTypes + +`func (o *ServiceGetApi200Response) GetSupportedAuthorizationDetailsTypes() []string` + +GetSupportedAuthorizationDetailsTypes returns the SupportedAuthorizationDetailsTypes field if non-nil, zero value otherwise. + +### GetSupportedAuthorizationDetailsTypesOk + +`func (o *ServiceGetApi200Response) GetSupportedAuthorizationDetailsTypesOk() (*[]string, bool)` + +GetSupportedAuthorizationDetailsTypesOk returns a tuple with the SupportedAuthorizationDetailsTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSupportedAuthorizationDetailsTypes + +`func (o *ServiceGetApi200Response) SetSupportedAuthorizationDetailsTypes(v []string)` + +SetSupportedAuthorizationDetailsTypes sets SupportedAuthorizationDetailsTypes field to given value. + +### HasSupportedAuthorizationDetailsTypes + +`func (o *ServiceGetApi200Response) HasSupportedAuthorizationDetailsTypes() bool` + +HasSupportedAuthorizationDetailsTypes returns a boolean if a field has been set. + +### GetSupportedServiceProfiles + +`func (o *ServiceGetApi200Response) GetSupportedServiceProfiles() []ServiceProfile` + +GetSupportedServiceProfiles returns the SupportedServiceProfiles field if non-nil, zero value otherwise. + +### GetSupportedServiceProfilesOk + +`func (o *ServiceGetApi200Response) GetSupportedServiceProfilesOk() (*[]ServiceProfile, bool)` + +GetSupportedServiceProfilesOk returns a tuple with the SupportedServiceProfiles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSupportedServiceProfiles + +`func (o *ServiceGetApi200Response) SetSupportedServiceProfiles(v []ServiceProfile)` + +SetSupportedServiceProfiles sets SupportedServiceProfiles field to given value. + +### HasSupportedServiceProfiles + +`func (o *ServiceGetApi200Response) HasSupportedServiceProfiles() bool` + +HasSupportedServiceProfiles returns a boolean if a field has been set. + +### GetErrorDescriptionOmitted + +`func (o *ServiceGetApi200Response) GetErrorDescriptionOmitted() bool` + +GetErrorDescriptionOmitted returns the ErrorDescriptionOmitted field if non-nil, zero value otherwise. + +### GetErrorDescriptionOmittedOk + +`func (o *ServiceGetApi200Response) GetErrorDescriptionOmittedOk() (*bool, bool)` + +GetErrorDescriptionOmittedOk returns a tuple with the ErrorDescriptionOmitted field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorDescriptionOmitted + +`func (o *ServiceGetApi200Response) SetErrorDescriptionOmitted(v bool)` + +SetErrorDescriptionOmitted sets ErrorDescriptionOmitted field to given value. + +### HasErrorDescriptionOmitted + +`func (o *ServiceGetApi200Response) HasErrorDescriptionOmitted() bool` + +HasErrorDescriptionOmitted returns a boolean if a field has been set. + +### GetErrorUriOmitted + +`func (o *ServiceGetApi200Response) GetErrorUriOmitted() bool` + +GetErrorUriOmitted returns the ErrorUriOmitted field if non-nil, zero value otherwise. + +### GetErrorUriOmittedOk + +`func (o *ServiceGetApi200Response) GetErrorUriOmittedOk() (*bool, bool)` + +GetErrorUriOmittedOk returns a tuple with the ErrorUriOmitted field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorUriOmitted + +`func (o *ServiceGetApi200Response) SetErrorUriOmitted(v bool)` + +SetErrorUriOmitted sets ErrorUriOmitted field to given value. + +### HasErrorUriOmitted + +`func (o *ServiceGetApi200Response) HasErrorUriOmitted() bool` + +HasErrorUriOmitted returns a boolean if a field has been set. + +### GetAuthorizationEndpoint + +`func (o *ServiceGetApi200Response) GetAuthorizationEndpoint() string` + +GetAuthorizationEndpoint returns the AuthorizationEndpoint field if non-nil, zero value otherwise. + +### GetAuthorizationEndpointOk + +`func (o *ServiceGetApi200Response) GetAuthorizationEndpointOk() (*string, bool)` + +GetAuthorizationEndpointOk returns a tuple with the AuthorizationEndpoint field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthorizationEndpoint + +`func (o *ServiceGetApi200Response) SetAuthorizationEndpoint(v string)` + +SetAuthorizationEndpoint sets AuthorizationEndpoint field to given value. + +### HasAuthorizationEndpoint + +`func (o *ServiceGetApi200Response) HasAuthorizationEndpoint() bool` + +HasAuthorizationEndpoint returns a boolean if a field has been set. + +### GetDirectAuthorizationEndpointEnabled + +`func (o *ServiceGetApi200Response) GetDirectAuthorizationEndpointEnabled() bool` + +GetDirectAuthorizationEndpointEnabled returns the DirectAuthorizationEndpointEnabled field if non-nil, zero value otherwise. + +### GetDirectAuthorizationEndpointEnabledOk + +`func (o *ServiceGetApi200Response) GetDirectAuthorizationEndpointEnabledOk() (*bool, bool)` + +GetDirectAuthorizationEndpointEnabledOk returns a tuple with the DirectAuthorizationEndpointEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDirectAuthorizationEndpointEnabled + +`func (o *ServiceGetApi200Response) SetDirectAuthorizationEndpointEnabled(v bool)` + +SetDirectAuthorizationEndpointEnabled sets DirectAuthorizationEndpointEnabled field to given value. + +### HasDirectAuthorizationEndpointEnabled + +`func (o *ServiceGetApi200Response) HasDirectAuthorizationEndpointEnabled() bool` + +HasDirectAuthorizationEndpointEnabled returns a boolean if a field has been set. + +### GetSupportedUiLocales + +`func (o *ServiceGetApi200Response) GetSupportedUiLocales() []string` + +GetSupportedUiLocales returns the SupportedUiLocales field if non-nil, zero value otherwise. + +### GetSupportedUiLocalesOk + +`func (o *ServiceGetApi200Response) GetSupportedUiLocalesOk() (*[]string, bool)` + +GetSupportedUiLocalesOk returns a tuple with the SupportedUiLocales field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSupportedUiLocales + +`func (o *ServiceGetApi200Response) SetSupportedUiLocales(v []string)` + +SetSupportedUiLocales sets SupportedUiLocales field to given value. + +### HasSupportedUiLocales + +`func (o *ServiceGetApi200Response) HasSupportedUiLocales() bool` + +HasSupportedUiLocales returns a boolean if a field has been set. + +### GetSupportedDisplays + +`func (o *ServiceGetApi200Response) GetSupportedDisplays() []Display` + +GetSupportedDisplays returns the SupportedDisplays field if non-nil, zero value otherwise. + +### GetSupportedDisplaysOk + +`func (o *ServiceGetApi200Response) GetSupportedDisplaysOk() (*[]Display, bool)` + +GetSupportedDisplaysOk returns a tuple with the SupportedDisplays field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSupportedDisplays + +`func (o *ServiceGetApi200Response) SetSupportedDisplays(v []Display)` + +SetSupportedDisplays sets SupportedDisplays field to given value. + +### HasSupportedDisplays + +`func (o *ServiceGetApi200Response) HasSupportedDisplays() bool` + +HasSupportedDisplays returns a boolean if a field has been set. + +### GetPkceRequired + +`func (o *ServiceGetApi200Response) GetPkceRequired() bool` + +GetPkceRequired returns the PkceRequired field if non-nil, zero value otherwise. + +### GetPkceRequiredOk + +`func (o *ServiceGetApi200Response) GetPkceRequiredOk() (*bool, bool)` + +GetPkceRequiredOk returns a tuple with the PkceRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPkceRequired + +`func (o *ServiceGetApi200Response) SetPkceRequired(v bool)` + +SetPkceRequired sets PkceRequired field to given value. + +### HasPkceRequired + +`func (o *ServiceGetApi200Response) HasPkceRequired() bool` + +HasPkceRequired returns a boolean if a field has been set. + +### GetPkceS256Required + +`func (o *ServiceGetApi200Response) GetPkceS256Required() bool` + +GetPkceS256Required returns the PkceS256Required field if non-nil, zero value otherwise. + +### GetPkceS256RequiredOk + +`func (o *ServiceGetApi200Response) GetPkceS256RequiredOk() (*bool, bool)` + +GetPkceS256RequiredOk returns a tuple with the PkceS256Required field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPkceS256Required + +`func (o *ServiceGetApi200Response) SetPkceS256Required(v bool)` + +SetPkceS256Required sets PkceS256Required field to given value. + +### HasPkceS256Required + +`func (o *ServiceGetApi200Response) HasPkceS256Required() bool` + +HasPkceS256Required returns a boolean if a field has been set. + +### GetAuthorizationResponseDuration + +`func (o *ServiceGetApi200Response) GetAuthorizationResponseDuration() int64` + +GetAuthorizationResponseDuration returns the AuthorizationResponseDuration field if non-nil, zero value otherwise. + +### GetAuthorizationResponseDurationOk + +`func (o *ServiceGetApi200Response) GetAuthorizationResponseDurationOk() (*int64, bool)` + +GetAuthorizationResponseDurationOk returns a tuple with the AuthorizationResponseDuration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthorizationResponseDuration + +`func (o *ServiceGetApi200Response) SetAuthorizationResponseDuration(v int64)` + +SetAuthorizationResponseDuration sets AuthorizationResponseDuration field to given value. + +### HasAuthorizationResponseDuration + +`func (o *ServiceGetApi200Response) HasAuthorizationResponseDuration() bool` + +HasAuthorizationResponseDuration returns a boolean if a field has been set. + +### GetTokenEndpoint + +`func (o *ServiceGetApi200Response) GetTokenEndpoint() string` + +GetTokenEndpoint returns the TokenEndpoint field if non-nil, zero value otherwise. + +### GetTokenEndpointOk + +`func (o *ServiceGetApi200Response) GetTokenEndpointOk() (*string, bool)` + +GetTokenEndpointOk returns a tuple with the TokenEndpoint field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTokenEndpoint + +`func (o *ServiceGetApi200Response) SetTokenEndpoint(v string)` + +SetTokenEndpoint sets TokenEndpoint field to given value. + +### HasTokenEndpoint + +`func (o *ServiceGetApi200Response) HasTokenEndpoint() bool` + +HasTokenEndpoint returns a boolean if a field has been set. + +### GetDirectTokenEndpointEnabled + +`func (o *ServiceGetApi200Response) GetDirectTokenEndpointEnabled() bool` + +GetDirectTokenEndpointEnabled returns the DirectTokenEndpointEnabled field if non-nil, zero value otherwise. + +### GetDirectTokenEndpointEnabledOk + +`func (o *ServiceGetApi200Response) GetDirectTokenEndpointEnabledOk() (*bool, bool)` + +GetDirectTokenEndpointEnabledOk returns a tuple with the DirectTokenEndpointEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDirectTokenEndpointEnabled + +`func (o *ServiceGetApi200Response) SetDirectTokenEndpointEnabled(v bool)` + +SetDirectTokenEndpointEnabled sets DirectTokenEndpointEnabled field to given value. + +### HasDirectTokenEndpointEnabled + +`func (o *ServiceGetApi200Response) HasDirectTokenEndpointEnabled() bool` + +HasDirectTokenEndpointEnabled returns a boolean if a field has been set. + +### GetSupportedTokenAuthMethods + +`func (o *ServiceGetApi200Response) GetSupportedTokenAuthMethods() []ClientAuthMethod` + +GetSupportedTokenAuthMethods returns the SupportedTokenAuthMethods field if non-nil, zero value otherwise. + +### GetSupportedTokenAuthMethodsOk + +`func (o *ServiceGetApi200Response) GetSupportedTokenAuthMethodsOk() (*[]ClientAuthMethod, bool)` + +GetSupportedTokenAuthMethodsOk returns a tuple with the SupportedTokenAuthMethods field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSupportedTokenAuthMethods + +`func (o *ServiceGetApi200Response) SetSupportedTokenAuthMethods(v []ClientAuthMethod)` + +SetSupportedTokenAuthMethods sets SupportedTokenAuthMethods field to given value. + +### HasSupportedTokenAuthMethods + +`func (o *ServiceGetApi200Response) HasSupportedTokenAuthMethods() bool` + +HasSupportedTokenAuthMethods returns a boolean if a field has been set. + +### GetMissingClientIdAllowed + +`func (o *ServiceGetApi200Response) GetMissingClientIdAllowed() bool` + +GetMissingClientIdAllowed returns the MissingClientIdAllowed field if non-nil, zero value otherwise. + +### GetMissingClientIdAllowedOk + +`func (o *ServiceGetApi200Response) GetMissingClientIdAllowedOk() (*bool, bool)` + +GetMissingClientIdAllowedOk returns a tuple with the MissingClientIdAllowed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMissingClientIdAllowed + +`func (o *ServiceGetApi200Response) SetMissingClientIdAllowed(v bool)` + +SetMissingClientIdAllowed sets MissingClientIdAllowed field to given value. + +### HasMissingClientIdAllowed + +`func (o *ServiceGetApi200Response) HasMissingClientIdAllowed() bool` + +HasMissingClientIdAllowed returns a boolean if a field has been set. + +### GetRevocationEndpoint + +`func (o *ServiceGetApi200Response) GetRevocationEndpoint() string` + +GetRevocationEndpoint returns the RevocationEndpoint field if non-nil, zero value otherwise. + +### GetRevocationEndpointOk + +`func (o *ServiceGetApi200Response) GetRevocationEndpointOk() (*string, bool)` + +GetRevocationEndpointOk returns a tuple with the RevocationEndpoint field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRevocationEndpoint + +`func (o *ServiceGetApi200Response) SetRevocationEndpoint(v string)` + +SetRevocationEndpoint sets RevocationEndpoint field to given value. + +### HasRevocationEndpoint + +`func (o *ServiceGetApi200Response) HasRevocationEndpoint() bool` + +HasRevocationEndpoint returns a boolean if a field has been set. + +### GetDirectRevocationEndpointEnabled + +`func (o *ServiceGetApi200Response) GetDirectRevocationEndpointEnabled() bool` + +GetDirectRevocationEndpointEnabled returns the DirectRevocationEndpointEnabled field if non-nil, zero value otherwise. + +### GetDirectRevocationEndpointEnabledOk + +`func (o *ServiceGetApi200Response) GetDirectRevocationEndpointEnabledOk() (*bool, bool)` + +GetDirectRevocationEndpointEnabledOk returns a tuple with the DirectRevocationEndpointEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDirectRevocationEndpointEnabled + +`func (o *ServiceGetApi200Response) SetDirectRevocationEndpointEnabled(v bool)` + +SetDirectRevocationEndpointEnabled sets DirectRevocationEndpointEnabled field to given value. + +### HasDirectRevocationEndpointEnabled + +`func (o *ServiceGetApi200Response) HasDirectRevocationEndpointEnabled() bool` + +HasDirectRevocationEndpointEnabled returns a boolean if a field has been set. + +### GetSupportedRevocationAuthMethods + +`func (o *ServiceGetApi200Response) GetSupportedRevocationAuthMethods() []ClientAuthMethod` + +GetSupportedRevocationAuthMethods returns the SupportedRevocationAuthMethods field if non-nil, zero value otherwise. + +### GetSupportedRevocationAuthMethodsOk + +`func (o *ServiceGetApi200Response) GetSupportedRevocationAuthMethodsOk() (*[]ClientAuthMethod, bool)` + +GetSupportedRevocationAuthMethodsOk returns a tuple with the SupportedRevocationAuthMethods field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSupportedRevocationAuthMethods + +`func (o *ServiceGetApi200Response) SetSupportedRevocationAuthMethods(v []ClientAuthMethod)` + +SetSupportedRevocationAuthMethods sets SupportedRevocationAuthMethods field to given value. + +### HasSupportedRevocationAuthMethods + +`func (o *ServiceGetApi200Response) HasSupportedRevocationAuthMethods() bool` + +HasSupportedRevocationAuthMethods returns a boolean if a field has been set. + +### GetIntrospectionEndpoint + +`func (o *ServiceGetApi200Response) GetIntrospectionEndpoint() string` + +GetIntrospectionEndpoint returns the IntrospectionEndpoint field if non-nil, zero value otherwise. + +### GetIntrospectionEndpointOk + +`func (o *ServiceGetApi200Response) GetIntrospectionEndpointOk() (*string, bool)` + +GetIntrospectionEndpointOk returns a tuple with the IntrospectionEndpoint field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIntrospectionEndpoint + +`func (o *ServiceGetApi200Response) SetIntrospectionEndpoint(v string)` + +SetIntrospectionEndpoint sets IntrospectionEndpoint field to given value. + +### HasIntrospectionEndpoint + +`func (o *ServiceGetApi200Response) HasIntrospectionEndpoint() bool` + +HasIntrospectionEndpoint returns a boolean if a field has been set. + +### GetDirectIntrospectionEndpointEnabled + +`func (o *ServiceGetApi200Response) GetDirectIntrospectionEndpointEnabled() bool` + +GetDirectIntrospectionEndpointEnabled returns the DirectIntrospectionEndpointEnabled field if non-nil, zero value otherwise. + +### GetDirectIntrospectionEndpointEnabledOk + +`func (o *ServiceGetApi200Response) GetDirectIntrospectionEndpointEnabledOk() (*bool, bool)` + +GetDirectIntrospectionEndpointEnabledOk returns a tuple with the DirectIntrospectionEndpointEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDirectIntrospectionEndpointEnabled + +`func (o *ServiceGetApi200Response) SetDirectIntrospectionEndpointEnabled(v bool)` + +SetDirectIntrospectionEndpointEnabled sets DirectIntrospectionEndpointEnabled field to given value. + +### HasDirectIntrospectionEndpointEnabled + +`func (o *ServiceGetApi200Response) HasDirectIntrospectionEndpointEnabled() bool` + +HasDirectIntrospectionEndpointEnabled returns a boolean if a field has been set. + +### GetSupportedIntrospectionAuthMethods + +`func (o *ServiceGetApi200Response) GetSupportedIntrospectionAuthMethods() []ClientAuthMethod` + +GetSupportedIntrospectionAuthMethods returns the SupportedIntrospectionAuthMethods field if non-nil, zero value otherwise. + +### GetSupportedIntrospectionAuthMethodsOk + +`func (o *ServiceGetApi200Response) GetSupportedIntrospectionAuthMethodsOk() (*[]ClientAuthMethod, bool)` + +GetSupportedIntrospectionAuthMethodsOk returns a tuple with the SupportedIntrospectionAuthMethods field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSupportedIntrospectionAuthMethods + +`func (o *ServiceGetApi200Response) SetSupportedIntrospectionAuthMethods(v []ClientAuthMethod)` + +SetSupportedIntrospectionAuthMethods sets SupportedIntrospectionAuthMethods field to given value. + +### HasSupportedIntrospectionAuthMethods + +`func (o *ServiceGetApi200Response) HasSupportedIntrospectionAuthMethods() bool` + +HasSupportedIntrospectionAuthMethods returns a boolean if a field has been set. + +### GetPushedAuthReqEndpoint + +`func (o *ServiceGetApi200Response) GetPushedAuthReqEndpoint() string` + +GetPushedAuthReqEndpoint returns the PushedAuthReqEndpoint field if non-nil, zero value otherwise. + +### GetPushedAuthReqEndpointOk + +`func (o *ServiceGetApi200Response) GetPushedAuthReqEndpointOk() (*string, bool)` + +GetPushedAuthReqEndpointOk returns a tuple with the PushedAuthReqEndpoint field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPushedAuthReqEndpoint + +`func (o *ServiceGetApi200Response) SetPushedAuthReqEndpoint(v string)` + +SetPushedAuthReqEndpoint sets PushedAuthReqEndpoint field to given value. + +### HasPushedAuthReqEndpoint + +`func (o *ServiceGetApi200Response) HasPushedAuthReqEndpoint() bool` + +HasPushedAuthReqEndpoint returns a boolean if a field has been set. + +### GetPushedAuthReqDuration + +`func (o *ServiceGetApi200Response) GetPushedAuthReqDuration() int64` + +GetPushedAuthReqDuration returns the PushedAuthReqDuration field if non-nil, zero value otherwise. + +### GetPushedAuthReqDurationOk + +`func (o *ServiceGetApi200Response) GetPushedAuthReqDurationOk() (*int64, bool)` + +GetPushedAuthReqDurationOk returns a tuple with the PushedAuthReqDuration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPushedAuthReqDuration + +`func (o *ServiceGetApi200Response) SetPushedAuthReqDuration(v int64)` + +SetPushedAuthReqDuration sets PushedAuthReqDuration field to given value. + +### HasPushedAuthReqDuration + +`func (o *ServiceGetApi200Response) HasPushedAuthReqDuration() bool` + +HasPushedAuthReqDuration returns a boolean if a field has been set. + +### GetParRequired + +`func (o *ServiceGetApi200Response) GetParRequired() bool` + +GetParRequired returns the ParRequired field if non-nil, zero value otherwise. + +### GetParRequiredOk + +`func (o *ServiceGetApi200Response) GetParRequiredOk() (*bool, bool)` + +GetParRequiredOk returns a tuple with the ParRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetParRequired + +`func (o *ServiceGetApi200Response) SetParRequired(v bool)` + +SetParRequired sets ParRequired field to given value. + +### HasParRequired + +`func (o *ServiceGetApi200Response) HasParRequired() bool` + +HasParRequired returns a boolean if a field has been set. + +### GetRequestObjectRequired + +`func (o *ServiceGetApi200Response) GetRequestObjectRequired() bool` + +GetRequestObjectRequired returns the RequestObjectRequired field if non-nil, zero value otherwise. + +### GetRequestObjectRequiredOk + +`func (o *ServiceGetApi200Response) GetRequestObjectRequiredOk() (*bool, bool)` + +GetRequestObjectRequiredOk returns a tuple with the RequestObjectRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestObjectRequired + +`func (o *ServiceGetApi200Response) SetRequestObjectRequired(v bool)` + +SetRequestObjectRequired sets RequestObjectRequired field to given value. + +### HasRequestObjectRequired + +`func (o *ServiceGetApi200Response) HasRequestObjectRequired() bool` + +HasRequestObjectRequired returns a boolean if a field has been set. + +### GetTraditionalRequestObjectProcessingApplied + +`func (o *ServiceGetApi200Response) GetTraditionalRequestObjectProcessingApplied() bool` + +GetTraditionalRequestObjectProcessingApplied returns the TraditionalRequestObjectProcessingApplied field if non-nil, zero value otherwise. + +### GetTraditionalRequestObjectProcessingAppliedOk + +`func (o *ServiceGetApi200Response) GetTraditionalRequestObjectProcessingAppliedOk() (*bool, bool)` + +GetTraditionalRequestObjectProcessingAppliedOk returns a tuple with the TraditionalRequestObjectProcessingApplied field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTraditionalRequestObjectProcessingApplied + +`func (o *ServiceGetApi200Response) SetTraditionalRequestObjectProcessingApplied(v bool)` + +SetTraditionalRequestObjectProcessingApplied sets TraditionalRequestObjectProcessingApplied field to given value. + +### HasTraditionalRequestObjectProcessingApplied + +`func (o *ServiceGetApi200Response) HasTraditionalRequestObjectProcessingApplied() bool` + +HasTraditionalRequestObjectProcessingApplied returns a boolean if a field has been set. + +### GetMutualTlsValidatePkiCertChain + +`func (o *ServiceGetApi200Response) GetMutualTlsValidatePkiCertChain() bool` + +GetMutualTlsValidatePkiCertChain returns the MutualTlsValidatePkiCertChain field if non-nil, zero value otherwise. + +### GetMutualTlsValidatePkiCertChainOk + +`func (o *ServiceGetApi200Response) GetMutualTlsValidatePkiCertChainOk() (*bool, bool)` + +GetMutualTlsValidatePkiCertChainOk returns a tuple with the MutualTlsValidatePkiCertChain field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMutualTlsValidatePkiCertChain + +`func (o *ServiceGetApi200Response) SetMutualTlsValidatePkiCertChain(v bool)` + +SetMutualTlsValidatePkiCertChain sets MutualTlsValidatePkiCertChain field to given value. + +### HasMutualTlsValidatePkiCertChain + +`func (o *ServiceGetApi200Response) HasMutualTlsValidatePkiCertChain() bool` + +HasMutualTlsValidatePkiCertChain returns a boolean if a field has been set. + +### GetTrustedRootCertificates + +`func (o *ServiceGetApi200Response) GetTrustedRootCertificates() []string` + +GetTrustedRootCertificates returns the TrustedRootCertificates field if non-nil, zero value otherwise. + +### GetTrustedRootCertificatesOk + +`func (o *ServiceGetApi200Response) GetTrustedRootCertificatesOk() (*[]string, bool)` + +GetTrustedRootCertificatesOk returns a tuple with the TrustedRootCertificates field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTrustedRootCertificates + +`func (o *ServiceGetApi200Response) SetTrustedRootCertificates(v []string)` + +SetTrustedRootCertificates sets TrustedRootCertificates field to given value. + +### HasTrustedRootCertificates + +`func (o *ServiceGetApi200Response) HasTrustedRootCertificates() bool` + +HasTrustedRootCertificates returns a boolean if a field has been set. + +### GetMtlsEndpointAliases + +`func (o *ServiceGetApi200Response) GetMtlsEndpointAliases() []NamedUri` + +GetMtlsEndpointAliases returns the MtlsEndpointAliases field if non-nil, zero value otherwise. + +### GetMtlsEndpointAliasesOk + +`func (o *ServiceGetApi200Response) GetMtlsEndpointAliasesOk() (*[]NamedUri, bool)` + +GetMtlsEndpointAliasesOk returns a tuple with the MtlsEndpointAliases field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMtlsEndpointAliases + +`func (o *ServiceGetApi200Response) SetMtlsEndpointAliases(v []NamedUri)` + +SetMtlsEndpointAliases sets MtlsEndpointAliases field to given value. + +### HasMtlsEndpointAliases + +`func (o *ServiceGetApi200Response) HasMtlsEndpointAliases() bool` + +HasMtlsEndpointAliases returns a boolean if a field has been set. + +### GetAccessTokenType + +`func (o *ServiceGetApi200Response) GetAccessTokenType() string` + +GetAccessTokenType returns the AccessTokenType field if non-nil, zero value otherwise. + +### GetAccessTokenTypeOk + +`func (o *ServiceGetApi200Response) GetAccessTokenTypeOk() (*string, bool)` + +GetAccessTokenTypeOk returns a tuple with the AccessTokenType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessTokenType + +`func (o *ServiceGetApi200Response) SetAccessTokenType(v string)` + +SetAccessTokenType sets AccessTokenType field to given value. + +### HasAccessTokenType + +`func (o *ServiceGetApi200Response) HasAccessTokenType() bool` + +HasAccessTokenType returns a boolean if a field has been set. + +### GetTlsClientCertificateBoundAccessTokens + +`func (o *ServiceGetApi200Response) GetTlsClientCertificateBoundAccessTokens() bool` + +GetTlsClientCertificateBoundAccessTokens returns the TlsClientCertificateBoundAccessTokens field if non-nil, zero value otherwise. + +### GetTlsClientCertificateBoundAccessTokensOk + +`func (o *ServiceGetApi200Response) GetTlsClientCertificateBoundAccessTokensOk() (*bool, bool)` + +GetTlsClientCertificateBoundAccessTokensOk returns a tuple with the TlsClientCertificateBoundAccessTokens field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTlsClientCertificateBoundAccessTokens + +`func (o *ServiceGetApi200Response) SetTlsClientCertificateBoundAccessTokens(v bool)` + +SetTlsClientCertificateBoundAccessTokens sets TlsClientCertificateBoundAccessTokens field to given value. + +### HasTlsClientCertificateBoundAccessTokens + +`func (o *ServiceGetApi200Response) HasTlsClientCertificateBoundAccessTokens() bool` + +HasTlsClientCertificateBoundAccessTokens returns a boolean if a field has been set. + +### GetAccessTokenDuration + +`func (o *ServiceGetApi200Response) GetAccessTokenDuration() int64` + +GetAccessTokenDuration returns the AccessTokenDuration field if non-nil, zero value otherwise. + +### GetAccessTokenDurationOk + +`func (o *ServiceGetApi200Response) GetAccessTokenDurationOk() (*int64, bool)` + +GetAccessTokenDurationOk returns a tuple with the AccessTokenDuration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessTokenDuration + +`func (o *ServiceGetApi200Response) SetAccessTokenDuration(v int64)` + +SetAccessTokenDuration sets AccessTokenDuration field to given value. + +### HasAccessTokenDuration + +`func (o *ServiceGetApi200Response) HasAccessTokenDuration() bool` + +HasAccessTokenDuration returns a boolean if a field has been set. + +### GetSingleAccessTokenPerSubject + +`func (o *ServiceGetApi200Response) GetSingleAccessTokenPerSubject() bool` + +GetSingleAccessTokenPerSubject returns the SingleAccessTokenPerSubject field if non-nil, zero value otherwise. + +### GetSingleAccessTokenPerSubjectOk + +`func (o *ServiceGetApi200Response) GetSingleAccessTokenPerSubjectOk() (*bool, bool)` + +GetSingleAccessTokenPerSubjectOk returns a tuple with the SingleAccessTokenPerSubject field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSingleAccessTokenPerSubject + +`func (o *ServiceGetApi200Response) SetSingleAccessTokenPerSubject(v bool)` + +SetSingleAccessTokenPerSubject sets SingleAccessTokenPerSubject field to given value. + +### HasSingleAccessTokenPerSubject + +`func (o *ServiceGetApi200Response) HasSingleAccessTokenPerSubject() bool` + +HasSingleAccessTokenPerSubject returns a boolean if a field has been set. + +### GetAccessTokenSignAlg + +`func (o *ServiceGetApi200Response) GetAccessTokenSignAlg() JwsAlg` + +GetAccessTokenSignAlg returns the AccessTokenSignAlg field if non-nil, zero value otherwise. + +### GetAccessTokenSignAlgOk + +`func (o *ServiceGetApi200Response) GetAccessTokenSignAlgOk() (*JwsAlg, bool)` + +GetAccessTokenSignAlgOk returns a tuple with the AccessTokenSignAlg field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessTokenSignAlg + +`func (o *ServiceGetApi200Response) SetAccessTokenSignAlg(v JwsAlg)` + +SetAccessTokenSignAlg sets AccessTokenSignAlg field to given value. + +### HasAccessTokenSignAlg + +`func (o *ServiceGetApi200Response) HasAccessTokenSignAlg() bool` + +HasAccessTokenSignAlg returns a boolean if a field has been set. + +### GetAccessTokenSignatureKeyId + +`func (o *ServiceGetApi200Response) GetAccessTokenSignatureKeyId() string` + +GetAccessTokenSignatureKeyId returns the AccessTokenSignatureKeyId field if non-nil, zero value otherwise. + +### GetAccessTokenSignatureKeyIdOk + +`func (o *ServiceGetApi200Response) GetAccessTokenSignatureKeyIdOk() (*string, bool)` + +GetAccessTokenSignatureKeyIdOk returns a tuple with the AccessTokenSignatureKeyId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessTokenSignatureKeyId + +`func (o *ServiceGetApi200Response) SetAccessTokenSignatureKeyId(v string)` + +SetAccessTokenSignatureKeyId sets AccessTokenSignatureKeyId field to given value. + +### HasAccessTokenSignatureKeyId + +`func (o *ServiceGetApi200Response) HasAccessTokenSignatureKeyId() bool` + +HasAccessTokenSignatureKeyId returns a boolean if a field has been set. + +### GetRefreshTokenDuration + +`func (o *ServiceGetApi200Response) GetRefreshTokenDuration() int64` + +GetRefreshTokenDuration returns the RefreshTokenDuration field if non-nil, zero value otherwise. + +### GetRefreshTokenDurationOk + +`func (o *ServiceGetApi200Response) GetRefreshTokenDurationOk() (*int64, bool)` + +GetRefreshTokenDurationOk returns a tuple with the RefreshTokenDuration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRefreshTokenDuration + +`func (o *ServiceGetApi200Response) SetRefreshTokenDuration(v int64)` + +SetRefreshTokenDuration sets RefreshTokenDuration field to given value. + +### HasRefreshTokenDuration + +`func (o *ServiceGetApi200Response) HasRefreshTokenDuration() bool` + +HasRefreshTokenDuration returns a boolean if a field has been set. + +### GetRefreshTokenDurationKept + +`func (o *ServiceGetApi200Response) GetRefreshTokenDurationKept() bool` + +GetRefreshTokenDurationKept returns the RefreshTokenDurationKept field if non-nil, zero value otherwise. + +### GetRefreshTokenDurationKeptOk + +`func (o *ServiceGetApi200Response) GetRefreshTokenDurationKeptOk() (*bool, bool)` + +GetRefreshTokenDurationKeptOk returns a tuple with the RefreshTokenDurationKept field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRefreshTokenDurationKept + +`func (o *ServiceGetApi200Response) SetRefreshTokenDurationKept(v bool)` + +SetRefreshTokenDurationKept sets RefreshTokenDurationKept field to given value. + +### HasRefreshTokenDurationKept + +`func (o *ServiceGetApi200Response) HasRefreshTokenDurationKept() bool` + +HasRefreshTokenDurationKept returns a boolean if a field has been set. + +### GetRefreshTokenDurationReset + +`func (o *ServiceGetApi200Response) GetRefreshTokenDurationReset() bool` + +GetRefreshTokenDurationReset returns the RefreshTokenDurationReset field if non-nil, zero value otherwise. + +### GetRefreshTokenDurationResetOk + +`func (o *ServiceGetApi200Response) GetRefreshTokenDurationResetOk() (*bool, bool)` + +GetRefreshTokenDurationResetOk returns a tuple with the RefreshTokenDurationReset field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRefreshTokenDurationReset + +`func (o *ServiceGetApi200Response) SetRefreshTokenDurationReset(v bool)` + +SetRefreshTokenDurationReset sets RefreshTokenDurationReset field to given value. + +### HasRefreshTokenDurationReset + +`func (o *ServiceGetApi200Response) HasRefreshTokenDurationReset() bool` + +HasRefreshTokenDurationReset returns a boolean if a field has been set. + +### GetRefreshTokenKept + +`func (o *ServiceGetApi200Response) GetRefreshTokenKept() bool` + +GetRefreshTokenKept returns the RefreshTokenKept field if non-nil, zero value otherwise. + +### GetRefreshTokenKeptOk + +`func (o *ServiceGetApi200Response) GetRefreshTokenKeptOk() (*bool, bool)` + +GetRefreshTokenKeptOk returns a tuple with the RefreshTokenKept field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRefreshTokenKept + +`func (o *ServiceGetApi200Response) SetRefreshTokenKept(v bool)` + +SetRefreshTokenKept sets RefreshTokenKept field to given value. + +### HasRefreshTokenKept + +`func (o *ServiceGetApi200Response) HasRefreshTokenKept() bool` + +HasRefreshTokenKept returns a boolean if a field has been set. + +### GetSupportedScopes + +`func (o *ServiceGetApi200Response) GetSupportedScopes() []Scope` + +GetSupportedScopes returns the SupportedScopes field if non-nil, zero value otherwise. + +### GetSupportedScopesOk + +`func (o *ServiceGetApi200Response) GetSupportedScopesOk() (*[]Scope, bool)` + +GetSupportedScopesOk returns a tuple with the SupportedScopes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSupportedScopes + +`func (o *ServiceGetApi200Response) SetSupportedScopes(v []Scope)` + +SetSupportedScopes sets SupportedScopes field to given value. + +### HasSupportedScopes + +`func (o *ServiceGetApi200Response) HasSupportedScopes() bool` + +HasSupportedScopes returns a boolean if a field has been set. + +### GetScopeRequired + +`func (o *ServiceGetApi200Response) GetScopeRequired() bool` + +GetScopeRequired returns the ScopeRequired field if non-nil, zero value otherwise. + +### GetScopeRequiredOk + +`func (o *ServiceGetApi200Response) GetScopeRequiredOk() (*bool, bool)` + +GetScopeRequiredOk returns a tuple with the ScopeRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScopeRequired + +`func (o *ServiceGetApi200Response) SetScopeRequired(v bool)` + +SetScopeRequired sets ScopeRequired field to given value. + +### HasScopeRequired + +`func (o *ServiceGetApi200Response) HasScopeRequired() bool` + +HasScopeRequired returns a boolean if a field has been set. + +### GetIdTokenDuration + +`func (o *ServiceGetApi200Response) GetIdTokenDuration() int64` + +GetIdTokenDuration returns the IdTokenDuration field if non-nil, zero value otherwise. + +### GetIdTokenDurationOk + +`func (o *ServiceGetApi200Response) GetIdTokenDurationOk() (*int64, bool)` + +GetIdTokenDurationOk returns a tuple with the IdTokenDuration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdTokenDuration + +`func (o *ServiceGetApi200Response) SetIdTokenDuration(v int64)` + +SetIdTokenDuration sets IdTokenDuration field to given value. + +### HasIdTokenDuration + +`func (o *ServiceGetApi200Response) HasIdTokenDuration() bool` + +HasIdTokenDuration returns a boolean if a field has been set. + +### GetAllowableClockSkew + +`func (o *ServiceGetApi200Response) GetAllowableClockSkew() int32` + +GetAllowableClockSkew returns the AllowableClockSkew field if non-nil, zero value otherwise. + +### GetAllowableClockSkewOk + +`func (o *ServiceGetApi200Response) GetAllowableClockSkewOk() (*int32, bool)` + +GetAllowableClockSkewOk returns a tuple with the AllowableClockSkew field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAllowableClockSkew + +`func (o *ServiceGetApi200Response) SetAllowableClockSkew(v int32)` + +SetAllowableClockSkew sets AllowableClockSkew field to given value. + +### HasAllowableClockSkew + +`func (o *ServiceGetApi200Response) HasAllowableClockSkew() bool` + +HasAllowableClockSkew returns a boolean if a field has been set. + +### GetSupportedClaimTypes + +`func (o *ServiceGetApi200Response) GetSupportedClaimTypes() []ClaimType` + +GetSupportedClaimTypes returns the SupportedClaimTypes field if non-nil, zero value otherwise. + +### GetSupportedClaimTypesOk + +`func (o *ServiceGetApi200Response) GetSupportedClaimTypesOk() (*[]ClaimType, bool)` + +GetSupportedClaimTypesOk returns a tuple with the SupportedClaimTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSupportedClaimTypes + +`func (o *ServiceGetApi200Response) SetSupportedClaimTypes(v []ClaimType)` + +SetSupportedClaimTypes sets SupportedClaimTypes field to given value. + +### HasSupportedClaimTypes + +`func (o *ServiceGetApi200Response) HasSupportedClaimTypes() bool` + +HasSupportedClaimTypes returns a boolean if a field has been set. + +### GetSupportedClaimLocales + +`func (o *ServiceGetApi200Response) GetSupportedClaimLocales() []string` + +GetSupportedClaimLocales returns the SupportedClaimLocales field if non-nil, zero value otherwise. + +### GetSupportedClaimLocalesOk + +`func (o *ServiceGetApi200Response) GetSupportedClaimLocalesOk() (*[]string, bool)` + +GetSupportedClaimLocalesOk returns a tuple with the SupportedClaimLocales field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSupportedClaimLocales + +`func (o *ServiceGetApi200Response) SetSupportedClaimLocales(v []string)` + +SetSupportedClaimLocales sets SupportedClaimLocales field to given value. + +### HasSupportedClaimLocales + +`func (o *ServiceGetApi200Response) HasSupportedClaimLocales() bool` + +HasSupportedClaimLocales returns a boolean if a field has been set. + +### GetSupportedClaims + +`func (o *ServiceGetApi200Response) GetSupportedClaims() []string` + +GetSupportedClaims returns the SupportedClaims field if non-nil, zero value otherwise. + +### GetSupportedClaimsOk + +`func (o *ServiceGetApi200Response) GetSupportedClaimsOk() (*[]string, bool)` + +GetSupportedClaimsOk returns a tuple with the SupportedClaims field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSupportedClaims + +`func (o *ServiceGetApi200Response) SetSupportedClaims(v []string)` + +SetSupportedClaims sets SupportedClaims field to given value. + +### HasSupportedClaims + +`func (o *ServiceGetApi200Response) HasSupportedClaims() bool` + +HasSupportedClaims returns a boolean if a field has been set. + +### GetClaimShortcutRestrictive + +`func (o *ServiceGetApi200Response) GetClaimShortcutRestrictive() bool` + +GetClaimShortcutRestrictive returns the ClaimShortcutRestrictive field if non-nil, zero value otherwise. + +### GetClaimShortcutRestrictiveOk + +`func (o *ServiceGetApi200Response) GetClaimShortcutRestrictiveOk() (*bool, bool)` + +GetClaimShortcutRestrictiveOk returns a tuple with the ClaimShortcutRestrictive field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClaimShortcutRestrictive + +`func (o *ServiceGetApi200Response) SetClaimShortcutRestrictive(v bool)` + +SetClaimShortcutRestrictive sets ClaimShortcutRestrictive field to given value. + +### HasClaimShortcutRestrictive + +`func (o *ServiceGetApi200Response) HasClaimShortcutRestrictive() bool` + +HasClaimShortcutRestrictive returns a boolean if a field has been set. + +### GetJwksUri + +`func (o *ServiceGetApi200Response) GetJwksUri() string` + +GetJwksUri returns the JwksUri field if non-nil, zero value otherwise. + +### GetJwksUriOk + +`func (o *ServiceGetApi200Response) GetJwksUriOk() (*string, bool)` + +GetJwksUriOk returns a tuple with the JwksUri field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetJwksUri + +`func (o *ServiceGetApi200Response) SetJwksUri(v string)` + +SetJwksUri sets JwksUri field to given value. + +### HasJwksUri + +`func (o *ServiceGetApi200Response) HasJwksUri() bool` + +HasJwksUri returns a boolean if a field has been set. + +### GetDirectJwksEndpointEnabled + +`func (o *ServiceGetApi200Response) GetDirectJwksEndpointEnabled() bool` + +GetDirectJwksEndpointEnabled returns the DirectJwksEndpointEnabled field if non-nil, zero value otherwise. + +### GetDirectJwksEndpointEnabledOk + +`func (o *ServiceGetApi200Response) GetDirectJwksEndpointEnabledOk() (*bool, bool)` + +GetDirectJwksEndpointEnabledOk returns a tuple with the DirectJwksEndpointEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDirectJwksEndpointEnabled + +`func (o *ServiceGetApi200Response) SetDirectJwksEndpointEnabled(v bool)` + +SetDirectJwksEndpointEnabled sets DirectJwksEndpointEnabled field to given value. + +### HasDirectJwksEndpointEnabled + +`func (o *ServiceGetApi200Response) HasDirectJwksEndpointEnabled() bool` + +HasDirectJwksEndpointEnabled returns a boolean if a field has been set. + +### GetJwks + +`func (o *ServiceGetApi200Response) GetJwks() string` + +GetJwks returns the Jwks field if non-nil, zero value otherwise. + +### GetJwksOk + +`func (o *ServiceGetApi200Response) GetJwksOk() (*string, bool)` + +GetJwksOk returns a tuple with the Jwks field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetJwks + +`func (o *ServiceGetApi200Response) SetJwks(v string)` + +SetJwks sets Jwks field to given value. + +### HasJwks + +`func (o *ServiceGetApi200Response) HasJwks() bool` + +HasJwks returns a boolean if a field has been set. + +### GetIdTokenSignatureKeyId + +`func (o *ServiceGetApi200Response) GetIdTokenSignatureKeyId() string` + +GetIdTokenSignatureKeyId returns the IdTokenSignatureKeyId field if non-nil, zero value otherwise. + +### GetIdTokenSignatureKeyIdOk + +`func (o *ServiceGetApi200Response) GetIdTokenSignatureKeyIdOk() (*string, bool)` + +GetIdTokenSignatureKeyIdOk returns a tuple with the IdTokenSignatureKeyId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdTokenSignatureKeyId + +`func (o *ServiceGetApi200Response) SetIdTokenSignatureKeyId(v string)` + +SetIdTokenSignatureKeyId sets IdTokenSignatureKeyId field to given value. + +### HasIdTokenSignatureKeyId + +`func (o *ServiceGetApi200Response) HasIdTokenSignatureKeyId() bool` + +HasIdTokenSignatureKeyId returns a boolean if a field has been set. + +### GetUserInfoSignatureKeyId + +`func (o *ServiceGetApi200Response) GetUserInfoSignatureKeyId() string` + +GetUserInfoSignatureKeyId returns the UserInfoSignatureKeyId field if non-nil, zero value otherwise. + +### GetUserInfoSignatureKeyIdOk + +`func (o *ServiceGetApi200Response) GetUserInfoSignatureKeyIdOk() (*string, bool)` + +GetUserInfoSignatureKeyIdOk returns a tuple with the UserInfoSignatureKeyId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserInfoSignatureKeyId + +`func (o *ServiceGetApi200Response) SetUserInfoSignatureKeyId(v string)` + +SetUserInfoSignatureKeyId sets UserInfoSignatureKeyId field to given value. + +### HasUserInfoSignatureKeyId + +`func (o *ServiceGetApi200Response) HasUserInfoSignatureKeyId() bool` + +HasUserInfoSignatureKeyId returns a boolean if a field has been set. + +### GetAuthorizationSignatureKeyId + +`func (o *ServiceGetApi200Response) GetAuthorizationSignatureKeyId() string` + +GetAuthorizationSignatureKeyId returns the AuthorizationSignatureKeyId field if non-nil, zero value otherwise. + +### GetAuthorizationSignatureKeyIdOk + +`func (o *ServiceGetApi200Response) GetAuthorizationSignatureKeyIdOk() (*string, bool)` + +GetAuthorizationSignatureKeyIdOk returns a tuple with the AuthorizationSignatureKeyId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthorizationSignatureKeyId + +`func (o *ServiceGetApi200Response) SetAuthorizationSignatureKeyId(v string)` + +SetAuthorizationSignatureKeyId sets AuthorizationSignatureKeyId field to given value. + +### HasAuthorizationSignatureKeyId + +`func (o *ServiceGetApi200Response) HasAuthorizationSignatureKeyId() bool` + +HasAuthorizationSignatureKeyId returns a boolean if a field has been set. + +### GetUserInfoEndpoint + +`func (o *ServiceGetApi200Response) GetUserInfoEndpoint() string` + +GetUserInfoEndpoint returns the UserInfoEndpoint field if non-nil, zero value otherwise. + +### GetUserInfoEndpointOk + +`func (o *ServiceGetApi200Response) GetUserInfoEndpointOk() (*string, bool)` + +GetUserInfoEndpointOk returns a tuple with the UserInfoEndpoint field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserInfoEndpoint + +`func (o *ServiceGetApi200Response) SetUserInfoEndpoint(v string)` + +SetUserInfoEndpoint sets UserInfoEndpoint field to given value. + +### HasUserInfoEndpoint + +`func (o *ServiceGetApi200Response) HasUserInfoEndpoint() bool` + +HasUserInfoEndpoint returns a boolean if a field has been set. + +### GetDirectUserInfoEndpointEnabled + +`func (o *ServiceGetApi200Response) GetDirectUserInfoEndpointEnabled() bool` + +GetDirectUserInfoEndpointEnabled returns the DirectUserInfoEndpointEnabled field if non-nil, zero value otherwise. + +### GetDirectUserInfoEndpointEnabledOk + +`func (o *ServiceGetApi200Response) GetDirectUserInfoEndpointEnabledOk() (*bool, bool)` + +GetDirectUserInfoEndpointEnabledOk returns a tuple with the DirectUserInfoEndpointEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDirectUserInfoEndpointEnabled + +`func (o *ServiceGetApi200Response) SetDirectUserInfoEndpointEnabled(v bool)` + +SetDirectUserInfoEndpointEnabled sets DirectUserInfoEndpointEnabled field to given value. + +### HasDirectUserInfoEndpointEnabled + +`func (o *ServiceGetApi200Response) HasDirectUserInfoEndpointEnabled() bool` + +HasDirectUserInfoEndpointEnabled returns a boolean if a field has been set. + +### GetDynamicRegistrationSupported + +`func (o *ServiceGetApi200Response) GetDynamicRegistrationSupported() bool` + +GetDynamicRegistrationSupported returns the DynamicRegistrationSupported field if non-nil, zero value otherwise. + +### GetDynamicRegistrationSupportedOk + +`func (o *ServiceGetApi200Response) GetDynamicRegistrationSupportedOk() (*bool, bool)` + +GetDynamicRegistrationSupportedOk returns a tuple with the DynamicRegistrationSupported field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDynamicRegistrationSupported + +`func (o *ServiceGetApi200Response) SetDynamicRegistrationSupported(v bool)` + +SetDynamicRegistrationSupported sets DynamicRegistrationSupported field to given value. + +### HasDynamicRegistrationSupported + +`func (o *ServiceGetApi200Response) HasDynamicRegistrationSupported() bool` + +HasDynamicRegistrationSupported returns a boolean if a field has been set. + +### GetRegistrationEndpoint + +`func (o *ServiceGetApi200Response) GetRegistrationEndpoint() string` + +GetRegistrationEndpoint returns the RegistrationEndpoint field if non-nil, zero value otherwise. + +### GetRegistrationEndpointOk + +`func (o *ServiceGetApi200Response) GetRegistrationEndpointOk() (*string, bool)` + +GetRegistrationEndpointOk returns a tuple with the RegistrationEndpoint field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRegistrationEndpoint + +`func (o *ServiceGetApi200Response) SetRegistrationEndpoint(v string)` + +SetRegistrationEndpoint sets RegistrationEndpoint field to given value. + +### HasRegistrationEndpoint + +`func (o *ServiceGetApi200Response) HasRegistrationEndpoint() bool` + +HasRegistrationEndpoint returns a boolean if a field has been set. + +### GetRegistrationManagementEndpoint + +`func (o *ServiceGetApi200Response) GetRegistrationManagementEndpoint() string` + +GetRegistrationManagementEndpoint returns the RegistrationManagementEndpoint field if non-nil, zero value otherwise. + +### GetRegistrationManagementEndpointOk + +`func (o *ServiceGetApi200Response) GetRegistrationManagementEndpointOk() (*string, bool)` + +GetRegistrationManagementEndpointOk returns a tuple with the RegistrationManagementEndpoint field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRegistrationManagementEndpoint + +`func (o *ServiceGetApi200Response) SetRegistrationManagementEndpoint(v string)` + +SetRegistrationManagementEndpoint sets RegistrationManagementEndpoint field to given value. + +### HasRegistrationManagementEndpoint + +`func (o *ServiceGetApi200Response) HasRegistrationManagementEndpoint() bool` + +HasRegistrationManagementEndpoint returns a boolean if a field has been set. + +### GetPolicyUri + +`func (o *ServiceGetApi200Response) GetPolicyUri() string` + +GetPolicyUri returns the PolicyUri field if non-nil, zero value otherwise. + +### GetPolicyUriOk + +`func (o *ServiceGetApi200Response) GetPolicyUriOk() (*string, bool)` + +GetPolicyUriOk returns a tuple with the PolicyUri field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPolicyUri + +`func (o *ServiceGetApi200Response) SetPolicyUri(v string)` + +SetPolicyUri sets PolicyUri field to given value. + +### HasPolicyUri + +`func (o *ServiceGetApi200Response) HasPolicyUri() bool` + +HasPolicyUri returns a boolean if a field has been set. + +### GetTosUri + +`func (o *ServiceGetApi200Response) GetTosUri() string` + +GetTosUri returns the TosUri field if non-nil, zero value otherwise. + +### GetTosUriOk + +`func (o *ServiceGetApi200Response) GetTosUriOk() (*string, bool)` + +GetTosUriOk returns a tuple with the TosUri field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTosUri + +`func (o *ServiceGetApi200Response) SetTosUri(v string)` + +SetTosUri sets TosUri field to given value. + +### HasTosUri + +`func (o *ServiceGetApi200Response) HasTosUri() bool` + +HasTosUri returns a boolean if a field has been set. + +### GetServiceDocumentation + +`func (o *ServiceGetApi200Response) GetServiceDocumentation() string` + +GetServiceDocumentation returns the ServiceDocumentation field if non-nil, zero value otherwise. + +### GetServiceDocumentationOk + +`func (o *ServiceGetApi200Response) GetServiceDocumentationOk() (*string, bool)` + +GetServiceDocumentationOk returns a tuple with the ServiceDocumentation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetServiceDocumentation + +`func (o *ServiceGetApi200Response) SetServiceDocumentation(v string)` + +SetServiceDocumentation sets ServiceDocumentation field to given value. + +### HasServiceDocumentation + +`func (o *ServiceGetApi200Response) HasServiceDocumentation() bool` + +HasServiceDocumentation returns a boolean if a field has been set. + +### GetBackchannelAuthenticationEndpoint + +`func (o *ServiceGetApi200Response) GetBackchannelAuthenticationEndpoint() string` + +GetBackchannelAuthenticationEndpoint returns the BackchannelAuthenticationEndpoint field if non-nil, zero value otherwise. + +### GetBackchannelAuthenticationEndpointOk + +`func (o *ServiceGetApi200Response) GetBackchannelAuthenticationEndpointOk() (*string, bool)` + +GetBackchannelAuthenticationEndpointOk returns a tuple with the BackchannelAuthenticationEndpoint field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBackchannelAuthenticationEndpoint + +`func (o *ServiceGetApi200Response) SetBackchannelAuthenticationEndpoint(v string)` + +SetBackchannelAuthenticationEndpoint sets BackchannelAuthenticationEndpoint field to given value. + +### HasBackchannelAuthenticationEndpoint + +`func (o *ServiceGetApi200Response) HasBackchannelAuthenticationEndpoint() bool` + +HasBackchannelAuthenticationEndpoint returns a boolean if a field has been set. + +### GetSupportedBackchannelTokenDeliveryModes + +`func (o *ServiceGetApi200Response) GetSupportedBackchannelTokenDeliveryModes() []DeliveryMode` + +GetSupportedBackchannelTokenDeliveryModes returns the SupportedBackchannelTokenDeliveryModes field if non-nil, zero value otherwise. + +### GetSupportedBackchannelTokenDeliveryModesOk + +`func (o *ServiceGetApi200Response) GetSupportedBackchannelTokenDeliveryModesOk() (*[]DeliveryMode, bool)` + +GetSupportedBackchannelTokenDeliveryModesOk returns a tuple with the SupportedBackchannelTokenDeliveryModes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSupportedBackchannelTokenDeliveryModes + +`func (o *ServiceGetApi200Response) SetSupportedBackchannelTokenDeliveryModes(v []DeliveryMode)` + +SetSupportedBackchannelTokenDeliveryModes sets SupportedBackchannelTokenDeliveryModes field to given value. + +### HasSupportedBackchannelTokenDeliveryModes + +`func (o *ServiceGetApi200Response) HasSupportedBackchannelTokenDeliveryModes() bool` + +HasSupportedBackchannelTokenDeliveryModes returns a boolean if a field has been set. + +### GetBackchannelAuthReqIdDuration + +`func (o *ServiceGetApi200Response) GetBackchannelAuthReqIdDuration() int32` + +GetBackchannelAuthReqIdDuration returns the BackchannelAuthReqIdDuration field if non-nil, zero value otherwise. + +### GetBackchannelAuthReqIdDurationOk + +`func (o *ServiceGetApi200Response) GetBackchannelAuthReqIdDurationOk() (*int32, bool)` + +GetBackchannelAuthReqIdDurationOk returns a tuple with the BackchannelAuthReqIdDuration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBackchannelAuthReqIdDuration + +`func (o *ServiceGetApi200Response) SetBackchannelAuthReqIdDuration(v int32)` + +SetBackchannelAuthReqIdDuration sets BackchannelAuthReqIdDuration field to given value. + +### HasBackchannelAuthReqIdDuration + +`func (o *ServiceGetApi200Response) HasBackchannelAuthReqIdDuration() bool` + +HasBackchannelAuthReqIdDuration returns a boolean if a field has been set. + +### GetBackchannelPollingInterval + +`func (o *ServiceGetApi200Response) GetBackchannelPollingInterval() int32` + +GetBackchannelPollingInterval returns the BackchannelPollingInterval field if non-nil, zero value otherwise. + +### GetBackchannelPollingIntervalOk + +`func (o *ServiceGetApi200Response) GetBackchannelPollingIntervalOk() (*int32, bool)` + +GetBackchannelPollingIntervalOk returns a tuple with the BackchannelPollingInterval field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBackchannelPollingInterval + +`func (o *ServiceGetApi200Response) SetBackchannelPollingInterval(v int32)` + +SetBackchannelPollingInterval sets BackchannelPollingInterval field to given value. + +### HasBackchannelPollingInterval + +`func (o *ServiceGetApi200Response) HasBackchannelPollingInterval() bool` + +HasBackchannelPollingInterval returns a boolean if a field has been set. + +### GetBackchannelUserCodeParameterSupported + +`func (o *ServiceGetApi200Response) GetBackchannelUserCodeParameterSupported() bool` + +GetBackchannelUserCodeParameterSupported returns the BackchannelUserCodeParameterSupported field if non-nil, zero value otherwise. + +### GetBackchannelUserCodeParameterSupportedOk + +`func (o *ServiceGetApi200Response) GetBackchannelUserCodeParameterSupportedOk() (*bool, bool)` + +GetBackchannelUserCodeParameterSupportedOk returns a tuple with the BackchannelUserCodeParameterSupported field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBackchannelUserCodeParameterSupported + +`func (o *ServiceGetApi200Response) SetBackchannelUserCodeParameterSupported(v bool)` + +SetBackchannelUserCodeParameterSupported sets BackchannelUserCodeParameterSupported field to given value. + +### HasBackchannelUserCodeParameterSupported + +`func (o *ServiceGetApi200Response) HasBackchannelUserCodeParameterSupported() bool` + +HasBackchannelUserCodeParameterSupported returns a boolean if a field has been set. + +### GetBackchannelBindingMessageRequiredInFapi + +`func (o *ServiceGetApi200Response) GetBackchannelBindingMessageRequiredInFapi() bool` + +GetBackchannelBindingMessageRequiredInFapi returns the BackchannelBindingMessageRequiredInFapi field if non-nil, zero value otherwise. + +### GetBackchannelBindingMessageRequiredInFapiOk + +`func (o *ServiceGetApi200Response) GetBackchannelBindingMessageRequiredInFapiOk() (*bool, bool)` + +GetBackchannelBindingMessageRequiredInFapiOk returns a tuple with the BackchannelBindingMessageRequiredInFapi field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBackchannelBindingMessageRequiredInFapi + +`func (o *ServiceGetApi200Response) SetBackchannelBindingMessageRequiredInFapi(v bool)` + +SetBackchannelBindingMessageRequiredInFapi sets BackchannelBindingMessageRequiredInFapi field to given value. + +### HasBackchannelBindingMessageRequiredInFapi + +`func (o *ServiceGetApi200Response) HasBackchannelBindingMessageRequiredInFapi() bool` + +HasBackchannelBindingMessageRequiredInFapi returns a boolean if a field has been set. + +### GetDeviceAuthorizationEndpoint + +`func (o *ServiceGetApi200Response) GetDeviceAuthorizationEndpoint() string` + +GetDeviceAuthorizationEndpoint returns the DeviceAuthorizationEndpoint field if non-nil, zero value otherwise. + +### GetDeviceAuthorizationEndpointOk + +`func (o *ServiceGetApi200Response) GetDeviceAuthorizationEndpointOk() (*string, bool)` + +GetDeviceAuthorizationEndpointOk returns a tuple with the DeviceAuthorizationEndpoint field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeviceAuthorizationEndpoint + +`func (o *ServiceGetApi200Response) SetDeviceAuthorizationEndpoint(v string)` + +SetDeviceAuthorizationEndpoint sets DeviceAuthorizationEndpoint field to given value. + +### HasDeviceAuthorizationEndpoint + +`func (o *ServiceGetApi200Response) HasDeviceAuthorizationEndpoint() bool` + +HasDeviceAuthorizationEndpoint returns a boolean if a field has been set. + +### GetDeviceVerificationUri + +`func (o *ServiceGetApi200Response) GetDeviceVerificationUri() string` + +GetDeviceVerificationUri returns the DeviceVerificationUri field if non-nil, zero value otherwise. + +### GetDeviceVerificationUriOk + +`func (o *ServiceGetApi200Response) GetDeviceVerificationUriOk() (*string, bool)` + +GetDeviceVerificationUriOk returns a tuple with the DeviceVerificationUri field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeviceVerificationUri + +`func (o *ServiceGetApi200Response) SetDeviceVerificationUri(v string)` + +SetDeviceVerificationUri sets DeviceVerificationUri field to given value. + +### HasDeviceVerificationUri + +`func (o *ServiceGetApi200Response) HasDeviceVerificationUri() bool` + +HasDeviceVerificationUri returns a boolean if a field has been set. + +### GetDeviceVerificationUriComplete + +`func (o *ServiceGetApi200Response) GetDeviceVerificationUriComplete() string` + +GetDeviceVerificationUriComplete returns the DeviceVerificationUriComplete field if non-nil, zero value otherwise. + +### GetDeviceVerificationUriCompleteOk + +`func (o *ServiceGetApi200Response) GetDeviceVerificationUriCompleteOk() (*string, bool)` + +GetDeviceVerificationUriCompleteOk returns a tuple with the DeviceVerificationUriComplete field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeviceVerificationUriComplete + +`func (o *ServiceGetApi200Response) SetDeviceVerificationUriComplete(v string)` + +SetDeviceVerificationUriComplete sets DeviceVerificationUriComplete field to given value. + +### HasDeviceVerificationUriComplete + +`func (o *ServiceGetApi200Response) HasDeviceVerificationUriComplete() bool` + +HasDeviceVerificationUriComplete returns a boolean if a field has been set. + +### GetDeviceFlowCodeDuration + +`func (o *ServiceGetApi200Response) GetDeviceFlowCodeDuration() int32` + +GetDeviceFlowCodeDuration returns the DeviceFlowCodeDuration field if non-nil, zero value otherwise. + +### GetDeviceFlowCodeDurationOk + +`func (o *ServiceGetApi200Response) GetDeviceFlowCodeDurationOk() (*int32, bool)` + +GetDeviceFlowCodeDurationOk returns a tuple with the DeviceFlowCodeDuration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeviceFlowCodeDuration + +`func (o *ServiceGetApi200Response) SetDeviceFlowCodeDuration(v int32)` + +SetDeviceFlowCodeDuration sets DeviceFlowCodeDuration field to given value. + +### HasDeviceFlowCodeDuration + +`func (o *ServiceGetApi200Response) HasDeviceFlowCodeDuration() bool` + +HasDeviceFlowCodeDuration returns a boolean if a field has been set. + +### GetDeviceFlowPollingInterval + +`func (o *ServiceGetApi200Response) GetDeviceFlowPollingInterval() int32` + +GetDeviceFlowPollingInterval returns the DeviceFlowPollingInterval field if non-nil, zero value otherwise. + +### GetDeviceFlowPollingIntervalOk + +`func (o *ServiceGetApi200Response) GetDeviceFlowPollingIntervalOk() (*int32, bool)` + +GetDeviceFlowPollingIntervalOk returns a tuple with the DeviceFlowPollingInterval field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeviceFlowPollingInterval + +`func (o *ServiceGetApi200Response) SetDeviceFlowPollingInterval(v int32)` + +SetDeviceFlowPollingInterval sets DeviceFlowPollingInterval field to given value. + +### HasDeviceFlowPollingInterval + +`func (o *ServiceGetApi200Response) HasDeviceFlowPollingInterval() bool` + +HasDeviceFlowPollingInterval returns a boolean if a field has been set. + +### GetUserCodeCharset + +`func (o *ServiceGetApi200Response) GetUserCodeCharset() UserCodeCharset` + +GetUserCodeCharset returns the UserCodeCharset field if non-nil, zero value otherwise. + +### GetUserCodeCharsetOk + +`func (o *ServiceGetApi200Response) GetUserCodeCharsetOk() (*UserCodeCharset, bool)` + +GetUserCodeCharsetOk returns a tuple with the UserCodeCharset field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserCodeCharset + +`func (o *ServiceGetApi200Response) SetUserCodeCharset(v UserCodeCharset)` + +SetUserCodeCharset sets UserCodeCharset field to given value. + +### HasUserCodeCharset + +`func (o *ServiceGetApi200Response) HasUserCodeCharset() bool` + +HasUserCodeCharset returns a boolean if a field has been set. + +### GetUserCodeLength + +`func (o *ServiceGetApi200Response) GetUserCodeLength() int32` + +GetUserCodeLength returns the UserCodeLength field if non-nil, zero value otherwise. + +### GetUserCodeLengthOk + +`func (o *ServiceGetApi200Response) GetUserCodeLengthOk() (*int32, bool)` + +GetUserCodeLengthOk returns a tuple with the UserCodeLength field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserCodeLength + +`func (o *ServiceGetApi200Response) SetUserCodeLength(v int32)` + +SetUserCodeLength sets UserCodeLength field to given value. + +### HasUserCodeLength + +`func (o *ServiceGetApi200Response) HasUserCodeLength() bool` + +HasUserCodeLength returns a boolean if a field has been set. + +### GetSupportedTrustFrameworks + +`func (o *ServiceGetApi200Response) GetSupportedTrustFrameworks() []string` + +GetSupportedTrustFrameworks returns the SupportedTrustFrameworks field if non-nil, zero value otherwise. + +### GetSupportedTrustFrameworksOk + +`func (o *ServiceGetApi200Response) GetSupportedTrustFrameworksOk() (*[]string, bool)` + +GetSupportedTrustFrameworksOk returns a tuple with the SupportedTrustFrameworks field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSupportedTrustFrameworks + +`func (o *ServiceGetApi200Response) SetSupportedTrustFrameworks(v []string)` + +SetSupportedTrustFrameworks sets SupportedTrustFrameworks field to given value. + +### HasSupportedTrustFrameworks + +`func (o *ServiceGetApi200Response) HasSupportedTrustFrameworks() bool` + +HasSupportedTrustFrameworks returns a boolean if a field has been set. + +### GetSupportedEvidence + +`func (o *ServiceGetApi200Response) GetSupportedEvidence() []string` + +GetSupportedEvidence returns the SupportedEvidence field if non-nil, zero value otherwise. + +### GetSupportedEvidenceOk + +`func (o *ServiceGetApi200Response) GetSupportedEvidenceOk() (*[]string, bool)` + +GetSupportedEvidenceOk returns a tuple with the SupportedEvidence field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSupportedEvidence + +`func (o *ServiceGetApi200Response) SetSupportedEvidence(v []string)` + +SetSupportedEvidence sets SupportedEvidence field to given value. + +### HasSupportedEvidence + +`func (o *ServiceGetApi200Response) HasSupportedEvidence() bool` + +HasSupportedEvidence returns a boolean if a field has been set. + +### GetSupportedIdentityDocuments + +`func (o *ServiceGetApi200Response) GetSupportedIdentityDocuments() []string` + +GetSupportedIdentityDocuments returns the SupportedIdentityDocuments field if non-nil, zero value otherwise. + +### GetSupportedIdentityDocumentsOk + +`func (o *ServiceGetApi200Response) GetSupportedIdentityDocumentsOk() (*[]string, bool)` + +GetSupportedIdentityDocumentsOk returns a tuple with the SupportedIdentityDocuments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSupportedIdentityDocuments + +`func (o *ServiceGetApi200Response) SetSupportedIdentityDocuments(v []string)` + +SetSupportedIdentityDocuments sets SupportedIdentityDocuments field to given value. + +### HasSupportedIdentityDocuments + +`func (o *ServiceGetApi200Response) HasSupportedIdentityDocuments() bool` + +HasSupportedIdentityDocuments returns a boolean if a field has been set. + +### GetSupportedVerificationMethods + +`func (o *ServiceGetApi200Response) GetSupportedVerificationMethods() []string` + +GetSupportedVerificationMethods returns the SupportedVerificationMethods field if non-nil, zero value otherwise. + +### GetSupportedVerificationMethodsOk + +`func (o *ServiceGetApi200Response) GetSupportedVerificationMethodsOk() (*[]string, bool)` + +GetSupportedVerificationMethodsOk returns a tuple with the SupportedVerificationMethods field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSupportedVerificationMethods + +`func (o *ServiceGetApi200Response) SetSupportedVerificationMethods(v []string)` + +SetSupportedVerificationMethods sets SupportedVerificationMethods field to given value. + +### HasSupportedVerificationMethods + +`func (o *ServiceGetApi200Response) HasSupportedVerificationMethods() bool` + +HasSupportedVerificationMethods returns a boolean if a field has been set. + +### GetSupportedVerifiedClaims + +`func (o *ServiceGetApi200Response) GetSupportedVerifiedClaims() []string` + +GetSupportedVerifiedClaims returns the SupportedVerifiedClaims field if non-nil, zero value otherwise. + +### GetSupportedVerifiedClaimsOk + +`func (o *ServiceGetApi200Response) GetSupportedVerifiedClaimsOk() (*[]string, bool)` + +GetSupportedVerifiedClaimsOk returns a tuple with the SupportedVerifiedClaims field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSupportedVerifiedClaims + +`func (o *ServiceGetApi200Response) SetSupportedVerifiedClaims(v []string)` + +SetSupportedVerifiedClaims sets SupportedVerifiedClaims field to given value. + +### HasSupportedVerifiedClaims + +`func (o *ServiceGetApi200Response) HasSupportedVerifiedClaims() bool` + +HasSupportedVerifiedClaims returns a boolean if a field has been set. + +### GetVerifiedClaimsValidationSchemaSet + +`func (o *ServiceGetApi200Response) GetVerifiedClaimsValidationSchemaSet() VerifiedClaimsValidationSchema` + +GetVerifiedClaimsValidationSchemaSet returns the VerifiedClaimsValidationSchemaSet field if non-nil, zero value otherwise. + +### GetVerifiedClaimsValidationSchemaSetOk + +`func (o *ServiceGetApi200Response) GetVerifiedClaimsValidationSchemaSetOk() (*VerifiedClaimsValidationSchema, bool)` + +GetVerifiedClaimsValidationSchemaSetOk returns a tuple with the VerifiedClaimsValidationSchemaSet field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVerifiedClaimsValidationSchemaSet + +`func (o *ServiceGetApi200Response) SetVerifiedClaimsValidationSchemaSet(v VerifiedClaimsValidationSchema)` + +SetVerifiedClaimsValidationSchemaSet sets VerifiedClaimsValidationSchemaSet field to given value. + +### HasVerifiedClaimsValidationSchemaSet + +`func (o *ServiceGetApi200Response) HasVerifiedClaimsValidationSchemaSet() bool` + +HasVerifiedClaimsValidationSchemaSet returns a boolean if a field has been set. + +### SetVerifiedClaimsValidationSchemaSetNil + +`func (o *ServiceGetApi200Response) SetVerifiedClaimsValidationSchemaSetNil(b bool)` + + SetVerifiedClaimsValidationSchemaSetNil sets the value for VerifiedClaimsValidationSchemaSet to be an explicit nil + +### UnsetVerifiedClaimsValidationSchemaSet +`func (o *ServiceGetApi200Response) UnsetVerifiedClaimsValidationSchemaSet()` + +UnsetVerifiedClaimsValidationSchemaSet ensures that no value is present for VerifiedClaimsValidationSchemaSet, not even an explicit nil +### GetAttributes + +`func (o *ServiceGetApi200Response) GetAttributes() []Pair` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *ServiceGetApi200Response) GetAttributesOk() (*[]Pair, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *ServiceGetApi200Response) SetAttributes(v []Pair)` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *ServiceGetApi200Response) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetNbfOptional + +`func (o *ServiceGetApi200Response) GetNbfOptional() bool` + +GetNbfOptional returns the NbfOptional field if non-nil, zero value otherwise. + +### GetNbfOptionalOk + +`func (o *ServiceGetApi200Response) GetNbfOptionalOk() (*bool, bool)` + +GetNbfOptionalOk returns a tuple with the NbfOptional field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNbfOptional + +`func (o *ServiceGetApi200Response) SetNbfOptional(v bool)` + +SetNbfOptional sets NbfOptional field to given value. + +### HasNbfOptional + +`func (o *ServiceGetApi200Response) HasNbfOptional() bool` + +HasNbfOptional returns a boolean if a field has been set. + +### GetIssSuppressed + +`func (o *ServiceGetApi200Response) GetIssSuppressed() bool` + +GetIssSuppressed returns the IssSuppressed field if non-nil, zero value otherwise. + +### GetIssSuppressedOk + +`func (o *ServiceGetApi200Response) GetIssSuppressedOk() (*bool, bool)` + +GetIssSuppressedOk returns a tuple with the IssSuppressed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIssSuppressed + +`func (o *ServiceGetApi200Response) SetIssSuppressed(v bool)` + +SetIssSuppressed sets IssSuppressed field to given value. + +### HasIssSuppressed + +`func (o *ServiceGetApi200Response) HasIssSuppressed() bool` + +HasIssSuppressed returns a boolean if a field has been set. + +### GetSupportedCustomClientMetadata + +`func (o *ServiceGetApi200Response) GetSupportedCustomClientMetadata() []string` + +GetSupportedCustomClientMetadata returns the SupportedCustomClientMetadata field if non-nil, zero value otherwise. + +### GetSupportedCustomClientMetadataOk + +`func (o *ServiceGetApi200Response) GetSupportedCustomClientMetadataOk() (*[]string, bool)` + +GetSupportedCustomClientMetadataOk returns a tuple with the SupportedCustomClientMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSupportedCustomClientMetadata + +`func (o *ServiceGetApi200Response) SetSupportedCustomClientMetadata(v []string)` + +SetSupportedCustomClientMetadata sets SupportedCustomClientMetadata field to given value. + +### HasSupportedCustomClientMetadata + +`func (o *ServiceGetApi200Response) HasSupportedCustomClientMetadata() bool` + +HasSupportedCustomClientMetadata returns a boolean if a field has been set. + +### GetTokenExpirationLinked + +`func (o *ServiceGetApi200Response) GetTokenExpirationLinked() bool` + +GetTokenExpirationLinked returns the TokenExpirationLinked field if non-nil, zero value otherwise. + +### GetTokenExpirationLinkedOk + +`func (o *ServiceGetApi200Response) GetTokenExpirationLinkedOk() (*bool, bool)` + +GetTokenExpirationLinkedOk returns a tuple with the TokenExpirationLinked field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTokenExpirationLinked + +`func (o *ServiceGetApi200Response) SetTokenExpirationLinked(v bool)` + +SetTokenExpirationLinked sets TokenExpirationLinked field to given value. + +### HasTokenExpirationLinked + +`func (o *ServiceGetApi200Response) HasTokenExpirationLinked() bool` + +HasTokenExpirationLinked returns a boolean if a field has been set. + +### GetFrontChannelRequestObjectEncryptionRequired + +`func (o *ServiceGetApi200Response) GetFrontChannelRequestObjectEncryptionRequired() bool` + +GetFrontChannelRequestObjectEncryptionRequired returns the FrontChannelRequestObjectEncryptionRequired field if non-nil, zero value otherwise. + +### GetFrontChannelRequestObjectEncryptionRequiredOk + +`func (o *ServiceGetApi200Response) GetFrontChannelRequestObjectEncryptionRequiredOk() (*bool, bool)` + +GetFrontChannelRequestObjectEncryptionRequiredOk returns a tuple with the FrontChannelRequestObjectEncryptionRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFrontChannelRequestObjectEncryptionRequired + +`func (o *ServiceGetApi200Response) SetFrontChannelRequestObjectEncryptionRequired(v bool)` + +SetFrontChannelRequestObjectEncryptionRequired sets FrontChannelRequestObjectEncryptionRequired field to given value. + +### HasFrontChannelRequestObjectEncryptionRequired + +`func (o *ServiceGetApi200Response) HasFrontChannelRequestObjectEncryptionRequired() bool` + +HasFrontChannelRequestObjectEncryptionRequired returns a boolean if a field has been set. + +### GetRequestObjectEncryptionAlgMatchRequired + +`func (o *ServiceGetApi200Response) GetRequestObjectEncryptionAlgMatchRequired() bool` + +GetRequestObjectEncryptionAlgMatchRequired returns the RequestObjectEncryptionAlgMatchRequired field if non-nil, zero value otherwise. + +### GetRequestObjectEncryptionAlgMatchRequiredOk + +`func (o *ServiceGetApi200Response) GetRequestObjectEncryptionAlgMatchRequiredOk() (*bool, bool)` + +GetRequestObjectEncryptionAlgMatchRequiredOk returns a tuple with the RequestObjectEncryptionAlgMatchRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestObjectEncryptionAlgMatchRequired + +`func (o *ServiceGetApi200Response) SetRequestObjectEncryptionAlgMatchRequired(v bool)` + +SetRequestObjectEncryptionAlgMatchRequired sets RequestObjectEncryptionAlgMatchRequired field to given value. + +### HasRequestObjectEncryptionAlgMatchRequired + +`func (o *ServiceGetApi200Response) HasRequestObjectEncryptionAlgMatchRequired() bool` + +HasRequestObjectEncryptionAlgMatchRequired returns a boolean if a field has been set. + +### GetRequestObjectEncryptionEncMatchRequired + +`func (o *ServiceGetApi200Response) GetRequestObjectEncryptionEncMatchRequired() bool` + +GetRequestObjectEncryptionEncMatchRequired returns the RequestObjectEncryptionEncMatchRequired field if non-nil, zero value otherwise. + +### GetRequestObjectEncryptionEncMatchRequiredOk + +`func (o *ServiceGetApi200Response) GetRequestObjectEncryptionEncMatchRequiredOk() (*bool, bool)` + +GetRequestObjectEncryptionEncMatchRequiredOk returns a tuple with the RequestObjectEncryptionEncMatchRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestObjectEncryptionEncMatchRequired + +`func (o *ServiceGetApi200Response) SetRequestObjectEncryptionEncMatchRequired(v bool)` + +SetRequestObjectEncryptionEncMatchRequired sets RequestObjectEncryptionEncMatchRequired field to given value. + +### HasRequestObjectEncryptionEncMatchRequired + +`func (o *ServiceGetApi200Response) HasRequestObjectEncryptionEncMatchRequired() bool` + +HasRequestObjectEncryptionEncMatchRequired returns a boolean if a field has been set. + +### GetHsmEnabled + +`func (o *ServiceGetApi200Response) GetHsmEnabled() bool` + +GetHsmEnabled returns the HsmEnabled field if non-nil, zero value otherwise. + +### GetHsmEnabledOk + +`func (o *ServiceGetApi200Response) GetHsmEnabledOk() (*bool, bool)` + +GetHsmEnabledOk returns a tuple with the HsmEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHsmEnabled + +`func (o *ServiceGetApi200Response) SetHsmEnabled(v bool)` + +SetHsmEnabled sets HsmEnabled field to given value. + +### HasHsmEnabled + +`func (o *ServiceGetApi200Response) HasHsmEnabled() bool` + +HasHsmEnabled returns a boolean if a field has been set. + +### GetHsks + +`func (o *ServiceGetApi200Response) GetHsks() []Hsk` + +GetHsks returns the Hsks field if non-nil, zero value otherwise. + +### GetHsksOk + +`func (o *ServiceGetApi200Response) GetHsksOk() (*[]Hsk, bool)` + +GetHsksOk returns a tuple with the Hsks field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHsks + +`func (o *ServiceGetApi200Response) SetHsks(v []Hsk)` + +SetHsks sets Hsks field to given value. + +### HasHsks + +`func (o *ServiceGetApi200Response) HasHsks() bool` + +HasHsks returns a boolean if a field has been set. + +### GetGrantManagementEndpoint + +`func (o *ServiceGetApi200Response) GetGrantManagementEndpoint() string` + +GetGrantManagementEndpoint returns the GrantManagementEndpoint field if non-nil, zero value otherwise. + +### GetGrantManagementEndpointOk + +`func (o *ServiceGetApi200Response) GetGrantManagementEndpointOk() (*string, bool)` + +GetGrantManagementEndpointOk returns a tuple with the GrantManagementEndpoint field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGrantManagementEndpoint + +`func (o *ServiceGetApi200Response) SetGrantManagementEndpoint(v string)` + +SetGrantManagementEndpoint sets GrantManagementEndpoint field to given value. + +### HasGrantManagementEndpoint + +`func (o *ServiceGetApi200Response) HasGrantManagementEndpoint() bool` + +HasGrantManagementEndpoint returns a boolean if a field has been set. + +### GetGrantManagementActionRequired + +`func (o *ServiceGetApi200Response) GetGrantManagementActionRequired() bool` + +GetGrantManagementActionRequired returns the GrantManagementActionRequired field if non-nil, zero value otherwise. + +### GetGrantManagementActionRequiredOk + +`func (o *ServiceGetApi200Response) GetGrantManagementActionRequiredOk() (*bool, bool)` + +GetGrantManagementActionRequiredOk returns a tuple with the GrantManagementActionRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGrantManagementActionRequired + +`func (o *ServiceGetApi200Response) SetGrantManagementActionRequired(v bool)` + +SetGrantManagementActionRequired sets GrantManagementActionRequired field to given value. + +### HasGrantManagementActionRequired + +`func (o *ServiceGetApi200Response) HasGrantManagementActionRequired() bool` + +HasGrantManagementActionRequired returns a boolean if a field has been set. + +### GetUnauthorizedOnClientConfigSupported + +`func (o *ServiceGetApi200Response) GetUnauthorizedOnClientConfigSupported() bool` + +GetUnauthorizedOnClientConfigSupported returns the UnauthorizedOnClientConfigSupported field if non-nil, zero value otherwise. + +### GetUnauthorizedOnClientConfigSupportedOk + +`func (o *ServiceGetApi200Response) GetUnauthorizedOnClientConfigSupportedOk() (*bool, bool)` + +GetUnauthorizedOnClientConfigSupportedOk returns a tuple with the UnauthorizedOnClientConfigSupported field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUnauthorizedOnClientConfigSupported + +`func (o *ServiceGetApi200Response) SetUnauthorizedOnClientConfigSupported(v bool)` + +SetUnauthorizedOnClientConfigSupported sets UnauthorizedOnClientConfigSupported field to given value. + +### HasUnauthorizedOnClientConfigSupported + +`func (o *ServiceGetApi200Response) HasUnauthorizedOnClientConfigSupported() bool` + +HasUnauthorizedOnClientConfigSupported returns a boolean if a field has been set. + +### GetDcrScopeUsedAsRequestable + +`func (o *ServiceGetApi200Response) GetDcrScopeUsedAsRequestable() bool` + +GetDcrScopeUsedAsRequestable returns the DcrScopeUsedAsRequestable field if non-nil, zero value otherwise. + +### GetDcrScopeUsedAsRequestableOk + +`func (o *ServiceGetApi200Response) GetDcrScopeUsedAsRequestableOk() (*bool, bool)` + +GetDcrScopeUsedAsRequestableOk returns a tuple with the DcrScopeUsedAsRequestable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDcrScopeUsedAsRequestable + +`func (o *ServiceGetApi200Response) SetDcrScopeUsedAsRequestable(v bool)` + +SetDcrScopeUsedAsRequestable sets DcrScopeUsedAsRequestable field to given value. + +### HasDcrScopeUsedAsRequestable + +`func (o *ServiceGetApi200Response) HasDcrScopeUsedAsRequestable() bool` + +HasDcrScopeUsedAsRequestable returns a boolean if a field has been set. + +### GetEndSessionEndpoint + +`func (o *ServiceGetApi200Response) GetEndSessionEndpoint() string` + +GetEndSessionEndpoint returns the EndSessionEndpoint field if non-nil, zero value otherwise. + +### GetEndSessionEndpointOk + +`func (o *ServiceGetApi200Response) GetEndSessionEndpointOk() (*string, bool)` + +GetEndSessionEndpointOk returns a tuple with the EndSessionEndpoint field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndSessionEndpoint + +`func (o *ServiceGetApi200Response) SetEndSessionEndpoint(v string)` + +SetEndSessionEndpoint sets EndSessionEndpoint field to given value. + +### HasEndSessionEndpoint + +`func (o *ServiceGetApi200Response) HasEndSessionEndpoint() bool` + +HasEndSessionEndpoint returns a boolean if a field has been set. + +### GetLoopbackRedirectionUriVariable + +`func (o *ServiceGetApi200Response) GetLoopbackRedirectionUriVariable() bool` + +GetLoopbackRedirectionUriVariable returns the LoopbackRedirectionUriVariable field if non-nil, zero value otherwise. + +### GetLoopbackRedirectionUriVariableOk + +`func (o *ServiceGetApi200Response) GetLoopbackRedirectionUriVariableOk() (*bool, bool)` + +GetLoopbackRedirectionUriVariableOk returns a tuple with the LoopbackRedirectionUriVariable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLoopbackRedirectionUriVariable + +`func (o *ServiceGetApi200Response) SetLoopbackRedirectionUriVariable(v bool)` + +SetLoopbackRedirectionUriVariable sets LoopbackRedirectionUriVariable field to given value. + +### HasLoopbackRedirectionUriVariable + +`func (o *ServiceGetApi200Response) HasLoopbackRedirectionUriVariable() bool` + +HasLoopbackRedirectionUriVariable returns a boolean if a field has been set. + +### GetRequestObjectAudienceChecked + +`func (o *ServiceGetApi200Response) GetRequestObjectAudienceChecked() bool` + +GetRequestObjectAudienceChecked returns the RequestObjectAudienceChecked field if non-nil, zero value otherwise. + +### GetRequestObjectAudienceCheckedOk + +`func (o *ServiceGetApi200Response) GetRequestObjectAudienceCheckedOk() (*bool, bool)` + +GetRequestObjectAudienceCheckedOk returns a tuple with the RequestObjectAudienceChecked field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestObjectAudienceChecked + +`func (o *ServiceGetApi200Response) SetRequestObjectAudienceChecked(v bool)` + +SetRequestObjectAudienceChecked sets RequestObjectAudienceChecked field to given value. + +### HasRequestObjectAudienceChecked + +`func (o *ServiceGetApi200Response) HasRequestObjectAudienceChecked() bool` + +HasRequestObjectAudienceChecked returns a boolean if a field has been set. + +### GetAccessTokenForExternalAttachmentEmbedded + +`func (o *ServiceGetApi200Response) GetAccessTokenForExternalAttachmentEmbedded() bool` + +GetAccessTokenForExternalAttachmentEmbedded returns the AccessTokenForExternalAttachmentEmbedded field if non-nil, zero value otherwise. + +### GetAccessTokenForExternalAttachmentEmbeddedOk + +`func (o *ServiceGetApi200Response) GetAccessTokenForExternalAttachmentEmbeddedOk() (*bool, bool)` + +GetAccessTokenForExternalAttachmentEmbeddedOk returns a tuple with the AccessTokenForExternalAttachmentEmbedded field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessTokenForExternalAttachmentEmbedded + +`func (o *ServiceGetApi200Response) SetAccessTokenForExternalAttachmentEmbedded(v bool)` + +SetAccessTokenForExternalAttachmentEmbedded sets AccessTokenForExternalAttachmentEmbedded field to given value. + +### HasAccessTokenForExternalAttachmentEmbedded + +`func (o *ServiceGetApi200Response) HasAccessTokenForExternalAttachmentEmbedded() bool` + +HasAccessTokenForExternalAttachmentEmbedded returns a boolean if a field has been set. + +### GetAuthorityHints + +`func (o *ServiceGetApi200Response) GetAuthorityHints() []string` + +GetAuthorityHints returns the AuthorityHints field if non-nil, zero value otherwise. + +### GetAuthorityHintsOk + +`func (o *ServiceGetApi200Response) GetAuthorityHintsOk() (*[]string, bool)` + +GetAuthorityHintsOk returns a tuple with the AuthorityHints field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthorityHints + +`func (o *ServiceGetApi200Response) SetAuthorityHints(v []string)` + +SetAuthorityHints sets AuthorityHints field to given value. + +### HasAuthorityHints + +`func (o *ServiceGetApi200Response) HasAuthorityHints() bool` + +HasAuthorityHints returns a boolean if a field has been set. + +### GetFederationEnabled + +`func (o *ServiceGetApi200Response) GetFederationEnabled() bool` + +GetFederationEnabled returns the FederationEnabled field if non-nil, zero value otherwise. + +### GetFederationEnabledOk + +`func (o *ServiceGetApi200Response) GetFederationEnabledOk() (*bool, bool)` + +GetFederationEnabledOk returns a tuple with the FederationEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFederationEnabled + +`func (o *ServiceGetApi200Response) SetFederationEnabled(v bool)` + +SetFederationEnabled sets FederationEnabled field to given value. + +### HasFederationEnabled + +`func (o *ServiceGetApi200Response) HasFederationEnabled() bool` + +HasFederationEnabled returns a boolean if a field has been set. + +### GetFederationJwks + +`func (o *ServiceGetApi200Response) GetFederationJwks() string` + +GetFederationJwks returns the FederationJwks field if non-nil, zero value otherwise. + +### GetFederationJwksOk + +`func (o *ServiceGetApi200Response) GetFederationJwksOk() (*string, bool)` + +GetFederationJwksOk returns a tuple with the FederationJwks field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFederationJwks + +`func (o *ServiceGetApi200Response) SetFederationJwks(v string)` + +SetFederationJwks sets FederationJwks field to given value. + +### HasFederationJwks + +`func (o *ServiceGetApi200Response) HasFederationJwks() bool` + +HasFederationJwks returns a boolean if a field has been set. + +### GetFederationSignatureKeyId + +`func (o *ServiceGetApi200Response) GetFederationSignatureKeyId() string` + +GetFederationSignatureKeyId returns the FederationSignatureKeyId field if non-nil, zero value otherwise. + +### GetFederationSignatureKeyIdOk + +`func (o *ServiceGetApi200Response) GetFederationSignatureKeyIdOk() (*string, bool)` + +GetFederationSignatureKeyIdOk returns a tuple with the FederationSignatureKeyId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFederationSignatureKeyId + +`func (o *ServiceGetApi200Response) SetFederationSignatureKeyId(v string)` + +SetFederationSignatureKeyId sets FederationSignatureKeyId field to given value. + +### HasFederationSignatureKeyId + +`func (o *ServiceGetApi200Response) HasFederationSignatureKeyId() bool` + +HasFederationSignatureKeyId returns a boolean if a field has been set. + +### GetFederationConfigurationDuration + +`func (o *ServiceGetApi200Response) GetFederationConfigurationDuration() int32` + +GetFederationConfigurationDuration returns the FederationConfigurationDuration field if non-nil, zero value otherwise. + +### GetFederationConfigurationDurationOk + +`func (o *ServiceGetApi200Response) GetFederationConfigurationDurationOk() (*int32, bool)` + +GetFederationConfigurationDurationOk returns a tuple with the FederationConfigurationDuration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFederationConfigurationDuration + +`func (o *ServiceGetApi200Response) SetFederationConfigurationDuration(v int32)` + +SetFederationConfigurationDuration sets FederationConfigurationDuration field to given value. + +### HasFederationConfigurationDuration + +`func (o *ServiceGetApi200Response) HasFederationConfigurationDuration() bool` + +HasFederationConfigurationDuration returns a boolean if a field has been set. + +### GetFederationRegistrationEndpoint + +`func (o *ServiceGetApi200Response) GetFederationRegistrationEndpoint() string` + +GetFederationRegistrationEndpoint returns the FederationRegistrationEndpoint field if non-nil, zero value otherwise. + +### GetFederationRegistrationEndpointOk + +`func (o *ServiceGetApi200Response) GetFederationRegistrationEndpointOk() (*string, bool)` + +GetFederationRegistrationEndpointOk returns a tuple with the FederationRegistrationEndpoint field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFederationRegistrationEndpoint + +`func (o *ServiceGetApi200Response) SetFederationRegistrationEndpoint(v string)` + +SetFederationRegistrationEndpoint sets FederationRegistrationEndpoint field to given value. + +### HasFederationRegistrationEndpoint + +`func (o *ServiceGetApi200Response) HasFederationRegistrationEndpoint() bool` + +HasFederationRegistrationEndpoint returns a boolean if a field has been set. + +### GetOrganizationName + +`func (o *ServiceGetApi200Response) GetOrganizationName() string` + +GetOrganizationName returns the OrganizationName field if non-nil, zero value otherwise. + +### GetOrganizationNameOk + +`func (o *ServiceGetApi200Response) GetOrganizationNameOk() (*string, bool)` + +GetOrganizationNameOk returns a tuple with the OrganizationName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrganizationName + +`func (o *ServiceGetApi200Response) SetOrganizationName(v string)` + +SetOrganizationName sets OrganizationName field to given value. + +### HasOrganizationName + +`func (o *ServiceGetApi200Response) HasOrganizationName() bool` + +HasOrganizationName returns a boolean if a field has been set. + +### GetPredefinedTransformedClaims + +`func (o *ServiceGetApi200Response) GetPredefinedTransformedClaims() string` + +GetPredefinedTransformedClaims returns the PredefinedTransformedClaims field if non-nil, zero value otherwise. + +### GetPredefinedTransformedClaimsOk + +`func (o *ServiceGetApi200Response) GetPredefinedTransformedClaimsOk() (*string, bool)` + +GetPredefinedTransformedClaimsOk returns a tuple with the PredefinedTransformedClaims field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPredefinedTransformedClaims + +`func (o *ServiceGetApi200Response) SetPredefinedTransformedClaims(v string)` + +SetPredefinedTransformedClaims sets PredefinedTransformedClaims field to given value. + +### HasPredefinedTransformedClaims + +`func (o *ServiceGetApi200Response) HasPredefinedTransformedClaims() bool` + +HasPredefinedTransformedClaims returns a boolean if a field has been set. + +### GetRefreshTokenIdempotent + +`func (o *ServiceGetApi200Response) GetRefreshTokenIdempotent() bool` + +GetRefreshTokenIdempotent returns the RefreshTokenIdempotent field if non-nil, zero value otherwise. + +### GetRefreshTokenIdempotentOk + +`func (o *ServiceGetApi200Response) GetRefreshTokenIdempotentOk() (*bool, bool)` + +GetRefreshTokenIdempotentOk returns a tuple with the RefreshTokenIdempotent field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRefreshTokenIdempotent + +`func (o *ServiceGetApi200Response) SetRefreshTokenIdempotent(v bool)` + +SetRefreshTokenIdempotent sets RefreshTokenIdempotent field to given value. + +### HasRefreshTokenIdempotent + +`func (o *ServiceGetApi200Response) HasRefreshTokenIdempotent() bool` + +HasRefreshTokenIdempotent returns a boolean if a field has been set. + +### GetSignedJwksUri + +`func (o *ServiceGetApi200Response) GetSignedJwksUri() string` + +GetSignedJwksUri returns the SignedJwksUri field if non-nil, zero value otherwise. + +### GetSignedJwksUriOk + +`func (o *ServiceGetApi200Response) GetSignedJwksUriOk() (*string, bool)` + +GetSignedJwksUriOk returns a tuple with the SignedJwksUri field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSignedJwksUri + +`func (o *ServiceGetApi200Response) SetSignedJwksUri(v string)` + +SetSignedJwksUri sets SignedJwksUri field to given value. + +### HasSignedJwksUri + +`func (o *ServiceGetApi200Response) HasSignedJwksUri() bool` + +HasSignedJwksUri returns a boolean if a field has been set. + +### GetSupportedAttachments + +`func (o *ServiceGetApi200Response) GetSupportedAttachments() []AttachmentType` + +GetSupportedAttachments returns the SupportedAttachments field if non-nil, zero value otherwise. + +### GetSupportedAttachmentsOk + +`func (o *ServiceGetApi200Response) GetSupportedAttachmentsOk() (*[]AttachmentType, bool)` + +GetSupportedAttachmentsOk returns a tuple with the SupportedAttachments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSupportedAttachments + +`func (o *ServiceGetApi200Response) SetSupportedAttachments(v []AttachmentType)` + +SetSupportedAttachments sets SupportedAttachments field to given value. + +### HasSupportedAttachments + +`func (o *ServiceGetApi200Response) HasSupportedAttachments() bool` + +HasSupportedAttachments returns a boolean if a field has been set. + +### GetSupportedDigestAlgorithms + +`func (o *ServiceGetApi200Response) GetSupportedDigestAlgorithms() []string` + +GetSupportedDigestAlgorithms returns the SupportedDigestAlgorithms field if non-nil, zero value otherwise. + +### GetSupportedDigestAlgorithmsOk + +`func (o *ServiceGetApi200Response) GetSupportedDigestAlgorithmsOk() (*[]string, bool)` + +GetSupportedDigestAlgorithmsOk returns a tuple with the SupportedDigestAlgorithms field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSupportedDigestAlgorithms + +`func (o *ServiceGetApi200Response) SetSupportedDigestAlgorithms(v []string)` + +SetSupportedDigestAlgorithms sets SupportedDigestAlgorithms field to given value. + +### HasSupportedDigestAlgorithms + +`func (o *ServiceGetApi200Response) HasSupportedDigestAlgorithms() bool` + +HasSupportedDigestAlgorithms returns a boolean if a field has been set. + +### GetSupportedDocuments + +`func (o *ServiceGetApi200Response) GetSupportedDocuments() []string` + +GetSupportedDocuments returns the SupportedDocuments field if non-nil, zero value otherwise. + +### GetSupportedDocumentsOk + +`func (o *ServiceGetApi200Response) GetSupportedDocumentsOk() (*[]string, bool)` + +GetSupportedDocumentsOk returns a tuple with the SupportedDocuments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSupportedDocuments + +`func (o *ServiceGetApi200Response) SetSupportedDocuments(v []string)` + +SetSupportedDocuments sets SupportedDocuments field to given value. + +### HasSupportedDocuments + +`func (o *ServiceGetApi200Response) HasSupportedDocuments() bool` + +HasSupportedDocuments returns a boolean if a field has been set. + +### GetSupportedDocumentsMethods + +`func (o *ServiceGetApi200Response) GetSupportedDocumentsMethods() []string` + +GetSupportedDocumentsMethods returns the SupportedDocumentsMethods field if non-nil, zero value otherwise. + +### GetSupportedDocumentsMethodsOk + +`func (o *ServiceGetApi200Response) GetSupportedDocumentsMethodsOk() (*[]string, bool)` + +GetSupportedDocumentsMethodsOk returns a tuple with the SupportedDocumentsMethods field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSupportedDocumentsMethods + +`func (o *ServiceGetApi200Response) SetSupportedDocumentsMethods(v []string)` + +SetSupportedDocumentsMethods sets SupportedDocumentsMethods field to given value. + +### HasSupportedDocumentsMethods + +`func (o *ServiceGetApi200Response) HasSupportedDocumentsMethods() bool` + +HasSupportedDocumentsMethods returns a boolean if a field has been set. + +### GetSupportedDocumentsValidationMethods + +`func (o *ServiceGetApi200Response) GetSupportedDocumentsValidationMethods() []string` + +GetSupportedDocumentsValidationMethods returns the SupportedDocumentsValidationMethods field if non-nil, zero value otherwise. + +### GetSupportedDocumentsValidationMethodsOk + +`func (o *ServiceGetApi200Response) GetSupportedDocumentsValidationMethodsOk() (*[]string, bool)` + +GetSupportedDocumentsValidationMethodsOk returns a tuple with the SupportedDocumentsValidationMethods field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSupportedDocumentsValidationMethods + +`func (o *ServiceGetApi200Response) SetSupportedDocumentsValidationMethods(v []string)` + +SetSupportedDocumentsValidationMethods sets SupportedDocumentsValidationMethods field to given value. + +### HasSupportedDocumentsValidationMethods + +`func (o *ServiceGetApi200Response) HasSupportedDocumentsValidationMethods() bool` + +HasSupportedDocumentsValidationMethods returns a boolean if a field has been set. + +### GetSupportedDocumentsVerificationMethods + +`func (o *ServiceGetApi200Response) GetSupportedDocumentsVerificationMethods() []string` + +GetSupportedDocumentsVerificationMethods returns the SupportedDocumentsVerificationMethods field if non-nil, zero value otherwise. + +### GetSupportedDocumentsVerificationMethodsOk + +`func (o *ServiceGetApi200Response) GetSupportedDocumentsVerificationMethodsOk() (*[]string, bool)` + +GetSupportedDocumentsVerificationMethodsOk returns a tuple with the SupportedDocumentsVerificationMethods field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSupportedDocumentsVerificationMethods + +`func (o *ServiceGetApi200Response) SetSupportedDocumentsVerificationMethods(v []string)` + +SetSupportedDocumentsVerificationMethods sets SupportedDocumentsVerificationMethods field to given value. + +### HasSupportedDocumentsVerificationMethods + +`func (o *ServiceGetApi200Response) HasSupportedDocumentsVerificationMethods() bool` + +HasSupportedDocumentsVerificationMethods returns a boolean if a field has been set. + +### GetSupportedElectronicRecords + +`func (o *ServiceGetApi200Response) GetSupportedElectronicRecords() []string` + +GetSupportedElectronicRecords returns the SupportedElectronicRecords field if non-nil, zero value otherwise. + +### GetSupportedElectronicRecordsOk + +`func (o *ServiceGetApi200Response) GetSupportedElectronicRecordsOk() (*[]string, bool)` + +GetSupportedElectronicRecordsOk returns a tuple with the SupportedElectronicRecords field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSupportedElectronicRecords + +`func (o *ServiceGetApi200Response) SetSupportedElectronicRecords(v []string)` + +SetSupportedElectronicRecords sets SupportedElectronicRecords field to given value. + +### HasSupportedElectronicRecords + +`func (o *ServiceGetApi200Response) HasSupportedElectronicRecords() bool` + +HasSupportedElectronicRecords returns a boolean if a field has been set. + +### GetSupportedClientRegistrationTypes + +`func (o *ServiceGetApi200Response) GetSupportedClientRegistrationTypes() []ClientRegistrationType` + +GetSupportedClientRegistrationTypes returns the SupportedClientRegistrationTypes field if non-nil, zero value otherwise. + +### GetSupportedClientRegistrationTypesOk + +`func (o *ServiceGetApi200Response) GetSupportedClientRegistrationTypesOk() (*[]ClientRegistrationType, bool)` + +GetSupportedClientRegistrationTypesOk returns a tuple with the SupportedClientRegistrationTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSupportedClientRegistrationTypes + +`func (o *ServiceGetApi200Response) SetSupportedClientRegistrationTypes(v []ClientRegistrationType)` + +SetSupportedClientRegistrationTypes sets SupportedClientRegistrationTypes field to given value. + +### HasSupportedClientRegistrationTypes + +`func (o *ServiceGetApi200Response) HasSupportedClientRegistrationTypes() bool` + +HasSupportedClientRegistrationTypes returns a boolean if a field has been set. + +### GetTokenExchangeByIdentifiableClientsOnly + +`func (o *ServiceGetApi200Response) GetTokenExchangeByIdentifiableClientsOnly() bool` + +GetTokenExchangeByIdentifiableClientsOnly returns the TokenExchangeByIdentifiableClientsOnly field if non-nil, zero value otherwise. + +### GetTokenExchangeByIdentifiableClientsOnlyOk + +`func (o *ServiceGetApi200Response) GetTokenExchangeByIdentifiableClientsOnlyOk() (*bool, bool)` + +GetTokenExchangeByIdentifiableClientsOnlyOk returns a tuple with the TokenExchangeByIdentifiableClientsOnly field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTokenExchangeByIdentifiableClientsOnly + +`func (o *ServiceGetApi200Response) SetTokenExchangeByIdentifiableClientsOnly(v bool)` + +SetTokenExchangeByIdentifiableClientsOnly sets TokenExchangeByIdentifiableClientsOnly field to given value. + +### HasTokenExchangeByIdentifiableClientsOnly + +`func (o *ServiceGetApi200Response) HasTokenExchangeByIdentifiableClientsOnly() bool` + +HasTokenExchangeByIdentifiableClientsOnly returns a boolean if a field has been set. + +### GetTokenExchangeByConfidentialClientsOnly + +`func (o *ServiceGetApi200Response) GetTokenExchangeByConfidentialClientsOnly() bool` + +GetTokenExchangeByConfidentialClientsOnly returns the TokenExchangeByConfidentialClientsOnly field if non-nil, zero value otherwise. + +### GetTokenExchangeByConfidentialClientsOnlyOk + +`func (o *ServiceGetApi200Response) GetTokenExchangeByConfidentialClientsOnlyOk() (*bool, bool)` + +GetTokenExchangeByConfidentialClientsOnlyOk returns a tuple with the TokenExchangeByConfidentialClientsOnly field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTokenExchangeByConfidentialClientsOnly + +`func (o *ServiceGetApi200Response) SetTokenExchangeByConfidentialClientsOnly(v bool)` + +SetTokenExchangeByConfidentialClientsOnly sets TokenExchangeByConfidentialClientsOnly field to given value. + +### HasTokenExchangeByConfidentialClientsOnly + +`func (o *ServiceGetApi200Response) HasTokenExchangeByConfidentialClientsOnly() bool` + +HasTokenExchangeByConfidentialClientsOnly returns a boolean if a field has been set. + +### GetTokenExchangeByPermittedClientsOnly + +`func (o *ServiceGetApi200Response) GetTokenExchangeByPermittedClientsOnly() bool` + +GetTokenExchangeByPermittedClientsOnly returns the TokenExchangeByPermittedClientsOnly field if non-nil, zero value otherwise. + +### GetTokenExchangeByPermittedClientsOnlyOk + +`func (o *ServiceGetApi200Response) GetTokenExchangeByPermittedClientsOnlyOk() (*bool, bool)` + +GetTokenExchangeByPermittedClientsOnlyOk returns a tuple with the TokenExchangeByPermittedClientsOnly field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTokenExchangeByPermittedClientsOnly + +`func (o *ServiceGetApi200Response) SetTokenExchangeByPermittedClientsOnly(v bool)` + +SetTokenExchangeByPermittedClientsOnly sets TokenExchangeByPermittedClientsOnly field to given value. + +### HasTokenExchangeByPermittedClientsOnly + +`func (o *ServiceGetApi200Response) HasTokenExchangeByPermittedClientsOnly() bool` + +HasTokenExchangeByPermittedClientsOnly returns a boolean if a field has been set. + +### GetTokenExchangeEncryptedJwtRejected + +`func (o *ServiceGetApi200Response) GetTokenExchangeEncryptedJwtRejected() bool` + +GetTokenExchangeEncryptedJwtRejected returns the TokenExchangeEncryptedJwtRejected field if non-nil, zero value otherwise. + +### GetTokenExchangeEncryptedJwtRejectedOk + +`func (o *ServiceGetApi200Response) GetTokenExchangeEncryptedJwtRejectedOk() (*bool, bool)` + +GetTokenExchangeEncryptedJwtRejectedOk returns a tuple with the TokenExchangeEncryptedJwtRejected field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTokenExchangeEncryptedJwtRejected + +`func (o *ServiceGetApi200Response) SetTokenExchangeEncryptedJwtRejected(v bool)` + +SetTokenExchangeEncryptedJwtRejected sets TokenExchangeEncryptedJwtRejected field to given value. + +### HasTokenExchangeEncryptedJwtRejected + +`func (o *ServiceGetApi200Response) HasTokenExchangeEncryptedJwtRejected() bool` + +HasTokenExchangeEncryptedJwtRejected returns a boolean if a field has been set. + +### GetTokenExchangeUnsignedJwtRejected + +`func (o *ServiceGetApi200Response) GetTokenExchangeUnsignedJwtRejected() bool` + +GetTokenExchangeUnsignedJwtRejected returns the TokenExchangeUnsignedJwtRejected field if non-nil, zero value otherwise. + +### GetTokenExchangeUnsignedJwtRejectedOk + +`func (o *ServiceGetApi200Response) GetTokenExchangeUnsignedJwtRejectedOk() (*bool, bool)` + +GetTokenExchangeUnsignedJwtRejectedOk returns a tuple with the TokenExchangeUnsignedJwtRejected field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTokenExchangeUnsignedJwtRejected + +`func (o *ServiceGetApi200Response) SetTokenExchangeUnsignedJwtRejected(v bool)` + +SetTokenExchangeUnsignedJwtRejected sets TokenExchangeUnsignedJwtRejected field to given value. + +### HasTokenExchangeUnsignedJwtRejected + +`func (o *ServiceGetApi200Response) HasTokenExchangeUnsignedJwtRejected() bool` + +HasTokenExchangeUnsignedJwtRejected returns a boolean if a field has been set. + +### GetJwtGrantByIdentifiableClientsOnly + +`func (o *ServiceGetApi200Response) GetJwtGrantByIdentifiableClientsOnly() bool` + +GetJwtGrantByIdentifiableClientsOnly returns the JwtGrantByIdentifiableClientsOnly field if non-nil, zero value otherwise. + +### GetJwtGrantByIdentifiableClientsOnlyOk + +`func (o *ServiceGetApi200Response) GetJwtGrantByIdentifiableClientsOnlyOk() (*bool, bool)` + +GetJwtGrantByIdentifiableClientsOnlyOk returns a tuple with the JwtGrantByIdentifiableClientsOnly field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetJwtGrantByIdentifiableClientsOnly + +`func (o *ServiceGetApi200Response) SetJwtGrantByIdentifiableClientsOnly(v bool)` + +SetJwtGrantByIdentifiableClientsOnly sets JwtGrantByIdentifiableClientsOnly field to given value. + +### HasJwtGrantByIdentifiableClientsOnly + +`func (o *ServiceGetApi200Response) HasJwtGrantByIdentifiableClientsOnly() bool` + +HasJwtGrantByIdentifiableClientsOnly returns a boolean if a field has been set. + +### GetJwtGrantEncryptedJwtRejected + +`func (o *ServiceGetApi200Response) GetJwtGrantEncryptedJwtRejected() bool` + +GetJwtGrantEncryptedJwtRejected returns the JwtGrantEncryptedJwtRejected field if non-nil, zero value otherwise. + +### GetJwtGrantEncryptedJwtRejectedOk + +`func (o *ServiceGetApi200Response) GetJwtGrantEncryptedJwtRejectedOk() (*bool, bool)` + +GetJwtGrantEncryptedJwtRejectedOk returns a tuple with the JwtGrantEncryptedJwtRejected field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetJwtGrantEncryptedJwtRejected + +`func (o *ServiceGetApi200Response) SetJwtGrantEncryptedJwtRejected(v bool)` + +SetJwtGrantEncryptedJwtRejected sets JwtGrantEncryptedJwtRejected field to given value. + +### HasJwtGrantEncryptedJwtRejected + +`func (o *ServiceGetApi200Response) HasJwtGrantEncryptedJwtRejected() bool` + +HasJwtGrantEncryptedJwtRejected returns a boolean if a field has been set. + +### GetJwtGrantUnsignedJwtRejected + +`func (o *ServiceGetApi200Response) GetJwtGrantUnsignedJwtRejected() bool` + +GetJwtGrantUnsignedJwtRejected returns the JwtGrantUnsignedJwtRejected field if non-nil, zero value otherwise. + +### GetJwtGrantUnsignedJwtRejectedOk + +`func (o *ServiceGetApi200Response) GetJwtGrantUnsignedJwtRejectedOk() (*bool, bool)` + +GetJwtGrantUnsignedJwtRejectedOk returns a tuple with the JwtGrantUnsignedJwtRejected field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetJwtGrantUnsignedJwtRejected + +`func (o *ServiceGetApi200Response) SetJwtGrantUnsignedJwtRejected(v bool)` + +SetJwtGrantUnsignedJwtRejected sets JwtGrantUnsignedJwtRejected field to given value. + +### HasJwtGrantUnsignedJwtRejected + +`func (o *ServiceGetApi200Response) HasJwtGrantUnsignedJwtRejected() bool` + +HasJwtGrantUnsignedJwtRejected returns a boolean if a field has been set. + +### GetDcrDuplicateSoftwareIdBlocked + +`func (o *ServiceGetApi200Response) GetDcrDuplicateSoftwareIdBlocked() bool` + +GetDcrDuplicateSoftwareIdBlocked returns the DcrDuplicateSoftwareIdBlocked field if non-nil, zero value otherwise. + +### GetDcrDuplicateSoftwareIdBlockedOk + +`func (o *ServiceGetApi200Response) GetDcrDuplicateSoftwareIdBlockedOk() (*bool, bool)` + +GetDcrDuplicateSoftwareIdBlockedOk returns a tuple with the DcrDuplicateSoftwareIdBlocked field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDcrDuplicateSoftwareIdBlocked + +`func (o *ServiceGetApi200Response) SetDcrDuplicateSoftwareIdBlocked(v bool)` + +SetDcrDuplicateSoftwareIdBlocked sets DcrDuplicateSoftwareIdBlocked field to given value. + +### HasDcrDuplicateSoftwareIdBlocked + +`func (o *ServiceGetApi200Response) HasDcrDuplicateSoftwareIdBlocked() bool` + +HasDcrDuplicateSoftwareIdBlocked returns a boolean if a field has been set. + +### GetTrustAnchors + +`func (o *ServiceGetApi200Response) GetTrustAnchors() []TrustAnchor` + +GetTrustAnchors returns the TrustAnchors field if non-nil, zero value otherwise. + +### GetTrustAnchorsOk + +`func (o *ServiceGetApi200Response) GetTrustAnchorsOk() (*[]TrustAnchor, bool)` + +GetTrustAnchorsOk returns a tuple with the TrustAnchors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTrustAnchors + +`func (o *ServiceGetApi200Response) SetTrustAnchors(v []TrustAnchor)` + +SetTrustAnchors sets TrustAnchors field to given value. + +### HasTrustAnchors + +`func (o *ServiceGetApi200Response) HasTrustAnchors() bool` + +HasTrustAnchors returns a boolean if a field has been set. + +### GetOpenidDroppedOnRefreshWithoutOfflineAccess + +`func (o *ServiceGetApi200Response) GetOpenidDroppedOnRefreshWithoutOfflineAccess() bool` + +GetOpenidDroppedOnRefreshWithoutOfflineAccess returns the OpenidDroppedOnRefreshWithoutOfflineAccess field if non-nil, zero value otherwise. + +### GetOpenidDroppedOnRefreshWithoutOfflineAccessOk + +`func (o *ServiceGetApi200Response) GetOpenidDroppedOnRefreshWithoutOfflineAccessOk() (*bool, bool)` + +GetOpenidDroppedOnRefreshWithoutOfflineAccessOk returns a tuple with the OpenidDroppedOnRefreshWithoutOfflineAccess field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOpenidDroppedOnRefreshWithoutOfflineAccess + +`func (o *ServiceGetApi200Response) SetOpenidDroppedOnRefreshWithoutOfflineAccess(v bool)` + +SetOpenidDroppedOnRefreshWithoutOfflineAccess sets OpenidDroppedOnRefreshWithoutOfflineAccess field to given value. + +### HasOpenidDroppedOnRefreshWithoutOfflineAccess + +`func (o *ServiceGetApi200Response) HasOpenidDroppedOnRefreshWithoutOfflineAccess() bool` + +HasOpenidDroppedOnRefreshWithoutOfflineAccess returns a boolean if a field has been set. + +### GetSupportedDocumentsCheckMethods + +`func (o *ServiceGetApi200Response) GetSupportedDocumentsCheckMethods() []string` + +GetSupportedDocumentsCheckMethods returns the SupportedDocumentsCheckMethods field if non-nil, zero value otherwise. + +### GetSupportedDocumentsCheckMethodsOk + +`func (o *ServiceGetApi200Response) GetSupportedDocumentsCheckMethodsOk() (*[]string, bool)` + +GetSupportedDocumentsCheckMethodsOk returns a tuple with the SupportedDocumentsCheckMethods field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSupportedDocumentsCheckMethods + +`func (o *ServiceGetApi200Response) SetSupportedDocumentsCheckMethods(v []string)` + +SetSupportedDocumentsCheckMethods sets SupportedDocumentsCheckMethods field to given value. + +### HasSupportedDocumentsCheckMethods + +`func (o *ServiceGetApi200Response) HasSupportedDocumentsCheckMethods() bool` + +HasSupportedDocumentsCheckMethods returns a boolean if a field has been set. + +### GetRsResponseSigned + +`func (o *ServiceGetApi200Response) GetRsResponseSigned() bool` + +GetRsResponseSigned returns the RsResponseSigned field if non-nil, zero value otherwise. + +### GetRsResponseSignedOk + +`func (o *ServiceGetApi200Response) GetRsResponseSignedOk() (*bool, bool)` + +GetRsResponseSignedOk returns a tuple with the RsResponseSigned field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRsResponseSigned + +`func (o *ServiceGetApi200Response) SetRsResponseSigned(v bool)` + +SetRsResponseSigned sets RsResponseSigned field to given value. + +### HasRsResponseSigned + +`func (o *ServiceGetApi200Response) HasRsResponseSigned() bool` + +HasRsResponseSigned returns a boolean if a field has been set. + +### GetCnonceDuration + +`func (o *ServiceGetApi200Response) GetCnonceDuration() int64` + +GetCnonceDuration returns the CnonceDuration field if non-nil, zero value otherwise. + +### GetCnonceDurationOk + +`func (o *ServiceGetApi200Response) GetCnonceDurationOk() (*int64, bool)` + +GetCnonceDurationOk returns a tuple with the CnonceDuration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCnonceDuration + +`func (o *ServiceGetApi200Response) SetCnonceDuration(v int64)` + +SetCnonceDuration sets CnonceDuration field to given value. + +### HasCnonceDuration + +`func (o *ServiceGetApi200Response) HasCnonceDuration() bool` + +HasCnonceDuration returns a boolean if a field has been set. + +### GetDpopNonceRequired + +`func (o *ServiceGetApi200Response) GetDpopNonceRequired() bool` + +GetDpopNonceRequired returns the DpopNonceRequired field if non-nil, zero value otherwise. + +### GetDpopNonceRequiredOk + +`func (o *ServiceGetApi200Response) GetDpopNonceRequiredOk() (*bool, bool)` + +GetDpopNonceRequiredOk returns a tuple with the DpopNonceRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDpopNonceRequired + +`func (o *ServiceGetApi200Response) SetDpopNonceRequired(v bool)` + +SetDpopNonceRequired sets DpopNonceRequired field to given value. + +### HasDpopNonceRequired + +`func (o *ServiceGetApi200Response) HasDpopNonceRequired() bool` + +HasDpopNonceRequired returns a boolean if a field has been set. + +### GetVerifiableCredentialsEnabled + +`func (o *ServiceGetApi200Response) GetVerifiableCredentialsEnabled() bool` + +GetVerifiableCredentialsEnabled returns the VerifiableCredentialsEnabled field if non-nil, zero value otherwise. + +### GetVerifiableCredentialsEnabledOk + +`func (o *ServiceGetApi200Response) GetVerifiableCredentialsEnabledOk() (*bool, bool)` + +GetVerifiableCredentialsEnabledOk returns a tuple with the VerifiableCredentialsEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVerifiableCredentialsEnabled + +`func (o *ServiceGetApi200Response) SetVerifiableCredentialsEnabled(v bool)` + +SetVerifiableCredentialsEnabled sets VerifiableCredentialsEnabled field to given value. + +### HasVerifiableCredentialsEnabled + +`func (o *ServiceGetApi200Response) HasVerifiableCredentialsEnabled() bool` + +HasVerifiableCredentialsEnabled returns a boolean if a field has been set. + +### GetCredentialJwksUri + +`func (o *ServiceGetApi200Response) GetCredentialJwksUri() string` + +GetCredentialJwksUri returns the CredentialJwksUri field if non-nil, zero value otherwise. + +### GetCredentialJwksUriOk + +`func (o *ServiceGetApi200Response) GetCredentialJwksUriOk() (*string, bool)` + +GetCredentialJwksUriOk returns a tuple with the CredentialJwksUri field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCredentialJwksUri + +`func (o *ServiceGetApi200Response) SetCredentialJwksUri(v string)` + +SetCredentialJwksUri sets CredentialJwksUri field to given value. + +### HasCredentialJwksUri + +`func (o *ServiceGetApi200Response) HasCredentialJwksUri() bool` + +HasCredentialJwksUri returns a boolean if a field has been set. + +### GetCredentialOfferDuration + +`func (o *ServiceGetApi200Response) GetCredentialOfferDuration() int64` + +GetCredentialOfferDuration returns the CredentialOfferDuration field if non-nil, zero value otherwise. + +### GetCredentialOfferDurationOk + +`func (o *ServiceGetApi200Response) GetCredentialOfferDurationOk() (*int64, bool)` + +GetCredentialOfferDurationOk returns a tuple with the CredentialOfferDuration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCredentialOfferDuration + +`func (o *ServiceGetApi200Response) SetCredentialOfferDuration(v int64)` + +SetCredentialOfferDuration sets CredentialOfferDuration field to given value. + +### HasCredentialOfferDuration + +`func (o *ServiceGetApi200Response) HasCredentialOfferDuration() bool` + +HasCredentialOfferDuration returns a boolean if a field has been set. + +### GetDpopNonceDuration + +`func (o *ServiceGetApi200Response) GetDpopNonceDuration() int64` + +GetDpopNonceDuration returns the DpopNonceDuration field if non-nil, zero value otherwise. + +### GetDpopNonceDurationOk + +`func (o *ServiceGetApi200Response) GetDpopNonceDurationOk() (*int64, bool)` + +GetDpopNonceDurationOk returns a tuple with the DpopNonceDuration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDpopNonceDuration + +`func (o *ServiceGetApi200Response) SetDpopNonceDuration(v int64)` + +SetDpopNonceDuration sets DpopNonceDuration field to given value. + +### HasDpopNonceDuration + +`func (o *ServiceGetApi200Response) HasDpopNonceDuration() bool` + +HasDpopNonceDuration returns a boolean if a field has been set. + +### GetPreAuthorizedGrantAnonymousAccessSupported + +`func (o *ServiceGetApi200Response) GetPreAuthorizedGrantAnonymousAccessSupported() bool` + +GetPreAuthorizedGrantAnonymousAccessSupported returns the PreAuthorizedGrantAnonymousAccessSupported field if non-nil, zero value otherwise. + +### GetPreAuthorizedGrantAnonymousAccessSupportedOk + +`func (o *ServiceGetApi200Response) GetPreAuthorizedGrantAnonymousAccessSupportedOk() (*bool, bool)` + +GetPreAuthorizedGrantAnonymousAccessSupportedOk returns a tuple with the PreAuthorizedGrantAnonymousAccessSupported field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPreAuthorizedGrantAnonymousAccessSupported + +`func (o *ServiceGetApi200Response) SetPreAuthorizedGrantAnonymousAccessSupported(v bool)` + +SetPreAuthorizedGrantAnonymousAccessSupported sets PreAuthorizedGrantAnonymousAccessSupported field to given value. + +### HasPreAuthorizedGrantAnonymousAccessSupported + +`func (o *ServiceGetApi200Response) HasPreAuthorizedGrantAnonymousAccessSupported() bool` + +HasPreAuthorizedGrantAnonymousAccessSupported returns a boolean if a field has been set. + +### GetCredentialTransactionDuration + +`func (o *ServiceGetApi200Response) GetCredentialTransactionDuration() int64` + +GetCredentialTransactionDuration returns the CredentialTransactionDuration field if non-nil, zero value otherwise. + +### GetCredentialTransactionDurationOk + +`func (o *ServiceGetApi200Response) GetCredentialTransactionDurationOk() (*int64, bool)` + +GetCredentialTransactionDurationOk returns a tuple with the CredentialTransactionDuration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCredentialTransactionDuration + +`func (o *ServiceGetApi200Response) SetCredentialTransactionDuration(v int64)` + +SetCredentialTransactionDuration sets CredentialTransactionDuration field to given value. + +### HasCredentialTransactionDuration + +`func (o *ServiceGetApi200Response) HasCredentialTransactionDuration() bool` + +HasCredentialTransactionDuration returns a boolean if a field has been set. + +### GetIntrospectionSignatureKeyId + +`func (o *ServiceGetApi200Response) GetIntrospectionSignatureKeyId() string` + +GetIntrospectionSignatureKeyId returns the IntrospectionSignatureKeyId field if non-nil, zero value otherwise. + +### GetIntrospectionSignatureKeyIdOk + +`func (o *ServiceGetApi200Response) GetIntrospectionSignatureKeyIdOk() (*string, bool)` + +GetIntrospectionSignatureKeyIdOk returns a tuple with the IntrospectionSignatureKeyId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIntrospectionSignatureKeyId + +`func (o *ServiceGetApi200Response) SetIntrospectionSignatureKeyId(v string)` + +SetIntrospectionSignatureKeyId sets IntrospectionSignatureKeyId field to given value. + +### HasIntrospectionSignatureKeyId + +`func (o *ServiceGetApi200Response) HasIntrospectionSignatureKeyId() bool` + +HasIntrospectionSignatureKeyId returns a boolean if a field has been set. + +### GetResourceSignatureKeyId + +`func (o *ServiceGetApi200Response) GetResourceSignatureKeyId() string` + +GetResourceSignatureKeyId returns the ResourceSignatureKeyId field if non-nil, zero value otherwise. + +### GetResourceSignatureKeyIdOk + +`func (o *ServiceGetApi200Response) GetResourceSignatureKeyIdOk() (*string, bool)` + +GetResourceSignatureKeyIdOk returns a tuple with the ResourceSignatureKeyId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResourceSignatureKeyId + +`func (o *ServiceGetApi200Response) SetResourceSignatureKeyId(v string)` + +SetResourceSignatureKeyId sets ResourceSignatureKeyId field to given value. + +### HasResourceSignatureKeyId + +`func (o *ServiceGetApi200Response) HasResourceSignatureKeyId() bool` + +HasResourceSignatureKeyId returns a boolean if a field has been set. + +### GetUserPinLength + +`func (o *ServiceGetApi200Response) GetUserPinLength() int32` + +GetUserPinLength returns the UserPinLength field if non-nil, zero value otherwise. + +### GetUserPinLengthOk + +`func (o *ServiceGetApi200Response) GetUserPinLengthOk() (*int32, bool)` + +GetUserPinLengthOk returns a tuple with the UserPinLength field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserPinLength + +`func (o *ServiceGetApi200Response) SetUserPinLength(v int32)` + +SetUserPinLength sets UserPinLength field to given value. + +### HasUserPinLength + +`func (o *ServiceGetApi200Response) HasUserPinLength() bool` + +HasUserPinLength returns a boolean if a field has been set. + +### GetSupportedPromptValues + +`func (o *ServiceGetApi200Response) GetSupportedPromptValues() []Prompt` + +GetSupportedPromptValues returns the SupportedPromptValues field if non-nil, zero value otherwise. + +### GetSupportedPromptValuesOk + +`func (o *ServiceGetApi200Response) GetSupportedPromptValuesOk() (*[]Prompt, bool)` + +GetSupportedPromptValuesOk returns a tuple with the SupportedPromptValues field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSupportedPromptValues + +`func (o *ServiceGetApi200Response) SetSupportedPromptValues(v []Prompt)` + +SetSupportedPromptValues sets SupportedPromptValues field to given value. + +### HasSupportedPromptValues + +`func (o *ServiceGetApi200Response) HasSupportedPromptValues() bool` + +HasSupportedPromptValues returns a boolean if a field has been set. + +### GetIdTokenReissuable + +`func (o *ServiceGetApi200Response) GetIdTokenReissuable() bool` + +GetIdTokenReissuable returns the IdTokenReissuable field if non-nil, zero value otherwise. + +### GetIdTokenReissuableOk + +`func (o *ServiceGetApi200Response) GetIdTokenReissuableOk() (*bool, bool)` + +GetIdTokenReissuableOk returns a tuple with the IdTokenReissuable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdTokenReissuable + +`func (o *ServiceGetApi200Response) SetIdTokenReissuable(v bool)` + +SetIdTokenReissuable sets IdTokenReissuable field to given value. + +### HasIdTokenReissuable + +`func (o *ServiceGetApi200Response) HasIdTokenReissuable() bool` + +HasIdTokenReissuable returns a boolean if a field has been set. + +### GetCredentialJwks + +`func (o *ServiceGetApi200Response) GetCredentialJwks() string` + +GetCredentialJwks returns the CredentialJwks field if non-nil, zero value otherwise. + +### GetCredentialJwksOk + +`func (o *ServiceGetApi200Response) GetCredentialJwksOk() (*string, bool)` + +GetCredentialJwksOk returns a tuple with the CredentialJwks field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCredentialJwks + +`func (o *ServiceGetApi200Response) SetCredentialJwks(v string)` + +SetCredentialJwks sets CredentialJwks field to given value. + +### HasCredentialJwks + +`func (o *ServiceGetApi200Response) HasCredentialJwks() bool` + +HasCredentialJwks returns a boolean if a field has been set. + +### GetFapiModes + +`func (o *ServiceGetApi200Response) GetFapiModes() []FapiMode` + +GetFapiModes returns the FapiModes field if non-nil, zero value otherwise. + +### GetFapiModesOk + +`func (o *ServiceGetApi200Response) GetFapiModesOk() (*[]FapiMode, bool)` + +GetFapiModesOk returns a tuple with the FapiModes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFapiModes + +`func (o *ServiceGetApi200Response) SetFapiModes(v []FapiMode)` + +SetFapiModes sets FapiModes field to given value. + +### HasFapiModes + +`func (o *ServiceGetApi200Response) HasFapiModes() bool` + +HasFapiModes returns a boolean if a field has been set. + +### GetCredentialDuration + +`func (o *ServiceGetApi200Response) GetCredentialDuration() int64` + +GetCredentialDuration returns the CredentialDuration field if non-nil, zero value otherwise. + +### GetCredentialDurationOk + +`func (o *ServiceGetApi200Response) GetCredentialDurationOk() (*int64, bool)` + +GetCredentialDurationOk returns a tuple with the CredentialDuration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCredentialDuration + +`func (o *ServiceGetApi200Response) SetCredentialDuration(v int64)` + +SetCredentialDuration sets CredentialDuration field to given value. + +### HasCredentialDuration + +`func (o *ServiceGetApi200Response) HasCredentialDuration() bool` + +HasCredentialDuration returns a boolean if a field has been set. + +### GetCredentialIssuerMetadata + +`func (o *ServiceGetApi200Response) GetCredentialIssuerMetadata() CredentialIssuerMetadata` + +GetCredentialIssuerMetadata returns the CredentialIssuerMetadata field if non-nil, zero value otherwise. + +### GetCredentialIssuerMetadataOk + +`func (o *ServiceGetApi200Response) GetCredentialIssuerMetadataOk() (*CredentialIssuerMetadata, bool)` + +GetCredentialIssuerMetadataOk returns a tuple with the CredentialIssuerMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCredentialIssuerMetadata + +`func (o *ServiceGetApi200Response) SetCredentialIssuerMetadata(v CredentialIssuerMetadata)` + +SetCredentialIssuerMetadata sets CredentialIssuerMetadata field to given value. + +### HasCredentialIssuerMetadata + +`func (o *ServiceGetApi200Response) HasCredentialIssuerMetadata() bool` + +HasCredentialIssuerMetadata returns a boolean if a field has been set. + +### GetIdTokenAudType + +`func (o *ServiceGetApi200Response) GetIdTokenAudType() string` + +GetIdTokenAudType returns the IdTokenAudType field if non-nil, zero value otherwise. + +### GetIdTokenAudTypeOk + +`func (o *ServiceGetApi200Response) GetIdTokenAudTypeOk() (*string, bool)` + +GetIdTokenAudTypeOk returns a tuple with the IdTokenAudType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdTokenAudType + +`func (o *ServiceGetApi200Response) SetIdTokenAudType(v string)` + +SetIdTokenAudType sets IdTokenAudType field to given value. + +### HasIdTokenAudType + +`func (o *ServiceGetApi200Response) HasIdTokenAudType() bool` + +HasIdTokenAudType returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ServiceGetListApi200Response.md b/docs/ServiceGetListApi200Response.md new file mode 100644 index 0000000..0c83711 --- /dev/null +++ b/docs/ServiceGetListApi200Response.md @@ -0,0 +1,134 @@ +# ServiceGetListApi200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Start** | Pointer to **int32** | Start index (inclusive) of the result set. The default value is 0. Must not be a negative number. | [optional] +**End** | Pointer to **int32** | Start index (inclusive) of the result set. The default value is 0. Must not be a negative number. | [optional] +**TotalCount** | Pointer to **int32** | Total number of services owned by the service owner. This doesn't mean the number of services contained in the response. | [optional] +**Services** | Pointer to [**[]ServiceLimited**](ServiceLimited.md) | An array of services. | [optional] + +## Methods + +### NewServiceGetListApi200Response + +`func NewServiceGetListApi200Response() *ServiceGetListApi200Response` + +NewServiceGetListApi200Response instantiates a new ServiceGetListApi200Response object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewServiceGetListApi200ResponseWithDefaults + +`func NewServiceGetListApi200ResponseWithDefaults() *ServiceGetListApi200Response` + +NewServiceGetListApi200ResponseWithDefaults instantiates a new ServiceGetListApi200Response object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetStart + +`func (o *ServiceGetListApi200Response) GetStart() int32` + +GetStart returns the Start field if non-nil, zero value otherwise. + +### GetStartOk + +`func (o *ServiceGetListApi200Response) GetStartOk() (*int32, bool)` + +GetStartOk returns a tuple with the Start field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStart + +`func (o *ServiceGetListApi200Response) SetStart(v int32)` + +SetStart sets Start field to given value. + +### HasStart + +`func (o *ServiceGetListApi200Response) HasStart() bool` + +HasStart returns a boolean if a field has been set. + +### GetEnd + +`func (o *ServiceGetListApi200Response) GetEnd() int32` + +GetEnd returns the End field if non-nil, zero value otherwise. + +### GetEndOk + +`func (o *ServiceGetListApi200Response) GetEndOk() (*int32, bool)` + +GetEndOk returns a tuple with the End field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnd + +`func (o *ServiceGetListApi200Response) SetEnd(v int32)` + +SetEnd sets End field to given value. + +### HasEnd + +`func (o *ServiceGetListApi200Response) HasEnd() bool` + +HasEnd returns a boolean if a field has been set. + +### GetTotalCount + +`func (o *ServiceGetListApi200Response) GetTotalCount() int32` + +GetTotalCount returns the TotalCount field if non-nil, zero value otherwise. + +### GetTotalCountOk + +`func (o *ServiceGetListApi200Response) GetTotalCountOk() (*int32, bool)` + +GetTotalCountOk returns a tuple with the TotalCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCount + +`func (o *ServiceGetListApi200Response) SetTotalCount(v int32)` + +SetTotalCount sets TotalCount field to given value. + +### HasTotalCount + +`func (o *ServiceGetListApi200Response) HasTotalCount() bool` + +HasTotalCount returns a boolean if a field has been set. + +### GetServices + +`func (o *ServiceGetListApi200Response) GetServices() []ServiceLimited` + +GetServices returns the Services field if non-nil, zero value otherwise. + +### GetServicesOk + +`func (o *ServiceGetListApi200Response) GetServicesOk() (*[]ServiceLimited, bool)` + +GetServicesOk returns a tuple with the Services field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetServices + +`func (o *ServiceGetListApi200Response) SetServices(v []ServiceLimited)` + +SetServices sets Services field to given value. + +### HasServices + +`func (o *ServiceGetListApi200Response) HasServices() bool` + +HasServices returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ServiceGetListLimitedResponse.md b/docs/ServiceGetListLimitedResponse.md new file mode 100644 index 0000000..2962c89 --- /dev/null +++ b/docs/ServiceGetListLimitedResponse.md @@ -0,0 +1,134 @@ +# ServiceGetListLimitedResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Start** | Pointer to **int32** | Start index (inclusive) of the result set. The default value is 0. Must not be a negative number. | [optional] +**End** | Pointer to **int32** | Start index (inclusive) of the result set. The default value is 0. Must not be a negative number. | [optional] +**TotalCount** | Pointer to **int32** | Total number of services owned by the service owner. This doesn't mean the number of services contained in the response. | [optional] +**Services** | Pointer to [**[]ServiceLimited**](ServiceLimited.md) | An array of services. | [optional] + +## Methods + +### NewServiceGetListLimitedResponse + +`func NewServiceGetListLimitedResponse() *ServiceGetListLimitedResponse` + +NewServiceGetListLimitedResponse instantiates a new ServiceGetListLimitedResponse object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewServiceGetListLimitedResponseWithDefaults + +`func NewServiceGetListLimitedResponseWithDefaults() *ServiceGetListLimitedResponse` + +NewServiceGetListLimitedResponseWithDefaults instantiates a new ServiceGetListLimitedResponse object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetStart + +`func (o *ServiceGetListLimitedResponse) GetStart() int32` + +GetStart returns the Start field if non-nil, zero value otherwise. + +### GetStartOk + +`func (o *ServiceGetListLimitedResponse) GetStartOk() (*int32, bool)` + +GetStartOk returns a tuple with the Start field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStart + +`func (o *ServiceGetListLimitedResponse) SetStart(v int32)` + +SetStart sets Start field to given value. + +### HasStart + +`func (o *ServiceGetListLimitedResponse) HasStart() bool` + +HasStart returns a boolean if a field has been set. + +### GetEnd + +`func (o *ServiceGetListLimitedResponse) GetEnd() int32` + +GetEnd returns the End field if non-nil, zero value otherwise. + +### GetEndOk + +`func (o *ServiceGetListLimitedResponse) GetEndOk() (*int32, bool)` + +GetEndOk returns a tuple with the End field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnd + +`func (o *ServiceGetListLimitedResponse) SetEnd(v int32)` + +SetEnd sets End field to given value. + +### HasEnd + +`func (o *ServiceGetListLimitedResponse) HasEnd() bool` + +HasEnd returns a boolean if a field has been set. + +### GetTotalCount + +`func (o *ServiceGetListLimitedResponse) GetTotalCount() int32` + +GetTotalCount returns the TotalCount field if non-nil, zero value otherwise. + +### GetTotalCountOk + +`func (o *ServiceGetListLimitedResponse) GetTotalCountOk() (*int32, bool)` + +GetTotalCountOk returns a tuple with the TotalCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCount + +`func (o *ServiceGetListLimitedResponse) SetTotalCount(v int32)` + +SetTotalCount sets TotalCount field to given value. + +### HasTotalCount + +`func (o *ServiceGetListLimitedResponse) HasTotalCount() bool` + +HasTotalCount returns a boolean if a field has been set. + +### GetServices + +`func (o *ServiceGetListLimitedResponse) GetServices() []ServiceLimited` + +GetServices returns the Services field if non-nil, zero value otherwise. + +### GetServicesOk + +`func (o *ServiceGetListLimitedResponse) GetServicesOk() (*[]ServiceLimited, bool)` + +GetServicesOk returns a tuple with the Services field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetServices + +`func (o *ServiceGetListLimitedResponse) SetServices(v []ServiceLimited)` + +SetServices sets Services field to given value. + +### HasServices + +`func (o *ServiceGetListLimitedResponse) HasServices() bool` + +HasServices returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ServiceLimited.md b/docs/ServiceLimited.md new file mode 100644 index 0000000..b60e18b --- /dev/null +++ b/docs/ServiceLimited.md @@ -0,0 +1,160 @@ +# ServiceLimited + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Number** | Pointer to **int32** | The sequential number of the service. The value of this property is assigned by Authlete. | [optional] [readonly] +**ServiceName** | Pointer to **string** | The name of this service. | [optional] +**Description** | Pointer to **string** | The description about the service. | [optional] +**ApiKey** | Pointer to **int64** | The service ID used in Authlete API calls. The value of this property is assigned by Authlete. | [optional] [readonly] +**ClientIdAliasEnabled** | Pointer to **bool** | Deprecated. Always `true`. | [optional] + +## Methods + +### NewServiceLimited + +`func NewServiceLimited() *ServiceLimited` + +NewServiceLimited instantiates a new ServiceLimited object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewServiceLimitedWithDefaults + +`func NewServiceLimitedWithDefaults() *ServiceLimited` + +NewServiceLimitedWithDefaults instantiates a new ServiceLimited object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetNumber + +`func (o *ServiceLimited) GetNumber() int32` + +GetNumber returns the Number field if non-nil, zero value otherwise. + +### GetNumberOk + +`func (o *ServiceLimited) GetNumberOk() (*int32, bool)` + +GetNumberOk returns a tuple with the Number field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNumber + +`func (o *ServiceLimited) SetNumber(v int32)` + +SetNumber sets Number field to given value. + +### HasNumber + +`func (o *ServiceLimited) HasNumber() bool` + +HasNumber returns a boolean if a field has been set. + +### GetServiceName + +`func (o *ServiceLimited) GetServiceName() string` + +GetServiceName returns the ServiceName field if non-nil, zero value otherwise. + +### GetServiceNameOk + +`func (o *ServiceLimited) GetServiceNameOk() (*string, bool)` + +GetServiceNameOk returns a tuple with the ServiceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetServiceName + +`func (o *ServiceLimited) SetServiceName(v string)` + +SetServiceName sets ServiceName field to given value. + +### HasServiceName + +`func (o *ServiceLimited) HasServiceName() bool` + +HasServiceName returns a boolean if a field has been set. + +### GetDescription + +`func (o *ServiceLimited) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ServiceLimited) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ServiceLimited) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ServiceLimited) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetApiKey + +`func (o *ServiceLimited) GetApiKey() int64` + +GetApiKey returns the ApiKey field if non-nil, zero value otherwise. + +### GetApiKeyOk + +`func (o *ServiceLimited) GetApiKeyOk() (*int64, bool)` + +GetApiKeyOk returns a tuple with the ApiKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApiKey + +`func (o *ServiceLimited) SetApiKey(v int64)` + +SetApiKey sets ApiKey field to given value. + +### HasApiKey + +`func (o *ServiceLimited) HasApiKey() bool` + +HasApiKey returns a boolean if a field has been set. + +### GetClientIdAliasEnabled + +`func (o *ServiceLimited) GetClientIdAliasEnabled() bool` + +GetClientIdAliasEnabled returns the ClientIdAliasEnabled field if non-nil, zero value otherwise. + +### GetClientIdAliasEnabledOk + +`func (o *ServiceLimited) GetClientIdAliasEnabledOk() (*bool, bool)` + +GetClientIdAliasEnabledOk returns a tuple with the ClientIdAliasEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientIdAliasEnabled + +`func (o *ServiceLimited) SetClientIdAliasEnabled(v bool)` + +SetClientIdAliasEnabled sets ClientIdAliasEnabled field to given value. + +### HasClientIdAliasEnabled + +`func (o *ServiceLimited) HasClientIdAliasEnabled() bool` + +HasClientIdAliasEnabled returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ServiceManagementApi.md b/docs/ServiceManagementApi.md index a4fbd7e..2b981d0 100644 --- a/docs/ServiceManagementApi.md +++ b/docs/ServiceManagementApi.md @@ -1,14 +1,14 @@ # \ServiceManagementApi -All URIs are relative to *https://api.authlete.com* +All URIs are relative to *https://beta.authlete.com* Method | HTTP request | Description ------------- | ------------- | ------------- [**ServiceCreateApi**](ServiceManagementApi.md#ServiceCreateApi) | **Post** /api/service/create | /api/service/create API -[**ServiceDeleteApi**](ServiceManagementApi.md#ServiceDeleteApi) | **Delete** /api/service/delete/{serviceApiKey} | /api/service/delete/{serviceApiKey} API -[**ServiceGetApi**](ServiceManagementApi.md#ServiceGetApi) | **Get** /api/service/get/{serviceApiKey} | /api/service/get/{serviceApiKey} API +[**ServiceDeleteApi**](ServiceManagementApi.md#ServiceDeleteApi) | **Delete** /api/{serviceId}/service/delete | /api/{serviceId}/service/delete API +[**ServiceGetApi**](ServiceManagementApi.md#ServiceGetApi) | **Get** /api/{serviceId}/service/get | /api/{serviceId}/service/get API [**ServiceGetListApi**](ServiceManagementApi.md#ServiceGetListApi) | **Get** /api/service/get/list | /api/service/get/list API -[**ServiceUpdateApi**](ServiceManagementApi.md#ServiceUpdateApi) | **Post** /api/service/update/{serviceApiKey} | /api/service/update/{serviceApiKey} API +[**ServiceUpdateApi**](ServiceManagementApi.md#ServiceUpdateApi) | **Post** /api/{serviceId}/service/update | /api/{serviceId}/service/update API @@ -66,7 +66,7 @@ Name | Type | Description | Notes ### Authorization -[ServiceOwnerCredentials](../README.md#ServiceOwnerCredentials) +[CreateService](../README.md#CreateService) ### HTTP request headers @@ -80,9 +80,9 @@ Name | Type | Description | Notes ## ServiceDeleteApi -> ServiceDeleteApi(ctx, serviceApiKey).Execute() +> ServiceDeleteApi(ctx, serviceId).Execute() -/api/service/delete/{serviceApiKey} API +/api/{serviceId}/service/delete API @@ -99,11 +99,11 @@ import ( ) func main() { - serviceApiKey := "serviceApiKey_example" // string | The API key of the target service. + serviceId := "serviceId_example" // string | A service ID. configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.ServiceManagementApi.ServiceDeleteApi(context.Background(), serviceApiKey).Execute() + resp, r, err := apiClient.ServiceManagementApi.ServiceDeleteApi(context.Background(), serviceId).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ServiceManagementApi.ServiceDeleteApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -117,7 +117,7 @@ func main() { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**serviceApiKey** | **string** | The API key of the target service. | +**serviceId** | **string** | A service ID. | ### Other Parameters @@ -134,7 +134,7 @@ Name | Type | Description | Notes ### Authorization -[ServiceOwnerCredentials](../README.md#ServiceOwnerCredentials) +[DeleteService](../README.md#DeleteService) ### HTTP request headers @@ -148,9 +148,9 @@ Name | Type | Description | Notes ## ServiceGetApi -> Service ServiceGetApi(ctx, serviceApiKey).Execute() +> ServiceGetApi200Response ServiceGetApi(ctx, serviceId).Execute() -/api/service/get/{serviceApiKey} API +/api/{serviceId}/service/get API @@ -167,16 +167,16 @@ import ( ) func main() { - serviceApiKey := "serviceApiKey_example" // string | The API key of a service. + serviceId := "serviceId_example" // string | A service ID. configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.ServiceManagementApi.ServiceGetApi(context.Background(), serviceApiKey).Execute() + resp, r, err := apiClient.ServiceManagementApi.ServiceGetApi(context.Background(), serviceId).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ServiceManagementApi.ServiceGetApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } - // response from `ServiceGetApi`: Service + // response from `ServiceGetApi`: ServiceGetApi200Response fmt.Fprintf(os.Stdout, "Response from `ServiceManagementApi.ServiceGetApi`: %v\n", resp) } ``` @@ -187,7 +187,7 @@ func main() { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**serviceApiKey** | **string** | The API key of a service. | +**serviceId** | **string** | A service ID. | ### Other Parameters @@ -200,11 +200,11 @@ Name | Type | Description | Notes ### Return type -[**Service**](Service.md) +[**ServiceGetApi200Response**](ServiceGetApi200Response.md) ### Authorization -[ServiceOwnerCredentials](../README.md#ServiceOwnerCredentials) +[ViewService](../README.md#ViewService) ### HTTP request headers @@ -218,7 +218,7 @@ Name | Type | Description | Notes ## ServiceGetListApi -> ServiceGetListResponse ServiceGetListApi(ctx).Start(start).End(end).Execute() +> ServiceGetListApi200Response ServiceGetListApi(ctx).Start(start).End(end).Execute() /api/service/get/list API @@ -247,7 +247,7 @@ func main() { fmt.Fprintf(os.Stderr, "Error when calling `ServiceManagementApi.ServiceGetListApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } - // response from `ServiceGetListApi`: ServiceGetListResponse + // response from `ServiceGetListApi`: ServiceGetListApi200Response fmt.Fprintf(os.Stdout, "Response from `ServiceManagementApi.ServiceGetListApi`: %v\n", resp) } ``` @@ -268,11 +268,11 @@ Name | Type | Description | Notes ### Return type -[**ServiceGetListResponse**](ServiceGetListResponse.md) +[**ServiceGetListApi200Response**](ServiceGetListApi200Response.md) ### Authorization -[ServiceOwnerCredentials](../README.md#ServiceOwnerCredentials) +[Admin](../README.md#Admin), [ViewService](../README.md#ViewService) ### HTTP request headers @@ -286,9 +286,9 @@ Name | Type | Description | Notes ## ServiceUpdateApi -> Service ServiceUpdateApi(ctx, serviceApiKey).Service(service).Execute() +> Service ServiceUpdateApi(ctx, serviceId).Service(service).Execute() -/api/service/update/{serviceApiKey} API +/api/{serviceId}/service/update API @@ -305,12 +305,12 @@ import ( ) func main() { - serviceApiKey := "serviceApiKey_example" // string | The API key of the target service. + serviceId := "serviceId_example" // string | A service ID. service := *openapiclient.NewService() // Service | (optional) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.ServiceManagementApi.ServiceUpdateApi(context.Background(), serviceApiKey).Service(service).Execute() + resp, r, err := apiClient.ServiceManagementApi.ServiceUpdateApi(context.Background(), serviceId).Service(service).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ServiceManagementApi.ServiceUpdateApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -326,7 +326,7 @@ func main() { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**serviceApiKey** | **string** | The API key of the target service. | +**serviceId** | **string** | A service ID. | ### Other Parameters @@ -344,7 +344,7 @@ Name | Type | Description | Notes ### Authorization -[ServiceOwnerCredentials](../README.md#ServiceOwnerCredentials) +[ModifyService](../README.md#ModifyService) ### HTTP request headers diff --git a/docs/TokenBatchStatus.md b/docs/TokenBatchStatus.md new file mode 100644 index 0000000..4b49cf6 --- /dev/null +++ b/docs/TokenBatchStatus.md @@ -0,0 +1,238 @@ +# TokenBatchStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**BatchKind** | Pointer to **string** | The kind of the batch. | [optional] +**RequestId** | Pointer to **string** | The request ID associated with the status. | [optional] +**Result** | Pointer to [**TokenBatchStatusResult**](TokenBatchStatusResult.md) | | [optional] +**TokenCount** | Pointer to **int64** | The number of access tokens processed by the batch. | [optional] +**ErrorCode** | Pointer to **string** | The error code for the batch operation | [optional] +**ErrorDescription** | Pointer to **string** | The error description for the batch operation | [optional] +**CreatedAt** | Pointer to **int64** | The time when this status was created | [optional] +**ModifiedAt** | Pointer to **int64** | The time when this status was modified | [optional] + +## Methods + +### NewTokenBatchStatus + +`func NewTokenBatchStatus() *TokenBatchStatus` + +NewTokenBatchStatus instantiates a new TokenBatchStatus object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewTokenBatchStatusWithDefaults + +`func NewTokenBatchStatusWithDefaults() *TokenBatchStatus` + +NewTokenBatchStatusWithDefaults instantiates a new TokenBatchStatus object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetBatchKind + +`func (o *TokenBatchStatus) GetBatchKind() string` + +GetBatchKind returns the BatchKind field if non-nil, zero value otherwise. + +### GetBatchKindOk + +`func (o *TokenBatchStatus) GetBatchKindOk() (*string, bool)` + +GetBatchKindOk returns a tuple with the BatchKind field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBatchKind + +`func (o *TokenBatchStatus) SetBatchKind(v string)` + +SetBatchKind sets BatchKind field to given value. + +### HasBatchKind + +`func (o *TokenBatchStatus) HasBatchKind() bool` + +HasBatchKind returns a boolean if a field has been set. + +### GetRequestId + +`func (o *TokenBatchStatus) GetRequestId() string` + +GetRequestId returns the RequestId field if non-nil, zero value otherwise. + +### GetRequestIdOk + +`func (o *TokenBatchStatus) GetRequestIdOk() (*string, bool)` + +GetRequestIdOk returns a tuple with the RequestId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestId + +`func (o *TokenBatchStatus) SetRequestId(v string)` + +SetRequestId sets RequestId field to given value. + +### HasRequestId + +`func (o *TokenBatchStatus) HasRequestId() bool` + +HasRequestId returns a boolean if a field has been set. + +### GetResult + +`func (o *TokenBatchStatus) GetResult() TokenBatchStatusResult` + +GetResult returns the Result field if non-nil, zero value otherwise. + +### GetResultOk + +`func (o *TokenBatchStatus) GetResultOk() (*TokenBatchStatusResult, bool)` + +GetResultOk returns a tuple with the Result field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResult + +`func (o *TokenBatchStatus) SetResult(v TokenBatchStatusResult)` + +SetResult sets Result field to given value. + +### HasResult + +`func (o *TokenBatchStatus) HasResult() bool` + +HasResult returns a boolean if a field has been set. + +### GetTokenCount + +`func (o *TokenBatchStatus) GetTokenCount() int64` + +GetTokenCount returns the TokenCount field if non-nil, zero value otherwise. + +### GetTokenCountOk + +`func (o *TokenBatchStatus) GetTokenCountOk() (*int64, bool)` + +GetTokenCountOk returns a tuple with the TokenCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTokenCount + +`func (o *TokenBatchStatus) SetTokenCount(v int64)` + +SetTokenCount sets TokenCount field to given value. + +### HasTokenCount + +`func (o *TokenBatchStatus) HasTokenCount() bool` + +HasTokenCount returns a boolean if a field has been set. + +### GetErrorCode + +`func (o *TokenBatchStatus) GetErrorCode() string` + +GetErrorCode returns the ErrorCode field if non-nil, zero value otherwise. + +### GetErrorCodeOk + +`func (o *TokenBatchStatus) GetErrorCodeOk() (*string, bool)` + +GetErrorCodeOk returns a tuple with the ErrorCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorCode + +`func (o *TokenBatchStatus) SetErrorCode(v string)` + +SetErrorCode sets ErrorCode field to given value. + +### HasErrorCode + +`func (o *TokenBatchStatus) HasErrorCode() bool` + +HasErrorCode returns a boolean if a field has been set. + +### GetErrorDescription + +`func (o *TokenBatchStatus) GetErrorDescription() string` + +GetErrorDescription returns the ErrorDescription field if non-nil, zero value otherwise. + +### GetErrorDescriptionOk + +`func (o *TokenBatchStatus) GetErrorDescriptionOk() (*string, bool)` + +GetErrorDescriptionOk returns a tuple with the ErrorDescription field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorDescription + +`func (o *TokenBatchStatus) SetErrorDescription(v string)` + +SetErrorDescription sets ErrorDescription field to given value. + +### HasErrorDescription + +`func (o *TokenBatchStatus) HasErrorDescription() bool` + +HasErrorDescription returns a boolean if a field has been set. + +### GetCreatedAt + +`func (o *TokenBatchStatus) GetCreatedAt() int64` + +GetCreatedAt returns the CreatedAt field if non-nil, zero value otherwise. + +### GetCreatedAtOk + +`func (o *TokenBatchStatus) GetCreatedAtOk() (*int64, bool)` + +GetCreatedAtOk returns a tuple with the CreatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedAt + +`func (o *TokenBatchStatus) SetCreatedAt(v int64)` + +SetCreatedAt sets CreatedAt field to given value. + +### HasCreatedAt + +`func (o *TokenBatchStatus) HasCreatedAt() bool` + +HasCreatedAt returns a boolean if a field has been set. + +### GetModifiedAt + +`func (o *TokenBatchStatus) GetModifiedAt() int64` + +GetModifiedAt returns the ModifiedAt field if non-nil, zero value otherwise. + +### GetModifiedAtOk + +`func (o *TokenBatchStatus) GetModifiedAtOk() (*int64, bool)` + +GetModifiedAtOk returns a tuple with the ModifiedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModifiedAt + +`func (o *TokenBatchStatus) SetModifiedAt(v int64)` + +SetModifiedAt sets ModifiedAt field to given value. + +### HasModifiedAt + +`func (o *TokenBatchStatus) HasModifiedAt() bool` + +HasModifiedAt returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/TokenBatchStatusResult.md b/docs/TokenBatchStatusResult.md new file mode 100644 index 0000000..f3e29df --- /dev/null +++ b/docs/TokenBatchStatusResult.md @@ -0,0 +1,13 @@ +# TokenBatchStatusResult + +## Enum + + +* `FAILED` (value: `"FAILED"`) + +* `SUCCEED` (value: `"SUCCEED"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/TokenCreateBatchRequestInner.md b/docs/TokenCreateBatchRequestInner.md new file mode 100644 index 0000000..e4670b2 --- /dev/null +++ b/docs/TokenCreateBatchRequestInner.md @@ -0,0 +1,535 @@ +# TokenCreateBatchRequestInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**GrantType** | [**GrantType**](GrantType.md) | | +**ClientId** | **int64** | The ID of the client application which will be associated with a newly created access token. | +**Subject** | Pointer to **string** | The subject (= unique identifier) of the user who will be associated with a newly created access token. This parameter is required unless the grant type is `CLIENT_CREDENTIALS`. The value must consist of only ASCII characters and its length must not exceed 100. | [optional] +**Scopes** | Pointer to **[]string** | The scopes which will be associated with a newly created access token. Scopes that are not supported by the service cannot be specified and requesting them will cause an error. | [optional] +**AccessTokenDuration** | Pointer to **int64** | The duration of a newly created access token in seconds. If the value is 0, the duration is determined according to the settings of the service. | [optional] +**RefreshTokenDuration** | Pointer to **int64** | The duration of a newly created refresh token in seconds. If the value is 0, the duration is determined according to the settings of the service. A refresh token is not created (1) if the service does not support `REFRESH_TOKEN`, or (2) if the specified grant type is either `IMPLICIT`or `CLIENT_CREDENTIALS`. | [optional] +**Properties** | Pointer to [**[]Property**](Property.md) | Extra properties to associate with a newly created access token. Note that properties parameter is accepted only when the HTTP method of the request is POST and Content-Type of the request is `application/json`, so don't use `GET` method or `application/x-www-form-urlencoded` if you want to specify properties. | [optional] +**ClientIdAliasUsed** | Pointer to **bool** | A boolean request parameter which indicates whether to emulate that the client ID alias is used instead of the original numeric client ID when a new access token is created. This has an effect only on the value of the aud claim in a response from [UserInfo endpoint](https://openid.net/specs/openid-connect-core-1_0.html#UserInfo). When you access the UserInfo endpoint (which is expected to be implemented using Authlete's `/api/auth/userinfo` API and `/api/auth/userinfo/issue` API) with an access token which has been created using Authlete's `/api/auth/token/create/batch` API with this property (`clientIdAliasUsed`) `true`, the client ID alias is used as the value of the aud claim in a response from the UserInfo endpoint. Note that if a client ID alias is not assigned to the client when Authlete's `/api/auth/token/create/batch` API is called, this property (`clientIdAliasUsed`) has no effect (it is always regarded as `false`). | [optional] +**AccessToken** | **string** | The value of the new access token. you must specify the value of a newly created access token by passing a non-null value as the value of accessToken request parameter. | +**RefreshToken** | Pointer to **string** | The value of the new refresh token. This is required under some conditions such as when the service supports the refresh token flow. | [optional] +**AccessTokenPersistent** | Pointer to **bool** | Get whether the access token expires or not. By default, all access tokens expire after a period of time determined by their service. If this request parameter is `true`, then the access token will not automatically expire and must be revoked or deleted manually at the service. If this request parameter is true, the `accessTokenDuration` request parameter is ignored. | [optional] +**CertificateThumbprint** | Pointer to **string** | The thumbprint of the MTLS certificate bound to this token. If this property is set, a certificate with the corresponding value MUST be presented with the access token when it is used by a client. The value of this property must be a SHA256 certificate thumbprint, base64url encoded. | [optional] +**DpopKeyThumbprint** | Pointer to **string** | The thumbprint of the public key used for DPoP presentation of this token. If this property is set, a DPoP proof signed with the corresponding private key MUST be presented with the access token when it is used by a client. Additionally, the token's `token_type` will be set to 'DPoP'. | [optional] +**AuthorizationDetails** | Pointer to [**AuthzDetails**](AuthzDetails.md) | | [optional] +**Resources** | Pointer to **[]string** | The value of the resources to associate with the token. This property represents the value of one or more `resource` request parameters which is defined in \"RFC8707 Resource Indicators for OAuth 2.0\". | [optional] +**ForExternalAttachment** | Pointer to **bool** | the flag which indicates whether the access token is for an external attachment. | [optional] +**JwtAtClaims** | Pointer to **string** | Additional claims that are added to the payload part of the JWT access token. | [optional] +**Acr** | Pointer to **string** | The Authentication Context Class Reference of the user authentication that the authorization server performed during the course of issuing the access token. | [optional] +**AuthTime** | Pointer to **int64** | The time when the user authentication was performed during the course of issuing the access token. | [optional] +**ClientEntityIdUsed** | Pointer to **bool** | Flag which indicates whether the entity ID of the client was used when the request for the access token was made. | [optional] + +## Methods + +### NewTokenCreateBatchRequestInner + +`func NewTokenCreateBatchRequestInner(grantType GrantType, clientId int64, accessToken string, ) *TokenCreateBatchRequestInner` + +NewTokenCreateBatchRequestInner instantiates a new TokenCreateBatchRequestInner object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewTokenCreateBatchRequestInnerWithDefaults + +`func NewTokenCreateBatchRequestInnerWithDefaults() *TokenCreateBatchRequestInner` + +NewTokenCreateBatchRequestInnerWithDefaults instantiates a new TokenCreateBatchRequestInner object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetGrantType + +`func (o *TokenCreateBatchRequestInner) GetGrantType() GrantType` + +GetGrantType returns the GrantType field if non-nil, zero value otherwise. + +### GetGrantTypeOk + +`func (o *TokenCreateBatchRequestInner) GetGrantTypeOk() (*GrantType, bool)` + +GetGrantTypeOk returns a tuple with the GrantType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGrantType + +`func (o *TokenCreateBatchRequestInner) SetGrantType(v GrantType)` + +SetGrantType sets GrantType field to given value. + + +### GetClientId + +`func (o *TokenCreateBatchRequestInner) GetClientId() int64` + +GetClientId returns the ClientId field if non-nil, zero value otherwise. + +### GetClientIdOk + +`func (o *TokenCreateBatchRequestInner) GetClientIdOk() (*int64, bool)` + +GetClientIdOk returns a tuple with the ClientId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientId + +`func (o *TokenCreateBatchRequestInner) SetClientId(v int64)` + +SetClientId sets ClientId field to given value. + + +### GetSubject + +`func (o *TokenCreateBatchRequestInner) GetSubject() string` + +GetSubject returns the Subject field if non-nil, zero value otherwise. + +### GetSubjectOk + +`func (o *TokenCreateBatchRequestInner) GetSubjectOk() (*string, bool)` + +GetSubjectOk returns a tuple with the Subject field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSubject + +`func (o *TokenCreateBatchRequestInner) SetSubject(v string)` + +SetSubject sets Subject field to given value. + +### HasSubject + +`func (o *TokenCreateBatchRequestInner) HasSubject() bool` + +HasSubject returns a boolean if a field has been set. + +### GetScopes + +`func (o *TokenCreateBatchRequestInner) GetScopes() []string` + +GetScopes returns the Scopes field if non-nil, zero value otherwise. + +### GetScopesOk + +`func (o *TokenCreateBatchRequestInner) GetScopesOk() (*[]string, bool)` + +GetScopesOk returns a tuple with the Scopes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScopes + +`func (o *TokenCreateBatchRequestInner) SetScopes(v []string)` + +SetScopes sets Scopes field to given value. + +### HasScopes + +`func (o *TokenCreateBatchRequestInner) HasScopes() bool` + +HasScopes returns a boolean if a field has been set. + +### GetAccessTokenDuration + +`func (o *TokenCreateBatchRequestInner) GetAccessTokenDuration() int64` + +GetAccessTokenDuration returns the AccessTokenDuration field if non-nil, zero value otherwise. + +### GetAccessTokenDurationOk + +`func (o *TokenCreateBatchRequestInner) GetAccessTokenDurationOk() (*int64, bool)` + +GetAccessTokenDurationOk returns a tuple with the AccessTokenDuration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessTokenDuration + +`func (o *TokenCreateBatchRequestInner) SetAccessTokenDuration(v int64)` + +SetAccessTokenDuration sets AccessTokenDuration field to given value. + +### HasAccessTokenDuration + +`func (o *TokenCreateBatchRequestInner) HasAccessTokenDuration() bool` + +HasAccessTokenDuration returns a boolean if a field has been set. + +### GetRefreshTokenDuration + +`func (o *TokenCreateBatchRequestInner) GetRefreshTokenDuration() int64` + +GetRefreshTokenDuration returns the RefreshTokenDuration field if non-nil, zero value otherwise. + +### GetRefreshTokenDurationOk + +`func (o *TokenCreateBatchRequestInner) GetRefreshTokenDurationOk() (*int64, bool)` + +GetRefreshTokenDurationOk returns a tuple with the RefreshTokenDuration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRefreshTokenDuration + +`func (o *TokenCreateBatchRequestInner) SetRefreshTokenDuration(v int64)` + +SetRefreshTokenDuration sets RefreshTokenDuration field to given value. + +### HasRefreshTokenDuration + +`func (o *TokenCreateBatchRequestInner) HasRefreshTokenDuration() bool` + +HasRefreshTokenDuration returns a boolean if a field has been set. + +### GetProperties + +`func (o *TokenCreateBatchRequestInner) GetProperties() []Property` + +GetProperties returns the Properties field if non-nil, zero value otherwise. + +### GetPropertiesOk + +`func (o *TokenCreateBatchRequestInner) GetPropertiesOk() (*[]Property, bool)` + +GetPropertiesOk returns a tuple with the Properties field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProperties + +`func (o *TokenCreateBatchRequestInner) SetProperties(v []Property)` + +SetProperties sets Properties field to given value. + +### HasProperties + +`func (o *TokenCreateBatchRequestInner) HasProperties() bool` + +HasProperties returns a boolean if a field has been set. + +### GetClientIdAliasUsed + +`func (o *TokenCreateBatchRequestInner) GetClientIdAliasUsed() bool` + +GetClientIdAliasUsed returns the ClientIdAliasUsed field if non-nil, zero value otherwise. + +### GetClientIdAliasUsedOk + +`func (o *TokenCreateBatchRequestInner) GetClientIdAliasUsedOk() (*bool, bool)` + +GetClientIdAliasUsedOk returns a tuple with the ClientIdAliasUsed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientIdAliasUsed + +`func (o *TokenCreateBatchRequestInner) SetClientIdAliasUsed(v bool)` + +SetClientIdAliasUsed sets ClientIdAliasUsed field to given value. + +### HasClientIdAliasUsed + +`func (o *TokenCreateBatchRequestInner) HasClientIdAliasUsed() bool` + +HasClientIdAliasUsed returns a boolean if a field has been set. + +### GetAccessToken + +`func (o *TokenCreateBatchRequestInner) GetAccessToken() string` + +GetAccessToken returns the AccessToken field if non-nil, zero value otherwise. + +### GetAccessTokenOk + +`func (o *TokenCreateBatchRequestInner) GetAccessTokenOk() (*string, bool)` + +GetAccessTokenOk returns a tuple with the AccessToken field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessToken + +`func (o *TokenCreateBatchRequestInner) SetAccessToken(v string)` + +SetAccessToken sets AccessToken field to given value. + + +### GetRefreshToken + +`func (o *TokenCreateBatchRequestInner) GetRefreshToken() string` + +GetRefreshToken returns the RefreshToken field if non-nil, zero value otherwise. + +### GetRefreshTokenOk + +`func (o *TokenCreateBatchRequestInner) GetRefreshTokenOk() (*string, bool)` + +GetRefreshTokenOk returns a tuple with the RefreshToken field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRefreshToken + +`func (o *TokenCreateBatchRequestInner) SetRefreshToken(v string)` + +SetRefreshToken sets RefreshToken field to given value. + +### HasRefreshToken + +`func (o *TokenCreateBatchRequestInner) HasRefreshToken() bool` + +HasRefreshToken returns a boolean if a field has been set. + +### GetAccessTokenPersistent + +`func (o *TokenCreateBatchRequestInner) GetAccessTokenPersistent() bool` + +GetAccessTokenPersistent returns the AccessTokenPersistent field if non-nil, zero value otherwise. + +### GetAccessTokenPersistentOk + +`func (o *TokenCreateBatchRequestInner) GetAccessTokenPersistentOk() (*bool, bool)` + +GetAccessTokenPersistentOk returns a tuple with the AccessTokenPersistent field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessTokenPersistent + +`func (o *TokenCreateBatchRequestInner) SetAccessTokenPersistent(v bool)` + +SetAccessTokenPersistent sets AccessTokenPersistent field to given value. + +### HasAccessTokenPersistent + +`func (o *TokenCreateBatchRequestInner) HasAccessTokenPersistent() bool` + +HasAccessTokenPersistent returns a boolean if a field has been set. + +### GetCertificateThumbprint + +`func (o *TokenCreateBatchRequestInner) GetCertificateThumbprint() string` + +GetCertificateThumbprint returns the CertificateThumbprint field if non-nil, zero value otherwise. + +### GetCertificateThumbprintOk + +`func (o *TokenCreateBatchRequestInner) GetCertificateThumbprintOk() (*string, bool)` + +GetCertificateThumbprintOk returns a tuple with the CertificateThumbprint field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCertificateThumbprint + +`func (o *TokenCreateBatchRequestInner) SetCertificateThumbprint(v string)` + +SetCertificateThumbprint sets CertificateThumbprint field to given value. + +### HasCertificateThumbprint + +`func (o *TokenCreateBatchRequestInner) HasCertificateThumbprint() bool` + +HasCertificateThumbprint returns a boolean if a field has been set. + +### GetDpopKeyThumbprint + +`func (o *TokenCreateBatchRequestInner) GetDpopKeyThumbprint() string` + +GetDpopKeyThumbprint returns the DpopKeyThumbprint field if non-nil, zero value otherwise. + +### GetDpopKeyThumbprintOk + +`func (o *TokenCreateBatchRequestInner) GetDpopKeyThumbprintOk() (*string, bool)` + +GetDpopKeyThumbprintOk returns a tuple with the DpopKeyThumbprint field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDpopKeyThumbprint + +`func (o *TokenCreateBatchRequestInner) SetDpopKeyThumbprint(v string)` + +SetDpopKeyThumbprint sets DpopKeyThumbprint field to given value. + +### HasDpopKeyThumbprint + +`func (o *TokenCreateBatchRequestInner) HasDpopKeyThumbprint() bool` + +HasDpopKeyThumbprint returns a boolean if a field has been set. + +### GetAuthorizationDetails + +`func (o *TokenCreateBatchRequestInner) GetAuthorizationDetails() AuthzDetails` + +GetAuthorizationDetails returns the AuthorizationDetails field if non-nil, zero value otherwise. + +### GetAuthorizationDetailsOk + +`func (o *TokenCreateBatchRequestInner) GetAuthorizationDetailsOk() (*AuthzDetails, bool)` + +GetAuthorizationDetailsOk returns a tuple with the AuthorizationDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthorizationDetails + +`func (o *TokenCreateBatchRequestInner) SetAuthorizationDetails(v AuthzDetails)` + +SetAuthorizationDetails sets AuthorizationDetails field to given value. + +### HasAuthorizationDetails + +`func (o *TokenCreateBatchRequestInner) HasAuthorizationDetails() bool` + +HasAuthorizationDetails returns a boolean if a field has been set. + +### GetResources + +`func (o *TokenCreateBatchRequestInner) GetResources() []string` + +GetResources returns the Resources field if non-nil, zero value otherwise. + +### GetResourcesOk + +`func (o *TokenCreateBatchRequestInner) GetResourcesOk() (*[]string, bool)` + +GetResourcesOk returns a tuple with the Resources field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResources + +`func (o *TokenCreateBatchRequestInner) SetResources(v []string)` + +SetResources sets Resources field to given value. + +### HasResources + +`func (o *TokenCreateBatchRequestInner) HasResources() bool` + +HasResources returns a boolean if a field has been set. + +### GetForExternalAttachment + +`func (o *TokenCreateBatchRequestInner) GetForExternalAttachment() bool` + +GetForExternalAttachment returns the ForExternalAttachment field if non-nil, zero value otherwise. + +### GetForExternalAttachmentOk + +`func (o *TokenCreateBatchRequestInner) GetForExternalAttachmentOk() (*bool, bool)` + +GetForExternalAttachmentOk returns a tuple with the ForExternalAttachment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetForExternalAttachment + +`func (o *TokenCreateBatchRequestInner) SetForExternalAttachment(v bool)` + +SetForExternalAttachment sets ForExternalAttachment field to given value. + +### HasForExternalAttachment + +`func (o *TokenCreateBatchRequestInner) HasForExternalAttachment() bool` + +HasForExternalAttachment returns a boolean if a field has been set. + +### GetJwtAtClaims + +`func (o *TokenCreateBatchRequestInner) GetJwtAtClaims() string` + +GetJwtAtClaims returns the JwtAtClaims field if non-nil, zero value otherwise. + +### GetJwtAtClaimsOk + +`func (o *TokenCreateBatchRequestInner) GetJwtAtClaimsOk() (*string, bool)` + +GetJwtAtClaimsOk returns a tuple with the JwtAtClaims field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetJwtAtClaims + +`func (o *TokenCreateBatchRequestInner) SetJwtAtClaims(v string)` + +SetJwtAtClaims sets JwtAtClaims field to given value. + +### HasJwtAtClaims + +`func (o *TokenCreateBatchRequestInner) HasJwtAtClaims() bool` + +HasJwtAtClaims returns a boolean if a field has been set. + +### GetAcr + +`func (o *TokenCreateBatchRequestInner) GetAcr() string` + +GetAcr returns the Acr field if non-nil, zero value otherwise. + +### GetAcrOk + +`func (o *TokenCreateBatchRequestInner) GetAcrOk() (*string, bool)` + +GetAcrOk returns a tuple with the Acr field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAcr + +`func (o *TokenCreateBatchRequestInner) SetAcr(v string)` + +SetAcr sets Acr field to given value. + +### HasAcr + +`func (o *TokenCreateBatchRequestInner) HasAcr() bool` + +HasAcr returns a boolean if a field has been set. + +### GetAuthTime + +`func (o *TokenCreateBatchRequestInner) GetAuthTime() int64` + +GetAuthTime returns the AuthTime field if non-nil, zero value otherwise. + +### GetAuthTimeOk + +`func (o *TokenCreateBatchRequestInner) GetAuthTimeOk() (*int64, bool)` + +GetAuthTimeOk returns a tuple with the AuthTime field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthTime + +`func (o *TokenCreateBatchRequestInner) SetAuthTime(v int64)` + +SetAuthTime sets AuthTime field to given value. + +### HasAuthTime + +`func (o *TokenCreateBatchRequestInner) HasAuthTime() bool` + +HasAuthTime returns a boolean if a field has been set. + +### GetClientEntityIdUsed + +`func (o *TokenCreateBatchRequestInner) GetClientEntityIdUsed() bool` + +GetClientEntityIdUsed returns the ClientEntityIdUsed field if non-nil, zero value otherwise. + +### GetClientEntityIdUsedOk + +`func (o *TokenCreateBatchRequestInner) GetClientEntityIdUsedOk() (*bool, bool)` + +GetClientEntityIdUsedOk returns a tuple with the ClientEntityIdUsed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientEntityIdUsed + +`func (o *TokenCreateBatchRequestInner) SetClientEntityIdUsed(v bool)` + +SetClientEntityIdUsed sets ClientEntityIdUsed field to given value. + +### HasClientEntityIdUsed + +`func (o *TokenCreateBatchRequestInner) HasClientEntityIdUsed() bool` + +HasClientEntityIdUsed returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/TokenCreateBatchResponse.md b/docs/TokenCreateBatchResponse.md new file mode 100644 index 0000000..f36fa24 --- /dev/null +++ b/docs/TokenCreateBatchResponse.md @@ -0,0 +1,108 @@ +# TokenCreateBatchResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ResultCode** | Pointer to **string** | The code which represents the result of the API call. | [optional] +**ResultMessage** | Pointer to **string** | A short message which explains the result of the API call. | [optional] +**RequestId** | Pointer to **string** | The ID for the requested batch operation. | [optional] + +## Methods + +### NewTokenCreateBatchResponse + +`func NewTokenCreateBatchResponse() *TokenCreateBatchResponse` + +NewTokenCreateBatchResponse instantiates a new TokenCreateBatchResponse object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewTokenCreateBatchResponseWithDefaults + +`func NewTokenCreateBatchResponseWithDefaults() *TokenCreateBatchResponse` + +NewTokenCreateBatchResponseWithDefaults instantiates a new TokenCreateBatchResponse object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetResultCode + +`func (o *TokenCreateBatchResponse) GetResultCode() string` + +GetResultCode returns the ResultCode field if non-nil, zero value otherwise. + +### GetResultCodeOk + +`func (o *TokenCreateBatchResponse) GetResultCodeOk() (*string, bool)` + +GetResultCodeOk returns a tuple with the ResultCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResultCode + +`func (o *TokenCreateBatchResponse) SetResultCode(v string)` + +SetResultCode sets ResultCode field to given value. + +### HasResultCode + +`func (o *TokenCreateBatchResponse) HasResultCode() bool` + +HasResultCode returns a boolean if a field has been set. + +### GetResultMessage + +`func (o *TokenCreateBatchResponse) GetResultMessage() string` + +GetResultMessage returns the ResultMessage field if non-nil, zero value otherwise. + +### GetResultMessageOk + +`func (o *TokenCreateBatchResponse) GetResultMessageOk() (*string, bool)` + +GetResultMessageOk returns a tuple with the ResultMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResultMessage + +`func (o *TokenCreateBatchResponse) SetResultMessage(v string)` + +SetResultMessage sets ResultMessage field to given value. + +### HasResultMessage + +`func (o *TokenCreateBatchResponse) HasResultMessage() bool` + +HasResultMessage returns a boolean if a field has been set. + +### GetRequestId + +`func (o *TokenCreateBatchResponse) GetRequestId() string` + +GetRequestId returns the RequestId field if non-nil, zero value otherwise. + +### GetRequestIdOk + +`func (o *TokenCreateBatchResponse) GetRequestIdOk() (*string, bool)` + +GetRequestIdOk returns a tuple with the RequestId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestId + +`func (o *TokenCreateBatchResponse) SetRequestId(v string)` + +SetRequestId sets RequestId field to given value. + +### HasRequestId + +`func (o *TokenCreateBatchResponse) HasRequestId() bool` + +HasRequestId returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/TokenCreateBatchStatusResponse.md b/docs/TokenCreateBatchStatusResponse.md new file mode 100644 index 0000000..5ba8d85 --- /dev/null +++ b/docs/TokenCreateBatchStatusResponse.md @@ -0,0 +1,108 @@ +# TokenCreateBatchStatusResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ResultCode** | Pointer to **string** | The code which represents the result of the API call. | [optional] +**ResultMessage** | Pointer to **string** | A short message which explains the result of the API call. | [optional] +**Status** | Pointer to [**TokenBatchStatus**](TokenBatchStatus.md) | | [optional] + +## Methods + +### NewTokenCreateBatchStatusResponse + +`func NewTokenCreateBatchStatusResponse() *TokenCreateBatchStatusResponse` + +NewTokenCreateBatchStatusResponse instantiates a new TokenCreateBatchStatusResponse object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewTokenCreateBatchStatusResponseWithDefaults + +`func NewTokenCreateBatchStatusResponseWithDefaults() *TokenCreateBatchStatusResponse` + +NewTokenCreateBatchStatusResponseWithDefaults instantiates a new TokenCreateBatchStatusResponse object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetResultCode + +`func (o *TokenCreateBatchStatusResponse) GetResultCode() string` + +GetResultCode returns the ResultCode field if non-nil, zero value otherwise. + +### GetResultCodeOk + +`func (o *TokenCreateBatchStatusResponse) GetResultCodeOk() (*string, bool)` + +GetResultCodeOk returns a tuple with the ResultCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResultCode + +`func (o *TokenCreateBatchStatusResponse) SetResultCode(v string)` + +SetResultCode sets ResultCode field to given value. + +### HasResultCode + +`func (o *TokenCreateBatchStatusResponse) HasResultCode() bool` + +HasResultCode returns a boolean if a field has been set. + +### GetResultMessage + +`func (o *TokenCreateBatchStatusResponse) GetResultMessage() string` + +GetResultMessage returns the ResultMessage field if non-nil, zero value otherwise. + +### GetResultMessageOk + +`func (o *TokenCreateBatchStatusResponse) GetResultMessageOk() (*string, bool)` + +GetResultMessageOk returns a tuple with the ResultMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResultMessage + +`func (o *TokenCreateBatchStatusResponse) SetResultMessage(v string)` + +SetResultMessage sets ResultMessage field to given value. + +### HasResultMessage + +`func (o *TokenCreateBatchStatusResponse) HasResultMessage() bool` + +HasResultMessage returns a boolean if a field has been set. + +### GetStatus + +`func (o *TokenCreateBatchStatusResponse) GetStatus() TokenBatchStatus` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *TokenCreateBatchStatusResponse) GetStatusOk() (*TokenBatchStatus, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *TokenCreateBatchStatusResponse) SetStatus(v TokenBatchStatus)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *TokenCreateBatchStatusResponse) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/TokenCreateResponse.md b/docs/TokenCreateResponse.md index a41c08c..e3c7c33 100644 --- a/docs/TokenCreateResponse.md +++ b/docs/TokenCreateResponse.md @@ -19,7 +19,9 @@ Name | Type | Description | Notes **TokenType** | Pointer to **string** | The token type of the access token. | [optional] **JwtAccessToken** | Pointer to **string** | If the authorization server is configured to issue JWT-based access tokens (= if `Service.accessTokenSignAlg` is set to a `non-null` value), a JWT-based access token is issued along with the original random-string one. | [optional] **AuthorizationDetails** | Pointer to [**AuthzDetails**](AuthzDetails.md) | | [optional] -**ForExternalAttachment** | Pointer to **bool** | the flag which indicates whether the access token is for an external attachment. | [optional] +**ForExternalAttachment** | Pointer to **bool** | the flag which indicates whether the access token is for an external attachment. | [optional] +**TokenId** | Pointer to **string** | Set the unique token identifier. | [optional] +**RefreshTokenScopes** | Pointer to **[]string** | The scopes associated with the refresh token. May be null. | [optional] ## Methods @@ -440,6 +442,56 @@ SetForExternalAttachment sets ForExternalAttachment field to given value. HasForExternalAttachment returns a boolean if a field has been set. +### GetTokenId + +`func (o *TokenCreateResponse) GetTokenId() string` + +GetTokenId returns the TokenId field if non-nil, zero value otherwise. + +### GetTokenIdOk + +`func (o *TokenCreateResponse) GetTokenIdOk() (*string, bool)` + +GetTokenIdOk returns a tuple with the TokenId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTokenId + +`func (o *TokenCreateResponse) SetTokenId(v string)` + +SetTokenId sets TokenId field to given value. + +### HasTokenId + +`func (o *TokenCreateResponse) HasTokenId() bool` + +HasTokenId returns a boolean if a field has been set. + +### GetRefreshTokenScopes + +`func (o *TokenCreateResponse) GetRefreshTokenScopes() []string` + +GetRefreshTokenScopes returns the RefreshTokenScopes field if non-nil, zero value otherwise. + +### GetRefreshTokenScopesOk + +`func (o *TokenCreateResponse) GetRefreshTokenScopesOk() (*[]string, bool)` + +GetRefreshTokenScopesOk returns a tuple with the RefreshTokenScopes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRefreshTokenScopes + +`func (o *TokenCreateResponse) SetRefreshTokenScopes(v []string)` + +SetRefreshTokenScopes sets RefreshTokenScopes field to given value. + +### HasRefreshTokenScopes + +`func (o *TokenCreateResponse) HasRefreshTokenScopes() bool` + +HasRefreshTokenScopes returns a boolean if a field has been set. + [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TokenEndpointApi.md b/docs/TokenEndpointApi.md index b4f5132..933e9d6 100644 --- a/docs/TokenEndpointApi.md +++ b/docs/TokenEndpointApi.md @@ -1,20 +1,21 @@ # \TokenEndpointApi -All URIs are relative to *https://api.authlete.com* +All URIs are relative to *https://beta.authlete.com* Method | HTTP request | Description ------------- | ------------- | ------------- -[**AuthTokenApi**](TokenEndpointApi.md#AuthTokenApi) | **Post** /api/auth/token | /api/auth/token API -[**AuthTokenFailApi**](TokenEndpointApi.md#AuthTokenFailApi) | **Post** /api/auth/token/fail | /api/auth/token/fail API -[**AuthTokenIssueApi**](TokenEndpointApi.md#AuthTokenIssueApi) | **Post** /api/auth/token/issue | /api/auth/token/issue API +[**AuthTokenApi**](TokenEndpointApi.md#AuthTokenApi) | **Post** /api/{serviceId}/auth/token | /api/{serviceId}/auth/token API +[**AuthTokenFailApi**](TokenEndpointApi.md#AuthTokenFailApi) | **Post** /api/{serviceId}/auth/token/fail | /api/{serviceId}/auth/token/fail API +[**AuthTokenIssueApi**](TokenEndpointApi.md#AuthTokenIssueApi) | **Post** /api/{serviceId}/auth/token/issue | /api/{serviceId}/auth/token/issue API +[**IdtokenReissueApi**](TokenEndpointApi.md#IdtokenReissueApi) | **Post** /api/{serviceId}/idtoken/reissue | /api/{serviceId}/idtoken/reissue API ## AuthTokenApi -> TokenResponse AuthTokenApi(ctx).TokenRequest(tokenRequest).Execute() +> TokenResponse AuthTokenApi(ctx, serviceId).TokenRequest(tokenRequest).Execute() -/api/auth/token API +/api/{serviceId}/auth/token API @@ -31,11 +32,12 @@ import ( ) func main() { + serviceId := "serviceId_example" // string | A service ID. tokenRequest := *openapiclient.NewTokenRequest("Parameters_example") // TokenRequest | configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.TokenEndpointApi.AuthTokenApi(context.Background()).TokenRequest(tokenRequest).Execute() + resp, r, err := apiClient.TokenEndpointApi.AuthTokenApi(context.Background(), serviceId).TokenRequest(tokenRequest).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `TokenEndpointApi.AuthTokenApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -48,6 +50,10 @@ func main() { ### Path Parameters +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | ### Other Parameters @@ -56,6 +62,7 @@ Other parameters are passed through a pointer to a apiAuthTokenApiRequest struct Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **tokenRequest** | [**TokenRequest**](TokenRequest.md) | | ### Return type @@ -64,7 +71,7 @@ Name | Type | Description | Notes ### Authorization -[ServiceCredentials](../README.md#ServiceCredentials) +[UseService](../README.md#UseService) ### HTTP request headers @@ -78,9 +85,9 @@ Name | Type | Description | Notes ## AuthTokenFailApi -> TokenFailResponse AuthTokenFailApi(ctx).TokenFailRequest(tokenFailRequest).Execute() +> TokenFailResponse AuthTokenFailApi(ctx, serviceId).TokenFailRequest(tokenFailRequest).Execute() -/api/auth/token/fail API +/api/{serviceId}/auth/token/fail API @@ -97,11 +104,12 @@ import ( ) func main() { + serviceId := "serviceId_example" // string | A service ID. tokenFailRequest := *openapiclient.NewTokenFailRequest("Ticket_example", "Reason_example") // TokenFailRequest | configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.TokenEndpointApi.AuthTokenFailApi(context.Background()).TokenFailRequest(tokenFailRequest).Execute() + resp, r, err := apiClient.TokenEndpointApi.AuthTokenFailApi(context.Background(), serviceId).TokenFailRequest(tokenFailRequest).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `TokenEndpointApi.AuthTokenFailApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -114,6 +122,10 @@ func main() { ### Path Parameters +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | ### Other Parameters @@ -122,6 +134,7 @@ Other parameters are passed through a pointer to a apiAuthTokenFailApiRequest st Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **tokenFailRequest** | [**TokenFailRequest**](TokenFailRequest.md) | | ### Return type @@ -130,7 +143,7 @@ Name | Type | Description | Notes ### Authorization -[ServiceCredentials](../README.md#ServiceCredentials) +[UseService](../README.md#UseService) ### HTTP request headers @@ -144,9 +157,9 @@ Name | Type | Description | Notes ## AuthTokenIssueApi -> TokenIssueResponse AuthTokenIssueApi(ctx).TokenIssueRequest(tokenIssueRequest).Execute() +> TokenIssueResponse AuthTokenIssueApi(ctx, serviceId).TokenIssueRequest(tokenIssueRequest).Execute() -/api/auth/token/issue API +/api/{serviceId}/auth/token/issue API @@ -163,11 +176,12 @@ import ( ) func main() { + serviceId := "serviceId_example" // string | A service ID. tokenIssueRequest := *openapiclient.NewTokenIssueRequest("Ticket_example", "Subject_example") // TokenIssueRequest | configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.TokenEndpointApi.AuthTokenIssueApi(context.Background()).TokenIssueRequest(tokenIssueRequest).Execute() + resp, r, err := apiClient.TokenEndpointApi.AuthTokenIssueApi(context.Background(), serviceId).TokenIssueRequest(tokenIssueRequest).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `TokenEndpointApi.AuthTokenIssueApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -180,6 +194,10 @@ func main() { ### Path Parameters +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | ### Other Parameters @@ -188,6 +206,7 @@ Other parameters are passed through a pointer to a apiAuthTokenIssueApiRequest s Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **tokenIssueRequest** | [**TokenIssueRequest**](TokenIssueRequest.md) | | ### Return type @@ -196,7 +215,7 @@ Name | Type | Description | Notes ### Authorization -[ServiceCredentials](../README.md#ServiceCredentials) +[UseService](../README.md#UseService) ### HTTP request headers @@ -207,3 +226,75 @@ Name | Type | Description | Notes [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +## IdtokenReissueApi + +> IdtokenReissueResponse IdtokenReissueApi(ctx, serviceId).IdtokenReissueRequest(idtokenReissueRequest).Execute() + +/api/{serviceId}/idtoken/reissue API + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "./openapi" +) + +func main() { + serviceId := "serviceId_example" // string | A service ID. + idtokenReissueRequest := *openapiclient.NewIdtokenReissueRequest("AccessToken_example", "RefreshToken_example") // IdtokenReissueRequest | (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.TokenEndpointApi.IdtokenReissueApi(context.Background(), serviceId).IdtokenReissueRequest(idtokenReissueRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TokenEndpointApi.IdtokenReissueApi``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `IdtokenReissueApi`: IdtokenReissueResponse + fmt.Fprintf(os.Stdout, "Response from `TokenEndpointApi.IdtokenReissueApi`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiIdtokenReissueApiRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **idtokenReissueRequest** | [**IdtokenReissueRequest**](IdtokenReissueRequest.md) | | + +### Return type + +[**IdtokenReissueResponse**](IdtokenReissueResponse.md) + +### Authorization + +[UseService](../README.md#UseService) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + diff --git a/docs/TokenGetListResponse.md b/docs/TokenGetListResponse.md index 6211367..a55bf67 100644 --- a/docs/TokenGetListResponse.md +++ b/docs/TokenGetListResponse.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **Start** | Pointer to **int32** | Start index of search results (inclusive). | [optional] **End** | Pointer to **int32** | End index of search results (exclusive). | [optional] **TotalCount** | Pointer to **int32** | Unique ID of a client developer. | [optional] -**Client** | Pointer to [**Client**](Client.md) | | [optional] +**Client** | Pointer to [**ClientLimited**](ClientLimited.md) | | [optional] **Subject** | Pointer to **string** | Unique user ID of an end-user. | [optional] **AccessTokens** | Pointer to [**[]AccessToken**](AccessToken.md) | An array of access tokens. | [optional] @@ -107,20 +107,20 @@ HasTotalCount returns a boolean if a field has been set. ### GetClient -`func (o *TokenGetListResponse) GetClient() Client` +`func (o *TokenGetListResponse) GetClient() ClientLimited` GetClient returns the Client field if non-nil, zero value otherwise. ### GetClientOk -`func (o *TokenGetListResponse) GetClientOk() (*Client, bool)` +`func (o *TokenGetListResponse) GetClientOk() (*ClientLimited, bool)` GetClientOk returns a tuple with the Client field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### SetClient -`func (o *TokenGetListResponse) SetClient(v Client)` +`func (o *TokenGetListResponse) SetClient(v ClientLimited)` SetClient sets Client field to given value. diff --git a/docs/TokenIssueResponse.md b/docs/TokenIssueResponse.md index 666ca69..0fd3da4 100644 --- a/docs/TokenIssueResponse.md +++ b/docs/TokenIssueResponse.md @@ -26,7 +26,8 @@ Name | Type | Description | Notes **ServiceAttributes** | Pointer to [**[]Pair**](Pair.md) | The attributes of this service that the client application belongs to. | [optional] **ClientAttributes** | Pointer to [**[]Pair**](Pair.md) | The attributes of the client. | [optional] **ClientEntityId** | Pointer to **string** | The entity ID of the client. | [optional] -**ClientEntityIdUsed** | Pointer to **bool** | Flag which indicates whether the entity ID of the client was used when the request for the access token was made. | [optional] +**ClientEntityIdUsed** | Pointer to **bool** | Flag which indicates whether the entity ID of the client was used when the request for the access token was made. | [optional] +**RefreshTokenScopes** | Pointer to **[]string** | The scopes associated with the refresh token. May be null. | [optional] ## Methods @@ -622,6 +623,31 @@ SetClientEntityIdUsed sets ClientEntityIdUsed field to given value. HasClientEntityIdUsed returns a boolean if a field has been set. +### GetRefreshTokenScopes + +`func (o *TokenIssueResponse) GetRefreshTokenScopes() []string` + +GetRefreshTokenScopes returns the RefreshTokenScopes field if non-nil, zero value otherwise. + +### GetRefreshTokenScopesOk + +`func (o *TokenIssueResponse) GetRefreshTokenScopesOk() (*[]string, bool)` + +GetRefreshTokenScopesOk returns a tuple with the RefreshTokenScopes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRefreshTokenScopes + +`func (o *TokenIssueResponse) SetRefreshTokenScopes(v []string)` + +SetRefreshTokenScopes sets RefreshTokenScopes field to given value. + +### HasRefreshTokenScopes + +`func (o *TokenIssueResponse) HasRefreshTokenScopes() bool` + +HasRefreshTokenScopes returns a boolean if a field has been set. + [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TokenOperationsApi.md b/docs/TokenOperationsApi.md index f4e2315..7ee6227 100644 --- a/docs/TokenOperationsApi.md +++ b/docs/TokenOperationsApi.md @@ -1,22 +1,24 @@ # \TokenOperationsApi -All URIs are relative to *https://api.authlete.com* +All URIs are relative to *https://beta.authlete.com* Method | HTTP request | Description ------------- | ------------- | ------------- -[**AuthTokenCreateApi**](TokenOperationsApi.md#AuthTokenCreateApi) | **Post** /api/auth/token/create | /api/auth/token/create API -[**AuthTokenDeleteApi**](TokenOperationsApi.md#AuthTokenDeleteApi) | **Delete** /api/auth/token/delete/{accessTokenIdentifier} | /api/auth/token/delete API -[**AuthTokenGetListApi**](TokenOperationsApi.md#AuthTokenGetListApi) | **Get** /api/auth/token/get/list | /api/auth/token/get/list API -[**AuthTokenRevokeApi**](TokenOperationsApi.md#AuthTokenRevokeApi) | **Post** /api/auth/token/revoke | /api/auth/token/revoke API -[**AuthTokenUpdateApi**](TokenOperationsApi.md#AuthTokenUpdateApi) | **Post** /api/auth/token/update | /api/auth/token/update API +[**AuthTokenCreateApi**](TokenOperationsApi.md#AuthTokenCreateApi) | **Post** /api/{serviceId}/auth/token/create | /api/{serviceId}/auth/token/create API +[**AuthTokenCreateBatchApi**](TokenOperationsApi.md#AuthTokenCreateBatchApi) | **Post** /api/{serviceId}/auth/token/create/batch | /api/{serviceId}/auth/token/create/batch API +[**AuthTokenCreateBatchStatusApi**](TokenOperationsApi.md#AuthTokenCreateBatchStatusApi) | **Post** /api/{serviceId}/auth/token/create/batch/status/{requestId} | /api/{serviceId}/auth/token/create/batch/status/{requestId} API +[**AuthTokenDeleteApi**](TokenOperationsApi.md#AuthTokenDeleteApi) | **Delete** /api/{serviceId}/auth/token/delete/{accessTokenIdentifier} | /api/{serviceId}/auth/token/delete API +[**AuthTokenGetListApi**](TokenOperationsApi.md#AuthTokenGetListApi) | **Get** /api/{serviceId}/auth/token/get/list | /api/{serviceId}/auth/token/get/list API +[**AuthTokenRevokeApi**](TokenOperationsApi.md#AuthTokenRevokeApi) | **Post** /api/{serviceId}/auth/token/revoke | /api/{serviceId}/auth/token/revoke API +[**AuthTokenUpdateApi**](TokenOperationsApi.md#AuthTokenUpdateApi) | **Post** /api/{serviceId}/auth/token/update | /api/{serviceId}/auth/token/update API ## AuthTokenCreateApi -> TokenCreateResponse AuthTokenCreateApi(ctx).TokenCreateRequest(tokenCreateRequest).Execute() +> TokenCreateResponse AuthTokenCreateApi(ctx, serviceId).TokenCreateRequest(tokenCreateRequest).Execute() -/api/auth/token/create API +/api/{serviceId}/auth/token/create API @@ -33,11 +35,12 @@ import ( ) func main() { + serviceId := "serviceId_example" // string | A service ID. tokenCreateRequest := *openapiclient.NewTokenCreateRequest(openapiclient.grant_type("AUTHORIZATION_CODE"), int64(123)) // TokenCreateRequest | configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.TokenOperationsApi.AuthTokenCreateApi(context.Background()).TokenCreateRequest(tokenCreateRequest).Execute() + resp, r, err := apiClient.TokenOperationsApi.AuthTokenCreateApi(context.Background(), serviceId).TokenCreateRequest(tokenCreateRequest).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `TokenOperationsApi.AuthTokenCreateApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -50,6 +53,10 @@ func main() { ### Path Parameters +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | ### Other Parameters @@ -58,6 +65,7 @@ Other parameters are passed through a pointer to a apiAuthTokenCreateApiRequest Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **tokenCreateRequest** | [**TokenCreateRequest**](TokenCreateRequest.md) | | ### Return type @@ -66,7 +74,7 @@ Name | Type | Description | Notes ### Authorization -[ServiceCredentials](../README.md#ServiceCredentials) +[UseService](../README.md#UseService) ### HTTP request headers @@ -78,11 +86,156 @@ Name | Type | Description | Notes [[Back to README]](../README.md) +## AuthTokenCreateBatchApi + +> TokenCreateBatchResponse AuthTokenCreateBatchApi(ctx, serviceId).TokenCreateBatchRequestInner(tokenCreateBatchRequestInner).Execute() + +/api/{serviceId}/auth/token/create/batch API + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "./openapi" +) + +func main() { + serviceId := "serviceId_example" // string | A service ID. + tokenCreateBatchRequestInner := []openapiclient.TokenCreateBatchRequestInner{*openapiclient.NewTokenCreateBatchRequestInner(openapiclient.grant_type("AUTHORIZATION_CODE"), int64(123), "AccessToken_example")} // []TokenCreateBatchRequestInner | + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.TokenOperationsApi.AuthTokenCreateBatchApi(context.Background(), serviceId).TokenCreateBatchRequestInner(tokenCreateBatchRequestInner).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TokenOperationsApi.AuthTokenCreateBatchApi``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `AuthTokenCreateBatchApi`: TokenCreateBatchResponse + fmt.Fprintf(os.Stdout, "Response from `TokenOperationsApi.AuthTokenCreateBatchApi`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiAuthTokenCreateBatchApiRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **tokenCreateBatchRequestInner** | [**[]TokenCreateBatchRequestInner**](TokenCreateBatchRequestInner.md) | | + +### Return type + +[**TokenCreateBatchResponse**](TokenCreateBatchResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## AuthTokenCreateBatchStatusApi + +> TokenCreateBatchStatusResponse AuthTokenCreateBatchStatusApi(ctx, serviceId, requestId).Execute() + +/api/{serviceId}/auth/token/create/batch/status/{requestId} API + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "./openapi" +) + +func main() { + serviceId := "serviceId_example" // string | A service ID. + requestId := "requestId_example" // string | A request ID. + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.TokenOperationsApi.AuthTokenCreateBatchStatusApi(context.Background(), serviceId, requestId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TokenOperationsApi.AuthTokenCreateBatchStatusApi``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `AuthTokenCreateBatchStatusApi`: TokenCreateBatchStatusResponse + fmt.Fprintf(os.Stdout, "Response from `TokenOperationsApi.AuthTokenCreateBatchStatusApi`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | +**requestId** | **string** | A request ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiAuthTokenCreateBatchStatusApiRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**TokenCreateBatchStatusResponse**](TokenCreateBatchStatusResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + ## AuthTokenDeleteApi -> AuthTokenDeleteApi(ctx, accessTokenIdentifier).Execute() +> AuthTokenDeleteApi(ctx, serviceId, accessTokenIdentifier).Execute() -/api/auth/token/delete API +/api/{serviceId}/auth/token/delete API @@ -99,11 +252,12 @@ import ( ) func main() { + serviceId := "serviceId_example" // string | A service ID. accessTokenIdentifier := "accessTokenIdentifier_example" // string | The identifier of an existing access token. The identifier is the value of the access token or the value of the hash of the access token. configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.TokenOperationsApi.AuthTokenDeleteApi(context.Background(), accessTokenIdentifier).Execute() + resp, r, err := apiClient.TokenOperationsApi.AuthTokenDeleteApi(context.Background(), serviceId, accessTokenIdentifier).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `TokenOperationsApi.AuthTokenDeleteApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -117,6 +271,7 @@ func main() { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | **accessTokenIdentifier** | **string** | The identifier of an existing access token. The identifier is the value of the access token or the value of the hash of the access token. | ### Other Parameters @@ -128,13 +283,14 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + ### Return type (empty response body) ### Authorization -[ServiceCredentials](../README.md#ServiceCredentials) +[UseService](../README.md#UseService) ### HTTP request headers @@ -148,9 +304,9 @@ Name | Type | Description | Notes ## AuthTokenGetListApi -> TokenGetListResponse AuthTokenGetListApi(ctx).ClientIdentifier(clientIdentifier).Subject(subject).Start(start).End(end).Execute() +> TokenGetListResponse AuthTokenGetListApi(ctx, serviceId).ClientIdentifier(clientIdentifier).Subject(subject).Start(start).End(end).Execute() -/api/auth/token/get/list API +/api/{serviceId}/auth/token/get/list API @@ -167,6 +323,7 @@ import ( ) func main() { + serviceId := "serviceId_example" // string | A service ID. clientIdentifier := "clientIdentifier_example" // string | Client Identifier (client ID or client ID alias). (optional) subject := "subject_example" // string | Unique user ID. (optional) start := int32(56) // int32 | Start index of search results (inclusive). The default value is 0. (optional) @@ -174,7 +331,7 @@ func main() { configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.TokenOperationsApi.AuthTokenGetListApi(context.Background()).ClientIdentifier(clientIdentifier).Subject(subject).Start(start).End(end).Execute() + resp, r, err := apiClient.TokenOperationsApi.AuthTokenGetListApi(context.Background(), serviceId).ClientIdentifier(clientIdentifier).Subject(subject).Start(start).End(end).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `TokenOperationsApi.AuthTokenGetListApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -187,6 +344,10 @@ func main() { ### Path Parameters +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | ### Other Parameters @@ -195,6 +356,7 @@ Other parameters are passed through a pointer to a apiAuthTokenGetListApiRequest Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **clientIdentifier** | **string** | Client Identifier (client ID or client ID alias). | **subject** | **string** | Unique user ID. | **start** | **int32** | Start index of search results (inclusive). The default value is 0. | @@ -206,7 +368,7 @@ Name | Type | Description | Notes ### Authorization -[ServiceCredentials](../README.md#ServiceCredentials) +[UseService](../README.md#UseService) ### HTTP request headers @@ -220,9 +382,9 @@ Name | Type | Description | Notes ## AuthTokenRevokeApi -> TokenRevokeResponse AuthTokenRevokeApi(ctx).TokenRevokeRequest(tokenRevokeRequest).Execute() +> TokenRevokeResponse AuthTokenRevokeApi(ctx, serviceId).TokenRevokeRequest(tokenRevokeRequest).Execute() -/api/auth/token/revoke API +/api/{serviceId}/auth/token/revoke API @@ -239,11 +401,12 @@ import ( ) func main() { + serviceId := "serviceId_example" // string | A service ID. tokenRevokeRequest := *openapiclient.NewTokenRevokeRequest() // TokenRevokeRequest | configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.TokenOperationsApi.AuthTokenRevokeApi(context.Background()).TokenRevokeRequest(tokenRevokeRequest).Execute() + resp, r, err := apiClient.TokenOperationsApi.AuthTokenRevokeApi(context.Background(), serviceId).TokenRevokeRequest(tokenRevokeRequest).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `TokenOperationsApi.AuthTokenRevokeApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -256,6 +419,10 @@ func main() { ### Path Parameters +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | ### Other Parameters @@ -264,6 +431,7 @@ Other parameters are passed through a pointer to a apiAuthTokenRevokeApiRequest Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **tokenRevokeRequest** | [**TokenRevokeRequest**](TokenRevokeRequest.md) | | ### Return type @@ -272,7 +440,7 @@ Name | Type | Description | Notes ### Authorization -[ServiceCredentials](../README.md#ServiceCredentials) +[UseService](../README.md#UseService) ### HTTP request headers @@ -286,9 +454,9 @@ Name | Type | Description | Notes ## AuthTokenUpdateApi -> TokenUpdateResponse AuthTokenUpdateApi(ctx).TokenUpdateRequest(tokenUpdateRequest).Execute() +> TokenUpdateResponse AuthTokenUpdateApi(ctx, serviceId).TokenUpdateRequest(tokenUpdateRequest).Execute() -/api/auth/token/update API +/api/{serviceId}/auth/token/update API @@ -305,11 +473,12 @@ import ( ) func main() { + serviceId := "serviceId_example" // string | A service ID. tokenUpdateRequest := *openapiclient.NewTokenUpdateRequest("AccessToken_example") // TokenUpdateRequest | configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.TokenOperationsApi.AuthTokenUpdateApi(context.Background()).TokenUpdateRequest(tokenUpdateRequest).Execute() + resp, r, err := apiClient.TokenOperationsApi.AuthTokenUpdateApi(context.Background(), serviceId).TokenUpdateRequest(tokenUpdateRequest).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `TokenOperationsApi.AuthTokenUpdateApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -322,6 +491,10 @@ func main() { ### Path Parameters +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | ### Other Parameters @@ -330,6 +503,7 @@ Other parameters are passed through a pointer to a apiAuthTokenUpdateApiRequest Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **tokenUpdateRequest** | [**TokenUpdateRequest**](TokenUpdateRequest.md) | | ### Return type @@ -338,7 +512,7 @@ Name | Type | Description | Notes ### Authorization -[ServiceCredentials](../README.md#ServiceCredentials) +[UseService](../README.md#UseService) ### HTTP request headers diff --git a/docs/TokenResponse.md b/docs/TokenResponse.md index 8323b66..de77f5a 100644 --- a/docs/TokenResponse.md +++ b/docs/TokenResponse.md @@ -31,6 +31,7 @@ Name | Type | Description | Notes **AuthorizationDetails** | Pointer to [**AuthzDetails**](AuthzDetails.md) | | [optional] **ServiceAttributes** | Pointer to [**[]Pair**](Pair.md) | The attributes of this service that the client application belongs to. | [optional] **ClientAttributes** | Pointer to [**[]Pair**](Pair.md) | The attributes of the client. | [optional] +**ClientAuthMethod** | Pointer to **string** | The client authentication method that was performed at the token endpoint. | [optional] **GrantId** | Pointer to **string** | the value of the `grant_id` request parameter of the device authorization request. The `grant_id` request parameter is defined in [Grant Management for OAuth 2.0](https://openid.net/specs/fapi-grant-management.html) , which is supported by Authlete 2.3 and newer versions. | [optional] **Audiences** | Pointer to **[]string** | The audiences on the token exchange request | [optional] **RequestedTokenType** | Pointer to [**TokenType**](TokenType.md) | | [optional] @@ -43,7 +44,13 @@ Name | Type | Description | Notes **Assertion** | Pointer to **string** | For RFC 7523 JSON Web Token (JWT) Profile for OAuth 2.0 Client Authentication and Authorization Grants | [optional] **PreviousRefreshTokenUsed** | Pointer to **bool** | Indicate whether the previous refresh token that had been kept in the database for a short time was used | [optional] **ClientEntityId** | Pointer to **string** | The entity ID of the client. | [optional] -**ClientEntityIdUsed** | Pointer to **bool** | Flag which indicates whether the entity ID of the client was used when the request for the access token was made. | [optional] +**ClientEntityIdUsed** | Pointer to **bool** | Flag which indicates whether the entity ID of the client was used when the request for the access token was made. | [optional] +**CnonceDuration** | Pointer to **int64** | Duration of the `c_nonce` in seconds. | [optional] +**DpopNonce** | Pointer to **string** | Get the expected nonce value for DPoP proof JWT, which should be used as the value of the `DPoP-Nonce` HTTP header. | [optional] +**Cnonce** | Pointer to **string** | Get the `c_nonce`. | [optional] +**CnonceExpiresAt** | Pointer to **int64** | Get the time at which the `c_nonce` expires in milliseconds since the Unix epoch (1970-01-01). | [optional] +**RequestedIdTokenClaims** | Pointer to **[]string** | Get the names of the claims that the authorization request (which resulted in generation of the access token) requested to be embedded in ID tokens. | [optional] +**RefreshTokenScopes** | Pointer to **[]string** | Scopes associated with the refresh token. | [optional] ## Methods @@ -739,6 +746,31 @@ SetClientAttributes sets ClientAttributes field to given value. HasClientAttributes returns a boolean if a field has been set. +### GetClientAuthMethod + +`func (o *TokenResponse) GetClientAuthMethod() string` + +GetClientAuthMethod returns the ClientAuthMethod field if non-nil, zero value otherwise. + +### GetClientAuthMethodOk + +`func (o *TokenResponse) GetClientAuthMethodOk() (*string, bool)` + +GetClientAuthMethodOk returns a tuple with the ClientAuthMethod field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientAuthMethod + +`func (o *TokenResponse) SetClientAuthMethod(v string)` + +SetClientAuthMethod sets ClientAuthMethod field to given value. + +### HasClientAuthMethod + +`func (o *TokenResponse) HasClientAuthMethod() bool` + +HasClientAuthMethod returns a boolean if a field has been set. + ### GetGrantId `func (o *TokenResponse) GetGrantId() string` @@ -1064,6 +1096,156 @@ SetClientEntityIdUsed sets ClientEntityIdUsed field to given value. HasClientEntityIdUsed returns a boolean if a field has been set. +### GetCnonceDuration + +`func (o *TokenResponse) GetCnonceDuration() int64` + +GetCnonceDuration returns the CnonceDuration field if non-nil, zero value otherwise. + +### GetCnonceDurationOk + +`func (o *TokenResponse) GetCnonceDurationOk() (*int64, bool)` + +GetCnonceDurationOk returns a tuple with the CnonceDuration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCnonceDuration + +`func (o *TokenResponse) SetCnonceDuration(v int64)` + +SetCnonceDuration sets CnonceDuration field to given value. + +### HasCnonceDuration + +`func (o *TokenResponse) HasCnonceDuration() bool` + +HasCnonceDuration returns a boolean if a field has been set. + +### GetDpopNonce + +`func (o *TokenResponse) GetDpopNonce() string` + +GetDpopNonce returns the DpopNonce field if non-nil, zero value otherwise. + +### GetDpopNonceOk + +`func (o *TokenResponse) GetDpopNonceOk() (*string, bool)` + +GetDpopNonceOk returns a tuple with the DpopNonce field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDpopNonce + +`func (o *TokenResponse) SetDpopNonce(v string)` + +SetDpopNonce sets DpopNonce field to given value. + +### HasDpopNonce + +`func (o *TokenResponse) HasDpopNonce() bool` + +HasDpopNonce returns a boolean if a field has been set. + +### GetCnonce + +`func (o *TokenResponse) GetCnonce() string` + +GetCnonce returns the Cnonce field if non-nil, zero value otherwise. + +### GetCnonceOk + +`func (o *TokenResponse) GetCnonceOk() (*string, bool)` + +GetCnonceOk returns a tuple with the Cnonce field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCnonce + +`func (o *TokenResponse) SetCnonce(v string)` + +SetCnonce sets Cnonce field to given value. + +### HasCnonce + +`func (o *TokenResponse) HasCnonce() bool` + +HasCnonce returns a boolean if a field has been set. + +### GetCnonceExpiresAt + +`func (o *TokenResponse) GetCnonceExpiresAt() int64` + +GetCnonceExpiresAt returns the CnonceExpiresAt field if non-nil, zero value otherwise. + +### GetCnonceExpiresAtOk + +`func (o *TokenResponse) GetCnonceExpiresAtOk() (*int64, bool)` + +GetCnonceExpiresAtOk returns a tuple with the CnonceExpiresAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCnonceExpiresAt + +`func (o *TokenResponse) SetCnonceExpiresAt(v int64)` + +SetCnonceExpiresAt sets CnonceExpiresAt field to given value. + +### HasCnonceExpiresAt + +`func (o *TokenResponse) HasCnonceExpiresAt() bool` + +HasCnonceExpiresAt returns a boolean if a field has been set. + +### GetRequestedIdTokenClaims + +`func (o *TokenResponse) GetRequestedIdTokenClaims() []string` + +GetRequestedIdTokenClaims returns the RequestedIdTokenClaims field if non-nil, zero value otherwise. + +### GetRequestedIdTokenClaimsOk + +`func (o *TokenResponse) GetRequestedIdTokenClaimsOk() (*[]string, bool)` + +GetRequestedIdTokenClaimsOk returns a tuple with the RequestedIdTokenClaims field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedIdTokenClaims + +`func (o *TokenResponse) SetRequestedIdTokenClaims(v []string)` + +SetRequestedIdTokenClaims sets RequestedIdTokenClaims field to given value. + +### HasRequestedIdTokenClaims + +`func (o *TokenResponse) HasRequestedIdTokenClaims() bool` + +HasRequestedIdTokenClaims returns a boolean if a field has been set. + +### GetRefreshTokenScopes + +`func (o *TokenResponse) GetRefreshTokenScopes() []string` + +GetRefreshTokenScopes returns the RefreshTokenScopes field if non-nil, zero value otherwise. + +### GetRefreshTokenScopesOk + +`func (o *TokenResponse) GetRefreshTokenScopesOk() (*[]string, bool)` + +GetRefreshTokenScopesOk returns a tuple with the RefreshTokenScopes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRefreshTokenScopes + +`func (o *TokenResponse) SetRefreshTokenScopes(v []string)` + +SetRefreshTokenScopes sets RefreshTokenScopes field to given value. + +### HasRefreshTokenScopes + +`func (o *TokenResponse) HasRefreshTokenScopes() bool` + +HasRefreshTokenScopes returns a boolean if a field has been set. + [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TokenUpdateResponse.md b/docs/TokenUpdateResponse.md index c69c1f1..569cbd5 100644 --- a/docs/TokenUpdateResponse.md +++ b/docs/TokenUpdateResponse.md @@ -14,7 +14,8 @@ Name | Type | Description | Notes **AuthorizationDetails** | Pointer to [**AuthzDetails**](AuthzDetails.md) | | [optional] **TokenType** | Pointer to **string** | The token type associated with the access token. | [optional] **ForExternalAttachment** | Pointer to **bool** | the flag which indicates whether the access token is for an external attachment. | [optional] -**RefreshTokenExpiresAt** | Pointer to **int64** | The date at which the refresh token will expire. | [optional] +**TokenId** | Pointer to **string** | Set the unique token identifier. | [optional] +**RefreshTokenExpiresAt** | Pointer to **int64** | The datetime at which the newly issued refresh token will expire. The value is represented in milliseconds since the Unix epoch (1970-01-01). | [optional] ## Methods @@ -285,6 +286,31 @@ SetForExternalAttachment sets ForExternalAttachment field to given value. HasForExternalAttachment returns a boolean if a field has been set. +### GetTokenId + +`func (o *TokenUpdateResponse) GetTokenId() string` + +GetTokenId returns the TokenId field if non-nil, zero value otherwise. + +### GetTokenIdOk + +`func (o *TokenUpdateResponse) GetTokenIdOk() (*string, bool)` + +GetTokenIdOk returns a tuple with the TokenId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTokenId + +`func (o *TokenUpdateResponse) SetTokenId(v string)` + +SetTokenId sets TokenId field to given value. + +### HasTokenId + +`func (o *TokenUpdateResponse) HasTokenId() bool` + +HasTokenId returns a boolean if a field has been set. + ### GetRefreshTokenExpiresAt `func (o *TokenUpdateResponse) GetRefreshTokenExpiresAt() int64` diff --git a/docs/UserInfoEndpointApi.md b/docs/UserInfoEndpointApi.md index 32ac813..02ac62c 100644 --- a/docs/UserInfoEndpointApi.md +++ b/docs/UserInfoEndpointApi.md @@ -1,19 +1,19 @@ # \UserInfoEndpointApi -All URIs are relative to *https://api.authlete.com* +All URIs are relative to *https://beta.authlete.com* Method | HTTP request | Description ------------- | ------------- | ------------- -[**AuthUserinfoApi**](UserInfoEndpointApi.md#AuthUserinfoApi) | **Post** /api/auth/userinfo | /api/auth/userinfo API -[**AuthUserinfoIssueApi**](UserInfoEndpointApi.md#AuthUserinfoIssueApi) | **Post** /api/auth/userinfo/issue | /api/auth/userinfo/issue API +[**AuthUserinfoApi**](UserInfoEndpointApi.md#AuthUserinfoApi) | **Post** /api/{serviceId}/auth/userinfo | /api/{serviceId}/auth/userinfo API +[**AuthUserinfoIssueApi**](UserInfoEndpointApi.md#AuthUserinfoIssueApi) | **Post** /api/{serviceId}/auth/userinfo/issue | /api/{serviceId}/auth/userinfo/issue API ## AuthUserinfoApi -> UserinfoResponse AuthUserinfoApi(ctx).UserinfoRequest(userinfoRequest).Execute() +> UserinfoResponse AuthUserinfoApi(ctx, serviceId).UserinfoRequest(userinfoRequest).Execute() -/api/auth/userinfo API +/api/{serviceId}/auth/userinfo API @@ -30,11 +30,12 @@ import ( ) func main() { + serviceId := "serviceId_example" // string | A service ID. userinfoRequest := *openapiclient.NewUserinfoRequest("Token_example") // UserinfoRequest | configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.UserInfoEndpointApi.AuthUserinfoApi(context.Background()).UserinfoRequest(userinfoRequest).Execute() + resp, r, err := apiClient.UserInfoEndpointApi.AuthUserinfoApi(context.Background(), serviceId).UserinfoRequest(userinfoRequest).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `UserInfoEndpointApi.AuthUserinfoApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -47,6 +48,10 @@ func main() { ### Path Parameters +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | ### Other Parameters @@ -55,6 +60,7 @@ Other parameters are passed through a pointer to a apiAuthUserinfoApiRequest str Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **userinfoRequest** | [**UserinfoRequest**](UserinfoRequest.md) | | ### Return type @@ -63,7 +69,7 @@ Name | Type | Description | Notes ### Authorization -[ServiceCredentials](../README.md#ServiceCredentials) +[UseService](../README.md#UseService) ### HTTP request headers @@ -77,9 +83,9 @@ Name | Type | Description | Notes ## AuthUserinfoIssueApi -> UserinfoIssueResponse AuthUserinfoIssueApi(ctx).UserinfoIssueRequest(userinfoIssueRequest).Execute() +> UserinfoIssueResponse AuthUserinfoIssueApi(ctx, serviceId).UserinfoIssueRequest(userinfoIssueRequest).Execute() -/api/auth/userinfo/issue API +/api/{serviceId}/auth/userinfo/issue API @@ -96,11 +102,12 @@ import ( ) func main() { + serviceId := "serviceId_example" // string | A service ID. userinfoIssueRequest := *openapiclient.NewUserinfoIssueRequest("Token_example") // UserinfoIssueRequest | configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.UserInfoEndpointApi.AuthUserinfoIssueApi(context.Background()).UserinfoIssueRequest(userinfoIssueRequest).Execute() + resp, r, err := apiClient.UserInfoEndpointApi.AuthUserinfoIssueApi(context.Background(), serviceId).UserinfoIssueRequest(userinfoIssueRequest).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `UserInfoEndpointApi.AuthUserinfoIssueApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -113,6 +120,10 @@ func main() { ### Path Parameters +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | ### Other Parameters @@ -121,6 +132,7 @@ Other parameters are passed through a pointer to a apiAuthUserinfoIssueApiReques Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **userinfoIssueRequest** | [**UserinfoIssueRequest**](UserinfoIssueRequest.md) | | ### Return type @@ -129,7 +141,7 @@ Name | Type | Description | Notes ### Authorization -[ServiceCredentials](../README.md#ServiceCredentials) +[UseService](../README.md#UseService) ### HTTP request headers diff --git a/docs/UserinfoResponse.md b/docs/UserinfoResponse.md index 28dcb30..cf91b8a 100644 --- a/docs/UserinfoResponse.md +++ b/docs/UserinfoResponse.md @@ -24,7 +24,8 @@ Name | Type | Description | Notes **RequestedVerifiedClaimsForTx** | Pointer to **[][]string** | Names of verified claims that will be referenced when transformed claims are computed. | [optional] **TransformedClaims** | Pointer to **string** | the value of the `transformed_claims` property in the `claims` request parameter of an authorization request or in the `claims` property in a request object. | [optional] **ClientEntityId** | Pointer to **string** | The entity ID of the client. | [optional] -**ClientEntityIdUsed** | Pointer to **bool** | Flag which indicates whether the entity ID of the client was used when the request for the access token was made. | [optional] +**ClientEntityIdUsed** | Pointer to **bool** | Flag which indicates whether the entity ID of the client was used when the request for the access token was made. | [optional] +**DpopNonce** | Pointer to **string** | The expected nonce value for DPoP proof JWT, which should be used as the value of the `DPoP-Nonce` HTTP header. | [optional] ## Methods @@ -570,6 +571,31 @@ SetClientEntityIdUsed sets ClientEntityIdUsed field to given value. HasClientEntityIdUsed returns a boolean if a field has been set. +### GetDpopNonce + +`func (o *UserinfoResponse) GetDpopNonce() string` + +GetDpopNonce returns the DpopNonce field if non-nil, zero value otherwise. + +### GetDpopNonceOk + +`func (o *UserinfoResponse) GetDpopNonceOk() (*string, bool)` + +GetDpopNonceOk returns a tuple with the DpopNonce field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDpopNonce + +`func (o *UserinfoResponse) SetDpopNonce(v string)` + +SetDpopNonce sets DpopNonce field to given value. + +### HasDpopNonce + +`func (o *UserinfoResponse) HasDpopNonce() bool` + +HasDpopNonce returns a boolean if a field has been set. + [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/VciBatchIssueRequest.md b/docs/VciBatchIssueRequest.md new file mode 100644 index 0000000..81d5c3b --- /dev/null +++ b/docs/VciBatchIssueRequest.md @@ -0,0 +1,82 @@ +# VciBatchIssueRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessToken** | Pointer to **string** | The access token that came along with the credential request. | [optional] +**Orders** | Pointer to [**[]CredentialIssuanceOrder**](CredentialIssuanceOrder.md) | The instructions for issuance of credentials and/or transaction IDs. | [optional] + +## Methods + +### NewVciBatchIssueRequest + +`func NewVciBatchIssueRequest() *VciBatchIssueRequest` + +NewVciBatchIssueRequest instantiates a new VciBatchIssueRequest object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewVciBatchIssueRequestWithDefaults + +`func NewVciBatchIssueRequestWithDefaults() *VciBatchIssueRequest` + +NewVciBatchIssueRequestWithDefaults instantiates a new VciBatchIssueRequest object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAccessToken + +`func (o *VciBatchIssueRequest) GetAccessToken() string` + +GetAccessToken returns the AccessToken field if non-nil, zero value otherwise. + +### GetAccessTokenOk + +`func (o *VciBatchIssueRequest) GetAccessTokenOk() (*string, bool)` + +GetAccessTokenOk returns a tuple with the AccessToken field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessToken + +`func (o *VciBatchIssueRequest) SetAccessToken(v string)` + +SetAccessToken sets AccessToken field to given value. + +### HasAccessToken + +`func (o *VciBatchIssueRequest) HasAccessToken() bool` + +HasAccessToken returns a boolean if a field has been set. + +### GetOrders + +`func (o *VciBatchIssueRequest) GetOrders() []CredentialIssuanceOrder` + +GetOrders returns the Orders field if non-nil, zero value otherwise. + +### GetOrdersOk + +`func (o *VciBatchIssueRequest) GetOrdersOk() (*[]CredentialIssuanceOrder, bool)` + +GetOrdersOk returns a tuple with the Orders field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrders + +`func (o *VciBatchIssueRequest) SetOrders(v []CredentialIssuanceOrder)` + +SetOrders sets Orders field to given value. + +### HasOrders + +`func (o *VciBatchIssueRequest) HasOrders() bool` + +HasOrders returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/VciBatchIssueResponse.md b/docs/VciBatchIssueResponse.md new file mode 100644 index 0000000..900d2fe --- /dev/null +++ b/docs/VciBatchIssueResponse.md @@ -0,0 +1,134 @@ +# VciBatchIssueResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ResultCode** | Pointer to **string** | The code which represents the result of the API call. | [optional] +**ResultMessage** | Pointer to **string** | A short message which explains the result of the API call. | [optional] +**Action** | Pointer to **string** | The next action that the implementation of the batch credential endpoint should take. | [optional] +**ResponseContent** | Pointer to **string** | The content of the response that the implementation of the batch credential endpoint should return. | [optional] + +## Methods + +### NewVciBatchIssueResponse + +`func NewVciBatchIssueResponse() *VciBatchIssueResponse` + +NewVciBatchIssueResponse instantiates a new VciBatchIssueResponse object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewVciBatchIssueResponseWithDefaults + +`func NewVciBatchIssueResponseWithDefaults() *VciBatchIssueResponse` + +NewVciBatchIssueResponseWithDefaults instantiates a new VciBatchIssueResponse object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetResultCode + +`func (o *VciBatchIssueResponse) GetResultCode() string` + +GetResultCode returns the ResultCode field if non-nil, zero value otherwise. + +### GetResultCodeOk + +`func (o *VciBatchIssueResponse) GetResultCodeOk() (*string, bool)` + +GetResultCodeOk returns a tuple with the ResultCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResultCode + +`func (o *VciBatchIssueResponse) SetResultCode(v string)` + +SetResultCode sets ResultCode field to given value. + +### HasResultCode + +`func (o *VciBatchIssueResponse) HasResultCode() bool` + +HasResultCode returns a boolean if a field has been set. + +### GetResultMessage + +`func (o *VciBatchIssueResponse) GetResultMessage() string` + +GetResultMessage returns the ResultMessage field if non-nil, zero value otherwise. + +### GetResultMessageOk + +`func (o *VciBatchIssueResponse) GetResultMessageOk() (*string, bool)` + +GetResultMessageOk returns a tuple with the ResultMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResultMessage + +`func (o *VciBatchIssueResponse) SetResultMessage(v string)` + +SetResultMessage sets ResultMessage field to given value. + +### HasResultMessage + +`func (o *VciBatchIssueResponse) HasResultMessage() bool` + +HasResultMessage returns a boolean if a field has been set. + +### GetAction + +`func (o *VciBatchIssueResponse) GetAction() string` + +GetAction returns the Action field if non-nil, zero value otherwise. + +### GetActionOk + +`func (o *VciBatchIssueResponse) GetActionOk() (*string, bool)` + +GetActionOk returns a tuple with the Action field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAction + +`func (o *VciBatchIssueResponse) SetAction(v string)` + +SetAction sets Action field to given value. + +### HasAction + +`func (o *VciBatchIssueResponse) HasAction() bool` + +HasAction returns a boolean if a field has been set. + +### GetResponseContent + +`func (o *VciBatchIssueResponse) GetResponseContent() string` + +GetResponseContent returns the ResponseContent field if non-nil, zero value otherwise. + +### GetResponseContentOk + +`func (o *VciBatchIssueResponse) GetResponseContentOk() (*string, bool)` + +GetResponseContentOk returns a tuple with the ResponseContent field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResponseContent + +`func (o *VciBatchIssueResponse) SetResponseContent(v string)` + +SetResponseContent sets ResponseContent field to given value. + +### HasResponseContent + +`func (o *VciBatchIssueResponse) HasResponseContent() bool` + +HasResponseContent returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/VciBatchParseRequest.md b/docs/VciBatchParseRequest.md new file mode 100644 index 0000000..c6d7c44 --- /dev/null +++ b/docs/VciBatchParseRequest.md @@ -0,0 +1,82 @@ +# VciBatchParseRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessToken** | Pointer to **string** | The access token that came along with the credential request. | [optional] +**RequestContent** | Pointer to **string** | The message body of the batch credential request. | [optional] + +## Methods + +### NewVciBatchParseRequest + +`func NewVciBatchParseRequest() *VciBatchParseRequest` + +NewVciBatchParseRequest instantiates a new VciBatchParseRequest object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewVciBatchParseRequestWithDefaults + +`func NewVciBatchParseRequestWithDefaults() *VciBatchParseRequest` + +NewVciBatchParseRequestWithDefaults instantiates a new VciBatchParseRequest object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAccessToken + +`func (o *VciBatchParseRequest) GetAccessToken() string` + +GetAccessToken returns the AccessToken field if non-nil, zero value otherwise. + +### GetAccessTokenOk + +`func (o *VciBatchParseRequest) GetAccessTokenOk() (*string, bool)` + +GetAccessTokenOk returns a tuple with the AccessToken field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessToken + +`func (o *VciBatchParseRequest) SetAccessToken(v string)` + +SetAccessToken sets AccessToken field to given value. + +### HasAccessToken + +`func (o *VciBatchParseRequest) HasAccessToken() bool` + +HasAccessToken returns a boolean if a field has been set. + +### GetRequestContent + +`func (o *VciBatchParseRequest) GetRequestContent() string` + +GetRequestContent returns the RequestContent field if non-nil, zero value otherwise. + +### GetRequestContentOk + +`func (o *VciBatchParseRequest) GetRequestContentOk() (*string, bool)` + +GetRequestContentOk returns a tuple with the RequestContent field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestContent + +`func (o *VciBatchParseRequest) SetRequestContent(v string)` + +SetRequestContent sets RequestContent field to given value. + +### HasRequestContent + +`func (o *VciBatchParseRequest) HasRequestContent() bool` + +HasRequestContent returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/VciBatchParseResponse.md b/docs/VciBatchParseResponse.md new file mode 100644 index 0000000..30abf18 --- /dev/null +++ b/docs/VciBatchParseResponse.md @@ -0,0 +1,160 @@ +# VciBatchParseResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ResultCode** | Pointer to **string** | The code which represents the result of the API call. | [optional] +**ResultMessage** | Pointer to **string** | A short message which explains the result of the API call. | [optional] +**Action** | Pointer to **string** | The next action that the batch credential endpoint should take. | [optional] +**ResponseContent** | Pointer to **string** | The content of the response to the request sender. | [optional] +**Info** | Pointer to [**[]CredentialRequestInfo**](CredentialRequestInfo.md) | Information about the credential requests in the batch credential request. | [optional] + +## Methods + +### NewVciBatchParseResponse + +`func NewVciBatchParseResponse() *VciBatchParseResponse` + +NewVciBatchParseResponse instantiates a new VciBatchParseResponse object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewVciBatchParseResponseWithDefaults + +`func NewVciBatchParseResponseWithDefaults() *VciBatchParseResponse` + +NewVciBatchParseResponseWithDefaults instantiates a new VciBatchParseResponse object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetResultCode + +`func (o *VciBatchParseResponse) GetResultCode() string` + +GetResultCode returns the ResultCode field if non-nil, zero value otherwise. + +### GetResultCodeOk + +`func (o *VciBatchParseResponse) GetResultCodeOk() (*string, bool)` + +GetResultCodeOk returns a tuple with the ResultCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResultCode + +`func (o *VciBatchParseResponse) SetResultCode(v string)` + +SetResultCode sets ResultCode field to given value. + +### HasResultCode + +`func (o *VciBatchParseResponse) HasResultCode() bool` + +HasResultCode returns a boolean if a field has been set. + +### GetResultMessage + +`func (o *VciBatchParseResponse) GetResultMessage() string` + +GetResultMessage returns the ResultMessage field if non-nil, zero value otherwise. + +### GetResultMessageOk + +`func (o *VciBatchParseResponse) GetResultMessageOk() (*string, bool)` + +GetResultMessageOk returns a tuple with the ResultMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResultMessage + +`func (o *VciBatchParseResponse) SetResultMessage(v string)` + +SetResultMessage sets ResultMessage field to given value. + +### HasResultMessage + +`func (o *VciBatchParseResponse) HasResultMessage() bool` + +HasResultMessage returns a boolean if a field has been set. + +### GetAction + +`func (o *VciBatchParseResponse) GetAction() string` + +GetAction returns the Action field if non-nil, zero value otherwise. + +### GetActionOk + +`func (o *VciBatchParseResponse) GetActionOk() (*string, bool)` + +GetActionOk returns a tuple with the Action field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAction + +`func (o *VciBatchParseResponse) SetAction(v string)` + +SetAction sets Action field to given value. + +### HasAction + +`func (o *VciBatchParseResponse) HasAction() bool` + +HasAction returns a boolean if a field has been set. + +### GetResponseContent + +`func (o *VciBatchParseResponse) GetResponseContent() string` + +GetResponseContent returns the ResponseContent field if non-nil, zero value otherwise. + +### GetResponseContentOk + +`func (o *VciBatchParseResponse) GetResponseContentOk() (*string, bool)` + +GetResponseContentOk returns a tuple with the ResponseContent field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResponseContent + +`func (o *VciBatchParseResponse) SetResponseContent(v string)` + +SetResponseContent sets ResponseContent field to given value. + +### HasResponseContent + +`func (o *VciBatchParseResponse) HasResponseContent() bool` + +HasResponseContent returns a boolean if a field has been set. + +### GetInfo + +`func (o *VciBatchParseResponse) GetInfo() []CredentialRequestInfo` + +GetInfo returns the Info field if non-nil, zero value otherwise. + +### GetInfoOk + +`func (o *VciBatchParseResponse) GetInfoOk() (*[]CredentialRequestInfo, bool)` + +GetInfoOk returns a tuple with the Info field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInfo + +`func (o *VciBatchParseResponse) SetInfo(v []CredentialRequestInfo)` + +SetInfo sets Info field to given value. + +### HasInfo + +`func (o *VciBatchParseResponse) HasInfo() bool` + +HasInfo returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/VciDeferredIssueRequest.md b/docs/VciDeferredIssueRequest.md new file mode 100644 index 0000000..ce2be4b --- /dev/null +++ b/docs/VciDeferredIssueRequest.md @@ -0,0 +1,56 @@ +# VciDeferredIssueRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Order** | Pointer to [**CredentialIssuanceOrder**](CredentialIssuanceOrder.md) | | [optional] + +## Methods + +### NewVciDeferredIssueRequest + +`func NewVciDeferredIssueRequest() *VciDeferredIssueRequest` + +NewVciDeferredIssueRequest instantiates a new VciDeferredIssueRequest object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewVciDeferredIssueRequestWithDefaults + +`func NewVciDeferredIssueRequestWithDefaults() *VciDeferredIssueRequest` + +NewVciDeferredIssueRequestWithDefaults instantiates a new VciDeferredIssueRequest object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetOrder + +`func (o *VciDeferredIssueRequest) GetOrder() CredentialIssuanceOrder` + +GetOrder returns the Order field if non-nil, zero value otherwise. + +### GetOrderOk + +`func (o *VciDeferredIssueRequest) GetOrderOk() (*CredentialIssuanceOrder, bool)` + +GetOrderOk returns a tuple with the Order field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrder + +`func (o *VciDeferredIssueRequest) SetOrder(v CredentialIssuanceOrder)` + +SetOrder sets Order field to given value. + +### HasOrder + +`func (o *VciDeferredIssueRequest) HasOrder() bool` + +HasOrder returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/VciDeferredIssueResponse.md b/docs/VciDeferredIssueResponse.md new file mode 100644 index 0000000..646705c --- /dev/null +++ b/docs/VciDeferredIssueResponse.md @@ -0,0 +1,134 @@ +# VciDeferredIssueResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ResultCode** | Pointer to **string** | The code which represents the result of the API call. | [optional] +**ResultMessage** | Pointer to **string** | A short message which explains the result of the API call. | [optional] +**Action** | Pointer to **string** | The next action that the implementation of the deferred credential endpoint should take. | [optional] +**ResponseContent** | Pointer to **string** | The content of the response that the implementation of the deferred credential endpoint should return. | [optional] + +## Methods + +### NewVciDeferredIssueResponse + +`func NewVciDeferredIssueResponse() *VciDeferredIssueResponse` + +NewVciDeferredIssueResponse instantiates a new VciDeferredIssueResponse object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewVciDeferredIssueResponseWithDefaults + +`func NewVciDeferredIssueResponseWithDefaults() *VciDeferredIssueResponse` + +NewVciDeferredIssueResponseWithDefaults instantiates a new VciDeferredIssueResponse object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetResultCode + +`func (o *VciDeferredIssueResponse) GetResultCode() string` + +GetResultCode returns the ResultCode field if non-nil, zero value otherwise. + +### GetResultCodeOk + +`func (o *VciDeferredIssueResponse) GetResultCodeOk() (*string, bool)` + +GetResultCodeOk returns a tuple with the ResultCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResultCode + +`func (o *VciDeferredIssueResponse) SetResultCode(v string)` + +SetResultCode sets ResultCode field to given value. + +### HasResultCode + +`func (o *VciDeferredIssueResponse) HasResultCode() bool` + +HasResultCode returns a boolean if a field has been set. + +### GetResultMessage + +`func (o *VciDeferredIssueResponse) GetResultMessage() string` + +GetResultMessage returns the ResultMessage field if non-nil, zero value otherwise. + +### GetResultMessageOk + +`func (o *VciDeferredIssueResponse) GetResultMessageOk() (*string, bool)` + +GetResultMessageOk returns a tuple with the ResultMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResultMessage + +`func (o *VciDeferredIssueResponse) SetResultMessage(v string)` + +SetResultMessage sets ResultMessage field to given value. + +### HasResultMessage + +`func (o *VciDeferredIssueResponse) HasResultMessage() bool` + +HasResultMessage returns a boolean if a field has been set. + +### GetAction + +`func (o *VciDeferredIssueResponse) GetAction() string` + +GetAction returns the Action field if non-nil, zero value otherwise. + +### GetActionOk + +`func (o *VciDeferredIssueResponse) GetActionOk() (*string, bool)` + +GetActionOk returns a tuple with the Action field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAction + +`func (o *VciDeferredIssueResponse) SetAction(v string)` + +SetAction sets Action field to given value. + +### HasAction + +`func (o *VciDeferredIssueResponse) HasAction() bool` + +HasAction returns a boolean if a field has been set. + +### GetResponseContent + +`func (o *VciDeferredIssueResponse) GetResponseContent() string` + +GetResponseContent returns the ResponseContent field if non-nil, zero value otherwise. + +### GetResponseContentOk + +`func (o *VciDeferredIssueResponse) GetResponseContentOk() (*string, bool)` + +GetResponseContentOk returns a tuple with the ResponseContent field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResponseContent + +`func (o *VciDeferredIssueResponse) SetResponseContent(v string)` + +SetResponseContent sets ResponseContent field to given value. + +### HasResponseContent + +`func (o *VciDeferredIssueResponse) HasResponseContent() bool` + +HasResponseContent returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/VciDeferredParseRequest.md b/docs/VciDeferredParseRequest.md new file mode 100644 index 0000000..8a32cb2 --- /dev/null +++ b/docs/VciDeferredParseRequest.md @@ -0,0 +1,82 @@ +# VciDeferredParseRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessToken** | Pointer to **string** | The access token that came along with the deferred credential request. | [optional] +**RequestContent** | Pointer to **string** | The message body of the deferred credential request. | [optional] + +## Methods + +### NewVciDeferredParseRequest + +`func NewVciDeferredParseRequest() *VciDeferredParseRequest` + +NewVciDeferredParseRequest instantiates a new VciDeferredParseRequest object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewVciDeferredParseRequestWithDefaults + +`func NewVciDeferredParseRequestWithDefaults() *VciDeferredParseRequest` + +NewVciDeferredParseRequestWithDefaults instantiates a new VciDeferredParseRequest object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAccessToken + +`func (o *VciDeferredParseRequest) GetAccessToken() string` + +GetAccessToken returns the AccessToken field if non-nil, zero value otherwise. + +### GetAccessTokenOk + +`func (o *VciDeferredParseRequest) GetAccessTokenOk() (*string, bool)` + +GetAccessTokenOk returns a tuple with the AccessToken field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessToken + +`func (o *VciDeferredParseRequest) SetAccessToken(v string)` + +SetAccessToken sets AccessToken field to given value. + +### HasAccessToken + +`func (o *VciDeferredParseRequest) HasAccessToken() bool` + +HasAccessToken returns a boolean if a field has been set. + +### GetRequestContent + +`func (o *VciDeferredParseRequest) GetRequestContent() string` + +GetRequestContent returns the RequestContent field if non-nil, zero value otherwise. + +### GetRequestContentOk + +`func (o *VciDeferredParseRequest) GetRequestContentOk() (*string, bool)` + +GetRequestContentOk returns a tuple with the RequestContent field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestContent + +`func (o *VciDeferredParseRequest) SetRequestContent(v string)` + +SetRequestContent sets RequestContent field to given value. + +### HasRequestContent + +`func (o *VciDeferredParseRequest) HasRequestContent() bool` + +HasRequestContent returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/VciDeferredParseResponse.md b/docs/VciDeferredParseResponse.md new file mode 100644 index 0000000..1e5d4ff --- /dev/null +++ b/docs/VciDeferredParseResponse.md @@ -0,0 +1,160 @@ +# VciDeferredParseResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ResultCode** | Pointer to **string** | The code which represents the result of the API call. | [optional] +**ResultMessage** | Pointer to **string** | A short message which explains the result of the API call. | [optional] +**Action** | Pointer to **string** | The next action that the deferred credential endpoint should take. | [optional] +**ResponseContent** | Pointer to **string** | The content of the response to the request sender. | [optional] +**Info** | Pointer to [**CredentialRequestInfo**](CredentialRequestInfo.md) | | [optional] + +## Methods + +### NewVciDeferredParseResponse + +`func NewVciDeferredParseResponse() *VciDeferredParseResponse` + +NewVciDeferredParseResponse instantiates a new VciDeferredParseResponse object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewVciDeferredParseResponseWithDefaults + +`func NewVciDeferredParseResponseWithDefaults() *VciDeferredParseResponse` + +NewVciDeferredParseResponseWithDefaults instantiates a new VciDeferredParseResponse object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetResultCode + +`func (o *VciDeferredParseResponse) GetResultCode() string` + +GetResultCode returns the ResultCode field if non-nil, zero value otherwise. + +### GetResultCodeOk + +`func (o *VciDeferredParseResponse) GetResultCodeOk() (*string, bool)` + +GetResultCodeOk returns a tuple with the ResultCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResultCode + +`func (o *VciDeferredParseResponse) SetResultCode(v string)` + +SetResultCode sets ResultCode field to given value. + +### HasResultCode + +`func (o *VciDeferredParseResponse) HasResultCode() bool` + +HasResultCode returns a boolean if a field has been set. + +### GetResultMessage + +`func (o *VciDeferredParseResponse) GetResultMessage() string` + +GetResultMessage returns the ResultMessage field if non-nil, zero value otherwise. + +### GetResultMessageOk + +`func (o *VciDeferredParseResponse) GetResultMessageOk() (*string, bool)` + +GetResultMessageOk returns a tuple with the ResultMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResultMessage + +`func (o *VciDeferredParseResponse) SetResultMessage(v string)` + +SetResultMessage sets ResultMessage field to given value. + +### HasResultMessage + +`func (o *VciDeferredParseResponse) HasResultMessage() bool` + +HasResultMessage returns a boolean if a field has been set. + +### GetAction + +`func (o *VciDeferredParseResponse) GetAction() string` + +GetAction returns the Action field if non-nil, zero value otherwise. + +### GetActionOk + +`func (o *VciDeferredParseResponse) GetActionOk() (*string, bool)` + +GetActionOk returns a tuple with the Action field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAction + +`func (o *VciDeferredParseResponse) SetAction(v string)` + +SetAction sets Action field to given value. + +### HasAction + +`func (o *VciDeferredParseResponse) HasAction() bool` + +HasAction returns a boolean if a field has been set. + +### GetResponseContent + +`func (o *VciDeferredParseResponse) GetResponseContent() string` + +GetResponseContent returns the ResponseContent field if non-nil, zero value otherwise. + +### GetResponseContentOk + +`func (o *VciDeferredParseResponse) GetResponseContentOk() (*string, bool)` + +GetResponseContentOk returns a tuple with the ResponseContent field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResponseContent + +`func (o *VciDeferredParseResponse) SetResponseContent(v string)` + +SetResponseContent sets ResponseContent field to given value. + +### HasResponseContent + +`func (o *VciDeferredParseResponse) HasResponseContent() bool` + +HasResponseContent returns a boolean if a field has been set. + +### GetInfo + +`func (o *VciDeferredParseResponse) GetInfo() CredentialRequestInfo` + +GetInfo returns the Info field if non-nil, zero value otherwise. + +### GetInfoOk + +`func (o *VciDeferredParseResponse) GetInfoOk() (*CredentialRequestInfo, bool)` + +GetInfoOk returns a tuple with the Info field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInfo + +`func (o *VciDeferredParseResponse) SetInfo(v CredentialRequestInfo)` + +SetInfo sets Info field to given value. + +### HasInfo + +`func (o *VciDeferredParseResponse) HasInfo() bool` + +HasInfo returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/VciEndpointApi.md b/docs/VciEndpointApi.md new file mode 100644 index 0000000..7768c11 --- /dev/null +++ b/docs/VciEndpointApi.md @@ -0,0 +1,789 @@ +# \VciEndpointApi + +All URIs are relative to *https://beta.authlete.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**VciBatchIssueApi**](VciEndpointApi.md#VciBatchIssueApi) | **Post** /api/{serviceId}/vci/batch/issue | /api/{serviceId}/vci/batch/issue API +[**VciBatchParseApi**](VciEndpointApi.md#VciBatchParseApi) | **Post** /api/{serviceId}/vci/batch/parse | /api/{serviceId}/vci/batch/parse API +[**VciDeferredIssueApi**](VciEndpointApi.md#VciDeferredIssueApi) | **Post** /api/{serviceId}/vci/deferred/issue | /api/{serviceId}/vci/deferred/issue API +[**VciDeferredParseApi**](VciEndpointApi.md#VciDeferredParseApi) | **Post** /api/{serviceId}/vci/deferred/parse | /api/{serviceId}/vci/deferred/parse API +[**VciJwksApi**](VciEndpointApi.md#VciJwksApi) | **Post** /api/{serviceId}/vci/jwks | /api/{serviceId}/vci/jwks API +[**VciJwtissuerApi**](VciEndpointApi.md#VciJwtissuerApi) | **Post** /api/{serviceId}/vci/jwtissuer | /api/{serviceId}/vci/jwtissuer API +[**VciMetadataApi**](VciEndpointApi.md#VciMetadataApi) | **Post** /api/{serviceId}/vci/metadata | /api/{serviceId}/vci/metadata API +[**VciOfferCreateApi**](VciEndpointApi.md#VciOfferCreateApi) | **Post** /api/{serviceId}/vci/offer/create | /api/{serviceId}/vci/offer/create API +[**VciOfferInfoApi**](VciEndpointApi.md#VciOfferInfoApi) | **Post** /api/{serviceId}/vci/offer/info | /api/{serviceId}/vci/offer/info API +[**VciSingleIssueApi**](VciEndpointApi.md#VciSingleIssueApi) | **Post** /api/{serviceId}/vci/single/issue | /api/{serviceId}/vci/single/issue API +[**VciSingleParseApi**](VciEndpointApi.md#VciSingleParseApi) | **Post** /api/{serviceId}/vci/single/parse | /api/{serviceId}/vci/single/parse API + + + +## VciBatchIssueApi + +> VciBatchIssueResponse VciBatchIssueApi(ctx, serviceId).VciBatchIssueRequest(vciBatchIssueRequest).Execute() + +/api/{serviceId}/vci/batch/issue API + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "./openapi" +) + +func main() { + serviceId := "serviceId_example" // string | A service ID. + vciBatchIssueRequest := *openapiclient.NewVciBatchIssueRequest() // VciBatchIssueRequest | + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.VciEndpointApi.VciBatchIssueApi(context.Background(), serviceId).VciBatchIssueRequest(vciBatchIssueRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `VciEndpointApi.VciBatchIssueApi``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `VciBatchIssueApi`: VciBatchIssueResponse + fmt.Fprintf(os.Stdout, "Response from `VciEndpointApi.VciBatchIssueApi`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiVciBatchIssueApiRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **vciBatchIssueRequest** | [**VciBatchIssueRequest**](VciBatchIssueRequest.md) | | + +### Return type + +[**VciBatchIssueResponse**](VciBatchIssueResponse.md) + +### Authorization + +[UseService](../README.md#UseService) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## VciBatchParseApi + +> VciBatchParseResponse VciBatchParseApi(ctx, serviceId).VciBatchParseRequest(vciBatchParseRequest).Execute() + +/api/{serviceId}/vci/batch/parse API + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "./openapi" +) + +func main() { + serviceId := "serviceId_example" // string | A service ID. + vciBatchParseRequest := *openapiclient.NewVciBatchParseRequest() // VciBatchParseRequest | + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.VciEndpointApi.VciBatchParseApi(context.Background(), serviceId).VciBatchParseRequest(vciBatchParseRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `VciEndpointApi.VciBatchParseApi``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `VciBatchParseApi`: VciBatchParseResponse + fmt.Fprintf(os.Stdout, "Response from `VciEndpointApi.VciBatchParseApi`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiVciBatchParseApiRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **vciBatchParseRequest** | [**VciBatchParseRequest**](VciBatchParseRequest.md) | | + +### Return type + +[**VciBatchParseResponse**](VciBatchParseResponse.md) + +### Authorization + +[UseService](../README.md#UseService) + +### HTTP request headers + +- **Content-Type**: application/json, application/x-www-form-urlencoded +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## VciDeferredIssueApi + +> VciDeferredIssueResponse VciDeferredIssueApi(ctx, serviceId).VciDeferredIssueRequest(vciDeferredIssueRequest).Execute() + +/api/{serviceId}/vci/deferred/issue API + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "./openapi" +) + +func main() { + serviceId := "serviceId_example" // string | A service ID. + vciDeferredIssueRequest := *openapiclient.NewVciDeferredIssueRequest() // VciDeferredIssueRequest | + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.VciEndpointApi.VciDeferredIssueApi(context.Background(), serviceId).VciDeferredIssueRequest(vciDeferredIssueRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `VciEndpointApi.VciDeferredIssueApi``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `VciDeferredIssueApi`: VciDeferredIssueResponse + fmt.Fprintf(os.Stdout, "Response from `VciEndpointApi.VciDeferredIssueApi`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiVciDeferredIssueApiRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **vciDeferredIssueRequest** | [**VciDeferredIssueRequest**](VciDeferredIssueRequest.md) | | + +### Return type + +[**VciDeferredIssueResponse**](VciDeferredIssueResponse.md) + +### Authorization + +[UseService](../README.md#UseService) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## VciDeferredParseApi + +> VciDeferredParseResponse VciDeferredParseApi(ctx, serviceId).VciDeferredParseRequest(vciDeferredParseRequest).Execute() + +/api/{serviceId}/vci/deferred/parse API + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "./openapi" +) + +func main() { + serviceId := "serviceId_example" // string | A service ID. + vciDeferredParseRequest := *openapiclient.NewVciDeferredParseRequest() // VciDeferredParseRequest | + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.VciEndpointApi.VciDeferredParseApi(context.Background(), serviceId).VciDeferredParseRequest(vciDeferredParseRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `VciEndpointApi.VciDeferredParseApi``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `VciDeferredParseApi`: VciDeferredParseResponse + fmt.Fprintf(os.Stdout, "Response from `VciEndpointApi.VciDeferredParseApi`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiVciDeferredParseApiRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **vciDeferredParseRequest** | [**VciDeferredParseRequest**](VciDeferredParseRequest.md) | | + +### Return type + +[**VciDeferredParseResponse**](VciDeferredParseResponse.md) + +### Authorization + +[UseService](../README.md#UseService) + +### HTTP request headers + +- **Content-Type**: application/json, application/x-www-form-urlencoded +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## VciJwksApi + +> VciJwksResponse VciJwksApi(ctx, serviceId).VciJwksRequest(vciJwksRequest).Execute() + +/api/{serviceId}/vci/jwks API + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "./openapi" +) + +func main() { + serviceId := "serviceId_example" // string | A service ID. + vciJwksRequest := *openapiclient.NewVciJwksRequest(false) // VciJwksRequest | + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.VciEndpointApi.VciJwksApi(context.Background(), serviceId).VciJwksRequest(vciJwksRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `VciEndpointApi.VciJwksApi``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `VciJwksApi`: VciJwksResponse + fmt.Fprintf(os.Stdout, "Response from `VciEndpointApi.VciJwksApi`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiVciJwksApiRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **vciJwksRequest** | [**VciJwksRequest**](VciJwksRequest.md) | | + +### Return type + +[**VciJwksResponse**](VciJwksResponse.md) + +### Authorization + +[UseService](../README.md#UseService) + +### HTTP request headers + +- **Content-Type**: application/json, application/x-www-form-urlencoded +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## VciJwtissuerApi + +> VciJwtissuerResponse VciJwtissuerApi(ctx, serviceId).VciJwtissuerRequest(vciJwtissuerRequest).Execute() + +/api/{serviceId}/vci/jwtissuer API + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "./openapi" +) + +func main() { + serviceId := "serviceId_example" // string | A service ID. + vciJwtissuerRequest := *openapiclient.NewVciJwtissuerRequest(false) // VciJwtissuerRequest | + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.VciEndpointApi.VciJwtissuerApi(context.Background(), serviceId).VciJwtissuerRequest(vciJwtissuerRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `VciEndpointApi.VciJwtissuerApi``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `VciJwtissuerApi`: VciJwtissuerResponse + fmt.Fprintf(os.Stdout, "Response from `VciEndpointApi.VciJwtissuerApi`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiVciJwtissuerApiRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **vciJwtissuerRequest** | [**VciJwtissuerRequest**](VciJwtissuerRequest.md) | | + +### Return type + +[**VciJwtissuerResponse**](VciJwtissuerResponse.md) + +### Authorization + +[UseService](../README.md#UseService) + +### HTTP request headers + +- **Content-Type**: application/json, application/x-www-form-urlencoded +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## VciMetadataApi + +> VciMetadataResponse VciMetadataApi(ctx, serviceId).VciMetadataRequest(vciMetadataRequest).Execute() + +/api/{serviceId}/vci/metadata API + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "./openapi" +) + +func main() { + serviceId := "serviceId_example" // string | A service ID. + vciMetadataRequest := *openapiclient.NewVciMetadataRequest(false) // VciMetadataRequest | + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.VciEndpointApi.VciMetadataApi(context.Background(), serviceId).VciMetadataRequest(vciMetadataRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `VciEndpointApi.VciMetadataApi``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `VciMetadataApi`: VciMetadataResponse + fmt.Fprintf(os.Stdout, "Response from `VciEndpointApi.VciMetadataApi`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiVciMetadataApiRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **vciMetadataRequest** | [**VciMetadataRequest**](VciMetadataRequest.md) | | + +### Return type + +[**VciMetadataResponse**](VciMetadataResponse.md) + +### Authorization + +[UseService](../README.md#UseService) + +### HTTP request headers + +- **Content-Type**: application/json, application/x-www-form-urlencoded +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## VciOfferCreateApi + +> VciOfferCreateResponse VciOfferCreateApi(ctx, serviceId).VciOfferCreateRequest(vciOfferCreateRequest).Execute() + +/api/{serviceId}/vci/offer/create API + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "./openapi" +) + +func main() { + serviceId := "serviceId_example" // string | A service ID. + vciOfferCreateRequest := *openapiclient.NewVciOfferCreateRequest() // VciOfferCreateRequest | + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.VciEndpointApi.VciOfferCreateApi(context.Background(), serviceId).VciOfferCreateRequest(vciOfferCreateRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `VciEndpointApi.VciOfferCreateApi``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `VciOfferCreateApi`: VciOfferCreateResponse + fmt.Fprintf(os.Stdout, "Response from `VciEndpointApi.VciOfferCreateApi`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiVciOfferCreateApiRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **vciOfferCreateRequest** | [**VciOfferCreateRequest**](VciOfferCreateRequest.md) | | + +### Return type + +[**VciOfferCreateResponse**](VciOfferCreateResponse.md) + +### Authorization + +[UseService](../README.md#UseService) + +### HTTP request headers + +- **Content-Type**: application/json, application/x-www-form-urlencoded +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## VciOfferInfoApi + +> VciOfferInfoResponse VciOfferInfoApi(ctx, serviceId).VciOfferInfoRequest(vciOfferInfoRequest).Execute() + +/api/{serviceId}/vci/offer/info API + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "./openapi" +) + +func main() { + serviceId := "serviceId_example" // string | A service ID. + vciOfferInfoRequest := *openapiclient.NewVciOfferInfoRequest() // VciOfferInfoRequest | + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.VciEndpointApi.VciOfferInfoApi(context.Background(), serviceId).VciOfferInfoRequest(vciOfferInfoRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `VciEndpointApi.VciOfferInfoApi``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `VciOfferInfoApi`: VciOfferInfoResponse + fmt.Fprintf(os.Stdout, "Response from `VciEndpointApi.VciOfferInfoApi`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiVciOfferInfoApiRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **vciOfferInfoRequest** | [**VciOfferInfoRequest**](VciOfferInfoRequest.md) | | + +### Return type + +[**VciOfferInfoResponse**](VciOfferInfoResponse.md) + +### Authorization + +[UseService](../README.md#UseService) + +### HTTP request headers + +- **Content-Type**: application/json, application/x-www-form-urlencoded +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## VciSingleIssueApi + +> VciSingleIssueResponse VciSingleIssueApi(ctx, serviceId).VciSingleIssueRequest(vciSingleIssueRequest).Execute() + +/api/{serviceId}/vci/single/issue API + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "./openapi" +) + +func main() { + serviceId := "serviceId_example" // string | A service ID. + vciSingleIssueRequest := *openapiclient.NewVciSingleIssueRequest() // VciSingleIssueRequest | + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.VciEndpointApi.VciSingleIssueApi(context.Background(), serviceId).VciSingleIssueRequest(vciSingleIssueRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `VciEndpointApi.VciSingleIssueApi``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `VciSingleIssueApi`: VciSingleIssueResponse + fmt.Fprintf(os.Stdout, "Response from `VciEndpointApi.VciSingleIssueApi`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiVciSingleIssueApiRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **vciSingleIssueRequest** | [**VciSingleIssueRequest**](VciSingleIssueRequest.md) | | + +### Return type + +[**VciSingleIssueResponse**](VciSingleIssueResponse.md) + +### Authorization + +[UseService](../README.md#UseService) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## VciSingleParseApi + +> VciSingleParseResponse VciSingleParseApi(ctx, serviceId).VciSingleParseRequest(vciSingleParseRequest).Execute() + +/api/{serviceId}/vci/single/parse API + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "./openapi" +) + +func main() { + serviceId := "serviceId_example" // string | A service ID. + vciSingleParseRequest := *openapiclient.NewVciSingleParseRequest() // VciSingleParseRequest | + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.VciEndpointApi.VciSingleParseApi(context.Background(), serviceId).VciSingleParseRequest(vciSingleParseRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `VciEndpointApi.VciSingleParseApi``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `VciSingleParseApi`: VciSingleParseResponse + fmt.Fprintf(os.Stdout, "Response from `VciEndpointApi.VciSingleParseApi`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serviceId** | **string** | A service ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiVciSingleParseApiRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **vciSingleParseRequest** | [**VciSingleParseRequest**](VciSingleParseRequest.md) | | + +### Return type + +[**VciSingleParseResponse**](VciSingleParseResponse.md) + +### Authorization + +[UseService](../README.md#UseService) + +### HTTP request headers + +- **Content-Type**: application/json, application/x-www-form-urlencoded +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + diff --git a/docs/VciJwksRequest.md b/docs/VciJwksRequest.md new file mode 100644 index 0000000..5382704 --- /dev/null +++ b/docs/VciJwksRequest.md @@ -0,0 +1,51 @@ +# VciJwksRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Pretty** | **bool** | The flag indicating whether the metadata is written in the pretty format or not. | + +## Methods + +### NewVciJwksRequest + +`func NewVciJwksRequest(pretty bool, ) *VciJwksRequest` + +NewVciJwksRequest instantiates a new VciJwksRequest object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewVciJwksRequestWithDefaults + +`func NewVciJwksRequestWithDefaults() *VciJwksRequest` + +NewVciJwksRequestWithDefaults instantiates a new VciJwksRequest object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetPretty + +`func (o *VciJwksRequest) GetPretty() bool` + +GetPretty returns the Pretty field if non-nil, zero value otherwise. + +### GetPrettyOk + +`func (o *VciJwksRequest) GetPrettyOk() (*bool, bool)` + +GetPrettyOk returns a tuple with the Pretty field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPretty + +`func (o *VciJwksRequest) SetPretty(v bool)` + +SetPretty sets Pretty field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/VciJwksResponse.md b/docs/VciJwksResponse.md new file mode 100644 index 0000000..048ea12 --- /dev/null +++ b/docs/VciJwksResponse.md @@ -0,0 +1,134 @@ +# VciJwksResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ResultCode** | Pointer to **string** | The code which represents the result of the API call. | [optional] +**ResultMessage** | Pointer to **string** | A short message which explains the result of the API call. | [optional] +**Action** | Pointer to **string** | The next action that the implementation of the JWK Set document endpoint of the credential issuer should take after getting a response from Authlete's `/vci/jwks` API. | [optional] +**ResponseContent** | Pointer to **string** | Get the content that the implementation of the credential issuer metadata endpoint should use when it constructs a response. | [optional] + +## Methods + +### NewVciJwksResponse + +`func NewVciJwksResponse() *VciJwksResponse` + +NewVciJwksResponse instantiates a new VciJwksResponse object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewVciJwksResponseWithDefaults + +`func NewVciJwksResponseWithDefaults() *VciJwksResponse` + +NewVciJwksResponseWithDefaults instantiates a new VciJwksResponse object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetResultCode + +`func (o *VciJwksResponse) GetResultCode() string` + +GetResultCode returns the ResultCode field if non-nil, zero value otherwise. + +### GetResultCodeOk + +`func (o *VciJwksResponse) GetResultCodeOk() (*string, bool)` + +GetResultCodeOk returns a tuple with the ResultCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResultCode + +`func (o *VciJwksResponse) SetResultCode(v string)` + +SetResultCode sets ResultCode field to given value. + +### HasResultCode + +`func (o *VciJwksResponse) HasResultCode() bool` + +HasResultCode returns a boolean if a field has been set. + +### GetResultMessage + +`func (o *VciJwksResponse) GetResultMessage() string` + +GetResultMessage returns the ResultMessage field if non-nil, zero value otherwise. + +### GetResultMessageOk + +`func (o *VciJwksResponse) GetResultMessageOk() (*string, bool)` + +GetResultMessageOk returns a tuple with the ResultMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResultMessage + +`func (o *VciJwksResponse) SetResultMessage(v string)` + +SetResultMessage sets ResultMessage field to given value. + +### HasResultMessage + +`func (o *VciJwksResponse) HasResultMessage() bool` + +HasResultMessage returns a boolean if a field has been set. + +### GetAction + +`func (o *VciJwksResponse) GetAction() string` + +GetAction returns the Action field if non-nil, zero value otherwise. + +### GetActionOk + +`func (o *VciJwksResponse) GetActionOk() (*string, bool)` + +GetActionOk returns a tuple with the Action field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAction + +`func (o *VciJwksResponse) SetAction(v string)` + +SetAction sets Action field to given value. + +### HasAction + +`func (o *VciJwksResponse) HasAction() bool` + +HasAction returns a boolean if a field has been set. + +### GetResponseContent + +`func (o *VciJwksResponse) GetResponseContent() string` + +GetResponseContent returns the ResponseContent field if non-nil, zero value otherwise. + +### GetResponseContentOk + +`func (o *VciJwksResponse) GetResponseContentOk() (*string, bool)` + +GetResponseContentOk returns a tuple with the ResponseContent field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResponseContent + +`func (o *VciJwksResponse) SetResponseContent(v string)` + +SetResponseContent sets ResponseContent field to given value. + +### HasResponseContent + +`func (o *VciJwksResponse) HasResponseContent() bool` + +HasResponseContent returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/VciJwtissuerRequest.md b/docs/VciJwtissuerRequest.md new file mode 100644 index 0000000..37e52f4 --- /dev/null +++ b/docs/VciJwtissuerRequest.md @@ -0,0 +1,51 @@ +# VciJwtissuerRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Pretty** | **bool** | The flag indicating whether the metadata is written in the pretty format or not. | + +## Methods + +### NewVciJwtissuerRequest + +`func NewVciJwtissuerRequest(pretty bool, ) *VciJwtissuerRequest` + +NewVciJwtissuerRequest instantiates a new VciJwtissuerRequest object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewVciJwtissuerRequestWithDefaults + +`func NewVciJwtissuerRequestWithDefaults() *VciJwtissuerRequest` + +NewVciJwtissuerRequestWithDefaults instantiates a new VciJwtissuerRequest object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetPretty + +`func (o *VciJwtissuerRequest) GetPretty() bool` + +GetPretty returns the Pretty field if non-nil, zero value otherwise. + +### GetPrettyOk + +`func (o *VciJwtissuerRequest) GetPrettyOk() (*bool, bool)` + +GetPrettyOk returns a tuple with the Pretty field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPretty + +`func (o *VciJwtissuerRequest) SetPretty(v bool)` + +SetPretty sets Pretty field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/VciJwtissuerResponse.md b/docs/VciJwtissuerResponse.md new file mode 100644 index 0000000..3582cc3 --- /dev/null +++ b/docs/VciJwtissuerResponse.md @@ -0,0 +1,134 @@ +# VciJwtissuerResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ResultCode** | Pointer to **string** | The code which represents the result of the API call. | [optional] +**ResultMessage** | Pointer to **string** | A short message which explains the result of the API call. | [optional] +**Action** | Pointer to **string** | The next action that the implementation of the JWT issuer metadata endpoint (`/.well-known/jwt-issuer`) should take after getting a response from Authlete's `/vci/jwtissuer` API. | [optional] +**ResponseContent** | Pointer to **string** | Get the content that the implementation of the credential issuer metadata endpoint should use when it constructs a response. | [optional] + +## Methods + +### NewVciJwtissuerResponse + +`func NewVciJwtissuerResponse() *VciJwtissuerResponse` + +NewVciJwtissuerResponse instantiates a new VciJwtissuerResponse object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewVciJwtissuerResponseWithDefaults + +`func NewVciJwtissuerResponseWithDefaults() *VciJwtissuerResponse` + +NewVciJwtissuerResponseWithDefaults instantiates a new VciJwtissuerResponse object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetResultCode + +`func (o *VciJwtissuerResponse) GetResultCode() string` + +GetResultCode returns the ResultCode field if non-nil, zero value otherwise. + +### GetResultCodeOk + +`func (o *VciJwtissuerResponse) GetResultCodeOk() (*string, bool)` + +GetResultCodeOk returns a tuple with the ResultCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResultCode + +`func (o *VciJwtissuerResponse) SetResultCode(v string)` + +SetResultCode sets ResultCode field to given value. + +### HasResultCode + +`func (o *VciJwtissuerResponse) HasResultCode() bool` + +HasResultCode returns a boolean if a field has been set. + +### GetResultMessage + +`func (o *VciJwtissuerResponse) GetResultMessage() string` + +GetResultMessage returns the ResultMessage field if non-nil, zero value otherwise. + +### GetResultMessageOk + +`func (o *VciJwtissuerResponse) GetResultMessageOk() (*string, bool)` + +GetResultMessageOk returns a tuple with the ResultMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResultMessage + +`func (o *VciJwtissuerResponse) SetResultMessage(v string)` + +SetResultMessage sets ResultMessage field to given value. + +### HasResultMessage + +`func (o *VciJwtissuerResponse) HasResultMessage() bool` + +HasResultMessage returns a boolean if a field has been set. + +### GetAction + +`func (o *VciJwtissuerResponse) GetAction() string` + +GetAction returns the Action field if non-nil, zero value otherwise. + +### GetActionOk + +`func (o *VciJwtissuerResponse) GetActionOk() (*string, bool)` + +GetActionOk returns a tuple with the Action field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAction + +`func (o *VciJwtissuerResponse) SetAction(v string)` + +SetAction sets Action field to given value. + +### HasAction + +`func (o *VciJwtissuerResponse) HasAction() bool` + +HasAction returns a boolean if a field has been set. + +### GetResponseContent + +`func (o *VciJwtissuerResponse) GetResponseContent() string` + +GetResponseContent returns the ResponseContent field if non-nil, zero value otherwise. + +### GetResponseContentOk + +`func (o *VciJwtissuerResponse) GetResponseContentOk() (*string, bool)` + +GetResponseContentOk returns a tuple with the ResponseContent field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResponseContent + +`func (o *VciJwtissuerResponse) SetResponseContent(v string)` + +SetResponseContent sets ResponseContent field to given value. + +### HasResponseContent + +`func (o *VciJwtissuerResponse) HasResponseContent() bool` + +HasResponseContent returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/VciMetadataRequest.md b/docs/VciMetadataRequest.md new file mode 100644 index 0000000..30bd756 --- /dev/null +++ b/docs/VciMetadataRequest.md @@ -0,0 +1,51 @@ +# VciMetadataRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Pretty** | **bool** | The flag indicating whether the metadata is written in the pretty format or not. | + +## Methods + +### NewVciMetadataRequest + +`func NewVciMetadataRequest(pretty bool, ) *VciMetadataRequest` + +NewVciMetadataRequest instantiates a new VciMetadataRequest object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewVciMetadataRequestWithDefaults + +`func NewVciMetadataRequestWithDefaults() *VciMetadataRequest` + +NewVciMetadataRequestWithDefaults instantiates a new VciMetadataRequest object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetPretty + +`func (o *VciMetadataRequest) GetPretty() bool` + +GetPretty returns the Pretty field if non-nil, zero value otherwise. + +### GetPrettyOk + +`func (o *VciMetadataRequest) GetPrettyOk() (*bool, bool)` + +GetPrettyOk returns a tuple with the Pretty field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPretty + +`func (o *VciMetadataRequest) SetPretty(v bool)` + +SetPretty sets Pretty field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/VciMetadataResponse.md b/docs/VciMetadataResponse.md new file mode 100644 index 0000000..567d29e --- /dev/null +++ b/docs/VciMetadataResponse.md @@ -0,0 +1,134 @@ +# VciMetadataResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ResultCode** | Pointer to **string** | The code which represents the result of the API call. | [optional] +**ResultMessage** | Pointer to **string** | A short message which explains the result of the API call. | [optional] +**Action** | Pointer to **string** | The next action that the implementation of the credential issuer metadata endpoint (`/.well-known/openid-credential-issuer`) should take after getting a response from Authlete's `/vci/metadata` API. | [optional] +**ResponseContent** | Pointer to **string** | Get the content that the implementation of the credential issuer metadata endpoint should use when it constructs a response. | [optional] + +## Methods + +### NewVciMetadataResponse + +`func NewVciMetadataResponse() *VciMetadataResponse` + +NewVciMetadataResponse instantiates a new VciMetadataResponse object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewVciMetadataResponseWithDefaults + +`func NewVciMetadataResponseWithDefaults() *VciMetadataResponse` + +NewVciMetadataResponseWithDefaults instantiates a new VciMetadataResponse object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetResultCode + +`func (o *VciMetadataResponse) GetResultCode() string` + +GetResultCode returns the ResultCode field if non-nil, zero value otherwise. + +### GetResultCodeOk + +`func (o *VciMetadataResponse) GetResultCodeOk() (*string, bool)` + +GetResultCodeOk returns a tuple with the ResultCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResultCode + +`func (o *VciMetadataResponse) SetResultCode(v string)` + +SetResultCode sets ResultCode field to given value. + +### HasResultCode + +`func (o *VciMetadataResponse) HasResultCode() bool` + +HasResultCode returns a boolean if a field has been set. + +### GetResultMessage + +`func (o *VciMetadataResponse) GetResultMessage() string` + +GetResultMessage returns the ResultMessage field if non-nil, zero value otherwise. + +### GetResultMessageOk + +`func (o *VciMetadataResponse) GetResultMessageOk() (*string, bool)` + +GetResultMessageOk returns a tuple with the ResultMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResultMessage + +`func (o *VciMetadataResponse) SetResultMessage(v string)` + +SetResultMessage sets ResultMessage field to given value. + +### HasResultMessage + +`func (o *VciMetadataResponse) HasResultMessage() bool` + +HasResultMessage returns a boolean if a field has been set. + +### GetAction + +`func (o *VciMetadataResponse) GetAction() string` + +GetAction returns the Action field if non-nil, zero value otherwise. + +### GetActionOk + +`func (o *VciMetadataResponse) GetActionOk() (*string, bool)` + +GetActionOk returns a tuple with the Action field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAction + +`func (o *VciMetadataResponse) SetAction(v string)` + +SetAction sets Action field to given value. + +### HasAction + +`func (o *VciMetadataResponse) HasAction() bool` + +HasAction returns a boolean if a field has been set. + +### GetResponseContent + +`func (o *VciMetadataResponse) GetResponseContent() string` + +GetResponseContent returns the ResponseContent field if non-nil, zero value otherwise. + +### GetResponseContentOk + +`func (o *VciMetadataResponse) GetResponseContentOk() (*string, bool)` + +GetResponseContentOk returns a tuple with the ResponseContent field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResponseContent + +`func (o *VciMetadataResponse) SetResponseContent(v string)` + +SetResponseContent sets ResponseContent field to given value. + +### HasResponseContent + +`func (o *VciMetadataResponse) HasResponseContent() bool` + +HasResponseContent returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/VciOfferCreateRequest.md b/docs/VciOfferCreateRequest.md new file mode 100644 index 0000000..a232998 --- /dev/null +++ b/docs/VciOfferCreateRequest.md @@ -0,0 +1,368 @@ +# VciOfferCreateRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Credentials** | Pointer to **string** | The value of the `credentials` object in the JSON format. | [optional] +**AuthorizationCodeGrantIncluded** | Pointer to **bool** | The flag indicating whether the `authorization_code` object is included in the `grants` object. | [optional] +**IssuerStateIncluded** | Pointer to **bool** | The flag indicating whether the `issuer_state` property is included in the `authorization_code` object in the `grants` object. | [optional] +**PreAuthorizedCodeGrantIncluded** | Pointer to **bool** | The flag to include the `urn:ietf:params:oauth:grant-type:pre-authorized_code` object in the `grants` object. | [optional] +**UserPinRequired** | Pointer to **bool** | The value of the `user_pin_required` property in the `urn:ietf:params:oauth:grant-type:pre-authorized_code` object in the `grants` object. | [optional] +**UserPinLength** | Pointer to **int32** | The length of the user PIN to generate. | [optional] +**Subject** | Pointer to **string** | The subject associated with the credential offer. | [optional] +**Duration** | Pointer to **int64** | The duration of the credential offer. | [optional] +**Context** | Pointer to **string** | The general-purpose arbitrary string. | [optional] +**Properties** | Pointer to [**[]Property**](Property.md) | Extra properties to associate with the credential offer. | [optional] +**JwtAtClaims** | Pointer to **string** | Additional claims that are added to the payload part of the JWT access token. | [optional] +**AuthTime** | Pointer to **int64** | The time at which the user authentication was performed during the course of issuing the credential offer. | [optional] +**Acr** | Pointer to **string** | The Authentication Context Class Reference of the user authentication performed during the course of issuing the credential offer. | [optional] + +## Methods + +### NewVciOfferCreateRequest + +`func NewVciOfferCreateRequest() *VciOfferCreateRequest` + +NewVciOfferCreateRequest instantiates a new VciOfferCreateRequest object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewVciOfferCreateRequestWithDefaults + +`func NewVciOfferCreateRequestWithDefaults() *VciOfferCreateRequest` + +NewVciOfferCreateRequestWithDefaults instantiates a new VciOfferCreateRequest object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCredentials + +`func (o *VciOfferCreateRequest) GetCredentials() string` + +GetCredentials returns the Credentials field if non-nil, zero value otherwise. + +### GetCredentialsOk + +`func (o *VciOfferCreateRequest) GetCredentialsOk() (*string, bool)` + +GetCredentialsOk returns a tuple with the Credentials field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCredentials + +`func (o *VciOfferCreateRequest) SetCredentials(v string)` + +SetCredentials sets Credentials field to given value. + +### HasCredentials + +`func (o *VciOfferCreateRequest) HasCredentials() bool` + +HasCredentials returns a boolean if a field has been set. + +### GetAuthorizationCodeGrantIncluded + +`func (o *VciOfferCreateRequest) GetAuthorizationCodeGrantIncluded() bool` + +GetAuthorizationCodeGrantIncluded returns the AuthorizationCodeGrantIncluded field if non-nil, zero value otherwise. + +### GetAuthorizationCodeGrantIncludedOk + +`func (o *VciOfferCreateRequest) GetAuthorizationCodeGrantIncludedOk() (*bool, bool)` + +GetAuthorizationCodeGrantIncludedOk returns a tuple with the AuthorizationCodeGrantIncluded field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthorizationCodeGrantIncluded + +`func (o *VciOfferCreateRequest) SetAuthorizationCodeGrantIncluded(v bool)` + +SetAuthorizationCodeGrantIncluded sets AuthorizationCodeGrantIncluded field to given value. + +### HasAuthorizationCodeGrantIncluded + +`func (o *VciOfferCreateRequest) HasAuthorizationCodeGrantIncluded() bool` + +HasAuthorizationCodeGrantIncluded returns a boolean if a field has been set. + +### GetIssuerStateIncluded + +`func (o *VciOfferCreateRequest) GetIssuerStateIncluded() bool` + +GetIssuerStateIncluded returns the IssuerStateIncluded field if non-nil, zero value otherwise. + +### GetIssuerStateIncludedOk + +`func (o *VciOfferCreateRequest) GetIssuerStateIncludedOk() (*bool, bool)` + +GetIssuerStateIncludedOk returns a tuple with the IssuerStateIncluded field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIssuerStateIncluded + +`func (o *VciOfferCreateRequest) SetIssuerStateIncluded(v bool)` + +SetIssuerStateIncluded sets IssuerStateIncluded field to given value. + +### HasIssuerStateIncluded + +`func (o *VciOfferCreateRequest) HasIssuerStateIncluded() bool` + +HasIssuerStateIncluded returns a boolean if a field has been set. + +### GetPreAuthorizedCodeGrantIncluded + +`func (o *VciOfferCreateRequest) GetPreAuthorizedCodeGrantIncluded() bool` + +GetPreAuthorizedCodeGrantIncluded returns the PreAuthorizedCodeGrantIncluded field if non-nil, zero value otherwise. + +### GetPreAuthorizedCodeGrantIncludedOk + +`func (o *VciOfferCreateRequest) GetPreAuthorizedCodeGrantIncludedOk() (*bool, bool)` + +GetPreAuthorizedCodeGrantIncludedOk returns a tuple with the PreAuthorizedCodeGrantIncluded field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPreAuthorizedCodeGrantIncluded + +`func (o *VciOfferCreateRequest) SetPreAuthorizedCodeGrantIncluded(v bool)` + +SetPreAuthorizedCodeGrantIncluded sets PreAuthorizedCodeGrantIncluded field to given value. + +### HasPreAuthorizedCodeGrantIncluded + +`func (o *VciOfferCreateRequest) HasPreAuthorizedCodeGrantIncluded() bool` + +HasPreAuthorizedCodeGrantIncluded returns a boolean if a field has been set. + +### GetUserPinRequired + +`func (o *VciOfferCreateRequest) GetUserPinRequired() bool` + +GetUserPinRequired returns the UserPinRequired field if non-nil, zero value otherwise. + +### GetUserPinRequiredOk + +`func (o *VciOfferCreateRequest) GetUserPinRequiredOk() (*bool, bool)` + +GetUserPinRequiredOk returns a tuple with the UserPinRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserPinRequired + +`func (o *VciOfferCreateRequest) SetUserPinRequired(v bool)` + +SetUserPinRequired sets UserPinRequired field to given value. + +### HasUserPinRequired + +`func (o *VciOfferCreateRequest) HasUserPinRequired() bool` + +HasUserPinRequired returns a boolean if a field has been set. + +### GetUserPinLength + +`func (o *VciOfferCreateRequest) GetUserPinLength() int32` + +GetUserPinLength returns the UserPinLength field if non-nil, zero value otherwise. + +### GetUserPinLengthOk + +`func (o *VciOfferCreateRequest) GetUserPinLengthOk() (*int32, bool)` + +GetUserPinLengthOk returns a tuple with the UserPinLength field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserPinLength + +`func (o *VciOfferCreateRequest) SetUserPinLength(v int32)` + +SetUserPinLength sets UserPinLength field to given value. + +### HasUserPinLength + +`func (o *VciOfferCreateRequest) HasUserPinLength() bool` + +HasUserPinLength returns a boolean if a field has been set. + +### GetSubject + +`func (o *VciOfferCreateRequest) GetSubject() string` + +GetSubject returns the Subject field if non-nil, zero value otherwise. + +### GetSubjectOk + +`func (o *VciOfferCreateRequest) GetSubjectOk() (*string, bool)` + +GetSubjectOk returns a tuple with the Subject field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSubject + +`func (o *VciOfferCreateRequest) SetSubject(v string)` + +SetSubject sets Subject field to given value. + +### HasSubject + +`func (o *VciOfferCreateRequest) HasSubject() bool` + +HasSubject returns a boolean if a field has been set. + +### GetDuration + +`func (o *VciOfferCreateRequest) GetDuration() int64` + +GetDuration returns the Duration field if non-nil, zero value otherwise. + +### GetDurationOk + +`func (o *VciOfferCreateRequest) GetDurationOk() (*int64, bool)` + +GetDurationOk returns a tuple with the Duration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDuration + +`func (o *VciOfferCreateRequest) SetDuration(v int64)` + +SetDuration sets Duration field to given value. + +### HasDuration + +`func (o *VciOfferCreateRequest) HasDuration() bool` + +HasDuration returns a boolean if a field has been set. + +### GetContext + +`func (o *VciOfferCreateRequest) GetContext() string` + +GetContext returns the Context field if non-nil, zero value otherwise. + +### GetContextOk + +`func (o *VciOfferCreateRequest) GetContextOk() (*string, bool)` + +GetContextOk returns a tuple with the Context field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContext + +`func (o *VciOfferCreateRequest) SetContext(v string)` + +SetContext sets Context field to given value. + +### HasContext + +`func (o *VciOfferCreateRequest) HasContext() bool` + +HasContext returns a boolean if a field has been set. + +### GetProperties + +`func (o *VciOfferCreateRequest) GetProperties() []Property` + +GetProperties returns the Properties field if non-nil, zero value otherwise. + +### GetPropertiesOk + +`func (o *VciOfferCreateRequest) GetPropertiesOk() (*[]Property, bool)` + +GetPropertiesOk returns a tuple with the Properties field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProperties + +`func (o *VciOfferCreateRequest) SetProperties(v []Property)` + +SetProperties sets Properties field to given value. + +### HasProperties + +`func (o *VciOfferCreateRequest) HasProperties() bool` + +HasProperties returns a boolean if a field has been set. + +### GetJwtAtClaims + +`func (o *VciOfferCreateRequest) GetJwtAtClaims() string` + +GetJwtAtClaims returns the JwtAtClaims field if non-nil, zero value otherwise. + +### GetJwtAtClaimsOk + +`func (o *VciOfferCreateRequest) GetJwtAtClaimsOk() (*string, bool)` + +GetJwtAtClaimsOk returns a tuple with the JwtAtClaims field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetJwtAtClaims + +`func (o *VciOfferCreateRequest) SetJwtAtClaims(v string)` + +SetJwtAtClaims sets JwtAtClaims field to given value. + +### HasJwtAtClaims + +`func (o *VciOfferCreateRequest) HasJwtAtClaims() bool` + +HasJwtAtClaims returns a boolean if a field has been set. + +### GetAuthTime + +`func (o *VciOfferCreateRequest) GetAuthTime() int64` + +GetAuthTime returns the AuthTime field if non-nil, zero value otherwise. + +### GetAuthTimeOk + +`func (o *VciOfferCreateRequest) GetAuthTimeOk() (*int64, bool)` + +GetAuthTimeOk returns a tuple with the AuthTime field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthTime + +`func (o *VciOfferCreateRequest) SetAuthTime(v int64)` + +SetAuthTime sets AuthTime field to given value. + +### HasAuthTime + +`func (o *VciOfferCreateRequest) HasAuthTime() bool` + +HasAuthTime returns a boolean if a field has been set. + +### GetAcr + +`func (o *VciOfferCreateRequest) GetAcr() string` + +GetAcr returns the Acr field if non-nil, zero value otherwise. + +### GetAcrOk + +`func (o *VciOfferCreateRequest) GetAcrOk() (*string, bool)` + +GetAcrOk returns a tuple with the Acr field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAcr + +`func (o *VciOfferCreateRequest) SetAcr(v string)` + +SetAcr sets Acr field to given value. + +### HasAcr + +`func (o *VciOfferCreateRequest) HasAcr() bool` + +HasAcr returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/VciOfferCreateResponse.md b/docs/VciOfferCreateResponse.md new file mode 100644 index 0000000..6b80fe8 --- /dev/null +++ b/docs/VciOfferCreateResponse.md @@ -0,0 +1,134 @@ +# VciOfferCreateResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ResultCode** | Pointer to **string** | The code which represents the result of the API call. | [optional] +**ResultMessage** | Pointer to **string** | A short message which explains the result of the API call. | [optional] +**Action** | Pointer to **string** | The result of the `/vci/offer/create` API call. | [optional] +**Info** | Pointer to [**CredentialOfferInfo**](CredentialOfferInfo.md) | | [optional] + +## Methods + +### NewVciOfferCreateResponse + +`func NewVciOfferCreateResponse() *VciOfferCreateResponse` + +NewVciOfferCreateResponse instantiates a new VciOfferCreateResponse object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewVciOfferCreateResponseWithDefaults + +`func NewVciOfferCreateResponseWithDefaults() *VciOfferCreateResponse` + +NewVciOfferCreateResponseWithDefaults instantiates a new VciOfferCreateResponse object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetResultCode + +`func (o *VciOfferCreateResponse) GetResultCode() string` + +GetResultCode returns the ResultCode field if non-nil, zero value otherwise. + +### GetResultCodeOk + +`func (o *VciOfferCreateResponse) GetResultCodeOk() (*string, bool)` + +GetResultCodeOk returns a tuple with the ResultCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResultCode + +`func (o *VciOfferCreateResponse) SetResultCode(v string)` + +SetResultCode sets ResultCode field to given value. + +### HasResultCode + +`func (o *VciOfferCreateResponse) HasResultCode() bool` + +HasResultCode returns a boolean if a field has been set. + +### GetResultMessage + +`func (o *VciOfferCreateResponse) GetResultMessage() string` + +GetResultMessage returns the ResultMessage field if non-nil, zero value otherwise. + +### GetResultMessageOk + +`func (o *VciOfferCreateResponse) GetResultMessageOk() (*string, bool)` + +GetResultMessageOk returns a tuple with the ResultMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResultMessage + +`func (o *VciOfferCreateResponse) SetResultMessage(v string)` + +SetResultMessage sets ResultMessage field to given value. + +### HasResultMessage + +`func (o *VciOfferCreateResponse) HasResultMessage() bool` + +HasResultMessage returns a boolean if a field has been set. + +### GetAction + +`func (o *VciOfferCreateResponse) GetAction() string` + +GetAction returns the Action field if non-nil, zero value otherwise. + +### GetActionOk + +`func (o *VciOfferCreateResponse) GetActionOk() (*string, bool)` + +GetActionOk returns a tuple with the Action field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAction + +`func (o *VciOfferCreateResponse) SetAction(v string)` + +SetAction sets Action field to given value. + +### HasAction + +`func (o *VciOfferCreateResponse) HasAction() bool` + +HasAction returns a boolean if a field has been set. + +### GetInfo + +`func (o *VciOfferCreateResponse) GetInfo() CredentialOfferInfo` + +GetInfo returns the Info field if non-nil, zero value otherwise. + +### GetInfoOk + +`func (o *VciOfferCreateResponse) GetInfoOk() (*CredentialOfferInfo, bool)` + +GetInfoOk returns a tuple with the Info field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInfo + +`func (o *VciOfferCreateResponse) SetInfo(v CredentialOfferInfo)` + +SetInfo sets Info field to given value. + +### HasInfo + +`func (o *VciOfferCreateResponse) HasInfo() bool` + +HasInfo returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/VciOfferInfoRequest.md b/docs/VciOfferInfoRequest.md new file mode 100644 index 0000000..51591df --- /dev/null +++ b/docs/VciOfferInfoRequest.md @@ -0,0 +1,56 @@ +# VciOfferInfoRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identifier** | Pointer to **string** | The identifier of the credential offer. | [optional] + +## Methods + +### NewVciOfferInfoRequest + +`func NewVciOfferInfoRequest() *VciOfferInfoRequest` + +NewVciOfferInfoRequest instantiates a new VciOfferInfoRequest object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewVciOfferInfoRequestWithDefaults + +`func NewVciOfferInfoRequestWithDefaults() *VciOfferInfoRequest` + +NewVciOfferInfoRequestWithDefaults instantiates a new VciOfferInfoRequest object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetIdentifier + +`func (o *VciOfferInfoRequest) GetIdentifier() string` + +GetIdentifier returns the Identifier field if non-nil, zero value otherwise. + +### GetIdentifierOk + +`func (o *VciOfferInfoRequest) GetIdentifierOk() (*string, bool)` + +GetIdentifierOk returns a tuple with the Identifier field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentifier + +`func (o *VciOfferInfoRequest) SetIdentifier(v string)` + +SetIdentifier sets Identifier field to given value. + +### HasIdentifier + +`func (o *VciOfferInfoRequest) HasIdentifier() bool` + +HasIdentifier returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/VciOfferInfoResponse.md b/docs/VciOfferInfoResponse.md new file mode 100644 index 0000000..dedbb6e --- /dev/null +++ b/docs/VciOfferInfoResponse.md @@ -0,0 +1,134 @@ +# VciOfferInfoResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ResultCode** | Pointer to **string** | The code which represents the result of the API call. | [optional] +**ResultMessage** | Pointer to **string** | A short message which explains the result of the API call. | [optional] +**Action** | Pointer to **string** | The result of the `/vci/offer/info` API call. | [optional] +**Info** | Pointer to [**CredentialOfferInfo**](CredentialOfferInfo.md) | | [optional] + +## Methods + +### NewVciOfferInfoResponse + +`func NewVciOfferInfoResponse() *VciOfferInfoResponse` + +NewVciOfferInfoResponse instantiates a new VciOfferInfoResponse object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewVciOfferInfoResponseWithDefaults + +`func NewVciOfferInfoResponseWithDefaults() *VciOfferInfoResponse` + +NewVciOfferInfoResponseWithDefaults instantiates a new VciOfferInfoResponse object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetResultCode + +`func (o *VciOfferInfoResponse) GetResultCode() string` + +GetResultCode returns the ResultCode field if non-nil, zero value otherwise. + +### GetResultCodeOk + +`func (o *VciOfferInfoResponse) GetResultCodeOk() (*string, bool)` + +GetResultCodeOk returns a tuple with the ResultCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResultCode + +`func (o *VciOfferInfoResponse) SetResultCode(v string)` + +SetResultCode sets ResultCode field to given value. + +### HasResultCode + +`func (o *VciOfferInfoResponse) HasResultCode() bool` + +HasResultCode returns a boolean if a field has been set. + +### GetResultMessage + +`func (o *VciOfferInfoResponse) GetResultMessage() string` + +GetResultMessage returns the ResultMessage field if non-nil, zero value otherwise. + +### GetResultMessageOk + +`func (o *VciOfferInfoResponse) GetResultMessageOk() (*string, bool)` + +GetResultMessageOk returns a tuple with the ResultMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResultMessage + +`func (o *VciOfferInfoResponse) SetResultMessage(v string)` + +SetResultMessage sets ResultMessage field to given value. + +### HasResultMessage + +`func (o *VciOfferInfoResponse) HasResultMessage() bool` + +HasResultMessage returns a boolean if a field has been set. + +### GetAction + +`func (o *VciOfferInfoResponse) GetAction() string` + +GetAction returns the Action field if non-nil, zero value otherwise. + +### GetActionOk + +`func (o *VciOfferInfoResponse) GetActionOk() (*string, bool)` + +GetActionOk returns a tuple with the Action field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAction + +`func (o *VciOfferInfoResponse) SetAction(v string)` + +SetAction sets Action field to given value. + +### HasAction + +`func (o *VciOfferInfoResponse) HasAction() bool` + +HasAction returns a boolean if a field has been set. + +### GetInfo + +`func (o *VciOfferInfoResponse) GetInfo() CredentialOfferInfo` + +GetInfo returns the Info field if non-nil, zero value otherwise. + +### GetInfoOk + +`func (o *VciOfferInfoResponse) GetInfoOk() (*CredentialOfferInfo, bool)` + +GetInfoOk returns a tuple with the Info field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInfo + +`func (o *VciOfferInfoResponse) SetInfo(v CredentialOfferInfo)` + +SetInfo sets Info field to given value. + +### HasInfo + +`func (o *VciOfferInfoResponse) HasInfo() bool` + +HasInfo returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/VciSingleIssueRequest.md b/docs/VciSingleIssueRequest.md new file mode 100644 index 0000000..06107c9 --- /dev/null +++ b/docs/VciSingleIssueRequest.md @@ -0,0 +1,82 @@ +# VciSingleIssueRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessToken** | Pointer to **string** | The access token that came along with the credential request. | [optional] +**Order** | Pointer to [**CredentialIssuanceOrder**](CredentialIssuanceOrder.md) | | [optional] + +## Methods + +### NewVciSingleIssueRequest + +`func NewVciSingleIssueRequest() *VciSingleIssueRequest` + +NewVciSingleIssueRequest instantiates a new VciSingleIssueRequest object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewVciSingleIssueRequestWithDefaults + +`func NewVciSingleIssueRequestWithDefaults() *VciSingleIssueRequest` + +NewVciSingleIssueRequestWithDefaults instantiates a new VciSingleIssueRequest object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAccessToken + +`func (o *VciSingleIssueRequest) GetAccessToken() string` + +GetAccessToken returns the AccessToken field if non-nil, zero value otherwise. + +### GetAccessTokenOk + +`func (o *VciSingleIssueRequest) GetAccessTokenOk() (*string, bool)` + +GetAccessTokenOk returns a tuple with the AccessToken field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessToken + +`func (o *VciSingleIssueRequest) SetAccessToken(v string)` + +SetAccessToken sets AccessToken field to given value. + +### HasAccessToken + +`func (o *VciSingleIssueRequest) HasAccessToken() bool` + +HasAccessToken returns a boolean if a field has been set. + +### GetOrder + +`func (o *VciSingleIssueRequest) GetOrder() CredentialIssuanceOrder` + +GetOrder returns the Order field if non-nil, zero value otherwise. + +### GetOrderOk + +`func (o *VciSingleIssueRequest) GetOrderOk() (*CredentialIssuanceOrder, bool)` + +GetOrderOk returns a tuple with the Order field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrder + +`func (o *VciSingleIssueRequest) SetOrder(v CredentialIssuanceOrder)` + +SetOrder sets Order field to given value. + +### HasOrder + +`func (o *VciSingleIssueRequest) HasOrder() bool` + +HasOrder returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/VciSingleIssueResponse.md b/docs/VciSingleIssueResponse.md new file mode 100644 index 0000000..d9bca3b --- /dev/null +++ b/docs/VciSingleIssueResponse.md @@ -0,0 +1,160 @@ +# VciSingleIssueResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ResultCode** | Pointer to **string** | The code which represents the result of the API call. | [optional] +**ResultMessage** | Pointer to **string** | A short message which explains the result of the API call. | [optional] +**Action** | Pointer to **string** | The next action that the implementation of the credential endpoint should take. | [optional] +**ResponseContent** | Pointer to **string** | The content of the response that the implementation of the credential endpoint should return. | [optional] +**TransactionId** | Pointer to **string** | The issued transaction ID. | [optional] + +## Methods + +### NewVciSingleIssueResponse + +`func NewVciSingleIssueResponse() *VciSingleIssueResponse` + +NewVciSingleIssueResponse instantiates a new VciSingleIssueResponse object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewVciSingleIssueResponseWithDefaults + +`func NewVciSingleIssueResponseWithDefaults() *VciSingleIssueResponse` + +NewVciSingleIssueResponseWithDefaults instantiates a new VciSingleIssueResponse object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetResultCode + +`func (o *VciSingleIssueResponse) GetResultCode() string` + +GetResultCode returns the ResultCode field if non-nil, zero value otherwise. + +### GetResultCodeOk + +`func (o *VciSingleIssueResponse) GetResultCodeOk() (*string, bool)` + +GetResultCodeOk returns a tuple with the ResultCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResultCode + +`func (o *VciSingleIssueResponse) SetResultCode(v string)` + +SetResultCode sets ResultCode field to given value. + +### HasResultCode + +`func (o *VciSingleIssueResponse) HasResultCode() bool` + +HasResultCode returns a boolean if a field has been set. + +### GetResultMessage + +`func (o *VciSingleIssueResponse) GetResultMessage() string` + +GetResultMessage returns the ResultMessage field if non-nil, zero value otherwise. + +### GetResultMessageOk + +`func (o *VciSingleIssueResponse) GetResultMessageOk() (*string, bool)` + +GetResultMessageOk returns a tuple with the ResultMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResultMessage + +`func (o *VciSingleIssueResponse) SetResultMessage(v string)` + +SetResultMessage sets ResultMessage field to given value. + +### HasResultMessage + +`func (o *VciSingleIssueResponse) HasResultMessage() bool` + +HasResultMessage returns a boolean if a field has been set. + +### GetAction + +`func (o *VciSingleIssueResponse) GetAction() string` + +GetAction returns the Action field if non-nil, zero value otherwise. + +### GetActionOk + +`func (o *VciSingleIssueResponse) GetActionOk() (*string, bool)` + +GetActionOk returns a tuple with the Action field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAction + +`func (o *VciSingleIssueResponse) SetAction(v string)` + +SetAction sets Action field to given value. + +### HasAction + +`func (o *VciSingleIssueResponse) HasAction() bool` + +HasAction returns a boolean if a field has been set. + +### GetResponseContent + +`func (o *VciSingleIssueResponse) GetResponseContent() string` + +GetResponseContent returns the ResponseContent field if non-nil, zero value otherwise. + +### GetResponseContentOk + +`func (o *VciSingleIssueResponse) GetResponseContentOk() (*string, bool)` + +GetResponseContentOk returns a tuple with the ResponseContent field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResponseContent + +`func (o *VciSingleIssueResponse) SetResponseContent(v string)` + +SetResponseContent sets ResponseContent field to given value. + +### HasResponseContent + +`func (o *VciSingleIssueResponse) HasResponseContent() bool` + +HasResponseContent returns a boolean if a field has been set. + +### GetTransactionId + +`func (o *VciSingleIssueResponse) GetTransactionId() string` + +GetTransactionId returns the TransactionId field if non-nil, zero value otherwise. + +### GetTransactionIdOk + +`func (o *VciSingleIssueResponse) GetTransactionIdOk() (*string, bool)` + +GetTransactionIdOk returns a tuple with the TransactionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTransactionId + +`func (o *VciSingleIssueResponse) SetTransactionId(v string)` + +SetTransactionId sets TransactionId field to given value. + +### HasTransactionId + +`func (o *VciSingleIssueResponse) HasTransactionId() bool` + +HasTransactionId returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/VciSingleParseRequest.md b/docs/VciSingleParseRequest.md new file mode 100644 index 0000000..b68d1ff --- /dev/null +++ b/docs/VciSingleParseRequest.md @@ -0,0 +1,82 @@ +# VciSingleParseRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessToken** | Pointer to **string** | The access token that came along with the credential request. | [optional] +**RequestContent** | Pointer to **string** | The message body of the credential request. | [optional] + +## Methods + +### NewVciSingleParseRequest + +`func NewVciSingleParseRequest() *VciSingleParseRequest` + +NewVciSingleParseRequest instantiates a new VciSingleParseRequest object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewVciSingleParseRequestWithDefaults + +`func NewVciSingleParseRequestWithDefaults() *VciSingleParseRequest` + +NewVciSingleParseRequestWithDefaults instantiates a new VciSingleParseRequest object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAccessToken + +`func (o *VciSingleParseRequest) GetAccessToken() string` + +GetAccessToken returns the AccessToken field if non-nil, zero value otherwise. + +### GetAccessTokenOk + +`func (o *VciSingleParseRequest) GetAccessTokenOk() (*string, bool)` + +GetAccessTokenOk returns a tuple with the AccessToken field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessToken + +`func (o *VciSingleParseRequest) SetAccessToken(v string)` + +SetAccessToken sets AccessToken field to given value. + +### HasAccessToken + +`func (o *VciSingleParseRequest) HasAccessToken() bool` + +HasAccessToken returns a boolean if a field has been set. + +### GetRequestContent + +`func (o *VciSingleParseRequest) GetRequestContent() string` + +GetRequestContent returns the RequestContent field if non-nil, zero value otherwise. + +### GetRequestContentOk + +`func (o *VciSingleParseRequest) GetRequestContentOk() (*string, bool)` + +GetRequestContentOk returns a tuple with the RequestContent field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestContent + +`func (o *VciSingleParseRequest) SetRequestContent(v string)` + +SetRequestContent sets RequestContent field to given value. + +### HasRequestContent + +`func (o *VciSingleParseRequest) HasRequestContent() bool` + +HasRequestContent returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/VciSingleParseResponse.md b/docs/VciSingleParseResponse.md new file mode 100644 index 0000000..10fe93b --- /dev/null +++ b/docs/VciSingleParseResponse.md @@ -0,0 +1,160 @@ +# VciSingleParseResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ResultCode** | Pointer to **string** | The code which represents the result of the API call. | [optional] +**ResultMessage** | Pointer to **string** | A short message which explains the result of the API call. | [optional] +**Action** | Pointer to **string** | The next action that the credential endpoint should take. | [optional] +**ResponseContent** | Pointer to **string** | The content of the response to the request sender. | [optional] +**Info** | Pointer to [**CredentialRequestInfo**](CredentialRequestInfo.md) | | [optional] + +## Methods + +### NewVciSingleParseResponse + +`func NewVciSingleParseResponse() *VciSingleParseResponse` + +NewVciSingleParseResponse instantiates a new VciSingleParseResponse object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewVciSingleParseResponseWithDefaults + +`func NewVciSingleParseResponseWithDefaults() *VciSingleParseResponse` + +NewVciSingleParseResponseWithDefaults instantiates a new VciSingleParseResponse object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetResultCode + +`func (o *VciSingleParseResponse) GetResultCode() string` + +GetResultCode returns the ResultCode field if non-nil, zero value otherwise. + +### GetResultCodeOk + +`func (o *VciSingleParseResponse) GetResultCodeOk() (*string, bool)` + +GetResultCodeOk returns a tuple with the ResultCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResultCode + +`func (o *VciSingleParseResponse) SetResultCode(v string)` + +SetResultCode sets ResultCode field to given value. + +### HasResultCode + +`func (o *VciSingleParseResponse) HasResultCode() bool` + +HasResultCode returns a boolean if a field has been set. + +### GetResultMessage + +`func (o *VciSingleParseResponse) GetResultMessage() string` + +GetResultMessage returns the ResultMessage field if non-nil, zero value otherwise. + +### GetResultMessageOk + +`func (o *VciSingleParseResponse) GetResultMessageOk() (*string, bool)` + +GetResultMessageOk returns a tuple with the ResultMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResultMessage + +`func (o *VciSingleParseResponse) SetResultMessage(v string)` + +SetResultMessage sets ResultMessage field to given value. + +### HasResultMessage + +`func (o *VciSingleParseResponse) HasResultMessage() bool` + +HasResultMessage returns a boolean if a field has been set. + +### GetAction + +`func (o *VciSingleParseResponse) GetAction() string` + +GetAction returns the Action field if non-nil, zero value otherwise. + +### GetActionOk + +`func (o *VciSingleParseResponse) GetActionOk() (*string, bool)` + +GetActionOk returns a tuple with the Action field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAction + +`func (o *VciSingleParseResponse) SetAction(v string)` + +SetAction sets Action field to given value. + +### HasAction + +`func (o *VciSingleParseResponse) HasAction() bool` + +HasAction returns a boolean if a field has been set. + +### GetResponseContent + +`func (o *VciSingleParseResponse) GetResponseContent() string` + +GetResponseContent returns the ResponseContent field if non-nil, zero value otherwise. + +### GetResponseContentOk + +`func (o *VciSingleParseResponse) GetResponseContentOk() (*string, bool)` + +GetResponseContentOk returns a tuple with the ResponseContent field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResponseContent + +`func (o *VciSingleParseResponse) SetResponseContent(v string)` + +SetResponseContent sets ResponseContent field to given value. + +### HasResponseContent + +`func (o *VciSingleParseResponse) HasResponseContent() bool` + +HasResponseContent returns a boolean if a field has been set. + +### GetInfo + +`func (o *VciSingleParseResponse) GetInfo() CredentialRequestInfo` + +GetInfo returns the Info field if non-nil, zero value otherwise. + +### GetInfoOk + +`func (o *VciSingleParseResponse) GetInfoOk() (*CredentialRequestInfo, bool)` + +GetInfoOk returns a tuple with the Info field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInfo + +`func (o *VciSingleParseResponse) SetInfo(v CredentialRequestInfo)` + +SetInfo sets Info field to given value. + +### HasInfo + +`func (o *VciSingleParseResponse) HasInfo() bool` + +HasInfo returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/model_access_token.go b/model_access_token.go index 99ad99e..d195201 100644 --- a/model_access_token.go +++ b/model_access_token.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_application_type.go b/model_application_type.go index b06e908..a63ef24 100644 --- a/model_application_type.go +++ b/model_application_type.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_attachment_type.go b/model_attachment_type.go index 3cebd01..14e29b1 100644 --- a/model_attachment_type.go +++ b/model_attachment_type.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_authorization_details.go b/model_authorization_details.go index b5182d4..c20187f 100644 --- a/model_authorization_details.go +++ b/model_authorization_details.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_authorization_details_element.go b/model_authorization_details_element.go index c43b284..72aff70 100644 --- a/model_authorization_details_element.go +++ b/model_authorization_details_element.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_authorization_fail_request.go b/model_authorization_fail_request.go index 7727d1b..aa3df0f 100644 --- a/model_authorization_fail_request.go +++ b/model_authorization_fail_request.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_authorization_fail_response.go b/model_authorization_fail_response.go index 08fe0d5..ee95275 100644 --- a/model_authorization_fail_response.go +++ b/model_authorization_fail_response.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_authorization_issue_request.go b/model_authorization_issue_request.go index 941e26c..2a93ef2 100644 --- a/model_authorization_issue_request.go +++ b/model_authorization_issue_request.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_authorization_issue_response.go b/model_authorization_issue_response.go index 16838da..5e97ff3 100644 --- a/model_authorization_issue_response.go +++ b/model_authorization_issue_response.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. @@ -39,6 +39,8 @@ type AuthorizationIssueResponse struct { AuthorizationCode *string `json:"authorizationCode,omitempty"` // The newly issued access token in JWT format. If the service is not configured to issue JWT-based access tokens, this property is always set to `null`. JwtAccessToken *string `json:"jwtAccessToken,omitempty"` + // The information about the ticket. + TicketInfo *string `json:"ticketInfo,omitempty"` } // NewAuthorizationIssueResponse instantiates a new AuthorizationIssueResponse object @@ -378,6 +380,38 @@ func (o *AuthorizationIssueResponse) SetJwtAccessToken(v string) { o.JwtAccessToken = &v } +// GetTicketInfo returns the TicketInfo field value if set, zero value otherwise. +func (o *AuthorizationIssueResponse) GetTicketInfo() string { + if o == nil || isNil(o.TicketInfo) { + var ret string + return ret + } + return *o.TicketInfo +} + +// GetTicketInfoOk returns a tuple with the TicketInfo field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AuthorizationIssueResponse) GetTicketInfoOk() (*string, bool) { + if o == nil || isNil(o.TicketInfo) { + return nil, false + } + return o.TicketInfo, true +} + +// HasTicketInfo returns a boolean if a field has been set. +func (o *AuthorizationIssueResponse) HasTicketInfo() bool { + if o != nil && !isNil(o.TicketInfo) { + return true + } + + return false +} + +// SetTicketInfo gets a reference to the given string and assigns it to the TicketInfo field. +func (o *AuthorizationIssueResponse) SetTicketInfo(v string) { + o.TicketInfo = &v +} + func (o AuthorizationIssueResponse) MarshalJSON() ([]byte, error) { toSerialize,err := o.ToMap() if err != nil { @@ -418,6 +452,9 @@ func (o AuthorizationIssueResponse) ToMap() (map[string]interface{}, error) { if !isNil(o.JwtAccessToken) { toSerialize["jwtAccessToken"] = o.JwtAccessToken } + if !isNil(o.TicketInfo) { + toSerialize["ticketInfo"] = o.TicketInfo + } return toSerialize, nil } diff --git a/model_authorization_request.go b/model_authorization_request.go index c517525..59feee8 100644 --- a/model_authorization_request.go +++ b/model_authorization_request.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_authorization_response.go b/model_authorization_response.go index 0974089..d127358 100644 --- a/model_authorization_response.go +++ b/model_authorization_response.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. @@ -25,7 +25,7 @@ type AuthorizationResponse struct { ResultMessage *string `json:"resultMessage,omitempty"` // The next action that the authorization server implementation should take. Action *string `json:"action,omitempty"` - Client *Client `json:"client,omitempty"` + Client *ClientLimitedAuthorization `json:"client,omitempty"` Display *Display `json:"display,omitempty"` // The maximum authentication age. This value comes from `max_age` request parameter, or `defaultMaxAge` configuration parameter of the client application when the authorization request does not contain `max_age` request parameter. See \"[OpenID Connect Core 1.0, 3.1.2.1. Authentication Request](https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest), max_age\" for `max_age` request parameter, and see \"[OpenID Connect Dynamic Client Registration 1.0, 2. Client Metadata](https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata), default_max_age\" for `defaultMaxAge` configuration parameter. MaxAge *int32 `json:"maxAge,omitempty"` @@ -80,8 +80,13 @@ type AuthorizationResponse struct { RequestedVerifiedClaimsForTx [][]string `json:"requestedVerifiedClaimsForTx,omitempty"` // the value of the `transformed_claims` property in the `claims` request parameter of an authorization request or in the `claims` property in a request object. TransformedClaims *string `json:"transformedClaims,omitempty"` - // Flag which indicates whether the entity ID of the client was used when the request for the access token was made. + // Flag which indicates whether the entity ID of the client was used when the request for the access token was made. ClientEntityIdUsed *bool `json:"clientEntityIdUsed,omitempty"` + // Get the list of claims that the client application requests to be embedded in userinfo responses. The value comes from the `\"scope\"` and `\"claims\"` request parameters of the original authorization request. + ClaimsAtUserInfo []string `json:"claimsAtUserInfo,omitempty"` + CredentialOfferInfo *CredentialOfferInfo `json:"credentialOfferInfo,omitempty"` + // Get the information about the issuable credentials that can be obtained by presenting the access token that will be issued as a result of the authorization request. + IssuableCredentials *string `json:"issuableCredentials,omitempty"` } // NewAuthorizationResponse instantiates a new AuthorizationResponse object @@ -198,9 +203,9 @@ func (o *AuthorizationResponse) SetAction(v string) { } // GetClient returns the Client field value if set, zero value otherwise. -func (o *AuthorizationResponse) GetClient() Client { +func (o *AuthorizationResponse) GetClient() ClientLimitedAuthorization { if o == nil || isNil(o.Client) { - var ret Client + var ret ClientLimitedAuthorization return ret } return *o.Client @@ -208,7 +213,7 @@ func (o *AuthorizationResponse) GetClient() Client { // GetClientOk returns a tuple with the Client field value if set, nil otherwise // and a boolean to check if the value has been set. -func (o *AuthorizationResponse) GetClientOk() (*Client, bool) { +func (o *AuthorizationResponse) GetClientOk() (*ClientLimitedAuthorization, bool) { if o == nil || isNil(o.Client) { return nil, false } @@ -224,8 +229,8 @@ func (o *AuthorizationResponse) HasClient() bool { return false } -// SetClient gets a reference to the given Client and assigns it to the Client field. -func (o *AuthorizationResponse) SetClient(v Client) { +// SetClient gets a reference to the given ClientLimitedAuthorization and assigns it to the Client field. +func (o *AuthorizationResponse) SetClient(v ClientLimitedAuthorization) { o.Client = &v } @@ -1221,6 +1226,102 @@ func (o *AuthorizationResponse) SetClientEntityIdUsed(v bool) { o.ClientEntityIdUsed = &v } +// GetClaimsAtUserInfo returns the ClaimsAtUserInfo field value if set, zero value otherwise. +func (o *AuthorizationResponse) GetClaimsAtUserInfo() []string { + if o == nil || isNil(o.ClaimsAtUserInfo) { + var ret []string + return ret + } + return o.ClaimsAtUserInfo +} + +// GetClaimsAtUserInfoOk returns a tuple with the ClaimsAtUserInfo field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AuthorizationResponse) GetClaimsAtUserInfoOk() ([]string, bool) { + if o == nil || isNil(o.ClaimsAtUserInfo) { + return nil, false + } + return o.ClaimsAtUserInfo, true +} + +// HasClaimsAtUserInfo returns a boolean if a field has been set. +func (o *AuthorizationResponse) HasClaimsAtUserInfo() bool { + if o != nil && !isNil(o.ClaimsAtUserInfo) { + return true + } + + return false +} + +// SetClaimsAtUserInfo gets a reference to the given []string and assigns it to the ClaimsAtUserInfo field. +func (o *AuthorizationResponse) SetClaimsAtUserInfo(v []string) { + o.ClaimsAtUserInfo = v +} + +// GetCredentialOfferInfo returns the CredentialOfferInfo field value if set, zero value otherwise. +func (o *AuthorizationResponse) GetCredentialOfferInfo() CredentialOfferInfo { + if o == nil || isNil(o.CredentialOfferInfo) { + var ret CredentialOfferInfo + return ret + } + return *o.CredentialOfferInfo +} + +// GetCredentialOfferInfoOk returns a tuple with the CredentialOfferInfo field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AuthorizationResponse) GetCredentialOfferInfoOk() (*CredentialOfferInfo, bool) { + if o == nil || isNil(o.CredentialOfferInfo) { + return nil, false + } + return o.CredentialOfferInfo, true +} + +// HasCredentialOfferInfo returns a boolean if a field has been set. +func (o *AuthorizationResponse) HasCredentialOfferInfo() bool { + if o != nil && !isNil(o.CredentialOfferInfo) { + return true + } + + return false +} + +// SetCredentialOfferInfo gets a reference to the given CredentialOfferInfo and assigns it to the CredentialOfferInfo field. +func (o *AuthorizationResponse) SetCredentialOfferInfo(v CredentialOfferInfo) { + o.CredentialOfferInfo = &v +} + +// GetIssuableCredentials returns the IssuableCredentials field value if set, zero value otherwise. +func (o *AuthorizationResponse) GetIssuableCredentials() string { + if o == nil || isNil(o.IssuableCredentials) { + var ret string + return ret + } + return *o.IssuableCredentials +} + +// GetIssuableCredentialsOk returns a tuple with the IssuableCredentials field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AuthorizationResponse) GetIssuableCredentialsOk() (*string, bool) { + if o == nil || isNil(o.IssuableCredentials) { + return nil, false + } + return o.IssuableCredentials, true +} + +// HasIssuableCredentials returns a boolean if a field has been set. +func (o *AuthorizationResponse) HasIssuableCredentials() bool { + if o != nil && !isNil(o.IssuableCredentials) { + return true + } + + return false +} + +// SetIssuableCredentials gets a reference to the given string and assigns it to the IssuableCredentials field. +func (o *AuthorizationResponse) SetIssuableCredentials(v string) { + o.IssuableCredentials = &v +} + func (o AuthorizationResponse) MarshalJSON() ([]byte, error) { toSerialize,err := o.ToMap() if err != nil { @@ -1336,6 +1437,15 @@ func (o AuthorizationResponse) ToMap() (map[string]interface{}, error) { if !isNil(o.ClientEntityIdUsed) { toSerialize["clientEntityIdUsed"] = o.ClientEntityIdUsed } + if !isNil(o.ClaimsAtUserInfo) { + toSerialize["claimsAtUserInfo"] = o.ClaimsAtUserInfo + } + if !isNil(o.CredentialOfferInfo) { + toSerialize["credentialOfferInfo"] = o.CredentialOfferInfo + } + if !isNil(o.IssuableCredentials) { + toSerialize["issuableCredentials"] = o.IssuableCredentials + } return toSerialize, nil } diff --git a/model_authorization_ticket_info_request.go b/model_authorization_ticket_info_request.go new file mode 100644 index 0000000..2251316 --- /dev/null +++ b/model_authorization_ticket_info_request.go @@ -0,0 +1,118 @@ +/* +Authlete API + +Authlete API Document. + +API version: 3.0.0 +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package authlete + +import ( + "encoding/json" +) + +// checks if the AuthorizationTicketInfoRequest type satisfies the MappedNullable interface at compile time +var _ MappedNullable = &AuthorizationTicketInfoRequest{} + +// AuthorizationTicketInfoRequest struct for AuthorizationTicketInfoRequest +type AuthorizationTicketInfoRequest struct { + // The ticket that has been issued from the `/auth/authorization` API. + Ticket string `json:"ticket"` +} + +// NewAuthorizationTicketInfoRequest instantiates a new AuthorizationTicketInfoRequest object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewAuthorizationTicketInfoRequest(ticket string) *AuthorizationTicketInfoRequest { + this := AuthorizationTicketInfoRequest{} + this.Ticket = ticket + return &this +} + +// NewAuthorizationTicketInfoRequestWithDefaults instantiates a new AuthorizationTicketInfoRequest object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewAuthorizationTicketInfoRequestWithDefaults() *AuthorizationTicketInfoRequest { + this := AuthorizationTicketInfoRequest{} + return &this +} + +// GetTicket returns the Ticket field value +func (o *AuthorizationTicketInfoRequest) GetTicket() string { + if o == nil { + var ret string + return ret + } + + return o.Ticket +} + +// GetTicketOk returns a tuple with the Ticket field value +// and a boolean to check if the value has been set. +func (o *AuthorizationTicketInfoRequest) GetTicketOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.Ticket, true +} + +// SetTicket sets field value +func (o *AuthorizationTicketInfoRequest) SetTicket(v string) { + o.Ticket = v +} + +func (o AuthorizationTicketInfoRequest) MarshalJSON() ([]byte, error) { + toSerialize,err := o.ToMap() + if err != nil { + return []byte{}, err + } + return json.Marshal(toSerialize) +} + +func (o AuthorizationTicketInfoRequest) ToMap() (map[string]interface{}, error) { + toSerialize := map[string]interface{}{} + toSerialize["ticket"] = o.Ticket + return toSerialize, nil +} + +type NullableAuthorizationTicketInfoRequest struct { + value *AuthorizationTicketInfoRequest + isSet bool +} + +func (v NullableAuthorizationTicketInfoRequest) Get() *AuthorizationTicketInfoRequest { + return v.value +} + +func (v *NullableAuthorizationTicketInfoRequest) Set(val *AuthorizationTicketInfoRequest) { + v.value = val + v.isSet = true +} + +func (v NullableAuthorizationTicketInfoRequest) IsSet() bool { + return v.isSet +} + +func (v *NullableAuthorizationTicketInfoRequest) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableAuthorizationTicketInfoRequest(val *AuthorizationTicketInfoRequest) *NullableAuthorizationTicketInfoRequest { + return &NullableAuthorizationTicketInfoRequest{value: val, isSet: true} +} + +func (v NullableAuthorizationTicketInfoRequest) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableAuthorizationTicketInfoRequest) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/model_authorization_ticket_info_response.go b/model_authorization_ticket_info_response.go new file mode 100644 index 0000000..32b9192 --- /dev/null +++ b/model_authorization_ticket_info_response.go @@ -0,0 +1,238 @@ +/* +Authlete API + +Authlete API Document. + +API version: 3.0.0 +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package authlete + +import ( + "encoding/json" +) + +// checks if the AuthorizationTicketInfoResponse type satisfies the MappedNullable interface at compile time +var _ MappedNullable = &AuthorizationTicketInfoResponse{} + +// AuthorizationTicketInfoResponse struct for AuthorizationTicketInfoResponse +type AuthorizationTicketInfoResponse struct { + // Information about the ticket. + Info *string `json:"info,omitempty"` + // The result of the `/auth/authorization/ticket/info` API call. + Action *string `json:"action,omitempty"` + // The code which represents the result of the API call. + ResultCode *string `json:"resultCode,omitempty"` + // A short message which explains the result of the API call. + ResultMessage *string `json:"resultMessage,omitempty"` +} + +// NewAuthorizationTicketInfoResponse instantiates a new AuthorizationTicketInfoResponse object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewAuthorizationTicketInfoResponse() *AuthorizationTicketInfoResponse { + this := AuthorizationTicketInfoResponse{} + return &this +} + +// NewAuthorizationTicketInfoResponseWithDefaults instantiates a new AuthorizationTicketInfoResponse object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewAuthorizationTicketInfoResponseWithDefaults() *AuthorizationTicketInfoResponse { + this := AuthorizationTicketInfoResponse{} + return &this +} + +// GetInfo returns the Info field value if set, zero value otherwise. +func (o *AuthorizationTicketInfoResponse) GetInfo() string { + if o == nil || isNil(o.Info) { + var ret string + return ret + } + return *o.Info +} + +// GetInfoOk returns a tuple with the Info field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AuthorizationTicketInfoResponse) GetInfoOk() (*string, bool) { + if o == nil || isNil(o.Info) { + return nil, false + } + return o.Info, true +} + +// HasInfo returns a boolean if a field has been set. +func (o *AuthorizationTicketInfoResponse) HasInfo() bool { + if o != nil && !isNil(o.Info) { + return true + } + + return false +} + +// SetInfo gets a reference to the given string and assigns it to the Info field. +func (o *AuthorizationTicketInfoResponse) SetInfo(v string) { + o.Info = &v +} + +// GetAction returns the Action field value if set, zero value otherwise. +func (o *AuthorizationTicketInfoResponse) GetAction() string { + if o == nil || isNil(o.Action) { + var ret string + return ret + } + return *o.Action +} + +// GetActionOk returns a tuple with the Action field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AuthorizationTicketInfoResponse) GetActionOk() (*string, bool) { + if o == nil || isNil(o.Action) { + return nil, false + } + return o.Action, true +} + +// HasAction returns a boolean if a field has been set. +func (o *AuthorizationTicketInfoResponse) HasAction() bool { + if o != nil && !isNil(o.Action) { + return true + } + + return false +} + +// SetAction gets a reference to the given string and assigns it to the Action field. +func (o *AuthorizationTicketInfoResponse) SetAction(v string) { + o.Action = &v +} + +// GetResultCode returns the ResultCode field value if set, zero value otherwise. +func (o *AuthorizationTicketInfoResponse) GetResultCode() string { + if o == nil || isNil(o.ResultCode) { + var ret string + return ret + } + return *o.ResultCode +} + +// GetResultCodeOk returns a tuple with the ResultCode field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AuthorizationTicketInfoResponse) GetResultCodeOk() (*string, bool) { + if o == nil || isNil(o.ResultCode) { + return nil, false + } + return o.ResultCode, true +} + +// HasResultCode returns a boolean if a field has been set. +func (o *AuthorizationTicketInfoResponse) HasResultCode() bool { + if o != nil && !isNil(o.ResultCode) { + return true + } + + return false +} + +// SetResultCode gets a reference to the given string and assigns it to the ResultCode field. +func (o *AuthorizationTicketInfoResponse) SetResultCode(v string) { + o.ResultCode = &v +} + +// GetResultMessage returns the ResultMessage field value if set, zero value otherwise. +func (o *AuthorizationTicketInfoResponse) GetResultMessage() string { + if o == nil || isNil(o.ResultMessage) { + var ret string + return ret + } + return *o.ResultMessage +} + +// GetResultMessageOk returns a tuple with the ResultMessage field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AuthorizationTicketInfoResponse) GetResultMessageOk() (*string, bool) { + if o == nil || isNil(o.ResultMessage) { + return nil, false + } + return o.ResultMessage, true +} + +// HasResultMessage returns a boolean if a field has been set. +func (o *AuthorizationTicketInfoResponse) HasResultMessage() bool { + if o != nil && !isNil(o.ResultMessage) { + return true + } + + return false +} + +// SetResultMessage gets a reference to the given string and assigns it to the ResultMessage field. +func (o *AuthorizationTicketInfoResponse) SetResultMessage(v string) { + o.ResultMessage = &v +} + +func (o AuthorizationTicketInfoResponse) MarshalJSON() ([]byte, error) { + toSerialize,err := o.ToMap() + if err != nil { + return []byte{}, err + } + return json.Marshal(toSerialize) +} + +func (o AuthorizationTicketInfoResponse) ToMap() (map[string]interface{}, error) { + toSerialize := map[string]interface{}{} + if !isNil(o.Info) { + toSerialize["info"] = o.Info + } + if !isNil(o.Action) { + toSerialize["action"] = o.Action + } + if !isNil(o.ResultCode) { + toSerialize["resultCode"] = o.ResultCode + } + if !isNil(o.ResultMessage) { + toSerialize["resultMessage"] = o.ResultMessage + } + return toSerialize, nil +} + +type NullableAuthorizationTicketInfoResponse struct { + value *AuthorizationTicketInfoResponse + isSet bool +} + +func (v NullableAuthorizationTicketInfoResponse) Get() *AuthorizationTicketInfoResponse { + return v.value +} + +func (v *NullableAuthorizationTicketInfoResponse) Set(val *AuthorizationTicketInfoResponse) { + v.value = val + v.isSet = true +} + +func (v NullableAuthorizationTicketInfoResponse) IsSet() bool { + return v.isSet +} + +func (v *NullableAuthorizationTicketInfoResponse) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableAuthorizationTicketInfoResponse(val *AuthorizationTicketInfoResponse) *NullableAuthorizationTicketInfoResponse { + return &NullableAuthorizationTicketInfoResponse{value: val, isSet: true} +} + +func (v NullableAuthorizationTicketInfoResponse) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableAuthorizationTicketInfoResponse) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/model_authorization_ticket_update_request.go b/model_authorization_ticket_update_request.go new file mode 100644 index 0000000..38bf3bf --- /dev/null +++ b/model_authorization_ticket_update_request.go @@ -0,0 +1,146 @@ +/* +Authlete API + +Authlete API Document. + +API version: 3.0.0 +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package authlete + +import ( + "encoding/json" +) + +// checks if the AuthorizationTicketUpdateRequest type satisfies the MappedNullable interface at compile time +var _ MappedNullable = &AuthorizationTicketUpdateRequest{} + +// AuthorizationTicketUpdateRequest struct for AuthorizationTicketUpdateRequest +type AuthorizationTicketUpdateRequest struct { + // The ticket. + Ticket string `json:"ticket"` + // The information about the ticket. + Info string `json:"info"` +} + +// NewAuthorizationTicketUpdateRequest instantiates a new AuthorizationTicketUpdateRequest object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewAuthorizationTicketUpdateRequest(ticket string, info string) *AuthorizationTicketUpdateRequest { + this := AuthorizationTicketUpdateRequest{} + this.Ticket = ticket + this.Info = info + return &this +} + +// NewAuthorizationTicketUpdateRequestWithDefaults instantiates a new AuthorizationTicketUpdateRequest object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewAuthorizationTicketUpdateRequestWithDefaults() *AuthorizationTicketUpdateRequest { + this := AuthorizationTicketUpdateRequest{} + return &this +} + +// GetTicket returns the Ticket field value +func (o *AuthorizationTicketUpdateRequest) GetTicket() string { + if o == nil { + var ret string + return ret + } + + return o.Ticket +} + +// GetTicketOk returns a tuple with the Ticket field value +// and a boolean to check if the value has been set. +func (o *AuthorizationTicketUpdateRequest) GetTicketOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.Ticket, true +} + +// SetTicket sets field value +func (o *AuthorizationTicketUpdateRequest) SetTicket(v string) { + o.Ticket = v +} + +// GetInfo returns the Info field value +func (o *AuthorizationTicketUpdateRequest) GetInfo() string { + if o == nil { + var ret string + return ret + } + + return o.Info +} + +// GetInfoOk returns a tuple with the Info field value +// and a boolean to check if the value has been set. +func (o *AuthorizationTicketUpdateRequest) GetInfoOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.Info, true +} + +// SetInfo sets field value +func (o *AuthorizationTicketUpdateRequest) SetInfo(v string) { + o.Info = v +} + +func (o AuthorizationTicketUpdateRequest) MarshalJSON() ([]byte, error) { + toSerialize,err := o.ToMap() + if err != nil { + return []byte{}, err + } + return json.Marshal(toSerialize) +} + +func (o AuthorizationTicketUpdateRequest) ToMap() (map[string]interface{}, error) { + toSerialize := map[string]interface{}{} + toSerialize["ticket"] = o.Ticket + toSerialize["info"] = o.Info + return toSerialize, nil +} + +type NullableAuthorizationTicketUpdateRequest struct { + value *AuthorizationTicketUpdateRequest + isSet bool +} + +func (v NullableAuthorizationTicketUpdateRequest) Get() *AuthorizationTicketUpdateRequest { + return v.value +} + +func (v *NullableAuthorizationTicketUpdateRequest) Set(val *AuthorizationTicketUpdateRequest) { + v.value = val + v.isSet = true +} + +func (v NullableAuthorizationTicketUpdateRequest) IsSet() bool { + return v.isSet +} + +func (v *NullableAuthorizationTicketUpdateRequest) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableAuthorizationTicketUpdateRequest(val *AuthorizationTicketUpdateRequest) *NullableAuthorizationTicketUpdateRequest { + return &NullableAuthorizationTicketUpdateRequest{value: val, isSet: true} +} + +func (v NullableAuthorizationTicketUpdateRequest) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableAuthorizationTicketUpdateRequest) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/model_authorization_ticket_update_response.go b/model_authorization_ticket_update_response.go new file mode 100644 index 0000000..25d27f0 --- /dev/null +++ b/model_authorization_ticket_update_response.go @@ -0,0 +1,238 @@ +/* +Authlete API + +Authlete API Document. + +API version: 3.0.0 +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package authlete + +import ( + "encoding/json" +) + +// checks if the AuthorizationTicketUpdateResponse type satisfies the MappedNullable interface at compile time +var _ MappedNullable = &AuthorizationTicketUpdateResponse{} + +// AuthorizationTicketUpdateResponse struct for AuthorizationTicketUpdateResponse +type AuthorizationTicketUpdateResponse struct { + // Information about the ticket. + Info *string `json:"info,omitempty"` + // The result of the /auth/authorization/ticket/info API call. + Action *string `json:"action,omitempty"` + // The code which represents the result of the API call. + ResultCode *string `json:"resultCode,omitempty"` + // A short message which explains the result of the API call. + ResultMessage *string `json:"resultMessage,omitempty"` +} + +// NewAuthorizationTicketUpdateResponse instantiates a new AuthorizationTicketUpdateResponse object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewAuthorizationTicketUpdateResponse() *AuthorizationTicketUpdateResponse { + this := AuthorizationTicketUpdateResponse{} + return &this +} + +// NewAuthorizationTicketUpdateResponseWithDefaults instantiates a new AuthorizationTicketUpdateResponse object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewAuthorizationTicketUpdateResponseWithDefaults() *AuthorizationTicketUpdateResponse { + this := AuthorizationTicketUpdateResponse{} + return &this +} + +// GetInfo returns the Info field value if set, zero value otherwise. +func (o *AuthorizationTicketUpdateResponse) GetInfo() string { + if o == nil || isNil(o.Info) { + var ret string + return ret + } + return *o.Info +} + +// GetInfoOk returns a tuple with the Info field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AuthorizationTicketUpdateResponse) GetInfoOk() (*string, bool) { + if o == nil || isNil(o.Info) { + return nil, false + } + return o.Info, true +} + +// HasInfo returns a boolean if a field has been set. +func (o *AuthorizationTicketUpdateResponse) HasInfo() bool { + if o != nil && !isNil(o.Info) { + return true + } + + return false +} + +// SetInfo gets a reference to the given string and assigns it to the Info field. +func (o *AuthorizationTicketUpdateResponse) SetInfo(v string) { + o.Info = &v +} + +// GetAction returns the Action field value if set, zero value otherwise. +func (o *AuthorizationTicketUpdateResponse) GetAction() string { + if o == nil || isNil(o.Action) { + var ret string + return ret + } + return *o.Action +} + +// GetActionOk returns a tuple with the Action field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AuthorizationTicketUpdateResponse) GetActionOk() (*string, bool) { + if o == nil || isNil(o.Action) { + return nil, false + } + return o.Action, true +} + +// HasAction returns a boolean if a field has been set. +func (o *AuthorizationTicketUpdateResponse) HasAction() bool { + if o != nil && !isNil(o.Action) { + return true + } + + return false +} + +// SetAction gets a reference to the given string and assigns it to the Action field. +func (o *AuthorizationTicketUpdateResponse) SetAction(v string) { + o.Action = &v +} + +// GetResultCode returns the ResultCode field value if set, zero value otherwise. +func (o *AuthorizationTicketUpdateResponse) GetResultCode() string { + if o == nil || isNil(o.ResultCode) { + var ret string + return ret + } + return *o.ResultCode +} + +// GetResultCodeOk returns a tuple with the ResultCode field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AuthorizationTicketUpdateResponse) GetResultCodeOk() (*string, bool) { + if o == nil || isNil(o.ResultCode) { + return nil, false + } + return o.ResultCode, true +} + +// HasResultCode returns a boolean if a field has been set. +func (o *AuthorizationTicketUpdateResponse) HasResultCode() bool { + if o != nil && !isNil(o.ResultCode) { + return true + } + + return false +} + +// SetResultCode gets a reference to the given string and assigns it to the ResultCode field. +func (o *AuthorizationTicketUpdateResponse) SetResultCode(v string) { + o.ResultCode = &v +} + +// GetResultMessage returns the ResultMessage field value if set, zero value otherwise. +func (o *AuthorizationTicketUpdateResponse) GetResultMessage() string { + if o == nil || isNil(o.ResultMessage) { + var ret string + return ret + } + return *o.ResultMessage +} + +// GetResultMessageOk returns a tuple with the ResultMessage field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AuthorizationTicketUpdateResponse) GetResultMessageOk() (*string, bool) { + if o == nil || isNil(o.ResultMessage) { + return nil, false + } + return o.ResultMessage, true +} + +// HasResultMessage returns a boolean if a field has been set. +func (o *AuthorizationTicketUpdateResponse) HasResultMessage() bool { + if o != nil && !isNil(o.ResultMessage) { + return true + } + + return false +} + +// SetResultMessage gets a reference to the given string and assigns it to the ResultMessage field. +func (o *AuthorizationTicketUpdateResponse) SetResultMessage(v string) { + o.ResultMessage = &v +} + +func (o AuthorizationTicketUpdateResponse) MarshalJSON() ([]byte, error) { + toSerialize,err := o.ToMap() + if err != nil { + return []byte{}, err + } + return json.Marshal(toSerialize) +} + +func (o AuthorizationTicketUpdateResponse) ToMap() (map[string]interface{}, error) { + toSerialize := map[string]interface{}{} + if !isNil(o.Info) { + toSerialize["info"] = o.Info + } + if !isNil(o.Action) { + toSerialize["action"] = o.Action + } + if !isNil(o.ResultCode) { + toSerialize["resultCode"] = o.ResultCode + } + if !isNil(o.ResultMessage) { + toSerialize["resultMessage"] = o.ResultMessage + } + return toSerialize, nil +} + +type NullableAuthorizationTicketUpdateResponse struct { + value *AuthorizationTicketUpdateResponse + isSet bool +} + +func (v NullableAuthorizationTicketUpdateResponse) Get() *AuthorizationTicketUpdateResponse { + return v.value +} + +func (v *NullableAuthorizationTicketUpdateResponse) Set(val *AuthorizationTicketUpdateResponse) { + v.value = val + v.isSet = true +} + +func (v NullableAuthorizationTicketUpdateResponse) IsSet() bool { + return v.isSet +} + +func (v *NullableAuthorizationTicketUpdateResponse) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableAuthorizationTicketUpdateResponse(val *AuthorizationTicketUpdateResponse) *NullableAuthorizationTicketUpdateResponse { + return &NullableAuthorizationTicketUpdateResponse{value: val, isSet: true} +} + +func (v NullableAuthorizationTicketUpdateResponse) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableAuthorizationTicketUpdateResponse) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/model_authz_details.go b/model_authz_details.go index 89db97c..a019e94 100644 --- a/model_authz_details.go +++ b/model_authz_details.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_backchannel_authentication_complete_request.go b/model_backchannel_authentication_complete_request.go index c934e76..3f831cd 100644 --- a/model_backchannel_authentication_complete_request.go +++ b/model_backchannel_authentication_complete_request.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_backchannel_authentication_complete_response.go b/model_backchannel_authentication_complete_response.go index 3cd8169..0dec56c 100644 --- a/model_backchannel_authentication_complete_response.go +++ b/model_backchannel_authentication_complete_response.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_backchannel_authentication_fail_request.go b/model_backchannel_authentication_fail_request.go index d018d5c..f25d2dd 100644 --- a/model_backchannel_authentication_fail_request.go +++ b/model_backchannel_authentication_fail_request.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_backchannel_authentication_fail_response.go b/model_backchannel_authentication_fail_response.go index c531943..147be82 100644 --- a/model_backchannel_authentication_fail_response.go +++ b/model_backchannel_authentication_fail_response.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_backchannel_authentication_issue_request.go b/model_backchannel_authentication_issue_request.go index c227643..ce228b6 100644 --- a/model_backchannel_authentication_issue_request.go +++ b/model_backchannel_authentication_issue_request.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_backchannel_authentication_issue_response.go b/model_backchannel_authentication_issue_response.go index fee70fb..81c3865 100644 --- a/model_backchannel_authentication_issue_response.go +++ b/model_backchannel_authentication_issue_response.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_backchannel_authentication_request.go b/model_backchannel_authentication_request.go index a5f13b2..023e32a 100644 --- a/model_backchannel_authentication_request.go +++ b/model_backchannel_authentication_request.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_backchannel_authentication_response.go b/model_backchannel_authentication_response.go index affeeaf..d0f10e6 100644 --- a/model_backchannel_authentication_response.go +++ b/model_backchannel_authentication_response.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. @@ -73,6 +73,8 @@ type BackchannelAuthenticationResponse struct { // The dynamic scopes which the client application requested by the scope request parameter. DynamicScopes []DynamicScope `json:"dynamicScopes,omitempty"` DeliveryMode *DeliveryMode `json:"deliveryMode,omitempty"` + // The client authentication method that was performed. + ClientAuthMethod *string `json:"clientAuthMethod,omitempty"` GmAction *GrantManagementAction `json:"gmAction,omitempty"` // the value of the `grant_id` request parameter of the device authorization request. The `grant_id` request parameter is defined in [Grant Management for OAuth 2.0](https://openid.net/specs/fapi-grant-management.html) , which is supported by Authlete 2.3 and newer versions. GrantId *string `json:"grantId,omitempty"` @@ -998,6 +1000,38 @@ func (o *BackchannelAuthenticationResponse) SetDeliveryMode(v DeliveryMode) { o.DeliveryMode = &v } +// GetClientAuthMethod returns the ClientAuthMethod field value if set, zero value otherwise. +func (o *BackchannelAuthenticationResponse) GetClientAuthMethod() string { + if o == nil || isNil(o.ClientAuthMethod) { + var ret string + return ret + } + return *o.ClientAuthMethod +} + +// GetClientAuthMethodOk returns a tuple with the ClientAuthMethod field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *BackchannelAuthenticationResponse) GetClientAuthMethodOk() (*string, bool) { + if o == nil || isNil(o.ClientAuthMethod) { + return nil, false + } + return o.ClientAuthMethod, true +} + +// HasClientAuthMethod returns a boolean if a field has been set. +func (o *BackchannelAuthenticationResponse) HasClientAuthMethod() bool { + if o != nil && !isNil(o.ClientAuthMethod) { + return true + } + + return false +} + +// SetClientAuthMethod gets a reference to the given string and assigns it to the ClientAuthMethod field. +func (o *BackchannelAuthenticationResponse) SetClientAuthMethod(v string) { + o.ClientAuthMethod = &v +} + // GetGmAction returns the GmAction field value if set, zero value otherwise. func (o *BackchannelAuthenticationResponse) GetGmAction() GrantManagementAction { if o == nil || isNil(o.GmAction) { @@ -1284,6 +1318,9 @@ func (o BackchannelAuthenticationResponse) ToMap() (map[string]interface{}, erro if !isNil(o.DeliveryMode) { toSerialize["deliveryMode"] = o.DeliveryMode } + if !isNil(o.ClientAuthMethod) { + toSerialize["clientAuthMethod"] = o.ClientAuthMethod + } if !isNil(o.GmAction) { toSerialize["gmAction"] = o.GmAction } diff --git a/model_claim_type.go b/model_claim_type.go index f8a55c9..3020cd3 100644 --- a/model_claim_type.go +++ b/model_claim_type.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_client.go b/model_client.go index 59fe8f1..8d16de0 100644 --- a/model_client.go +++ b/model_client.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. @@ -23,8 +23,6 @@ type Client struct { Number *int32 `json:"number,omitempty"` // The sequential number of the service of the client application. The value of this property is assigned by Authlete. ServiceNumber *int32 `json:"serviceNumber,omitempty"` - // The developer of the client application. - Developer *string `json:"developer,omitempty"` // The name of the client application. This property corresponds to `client_name` in [OpenID Connect Dynamic Client Registration 1.0, 2. Client Metadata](https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata). ClientName *string `json:"clientName,omitempty"` // Client names with language tags. If the client application has different names for different languages, this property can be used to register the names. @@ -33,13 +31,13 @@ type Client struct { Description *string `json:"description,omitempty"` // Descriptions about the client application with language tags. If the client application has different descriptions for different languages, this property can be used to register the descriptions. Descriptions []TaggedValue `json:"descriptions,omitempty"` - // The client ID. The value of this property is assigned by Authlete. + // The client identifier used in Authlete API calls. The value of this property is assigned by Authlete. ClientId *int64 `json:"clientId,omitempty"` // The client secret. A random 512-bit value encoded by base64url (86 letters). The value of this property is assigned by Authlete. Note that Authlete issues a client secret even to a \"public\" client application, but the client application should not use the client secret unless it changes its client type to \"confidential\". That is, a public client application should behave as if it had not been issued a client secret. To be specific, a token request from a public client of Authlete should not come along with a client secret although [RFC 6749, 3.2.1. Client Authentication](https://datatracker.ietf.org/doc/html/rfc6749#section-3.2.1) says as follows. > Confidential clients or other clients issued client credentials MUST authenticate with the authorization server as described in Section 2.3 when making requests to the token endpoint. ClientSecret *string `json:"clientSecret,omitempty"` - // The alias of the client ID. Note that the client ID alias is recognized only when this client's `clientIdAliasEnabled` property is set to `true` AND the service's `clientIdAliasEnabled` property is also set to `true`. + // The value of the client's `client_id` property used in OAuth and OpenID Connect calls. By default, this is a string version of the `clientId` property. ClientIdAlias *string `json:"clientIdAlias,omitempty"` - // The flag to indicate whether the client ID alias is enabled or not. Note that a service also has `clientIdAliasEnabled` property. If the service's `clientIdAliasEnabled` property is set to `false`, the client ID alias of this client is not recognized even if this client's `clientIdAliasEnabled` property is set to `true`. + // Deprecated. Always set to `true`. ClientIdAliasEnabled *bool `json:"clientIdAliasEnabled,omitempty"` ClientType *ClientType `json:"clientType,omitempty"` ApplicationType NullableApplicationType `json:"applicationType,omitempty"` @@ -166,26 +164,34 @@ type Client struct { ExplicitlyRegistered *bool `json:"explicitlyRegistered,omitempty"` // The flag indicating whether this service signs responses from the resource server. RsRequestSigned *bool `json:"rsRequestSigned,omitempty"` - // Get the key ID of a JWK containing the public key used by this client to sign requests to the resource server. + // The key ID of a JWK containing the public key used by this client to sign requests to the resource server. RsSignedRequestKeyId *string `json:"rsSignedRequestKeyId,omitempty"` - // Get the client registration types that the client has declared it may use. + // The client registration types that the client has declared it may use. ClientRegistrationTypes []ClientRegistrationType `json:"clientRegistrationTypes,omitempty"` - // Get the human-readable name representing the organization that manages this client. This property corresponds to the organization_name client metadata that is defined in OpenID Connect Federation 1.0. + // The human-readable name representing the organization that manages this client. This property corresponds to the organization_name client metadata that is defined in OpenID Connect Federation 1.0. OrganizationName *string `json:"organizationName,omitempty"` - // Get the URI of the endpoint that returns this client's JWK Set document in the JWT format. This property corresponds to the `signed_jwks_uri` client metadata defined in OpenID Connect Federation 1.0. + // The URI of the endpoint that returns this client's JWK Set document in the JWT format. This property corresponds to the `signed_jwks_uri` client metadata defined in OpenID Connect Federation 1.0. SignedJwksUri *string `json:"signedJwksUri,omitempty"` // the entity ID of this client. EntityId *string `json:"entityId,omitempty"` - // The entity ID of the trust anchor of the trust chain that was used when this client was registered or updated by the mechanism defined in OpenID Connect Federation 1.0 + // The entity ID of the trust anchor of the trust chain that was used when this client was registered or updated by the mechanism defined in OpenID Connect Federation 1.0 TrustAnchorId *string `json:"trustAnchorId,omitempty"` // The trust chain that was used when this client was registered or updated by the mechanism defined in OpenID Connect Federation 1.0 TrustChain []string `json:"trustChain,omitempty"` - // the expiration time of the trust chain that was used when this client was registered or updated by the mechanism defined in OpenID Connect Federation 1.0. The value is represented as milliseconds elapsed since the Unix epoch (1970-01-01). + // the expiration time of the trust chain that was used when this client was registered or updated by the mechanism defined in OpenID Connect Federation 1.0. The value is represented as milliseconds elapsed since the Unix epoch (1970-01-01). TrustChainExpiresAt *int64 `json:"trustChainExpiresAt,omitempty"` // the time at which the trust chain was updated by the mechanism defined in OpenID Connect Federation 1.0 TrustChainUpdatedAt *int64 `json:"trustChainUpdatedAt,omitempty"` - // The flag which indicates whether this client is locked. + // The flag which indicates whether this client is locked. Locked *bool `json:"locked,omitempty"` + // The URL of the credential offer endpoint at which this client (wallet) receives a credential offer from the credential issuer. + CredentialOfferEndpoint *string `json:"credentialOfferEndpoint,omitempty"` + // The FAPI modes for this client. When the value of this property is not `null`, Authlete always processes requests from this client based on the specified FAPI modes if the FAPI feature is enabled in Authlete, the FAPI profile is supported by the service, and the FAPI modes for the service are set to `null`. For instance, when this property is set to an array containing `FAPI1_ADVANCED` only, Authlete always processes requests from this client based on \"Financial-grade API Security Profile 1.0 - Part 2: Advanced\" if the FAPI feature is enabled in Authlete, the FAPI profile is supported by the service, and the FAPI modes for the service are set to `null`. + FapiModes []FapiMode `json:"fapiModes,omitempty"` + // The response modes that this client may use. + ResponseModes []string `json:"responseModes,omitempty"` + // True if credential responses to this client must be always encrypted. + CredentialResponseEncryptionRequired *bool `json:"credentialResponseEncryptionRequired,omitempty"` } // NewClient instantiates a new Client object @@ -269,38 +275,6 @@ func (o *Client) SetServiceNumber(v int32) { o.ServiceNumber = &v } -// GetDeveloper returns the Developer field value if set, zero value otherwise. -func (o *Client) GetDeveloper() string { - if o == nil || isNil(o.Developer) { - var ret string - return ret - } - return *o.Developer -} - -// GetDeveloperOk returns a tuple with the Developer field value if set, nil otherwise -// and a boolean to check if the value has been set. -func (o *Client) GetDeveloperOk() (*string, bool) { - if o == nil || isNil(o.Developer) { - return nil, false - } - return o.Developer, true -} - -// HasDeveloper returns a boolean if a field has been set. -func (o *Client) HasDeveloper() bool { - if o != nil && !isNil(o.Developer) { - return true - } - - return false -} - -// SetDeveloper gets a reference to the given string and assigns it to the Developer field. -func (o *Client) SetDeveloper(v string) { - o.Developer = &v -} - // GetClientName returns the ClientName field value if set, zero value otherwise. func (o *Client) GetClientName() string { if o == nil || isNil(o.ClientName) { @@ -3191,6 +3165,134 @@ func (o *Client) SetLocked(v bool) { o.Locked = &v } +// GetCredentialOfferEndpoint returns the CredentialOfferEndpoint field value if set, zero value otherwise. +func (o *Client) GetCredentialOfferEndpoint() string { + if o == nil || isNil(o.CredentialOfferEndpoint) { + var ret string + return ret + } + return *o.CredentialOfferEndpoint +} + +// GetCredentialOfferEndpointOk returns a tuple with the CredentialOfferEndpoint field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *Client) GetCredentialOfferEndpointOk() (*string, bool) { + if o == nil || isNil(o.CredentialOfferEndpoint) { + return nil, false + } + return o.CredentialOfferEndpoint, true +} + +// HasCredentialOfferEndpoint returns a boolean if a field has been set. +func (o *Client) HasCredentialOfferEndpoint() bool { + if o != nil && !isNil(o.CredentialOfferEndpoint) { + return true + } + + return false +} + +// SetCredentialOfferEndpoint gets a reference to the given string and assigns it to the CredentialOfferEndpoint field. +func (o *Client) SetCredentialOfferEndpoint(v string) { + o.CredentialOfferEndpoint = &v +} + +// GetFapiModes returns the FapiModes field value if set, zero value otherwise. +func (o *Client) GetFapiModes() []FapiMode { + if o == nil || isNil(o.FapiModes) { + var ret []FapiMode + return ret + } + return o.FapiModes +} + +// GetFapiModesOk returns a tuple with the FapiModes field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *Client) GetFapiModesOk() ([]FapiMode, bool) { + if o == nil || isNil(o.FapiModes) { + return nil, false + } + return o.FapiModes, true +} + +// HasFapiModes returns a boolean if a field has been set. +func (o *Client) HasFapiModes() bool { + if o != nil && !isNil(o.FapiModes) { + return true + } + + return false +} + +// SetFapiModes gets a reference to the given []FapiMode and assigns it to the FapiModes field. +func (o *Client) SetFapiModes(v []FapiMode) { + o.FapiModes = v +} + +// GetResponseModes returns the ResponseModes field value if set, zero value otherwise. +func (o *Client) GetResponseModes() []string { + if o == nil || isNil(o.ResponseModes) { + var ret []string + return ret + } + return o.ResponseModes +} + +// GetResponseModesOk returns a tuple with the ResponseModes field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *Client) GetResponseModesOk() ([]string, bool) { + if o == nil || isNil(o.ResponseModes) { + return nil, false + } + return o.ResponseModes, true +} + +// HasResponseModes returns a boolean if a field has been set. +func (o *Client) HasResponseModes() bool { + if o != nil && !isNil(o.ResponseModes) { + return true + } + + return false +} + +// SetResponseModes gets a reference to the given []string and assigns it to the ResponseModes field. +func (o *Client) SetResponseModes(v []string) { + o.ResponseModes = v +} + +// GetCredentialResponseEncryptionRequired returns the CredentialResponseEncryptionRequired field value if set, zero value otherwise. +func (o *Client) GetCredentialResponseEncryptionRequired() bool { + if o == nil || isNil(o.CredentialResponseEncryptionRequired) { + var ret bool + return ret + } + return *o.CredentialResponseEncryptionRequired +} + +// GetCredentialResponseEncryptionRequiredOk returns a tuple with the CredentialResponseEncryptionRequired field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *Client) GetCredentialResponseEncryptionRequiredOk() (*bool, bool) { + if o == nil || isNil(o.CredentialResponseEncryptionRequired) { + return nil, false + } + return o.CredentialResponseEncryptionRequired, true +} + +// HasCredentialResponseEncryptionRequired returns a boolean if a field has been set. +func (o *Client) HasCredentialResponseEncryptionRequired() bool { + if o != nil && !isNil(o.CredentialResponseEncryptionRequired) { + return true + } + + return false +} + +// SetCredentialResponseEncryptionRequired gets a reference to the given bool and assigns it to the CredentialResponseEncryptionRequired field. +func (o *Client) SetCredentialResponseEncryptionRequired(v bool) { + o.CredentialResponseEncryptionRequired = &v +} + func (o Client) MarshalJSON() ([]byte, error) { toSerialize,err := o.ToMap() if err != nil { @@ -3207,9 +3309,6 @@ func (o Client) ToMap() (map[string]interface{}, error) { if !isNil(o.ServiceNumber) { toSerialize["serviceNumber"] = o.ServiceNumber } - if !isNil(o.Developer) { - toSerialize["developer"] = o.Developer - } if !isNil(o.ClientName) { toSerialize["clientName"] = o.ClientName } @@ -3480,6 +3579,18 @@ func (o Client) ToMap() (map[string]interface{}, error) { if !isNil(o.Locked) { toSerialize["locked"] = o.Locked } + if !isNil(o.CredentialOfferEndpoint) { + toSerialize["credentialOfferEndpoint"] = o.CredentialOfferEndpoint + } + if !isNil(o.FapiModes) { + toSerialize["fapiModes"] = o.FapiModes + } + if !isNil(o.ResponseModes) { + toSerialize["responseModes"] = o.ResponseModes + } + if !isNil(o.CredentialResponseEncryptionRequired) { + toSerialize["credentialResponseEncryptionRequired"] = o.CredentialResponseEncryptionRequired + } return toSerialize, nil } diff --git a/model_client_auth_method.go b/model_client_auth_method.go index 5b3039b..a7e264e 100644 --- a/model_client_auth_method.go +++ b/model_client_auth_method.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_client_authentication_method.go b/model_client_authentication_method.go index d0d726a..11ef7c8 100644 --- a/model_client_authentication_method.go +++ b/model_client_authentication_method.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_client_authorization_delete_response.go b/model_client_authorization_delete_response.go index d787a26..7deb1c8 100644 --- a/model_client_authorization_delete_response.go +++ b/model_client_authorization_delete_response.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. @@ -23,6 +23,18 @@ type ClientAuthorizationDeleteResponse struct { ResultCode *string `json:"resultCode,omitempty"` // A short message which explains the result of the API call. ResultMessage *string `json:"resultMessage,omitempty"` + // A short message which explains the result of the API call. + ServiceApiKey *int64 `json:"serviceApiKey,omitempty"` + // Get the client ID. + ClientId *int64 `json:"clientId,omitempty"` + // Get the subject (= unique identifier) of the user who has granted authorization to the client. + Subject *string `json:"subject,omitempty"` + // Get the scopes granted to the client application by the last authorization process by the user (who is identified by the subject). + LatestGrantedScopes []string `json:"latestGrantedScopes,omitempty"` + // Get the scopes granted to the client application by all the past authorization processes. Note that revoked scopes are not included. + MergedGrantedScopes []string `json:"mergedGrantedScopes,omitempty"` + // Get the timestamp in milliseconds since Unix epoch at which this record was modified. + ModifiedAt *int64 `json:"modifiedAt,omitempty"` } // NewClientAuthorizationDeleteResponse instantiates a new ClientAuthorizationDeleteResponse object @@ -106,6 +118,198 @@ func (o *ClientAuthorizationDeleteResponse) SetResultMessage(v string) { o.ResultMessage = &v } +// GetServiceApiKey returns the ServiceApiKey field value if set, zero value otherwise. +func (o *ClientAuthorizationDeleteResponse) GetServiceApiKey() int64 { + if o == nil || isNil(o.ServiceApiKey) { + var ret int64 + return ret + } + return *o.ServiceApiKey +} + +// GetServiceApiKeyOk returns a tuple with the ServiceApiKey field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ClientAuthorizationDeleteResponse) GetServiceApiKeyOk() (*int64, bool) { + if o == nil || isNil(o.ServiceApiKey) { + return nil, false + } + return o.ServiceApiKey, true +} + +// HasServiceApiKey returns a boolean if a field has been set. +func (o *ClientAuthorizationDeleteResponse) HasServiceApiKey() bool { + if o != nil && !isNil(o.ServiceApiKey) { + return true + } + + return false +} + +// SetServiceApiKey gets a reference to the given int64 and assigns it to the ServiceApiKey field. +func (o *ClientAuthorizationDeleteResponse) SetServiceApiKey(v int64) { + o.ServiceApiKey = &v +} + +// GetClientId returns the ClientId field value if set, zero value otherwise. +func (o *ClientAuthorizationDeleteResponse) GetClientId() int64 { + if o == nil || isNil(o.ClientId) { + var ret int64 + return ret + } + return *o.ClientId +} + +// GetClientIdOk returns a tuple with the ClientId field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ClientAuthorizationDeleteResponse) GetClientIdOk() (*int64, bool) { + if o == nil || isNil(o.ClientId) { + return nil, false + } + return o.ClientId, true +} + +// HasClientId returns a boolean if a field has been set. +func (o *ClientAuthorizationDeleteResponse) HasClientId() bool { + if o != nil && !isNil(o.ClientId) { + return true + } + + return false +} + +// SetClientId gets a reference to the given int64 and assigns it to the ClientId field. +func (o *ClientAuthorizationDeleteResponse) SetClientId(v int64) { + o.ClientId = &v +} + +// GetSubject returns the Subject field value if set, zero value otherwise. +func (o *ClientAuthorizationDeleteResponse) GetSubject() string { + if o == nil || isNil(o.Subject) { + var ret string + return ret + } + return *o.Subject +} + +// GetSubjectOk returns a tuple with the Subject field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ClientAuthorizationDeleteResponse) GetSubjectOk() (*string, bool) { + if o == nil || isNil(o.Subject) { + return nil, false + } + return o.Subject, true +} + +// HasSubject returns a boolean if a field has been set. +func (o *ClientAuthorizationDeleteResponse) HasSubject() bool { + if o != nil && !isNil(o.Subject) { + return true + } + + return false +} + +// SetSubject gets a reference to the given string and assigns it to the Subject field. +func (o *ClientAuthorizationDeleteResponse) SetSubject(v string) { + o.Subject = &v +} + +// GetLatestGrantedScopes returns the LatestGrantedScopes field value if set, zero value otherwise. +func (o *ClientAuthorizationDeleteResponse) GetLatestGrantedScopes() []string { + if o == nil || isNil(o.LatestGrantedScopes) { + var ret []string + return ret + } + return o.LatestGrantedScopes +} + +// GetLatestGrantedScopesOk returns a tuple with the LatestGrantedScopes field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ClientAuthorizationDeleteResponse) GetLatestGrantedScopesOk() ([]string, bool) { + if o == nil || isNil(o.LatestGrantedScopes) { + return nil, false + } + return o.LatestGrantedScopes, true +} + +// HasLatestGrantedScopes returns a boolean if a field has been set. +func (o *ClientAuthorizationDeleteResponse) HasLatestGrantedScopes() bool { + if o != nil && !isNil(o.LatestGrantedScopes) { + return true + } + + return false +} + +// SetLatestGrantedScopes gets a reference to the given []string and assigns it to the LatestGrantedScopes field. +func (o *ClientAuthorizationDeleteResponse) SetLatestGrantedScopes(v []string) { + o.LatestGrantedScopes = v +} + +// GetMergedGrantedScopes returns the MergedGrantedScopes field value if set, zero value otherwise. +func (o *ClientAuthorizationDeleteResponse) GetMergedGrantedScopes() []string { + if o == nil || isNil(o.MergedGrantedScopes) { + var ret []string + return ret + } + return o.MergedGrantedScopes +} + +// GetMergedGrantedScopesOk returns a tuple with the MergedGrantedScopes field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ClientAuthorizationDeleteResponse) GetMergedGrantedScopesOk() ([]string, bool) { + if o == nil || isNil(o.MergedGrantedScopes) { + return nil, false + } + return o.MergedGrantedScopes, true +} + +// HasMergedGrantedScopes returns a boolean if a field has been set. +func (o *ClientAuthorizationDeleteResponse) HasMergedGrantedScopes() bool { + if o != nil && !isNil(o.MergedGrantedScopes) { + return true + } + + return false +} + +// SetMergedGrantedScopes gets a reference to the given []string and assigns it to the MergedGrantedScopes field. +func (o *ClientAuthorizationDeleteResponse) SetMergedGrantedScopes(v []string) { + o.MergedGrantedScopes = v +} + +// GetModifiedAt returns the ModifiedAt field value if set, zero value otherwise. +func (o *ClientAuthorizationDeleteResponse) GetModifiedAt() int64 { + if o == nil || isNil(o.ModifiedAt) { + var ret int64 + return ret + } + return *o.ModifiedAt +} + +// GetModifiedAtOk returns a tuple with the ModifiedAt field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ClientAuthorizationDeleteResponse) GetModifiedAtOk() (*int64, bool) { + if o == nil || isNil(o.ModifiedAt) { + return nil, false + } + return o.ModifiedAt, true +} + +// HasModifiedAt returns a boolean if a field has been set. +func (o *ClientAuthorizationDeleteResponse) HasModifiedAt() bool { + if o != nil && !isNil(o.ModifiedAt) { + return true + } + + return false +} + +// SetModifiedAt gets a reference to the given int64 and assigns it to the ModifiedAt field. +func (o *ClientAuthorizationDeleteResponse) SetModifiedAt(v int64) { + o.ModifiedAt = &v +} + func (o ClientAuthorizationDeleteResponse) MarshalJSON() ([]byte, error) { toSerialize,err := o.ToMap() if err != nil { @@ -122,6 +326,24 @@ func (o ClientAuthorizationDeleteResponse) ToMap() (map[string]interface{}, erro if !isNil(o.ResultMessage) { toSerialize["resultMessage"] = o.ResultMessage } + if !isNil(o.ServiceApiKey) { + toSerialize["serviceApiKey"] = o.ServiceApiKey + } + if !isNil(o.ClientId) { + toSerialize["clientId"] = o.ClientId + } + if !isNil(o.Subject) { + toSerialize["subject"] = o.Subject + } + if !isNil(o.LatestGrantedScopes) { + toSerialize["latestGrantedScopes"] = o.LatestGrantedScopes + } + if !isNil(o.MergedGrantedScopes) { + toSerialize["mergedGrantedScopes"] = o.MergedGrantedScopes + } + if !isNil(o.ModifiedAt) { + toSerialize["modifiedAt"] = o.ModifiedAt + } return toSerialize, nil } diff --git a/model_client_authorization_get_list_response.go b/model_client_authorization_get_list_response.go index 13e55b6..2e7a9b1 100644 --- a/model_client_authorization_get_list_response.go +++ b/model_client_authorization_get_list_response.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. @@ -30,7 +30,7 @@ type ClientAuthorizationGetListResponse struct { // Unique ID of a client developer. TotalCount *int32 `json:"totalCount,omitempty"` // An array of clients. - Clients []Client `json:"clients,omitempty"` + Clients []ClientLimited `json:"clients,omitempty"` } // NewClientAuthorizationGetListResponse instantiates a new ClientAuthorizationGetListResponse object @@ -211,9 +211,9 @@ func (o *ClientAuthorizationGetListResponse) SetTotalCount(v int32) { } // GetClients returns the Clients field value if set, zero value otherwise. -func (o *ClientAuthorizationGetListResponse) GetClients() []Client { +func (o *ClientAuthorizationGetListResponse) GetClients() []ClientLimited { if o == nil || isNil(o.Clients) { - var ret []Client + var ret []ClientLimited return ret } return o.Clients @@ -221,7 +221,7 @@ func (o *ClientAuthorizationGetListResponse) GetClients() []Client { // GetClientsOk returns a tuple with the Clients field value if set, nil otherwise // and a boolean to check if the value has been set. -func (o *ClientAuthorizationGetListResponse) GetClientsOk() ([]Client, bool) { +func (o *ClientAuthorizationGetListResponse) GetClientsOk() ([]ClientLimited, bool) { if o == nil || isNil(o.Clients) { return nil, false } @@ -237,8 +237,8 @@ func (o *ClientAuthorizationGetListResponse) HasClients() bool { return false } -// SetClients gets a reference to the given []Client and assigns it to the Clients field. -func (o *ClientAuthorizationGetListResponse) SetClients(v []Client) { +// SetClients gets a reference to the given []ClientLimited and assigns it to the Clients field. +func (o *ClientAuthorizationGetListResponse) SetClients(v []ClientLimited) { o.Clients = v } diff --git a/model_client_authorization_update_request.go b/model_client_authorization_update_request.go index 582feeb..a98ed45 100644 --- a/model_client_authorization_update_request.go +++ b/model_client_authorization_update_request.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_client_authorization_update_response.go b/model_client_authorization_update_response.go index ecd4e51..12a494c 100644 --- a/model_client_authorization_update_response.go +++ b/model_client_authorization_update_response.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_client_extension.go b/model_client_extension.go index 504aae8..7fec271 100644 --- a/model_client_extension.go +++ b/model_client_extension.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_client_extension_requestable_scopes_get_response.go b/model_client_extension_requestable_scopes_get_response.go index b679c39..ad5e360 100644 --- a/model_client_extension_requestable_scopes_get_response.go +++ b/model_client_extension_requestable_scopes_get_response.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_client_extension_requestable_scopes_update_request.go b/model_client_extension_requestable_scopes_update_request.go index a9954f4..b24f7a7 100644 --- a/model_client_extension_requestable_scopes_update_request.go +++ b/model_client_extension_requestable_scopes_update_request.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_client_extension_requestable_scopes_update_response.go b/model_client_extension_requestable_scopes_update_response.go index 6c242d9..950c3e7 100644 --- a/model_client_extension_requestable_scopes_update_response.go +++ b/model_client_extension_requestable_scopes_update_response.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_client_flag_update_request.go b/model_client_flag_update_request.go index b013306..4f8915e 100644 --- a/model_client_flag_update_request.go +++ b/model_client_flag_update_request.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_client_flag_update_response.go b/model_client_flag_update_response.go index e481d55..db592ce 100644 --- a/model_client_flag_update_response.go +++ b/model_client_flag_update_response.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_client_get_list_api_200_response.go b/model_client_get_list_api_200_response.go new file mode 100644 index 0000000..097a45f --- /dev/null +++ b/model_client_get_list_api_200_response.go @@ -0,0 +1,148 @@ +/* +Authlete API + +Authlete API Document. + +API version: 3.0.0 +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package authlete + +import ( + "encoding/json" + "fmt" +) + +// ClientGetListApi200Response - struct for ClientGetListApi200Response +type ClientGetListApi200Response struct { + ClientGetListLimitedResponse *ClientGetListLimitedResponse + ClientGetListResponse *ClientGetListResponse +} + +// ClientGetListLimitedResponseAsClientGetListApi200Response is a convenience function that returns ClientGetListLimitedResponse wrapped in ClientGetListApi200Response +func ClientGetListLimitedResponseAsClientGetListApi200Response(v *ClientGetListLimitedResponse) ClientGetListApi200Response { + return ClientGetListApi200Response{ + ClientGetListLimitedResponse: v, + } +} + +// ClientGetListResponseAsClientGetListApi200Response is a convenience function that returns ClientGetListResponse wrapped in ClientGetListApi200Response +func ClientGetListResponseAsClientGetListApi200Response(v *ClientGetListResponse) ClientGetListApi200Response { + return ClientGetListApi200Response{ + ClientGetListResponse: v, + } +} + + +// Unmarshal JSON data into one of the pointers in the struct +func (dst *ClientGetListApi200Response) UnmarshalJSON(data []byte) error { + var err error + match := 0 + // try to unmarshal data into ClientGetListLimitedResponse + err = json.Unmarshal(data, &dst.ClientGetListLimitedResponse) + if err == nil { + jsonClientGetListLimitedResponse, _ := json.Marshal(dst.ClientGetListLimitedResponse) + if string(jsonClientGetListLimitedResponse) == "{}" { // empty struct + dst.ClientGetListLimitedResponse = nil + } else { + match++ + } + } else { + dst.ClientGetListLimitedResponse = nil + } + + // try to unmarshal data into ClientGetListResponse + err = json.Unmarshal(data, &dst.ClientGetListResponse) + if err == nil { + jsonClientGetListResponse, _ := json.Marshal(dst.ClientGetListResponse) + if string(jsonClientGetListResponse) == "{}" { // empty struct + dst.ClientGetListResponse = nil + } else { + match++ + } + } else { + dst.ClientGetListResponse = nil + } + + if match > 1 { // more than 1 match + // reset to nil + dst.ClientGetListLimitedResponse = nil + dst.ClientGetListResponse = nil + + return fmt.Errorf("data matches more than one schema in oneOf(ClientGetListApi200Response)") + } else if match == 1 { + return nil // exactly one match + } else { // no match + return fmt.Errorf("data failed to match schemas in oneOf(ClientGetListApi200Response)") + } +} + +// Marshal data from the first non-nil pointers in the struct to JSON +func (src ClientGetListApi200Response) MarshalJSON() ([]byte, error) { + if src.ClientGetListLimitedResponse != nil { + return json.Marshal(&src.ClientGetListLimitedResponse) + } + + if src.ClientGetListResponse != nil { + return json.Marshal(&src.ClientGetListResponse) + } + + return nil, nil // no data in oneOf schemas +} + +// Get the actual instance +func (obj *ClientGetListApi200Response) GetActualInstance() (interface{}) { + if obj == nil { + return nil + } + if obj.ClientGetListLimitedResponse != nil { + return obj.ClientGetListLimitedResponse + } + + if obj.ClientGetListResponse != nil { + return obj.ClientGetListResponse + } + + // all schemas are nil + return nil +} + +type NullableClientGetListApi200Response struct { + value *ClientGetListApi200Response + isSet bool +} + +func (v NullableClientGetListApi200Response) Get() *ClientGetListApi200Response { + return v.value +} + +func (v *NullableClientGetListApi200Response) Set(val *ClientGetListApi200Response) { + v.value = val + v.isSet = true +} + +func (v NullableClientGetListApi200Response) IsSet() bool { + return v.isSet +} + +func (v *NullableClientGetListApi200Response) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableClientGetListApi200Response(val *ClientGetListApi200Response) *NullableClientGetListApi200Response { + return &NullableClientGetListApi200Response{value: val, isSet: true} +} + +func (v NullableClientGetListApi200Response) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableClientGetListApi200Response) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/model_client_get_list_limited_response.go b/model_client_get_list_limited_response.go new file mode 100644 index 0000000..d438dab --- /dev/null +++ b/model_client_get_list_limited_response.go @@ -0,0 +1,238 @@ +/* +Authlete API + +Authlete API Document. + +API version: 3.0.0 +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package authlete + +import ( + "encoding/json" +) + +// checks if the ClientGetListLimitedResponse type satisfies the MappedNullable interface at compile time +var _ MappedNullable = &ClientGetListLimitedResponse{} + +// ClientGetListLimitedResponse struct for ClientGetListLimitedResponse +type ClientGetListLimitedResponse struct { + // Start index (inclusive) of the result set of the query. + Start *int32 `json:"start,omitempty"` + // End index (exclusive) of the result set of the query. + End *int32 `json:"end,omitempty"` + // Total number of clients that belong to the service. This doesn't mean the number of clients contained in the response. + TotalCount *int32 `json:"totalCount,omitempty"` + // An array of clients. + Clients []ClientLimited `json:"clients,omitempty"` +} + +// NewClientGetListLimitedResponse instantiates a new ClientGetListLimitedResponse object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewClientGetListLimitedResponse() *ClientGetListLimitedResponse { + this := ClientGetListLimitedResponse{} + return &this +} + +// NewClientGetListLimitedResponseWithDefaults instantiates a new ClientGetListLimitedResponse object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewClientGetListLimitedResponseWithDefaults() *ClientGetListLimitedResponse { + this := ClientGetListLimitedResponse{} + return &this +} + +// GetStart returns the Start field value if set, zero value otherwise. +func (o *ClientGetListLimitedResponse) GetStart() int32 { + if o == nil || isNil(o.Start) { + var ret int32 + return ret + } + return *o.Start +} + +// GetStartOk returns a tuple with the Start field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ClientGetListLimitedResponse) GetStartOk() (*int32, bool) { + if o == nil || isNil(o.Start) { + return nil, false + } + return o.Start, true +} + +// HasStart returns a boolean if a field has been set. +func (o *ClientGetListLimitedResponse) HasStart() bool { + if o != nil && !isNil(o.Start) { + return true + } + + return false +} + +// SetStart gets a reference to the given int32 and assigns it to the Start field. +func (o *ClientGetListLimitedResponse) SetStart(v int32) { + o.Start = &v +} + +// GetEnd returns the End field value if set, zero value otherwise. +func (o *ClientGetListLimitedResponse) GetEnd() int32 { + if o == nil || isNil(o.End) { + var ret int32 + return ret + } + return *o.End +} + +// GetEndOk returns a tuple with the End field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ClientGetListLimitedResponse) GetEndOk() (*int32, bool) { + if o == nil || isNil(o.End) { + return nil, false + } + return o.End, true +} + +// HasEnd returns a boolean if a field has been set. +func (o *ClientGetListLimitedResponse) HasEnd() bool { + if o != nil && !isNil(o.End) { + return true + } + + return false +} + +// SetEnd gets a reference to the given int32 and assigns it to the End field. +func (o *ClientGetListLimitedResponse) SetEnd(v int32) { + o.End = &v +} + +// GetTotalCount returns the TotalCount field value if set, zero value otherwise. +func (o *ClientGetListLimitedResponse) GetTotalCount() int32 { + if o == nil || isNil(o.TotalCount) { + var ret int32 + return ret + } + return *o.TotalCount +} + +// GetTotalCountOk returns a tuple with the TotalCount field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ClientGetListLimitedResponse) GetTotalCountOk() (*int32, bool) { + if o == nil || isNil(o.TotalCount) { + return nil, false + } + return o.TotalCount, true +} + +// HasTotalCount returns a boolean if a field has been set. +func (o *ClientGetListLimitedResponse) HasTotalCount() bool { + if o != nil && !isNil(o.TotalCount) { + return true + } + + return false +} + +// SetTotalCount gets a reference to the given int32 and assigns it to the TotalCount field. +func (o *ClientGetListLimitedResponse) SetTotalCount(v int32) { + o.TotalCount = &v +} + +// GetClients returns the Clients field value if set, zero value otherwise. +func (o *ClientGetListLimitedResponse) GetClients() []ClientLimited { + if o == nil || isNil(o.Clients) { + var ret []ClientLimited + return ret + } + return o.Clients +} + +// GetClientsOk returns a tuple with the Clients field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ClientGetListLimitedResponse) GetClientsOk() ([]ClientLimited, bool) { + if o == nil || isNil(o.Clients) { + return nil, false + } + return o.Clients, true +} + +// HasClients returns a boolean if a field has been set. +func (o *ClientGetListLimitedResponse) HasClients() bool { + if o != nil && !isNil(o.Clients) { + return true + } + + return false +} + +// SetClients gets a reference to the given []ClientLimited and assigns it to the Clients field. +func (o *ClientGetListLimitedResponse) SetClients(v []ClientLimited) { + o.Clients = v +} + +func (o ClientGetListLimitedResponse) MarshalJSON() ([]byte, error) { + toSerialize,err := o.ToMap() + if err != nil { + return []byte{}, err + } + return json.Marshal(toSerialize) +} + +func (o ClientGetListLimitedResponse) ToMap() (map[string]interface{}, error) { + toSerialize := map[string]interface{}{} + if !isNil(o.Start) { + toSerialize["start"] = o.Start + } + if !isNil(o.End) { + toSerialize["end"] = o.End + } + if !isNil(o.TotalCount) { + toSerialize["totalCount"] = o.TotalCount + } + if !isNil(o.Clients) { + toSerialize["clients"] = o.Clients + } + return toSerialize, nil +} + +type NullableClientGetListLimitedResponse struct { + value *ClientGetListLimitedResponse + isSet bool +} + +func (v NullableClientGetListLimitedResponse) Get() *ClientGetListLimitedResponse { + return v.value +} + +func (v *NullableClientGetListLimitedResponse) Set(val *ClientGetListLimitedResponse) { + v.value = val + v.isSet = true +} + +func (v NullableClientGetListLimitedResponse) IsSet() bool { + return v.isSet +} + +func (v *NullableClientGetListLimitedResponse) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableClientGetListLimitedResponse(val *ClientGetListLimitedResponse) *NullableClientGetListLimitedResponse { + return &NullableClientGetListLimitedResponse{value: val, isSet: true} +} + +func (v NullableClientGetListLimitedResponse) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableClientGetListLimitedResponse) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/model_client_get_list_response.go b/model_client_get_list_response.go index fbd46b7..ca0138b 100644 --- a/model_client_get_list_response.go +++ b/model_client_get_list_response.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. @@ -19,8 +19,6 @@ var _ MappedNullable = &ClientGetListResponse{} // ClientGetListResponse struct for ClientGetListResponse type ClientGetListResponse struct { - // The developer of the client applications. If the request did not contain `developer` request parameter, this property is set to `null`. - Developer *string `json:"developer,omitempty"` // Start index (inclusive) of the result set of the query. Start *int32 `json:"start,omitempty"` // End index (exclusive) of the result set of the query. @@ -48,38 +46,6 @@ func NewClientGetListResponseWithDefaults() *ClientGetListResponse { return &this } -// GetDeveloper returns the Developer field value if set, zero value otherwise. -func (o *ClientGetListResponse) GetDeveloper() string { - if o == nil || isNil(o.Developer) { - var ret string - return ret - } - return *o.Developer -} - -// GetDeveloperOk returns a tuple with the Developer field value if set, nil otherwise -// and a boolean to check if the value has been set. -func (o *ClientGetListResponse) GetDeveloperOk() (*string, bool) { - if o == nil || isNil(o.Developer) { - return nil, false - } - return o.Developer, true -} - -// HasDeveloper returns a boolean if a field has been set. -func (o *ClientGetListResponse) HasDeveloper() bool { - if o != nil && !isNil(o.Developer) { - return true - } - - return false -} - -// SetDeveloper gets a reference to the given string and assigns it to the Developer field. -func (o *ClientGetListResponse) SetDeveloper(v string) { - o.Developer = &v -} - // GetStart returns the Start field value if set, zero value otherwise. func (o *ClientGetListResponse) GetStart() int32 { if o == nil || isNil(o.Start) { @@ -218,9 +184,6 @@ func (o ClientGetListResponse) MarshalJSON() ([]byte, error) { func (o ClientGetListResponse) ToMap() (map[string]interface{}, error) { toSerialize := map[string]interface{}{} - if !isNil(o.Developer) { - toSerialize["developer"] = o.Developer - } if !isNil(o.Start) { toSerialize["start"] = o.Start } diff --git a/model_client_granted_scopes_delete_response.go b/model_client_granted_scopes_delete_response.go index de2d481..4ecb807 100644 --- a/model_client_granted_scopes_delete_response.go +++ b/model_client_granted_scopes_delete_response.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_client_limited.go b/model_client_limited.go new file mode 100644 index 0000000..de45ed8 --- /dev/null +++ b/model_client_limited.go @@ -0,0 +1,422 @@ +/* +Authlete API + +Authlete API Document. + +API version: 3.0.0 +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package authlete + +import ( + "encoding/json" +) + +// checks if the ClientLimited type satisfies the MappedNullable interface at compile time +var _ MappedNullable = &ClientLimited{} + +// ClientLimited struct for ClientLimited +type ClientLimited struct { + // The sequential number of the client. The value of this property is assigned by Authlete. + Number *int32 `json:"number,omitempty"` + // The name of the client application. This property corresponds to `client_name` in [OpenID Connect Dynamic Client Registration 1.0, 2. Client Metadata](https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata). + ClientName *string `json:"clientName,omitempty"` + // Client names with language tags. If the client application has different names for different languages, this property can be used to register the names. + ClientNames []TaggedValue `json:"clientNames,omitempty"` + // The description about the client application. + Description *string `json:"description,omitempty"` + // Descriptions about the client application with language tags. If the client application has different descriptions for different languages, this property can be used to register the descriptions. + Descriptions []TaggedValue `json:"descriptions,omitempty"` + // The client identifier used in Authlete API calls. The value of this property is assigned by Authlete. + ClientId *int64 `json:"clientId,omitempty"` + // The value of the client's `client_id` property used in OAuth and OpenID Connect calls. By default, this is a string version of the `clientId` property. + ClientIdAlias *string `json:"clientIdAlias,omitempty"` + // Deprecated. Always set to `true`. + ClientIdAliasEnabled *bool `json:"clientIdAliasEnabled,omitempty"` + ClientType *ClientType `json:"clientType,omitempty"` +} + +// NewClientLimited instantiates a new ClientLimited object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewClientLimited() *ClientLimited { + this := ClientLimited{} + return &this +} + +// NewClientLimitedWithDefaults instantiates a new ClientLimited object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewClientLimitedWithDefaults() *ClientLimited { + this := ClientLimited{} + return &this +} + +// GetNumber returns the Number field value if set, zero value otherwise. +func (o *ClientLimited) GetNumber() int32 { + if o == nil || isNil(o.Number) { + var ret int32 + return ret + } + return *o.Number +} + +// GetNumberOk returns a tuple with the Number field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ClientLimited) GetNumberOk() (*int32, bool) { + if o == nil || isNil(o.Number) { + return nil, false + } + return o.Number, true +} + +// HasNumber returns a boolean if a field has been set. +func (o *ClientLimited) HasNumber() bool { + if o != nil && !isNil(o.Number) { + return true + } + + return false +} + +// SetNumber gets a reference to the given int32 and assigns it to the Number field. +func (o *ClientLimited) SetNumber(v int32) { + o.Number = &v +} + +// GetClientName returns the ClientName field value if set, zero value otherwise. +func (o *ClientLimited) GetClientName() string { + if o == nil || isNil(o.ClientName) { + var ret string + return ret + } + return *o.ClientName +} + +// GetClientNameOk returns a tuple with the ClientName field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ClientLimited) GetClientNameOk() (*string, bool) { + if o == nil || isNil(o.ClientName) { + return nil, false + } + return o.ClientName, true +} + +// HasClientName returns a boolean if a field has been set. +func (o *ClientLimited) HasClientName() bool { + if o != nil && !isNil(o.ClientName) { + return true + } + + return false +} + +// SetClientName gets a reference to the given string and assigns it to the ClientName field. +func (o *ClientLimited) SetClientName(v string) { + o.ClientName = &v +} + +// GetClientNames returns the ClientNames field value if set, zero value otherwise. +func (o *ClientLimited) GetClientNames() []TaggedValue { + if o == nil || isNil(o.ClientNames) { + var ret []TaggedValue + return ret + } + return o.ClientNames +} + +// GetClientNamesOk returns a tuple with the ClientNames field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ClientLimited) GetClientNamesOk() ([]TaggedValue, bool) { + if o == nil || isNil(o.ClientNames) { + return nil, false + } + return o.ClientNames, true +} + +// HasClientNames returns a boolean if a field has been set. +func (o *ClientLimited) HasClientNames() bool { + if o != nil && !isNil(o.ClientNames) { + return true + } + + return false +} + +// SetClientNames gets a reference to the given []TaggedValue and assigns it to the ClientNames field. +func (o *ClientLimited) SetClientNames(v []TaggedValue) { + o.ClientNames = v +} + +// GetDescription returns the Description field value if set, zero value otherwise. +func (o *ClientLimited) GetDescription() string { + if o == nil || isNil(o.Description) { + var ret string + return ret + } + return *o.Description +} + +// GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ClientLimited) GetDescriptionOk() (*string, bool) { + if o == nil || isNil(o.Description) { + return nil, false + } + return o.Description, true +} + +// HasDescription returns a boolean if a field has been set. +func (o *ClientLimited) HasDescription() bool { + if o != nil && !isNil(o.Description) { + return true + } + + return false +} + +// SetDescription gets a reference to the given string and assigns it to the Description field. +func (o *ClientLimited) SetDescription(v string) { + o.Description = &v +} + +// GetDescriptions returns the Descriptions field value if set, zero value otherwise. +func (o *ClientLimited) GetDescriptions() []TaggedValue { + if o == nil || isNil(o.Descriptions) { + var ret []TaggedValue + return ret + } + return o.Descriptions +} + +// GetDescriptionsOk returns a tuple with the Descriptions field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ClientLimited) GetDescriptionsOk() ([]TaggedValue, bool) { + if o == nil || isNil(o.Descriptions) { + return nil, false + } + return o.Descriptions, true +} + +// HasDescriptions returns a boolean if a field has been set. +func (o *ClientLimited) HasDescriptions() bool { + if o != nil && !isNil(o.Descriptions) { + return true + } + + return false +} + +// SetDescriptions gets a reference to the given []TaggedValue and assigns it to the Descriptions field. +func (o *ClientLimited) SetDescriptions(v []TaggedValue) { + o.Descriptions = v +} + +// GetClientId returns the ClientId field value if set, zero value otherwise. +func (o *ClientLimited) GetClientId() int64 { + if o == nil || isNil(o.ClientId) { + var ret int64 + return ret + } + return *o.ClientId +} + +// GetClientIdOk returns a tuple with the ClientId field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ClientLimited) GetClientIdOk() (*int64, bool) { + if o == nil || isNil(o.ClientId) { + return nil, false + } + return o.ClientId, true +} + +// HasClientId returns a boolean if a field has been set. +func (o *ClientLimited) HasClientId() bool { + if o != nil && !isNil(o.ClientId) { + return true + } + + return false +} + +// SetClientId gets a reference to the given int64 and assigns it to the ClientId field. +func (o *ClientLimited) SetClientId(v int64) { + o.ClientId = &v +} + +// GetClientIdAlias returns the ClientIdAlias field value if set, zero value otherwise. +func (o *ClientLimited) GetClientIdAlias() string { + if o == nil || isNil(o.ClientIdAlias) { + var ret string + return ret + } + return *o.ClientIdAlias +} + +// GetClientIdAliasOk returns a tuple with the ClientIdAlias field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ClientLimited) GetClientIdAliasOk() (*string, bool) { + if o == nil || isNil(o.ClientIdAlias) { + return nil, false + } + return o.ClientIdAlias, true +} + +// HasClientIdAlias returns a boolean if a field has been set. +func (o *ClientLimited) HasClientIdAlias() bool { + if o != nil && !isNil(o.ClientIdAlias) { + return true + } + + return false +} + +// SetClientIdAlias gets a reference to the given string and assigns it to the ClientIdAlias field. +func (o *ClientLimited) SetClientIdAlias(v string) { + o.ClientIdAlias = &v +} + +// GetClientIdAliasEnabled returns the ClientIdAliasEnabled field value if set, zero value otherwise. +func (o *ClientLimited) GetClientIdAliasEnabled() bool { + if o == nil || isNil(o.ClientIdAliasEnabled) { + var ret bool + return ret + } + return *o.ClientIdAliasEnabled +} + +// GetClientIdAliasEnabledOk returns a tuple with the ClientIdAliasEnabled field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ClientLimited) GetClientIdAliasEnabledOk() (*bool, bool) { + if o == nil || isNil(o.ClientIdAliasEnabled) { + return nil, false + } + return o.ClientIdAliasEnabled, true +} + +// HasClientIdAliasEnabled returns a boolean if a field has been set. +func (o *ClientLimited) HasClientIdAliasEnabled() bool { + if o != nil && !isNil(o.ClientIdAliasEnabled) { + return true + } + + return false +} + +// SetClientIdAliasEnabled gets a reference to the given bool and assigns it to the ClientIdAliasEnabled field. +func (o *ClientLimited) SetClientIdAliasEnabled(v bool) { + o.ClientIdAliasEnabled = &v +} + +// GetClientType returns the ClientType field value if set, zero value otherwise. +func (o *ClientLimited) GetClientType() ClientType { + if o == nil || isNil(o.ClientType) { + var ret ClientType + return ret + } + return *o.ClientType +} + +// GetClientTypeOk returns a tuple with the ClientType field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ClientLimited) GetClientTypeOk() (*ClientType, bool) { + if o == nil || isNil(o.ClientType) { + return nil, false + } + return o.ClientType, true +} + +// HasClientType returns a boolean if a field has been set. +func (o *ClientLimited) HasClientType() bool { + if o != nil && !isNil(o.ClientType) { + return true + } + + return false +} + +// SetClientType gets a reference to the given ClientType and assigns it to the ClientType field. +func (o *ClientLimited) SetClientType(v ClientType) { + o.ClientType = &v +} + +func (o ClientLimited) MarshalJSON() ([]byte, error) { + toSerialize,err := o.ToMap() + if err != nil { + return []byte{}, err + } + return json.Marshal(toSerialize) +} + +func (o ClientLimited) ToMap() (map[string]interface{}, error) { + toSerialize := map[string]interface{}{} + if !isNil(o.Number) { + toSerialize["number"] = o.Number + } + if !isNil(o.ClientName) { + toSerialize["clientName"] = o.ClientName + } + if !isNil(o.ClientNames) { + toSerialize["clientNames"] = o.ClientNames + } + if !isNil(o.Description) { + toSerialize["description"] = o.Description + } + if !isNil(o.Descriptions) { + toSerialize["descriptions"] = o.Descriptions + } + if !isNil(o.ClientId) { + toSerialize["clientId"] = o.ClientId + } + if !isNil(o.ClientIdAlias) { + toSerialize["clientIdAlias"] = o.ClientIdAlias + } + if !isNil(o.ClientIdAliasEnabled) { + toSerialize["clientIdAliasEnabled"] = o.ClientIdAliasEnabled + } + if !isNil(o.ClientType) { + toSerialize["clientType"] = o.ClientType + } + return toSerialize, nil +} + +type NullableClientLimited struct { + value *ClientLimited + isSet bool +} + +func (v NullableClientLimited) Get() *ClientLimited { + return v.value +} + +func (v *NullableClientLimited) Set(val *ClientLimited) { + v.value = val + v.isSet = true +} + +func (v NullableClientLimited) IsSet() bool { + return v.isSet +} + +func (v *NullableClientLimited) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableClientLimited(val *ClientLimited) *NullableClientLimited { + return &NullableClientLimited{value: val, isSet: true} +} + +func (v NullableClientLimited) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableClientLimited) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/model_client_limited_authorization.go b/model_client_limited_authorization.go new file mode 100644 index 0000000..6ab0682 --- /dev/null +++ b/model_client_limited_authorization.go @@ -0,0 +1,644 @@ +/* +Authlete API + +Authlete API Document. + +API version: 3.0.0 +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package authlete + +import ( + "encoding/json" +) + +// checks if the ClientLimitedAuthorization type satisfies the MappedNullable interface at compile time +var _ MappedNullable = &ClientLimitedAuthorization{} + +// ClientLimitedAuthorization struct for ClientLimitedAuthorization +type ClientLimitedAuthorization struct { + // The sequential number of the client. The value of this property is assigned by Authlete. + Number *int32 `json:"number,omitempty"` + // The name of the client application. This property corresponds to `client_name` in [OpenID Connect Dynamic Client Registration 1.0, 2. Client Metadata](https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata). + ClientName *string `json:"clientName,omitempty"` + // Client names with language tags. If the client application has different names for different languages, this property can be used to register the names. + ClientNames []TaggedValue `json:"clientNames,omitempty"` + // The description about the client application. + Description *string `json:"description,omitempty"` + // Descriptions about the client application with language tags. If the client application has different descriptions for different languages, this property can be used to register the descriptions. + Descriptions []TaggedValue `json:"descriptions,omitempty"` + // The client identifier used in Authlete API calls. The value of this property is assigned by Authlete. + ClientId *int64 `json:"clientId,omitempty"` + // The value of the client's `client_id` property used in OAuth and OpenID Connect calls. By default, this is a string version of the `clientId` property. + ClientIdAlias *string `json:"clientIdAlias,omitempty"` + // Deprecated. Always set to `true`. + ClientIdAliasEnabled *bool `json:"clientIdAliasEnabled,omitempty"` + ClientType *ClientType `json:"clientType,omitempty"` + // The URL pointing to the logo image of the client application. This property corresponds to `logo_uri` in [OpenID Connect Dynamic Client Registration 1.0, 2. Client Metadata](https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata). + LogoUri *string `json:"logoUri,omitempty"` + // Logo image URLs with language tags. If the client application has different logo images for different languages, this property can be used to register URLs of the images. + LogoUris []TaggedValue `json:"logoUris,omitempty"` + // The URL pointing to the \"Terms Of Service\" page. This property corresponds to `tos_uri` in [OpenID Connect Dynamic Client Registration 1.0, 2. Client Metadata](https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata). + TosUri *string `json:"tosUri,omitempty"` + // URLs of \"Terms Of Service\" pages with language tags. If the client application has different \"Terms Of Service\" pages for different languages, this property can be used to register the URLs. + TosUris []TaggedValue `json:"tosUris,omitempty"` + // The URL pointing to the page which describes the policy as to how end-user's profile data is used. This property corresponds to `policy_uri` in [OpenID Connect Dynamic Client Registration 1.0, 2. Client Metadata](https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata). + PolicyUri *string `json:"policyUri,omitempty"` + // URLs of policy pages with language tags. If the client application has different policy pages for different languages, this property can be used to register the URLs. + PolicyUris []TaggedValue `json:"policyUris,omitempty"` +} + +// NewClientLimitedAuthorization instantiates a new ClientLimitedAuthorization object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewClientLimitedAuthorization() *ClientLimitedAuthorization { + this := ClientLimitedAuthorization{} + return &this +} + +// NewClientLimitedAuthorizationWithDefaults instantiates a new ClientLimitedAuthorization object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewClientLimitedAuthorizationWithDefaults() *ClientLimitedAuthorization { + this := ClientLimitedAuthorization{} + return &this +} + +// GetNumber returns the Number field value if set, zero value otherwise. +func (o *ClientLimitedAuthorization) GetNumber() int32 { + if o == nil || isNil(o.Number) { + var ret int32 + return ret + } + return *o.Number +} + +// GetNumberOk returns a tuple with the Number field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ClientLimitedAuthorization) GetNumberOk() (*int32, bool) { + if o == nil || isNil(o.Number) { + return nil, false + } + return o.Number, true +} + +// HasNumber returns a boolean if a field has been set. +func (o *ClientLimitedAuthorization) HasNumber() bool { + if o != nil && !isNil(o.Number) { + return true + } + + return false +} + +// SetNumber gets a reference to the given int32 and assigns it to the Number field. +func (o *ClientLimitedAuthorization) SetNumber(v int32) { + o.Number = &v +} + +// GetClientName returns the ClientName field value if set, zero value otherwise. +func (o *ClientLimitedAuthorization) GetClientName() string { + if o == nil || isNil(o.ClientName) { + var ret string + return ret + } + return *o.ClientName +} + +// GetClientNameOk returns a tuple with the ClientName field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ClientLimitedAuthorization) GetClientNameOk() (*string, bool) { + if o == nil || isNil(o.ClientName) { + return nil, false + } + return o.ClientName, true +} + +// HasClientName returns a boolean if a field has been set. +func (o *ClientLimitedAuthorization) HasClientName() bool { + if o != nil && !isNil(o.ClientName) { + return true + } + + return false +} + +// SetClientName gets a reference to the given string and assigns it to the ClientName field. +func (o *ClientLimitedAuthorization) SetClientName(v string) { + o.ClientName = &v +} + +// GetClientNames returns the ClientNames field value if set, zero value otherwise. +func (o *ClientLimitedAuthorization) GetClientNames() []TaggedValue { + if o == nil || isNil(o.ClientNames) { + var ret []TaggedValue + return ret + } + return o.ClientNames +} + +// GetClientNamesOk returns a tuple with the ClientNames field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ClientLimitedAuthorization) GetClientNamesOk() ([]TaggedValue, bool) { + if o == nil || isNil(o.ClientNames) { + return nil, false + } + return o.ClientNames, true +} + +// HasClientNames returns a boolean if a field has been set. +func (o *ClientLimitedAuthorization) HasClientNames() bool { + if o != nil && !isNil(o.ClientNames) { + return true + } + + return false +} + +// SetClientNames gets a reference to the given []TaggedValue and assigns it to the ClientNames field. +func (o *ClientLimitedAuthorization) SetClientNames(v []TaggedValue) { + o.ClientNames = v +} + +// GetDescription returns the Description field value if set, zero value otherwise. +func (o *ClientLimitedAuthorization) GetDescription() string { + if o == nil || isNil(o.Description) { + var ret string + return ret + } + return *o.Description +} + +// GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ClientLimitedAuthorization) GetDescriptionOk() (*string, bool) { + if o == nil || isNil(o.Description) { + return nil, false + } + return o.Description, true +} + +// HasDescription returns a boolean if a field has been set. +func (o *ClientLimitedAuthorization) HasDescription() bool { + if o != nil && !isNil(o.Description) { + return true + } + + return false +} + +// SetDescription gets a reference to the given string and assigns it to the Description field. +func (o *ClientLimitedAuthorization) SetDescription(v string) { + o.Description = &v +} + +// GetDescriptions returns the Descriptions field value if set, zero value otherwise. +func (o *ClientLimitedAuthorization) GetDescriptions() []TaggedValue { + if o == nil || isNil(o.Descriptions) { + var ret []TaggedValue + return ret + } + return o.Descriptions +} + +// GetDescriptionsOk returns a tuple with the Descriptions field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ClientLimitedAuthorization) GetDescriptionsOk() ([]TaggedValue, bool) { + if o == nil || isNil(o.Descriptions) { + return nil, false + } + return o.Descriptions, true +} + +// HasDescriptions returns a boolean if a field has been set. +func (o *ClientLimitedAuthorization) HasDescriptions() bool { + if o != nil && !isNil(o.Descriptions) { + return true + } + + return false +} + +// SetDescriptions gets a reference to the given []TaggedValue and assigns it to the Descriptions field. +func (o *ClientLimitedAuthorization) SetDescriptions(v []TaggedValue) { + o.Descriptions = v +} + +// GetClientId returns the ClientId field value if set, zero value otherwise. +func (o *ClientLimitedAuthorization) GetClientId() int64 { + if o == nil || isNil(o.ClientId) { + var ret int64 + return ret + } + return *o.ClientId +} + +// GetClientIdOk returns a tuple with the ClientId field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ClientLimitedAuthorization) GetClientIdOk() (*int64, bool) { + if o == nil || isNil(o.ClientId) { + return nil, false + } + return o.ClientId, true +} + +// HasClientId returns a boolean if a field has been set. +func (o *ClientLimitedAuthorization) HasClientId() bool { + if o != nil && !isNil(o.ClientId) { + return true + } + + return false +} + +// SetClientId gets a reference to the given int64 and assigns it to the ClientId field. +func (o *ClientLimitedAuthorization) SetClientId(v int64) { + o.ClientId = &v +} + +// GetClientIdAlias returns the ClientIdAlias field value if set, zero value otherwise. +func (o *ClientLimitedAuthorization) GetClientIdAlias() string { + if o == nil || isNil(o.ClientIdAlias) { + var ret string + return ret + } + return *o.ClientIdAlias +} + +// GetClientIdAliasOk returns a tuple with the ClientIdAlias field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ClientLimitedAuthorization) GetClientIdAliasOk() (*string, bool) { + if o == nil || isNil(o.ClientIdAlias) { + return nil, false + } + return o.ClientIdAlias, true +} + +// HasClientIdAlias returns a boolean if a field has been set. +func (o *ClientLimitedAuthorization) HasClientIdAlias() bool { + if o != nil && !isNil(o.ClientIdAlias) { + return true + } + + return false +} + +// SetClientIdAlias gets a reference to the given string and assigns it to the ClientIdAlias field. +func (o *ClientLimitedAuthorization) SetClientIdAlias(v string) { + o.ClientIdAlias = &v +} + +// GetClientIdAliasEnabled returns the ClientIdAliasEnabled field value if set, zero value otherwise. +func (o *ClientLimitedAuthorization) GetClientIdAliasEnabled() bool { + if o == nil || isNil(o.ClientIdAliasEnabled) { + var ret bool + return ret + } + return *o.ClientIdAliasEnabled +} + +// GetClientIdAliasEnabledOk returns a tuple with the ClientIdAliasEnabled field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ClientLimitedAuthorization) GetClientIdAliasEnabledOk() (*bool, bool) { + if o == nil || isNil(o.ClientIdAliasEnabled) { + return nil, false + } + return o.ClientIdAliasEnabled, true +} + +// HasClientIdAliasEnabled returns a boolean if a field has been set. +func (o *ClientLimitedAuthorization) HasClientIdAliasEnabled() bool { + if o != nil && !isNil(o.ClientIdAliasEnabled) { + return true + } + + return false +} + +// SetClientIdAliasEnabled gets a reference to the given bool and assigns it to the ClientIdAliasEnabled field. +func (o *ClientLimitedAuthorization) SetClientIdAliasEnabled(v bool) { + o.ClientIdAliasEnabled = &v +} + +// GetClientType returns the ClientType field value if set, zero value otherwise. +func (o *ClientLimitedAuthorization) GetClientType() ClientType { + if o == nil || isNil(o.ClientType) { + var ret ClientType + return ret + } + return *o.ClientType +} + +// GetClientTypeOk returns a tuple with the ClientType field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ClientLimitedAuthorization) GetClientTypeOk() (*ClientType, bool) { + if o == nil || isNil(o.ClientType) { + return nil, false + } + return o.ClientType, true +} + +// HasClientType returns a boolean if a field has been set. +func (o *ClientLimitedAuthorization) HasClientType() bool { + if o != nil && !isNil(o.ClientType) { + return true + } + + return false +} + +// SetClientType gets a reference to the given ClientType and assigns it to the ClientType field. +func (o *ClientLimitedAuthorization) SetClientType(v ClientType) { + o.ClientType = &v +} + +// GetLogoUri returns the LogoUri field value if set, zero value otherwise. +func (o *ClientLimitedAuthorization) GetLogoUri() string { + if o == nil || isNil(o.LogoUri) { + var ret string + return ret + } + return *o.LogoUri +} + +// GetLogoUriOk returns a tuple with the LogoUri field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ClientLimitedAuthorization) GetLogoUriOk() (*string, bool) { + if o == nil || isNil(o.LogoUri) { + return nil, false + } + return o.LogoUri, true +} + +// HasLogoUri returns a boolean if a field has been set. +func (o *ClientLimitedAuthorization) HasLogoUri() bool { + if o != nil && !isNil(o.LogoUri) { + return true + } + + return false +} + +// SetLogoUri gets a reference to the given string and assigns it to the LogoUri field. +func (o *ClientLimitedAuthorization) SetLogoUri(v string) { + o.LogoUri = &v +} + +// GetLogoUris returns the LogoUris field value if set, zero value otherwise. +func (o *ClientLimitedAuthorization) GetLogoUris() []TaggedValue { + if o == nil || isNil(o.LogoUris) { + var ret []TaggedValue + return ret + } + return o.LogoUris +} + +// GetLogoUrisOk returns a tuple with the LogoUris field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ClientLimitedAuthorization) GetLogoUrisOk() ([]TaggedValue, bool) { + if o == nil || isNil(o.LogoUris) { + return nil, false + } + return o.LogoUris, true +} + +// HasLogoUris returns a boolean if a field has been set. +func (o *ClientLimitedAuthorization) HasLogoUris() bool { + if o != nil && !isNil(o.LogoUris) { + return true + } + + return false +} + +// SetLogoUris gets a reference to the given []TaggedValue and assigns it to the LogoUris field. +func (o *ClientLimitedAuthorization) SetLogoUris(v []TaggedValue) { + o.LogoUris = v +} + +// GetTosUri returns the TosUri field value if set, zero value otherwise. +func (o *ClientLimitedAuthorization) GetTosUri() string { + if o == nil || isNil(o.TosUri) { + var ret string + return ret + } + return *o.TosUri +} + +// GetTosUriOk returns a tuple with the TosUri field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ClientLimitedAuthorization) GetTosUriOk() (*string, bool) { + if o == nil || isNil(o.TosUri) { + return nil, false + } + return o.TosUri, true +} + +// HasTosUri returns a boolean if a field has been set. +func (o *ClientLimitedAuthorization) HasTosUri() bool { + if o != nil && !isNil(o.TosUri) { + return true + } + + return false +} + +// SetTosUri gets a reference to the given string and assigns it to the TosUri field. +func (o *ClientLimitedAuthorization) SetTosUri(v string) { + o.TosUri = &v +} + +// GetTosUris returns the TosUris field value if set, zero value otherwise. +func (o *ClientLimitedAuthorization) GetTosUris() []TaggedValue { + if o == nil || isNil(o.TosUris) { + var ret []TaggedValue + return ret + } + return o.TosUris +} + +// GetTosUrisOk returns a tuple with the TosUris field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ClientLimitedAuthorization) GetTosUrisOk() ([]TaggedValue, bool) { + if o == nil || isNil(o.TosUris) { + return nil, false + } + return o.TosUris, true +} + +// HasTosUris returns a boolean if a field has been set. +func (o *ClientLimitedAuthorization) HasTosUris() bool { + if o != nil && !isNil(o.TosUris) { + return true + } + + return false +} + +// SetTosUris gets a reference to the given []TaggedValue and assigns it to the TosUris field. +func (o *ClientLimitedAuthorization) SetTosUris(v []TaggedValue) { + o.TosUris = v +} + +// GetPolicyUri returns the PolicyUri field value if set, zero value otherwise. +func (o *ClientLimitedAuthorization) GetPolicyUri() string { + if o == nil || isNil(o.PolicyUri) { + var ret string + return ret + } + return *o.PolicyUri +} + +// GetPolicyUriOk returns a tuple with the PolicyUri field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ClientLimitedAuthorization) GetPolicyUriOk() (*string, bool) { + if o == nil || isNil(o.PolicyUri) { + return nil, false + } + return o.PolicyUri, true +} + +// HasPolicyUri returns a boolean if a field has been set. +func (o *ClientLimitedAuthorization) HasPolicyUri() bool { + if o != nil && !isNil(o.PolicyUri) { + return true + } + + return false +} + +// SetPolicyUri gets a reference to the given string and assigns it to the PolicyUri field. +func (o *ClientLimitedAuthorization) SetPolicyUri(v string) { + o.PolicyUri = &v +} + +// GetPolicyUris returns the PolicyUris field value if set, zero value otherwise. +func (o *ClientLimitedAuthorization) GetPolicyUris() []TaggedValue { + if o == nil || isNil(o.PolicyUris) { + var ret []TaggedValue + return ret + } + return o.PolicyUris +} + +// GetPolicyUrisOk returns a tuple with the PolicyUris field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ClientLimitedAuthorization) GetPolicyUrisOk() ([]TaggedValue, bool) { + if o == nil || isNil(o.PolicyUris) { + return nil, false + } + return o.PolicyUris, true +} + +// HasPolicyUris returns a boolean if a field has been set. +func (o *ClientLimitedAuthorization) HasPolicyUris() bool { + if o != nil && !isNil(o.PolicyUris) { + return true + } + + return false +} + +// SetPolicyUris gets a reference to the given []TaggedValue and assigns it to the PolicyUris field. +func (o *ClientLimitedAuthorization) SetPolicyUris(v []TaggedValue) { + o.PolicyUris = v +} + +func (o ClientLimitedAuthorization) MarshalJSON() ([]byte, error) { + toSerialize,err := o.ToMap() + if err != nil { + return []byte{}, err + } + return json.Marshal(toSerialize) +} + +func (o ClientLimitedAuthorization) ToMap() (map[string]interface{}, error) { + toSerialize := map[string]interface{}{} + if !isNil(o.Number) { + toSerialize["number"] = o.Number + } + if !isNil(o.ClientName) { + toSerialize["clientName"] = o.ClientName + } + if !isNil(o.ClientNames) { + toSerialize["clientNames"] = o.ClientNames + } + if !isNil(o.Description) { + toSerialize["description"] = o.Description + } + if !isNil(o.Descriptions) { + toSerialize["descriptions"] = o.Descriptions + } + if !isNil(o.ClientId) { + toSerialize["clientId"] = o.ClientId + } + if !isNil(o.ClientIdAlias) { + toSerialize["clientIdAlias"] = o.ClientIdAlias + } + if !isNil(o.ClientIdAliasEnabled) { + toSerialize["clientIdAliasEnabled"] = o.ClientIdAliasEnabled + } + if !isNil(o.ClientType) { + toSerialize["clientType"] = o.ClientType + } + if !isNil(o.LogoUri) { + toSerialize["logoUri"] = o.LogoUri + } + if !isNil(o.LogoUris) { + toSerialize["logoUris"] = o.LogoUris + } + if !isNil(o.TosUri) { + toSerialize["tosUri"] = o.TosUri + } + if !isNil(o.TosUris) { + toSerialize["tosUris"] = o.TosUris + } + if !isNil(o.PolicyUri) { + toSerialize["policyUri"] = o.PolicyUri + } + if !isNil(o.PolicyUris) { + toSerialize["policyUris"] = o.PolicyUris + } + return toSerialize, nil +} + +type NullableClientLimitedAuthorization struct { + value *ClientLimitedAuthorization + isSet bool +} + +func (v NullableClientLimitedAuthorization) Get() *ClientLimitedAuthorization { + return v.value +} + +func (v *NullableClientLimitedAuthorization) Set(val *ClientLimitedAuthorization) { + v.value = val + v.isSet = true +} + +func (v NullableClientLimitedAuthorization) IsSet() bool { + return v.isSet +} + +func (v *NullableClientLimitedAuthorization) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableClientLimitedAuthorization(val *ClientLimitedAuthorization) *NullableClientLimitedAuthorization { + return &NullableClientLimitedAuthorization{value: val, isSet: true} +} + +func (v NullableClientLimitedAuthorization) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableClientLimitedAuthorization) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/model_client_registration_delete_request.go b/model_client_registration_delete_request.go index aa3fa1a..ee5b128 100644 --- a/model_client_registration_delete_request.go +++ b/model_client_registration_delete_request.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_client_registration_delete_response.go b/model_client_registration_delete_response.go index 64fa09f..f0c79bd 100644 --- a/model_client_registration_delete_response.go +++ b/model_client_registration_delete_response.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_client_registration_request.go b/model_client_registration_request.go index ee5b0bb..45531ac 100644 --- a/model_client_registration_request.go +++ b/model_client_registration_request.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_client_registration_response.go b/model_client_registration_response.go index e6d863c..48bf6c9 100644 --- a/model_client_registration_response.go +++ b/model_client_registration_response.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_client_registration_type.go b/model_client_registration_type.go index b050c01..b64694d 100644 --- a/model_client_registration_type.go +++ b/model_client_registration_type.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_client_registration_update_request.go b/model_client_registration_update_request.go index 0ef416e..4ef9eed 100644 --- a/model_client_registration_update_request.go +++ b/model_client_registration_update_request.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_client_registration_update_response.go b/model_client_registration_update_response.go index 51b547c..fe5f780 100644 --- a/model_client_registration_update_response.go +++ b/model_client_registration_update_response.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_client_secret_refresh_response.go b/model_client_secret_refresh_response.go index 496f0bd..20b48a0 100644 --- a/model_client_secret_refresh_response.go +++ b/model_client_secret_refresh_response.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_client_secret_update_request.go b/model_client_secret_update_request.go index c9ade44..fe62a14 100644 --- a/model_client_secret_update_request.go +++ b/model_client_secret_update_request.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_client_secret_update_response.go b/model_client_secret_update_response.go index e2fd9eb..3f439c3 100644 --- a/model_client_secret_update_response.go +++ b/model_client_secret_update_response.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_client_type.go b/model_client_type.go index ff5b698..3d393b5 100644 --- a/model_client_type.go +++ b/model_client_type.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_credential_issuance_order.go b/model_credential_issuance_order.go new file mode 100644 index 0000000..aeb6ead --- /dev/null +++ b/model_credential_issuance_order.go @@ -0,0 +1,275 @@ +/* +Authlete API + +Authlete API Document. + +API version: 3.0.0 +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package authlete + +import ( + "encoding/json" +) + +// checks if the CredentialIssuanceOrder type satisfies the MappedNullable interface at compile time +var _ MappedNullable = &CredentialIssuanceOrder{} + +// CredentialIssuanceOrder struct for CredentialIssuanceOrder +type CredentialIssuanceOrder struct { + // The identifier of a credential request. + RequestIdentifier *string `json:"requestIdentifier,omitempty"` + // The additional payload that will be added into a credential to be issued. + CredentialPayload *string `json:"credentialPayload,omitempty"` + // The flag indicating whether to defer credential issuance. + IssuanceDeferred *bool `json:"issuanceDeferred,omitempty"` + // The duration of a credential to be issued. + CredentialDuration *int64 `json:"credentialDuration,omitempty"` + // The key ID of a private key that should be used for signing a credential to be issued. + SigningKeyId *string `json:"signingKeyId,omitempty"` +} + +// NewCredentialIssuanceOrder instantiates a new CredentialIssuanceOrder object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewCredentialIssuanceOrder() *CredentialIssuanceOrder { + this := CredentialIssuanceOrder{} + return &this +} + +// NewCredentialIssuanceOrderWithDefaults instantiates a new CredentialIssuanceOrder object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewCredentialIssuanceOrderWithDefaults() *CredentialIssuanceOrder { + this := CredentialIssuanceOrder{} + return &this +} + +// GetRequestIdentifier returns the RequestIdentifier field value if set, zero value otherwise. +func (o *CredentialIssuanceOrder) GetRequestIdentifier() string { + if o == nil || isNil(o.RequestIdentifier) { + var ret string + return ret + } + return *o.RequestIdentifier +} + +// GetRequestIdentifierOk returns a tuple with the RequestIdentifier field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CredentialIssuanceOrder) GetRequestIdentifierOk() (*string, bool) { + if o == nil || isNil(o.RequestIdentifier) { + return nil, false + } + return o.RequestIdentifier, true +} + +// HasRequestIdentifier returns a boolean if a field has been set. +func (o *CredentialIssuanceOrder) HasRequestIdentifier() bool { + if o != nil && !isNil(o.RequestIdentifier) { + return true + } + + return false +} + +// SetRequestIdentifier gets a reference to the given string and assigns it to the RequestIdentifier field. +func (o *CredentialIssuanceOrder) SetRequestIdentifier(v string) { + o.RequestIdentifier = &v +} + +// GetCredentialPayload returns the CredentialPayload field value if set, zero value otherwise. +func (o *CredentialIssuanceOrder) GetCredentialPayload() string { + if o == nil || isNil(o.CredentialPayload) { + var ret string + return ret + } + return *o.CredentialPayload +} + +// GetCredentialPayloadOk returns a tuple with the CredentialPayload field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CredentialIssuanceOrder) GetCredentialPayloadOk() (*string, bool) { + if o == nil || isNil(o.CredentialPayload) { + return nil, false + } + return o.CredentialPayload, true +} + +// HasCredentialPayload returns a boolean if a field has been set. +func (o *CredentialIssuanceOrder) HasCredentialPayload() bool { + if o != nil && !isNil(o.CredentialPayload) { + return true + } + + return false +} + +// SetCredentialPayload gets a reference to the given string and assigns it to the CredentialPayload field. +func (o *CredentialIssuanceOrder) SetCredentialPayload(v string) { + o.CredentialPayload = &v +} + +// GetIssuanceDeferred returns the IssuanceDeferred field value if set, zero value otherwise. +func (o *CredentialIssuanceOrder) GetIssuanceDeferred() bool { + if o == nil || isNil(o.IssuanceDeferred) { + var ret bool + return ret + } + return *o.IssuanceDeferred +} + +// GetIssuanceDeferredOk returns a tuple with the IssuanceDeferred field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CredentialIssuanceOrder) GetIssuanceDeferredOk() (*bool, bool) { + if o == nil || isNil(o.IssuanceDeferred) { + return nil, false + } + return o.IssuanceDeferred, true +} + +// HasIssuanceDeferred returns a boolean if a field has been set. +func (o *CredentialIssuanceOrder) HasIssuanceDeferred() bool { + if o != nil && !isNil(o.IssuanceDeferred) { + return true + } + + return false +} + +// SetIssuanceDeferred gets a reference to the given bool and assigns it to the IssuanceDeferred field. +func (o *CredentialIssuanceOrder) SetIssuanceDeferred(v bool) { + o.IssuanceDeferred = &v +} + +// GetCredentialDuration returns the CredentialDuration field value if set, zero value otherwise. +func (o *CredentialIssuanceOrder) GetCredentialDuration() int64 { + if o == nil || isNil(o.CredentialDuration) { + var ret int64 + return ret + } + return *o.CredentialDuration +} + +// GetCredentialDurationOk returns a tuple with the CredentialDuration field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CredentialIssuanceOrder) GetCredentialDurationOk() (*int64, bool) { + if o == nil || isNil(o.CredentialDuration) { + return nil, false + } + return o.CredentialDuration, true +} + +// HasCredentialDuration returns a boolean if a field has been set. +func (o *CredentialIssuanceOrder) HasCredentialDuration() bool { + if o != nil && !isNil(o.CredentialDuration) { + return true + } + + return false +} + +// SetCredentialDuration gets a reference to the given int64 and assigns it to the CredentialDuration field. +func (o *CredentialIssuanceOrder) SetCredentialDuration(v int64) { + o.CredentialDuration = &v +} + +// GetSigningKeyId returns the SigningKeyId field value if set, zero value otherwise. +func (o *CredentialIssuanceOrder) GetSigningKeyId() string { + if o == nil || isNil(o.SigningKeyId) { + var ret string + return ret + } + return *o.SigningKeyId +} + +// GetSigningKeyIdOk returns a tuple with the SigningKeyId field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CredentialIssuanceOrder) GetSigningKeyIdOk() (*string, bool) { + if o == nil || isNil(o.SigningKeyId) { + return nil, false + } + return o.SigningKeyId, true +} + +// HasSigningKeyId returns a boolean if a field has been set. +func (o *CredentialIssuanceOrder) HasSigningKeyId() bool { + if o != nil && !isNil(o.SigningKeyId) { + return true + } + + return false +} + +// SetSigningKeyId gets a reference to the given string and assigns it to the SigningKeyId field. +func (o *CredentialIssuanceOrder) SetSigningKeyId(v string) { + o.SigningKeyId = &v +} + +func (o CredentialIssuanceOrder) MarshalJSON() ([]byte, error) { + toSerialize,err := o.ToMap() + if err != nil { + return []byte{}, err + } + return json.Marshal(toSerialize) +} + +func (o CredentialIssuanceOrder) ToMap() (map[string]interface{}, error) { + toSerialize := map[string]interface{}{} + if !isNil(o.RequestIdentifier) { + toSerialize["requestIdentifier"] = o.RequestIdentifier + } + if !isNil(o.CredentialPayload) { + toSerialize["credentialPayload"] = o.CredentialPayload + } + if !isNil(o.IssuanceDeferred) { + toSerialize["issuanceDeferred"] = o.IssuanceDeferred + } + if !isNil(o.CredentialDuration) { + toSerialize["credentialDuration"] = o.CredentialDuration + } + if !isNil(o.SigningKeyId) { + toSerialize["signingKeyId"] = o.SigningKeyId + } + return toSerialize, nil +} + +type NullableCredentialIssuanceOrder struct { + value *CredentialIssuanceOrder + isSet bool +} + +func (v NullableCredentialIssuanceOrder) Get() *CredentialIssuanceOrder { + return v.value +} + +func (v *NullableCredentialIssuanceOrder) Set(val *CredentialIssuanceOrder) { + v.value = val + v.isSet = true +} + +func (v NullableCredentialIssuanceOrder) IsSet() bool { + return v.isSet +} + +func (v *NullableCredentialIssuanceOrder) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableCredentialIssuanceOrder(val *CredentialIssuanceOrder) *NullableCredentialIssuanceOrder { + return &NullableCredentialIssuanceOrder{value: val, isSet: true} +} + +func (v NullableCredentialIssuanceOrder) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableCredentialIssuanceOrder) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/model_credential_issuer_metadata.go b/model_credential_issuer_metadata.go new file mode 100644 index 0000000..2088a5b --- /dev/null +++ b/model_credential_issuer_metadata.go @@ -0,0 +1,312 @@ +/* +Authlete API + +Authlete API Document. + +API version: 3.0.0 +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package authlete + +import ( + "encoding/json" +) + +// checks if the CredentialIssuerMetadata type satisfies the MappedNullable interface at compile time +var _ MappedNullable = &CredentialIssuerMetadata{} + +// CredentialIssuerMetadata struct for CredentialIssuerMetadata +type CredentialIssuerMetadata struct { + // The identifier of a credential request. + CredentialIssuer *string `json:"credentialIssuer,omitempty"` + // The identifier of the authorization server that the credential issuer relies on for authorization. + AuthorizationServer *string `json:"authorizationServer,omitempty"` + // The URL of the credential endpoint of the credential issuer. + CredentialEndpoint *bool `json:"credentialEndpoint,omitempty"` + // The URL of the batch credential endpoint of the credential issuer. + BatchCredentialEndpoint *int64 `json:"batchCredentialEndpoint,omitempty"` + // The URL of the deferred credential endpoint of the credential issuer. + DeferredCredentialEndpoint *string `json:"deferredCredentialEndpoint,omitempty"` + // A JSON array describing supported credentials. + CredentialsSupported *bool `json:"credentialsSupported,omitempty"` +} + +// NewCredentialIssuerMetadata instantiates a new CredentialIssuerMetadata object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewCredentialIssuerMetadata() *CredentialIssuerMetadata { + this := CredentialIssuerMetadata{} + return &this +} + +// NewCredentialIssuerMetadataWithDefaults instantiates a new CredentialIssuerMetadata object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewCredentialIssuerMetadataWithDefaults() *CredentialIssuerMetadata { + this := CredentialIssuerMetadata{} + return &this +} + +// GetCredentialIssuer returns the CredentialIssuer field value if set, zero value otherwise. +func (o *CredentialIssuerMetadata) GetCredentialIssuer() string { + if o == nil || isNil(o.CredentialIssuer) { + var ret string + return ret + } + return *o.CredentialIssuer +} + +// GetCredentialIssuerOk returns a tuple with the CredentialIssuer field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CredentialIssuerMetadata) GetCredentialIssuerOk() (*string, bool) { + if o == nil || isNil(o.CredentialIssuer) { + return nil, false + } + return o.CredentialIssuer, true +} + +// HasCredentialIssuer returns a boolean if a field has been set. +func (o *CredentialIssuerMetadata) HasCredentialIssuer() bool { + if o != nil && !isNil(o.CredentialIssuer) { + return true + } + + return false +} + +// SetCredentialIssuer gets a reference to the given string and assigns it to the CredentialIssuer field. +func (o *CredentialIssuerMetadata) SetCredentialIssuer(v string) { + o.CredentialIssuer = &v +} + +// GetAuthorizationServer returns the AuthorizationServer field value if set, zero value otherwise. +func (o *CredentialIssuerMetadata) GetAuthorizationServer() string { + if o == nil || isNil(o.AuthorizationServer) { + var ret string + return ret + } + return *o.AuthorizationServer +} + +// GetAuthorizationServerOk returns a tuple with the AuthorizationServer field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CredentialIssuerMetadata) GetAuthorizationServerOk() (*string, bool) { + if o == nil || isNil(o.AuthorizationServer) { + return nil, false + } + return o.AuthorizationServer, true +} + +// HasAuthorizationServer returns a boolean if a field has been set. +func (o *CredentialIssuerMetadata) HasAuthorizationServer() bool { + if o != nil && !isNil(o.AuthorizationServer) { + return true + } + + return false +} + +// SetAuthorizationServer gets a reference to the given string and assigns it to the AuthorizationServer field. +func (o *CredentialIssuerMetadata) SetAuthorizationServer(v string) { + o.AuthorizationServer = &v +} + +// GetCredentialEndpoint returns the CredentialEndpoint field value if set, zero value otherwise. +func (o *CredentialIssuerMetadata) GetCredentialEndpoint() bool { + if o == nil || isNil(o.CredentialEndpoint) { + var ret bool + return ret + } + return *o.CredentialEndpoint +} + +// GetCredentialEndpointOk returns a tuple with the CredentialEndpoint field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CredentialIssuerMetadata) GetCredentialEndpointOk() (*bool, bool) { + if o == nil || isNil(o.CredentialEndpoint) { + return nil, false + } + return o.CredentialEndpoint, true +} + +// HasCredentialEndpoint returns a boolean if a field has been set. +func (o *CredentialIssuerMetadata) HasCredentialEndpoint() bool { + if o != nil && !isNil(o.CredentialEndpoint) { + return true + } + + return false +} + +// SetCredentialEndpoint gets a reference to the given bool and assigns it to the CredentialEndpoint field. +func (o *CredentialIssuerMetadata) SetCredentialEndpoint(v bool) { + o.CredentialEndpoint = &v +} + +// GetBatchCredentialEndpoint returns the BatchCredentialEndpoint field value if set, zero value otherwise. +func (o *CredentialIssuerMetadata) GetBatchCredentialEndpoint() int64 { + if o == nil || isNil(o.BatchCredentialEndpoint) { + var ret int64 + return ret + } + return *o.BatchCredentialEndpoint +} + +// GetBatchCredentialEndpointOk returns a tuple with the BatchCredentialEndpoint field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CredentialIssuerMetadata) GetBatchCredentialEndpointOk() (*int64, bool) { + if o == nil || isNil(o.BatchCredentialEndpoint) { + return nil, false + } + return o.BatchCredentialEndpoint, true +} + +// HasBatchCredentialEndpoint returns a boolean if a field has been set. +func (o *CredentialIssuerMetadata) HasBatchCredentialEndpoint() bool { + if o != nil && !isNil(o.BatchCredentialEndpoint) { + return true + } + + return false +} + +// SetBatchCredentialEndpoint gets a reference to the given int64 and assigns it to the BatchCredentialEndpoint field. +func (o *CredentialIssuerMetadata) SetBatchCredentialEndpoint(v int64) { + o.BatchCredentialEndpoint = &v +} + +// GetDeferredCredentialEndpoint returns the DeferredCredentialEndpoint field value if set, zero value otherwise. +func (o *CredentialIssuerMetadata) GetDeferredCredentialEndpoint() string { + if o == nil || isNil(o.DeferredCredentialEndpoint) { + var ret string + return ret + } + return *o.DeferredCredentialEndpoint +} + +// GetDeferredCredentialEndpointOk returns a tuple with the DeferredCredentialEndpoint field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CredentialIssuerMetadata) GetDeferredCredentialEndpointOk() (*string, bool) { + if o == nil || isNil(o.DeferredCredentialEndpoint) { + return nil, false + } + return o.DeferredCredentialEndpoint, true +} + +// HasDeferredCredentialEndpoint returns a boolean if a field has been set. +func (o *CredentialIssuerMetadata) HasDeferredCredentialEndpoint() bool { + if o != nil && !isNil(o.DeferredCredentialEndpoint) { + return true + } + + return false +} + +// SetDeferredCredentialEndpoint gets a reference to the given string and assigns it to the DeferredCredentialEndpoint field. +func (o *CredentialIssuerMetadata) SetDeferredCredentialEndpoint(v string) { + o.DeferredCredentialEndpoint = &v +} + +// GetCredentialsSupported returns the CredentialsSupported field value if set, zero value otherwise. +func (o *CredentialIssuerMetadata) GetCredentialsSupported() bool { + if o == nil || isNil(o.CredentialsSupported) { + var ret bool + return ret + } + return *o.CredentialsSupported +} + +// GetCredentialsSupportedOk returns a tuple with the CredentialsSupported field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CredentialIssuerMetadata) GetCredentialsSupportedOk() (*bool, bool) { + if o == nil || isNil(o.CredentialsSupported) { + return nil, false + } + return o.CredentialsSupported, true +} + +// HasCredentialsSupported returns a boolean if a field has been set. +func (o *CredentialIssuerMetadata) HasCredentialsSupported() bool { + if o != nil && !isNil(o.CredentialsSupported) { + return true + } + + return false +} + +// SetCredentialsSupported gets a reference to the given bool and assigns it to the CredentialsSupported field. +func (o *CredentialIssuerMetadata) SetCredentialsSupported(v bool) { + o.CredentialsSupported = &v +} + +func (o CredentialIssuerMetadata) MarshalJSON() ([]byte, error) { + toSerialize,err := o.ToMap() + if err != nil { + return []byte{}, err + } + return json.Marshal(toSerialize) +} + +func (o CredentialIssuerMetadata) ToMap() (map[string]interface{}, error) { + toSerialize := map[string]interface{}{} + if !isNil(o.CredentialIssuer) { + toSerialize["credentialIssuer"] = o.CredentialIssuer + } + if !isNil(o.AuthorizationServer) { + toSerialize["authorizationServer"] = o.AuthorizationServer + } + if !isNil(o.CredentialEndpoint) { + toSerialize["credentialEndpoint"] = o.CredentialEndpoint + } + if !isNil(o.BatchCredentialEndpoint) { + toSerialize["batchCredentialEndpoint"] = o.BatchCredentialEndpoint + } + if !isNil(o.DeferredCredentialEndpoint) { + toSerialize["deferredCredentialEndpoint"] = o.DeferredCredentialEndpoint + } + if !isNil(o.CredentialsSupported) { + toSerialize["credentialsSupported"] = o.CredentialsSupported + } + return toSerialize, nil +} + +type NullableCredentialIssuerMetadata struct { + value *CredentialIssuerMetadata + isSet bool +} + +func (v NullableCredentialIssuerMetadata) Get() *CredentialIssuerMetadata { + return v.value +} + +func (v *NullableCredentialIssuerMetadata) Set(val *CredentialIssuerMetadata) { + v.value = val + v.isSet = true +} + +func (v NullableCredentialIssuerMetadata) IsSet() bool { + return v.isSet +} + +func (v *NullableCredentialIssuerMetadata) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableCredentialIssuerMetadata(val *CredentialIssuerMetadata) *NullableCredentialIssuerMetadata { + return &NullableCredentialIssuerMetadata{value: val, isSet: true} +} + +func (v NullableCredentialIssuerMetadata) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableCredentialIssuerMetadata) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/model_credential_offer_info.go b/model_credential_offer_info.go new file mode 100644 index 0000000..95f2db3 --- /dev/null +++ b/model_credential_offer_info.go @@ -0,0 +1,756 @@ +/* +Authlete API + +Authlete API Document. + +API version: 3.0.0 +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package authlete + +import ( + "encoding/json" +) + +// checks if the CredentialOfferInfo type satisfies the MappedNullable interface at compile time +var _ MappedNullable = &CredentialOfferInfo{} + +// CredentialOfferInfo struct for CredentialOfferInfo +type CredentialOfferInfo struct { + // The identifier of the credential offer. + Identifier *string `json:"identifier,omitempty"` + // The credential offer in the JSON format. + CredentialOffer *string `json:"credentialOffer,omitempty"` + // The identifier of the credential issuer. + CredentialIssuer *string `json:"credentialIssuer,omitempty"` + // The value of the `credentials` object in the JSON format. + Credentials *string `json:"credentials,omitempty"` + // The flag indicating whether the `authorization_code` object is included in the `grants` object. + AuthorizationCodeGrantIncluded *bool `json:"authorizationCodeGrantIncluded,omitempty"` + // The flag indicating whether the `issuer_state` property is included in the `authorization_code` object in the `grants` object. + IssuerStateIncluded *bool `json:"issuerStateIncluded,omitempty"` + // The value of the `issuer_state` property in the `authorization_code` object in the `grants` object. + IssuerState *string `json:"issuerState,omitempty"` + // The flag indicating whether the `urn:ietf:params:oauth:grant-type:pre-authorized_code` object is included in the `grants` object. + PreAuthorizedCodeGrantIncluded *bool `json:"preAuthorizedCodeGrantIncluded,omitempty"` + // The value of the `pre-authorized_code` property in the `urn:ietf:params:oauth:grant-type:pre-authorized_code` object in the `grants` object. + PreAuthorizedCode *string `json:"preAuthorizedCode,omitempty"` + // The value of the `user_pin_required` property in the `urn:ietf:params:oauth:grant-type:pre-authorized_code` object in the `grants` object. + UserPinRequired *bool `json:"userPinRequired,omitempty"` + // The value of the user PIN associated with the credential offer. + UserPin *string `json:"userPin,omitempty"` + // The subject associated with the credential offer. + Subject *string `json:"subject,omitempty"` + // The time at which the credential offer will expire. + ExpiresAt *int64 `json:"expiresAt,omitempty"` + // The general-purpose arbitrary string. + Context *string `json:"context,omitempty"` + // Extra properties to associate with the credential offer. + Properties []Property `json:"properties,omitempty"` + // Additional claims that are added to the payload part of the JWT access token. + JwtAtClaims *string `json:"jwtAtClaims,omitempty"` + // The time at which the user authentication was performed during the course of issuing the credential offer. + AuthTime *int64 `json:"authTime,omitempty"` + // The Authentication Context Class Reference of the user authentication performed during the course of issuing the credential offer. + Acr *string `json:"acr,omitempty"` +} + +// NewCredentialOfferInfo instantiates a new CredentialOfferInfo object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewCredentialOfferInfo() *CredentialOfferInfo { + this := CredentialOfferInfo{} + return &this +} + +// NewCredentialOfferInfoWithDefaults instantiates a new CredentialOfferInfo object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewCredentialOfferInfoWithDefaults() *CredentialOfferInfo { + this := CredentialOfferInfo{} + return &this +} + +// GetIdentifier returns the Identifier field value if set, zero value otherwise. +func (o *CredentialOfferInfo) GetIdentifier() string { + if o == nil || isNil(o.Identifier) { + var ret string + return ret + } + return *o.Identifier +} + +// GetIdentifierOk returns a tuple with the Identifier field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CredentialOfferInfo) GetIdentifierOk() (*string, bool) { + if o == nil || isNil(o.Identifier) { + return nil, false + } + return o.Identifier, true +} + +// HasIdentifier returns a boolean if a field has been set. +func (o *CredentialOfferInfo) HasIdentifier() bool { + if o != nil && !isNil(o.Identifier) { + return true + } + + return false +} + +// SetIdentifier gets a reference to the given string and assigns it to the Identifier field. +func (o *CredentialOfferInfo) SetIdentifier(v string) { + o.Identifier = &v +} + +// GetCredentialOffer returns the CredentialOffer field value if set, zero value otherwise. +func (o *CredentialOfferInfo) GetCredentialOffer() string { + if o == nil || isNil(o.CredentialOffer) { + var ret string + return ret + } + return *o.CredentialOffer +} + +// GetCredentialOfferOk returns a tuple with the CredentialOffer field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CredentialOfferInfo) GetCredentialOfferOk() (*string, bool) { + if o == nil || isNil(o.CredentialOffer) { + return nil, false + } + return o.CredentialOffer, true +} + +// HasCredentialOffer returns a boolean if a field has been set. +func (o *CredentialOfferInfo) HasCredentialOffer() bool { + if o != nil && !isNil(o.CredentialOffer) { + return true + } + + return false +} + +// SetCredentialOffer gets a reference to the given string and assigns it to the CredentialOffer field. +func (o *CredentialOfferInfo) SetCredentialOffer(v string) { + o.CredentialOffer = &v +} + +// GetCredentialIssuer returns the CredentialIssuer field value if set, zero value otherwise. +func (o *CredentialOfferInfo) GetCredentialIssuer() string { + if o == nil || isNil(o.CredentialIssuer) { + var ret string + return ret + } + return *o.CredentialIssuer +} + +// GetCredentialIssuerOk returns a tuple with the CredentialIssuer field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CredentialOfferInfo) GetCredentialIssuerOk() (*string, bool) { + if o == nil || isNil(o.CredentialIssuer) { + return nil, false + } + return o.CredentialIssuer, true +} + +// HasCredentialIssuer returns a boolean if a field has been set. +func (o *CredentialOfferInfo) HasCredentialIssuer() bool { + if o != nil && !isNil(o.CredentialIssuer) { + return true + } + + return false +} + +// SetCredentialIssuer gets a reference to the given string and assigns it to the CredentialIssuer field. +func (o *CredentialOfferInfo) SetCredentialIssuer(v string) { + o.CredentialIssuer = &v +} + +// GetCredentials returns the Credentials field value if set, zero value otherwise. +func (o *CredentialOfferInfo) GetCredentials() string { + if o == nil || isNil(o.Credentials) { + var ret string + return ret + } + return *o.Credentials +} + +// GetCredentialsOk returns a tuple with the Credentials field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CredentialOfferInfo) GetCredentialsOk() (*string, bool) { + if o == nil || isNil(o.Credentials) { + return nil, false + } + return o.Credentials, true +} + +// HasCredentials returns a boolean if a field has been set. +func (o *CredentialOfferInfo) HasCredentials() bool { + if o != nil && !isNil(o.Credentials) { + return true + } + + return false +} + +// SetCredentials gets a reference to the given string and assigns it to the Credentials field. +func (o *CredentialOfferInfo) SetCredentials(v string) { + o.Credentials = &v +} + +// GetAuthorizationCodeGrantIncluded returns the AuthorizationCodeGrantIncluded field value if set, zero value otherwise. +func (o *CredentialOfferInfo) GetAuthorizationCodeGrantIncluded() bool { + if o == nil || isNil(o.AuthorizationCodeGrantIncluded) { + var ret bool + return ret + } + return *o.AuthorizationCodeGrantIncluded +} + +// GetAuthorizationCodeGrantIncludedOk returns a tuple with the AuthorizationCodeGrantIncluded field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CredentialOfferInfo) GetAuthorizationCodeGrantIncludedOk() (*bool, bool) { + if o == nil || isNil(o.AuthorizationCodeGrantIncluded) { + return nil, false + } + return o.AuthorizationCodeGrantIncluded, true +} + +// HasAuthorizationCodeGrantIncluded returns a boolean if a field has been set. +func (o *CredentialOfferInfo) HasAuthorizationCodeGrantIncluded() bool { + if o != nil && !isNil(o.AuthorizationCodeGrantIncluded) { + return true + } + + return false +} + +// SetAuthorizationCodeGrantIncluded gets a reference to the given bool and assigns it to the AuthorizationCodeGrantIncluded field. +func (o *CredentialOfferInfo) SetAuthorizationCodeGrantIncluded(v bool) { + o.AuthorizationCodeGrantIncluded = &v +} + +// GetIssuerStateIncluded returns the IssuerStateIncluded field value if set, zero value otherwise. +func (o *CredentialOfferInfo) GetIssuerStateIncluded() bool { + if o == nil || isNil(o.IssuerStateIncluded) { + var ret bool + return ret + } + return *o.IssuerStateIncluded +} + +// GetIssuerStateIncludedOk returns a tuple with the IssuerStateIncluded field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CredentialOfferInfo) GetIssuerStateIncludedOk() (*bool, bool) { + if o == nil || isNil(o.IssuerStateIncluded) { + return nil, false + } + return o.IssuerStateIncluded, true +} + +// HasIssuerStateIncluded returns a boolean if a field has been set. +func (o *CredentialOfferInfo) HasIssuerStateIncluded() bool { + if o != nil && !isNil(o.IssuerStateIncluded) { + return true + } + + return false +} + +// SetIssuerStateIncluded gets a reference to the given bool and assigns it to the IssuerStateIncluded field. +func (o *CredentialOfferInfo) SetIssuerStateIncluded(v bool) { + o.IssuerStateIncluded = &v +} + +// GetIssuerState returns the IssuerState field value if set, zero value otherwise. +func (o *CredentialOfferInfo) GetIssuerState() string { + if o == nil || isNil(o.IssuerState) { + var ret string + return ret + } + return *o.IssuerState +} + +// GetIssuerStateOk returns a tuple with the IssuerState field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CredentialOfferInfo) GetIssuerStateOk() (*string, bool) { + if o == nil || isNil(o.IssuerState) { + return nil, false + } + return o.IssuerState, true +} + +// HasIssuerState returns a boolean if a field has been set. +func (o *CredentialOfferInfo) HasIssuerState() bool { + if o != nil && !isNil(o.IssuerState) { + return true + } + + return false +} + +// SetIssuerState gets a reference to the given string and assigns it to the IssuerState field. +func (o *CredentialOfferInfo) SetIssuerState(v string) { + o.IssuerState = &v +} + +// GetPreAuthorizedCodeGrantIncluded returns the PreAuthorizedCodeGrantIncluded field value if set, zero value otherwise. +func (o *CredentialOfferInfo) GetPreAuthorizedCodeGrantIncluded() bool { + if o == nil || isNil(o.PreAuthorizedCodeGrantIncluded) { + var ret bool + return ret + } + return *o.PreAuthorizedCodeGrantIncluded +} + +// GetPreAuthorizedCodeGrantIncludedOk returns a tuple with the PreAuthorizedCodeGrantIncluded field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CredentialOfferInfo) GetPreAuthorizedCodeGrantIncludedOk() (*bool, bool) { + if o == nil || isNil(o.PreAuthorizedCodeGrantIncluded) { + return nil, false + } + return o.PreAuthorizedCodeGrantIncluded, true +} + +// HasPreAuthorizedCodeGrantIncluded returns a boolean if a field has been set. +func (o *CredentialOfferInfo) HasPreAuthorizedCodeGrantIncluded() bool { + if o != nil && !isNil(o.PreAuthorizedCodeGrantIncluded) { + return true + } + + return false +} + +// SetPreAuthorizedCodeGrantIncluded gets a reference to the given bool and assigns it to the PreAuthorizedCodeGrantIncluded field. +func (o *CredentialOfferInfo) SetPreAuthorizedCodeGrantIncluded(v bool) { + o.PreAuthorizedCodeGrantIncluded = &v +} + +// GetPreAuthorizedCode returns the PreAuthorizedCode field value if set, zero value otherwise. +func (o *CredentialOfferInfo) GetPreAuthorizedCode() string { + if o == nil || isNil(o.PreAuthorizedCode) { + var ret string + return ret + } + return *o.PreAuthorizedCode +} + +// GetPreAuthorizedCodeOk returns a tuple with the PreAuthorizedCode field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CredentialOfferInfo) GetPreAuthorizedCodeOk() (*string, bool) { + if o == nil || isNil(o.PreAuthorizedCode) { + return nil, false + } + return o.PreAuthorizedCode, true +} + +// HasPreAuthorizedCode returns a boolean if a field has been set. +func (o *CredentialOfferInfo) HasPreAuthorizedCode() bool { + if o != nil && !isNil(o.PreAuthorizedCode) { + return true + } + + return false +} + +// SetPreAuthorizedCode gets a reference to the given string and assigns it to the PreAuthorizedCode field. +func (o *CredentialOfferInfo) SetPreAuthorizedCode(v string) { + o.PreAuthorizedCode = &v +} + +// GetUserPinRequired returns the UserPinRequired field value if set, zero value otherwise. +func (o *CredentialOfferInfo) GetUserPinRequired() bool { + if o == nil || isNil(o.UserPinRequired) { + var ret bool + return ret + } + return *o.UserPinRequired +} + +// GetUserPinRequiredOk returns a tuple with the UserPinRequired field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CredentialOfferInfo) GetUserPinRequiredOk() (*bool, bool) { + if o == nil || isNil(o.UserPinRequired) { + return nil, false + } + return o.UserPinRequired, true +} + +// HasUserPinRequired returns a boolean if a field has been set. +func (o *CredentialOfferInfo) HasUserPinRequired() bool { + if o != nil && !isNil(o.UserPinRequired) { + return true + } + + return false +} + +// SetUserPinRequired gets a reference to the given bool and assigns it to the UserPinRequired field. +func (o *CredentialOfferInfo) SetUserPinRequired(v bool) { + o.UserPinRequired = &v +} + +// GetUserPin returns the UserPin field value if set, zero value otherwise. +func (o *CredentialOfferInfo) GetUserPin() string { + if o == nil || isNil(o.UserPin) { + var ret string + return ret + } + return *o.UserPin +} + +// GetUserPinOk returns a tuple with the UserPin field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CredentialOfferInfo) GetUserPinOk() (*string, bool) { + if o == nil || isNil(o.UserPin) { + return nil, false + } + return o.UserPin, true +} + +// HasUserPin returns a boolean if a field has been set. +func (o *CredentialOfferInfo) HasUserPin() bool { + if o != nil && !isNil(o.UserPin) { + return true + } + + return false +} + +// SetUserPin gets a reference to the given string and assigns it to the UserPin field. +func (o *CredentialOfferInfo) SetUserPin(v string) { + o.UserPin = &v +} + +// GetSubject returns the Subject field value if set, zero value otherwise. +func (o *CredentialOfferInfo) GetSubject() string { + if o == nil || isNil(o.Subject) { + var ret string + return ret + } + return *o.Subject +} + +// GetSubjectOk returns a tuple with the Subject field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CredentialOfferInfo) GetSubjectOk() (*string, bool) { + if o == nil || isNil(o.Subject) { + return nil, false + } + return o.Subject, true +} + +// HasSubject returns a boolean if a field has been set. +func (o *CredentialOfferInfo) HasSubject() bool { + if o != nil && !isNil(o.Subject) { + return true + } + + return false +} + +// SetSubject gets a reference to the given string and assigns it to the Subject field. +func (o *CredentialOfferInfo) SetSubject(v string) { + o.Subject = &v +} + +// GetExpiresAt returns the ExpiresAt field value if set, zero value otherwise. +func (o *CredentialOfferInfo) GetExpiresAt() int64 { + if o == nil || isNil(o.ExpiresAt) { + var ret int64 + return ret + } + return *o.ExpiresAt +} + +// GetExpiresAtOk returns a tuple with the ExpiresAt field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CredentialOfferInfo) GetExpiresAtOk() (*int64, bool) { + if o == nil || isNil(o.ExpiresAt) { + return nil, false + } + return o.ExpiresAt, true +} + +// HasExpiresAt returns a boolean if a field has been set. +func (o *CredentialOfferInfo) HasExpiresAt() bool { + if o != nil && !isNil(o.ExpiresAt) { + return true + } + + return false +} + +// SetExpiresAt gets a reference to the given int64 and assigns it to the ExpiresAt field. +func (o *CredentialOfferInfo) SetExpiresAt(v int64) { + o.ExpiresAt = &v +} + +// GetContext returns the Context field value if set, zero value otherwise. +func (o *CredentialOfferInfo) GetContext() string { + if o == nil || isNil(o.Context) { + var ret string + return ret + } + return *o.Context +} + +// GetContextOk returns a tuple with the Context field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CredentialOfferInfo) GetContextOk() (*string, bool) { + if o == nil || isNil(o.Context) { + return nil, false + } + return o.Context, true +} + +// HasContext returns a boolean if a field has been set. +func (o *CredentialOfferInfo) HasContext() bool { + if o != nil && !isNil(o.Context) { + return true + } + + return false +} + +// SetContext gets a reference to the given string and assigns it to the Context field. +func (o *CredentialOfferInfo) SetContext(v string) { + o.Context = &v +} + +// GetProperties returns the Properties field value if set, zero value otherwise. +func (o *CredentialOfferInfo) GetProperties() []Property { + if o == nil || isNil(o.Properties) { + var ret []Property + return ret + } + return o.Properties +} + +// GetPropertiesOk returns a tuple with the Properties field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CredentialOfferInfo) GetPropertiesOk() ([]Property, bool) { + if o == nil || isNil(o.Properties) { + return nil, false + } + return o.Properties, true +} + +// HasProperties returns a boolean if a field has been set. +func (o *CredentialOfferInfo) HasProperties() bool { + if o != nil && !isNil(o.Properties) { + return true + } + + return false +} + +// SetProperties gets a reference to the given []Property and assigns it to the Properties field. +func (o *CredentialOfferInfo) SetProperties(v []Property) { + o.Properties = v +} + +// GetJwtAtClaims returns the JwtAtClaims field value if set, zero value otherwise. +func (o *CredentialOfferInfo) GetJwtAtClaims() string { + if o == nil || isNil(o.JwtAtClaims) { + var ret string + return ret + } + return *o.JwtAtClaims +} + +// GetJwtAtClaimsOk returns a tuple with the JwtAtClaims field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CredentialOfferInfo) GetJwtAtClaimsOk() (*string, bool) { + if o == nil || isNil(o.JwtAtClaims) { + return nil, false + } + return o.JwtAtClaims, true +} + +// HasJwtAtClaims returns a boolean if a field has been set. +func (o *CredentialOfferInfo) HasJwtAtClaims() bool { + if o != nil && !isNil(o.JwtAtClaims) { + return true + } + + return false +} + +// SetJwtAtClaims gets a reference to the given string and assigns it to the JwtAtClaims field. +func (o *CredentialOfferInfo) SetJwtAtClaims(v string) { + o.JwtAtClaims = &v +} + +// GetAuthTime returns the AuthTime field value if set, zero value otherwise. +func (o *CredentialOfferInfo) GetAuthTime() int64 { + if o == nil || isNil(o.AuthTime) { + var ret int64 + return ret + } + return *o.AuthTime +} + +// GetAuthTimeOk returns a tuple with the AuthTime field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CredentialOfferInfo) GetAuthTimeOk() (*int64, bool) { + if o == nil || isNil(o.AuthTime) { + return nil, false + } + return o.AuthTime, true +} + +// HasAuthTime returns a boolean if a field has been set. +func (o *CredentialOfferInfo) HasAuthTime() bool { + if o != nil && !isNil(o.AuthTime) { + return true + } + + return false +} + +// SetAuthTime gets a reference to the given int64 and assigns it to the AuthTime field. +func (o *CredentialOfferInfo) SetAuthTime(v int64) { + o.AuthTime = &v +} + +// GetAcr returns the Acr field value if set, zero value otherwise. +func (o *CredentialOfferInfo) GetAcr() string { + if o == nil || isNil(o.Acr) { + var ret string + return ret + } + return *o.Acr +} + +// GetAcrOk returns a tuple with the Acr field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CredentialOfferInfo) GetAcrOk() (*string, bool) { + if o == nil || isNil(o.Acr) { + return nil, false + } + return o.Acr, true +} + +// HasAcr returns a boolean if a field has been set. +func (o *CredentialOfferInfo) HasAcr() bool { + if o != nil && !isNil(o.Acr) { + return true + } + + return false +} + +// SetAcr gets a reference to the given string and assigns it to the Acr field. +func (o *CredentialOfferInfo) SetAcr(v string) { + o.Acr = &v +} + +func (o CredentialOfferInfo) MarshalJSON() ([]byte, error) { + toSerialize,err := o.ToMap() + if err != nil { + return []byte{}, err + } + return json.Marshal(toSerialize) +} + +func (o CredentialOfferInfo) ToMap() (map[string]interface{}, error) { + toSerialize := map[string]interface{}{} + if !isNil(o.Identifier) { + toSerialize["identifier"] = o.Identifier + } + if !isNil(o.CredentialOffer) { + toSerialize["credentialOffer"] = o.CredentialOffer + } + if !isNil(o.CredentialIssuer) { + toSerialize["credentialIssuer"] = o.CredentialIssuer + } + if !isNil(o.Credentials) { + toSerialize["credentials"] = o.Credentials + } + if !isNil(o.AuthorizationCodeGrantIncluded) { + toSerialize["authorizationCodeGrantIncluded"] = o.AuthorizationCodeGrantIncluded + } + if !isNil(o.IssuerStateIncluded) { + toSerialize["issuerStateIncluded"] = o.IssuerStateIncluded + } + if !isNil(o.IssuerState) { + toSerialize["issuerState"] = o.IssuerState + } + if !isNil(o.PreAuthorizedCodeGrantIncluded) { + toSerialize["preAuthorizedCodeGrantIncluded"] = o.PreAuthorizedCodeGrantIncluded + } + if !isNil(o.PreAuthorizedCode) { + toSerialize["preAuthorizedCode"] = o.PreAuthorizedCode + } + if !isNil(o.UserPinRequired) { + toSerialize["userPinRequired"] = o.UserPinRequired + } + if !isNil(o.UserPin) { + toSerialize["userPin"] = o.UserPin + } + if !isNil(o.Subject) { + toSerialize["subject"] = o.Subject + } + if !isNil(o.ExpiresAt) { + toSerialize["expiresAt"] = o.ExpiresAt + } + if !isNil(o.Context) { + toSerialize["context"] = o.Context + } + if !isNil(o.Properties) { + toSerialize["properties"] = o.Properties + } + if !isNil(o.JwtAtClaims) { + toSerialize["jwtAtClaims"] = o.JwtAtClaims + } + if !isNil(o.AuthTime) { + toSerialize["authTime"] = o.AuthTime + } + if !isNil(o.Acr) { + toSerialize["acr"] = o.Acr + } + return toSerialize, nil +} + +type NullableCredentialOfferInfo struct { + value *CredentialOfferInfo + isSet bool +} + +func (v NullableCredentialOfferInfo) Get() *CredentialOfferInfo { + return v.value +} + +func (v *NullableCredentialOfferInfo) Set(val *CredentialOfferInfo) { + v.value = val + v.isSet = true +} + +func (v NullableCredentialOfferInfo) IsSet() bool { + return v.isSet +} + +func (v *NullableCredentialOfferInfo) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableCredentialOfferInfo(val *CredentialOfferInfo) *NullableCredentialOfferInfo { + return &NullableCredentialOfferInfo{value: val, isSet: true} +} + +func (v NullableCredentialOfferInfo) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableCredentialOfferInfo) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/model_credential_request_info.go b/model_credential_request_info.go new file mode 100644 index 0000000..75e4661 --- /dev/null +++ b/model_credential_request_info.go @@ -0,0 +1,238 @@ +/* +Authlete API + +Authlete API Document. + +API version: 3.0.0 +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package authlete + +import ( + "encoding/json" +) + +// checks if the CredentialRequestInfo type satisfies the MappedNullable interface at compile time +var _ MappedNullable = &CredentialRequestInfo{} + +// CredentialRequestInfo struct for CredentialRequestInfo +type CredentialRequestInfo struct { + // The identifier of the credential offer. + Identifier *string `json:"identifier,omitempty"` + // The value of the format parameter in the credential request. + Format *string `json:"format,omitempty"` + // The binding key specified by the proof in the credential request. + BindingKey *string `json:"bindingKey,omitempty"` + // The details about the credential request. + Details *string `json:"details,omitempty"` +} + +// NewCredentialRequestInfo instantiates a new CredentialRequestInfo object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewCredentialRequestInfo() *CredentialRequestInfo { + this := CredentialRequestInfo{} + return &this +} + +// NewCredentialRequestInfoWithDefaults instantiates a new CredentialRequestInfo object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewCredentialRequestInfoWithDefaults() *CredentialRequestInfo { + this := CredentialRequestInfo{} + return &this +} + +// GetIdentifier returns the Identifier field value if set, zero value otherwise. +func (o *CredentialRequestInfo) GetIdentifier() string { + if o == nil || isNil(o.Identifier) { + var ret string + return ret + } + return *o.Identifier +} + +// GetIdentifierOk returns a tuple with the Identifier field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CredentialRequestInfo) GetIdentifierOk() (*string, bool) { + if o == nil || isNil(o.Identifier) { + return nil, false + } + return o.Identifier, true +} + +// HasIdentifier returns a boolean if a field has been set. +func (o *CredentialRequestInfo) HasIdentifier() bool { + if o != nil && !isNil(o.Identifier) { + return true + } + + return false +} + +// SetIdentifier gets a reference to the given string and assigns it to the Identifier field. +func (o *CredentialRequestInfo) SetIdentifier(v string) { + o.Identifier = &v +} + +// GetFormat returns the Format field value if set, zero value otherwise. +func (o *CredentialRequestInfo) GetFormat() string { + if o == nil || isNil(o.Format) { + var ret string + return ret + } + return *o.Format +} + +// GetFormatOk returns a tuple with the Format field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CredentialRequestInfo) GetFormatOk() (*string, bool) { + if o == nil || isNil(o.Format) { + return nil, false + } + return o.Format, true +} + +// HasFormat returns a boolean if a field has been set. +func (o *CredentialRequestInfo) HasFormat() bool { + if o != nil && !isNil(o.Format) { + return true + } + + return false +} + +// SetFormat gets a reference to the given string and assigns it to the Format field. +func (o *CredentialRequestInfo) SetFormat(v string) { + o.Format = &v +} + +// GetBindingKey returns the BindingKey field value if set, zero value otherwise. +func (o *CredentialRequestInfo) GetBindingKey() string { + if o == nil || isNil(o.BindingKey) { + var ret string + return ret + } + return *o.BindingKey +} + +// GetBindingKeyOk returns a tuple with the BindingKey field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CredentialRequestInfo) GetBindingKeyOk() (*string, bool) { + if o == nil || isNil(o.BindingKey) { + return nil, false + } + return o.BindingKey, true +} + +// HasBindingKey returns a boolean if a field has been set. +func (o *CredentialRequestInfo) HasBindingKey() bool { + if o != nil && !isNil(o.BindingKey) { + return true + } + + return false +} + +// SetBindingKey gets a reference to the given string and assigns it to the BindingKey field. +func (o *CredentialRequestInfo) SetBindingKey(v string) { + o.BindingKey = &v +} + +// GetDetails returns the Details field value if set, zero value otherwise. +func (o *CredentialRequestInfo) GetDetails() string { + if o == nil || isNil(o.Details) { + var ret string + return ret + } + return *o.Details +} + +// GetDetailsOk returns a tuple with the Details field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CredentialRequestInfo) GetDetailsOk() (*string, bool) { + if o == nil || isNil(o.Details) { + return nil, false + } + return o.Details, true +} + +// HasDetails returns a boolean if a field has been set. +func (o *CredentialRequestInfo) HasDetails() bool { + if o != nil && !isNil(o.Details) { + return true + } + + return false +} + +// SetDetails gets a reference to the given string and assigns it to the Details field. +func (o *CredentialRequestInfo) SetDetails(v string) { + o.Details = &v +} + +func (o CredentialRequestInfo) MarshalJSON() ([]byte, error) { + toSerialize,err := o.ToMap() + if err != nil { + return []byte{}, err + } + return json.Marshal(toSerialize) +} + +func (o CredentialRequestInfo) ToMap() (map[string]interface{}, error) { + toSerialize := map[string]interface{}{} + if !isNil(o.Identifier) { + toSerialize["identifier"] = o.Identifier + } + if !isNil(o.Format) { + toSerialize["format"] = o.Format + } + if !isNil(o.BindingKey) { + toSerialize["bindingKey"] = o.BindingKey + } + if !isNil(o.Details) { + toSerialize["details"] = o.Details + } + return toSerialize, nil +} + +type NullableCredentialRequestInfo struct { + value *CredentialRequestInfo + isSet bool +} + +func (v NullableCredentialRequestInfo) Get() *CredentialRequestInfo { + return v.value +} + +func (v *NullableCredentialRequestInfo) Set(val *CredentialRequestInfo) { + v.value = val + v.isSet = true +} + +func (v NullableCredentialRequestInfo) IsSet() bool { + return v.isSet +} + +func (v *NullableCredentialRequestInfo) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableCredentialRequestInfo(val *CredentialRequestInfo) *NullableCredentialRequestInfo { + return &NullableCredentialRequestInfo{value: val, isSet: true} +} + +func (v NullableCredentialRequestInfo) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableCredentialRequestInfo) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/model_delivery_mode.go b/model_delivery_mode.go index 4eb740d..0ceb1f2 100644 --- a/model_delivery_mode.go +++ b/model_delivery_mode.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_device_authorization_request.go b/model_device_authorization_request.go index efb3e72..79ccd6b 100644 --- a/model_device_authorization_request.go +++ b/model_device_authorization_request.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_device_authorization_response.go b/model_device_authorization_response.go index 5b3f407..a33317e 100644 --- a/model_device_authorization_response.go +++ b/model_device_authorization_response.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_device_complete_request.go b/model_device_complete_request.go index 721a182..d1b206b 100644 --- a/model_device_complete_request.go +++ b/model_device_complete_request.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_device_complete_response.go b/model_device_complete_response.go index 8f475be..e86ceb9 100644 --- a/model_device_complete_response.go +++ b/model_device_complete_response.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_device_verification_request.go b/model_device_verification_request.go index 99ff88c..8a38639 100644 --- a/model_device_verification_request.go +++ b/model_device_verification_request.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_device_verification_response.go b/model_device_verification_response.go index f01bce1..e8a7877 100644 --- a/model_device_verification_response.go +++ b/model_device_verification_response.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_display.go b/model_display.go index db7daf5..5d283be 100644 --- a/model_display.go +++ b/model_display.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_dynamic_scope.go b/model_dynamic_scope.go index ecfa569..b5c0c7b 100644 --- a/model_dynamic_scope.go +++ b/model_dynamic_scope.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_fapi_mode.go b/model_fapi_mode.go new file mode 100644 index 0000000..d59cd04 --- /dev/null +++ b/model_fapi_mode.go @@ -0,0 +1,119 @@ +/* +Authlete API + +Authlete API Document. + +API version: 3.0.0 +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package authlete + +import ( + "encoding/json" + "fmt" +) + +// FapiMode the model 'FapiMode' +type FapiMode string + +// List of fapi_mode +const ( + FAPIMODE_FAPI1_ADVANCED FapiMode = "FAPI1_ADVANCED" + FAPIMODE_FAPI1_BASELINE FapiMode = "FAPI1_BASELINE" + FAPIMODE_FAPI2_MESSAGE_SIGNING_AUTH_REQ FapiMode = "FAPI2_MESSAGE_SIGNING_AUTH_REQ" + FAPIMODE_FAPI2_MESSAGE_SIGNING_AUTH_RES FapiMode = "FAPI2_MESSAGE_SIGNING_AUTH_RES" + FAPIMODE_FAPI2_MESSAGE_SIGNING_INTROSPECTION_RES FapiMode = "FAPI2_MESSAGE_SIGNING_INTROSPECTION_RES" + FAPIMODE_FAPI2_SECURITY FapiMode = "FAPI2_SECURITY" +) + +// All allowed values of FapiMode enum +var AllowedFapiModeEnumValues = []FapiMode{ + "FAPI1_ADVANCED", + "FAPI1_BASELINE", + "FAPI2_MESSAGE_SIGNING_AUTH_REQ", + "FAPI2_MESSAGE_SIGNING_AUTH_RES", + "FAPI2_MESSAGE_SIGNING_INTROSPECTION_RES", + "FAPI2_SECURITY", +} + +func (v *FapiMode) UnmarshalJSON(src []byte) error { + var value string + err := json.Unmarshal(src, &value) + if err != nil { + return err + } + enumTypeValue := FapiMode(value) + for _, existing := range AllowedFapiModeEnumValues { + if existing == enumTypeValue { + *v = enumTypeValue + return nil + } + } + + return fmt.Errorf("%+v is not a valid FapiMode", value) +} + +// NewFapiModeFromValue returns a pointer to a valid FapiMode +// for the value passed as argument, or an error if the value passed is not allowed by the enum +func NewFapiModeFromValue(v string) (*FapiMode, error) { + ev := FapiMode(v) + if ev.IsValid() { + return &ev, nil + } else { + return nil, fmt.Errorf("invalid value '%v' for FapiMode: valid values are %v", v, AllowedFapiModeEnumValues) + } +} + +// IsValid return true if the value is valid for the enum, false otherwise +func (v FapiMode) IsValid() bool { + for _, existing := range AllowedFapiModeEnumValues { + if existing == v { + return true + } + } + return false +} + +// Ptr returns reference to fapi_mode value +func (v FapiMode) Ptr() *FapiMode { + return &v +} + +type NullableFapiMode struct { + value *FapiMode + isSet bool +} + +func (v NullableFapiMode) Get() *FapiMode { + return v.value +} + +func (v *NullableFapiMode) Set(val *FapiMode) { + v.value = val + v.isSet = true +} + +func (v NullableFapiMode) IsSet() bool { + return v.isSet +} + +func (v *NullableFapiMode) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableFapiMode(val *FapiMode) *NullableFapiMode { + return &NullableFapiMode{value: val, isSet: true} +} + +func (v NullableFapiMode) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableFapiMode) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + diff --git a/model_federation_configuration_response.go b/model_federation_configuration_response.go index 5828a74..0238ff3 100644 --- a/model_federation_configuration_response.go +++ b/model_federation_configuration_response.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_federation_registration_request.go b/model_federation_registration_request.go index 2086277..8130b71 100644 --- a/model_federation_registration_request.go +++ b/model_federation_registration_request.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_federation_registration_response.go b/model_federation_registration_response.go index a449584..555b7d5 100644 --- a/model_federation_registration_response.go +++ b/model_federation_registration_response.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_g_m_request.go b/model_g_m_request.go index 22a915a..d2195ba 100644 --- a/model_g_m_request.go +++ b/model_g_m_request.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_g_m_response.go b/model_g_m_response.go index 73a1992..9b62feb 100644 --- a/model_g_m_response.go +++ b/model_g_m_response.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. @@ -27,6 +27,8 @@ type GMResponse struct { Action *string `json:"action,omitempty"` // The content that the authorization server implementation is to return to the client application. Its format varies depending on the value of `action` parameter. ResponseContent *string `json:"responseContent,omitempty"` + // Get the expected nonce value for DPoP proof JWT, which should be used as the value of the `DPoP-Nonce` HTTP header. + DpopNonce *string `json:"dpopNonce,omitempty"` } // NewGMResponse instantiates a new GMResponse object @@ -174,6 +176,38 @@ func (o *GMResponse) SetResponseContent(v string) { o.ResponseContent = &v } +// GetDpopNonce returns the DpopNonce field value if set, zero value otherwise. +func (o *GMResponse) GetDpopNonce() string { + if o == nil || isNil(o.DpopNonce) { + var ret string + return ret + } + return *o.DpopNonce +} + +// GetDpopNonceOk returns a tuple with the DpopNonce field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *GMResponse) GetDpopNonceOk() (*string, bool) { + if o == nil || isNil(o.DpopNonce) { + return nil, false + } + return o.DpopNonce, true +} + +// HasDpopNonce returns a boolean if a field has been set. +func (o *GMResponse) HasDpopNonce() bool { + if o != nil && !isNil(o.DpopNonce) { + return true + } + + return false +} + +// SetDpopNonce gets a reference to the given string and assigns it to the DpopNonce field. +func (o *GMResponse) SetDpopNonce(v string) { + o.DpopNonce = &v +} + func (o GMResponse) MarshalJSON() ([]byte, error) { toSerialize,err := o.ToMap() if err != nil { @@ -196,6 +230,9 @@ func (o GMResponse) ToMap() (map[string]interface{}, error) { if !isNil(o.ResponseContent) { toSerialize["responseContent"] = o.ResponseContent } + if !isNil(o.DpopNonce) { + toSerialize["dpopNonce"] = o.DpopNonce + } return toSerialize, nil } diff --git a/model_grant.go b/model_grant.go index 1072417..b020796 100644 --- a/model_grant.go +++ b/model_grant.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_grant_management_action.go b/model_grant_management_action.go index f4acf11..818eb7e 100644 --- a/model_grant_management_action.go +++ b/model_grant_management_action.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_grant_scope.go b/model_grant_scope.go index 325a301..8e91df0 100644 --- a/model_grant_scope.go +++ b/model_grant_scope.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_grant_type.go b/model_grant_type.go index ac384a4..8177025 100644 --- a/model_grant_type.go +++ b/model_grant_type.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_hsk.go b/model_hsk.go index 7da6a3b..a6b3ff4 100644 --- a/model_hsk.go +++ b/model_hsk.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_hsk_create_request.go b/model_hsk_create_request.go index e74429e..2377396 100644 --- a/model_hsk_create_request.go +++ b/model_hsk_create_request.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_hsk_create_response.go b/model_hsk_create_response.go index ee6a2ac..8b9c2d1 100644 --- a/model_hsk_create_response.go +++ b/model_hsk_create_response.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_hsk_delete_response.go b/model_hsk_delete_response.go index 0cb3ed8..533edef 100644 --- a/model_hsk_delete_response.go +++ b/model_hsk_delete_response.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_hsk_get_list_response.go b/model_hsk_get_list_response.go index e274138..2be4cee 100644 --- a/model_hsk_get_list_response.go +++ b/model_hsk_get_list_response.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_hsk_get_response.go b/model_hsk_get_response.go index ed7f834..8811b8a 100644 --- a/model_hsk_get_response.go +++ b/model_hsk_get_response.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_idtoken_reissue_request.go b/model_idtoken_reissue_request.go index 15ebada..58ebfe3 100644 --- a/model_idtoken_reissue_request.go +++ b/model_idtoken_reissue_request.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_idtoken_reissue_response.go b/model_idtoken_reissue_response.go index 9ebd2f9..951c726 100644 --- a/model_idtoken_reissue_response.go +++ b/model_idtoken_reissue_response.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_info_response.go b/model_info_response.go index a53c7a7..9f8247e 100644 --- a/model_info_response.go +++ b/model_info_response.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_introspection_request.go b/model_introspection_request.go index b2a9097..7ba25e1 100644 --- a/model_introspection_request.go +++ b/model_introspection_request.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_introspection_response.go b/model_introspection_response.go index 314f367..2c8b937 100644 --- a/model_introspection_response.go +++ b/model_introspection_response.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. @@ -76,8 +76,18 @@ type IntrospectionResponse struct { AuthTime *int64 `json:"authTime,omitempty"` // The entity ID of the client. ClientEntityId *string `json:"clientEntityId,omitempty"` - // Flag which indicates whether the entity ID of the client was used when the request for the access token was made. + // Flag which indicates whether the entity ID of the client was used when the request for the access token was made. ClientEntityIdUsed *bool `json:"clientEntityIdUsed,omitempty"` + // The flag indicating whether the token is for credential issuance. + ForCredentialIssuance *bool `json:"forCredentialIssuance,omitempty"` + // The c_nonce + Cnonce *string `json:"cnonce,omitempty"` + // The time at which the `c_nonce` expires. + CnonceExpiresAt *int64 `json:"cnonceExpiresAt,omitempty"` + // The credentials that can be obtained by presenting the access token. + IssuableCredentials *string `json:"issuableCredentials,omitempty"` + // The expected nonce value for DPoP proof JWT, which should be used as the value of the `DPoP-Nonce` HTTP header. + DpopNonce *string `json:"dpopNonce,omitempty"` } // NewIntrospectionResponse instantiates a new IntrospectionResponse object @@ -1089,6 +1099,166 @@ func (o *IntrospectionResponse) SetClientEntityIdUsed(v bool) { o.ClientEntityIdUsed = &v } +// GetForCredentialIssuance returns the ForCredentialIssuance field value if set, zero value otherwise. +func (o *IntrospectionResponse) GetForCredentialIssuance() bool { + if o == nil || isNil(o.ForCredentialIssuance) { + var ret bool + return ret + } + return *o.ForCredentialIssuance +} + +// GetForCredentialIssuanceOk returns a tuple with the ForCredentialIssuance field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *IntrospectionResponse) GetForCredentialIssuanceOk() (*bool, bool) { + if o == nil || isNil(o.ForCredentialIssuance) { + return nil, false + } + return o.ForCredentialIssuance, true +} + +// HasForCredentialIssuance returns a boolean if a field has been set. +func (o *IntrospectionResponse) HasForCredentialIssuance() bool { + if o != nil && !isNil(o.ForCredentialIssuance) { + return true + } + + return false +} + +// SetForCredentialIssuance gets a reference to the given bool and assigns it to the ForCredentialIssuance field. +func (o *IntrospectionResponse) SetForCredentialIssuance(v bool) { + o.ForCredentialIssuance = &v +} + +// GetCnonce returns the Cnonce field value if set, zero value otherwise. +func (o *IntrospectionResponse) GetCnonce() string { + if o == nil || isNil(o.Cnonce) { + var ret string + return ret + } + return *o.Cnonce +} + +// GetCnonceOk returns a tuple with the Cnonce field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *IntrospectionResponse) GetCnonceOk() (*string, bool) { + if o == nil || isNil(o.Cnonce) { + return nil, false + } + return o.Cnonce, true +} + +// HasCnonce returns a boolean if a field has been set. +func (o *IntrospectionResponse) HasCnonce() bool { + if o != nil && !isNil(o.Cnonce) { + return true + } + + return false +} + +// SetCnonce gets a reference to the given string and assigns it to the Cnonce field. +func (o *IntrospectionResponse) SetCnonce(v string) { + o.Cnonce = &v +} + +// GetCnonceExpiresAt returns the CnonceExpiresAt field value if set, zero value otherwise. +func (o *IntrospectionResponse) GetCnonceExpiresAt() int64 { + if o == nil || isNil(o.CnonceExpiresAt) { + var ret int64 + return ret + } + return *o.CnonceExpiresAt +} + +// GetCnonceExpiresAtOk returns a tuple with the CnonceExpiresAt field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *IntrospectionResponse) GetCnonceExpiresAtOk() (*int64, bool) { + if o == nil || isNil(o.CnonceExpiresAt) { + return nil, false + } + return o.CnonceExpiresAt, true +} + +// HasCnonceExpiresAt returns a boolean if a field has been set. +func (o *IntrospectionResponse) HasCnonceExpiresAt() bool { + if o != nil && !isNil(o.CnonceExpiresAt) { + return true + } + + return false +} + +// SetCnonceExpiresAt gets a reference to the given int64 and assigns it to the CnonceExpiresAt field. +func (o *IntrospectionResponse) SetCnonceExpiresAt(v int64) { + o.CnonceExpiresAt = &v +} + +// GetIssuableCredentials returns the IssuableCredentials field value if set, zero value otherwise. +func (o *IntrospectionResponse) GetIssuableCredentials() string { + if o == nil || isNil(o.IssuableCredentials) { + var ret string + return ret + } + return *o.IssuableCredentials +} + +// GetIssuableCredentialsOk returns a tuple with the IssuableCredentials field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *IntrospectionResponse) GetIssuableCredentialsOk() (*string, bool) { + if o == nil || isNil(o.IssuableCredentials) { + return nil, false + } + return o.IssuableCredentials, true +} + +// HasIssuableCredentials returns a boolean if a field has been set. +func (o *IntrospectionResponse) HasIssuableCredentials() bool { + if o != nil && !isNil(o.IssuableCredentials) { + return true + } + + return false +} + +// SetIssuableCredentials gets a reference to the given string and assigns it to the IssuableCredentials field. +func (o *IntrospectionResponse) SetIssuableCredentials(v string) { + o.IssuableCredentials = &v +} + +// GetDpopNonce returns the DpopNonce field value if set, zero value otherwise. +func (o *IntrospectionResponse) GetDpopNonce() string { + if o == nil || isNil(o.DpopNonce) { + var ret string + return ret + } + return *o.DpopNonce +} + +// GetDpopNonceOk returns a tuple with the DpopNonce field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *IntrospectionResponse) GetDpopNonceOk() (*string, bool) { + if o == nil || isNil(o.DpopNonce) { + return nil, false + } + return o.DpopNonce, true +} + +// HasDpopNonce returns a boolean if a field has been set. +func (o *IntrospectionResponse) HasDpopNonce() bool { + if o != nil && !isNil(o.DpopNonce) { + return true + } + + return false +} + +// SetDpopNonce gets a reference to the given string and assigns it to the DpopNonce field. +func (o *IntrospectionResponse) SetDpopNonce(v string) { + o.DpopNonce = &v +} + func (o IntrospectionResponse) MarshalJSON() ([]byte, error) { toSerialize,err := o.ToMap() if err != nil { @@ -1192,6 +1362,21 @@ func (o IntrospectionResponse) ToMap() (map[string]interface{}, error) { if !isNil(o.ClientEntityIdUsed) { toSerialize["clientEntityIdUsed"] = o.ClientEntityIdUsed } + if !isNil(o.ForCredentialIssuance) { + toSerialize["forCredentialIssuance"] = o.ForCredentialIssuance + } + if !isNil(o.Cnonce) { + toSerialize["cnonce"] = o.Cnonce + } + if !isNil(o.CnonceExpiresAt) { + toSerialize["cnonceExpiresAt"] = o.CnonceExpiresAt + } + if !isNil(o.IssuableCredentials) { + toSerialize["issuableCredentials"] = o.IssuableCredentials + } + if !isNil(o.DpopNonce) { + toSerialize["dpopNonce"] = o.DpopNonce + } return toSerialize, nil } diff --git a/model_jose_verify_request.go b/model_jose_verify_request.go index 13c9469..0ae9699 100644 --- a/model_jose_verify_request.go +++ b/model_jose_verify_request.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_jose_verify_response.go b/model_jose_verify_response.go index c530a99..0dfa9e0 100644 --- a/model_jose_verify_response.go +++ b/model_jose_verify_response.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_jwe_alg.go b/model_jwe_alg.go index 2480918..589eb1d 100644 --- a/model_jwe_alg.go +++ b/model_jwe_alg.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_jwe_enc.go b/model_jwe_enc.go index f1d5921..0d7ea28 100644 --- a/model_jwe_enc.go +++ b/model_jwe_enc.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_jws_alg.go b/model_jws_alg.go index 44f1787..6658df1 100644 --- a/model_jws_alg.go +++ b/model_jws_alg.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_named_uri.go b/model_named_uri.go index dcd43b1..d4b39a0 100644 --- a/model_named_uri.go +++ b/model_named_uri.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_pair.go b/model_pair.go index c46fcb9..ea517ea 100644 --- a/model_pair.go +++ b/model_pair.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_prompt.go b/model_prompt.go index 024fb4d..c5a4e95 100644 --- a/model_prompt.go +++ b/model_prompt.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_property.go b/model_property.go index c7bb9a7..f5eb128 100644 --- a/model_property.go +++ b/model_property.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_pushed_authorization_request.go b/model_pushed_authorization_request.go index 0c9cf55..9cb6202 100644 --- a/model_pushed_authorization_request.go +++ b/model_pushed_authorization_request.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_pushed_authorization_response.go b/model_pushed_authorization_response.go index 98eec94..0f76a07 100644 --- a/model_pushed_authorization_response.go +++ b/model_pushed_authorization_response.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. @@ -29,6 +29,10 @@ type PushedAuthorizationResponse struct { RequestUri *string `json:"requestUri,omitempty"` // The content that the authorization server implementation is to return to the client application. ResponseContent *string `json:"responseContent,omitempty"` + // The client authentication method that the client application declares that it uses at the token endpoint. This property corresponds to `token_endpoint_auth_method` in [OpenID Connect Dynamic Client Registration 1.0, 2. Client Metadata](https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata). + ClientAuthMethod *string `json:"clientAuthMethod,omitempty"` + // Get the expected nonce value for DPoP proof JWT, which should be used as the value of the `DPoP-Nonce` HTTP header. + DpopNonce *string `json:"dpopNonce,omitempty"` } // NewPushedAuthorizationResponse instantiates a new PushedAuthorizationResponse object @@ -208,6 +212,70 @@ func (o *PushedAuthorizationResponse) SetResponseContent(v string) { o.ResponseContent = &v } +// GetClientAuthMethod returns the ClientAuthMethod field value if set, zero value otherwise. +func (o *PushedAuthorizationResponse) GetClientAuthMethod() string { + if o == nil || isNil(o.ClientAuthMethod) { + var ret string + return ret + } + return *o.ClientAuthMethod +} + +// GetClientAuthMethodOk returns a tuple with the ClientAuthMethod field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *PushedAuthorizationResponse) GetClientAuthMethodOk() (*string, bool) { + if o == nil || isNil(o.ClientAuthMethod) { + return nil, false + } + return o.ClientAuthMethod, true +} + +// HasClientAuthMethod returns a boolean if a field has been set. +func (o *PushedAuthorizationResponse) HasClientAuthMethod() bool { + if o != nil && !isNil(o.ClientAuthMethod) { + return true + } + + return false +} + +// SetClientAuthMethod gets a reference to the given string and assigns it to the ClientAuthMethod field. +func (o *PushedAuthorizationResponse) SetClientAuthMethod(v string) { + o.ClientAuthMethod = &v +} + +// GetDpopNonce returns the DpopNonce field value if set, zero value otherwise. +func (o *PushedAuthorizationResponse) GetDpopNonce() string { + if o == nil || isNil(o.DpopNonce) { + var ret string + return ret + } + return *o.DpopNonce +} + +// GetDpopNonceOk returns a tuple with the DpopNonce field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *PushedAuthorizationResponse) GetDpopNonceOk() (*string, bool) { + if o == nil || isNil(o.DpopNonce) { + return nil, false + } + return o.DpopNonce, true +} + +// HasDpopNonce returns a boolean if a field has been set. +func (o *PushedAuthorizationResponse) HasDpopNonce() bool { + if o != nil && !isNil(o.DpopNonce) { + return true + } + + return false +} + +// SetDpopNonce gets a reference to the given string and assigns it to the DpopNonce field. +func (o *PushedAuthorizationResponse) SetDpopNonce(v string) { + o.DpopNonce = &v +} + func (o PushedAuthorizationResponse) MarshalJSON() ([]byte, error) { toSerialize,err := o.ToMap() if err != nil { @@ -233,6 +301,12 @@ func (o PushedAuthorizationResponse) ToMap() (map[string]interface{}, error) { if !isNil(o.ResponseContent) { toSerialize["responseContent"] = o.ResponseContent } + if !isNil(o.ClientAuthMethod) { + toSerialize["clientAuthMethod"] = o.ClientAuthMethod + } + if !isNil(o.DpopNonce) { + toSerialize["dpopNonce"] = o.DpopNonce + } return toSerialize, nil } diff --git a/model_response_type.go b/model_response_type.go index a111308..c929430 100644 --- a/model_response_type.go +++ b/model_response_type.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_result.go b/model_result.go index 8049cb0..0ff4a3b 100644 --- a/model_result.go +++ b/model_result.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_revocation_request.go b/model_revocation_request.go index a2936cd..c582fc4 100644 --- a/model_revocation_request.go +++ b/model_revocation_request.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_revocation_response.go b/model_revocation_response.go index e3acb42..98a54a7 100644 --- a/model_revocation_response.go +++ b/model_revocation_response.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_scope.go b/model_scope.go index 6e72291..bc39274 100644 --- a/model_scope.go +++ b/model_scope.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_service.go b/model_service.go index b7bfaa9..4ad35bc 100644 --- a/model_service.go +++ b/model_service.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. @@ -21,21 +21,15 @@ var _ MappedNullable = &Service{} type Service struct { // The sequential number of the service. The value of this property is assigned by Authlete. Number *int32 `json:"number,omitempty"` - // The sequential number of the service owner of the service. The value of this property is assigned by Authlete. - ServiceOwnerNumber *int32 `json:"serviceOwnerNumber,omitempty"` // The name of this service. ServiceName *string `json:"serviceName,omitempty"` // The issuer identifier of the service. A URL that starts with https:// and has no query or fragment component. The value of this property is used as `iss` claim in an [ID token](https://openid.net/specs/openid-connect-core-1_0.html#IDToken) and `issuer` property in the [OpenID Provider Metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). Issuer *string `json:"issuer,omitempty"` // The description about the service. Description *string `json:"description,omitempty"` - // The API key. The value of this property is assigned by Authlete. + // The service ID used in Authlete API calls. The value of this property is assigned by Authlete. ApiKey *int64 `json:"apiKey,omitempty"` - // The API secret. A random 256-bit value encoded by base64url (43 letters). The value of this property is assigned by Authlete. - ApiSecret *string `json:"apiSecret,omitempty"` - // The maximum number of client applications that a developer is allowed to create. `0` means no limit. - ClientsPerDeveloper *int32 `json:"clientsPerDeveloper,omitempty"` - // The flag to indicate whether the 'Client ID Alias' feature is enabled or not. When a new client is created, Authlete generates a numeric value and assigns it as a client ID to the newly created client. In addition to the client ID, each client can have a client ID alias. The client ID alias is, however, recognized only when this property (`clientIdAliasEnabled`) is set to `true`. + // Deprecated. Always `true`. ClientIdAliasEnabled *bool `json:"clientIdAliasEnabled,omitempty"` // The `metadata` of the service. The content of the returned array depends on contexts. The predefined service metadata is listed in the following table. | Key | Description | | --- | --- | | `clientCount` | The number of client applications which belong to this service. | Metadata []Pair `json:"metadata,omitempty"` @@ -49,22 +43,8 @@ type Service struct { AuthenticationCallbackApiKey *string `json:"authenticationCallbackApiKey,omitempty"` // API secret for `basic` authentication at the authentication callback endpoint. AuthenticationCallbackApiSecret *string `json:"authenticationCallbackApiSecret,omitempty"` - // SNSes you want to support 'social login' in the UI at the authorization endpoint provided by Authlete. You need to register a `client` application in each SNS that is set as this parameter and set Authlete server's `/api/sns/redirection` as the redirection endpoint of the client application. - SupportedSnses []Sns `json:"supportedSnses,omitempty"` - // `SNS` credentials which Authlete uses to make requests to SNSes. The format is JSON. - SnsCredentials []SnsCredentials `json:"snsCredentials,omitempty"` // Values of acrs (authentication context class references) that the service supports. The value of this property is used as `acr_values_supported` property in the [OpenID Provider Metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). SupportedAcrs []string `json:"supportedAcrs,omitempty"` - // A Web API endpoint for developer authentication which is to be prepared on the server side. The endpoint must be implemented if you use Developer Console. The developer authentication at the login page of Developer Console is performed by making a `POST` request to this endpoint. - DeveloperAuthenticationCallbackEndpoint *string `json:"developerAuthenticationCallbackEndpoint,omitempty"` - // API key for basic authentication at the developer authentication callback endpoint. If the value is not empty, Authlete generates Authorization header for Basic authentication when making a request to the developer authentication callback endpoint. - DeveloperAuthenticationCallbackApiKey *string `json:"developerAuthenticationCallbackApiKey,omitempty"` - // API secret for basic authentication at the developer authentication callback endpoint. - DeveloperAuthenticationCallbackApiSecret *string `json:"developerAuthenticationCallbackApiSecret,omitempty"` - // SNSes you want to support 'social login' in the login page of Developer Console provided by Authlete. You need to register a client application in each SNS checked here and set Authlete server's `/api/developer/sns/redirection` as the redirection endpoint of the client application. - SupportedDeveloperSnses []Sns `json:"supportedDeveloperSnses,omitempty"` - // SNS credentials which Authlete uses to make requests to SNSes. The format is JSON. - DeveloperSnsCredentials []SnsCredentials `json:"developerSnsCredentials,omitempty"` // Values of `grant_type` request parameter that the service supports. The value of this property is used as `grant_types_supported property` in the [OpenID Provider Metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). SupportedGrantTypes []GrantType `json:"supportedGrantTypes,omitempty"` // Values of `response_type` request parameter that the service supports. Valid values are listed in Response Type. The value of this property is used as `response_types_supported` property in the [OpenID Provider Metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). @@ -318,18 +298,47 @@ type Service struct { DcrDuplicateSoftwareIdBlocked *bool `json:"dcrDuplicateSoftwareIdBlocked,omitempty"` // The trust anchors that are referenced when this service resolves trust chains of relying parties. If this property is empty, client registration fails regardless of whether its type is `automatic` or `explicit`. It means that OpenID Connect Federation 1.0 does not work. TrustAnchors []TrustAnchor `json:"trustAnchors,omitempty"` - // The flag indicating whether the openid scope should be dropped from scopes list assigned to access token issued when a refresh token grant is used. + // The flag indicating whether the openid scope should be dropped from scopes list assigned to access token issued when a refresh token grant is used. OpenidDroppedOnRefreshWithoutOfflineAccess *bool `json:"openidDroppedOnRefreshWithoutOfflineAccess,omitempty"` // Supported document check methods. This property corresponds to the `documents_check_methods_supported` server metadata which was added by the fourth implementer's draft of OpenID Connect for Identity Assurance 1.0. SupportedDocumentsCheckMethods []string `json:"supportedDocumentsCheckMethods,omitempty"` // The flag indicating whether this service signs responses from the resource server. RsResponseSigned *bool `json:"rsResponseSigned,omitempty"` - // Get the key ID of a JWK containing the public key used by this client to sign requests to the resource server. + // The duration of `c_nonce`. + CnonceDuration *int64 `json:"cnonceDuration,omitempty"` + // Whether to require DPoP proof JWTs to include the `nonce` claim whenever they are presented. + DpopNonceRequired *bool `json:"dpopNonceRequired,omitempty"` + // Get the flag indicating whether the feature of Verifiable Credentials for this service is enabled or not. + VerifiableCredentialsEnabled *bool `json:"verifiableCredentialsEnabled,omitempty"` + // The URL at which the JWK Set document of the credential issuer is exposed. + CredentialJwksUri *string `json:"credentialJwksUri,omitempty"` + // The default duration of credential offers in seconds. + CredentialOfferDuration *int64 `json:"credentialOfferDuration,omitempty"` + // The duration of nonce values for DPoP proof JWTs in seconds. + DpopNonceDuration *int64 `json:"dpopNonceDuration,omitempty"` + // The flag indicating whether token requests using the pre-authorized code grant flow by unidentifiable clients are allowed. + PreAuthorizedGrantAnonymousAccessSupported *bool `json:"preAuthorizedGrantAnonymousAccessSupported,omitempty"` + // The duration of transaction ID in seconds that may be issued as a result of a credential request or a batch credential request. + CredentialTransactionDuration *int64 `json:"credentialTransactionDuration,omitempty"` + // The key ID of the key for signing introspection responses. + IntrospectionSignatureKeyId *string `json:"introspectionSignatureKeyId,omitempty"` + // The key ID of the key for signing introspection responses. ResourceSignatureKeyId *string `json:"resourceSignatureKeyId,omitempty"` - // The type of the `aud` claim in ID tokens. - IdTokenAudType *string `json:"idTokenAudType,omitempty"` - // The flag indicating whether to enable the feature of ID token reissuance in the refresh token flow. + // The default length of user PINs. + UserPinLength *int32 `json:"userPinLength,omitempty"` + // The supported `prompt` values. + SupportedPromptValues []Prompt `json:"supportedPromptValues,omitempty"` + // The flag indicating whether to enable the feature of ID token reissuance in the refresh token flow. IdTokenReissuable *bool `json:"idTokenReissuable,omitempty"` + // The JWK Set document containing private keys that are used to sign verifiable credentials. + CredentialJwks *string `json:"credentialJwks,omitempty"` + // FAPI modes for this service. When the value of this property is not `null`, Authlete always processes requests to this service based on the specified FAPI modes if the FAPI feature is enabled in Authlete and the FAPI profile is supported by this service. For instance, when this property is set to an array containing `FAPI1_ADVANCED` only, Authlete always processes requests to this service based on \"Financial-grade API Security Profile 1.0 - Part 2: Advanced\" if the FAPI feature is enabled in Authlete and the FAPI profile is supported by this service. + FapiModes []FapiMode `json:"fapiModes,omitempty"` + // The default duration of verifiable credentials in seconds. + CredentialDuration *int64 `json:"credentialDuration,omitempty"` + CredentialIssuerMetadata *CredentialIssuerMetadata `json:"credentialIssuerMetadata,omitempty"` + // The type of the `aud` claim in ID tokens. + IdTokenAudType *string `json:"idTokenAudType,omitempty"` } // NewService instantiates a new Service object @@ -381,38 +390,6 @@ func (o *Service) SetNumber(v int32) { o.Number = &v } -// GetServiceOwnerNumber returns the ServiceOwnerNumber field value if set, zero value otherwise. -func (o *Service) GetServiceOwnerNumber() int32 { - if o == nil || isNil(o.ServiceOwnerNumber) { - var ret int32 - return ret - } - return *o.ServiceOwnerNumber -} - -// GetServiceOwnerNumberOk returns a tuple with the ServiceOwnerNumber field value if set, nil otherwise -// and a boolean to check if the value has been set. -func (o *Service) GetServiceOwnerNumberOk() (*int32, bool) { - if o == nil || isNil(o.ServiceOwnerNumber) { - return nil, false - } - return o.ServiceOwnerNumber, true -} - -// HasServiceOwnerNumber returns a boolean if a field has been set. -func (o *Service) HasServiceOwnerNumber() bool { - if o != nil && !isNil(o.ServiceOwnerNumber) { - return true - } - - return false -} - -// SetServiceOwnerNumber gets a reference to the given int32 and assigns it to the ServiceOwnerNumber field. -func (o *Service) SetServiceOwnerNumber(v int32) { - o.ServiceOwnerNumber = &v -} - // GetServiceName returns the ServiceName field value if set, zero value otherwise. func (o *Service) GetServiceName() string { if o == nil || isNil(o.ServiceName) { @@ -541,70 +518,6 @@ func (o *Service) SetApiKey(v int64) { o.ApiKey = &v } -// GetApiSecret returns the ApiSecret field value if set, zero value otherwise. -func (o *Service) GetApiSecret() string { - if o == nil || isNil(o.ApiSecret) { - var ret string - return ret - } - return *o.ApiSecret -} - -// GetApiSecretOk returns a tuple with the ApiSecret field value if set, nil otherwise -// and a boolean to check if the value has been set. -func (o *Service) GetApiSecretOk() (*string, bool) { - if o == nil || isNil(o.ApiSecret) { - return nil, false - } - return o.ApiSecret, true -} - -// HasApiSecret returns a boolean if a field has been set. -func (o *Service) HasApiSecret() bool { - if o != nil && !isNil(o.ApiSecret) { - return true - } - - return false -} - -// SetApiSecret gets a reference to the given string and assigns it to the ApiSecret field. -func (o *Service) SetApiSecret(v string) { - o.ApiSecret = &v -} - -// GetClientsPerDeveloper returns the ClientsPerDeveloper field value if set, zero value otherwise. -func (o *Service) GetClientsPerDeveloper() int32 { - if o == nil || isNil(o.ClientsPerDeveloper) { - var ret int32 - return ret - } - return *o.ClientsPerDeveloper -} - -// GetClientsPerDeveloperOk returns a tuple with the ClientsPerDeveloper field value if set, nil otherwise -// and a boolean to check if the value has been set. -func (o *Service) GetClientsPerDeveloperOk() (*int32, bool) { - if o == nil || isNil(o.ClientsPerDeveloper) { - return nil, false - } - return o.ClientsPerDeveloper, true -} - -// HasClientsPerDeveloper returns a boolean if a field has been set. -func (o *Service) HasClientsPerDeveloper() bool { - if o != nil && !isNil(o.ClientsPerDeveloper) { - return true - } - - return false -} - -// SetClientsPerDeveloper gets a reference to the given int32 and assigns it to the ClientsPerDeveloper field. -func (o *Service) SetClientsPerDeveloper(v int32) { - o.ClientsPerDeveloper = &v -} - // GetClientIdAliasEnabled returns the ClientIdAliasEnabled field value if set, zero value otherwise. func (o *Service) GetClientIdAliasEnabled() bool { if o == nil || isNil(o.ClientIdAliasEnabled) { @@ -829,70 +742,6 @@ func (o *Service) SetAuthenticationCallbackApiSecret(v string) { o.AuthenticationCallbackApiSecret = &v } -// GetSupportedSnses returns the SupportedSnses field value if set, zero value otherwise. -func (o *Service) GetSupportedSnses() []Sns { - if o == nil || isNil(o.SupportedSnses) { - var ret []Sns - return ret - } - return o.SupportedSnses -} - -// GetSupportedSnsesOk returns a tuple with the SupportedSnses field value if set, nil otherwise -// and a boolean to check if the value has been set. -func (o *Service) GetSupportedSnsesOk() ([]Sns, bool) { - if o == nil || isNil(o.SupportedSnses) { - return nil, false - } - return o.SupportedSnses, true -} - -// HasSupportedSnses returns a boolean if a field has been set. -func (o *Service) HasSupportedSnses() bool { - if o != nil && !isNil(o.SupportedSnses) { - return true - } - - return false -} - -// SetSupportedSnses gets a reference to the given []Sns and assigns it to the SupportedSnses field. -func (o *Service) SetSupportedSnses(v []Sns) { - o.SupportedSnses = v -} - -// GetSnsCredentials returns the SnsCredentials field value if set, zero value otherwise. -func (o *Service) GetSnsCredentials() []SnsCredentials { - if o == nil || isNil(o.SnsCredentials) { - var ret []SnsCredentials - return ret - } - return o.SnsCredentials -} - -// GetSnsCredentialsOk returns a tuple with the SnsCredentials field value if set, nil otherwise -// and a boolean to check if the value has been set. -func (o *Service) GetSnsCredentialsOk() ([]SnsCredentials, bool) { - if o == nil || isNil(o.SnsCredentials) { - return nil, false - } - return o.SnsCredentials, true -} - -// HasSnsCredentials returns a boolean if a field has been set. -func (o *Service) HasSnsCredentials() bool { - if o != nil && !isNil(o.SnsCredentials) { - return true - } - - return false -} - -// SetSnsCredentials gets a reference to the given []SnsCredentials and assigns it to the SnsCredentials field. -func (o *Service) SetSnsCredentials(v []SnsCredentials) { - o.SnsCredentials = v -} - // GetSupportedAcrs returns the SupportedAcrs field value if set, zero value otherwise. func (o *Service) GetSupportedAcrs() []string { if o == nil || isNil(o.SupportedAcrs) { @@ -925,166 +774,6 @@ func (o *Service) SetSupportedAcrs(v []string) { o.SupportedAcrs = v } -// GetDeveloperAuthenticationCallbackEndpoint returns the DeveloperAuthenticationCallbackEndpoint field value if set, zero value otherwise. -func (o *Service) GetDeveloperAuthenticationCallbackEndpoint() string { - if o == nil || isNil(o.DeveloperAuthenticationCallbackEndpoint) { - var ret string - return ret - } - return *o.DeveloperAuthenticationCallbackEndpoint -} - -// GetDeveloperAuthenticationCallbackEndpointOk returns a tuple with the DeveloperAuthenticationCallbackEndpoint field value if set, nil otherwise -// and a boolean to check if the value has been set. -func (o *Service) GetDeveloperAuthenticationCallbackEndpointOk() (*string, bool) { - if o == nil || isNil(o.DeveloperAuthenticationCallbackEndpoint) { - return nil, false - } - return o.DeveloperAuthenticationCallbackEndpoint, true -} - -// HasDeveloperAuthenticationCallbackEndpoint returns a boolean if a field has been set. -func (o *Service) HasDeveloperAuthenticationCallbackEndpoint() bool { - if o != nil && !isNil(o.DeveloperAuthenticationCallbackEndpoint) { - return true - } - - return false -} - -// SetDeveloperAuthenticationCallbackEndpoint gets a reference to the given string and assigns it to the DeveloperAuthenticationCallbackEndpoint field. -func (o *Service) SetDeveloperAuthenticationCallbackEndpoint(v string) { - o.DeveloperAuthenticationCallbackEndpoint = &v -} - -// GetDeveloperAuthenticationCallbackApiKey returns the DeveloperAuthenticationCallbackApiKey field value if set, zero value otherwise. -func (o *Service) GetDeveloperAuthenticationCallbackApiKey() string { - if o == nil || isNil(o.DeveloperAuthenticationCallbackApiKey) { - var ret string - return ret - } - return *o.DeveloperAuthenticationCallbackApiKey -} - -// GetDeveloperAuthenticationCallbackApiKeyOk returns a tuple with the DeveloperAuthenticationCallbackApiKey field value if set, nil otherwise -// and a boolean to check if the value has been set. -func (o *Service) GetDeveloperAuthenticationCallbackApiKeyOk() (*string, bool) { - if o == nil || isNil(o.DeveloperAuthenticationCallbackApiKey) { - return nil, false - } - return o.DeveloperAuthenticationCallbackApiKey, true -} - -// HasDeveloperAuthenticationCallbackApiKey returns a boolean if a field has been set. -func (o *Service) HasDeveloperAuthenticationCallbackApiKey() bool { - if o != nil && !isNil(o.DeveloperAuthenticationCallbackApiKey) { - return true - } - - return false -} - -// SetDeveloperAuthenticationCallbackApiKey gets a reference to the given string and assigns it to the DeveloperAuthenticationCallbackApiKey field. -func (o *Service) SetDeveloperAuthenticationCallbackApiKey(v string) { - o.DeveloperAuthenticationCallbackApiKey = &v -} - -// GetDeveloperAuthenticationCallbackApiSecret returns the DeveloperAuthenticationCallbackApiSecret field value if set, zero value otherwise. -func (o *Service) GetDeveloperAuthenticationCallbackApiSecret() string { - if o == nil || isNil(o.DeveloperAuthenticationCallbackApiSecret) { - var ret string - return ret - } - return *o.DeveloperAuthenticationCallbackApiSecret -} - -// GetDeveloperAuthenticationCallbackApiSecretOk returns a tuple with the DeveloperAuthenticationCallbackApiSecret field value if set, nil otherwise -// and a boolean to check if the value has been set. -func (o *Service) GetDeveloperAuthenticationCallbackApiSecretOk() (*string, bool) { - if o == nil || isNil(o.DeveloperAuthenticationCallbackApiSecret) { - return nil, false - } - return o.DeveloperAuthenticationCallbackApiSecret, true -} - -// HasDeveloperAuthenticationCallbackApiSecret returns a boolean if a field has been set. -func (o *Service) HasDeveloperAuthenticationCallbackApiSecret() bool { - if o != nil && !isNil(o.DeveloperAuthenticationCallbackApiSecret) { - return true - } - - return false -} - -// SetDeveloperAuthenticationCallbackApiSecret gets a reference to the given string and assigns it to the DeveloperAuthenticationCallbackApiSecret field. -func (o *Service) SetDeveloperAuthenticationCallbackApiSecret(v string) { - o.DeveloperAuthenticationCallbackApiSecret = &v -} - -// GetSupportedDeveloperSnses returns the SupportedDeveloperSnses field value if set, zero value otherwise. -func (o *Service) GetSupportedDeveloperSnses() []Sns { - if o == nil || isNil(o.SupportedDeveloperSnses) { - var ret []Sns - return ret - } - return o.SupportedDeveloperSnses -} - -// GetSupportedDeveloperSnsesOk returns a tuple with the SupportedDeveloperSnses field value if set, nil otherwise -// and a boolean to check if the value has been set. -func (o *Service) GetSupportedDeveloperSnsesOk() ([]Sns, bool) { - if o == nil || isNil(o.SupportedDeveloperSnses) { - return nil, false - } - return o.SupportedDeveloperSnses, true -} - -// HasSupportedDeveloperSnses returns a boolean if a field has been set. -func (o *Service) HasSupportedDeveloperSnses() bool { - if o != nil && !isNil(o.SupportedDeveloperSnses) { - return true - } - - return false -} - -// SetSupportedDeveloperSnses gets a reference to the given []Sns and assigns it to the SupportedDeveloperSnses field. -func (o *Service) SetSupportedDeveloperSnses(v []Sns) { - o.SupportedDeveloperSnses = v -} - -// GetDeveloperSnsCredentials returns the DeveloperSnsCredentials field value if set, zero value otherwise. -func (o *Service) GetDeveloperSnsCredentials() []SnsCredentials { - if o == nil || isNil(o.DeveloperSnsCredentials) { - var ret []SnsCredentials - return ret - } - return o.DeveloperSnsCredentials -} - -// GetDeveloperSnsCredentialsOk returns a tuple with the DeveloperSnsCredentials field value if set, nil otherwise -// and a boolean to check if the value has been set. -func (o *Service) GetDeveloperSnsCredentialsOk() ([]SnsCredentials, bool) { - if o == nil || isNil(o.DeveloperSnsCredentials) { - return nil, false - } - return o.DeveloperSnsCredentials, true -} - -// HasDeveloperSnsCredentials returns a boolean if a field has been set. -func (o *Service) HasDeveloperSnsCredentials() bool { - if o != nil && !isNil(o.DeveloperSnsCredentials) { - return true - } - - return false -} - -// SetDeveloperSnsCredentials gets a reference to the given []SnsCredentials and assigns it to the DeveloperSnsCredentials field. -func (o *Service) SetDeveloperSnsCredentials(v []SnsCredentials) { - o.DeveloperSnsCredentials = v -} - // GetSupportedGrantTypes returns the SupportedGrantTypes field value if set, zero value otherwise. func (o *Service) GetSupportedGrantTypes() []GrantType { if o == nil || isNil(o.SupportedGrantTypes) { @@ -5287,6 +4976,294 @@ func (o *Service) SetRsResponseSigned(v bool) { o.RsResponseSigned = &v } +// GetCnonceDuration returns the CnonceDuration field value if set, zero value otherwise. +func (o *Service) GetCnonceDuration() int64 { + if o == nil || isNil(o.CnonceDuration) { + var ret int64 + return ret + } + return *o.CnonceDuration +} + +// GetCnonceDurationOk returns a tuple with the CnonceDuration field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *Service) GetCnonceDurationOk() (*int64, bool) { + if o == nil || isNil(o.CnonceDuration) { + return nil, false + } + return o.CnonceDuration, true +} + +// HasCnonceDuration returns a boolean if a field has been set. +func (o *Service) HasCnonceDuration() bool { + if o != nil && !isNil(o.CnonceDuration) { + return true + } + + return false +} + +// SetCnonceDuration gets a reference to the given int64 and assigns it to the CnonceDuration field. +func (o *Service) SetCnonceDuration(v int64) { + o.CnonceDuration = &v +} + +// GetDpopNonceRequired returns the DpopNonceRequired field value if set, zero value otherwise. +func (o *Service) GetDpopNonceRequired() bool { + if o == nil || isNil(o.DpopNonceRequired) { + var ret bool + return ret + } + return *o.DpopNonceRequired +} + +// GetDpopNonceRequiredOk returns a tuple with the DpopNonceRequired field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *Service) GetDpopNonceRequiredOk() (*bool, bool) { + if o == nil || isNil(o.DpopNonceRequired) { + return nil, false + } + return o.DpopNonceRequired, true +} + +// HasDpopNonceRequired returns a boolean if a field has been set. +func (o *Service) HasDpopNonceRequired() bool { + if o != nil && !isNil(o.DpopNonceRequired) { + return true + } + + return false +} + +// SetDpopNonceRequired gets a reference to the given bool and assigns it to the DpopNonceRequired field. +func (o *Service) SetDpopNonceRequired(v bool) { + o.DpopNonceRequired = &v +} + +// GetVerifiableCredentialsEnabled returns the VerifiableCredentialsEnabled field value if set, zero value otherwise. +func (o *Service) GetVerifiableCredentialsEnabled() bool { + if o == nil || isNil(o.VerifiableCredentialsEnabled) { + var ret bool + return ret + } + return *o.VerifiableCredentialsEnabled +} + +// GetVerifiableCredentialsEnabledOk returns a tuple with the VerifiableCredentialsEnabled field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *Service) GetVerifiableCredentialsEnabledOk() (*bool, bool) { + if o == nil || isNil(o.VerifiableCredentialsEnabled) { + return nil, false + } + return o.VerifiableCredentialsEnabled, true +} + +// HasVerifiableCredentialsEnabled returns a boolean if a field has been set. +func (o *Service) HasVerifiableCredentialsEnabled() bool { + if o != nil && !isNil(o.VerifiableCredentialsEnabled) { + return true + } + + return false +} + +// SetVerifiableCredentialsEnabled gets a reference to the given bool and assigns it to the VerifiableCredentialsEnabled field. +func (o *Service) SetVerifiableCredentialsEnabled(v bool) { + o.VerifiableCredentialsEnabled = &v +} + +// GetCredentialJwksUri returns the CredentialJwksUri field value if set, zero value otherwise. +func (o *Service) GetCredentialJwksUri() string { + if o == nil || isNil(o.CredentialJwksUri) { + var ret string + return ret + } + return *o.CredentialJwksUri +} + +// GetCredentialJwksUriOk returns a tuple with the CredentialJwksUri field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *Service) GetCredentialJwksUriOk() (*string, bool) { + if o == nil || isNil(o.CredentialJwksUri) { + return nil, false + } + return o.CredentialJwksUri, true +} + +// HasCredentialJwksUri returns a boolean if a field has been set. +func (o *Service) HasCredentialJwksUri() bool { + if o != nil && !isNil(o.CredentialJwksUri) { + return true + } + + return false +} + +// SetCredentialJwksUri gets a reference to the given string and assigns it to the CredentialJwksUri field. +func (o *Service) SetCredentialJwksUri(v string) { + o.CredentialJwksUri = &v +} + +// GetCredentialOfferDuration returns the CredentialOfferDuration field value if set, zero value otherwise. +func (o *Service) GetCredentialOfferDuration() int64 { + if o == nil || isNil(o.CredentialOfferDuration) { + var ret int64 + return ret + } + return *o.CredentialOfferDuration +} + +// GetCredentialOfferDurationOk returns a tuple with the CredentialOfferDuration field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *Service) GetCredentialOfferDurationOk() (*int64, bool) { + if o == nil || isNil(o.CredentialOfferDuration) { + return nil, false + } + return o.CredentialOfferDuration, true +} + +// HasCredentialOfferDuration returns a boolean if a field has been set. +func (o *Service) HasCredentialOfferDuration() bool { + if o != nil && !isNil(o.CredentialOfferDuration) { + return true + } + + return false +} + +// SetCredentialOfferDuration gets a reference to the given int64 and assigns it to the CredentialOfferDuration field. +func (o *Service) SetCredentialOfferDuration(v int64) { + o.CredentialOfferDuration = &v +} + +// GetDpopNonceDuration returns the DpopNonceDuration field value if set, zero value otherwise. +func (o *Service) GetDpopNonceDuration() int64 { + if o == nil || isNil(o.DpopNonceDuration) { + var ret int64 + return ret + } + return *o.DpopNonceDuration +} + +// GetDpopNonceDurationOk returns a tuple with the DpopNonceDuration field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *Service) GetDpopNonceDurationOk() (*int64, bool) { + if o == nil || isNil(o.DpopNonceDuration) { + return nil, false + } + return o.DpopNonceDuration, true +} + +// HasDpopNonceDuration returns a boolean if a field has been set. +func (o *Service) HasDpopNonceDuration() bool { + if o != nil && !isNil(o.DpopNonceDuration) { + return true + } + + return false +} + +// SetDpopNonceDuration gets a reference to the given int64 and assigns it to the DpopNonceDuration field. +func (o *Service) SetDpopNonceDuration(v int64) { + o.DpopNonceDuration = &v +} + +// GetPreAuthorizedGrantAnonymousAccessSupported returns the PreAuthorizedGrantAnonymousAccessSupported field value if set, zero value otherwise. +func (o *Service) GetPreAuthorizedGrantAnonymousAccessSupported() bool { + if o == nil || isNil(o.PreAuthorizedGrantAnonymousAccessSupported) { + var ret bool + return ret + } + return *o.PreAuthorizedGrantAnonymousAccessSupported +} + +// GetPreAuthorizedGrantAnonymousAccessSupportedOk returns a tuple with the PreAuthorizedGrantAnonymousAccessSupported field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *Service) GetPreAuthorizedGrantAnonymousAccessSupportedOk() (*bool, bool) { + if o == nil || isNil(o.PreAuthorizedGrantAnonymousAccessSupported) { + return nil, false + } + return o.PreAuthorizedGrantAnonymousAccessSupported, true +} + +// HasPreAuthorizedGrantAnonymousAccessSupported returns a boolean if a field has been set. +func (o *Service) HasPreAuthorizedGrantAnonymousAccessSupported() bool { + if o != nil && !isNil(o.PreAuthorizedGrantAnonymousAccessSupported) { + return true + } + + return false +} + +// SetPreAuthorizedGrantAnonymousAccessSupported gets a reference to the given bool and assigns it to the PreAuthorizedGrantAnonymousAccessSupported field. +func (o *Service) SetPreAuthorizedGrantAnonymousAccessSupported(v bool) { + o.PreAuthorizedGrantAnonymousAccessSupported = &v +} + +// GetCredentialTransactionDuration returns the CredentialTransactionDuration field value if set, zero value otherwise. +func (o *Service) GetCredentialTransactionDuration() int64 { + if o == nil || isNil(o.CredentialTransactionDuration) { + var ret int64 + return ret + } + return *o.CredentialTransactionDuration +} + +// GetCredentialTransactionDurationOk returns a tuple with the CredentialTransactionDuration field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *Service) GetCredentialTransactionDurationOk() (*int64, bool) { + if o == nil || isNil(o.CredentialTransactionDuration) { + return nil, false + } + return o.CredentialTransactionDuration, true +} + +// HasCredentialTransactionDuration returns a boolean if a field has been set. +func (o *Service) HasCredentialTransactionDuration() bool { + if o != nil && !isNil(o.CredentialTransactionDuration) { + return true + } + + return false +} + +// SetCredentialTransactionDuration gets a reference to the given int64 and assigns it to the CredentialTransactionDuration field. +func (o *Service) SetCredentialTransactionDuration(v int64) { + o.CredentialTransactionDuration = &v +} + +// GetIntrospectionSignatureKeyId returns the IntrospectionSignatureKeyId field value if set, zero value otherwise. +func (o *Service) GetIntrospectionSignatureKeyId() string { + if o == nil || isNil(o.IntrospectionSignatureKeyId) { + var ret string + return ret + } + return *o.IntrospectionSignatureKeyId +} + +// GetIntrospectionSignatureKeyIdOk returns a tuple with the IntrospectionSignatureKeyId field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *Service) GetIntrospectionSignatureKeyIdOk() (*string, bool) { + if o == nil || isNil(o.IntrospectionSignatureKeyId) { + return nil, false + } + return o.IntrospectionSignatureKeyId, true +} + +// HasIntrospectionSignatureKeyId returns a boolean if a field has been set. +func (o *Service) HasIntrospectionSignatureKeyId() bool { + if o != nil && !isNil(o.IntrospectionSignatureKeyId) { + return true + } + + return false +} + +// SetIntrospectionSignatureKeyId gets a reference to the given string and assigns it to the IntrospectionSignatureKeyId field. +func (o *Service) SetIntrospectionSignatureKeyId(v string) { + o.IntrospectionSignatureKeyId = &v +} + // GetResourceSignatureKeyId returns the ResourceSignatureKeyId field value if set, zero value otherwise. func (o *Service) GetResourceSignatureKeyId() string { if o == nil || isNil(o.ResourceSignatureKeyId) { @@ -5319,36 +5296,68 @@ func (o *Service) SetResourceSignatureKeyId(v string) { o.ResourceSignatureKeyId = &v } -// GetIdTokenAudType returns the IdTokenAudType field value if set, zero value otherwise. -func (o *Service) GetIdTokenAudType() string { - if o == nil || isNil(o.IdTokenAudType) { - var ret string +// GetUserPinLength returns the UserPinLength field value if set, zero value otherwise. +func (o *Service) GetUserPinLength() int32 { + if o == nil || isNil(o.UserPinLength) { + var ret int32 return ret } - return *o.IdTokenAudType + return *o.UserPinLength } -// GetIdTokenAudTypeOk returns a tuple with the IdTokenAudType field value if set, nil otherwise +// GetUserPinLengthOk returns a tuple with the UserPinLength field value if set, nil otherwise // and a boolean to check if the value has been set. -func (o *Service) GetIdTokenAudTypeOk() (*string, bool) { - if o == nil || isNil(o.IdTokenAudType) { +func (o *Service) GetUserPinLengthOk() (*int32, bool) { + if o == nil || isNil(o.UserPinLength) { return nil, false } - return o.IdTokenAudType, true + return o.UserPinLength, true } -// HasIdTokenAudType returns a boolean if a field has been set. -func (o *Service) HasIdTokenAudType() bool { - if o != nil && !isNil(o.IdTokenAudType) { +// HasUserPinLength returns a boolean if a field has been set. +func (o *Service) HasUserPinLength() bool { + if o != nil && !isNil(o.UserPinLength) { return true } return false } -// SetIdTokenAudType gets a reference to the given string and assigns it to the IdTokenAudType field. -func (o *Service) SetIdTokenAudType(v string) { - o.IdTokenAudType = &v +// SetUserPinLength gets a reference to the given int32 and assigns it to the UserPinLength field. +func (o *Service) SetUserPinLength(v int32) { + o.UserPinLength = &v +} + +// GetSupportedPromptValues returns the SupportedPromptValues field value if set, zero value otherwise. +func (o *Service) GetSupportedPromptValues() []Prompt { + if o == nil || isNil(o.SupportedPromptValues) { + var ret []Prompt + return ret + } + return o.SupportedPromptValues +} + +// GetSupportedPromptValuesOk returns a tuple with the SupportedPromptValues field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *Service) GetSupportedPromptValuesOk() ([]Prompt, bool) { + if o == nil || isNil(o.SupportedPromptValues) { + return nil, false + } + return o.SupportedPromptValues, true +} + +// HasSupportedPromptValues returns a boolean if a field has been set. +func (o *Service) HasSupportedPromptValues() bool { + if o != nil && !isNil(o.SupportedPromptValues) { + return true + } + + return false +} + +// SetSupportedPromptValues gets a reference to the given []Prompt and assigns it to the SupportedPromptValues field. +func (o *Service) SetSupportedPromptValues(v []Prompt) { + o.SupportedPromptValues = v } // GetIdTokenReissuable returns the IdTokenReissuable field value if set, zero value otherwise. @@ -5383,6 +5392,166 @@ func (o *Service) SetIdTokenReissuable(v bool) { o.IdTokenReissuable = &v } +// GetCredentialJwks returns the CredentialJwks field value if set, zero value otherwise. +func (o *Service) GetCredentialJwks() string { + if o == nil || isNil(o.CredentialJwks) { + var ret string + return ret + } + return *o.CredentialJwks +} + +// GetCredentialJwksOk returns a tuple with the CredentialJwks field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *Service) GetCredentialJwksOk() (*string, bool) { + if o == nil || isNil(o.CredentialJwks) { + return nil, false + } + return o.CredentialJwks, true +} + +// HasCredentialJwks returns a boolean if a field has been set. +func (o *Service) HasCredentialJwks() bool { + if o != nil && !isNil(o.CredentialJwks) { + return true + } + + return false +} + +// SetCredentialJwks gets a reference to the given string and assigns it to the CredentialJwks field. +func (o *Service) SetCredentialJwks(v string) { + o.CredentialJwks = &v +} + +// GetFapiModes returns the FapiModes field value if set, zero value otherwise. +func (o *Service) GetFapiModes() []FapiMode { + if o == nil || isNil(o.FapiModes) { + var ret []FapiMode + return ret + } + return o.FapiModes +} + +// GetFapiModesOk returns a tuple with the FapiModes field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *Service) GetFapiModesOk() ([]FapiMode, bool) { + if o == nil || isNil(o.FapiModes) { + return nil, false + } + return o.FapiModes, true +} + +// HasFapiModes returns a boolean if a field has been set. +func (o *Service) HasFapiModes() bool { + if o != nil && !isNil(o.FapiModes) { + return true + } + + return false +} + +// SetFapiModes gets a reference to the given []FapiMode and assigns it to the FapiModes field. +func (o *Service) SetFapiModes(v []FapiMode) { + o.FapiModes = v +} + +// GetCredentialDuration returns the CredentialDuration field value if set, zero value otherwise. +func (o *Service) GetCredentialDuration() int64 { + if o == nil || isNil(o.CredentialDuration) { + var ret int64 + return ret + } + return *o.CredentialDuration +} + +// GetCredentialDurationOk returns a tuple with the CredentialDuration field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *Service) GetCredentialDurationOk() (*int64, bool) { + if o == nil || isNil(o.CredentialDuration) { + return nil, false + } + return o.CredentialDuration, true +} + +// HasCredentialDuration returns a boolean if a field has been set. +func (o *Service) HasCredentialDuration() bool { + if o != nil && !isNil(o.CredentialDuration) { + return true + } + + return false +} + +// SetCredentialDuration gets a reference to the given int64 and assigns it to the CredentialDuration field. +func (o *Service) SetCredentialDuration(v int64) { + o.CredentialDuration = &v +} + +// GetCredentialIssuerMetadata returns the CredentialIssuerMetadata field value if set, zero value otherwise. +func (o *Service) GetCredentialIssuerMetadata() CredentialIssuerMetadata { + if o == nil || isNil(o.CredentialIssuerMetadata) { + var ret CredentialIssuerMetadata + return ret + } + return *o.CredentialIssuerMetadata +} + +// GetCredentialIssuerMetadataOk returns a tuple with the CredentialIssuerMetadata field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *Service) GetCredentialIssuerMetadataOk() (*CredentialIssuerMetadata, bool) { + if o == nil || isNil(o.CredentialIssuerMetadata) { + return nil, false + } + return o.CredentialIssuerMetadata, true +} + +// HasCredentialIssuerMetadata returns a boolean if a field has been set. +func (o *Service) HasCredentialIssuerMetadata() bool { + if o != nil && !isNil(o.CredentialIssuerMetadata) { + return true + } + + return false +} + +// SetCredentialIssuerMetadata gets a reference to the given CredentialIssuerMetadata and assigns it to the CredentialIssuerMetadata field. +func (o *Service) SetCredentialIssuerMetadata(v CredentialIssuerMetadata) { + o.CredentialIssuerMetadata = &v +} + +// GetIdTokenAudType returns the IdTokenAudType field value if set, zero value otherwise. +func (o *Service) GetIdTokenAudType() string { + if o == nil || isNil(o.IdTokenAudType) { + var ret string + return ret + } + return *o.IdTokenAudType +} + +// GetIdTokenAudTypeOk returns a tuple with the IdTokenAudType field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *Service) GetIdTokenAudTypeOk() (*string, bool) { + if o == nil || isNil(o.IdTokenAudType) { + return nil, false + } + return o.IdTokenAudType, true +} + +// HasIdTokenAudType returns a boolean if a field has been set. +func (o *Service) HasIdTokenAudType() bool { + if o != nil && !isNil(o.IdTokenAudType) { + return true + } + + return false +} + +// SetIdTokenAudType gets a reference to the given string and assigns it to the IdTokenAudType field. +func (o *Service) SetIdTokenAudType(v string) { + o.IdTokenAudType = &v +} + func (o Service) MarshalJSON() ([]byte, error) { toSerialize,err := o.ToMap() if err != nil { @@ -5396,9 +5565,6 @@ func (o Service) ToMap() (map[string]interface{}, error) { if !isNil(o.Number) { toSerialize["number"] = o.Number } - if !isNil(o.ServiceOwnerNumber) { - toSerialize["serviceOwnerNumber"] = o.ServiceOwnerNumber - } if !isNil(o.ServiceName) { toSerialize["serviceName"] = o.ServiceName } @@ -5411,12 +5577,6 @@ func (o Service) ToMap() (map[string]interface{}, error) { if !isNil(o.ApiKey) { toSerialize["apiKey"] = o.ApiKey } - if !isNil(o.ApiSecret) { - toSerialize["apiSecret"] = o.ApiSecret - } - if !isNil(o.ClientsPerDeveloper) { - toSerialize["clientsPerDeveloper"] = o.ClientsPerDeveloper - } if !isNil(o.ClientIdAliasEnabled) { toSerialize["clientIdAliasEnabled"] = o.ClientIdAliasEnabled } @@ -5438,30 +5598,9 @@ func (o Service) ToMap() (map[string]interface{}, error) { if !isNil(o.AuthenticationCallbackApiSecret) { toSerialize["authenticationCallbackApiSecret"] = o.AuthenticationCallbackApiSecret } - if !isNil(o.SupportedSnses) { - toSerialize["supportedSnses"] = o.SupportedSnses - } - if !isNil(o.SnsCredentials) { - toSerialize["snsCredentials"] = o.SnsCredentials - } if !isNil(o.SupportedAcrs) { toSerialize["supportedAcrs"] = o.SupportedAcrs } - if !isNil(o.DeveloperAuthenticationCallbackEndpoint) { - toSerialize["developerAuthenticationCallbackEndpoint"] = o.DeveloperAuthenticationCallbackEndpoint - } - if !isNil(o.DeveloperAuthenticationCallbackApiKey) { - toSerialize["developerAuthenticationCallbackApiKey"] = o.DeveloperAuthenticationCallbackApiKey - } - if !isNil(o.DeveloperAuthenticationCallbackApiSecret) { - toSerialize["developerAuthenticationCallbackApiSecret"] = o.DeveloperAuthenticationCallbackApiSecret - } - if !isNil(o.SupportedDeveloperSnses) { - toSerialize["supportedDeveloperSnses"] = o.SupportedDeveloperSnses - } - if !isNil(o.DeveloperSnsCredentials) { - toSerialize["developerSnsCredentials"] = o.DeveloperSnsCredentials - } if !isNil(o.SupportedGrantTypes) { toSerialize["supportedGrantTypes"] = o.SupportedGrantTypes } @@ -5855,15 +5994,60 @@ func (o Service) ToMap() (map[string]interface{}, error) { if !isNil(o.RsResponseSigned) { toSerialize["rsResponseSigned"] = o.RsResponseSigned } + if !isNil(o.CnonceDuration) { + toSerialize["cnonceDuration"] = o.CnonceDuration + } + if !isNil(o.DpopNonceRequired) { + toSerialize["dpopNonceRequired"] = o.DpopNonceRequired + } + if !isNil(o.VerifiableCredentialsEnabled) { + toSerialize["verifiableCredentialsEnabled"] = o.VerifiableCredentialsEnabled + } + if !isNil(o.CredentialJwksUri) { + toSerialize["credentialJwksUri"] = o.CredentialJwksUri + } + if !isNil(o.CredentialOfferDuration) { + toSerialize["credentialOfferDuration"] = o.CredentialOfferDuration + } + if !isNil(o.DpopNonceDuration) { + toSerialize["dpopNonceDuration"] = o.DpopNonceDuration + } + if !isNil(o.PreAuthorizedGrantAnonymousAccessSupported) { + toSerialize["preAuthorizedGrantAnonymousAccessSupported"] = o.PreAuthorizedGrantAnonymousAccessSupported + } + if !isNil(o.CredentialTransactionDuration) { + toSerialize["credentialTransactionDuration"] = o.CredentialTransactionDuration + } + if !isNil(o.IntrospectionSignatureKeyId) { + toSerialize["introspectionSignatureKeyId"] = o.IntrospectionSignatureKeyId + } if !isNil(o.ResourceSignatureKeyId) { toSerialize["resourceSignatureKeyId"] = o.ResourceSignatureKeyId } - if !isNil(o.IdTokenAudType) { - toSerialize["idTokenAudType"] = o.IdTokenAudType + if !isNil(o.UserPinLength) { + toSerialize["userPinLength"] = o.UserPinLength + } + if !isNil(o.SupportedPromptValues) { + toSerialize["supportedPromptValues"] = o.SupportedPromptValues } if !isNil(o.IdTokenReissuable) { toSerialize["idTokenReissuable"] = o.IdTokenReissuable } + if !isNil(o.CredentialJwks) { + toSerialize["credentialJwks"] = o.CredentialJwks + } + if !isNil(o.FapiModes) { + toSerialize["fapiModes"] = o.FapiModes + } + if !isNil(o.CredentialDuration) { + toSerialize["credentialDuration"] = o.CredentialDuration + } + if !isNil(o.CredentialIssuerMetadata) { + toSerialize["credentialIssuerMetadata"] = o.CredentialIssuerMetadata + } + if !isNil(o.IdTokenAudType) { + toSerialize["idTokenAudType"] = o.IdTokenAudType + } return toSerialize, nil } diff --git a/model_service_get_api_200_response.go b/model_service_get_api_200_response.go new file mode 100644 index 0000000..9f21a9c --- /dev/null +++ b/model_service_get_api_200_response.go @@ -0,0 +1,148 @@ +/* +Authlete API + +Authlete API Document. + +API version: 3.0.0 +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package authlete + +import ( + "encoding/json" + "fmt" +) + +// ServiceGetApi200Response - struct for ServiceGetApi200Response +type ServiceGetApi200Response struct { + Service *Service + ServiceLimited *ServiceLimited +} + +// ServiceAsServiceGetApi200Response is a convenience function that returns Service wrapped in ServiceGetApi200Response +func ServiceAsServiceGetApi200Response(v *Service) ServiceGetApi200Response { + return ServiceGetApi200Response{ + Service: v, + } +} + +// ServiceLimitedAsServiceGetApi200Response is a convenience function that returns ServiceLimited wrapped in ServiceGetApi200Response +func ServiceLimitedAsServiceGetApi200Response(v *ServiceLimited) ServiceGetApi200Response { + return ServiceGetApi200Response{ + ServiceLimited: v, + } +} + + +// Unmarshal JSON data into one of the pointers in the struct +func (dst *ServiceGetApi200Response) UnmarshalJSON(data []byte) error { + var err error + match := 0 + // try to unmarshal data into Service + err = json.Unmarshal(data, &dst.Service) + if err == nil { + jsonService, _ := json.Marshal(dst.Service) + if string(jsonService) == "{}" { // empty struct + dst.Service = nil + } else { + match++ + } + } else { + dst.Service = nil + } + + // try to unmarshal data into ServiceLimited + err = json.Unmarshal(data, &dst.ServiceLimited) + if err == nil { + jsonServiceLimited, _ := json.Marshal(dst.ServiceLimited) + if string(jsonServiceLimited) == "{}" { // empty struct + dst.ServiceLimited = nil + } else { + match++ + } + } else { + dst.ServiceLimited = nil + } + + if match > 1 { // more than 1 match + // reset to nil + dst.Service = nil + dst.ServiceLimited = nil + + return fmt.Errorf("data matches more than one schema in oneOf(ServiceGetApi200Response)") + } else if match == 1 { + return nil // exactly one match + } else { // no match + return fmt.Errorf("data failed to match schemas in oneOf(ServiceGetApi200Response)") + } +} + +// Marshal data from the first non-nil pointers in the struct to JSON +func (src ServiceGetApi200Response) MarshalJSON() ([]byte, error) { + if src.Service != nil { + return json.Marshal(&src.Service) + } + + if src.ServiceLimited != nil { + return json.Marshal(&src.ServiceLimited) + } + + return nil, nil // no data in oneOf schemas +} + +// Get the actual instance +func (obj *ServiceGetApi200Response) GetActualInstance() (interface{}) { + if obj == nil { + return nil + } + if obj.Service != nil { + return obj.Service + } + + if obj.ServiceLimited != nil { + return obj.ServiceLimited + } + + // all schemas are nil + return nil +} + +type NullableServiceGetApi200Response struct { + value *ServiceGetApi200Response + isSet bool +} + +func (v NullableServiceGetApi200Response) Get() *ServiceGetApi200Response { + return v.value +} + +func (v *NullableServiceGetApi200Response) Set(val *ServiceGetApi200Response) { + v.value = val + v.isSet = true +} + +func (v NullableServiceGetApi200Response) IsSet() bool { + return v.isSet +} + +func (v *NullableServiceGetApi200Response) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableServiceGetApi200Response(val *ServiceGetApi200Response) *NullableServiceGetApi200Response { + return &NullableServiceGetApi200Response{value: val, isSet: true} +} + +func (v NullableServiceGetApi200Response) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableServiceGetApi200Response) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/model_service_get_list_api_200_response.go b/model_service_get_list_api_200_response.go new file mode 100644 index 0000000..1a8a907 --- /dev/null +++ b/model_service_get_list_api_200_response.go @@ -0,0 +1,148 @@ +/* +Authlete API + +Authlete API Document. + +API version: 3.0.0 +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package authlete + +import ( + "encoding/json" + "fmt" +) + +// ServiceGetListApi200Response - struct for ServiceGetListApi200Response +type ServiceGetListApi200Response struct { + ServiceGetListLimitedResponse *ServiceGetListLimitedResponse + ServiceGetListResponse *ServiceGetListResponse +} + +// ServiceGetListLimitedResponseAsServiceGetListApi200Response is a convenience function that returns ServiceGetListLimitedResponse wrapped in ServiceGetListApi200Response +func ServiceGetListLimitedResponseAsServiceGetListApi200Response(v *ServiceGetListLimitedResponse) ServiceGetListApi200Response { + return ServiceGetListApi200Response{ + ServiceGetListLimitedResponse: v, + } +} + +// ServiceGetListResponseAsServiceGetListApi200Response is a convenience function that returns ServiceGetListResponse wrapped in ServiceGetListApi200Response +func ServiceGetListResponseAsServiceGetListApi200Response(v *ServiceGetListResponse) ServiceGetListApi200Response { + return ServiceGetListApi200Response{ + ServiceGetListResponse: v, + } +} + + +// Unmarshal JSON data into one of the pointers in the struct +func (dst *ServiceGetListApi200Response) UnmarshalJSON(data []byte) error { + var err error + match := 0 + // try to unmarshal data into ServiceGetListLimitedResponse + err = json.Unmarshal(data, &dst.ServiceGetListLimitedResponse) + if err == nil { + jsonServiceGetListLimitedResponse, _ := json.Marshal(dst.ServiceGetListLimitedResponse) + if string(jsonServiceGetListLimitedResponse) == "{}" { // empty struct + dst.ServiceGetListLimitedResponse = nil + } else { + match++ + } + } else { + dst.ServiceGetListLimitedResponse = nil + } + + // try to unmarshal data into ServiceGetListResponse + err = json.Unmarshal(data, &dst.ServiceGetListResponse) + if err == nil { + jsonServiceGetListResponse, _ := json.Marshal(dst.ServiceGetListResponse) + if string(jsonServiceGetListResponse) == "{}" { // empty struct + dst.ServiceGetListResponse = nil + } else { + match++ + } + } else { + dst.ServiceGetListResponse = nil + } + + if match > 1 { // more than 1 match + // reset to nil + dst.ServiceGetListLimitedResponse = nil + dst.ServiceGetListResponse = nil + + return fmt.Errorf("data matches more than one schema in oneOf(ServiceGetListApi200Response)") + } else if match == 1 { + return nil // exactly one match + } else { // no match + return fmt.Errorf("data failed to match schemas in oneOf(ServiceGetListApi200Response)") + } +} + +// Marshal data from the first non-nil pointers in the struct to JSON +func (src ServiceGetListApi200Response) MarshalJSON() ([]byte, error) { + if src.ServiceGetListLimitedResponse != nil { + return json.Marshal(&src.ServiceGetListLimitedResponse) + } + + if src.ServiceGetListResponse != nil { + return json.Marshal(&src.ServiceGetListResponse) + } + + return nil, nil // no data in oneOf schemas +} + +// Get the actual instance +func (obj *ServiceGetListApi200Response) GetActualInstance() (interface{}) { + if obj == nil { + return nil + } + if obj.ServiceGetListLimitedResponse != nil { + return obj.ServiceGetListLimitedResponse + } + + if obj.ServiceGetListResponse != nil { + return obj.ServiceGetListResponse + } + + // all schemas are nil + return nil +} + +type NullableServiceGetListApi200Response struct { + value *ServiceGetListApi200Response + isSet bool +} + +func (v NullableServiceGetListApi200Response) Get() *ServiceGetListApi200Response { + return v.value +} + +func (v *NullableServiceGetListApi200Response) Set(val *ServiceGetListApi200Response) { + v.value = val + v.isSet = true +} + +func (v NullableServiceGetListApi200Response) IsSet() bool { + return v.isSet +} + +func (v *NullableServiceGetListApi200Response) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableServiceGetListApi200Response(val *ServiceGetListApi200Response) *NullableServiceGetListApi200Response { + return &NullableServiceGetListApi200Response{value: val, isSet: true} +} + +func (v NullableServiceGetListApi200Response) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableServiceGetListApi200Response) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/model_service_get_list_limited_response.go b/model_service_get_list_limited_response.go new file mode 100644 index 0000000..bf89c24 --- /dev/null +++ b/model_service_get_list_limited_response.go @@ -0,0 +1,238 @@ +/* +Authlete API + +Authlete API Document. + +API version: 3.0.0 +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package authlete + +import ( + "encoding/json" +) + +// checks if the ServiceGetListLimitedResponse type satisfies the MappedNullable interface at compile time +var _ MappedNullable = &ServiceGetListLimitedResponse{} + +// ServiceGetListLimitedResponse struct for ServiceGetListLimitedResponse +type ServiceGetListLimitedResponse struct { + // Start index (inclusive) of the result set. The default value is 0. Must not be a negative number. + Start *int32 `json:"start,omitempty"` + // Start index (inclusive) of the result set. The default value is 0. Must not be a negative number. + End *int32 `json:"end,omitempty"` + // Total number of services owned by the service owner. This doesn't mean the number of services contained in the response. + TotalCount *int32 `json:"totalCount,omitempty"` + // An array of services. + Services []ServiceLimited `json:"services,omitempty"` +} + +// NewServiceGetListLimitedResponse instantiates a new ServiceGetListLimitedResponse object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewServiceGetListLimitedResponse() *ServiceGetListLimitedResponse { + this := ServiceGetListLimitedResponse{} + return &this +} + +// NewServiceGetListLimitedResponseWithDefaults instantiates a new ServiceGetListLimitedResponse object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewServiceGetListLimitedResponseWithDefaults() *ServiceGetListLimitedResponse { + this := ServiceGetListLimitedResponse{} + return &this +} + +// GetStart returns the Start field value if set, zero value otherwise. +func (o *ServiceGetListLimitedResponse) GetStart() int32 { + if o == nil || isNil(o.Start) { + var ret int32 + return ret + } + return *o.Start +} + +// GetStartOk returns a tuple with the Start field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ServiceGetListLimitedResponse) GetStartOk() (*int32, bool) { + if o == nil || isNil(o.Start) { + return nil, false + } + return o.Start, true +} + +// HasStart returns a boolean if a field has been set. +func (o *ServiceGetListLimitedResponse) HasStart() bool { + if o != nil && !isNil(o.Start) { + return true + } + + return false +} + +// SetStart gets a reference to the given int32 and assigns it to the Start field. +func (o *ServiceGetListLimitedResponse) SetStart(v int32) { + o.Start = &v +} + +// GetEnd returns the End field value if set, zero value otherwise. +func (o *ServiceGetListLimitedResponse) GetEnd() int32 { + if o == nil || isNil(o.End) { + var ret int32 + return ret + } + return *o.End +} + +// GetEndOk returns a tuple with the End field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ServiceGetListLimitedResponse) GetEndOk() (*int32, bool) { + if o == nil || isNil(o.End) { + return nil, false + } + return o.End, true +} + +// HasEnd returns a boolean if a field has been set. +func (o *ServiceGetListLimitedResponse) HasEnd() bool { + if o != nil && !isNil(o.End) { + return true + } + + return false +} + +// SetEnd gets a reference to the given int32 and assigns it to the End field. +func (o *ServiceGetListLimitedResponse) SetEnd(v int32) { + o.End = &v +} + +// GetTotalCount returns the TotalCount field value if set, zero value otherwise. +func (o *ServiceGetListLimitedResponse) GetTotalCount() int32 { + if o == nil || isNil(o.TotalCount) { + var ret int32 + return ret + } + return *o.TotalCount +} + +// GetTotalCountOk returns a tuple with the TotalCount field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ServiceGetListLimitedResponse) GetTotalCountOk() (*int32, bool) { + if o == nil || isNil(o.TotalCount) { + return nil, false + } + return o.TotalCount, true +} + +// HasTotalCount returns a boolean if a field has been set. +func (o *ServiceGetListLimitedResponse) HasTotalCount() bool { + if o != nil && !isNil(o.TotalCount) { + return true + } + + return false +} + +// SetTotalCount gets a reference to the given int32 and assigns it to the TotalCount field. +func (o *ServiceGetListLimitedResponse) SetTotalCount(v int32) { + o.TotalCount = &v +} + +// GetServices returns the Services field value if set, zero value otherwise. +func (o *ServiceGetListLimitedResponse) GetServices() []ServiceLimited { + if o == nil || isNil(o.Services) { + var ret []ServiceLimited + return ret + } + return o.Services +} + +// GetServicesOk returns a tuple with the Services field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ServiceGetListLimitedResponse) GetServicesOk() ([]ServiceLimited, bool) { + if o == nil || isNil(o.Services) { + return nil, false + } + return o.Services, true +} + +// HasServices returns a boolean if a field has been set. +func (o *ServiceGetListLimitedResponse) HasServices() bool { + if o != nil && !isNil(o.Services) { + return true + } + + return false +} + +// SetServices gets a reference to the given []ServiceLimited and assigns it to the Services field. +func (o *ServiceGetListLimitedResponse) SetServices(v []ServiceLimited) { + o.Services = v +} + +func (o ServiceGetListLimitedResponse) MarshalJSON() ([]byte, error) { + toSerialize,err := o.ToMap() + if err != nil { + return []byte{}, err + } + return json.Marshal(toSerialize) +} + +func (o ServiceGetListLimitedResponse) ToMap() (map[string]interface{}, error) { + toSerialize := map[string]interface{}{} + if !isNil(o.Start) { + toSerialize["start"] = o.Start + } + if !isNil(o.End) { + toSerialize["end"] = o.End + } + if !isNil(o.TotalCount) { + toSerialize["totalCount"] = o.TotalCount + } + if !isNil(o.Services) { + toSerialize["services"] = o.Services + } + return toSerialize, nil +} + +type NullableServiceGetListLimitedResponse struct { + value *ServiceGetListLimitedResponse + isSet bool +} + +func (v NullableServiceGetListLimitedResponse) Get() *ServiceGetListLimitedResponse { + return v.value +} + +func (v *NullableServiceGetListLimitedResponse) Set(val *ServiceGetListLimitedResponse) { + v.value = val + v.isSet = true +} + +func (v NullableServiceGetListLimitedResponse) IsSet() bool { + return v.isSet +} + +func (v *NullableServiceGetListLimitedResponse) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableServiceGetListLimitedResponse(val *ServiceGetListLimitedResponse) *NullableServiceGetListLimitedResponse { + return &NullableServiceGetListLimitedResponse{value: val, isSet: true} +} + +func (v NullableServiceGetListLimitedResponse) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableServiceGetListLimitedResponse) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/model_service_get_list_response.go b/model_service_get_list_response.go index 7eebd0e..ba30368 100644 --- a/model_service_get_list_response.go +++ b/model_service_get_list_response.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_service_jwks_get_response.go b/model_service_jwks_get_response.go index cf29d2f..b5510a2 100644 --- a/model_service_jwks_get_response.go +++ b/model_service_jwks_get_response.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_service_limited.go b/model_service_limited.go new file mode 100644 index 0000000..f2ecfdf --- /dev/null +++ b/model_service_limited.go @@ -0,0 +1,275 @@ +/* +Authlete API + +Authlete API Document. + +API version: 3.0.0 +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package authlete + +import ( + "encoding/json" +) + +// checks if the ServiceLimited type satisfies the MappedNullable interface at compile time +var _ MappedNullable = &ServiceLimited{} + +// ServiceLimited struct for ServiceLimited +type ServiceLimited struct { + // The sequential number of the service. The value of this property is assigned by Authlete. + Number *int32 `json:"number,omitempty"` + // The name of this service. + ServiceName *string `json:"serviceName,omitempty"` + // The description about the service. + Description *string `json:"description,omitempty"` + // The service ID used in Authlete API calls. The value of this property is assigned by Authlete. + ApiKey *int64 `json:"apiKey,omitempty"` + // Deprecated. Always `true`. + ClientIdAliasEnabled *bool `json:"clientIdAliasEnabled,omitempty"` +} + +// NewServiceLimited instantiates a new ServiceLimited object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewServiceLimited() *ServiceLimited { + this := ServiceLimited{} + return &this +} + +// NewServiceLimitedWithDefaults instantiates a new ServiceLimited object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewServiceLimitedWithDefaults() *ServiceLimited { + this := ServiceLimited{} + return &this +} + +// GetNumber returns the Number field value if set, zero value otherwise. +func (o *ServiceLimited) GetNumber() int32 { + if o == nil || isNil(o.Number) { + var ret int32 + return ret + } + return *o.Number +} + +// GetNumberOk returns a tuple with the Number field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ServiceLimited) GetNumberOk() (*int32, bool) { + if o == nil || isNil(o.Number) { + return nil, false + } + return o.Number, true +} + +// HasNumber returns a boolean if a field has been set. +func (o *ServiceLimited) HasNumber() bool { + if o != nil && !isNil(o.Number) { + return true + } + + return false +} + +// SetNumber gets a reference to the given int32 and assigns it to the Number field. +func (o *ServiceLimited) SetNumber(v int32) { + o.Number = &v +} + +// GetServiceName returns the ServiceName field value if set, zero value otherwise. +func (o *ServiceLimited) GetServiceName() string { + if o == nil || isNil(o.ServiceName) { + var ret string + return ret + } + return *o.ServiceName +} + +// GetServiceNameOk returns a tuple with the ServiceName field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ServiceLimited) GetServiceNameOk() (*string, bool) { + if o == nil || isNil(o.ServiceName) { + return nil, false + } + return o.ServiceName, true +} + +// HasServiceName returns a boolean if a field has been set. +func (o *ServiceLimited) HasServiceName() bool { + if o != nil && !isNil(o.ServiceName) { + return true + } + + return false +} + +// SetServiceName gets a reference to the given string and assigns it to the ServiceName field. +func (o *ServiceLimited) SetServiceName(v string) { + o.ServiceName = &v +} + +// GetDescription returns the Description field value if set, zero value otherwise. +func (o *ServiceLimited) GetDescription() string { + if o == nil || isNil(o.Description) { + var ret string + return ret + } + return *o.Description +} + +// GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ServiceLimited) GetDescriptionOk() (*string, bool) { + if o == nil || isNil(o.Description) { + return nil, false + } + return o.Description, true +} + +// HasDescription returns a boolean if a field has been set. +func (o *ServiceLimited) HasDescription() bool { + if o != nil && !isNil(o.Description) { + return true + } + + return false +} + +// SetDescription gets a reference to the given string and assigns it to the Description field. +func (o *ServiceLimited) SetDescription(v string) { + o.Description = &v +} + +// GetApiKey returns the ApiKey field value if set, zero value otherwise. +func (o *ServiceLimited) GetApiKey() int64 { + if o == nil || isNil(o.ApiKey) { + var ret int64 + return ret + } + return *o.ApiKey +} + +// GetApiKeyOk returns a tuple with the ApiKey field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ServiceLimited) GetApiKeyOk() (*int64, bool) { + if o == nil || isNil(o.ApiKey) { + return nil, false + } + return o.ApiKey, true +} + +// HasApiKey returns a boolean if a field has been set. +func (o *ServiceLimited) HasApiKey() bool { + if o != nil && !isNil(o.ApiKey) { + return true + } + + return false +} + +// SetApiKey gets a reference to the given int64 and assigns it to the ApiKey field. +func (o *ServiceLimited) SetApiKey(v int64) { + o.ApiKey = &v +} + +// GetClientIdAliasEnabled returns the ClientIdAliasEnabled field value if set, zero value otherwise. +func (o *ServiceLimited) GetClientIdAliasEnabled() bool { + if o == nil || isNil(o.ClientIdAliasEnabled) { + var ret bool + return ret + } + return *o.ClientIdAliasEnabled +} + +// GetClientIdAliasEnabledOk returns a tuple with the ClientIdAliasEnabled field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ServiceLimited) GetClientIdAliasEnabledOk() (*bool, bool) { + if o == nil || isNil(o.ClientIdAliasEnabled) { + return nil, false + } + return o.ClientIdAliasEnabled, true +} + +// HasClientIdAliasEnabled returns a boolean if a field has been set. +func (o *ServiceLimited) HasClientIdAliasEnabled() bool { + if o != nil && !isNil(o.ClientIdAliasEnabled) { + return true + } + + return false +} + +// SetClientIdAliasEnabled gets a reference to the given bool and assigns it to the ClientIdAliasEnabled field. +func (o *ServiceLimited) SetClientIdAliasEnabled(v bool) { + o.ClientIdAliasEnabled = &v +} + +func (o ServiceLimited) MarshalJSON() ([]byte, error) { + toSerialize,err := o.ToMap() + if err != nil { + return []byte{}, err + } + return json.Marshal(toSerialize) +} + +func (o ServiceLimited) ToMap() (map[string]interface{}, error) { + toSerialize := map[string]interface{}{} + if !isNil(o.Number) { + toSerialize["number"] = o.Number + } + if !isNil(o.ServiceName) { + toSerialize["serviceName"] = o.ServiceName + } + if !isNil(o.Description) { + toSerialize["description"] = o.Description + } + if !isNil(o.ApiKey) { + toSerialize["apiKey"] = o.ApiKey + } + if !isNil(o.ClientIdAliasEnabled) { + toSerialize["clientIdAliasEnabled"] = o.ClientIdAliasEnabled + } + return toSerialize, nil +} + +type NullableServiceLimited struct { + value *ServiceLimited + isSet bool +} + +func (v NullableServiceLimited) Get() *ServiceLimited { + return v.value +} + +func (v *NullableServiceLimited) Set(val *ServiceLimited) { + v.value = val + v.isSet = true +} + +func (v NullableServiceLimited) IsSet() bool { + return v.isSet +} + +func (v *NullableServiceLimited) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableServiceLimited(val *ServiceLimited) *NullableServiceLimited { + return &NullableServiceLimited{value: val, isSet: true} +} + +func (v NullableServiceLimited) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableServiceLimited) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/model_service_profile.go b/model_service_profile.go index 0bb6ac4..74a1431 100644 --- a/model_service_profile.go +++ b/model_service_profile.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_sns.go b/model_sns.go index 15c5a15..b86773c 100644 --- a/model_sns.go +++ b/model_sns.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_sns_credentials.go b/model_sns_credentials.go index 5cb807e..4c25fbf 100644 --- a/model_sns_credentials.go +++ b/model_sns_credentials.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_standard_introspection_request.go b/model_standard_introspection_request.go index 8005740..d75e781 100644 --- a/model_standard_introspection_request.go +++ b/model_standard_introspection_request.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_standard_introspection_response.go b/model_standard_introspection_response.go index b817917..993ebe2 100644 --- a/model_standard_introspection_response.go +++ b/model_standard_introspection_response.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_subject_type.go b/model_subject_type.go index 55cc5e4..cf3b335 100644 --- a/model_subject_type.go +++ b/model_subject_type.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_tagged_value.go b/model_tagged_value.go index fe0310f..0d4e70c 100644 --- a/model_tagged_value.go +++ b/model_tagged_value.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_token_batch_status.go b/model_token_batch_status.go new file mode 100644 index 0000000..75eba0b --- /dev/null +++ b/model_token_batch_status.go @@ -0,0 +1,385 @@ +/* +Authlete API + +Authlete API Document. + +API version: 3.0.0 +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package authlete + +import ( + "encoding/json" +) + +// checks if the TokenBatchStatus type satisfies the MappedNullable interface at compile time +var _ MappedNullable = &TokenBatchStatus{} + +// TokenBatchStatus struct for TokenBatchStatus +type TokenBatchStatus struct { + // The kind of the batch. + BatchKind *string `json:"batchKind,omitempty"` + // The request ID associated with the status. + RequestId *string `json:"requestId,omitempty"` + Result *TokenBatchStatusResult `json:"result,omitempty"` + // The number of access tokens processed by the batch. + TokenCount *int64 `json:"tokenCount,omitempty"` + // The error code for the batch operation + ErrorCode *string `json:"errorCode,omitempty"` + // The error description for the batch operation + ErrorDescription *string `json:"errorDescription,omitempty"` + // The time when this status was created + CreatedAt *int64 `json:"createdAt,omitempty"` + // The time when this status was modified + ModifiedAt *int64 `json:"modifiedAt,omitempty"` +} + +// NewTokenBatchStatus instantiates a new TokenBatchStatus object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewTokenBatchStatus() *TokenBatchStatus { + this := TokenBatchStatus{} + return &this +} + +// NewTokenBatchStatusWithDefaults instantiates a new TokenBatchStatus object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewTokenBatchStatusWithDefaults() *TokenBatchStatus { + this := TokenBatchStatus{} + return &this +} + +// GetBatchKind returns the BatchKind field value if set, zero value otherwise. +func (o *TokenBatchStatus) GetBatchKind() string { + if o == nil || isNil(o.BatchKind) { + var ret string + return ret + } + return *o.BatchKind +} + +// GetBatchKindOk returns a tuple with the BatchKind field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *TokenBatchStatus) GetBatchKindOk() (*string, bool) { + if o == nil || isNil(o.BatchKind) { + return nil, false + } + return o.BatchKind, true +} + +// HasBatchKind returns a boolean if a field has been set. +func (o *TokenBatchStatus) HasBatchKind() bool { + if o != nil && !isNil(o.BatchKind) { + return true + } + + return false +} + +// SetBatchKind gets a reference to the given string and assigns it to the BatchKind field. +func (o *TokenBatchStatus) SetBatchKind(v string) { + o.BatchKind = &v +} + +// GetRequestId returns the RequestId field value if set, zero value otherwise. +func (o *TokenBatchStatus) GetRequestId() string { + if o == nil || isNil(o.RequestId) { + var ret string + return ret + } + return *o.RequestId +} + +// GetRequestIdOk returns a tuple with the RequestId field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *TokenBatchStatus) GetRequestIdOk() (*string, bool) { + if o == nil || isNil(o.RequestId) { + return nil, false + } + return o.RequestId, true +} + +// HasRequestId returns a boolean if a field has been set. +func (o *TokenBatchStatus) HasRequestId() bool { + if o != nil && !isNil(o.RequestId) { + return true + } + + return false +} + +// SetRequestId gets a reference to the given string and assigns it to the RequestId field. +func (o *TokenBatchStatus) SetRequestId(v string) { + o.RequestId = &v +} + +// GetResult returns the Result field value if set, zero value otherwise. +func (o *TokenBatchStatus) GetResult() TokenBatchStatusResult { + if o == nil || isNil(o.Result) { + var ret TokenBatchStatusResult + return ret + } + return *o.Result +} + +// GetResultOk returns a tuple with the Result field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *TokenBatchStatus) GetResultOk() (*TokenBatchStatusResult, bool) { + if o == nil || isNil(o.Result) { + return nil, false + } + return o.Result, true +} + +// HasResult returns a boolean if a field has been set. +func (o *TokenBatchStatus) HasResult() bool { + if o != nil && !isNil(o.Result) { + return true + } + + return false +} + +// SetResult gets a reference to the given TokenBatchStatusResult and assigns it to the Result field. +func (o *TokenBatchStatus) SetResult(v TokenBatchStatusResult) { + o.Result = &v +} + +// GetTokenCount returns the TokenCount field value if set, zero value otherwise. +func (o *TokenBatchStatus) GetTokenCount() int64 { + if o == nil || isNil(o.TokenCount) { + var ret int64 + return ret + } + return *o.TokenCount +} + +// GetTokenCountOk returns a tuple with the TokenCount field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *TokenBatchStatus) GetTokenCountOk() (*int64, bool) { + if o == nil || isNil(o.TokenCount) { + return nil, false + } + return o.TokenCount, true +} + +// HasTokenCount returns a boolean if a field has been set. +func (o *TokenBatchStatus) HasTokenCount() bool { + if o != nil && !isNil(o.TokenCount) { + return true + } + + return false +} + +// SetTokenCount gets a reference to the given int64 and assigns it to the TokenCount field. +func (o *TokenBatchStatus) SetTokenCount(v int64) { + o.TokenCount = &v +} + +// GetErrorCode returns the ErrorCode field value if set, zero value otherwise. +func (o *TokenBatchStatus) GetErrorCode() string { + if o == nil || isNil(o.ErrorCode) { + var ret string + return ret + } + return *o.ErrorCode +} + +// GetErrorCodeOk returns a tuple with the ErrorCode field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *TokenBatchStatus) GetErrorCodeOk() (*string, bool) { + if o == nil || isNil(o.ErrorCode) { + return nil, false + } + return o.ErrorCode, true +} + +// HasErrorCode returns a boolean if a field has been set. +func (o *TokenBatchStatus) HasErrorCode() bool { + if o != nil && !isNil(o.ErrorCode) { + return true + } + + return false +} + +// SetErrorCode gets a reference to the given string and assigns it to the ErrorCode field. +func (o *TokenBatchStatus) SetErrorCode(v string) { + o.ErrorCode = &v +} + +// GetErrorDescription returns the ErrorDescription field value if set, zero value otherwise. +func (o *TokenBatchStatus) GetErrorDescription() string { + if o == nil || isNil(o.ErrorDescription) { + var ret string + return ret + } + return *o.ErrorDescription +} + +// GetErrorDescriptionOk returns a tuple with the ErrorDescription field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *TokenBatchStatus) GetErrorDescriptionOk() (*string, bool) { + if o == nil || isNil(o.ErrorDescription) { + return nil, false + } + return o.ErrorDescription, true +} + +// HasErrorDescription returns a boolean if a field has been set. +func (o *TokenBatchStatus) HasErrorDescription() bool { + if o != nil && !isNil(o.ErrorDescription) { + return true + } + + return false +} + +// SetErrorDescription gets a reference to the given string and assigns it to the ErrorDescription field. +func (o *TokenBatchStatus) SetErrorDescription(v string) { + o.ErrorDescription = &v +} + +// GetCreatedAt returns the CreatedAt field value if set, zero value otherwise. +func (o *TokenBatchStatus) GetCreatedAt() int64 { + if o == nil || isNil(o.CreatedAt) { + var ret int64 + return ret + } + return *o.CreatedAt +} + +// GetCreatedAtOk returns a tuple with the CreatedAt field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *TokenBatchStatus) GetCreatedAtOk() (*int64, bool) { + if o == nil || isNil(o.CreatedAt) { + return nil, false + } + return o.CreatedAt, true +} + +// HasCreatedAt returns a boolean if a field has been set. +func (o *TokenBatchStatus) HasCreatedAt() bool { + if o != nil && !isNil(o.CreatedAt) { + return true + } + + return false +} + +// SetCreatedAt gets a reference to the given int64 and assigns it to the CreatedAt field. +func (o *TokenBatchStatus) SetCreatedAt(v int64) { + o.CreatedAt = &v +} + +// GetModifiedAt returns the ModifiedAt field value if set, zero value otherwise. +func (o *TokenBatchStatus) GetModifiedAt() int64 { + if o == nil || isNil(o.ModifiedAt) { + var ret int64 + return ret + } + return *o.ModifiedAt +} + +// GetModifiedAtOk returns a tuple with the ModifiedAt field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *TokenBatchStatus) GetModifiedAtOk() (*int64, bool) { + if o == nil || isNil(o.ModifiedAt) { + return nil, false + } + return o.ModifiedAt, true +} + +// HasModifiedAt returns a boolean if a field has been set. +func (o *TokenBatchStatus) HasModifiedAt() bool { + if o != nil && !isNil(o.ModifiedAt) { + return true + } + + return false +} + +// SetModifiedAt gets a reference to the given int64 and assigns it to the ModifiedAt field. +func (o *TokenBatchStatus) SetModifiedAt(v int64) { + o.ModifiedAt = &v +} + +func (o TokenBatchStatus) MarshalJSON() ([]byte, error) { + toSerialize,err := o.ToMap() + if err != nil { + return []byte{}, err + } + return json.Marshal(toSerialize) +} + +func (o TokenBatchStatus) ToMap() (map[string]interface{}, error) { + toSerialize := map[string]interface{}{} + if !isNil(o.BatchKind) { + toSerialize["batchKind"] = o.BatchKind + } + if !isNil(o.RequestId) { + toSerialize["requestId"] = o.RequestId + } + if !isNil(o.Result) { + toSerialize["result"] = o.Result + } + if !isNil(o.TokenCount) { + toSerialize["tokenCount"] = o.TokenCount + } + if !isNil(o.ErrorCode) { + toSerialize["errorCode"] = o.ErrorCode + } + if !isNil(o.ErrorDescription) { + toSerialize["errorDescription"] = o.ErrorDescription + } + if !isNil(o.CreatedAt) { + toSerialize["createdAt"] = o.CreatedAt + } + if !isNil(o.ModifiedAt) { + toSerialize["modifiedAt"] = o.ModifiedAt + } + return toSerialize, nil +} + +type NullableTokenBatchStatus struct { + value *TokenBatchStatus + isSet bool +} + +func (v NullableTokenBatchStatus) Get() *TokenBatchStatus { + return v.value +} + +func (v *NullableTokenBatchStatus) Set(val *TokenBatchStatus) { + v.value = val + v.isSet = true +} + +func (v NullableTokenBatchStatus) IsSet() bool { + return v.isSet +} + +func (v *NullableTokenBatchStatus) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableTokenBatchStatus(val *TokenBatchStatus) *NullableTokenBatchStatus { + return &NullableTokenBatchStatus{value: val, isSet: true} +} + +func (v NullableTokenBatchStatus) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableTokenBatchStatus) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/model_token_batch_status_result.go b/model_token_batch_status_result.go new file mode 100644 index 0000000..8a465df --- /dev/null +++ b/model_token_batch_status_result.go @@ -0,0 +1,111 @@ +/* +Authlete API + +Authlete API Document. + +API version: 3.0.0 +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package authlete + +import ( + "encoding/json" + "fmt" +) + +// TokenBatchStatusResult the model 'TokenBatchStatusResult' +type TokenBatchStatusResult string + +// List of token_batch_status_result +const ( + TOKENBATCHSTATUSRESULT_FAILED TokenBatchStatusResult = "FAILED" + TOKENBATCHSTATUSRESULT_SUCCEED TokenBatchStatusResult = "SUCCEED" +) + +// All allowed values of TokenBatchStatusResult enum +var AllowedTokenBatchStatusResultEnumValues = []TokenBatchStatusResult{ + "FAILED", + "SUCCEED", +} + +func (v *TokenBatchStatusResult) UnmarshalJSON(src []byte) error { + var value string + err := json.Unmarshal(src, &value) + if err != nil { + return err + } + enumTypeValue := TokenBatchStatusResult(value) + for _, existing := range AllowedTokenBatchStatusResultEnumValues { + if existing == enumTypeValue { + *v = enumTypeValue + return nil + } + } + + return fmt.Errorf("%+v is not a valid TokenBatchStatusResult", value) +} + +// NewTokenBatchStatusResultFromValue returns a pointer to a valid TokenBatchStatusResult +// for the value passed as argument, or an error if the value passed is not allowed by the enum +func NewTokenBatchStatusResultFromValue(v string) (*TokenBatchStatusResult, error) { + ev := TokenBatchStatusResult(v) + if ev.IsValid() { + return &ev, nil + } else { + return nil, fmt.Errorf("invalid value '%v' for TokenBatchStatusResult: valid values are %v", v, AllowedTokenBatchStatusResultEnumValues) + } +} + +// IsValid return true if the value is valid for the enum, false otherwise +func (v TokenBatchStatusResult) IsValid() bool { + for _, existing := range AllowedTokenBatchStatusResultEnumValues { + if existing == v { + return true + } + } + return false +} + +// Ptr returns reference to token_batch_status_result value +func (v TokenBatchStatusResult) Ptr() *TokenBatchStatusResult { + return &v +} + +type NullableTokenBatchStatusResult struct { + value *TokenBatchStatusResult + isSet bool +} + +func (v NullableTokenBatchStatusResult) Get() *TokenBatchStatusResult { + return v.value +} + +func (v *NullableTokenBatchStatusResult) Set(val *TokenBatchStatusResult) { + v.value = val + v.isSet = true +} + +func (v NullableTokenBatchStatusResult) IsSet() bool { + return v.isSet +} + +func (v *NullableTokenBatchStatusResult) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableTokenBatchStatusResult(val *TokenBatchStatusResult) *NullableTokenBatchStatusResult { + return &NullableTokenBatchStatusResult{value: val, isSet: true} +} + +func (v NullableTokenBatchStatusResult) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableTokenBatchStatusResult) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + diff --git a/model_token_create_batch_request_inner.go b/model_token_create_batch_request_inner.go new file mode 100644 index 0000000..898c2f2 --- /dev/null +++ b/model_token_create_batch_request_inner.go @@ -0,0 +1,801 @@ +/* +Authlete API + +Authlete API Document. + +API version: 3.0.0 +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package authlete + +import ( + "encoding/json" +) + +// checks if the TokenCreateBatchRequestInner type satisfies the MappedNullable interface at compile time +var _ MappedNullable = &TokenCreateBatchRequestInner{} + +// TokenCreateBatchRequestInner struct for TokenCreateBatchRequestInner +type TokenCreateBatchRequestInner struct { + GrantType GrantType `json:"grantType"` + // The ID of the client application which will be associated with a newly created access token. + ClientId int64 `json:"clientId"` + // The subject (= unique identifier) of the user who will be associated with a newly created access token. This parameter is required unless the grant type is `CLIENT_CREDENTIALS`. The value must consist of only ASCII characters and its length must not exceed 100. + Subject *string `json:"subject,omitempty"` + // The scopes which will be associated with a newly created access token. Scopes that are not supported by the service cannot be specified and requesting them will cause an error. + Scopes []string `json:"scopes,omitempty"` + // The duration of a newly created access token in seconds. If the value is 0, the duration is determined according to the settings of the service. + AccessTokenDuration *int64 `json:"accessTokenDuration,omitempty"` + // The duration of a newly created refresh token in seconds. If the value is 0, the duration is determined according to the settings of the service. A refresh token is not created (1) if the service does not support `REFRESH_TOKEN`, or (2) if the specified grant type is either `IMPLICIT`or `CLIENT_CREDENTIALS`. + RefreshTokenDuration *int64 `json:"refreshTokenDuration,omitempty"` + // Extra properties to associate with a newly created access token. Note that properties parameter is accepted only when the HTTP method of the request is POST and Content-Type of the request is `application/json`, so don't use `GET` method or `application/x-www-form-urlencoded` if you want to specify properties. + Properties []Property `json:"properties,omitempty"` + // A boolean request parameter which indicates whether to emulate that the client ID alias is used instead of the original numeric client ID when a new access token is created. This has an effect only on the value of the aud claim in a response from [UserInfo endpoint](https://openid.net/specs/openid-connect-core-1_0.html#UserInfo). When you access the UserInfo endpoint (which is expected to be implemented using Authlete's `/api/auth/userinfo` API and `/api/auth/userinfo/issue` API) with an access token which has been created using Authlete's `/api/auth/token/create/batch` API with this property (`clientIdAliasUsed`) `true`, the client ID alias is used as the value of the aud claim in a response from the UserInfo endpoint. Note that if a client ID alias is not assigned to the client when Authlete's `/api/auth/token/create/batch` API is called, this property (`clientIdAliasUsed`) has no effect (it is always regarded as `false`). + ClientIdAliasUsed *bool `json:"clientIdAliasUsed,omitempty"` + // The value of the new access token. you must specify the value of a newly created access token by passing a non-null value as the value of accessToken request parameter. + AccessToken string `json:"accessToken"` + // The value of the new refresh token. This is required under some conditions such as when the service supports the refresh token flow. + RefreshToken *string `json:"refreshToken,omitempty"` + // Get whether the access token expires or not. By default, all access tokens expire after a period of time determined by their service. If this request parameter is `true`, then the access token will not automatically expire and must be revoked or deleted manually at the service. If this request parameter is true, the `accessTokenDuration` request parameter is ignored. + AccessTokenPersistent *bool `json:"accessTokenPersistent,omitempty"` + // The thumbprint of the MTLS certificate bound to this token. If this property is set, a certificate with the corresponding value MUST be presented with the access token when it is used by a client. The value of this property must be a SHA256 certificate thumbprint, base64url encoded. + CertificateThumbprint *string `json:"certificateThumbprint,omitempty"` + // The thumbprint of the public key used for DPoP presentation of this token. If this property is set, a DPoP proof signed with the corresponding private key MUST be presented with the access token when it is used by a client. Additionally, the token's `token_type` will be set to 'DPoP'. + DpopKeyThumbprint *string `json:"dpopKeyThumbprint,omitempty"` + AuthorizationDetails *AuthzDetails `json:"authorizationDetails,omitempty"` + // The value of the resources to associate with the token. This property represents the value of one or more `resource` request parameters which is defined in \"RFC8707 Resource Indicators for OAuth 2.0\". + Resources []string `json:"resources,omitempty"` + // the flag which indicates whether the access token is for an external attachment. + ForExternalAttachment *bool `json:"forExternalAttachment,omitempty"` + // Additional claims that are added to the payload part of the JWT access token. + JwtAtClaims *string `json:"jwtAtClaims,omitempty"` + // The Authentication Context Class Reference of the user authentication that the authorization server performed during the course of issuing the access token. + Acr *string `json:"acr,omitempty"` + // The time when the user authentication was performed during the course of issuing the access token. + AuthTime *int64 `json:"authTime,omitempty"` + // Flag which indicates whether the entity ID of the client was used when the request for the access token was made. + ClientEntityIdUsed *bool `json:"clientEntityIdUsed,omitempty"` +} + +// NewTokenCreateBatchRequestInner instantiates a new TokenCreateBatchRequestInner object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewTokenCreateBatchRequestInner(grantType GrantType, clientId int64, accessToken string) *TokenCreateBatchRequestInner { + this := TokenCreateBatchRequestInner{} + this.GrantType = grantType + this.ClientId = clientId + this.AccessToken = accessToken + return &this +} + +// NewTokenCreateBatchRequestInnerWithDefaults instantiates a new TokenCreateBatchRequestInner object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewTokenCreateBatchRequestInnerWithDefaults() *TokenCreateBatchRequestInner { + this := TokenCreateBatchRequestInner{} + return &this +} + +// GetGrantType returns the GrantType field value +func (o *TokenCreateBatchRequestInner) GetGrantType() GrantType { + if o == nil { + var ret GrantType + return ret + } + + return o.GrantType +} + +// GetGrantTypeOk returns a tuple with the GrantType field value +// and a boolean to check if the value has been set. +func (o *TokenCreateBatchRequestInner) GetGrantTypeOk() (*GrantType, bool) { + if o == nil { + return nil, false + } + return &o.GrantType, true +} + +// SetGrantType sets field value +func (o *TokenCreateBatchRequestInner) SetGrantType(v GrantType) { + o.GrantType = v +} + +// GetClientId returns the ClientId field value +func (o *TokenCreateBatchRequestInner) GetClientId() int64 { + if o == nil { + var ret int64 + return ret + } + + return o.ClientId +} + +// GetClientIdOk returns a tuple with the ClientId field value +// and a boolean to check if the value has been set. +func (o *TokenCreateBatchRequestInner) GetClientIdOk() (*int64, bool) { + if o == nil { + return nil, false + } + return &o.ClientId, true +} + +// SetClientId sets field value +func (o *TokenCreateBatchRequestInner) SetClientId(v int64) { + o.ClientId = v +} + +// GetSubject returns the Subject field value if set, zero value otherwise. +func (o *TokenCreateBatchRequestInner) GetSubject() string { + if o == nil || isNil(o.Subject) { + var ret string + return ret + } + return *o.Subject +} + +// GetSubjectOk returns a tuple with the Subject field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *TokenCreateBatchRequestInner) GetSubjectOk() (*string, bool) { + if o == nil || isNil(o.Subject) { + return nil, false + } + return o.Subject, true +} + +// HasSubject returns a boolean if a field has been set. +func (o *TokenCreateBatchRequestInner) HasSubject() bool { + if o != nil && !isNil(o.Subject) { + return true + } + + return false +} + +// SetSubject gets a reference to the given string and assigns it to the Subject field. +func (o *TokenCreateBatchRequestInner) SetSubject(v string) { + o.Subject = &v +} + +// GetScopes returns the Scopes field value if set, zero value otherwise. +func (o *TokenCreateBatchRequestInner) GetScopes() []string { + if o == nil || isNil(o.Scopes) { + var ret []string + return ret + } + return o.Scopes +} + +// GetScopesOk returns a tuple with the Scopes field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *TokenCreateBatchRequestInner) GetScopesOk() ([]string, bool) { + if o == nil || isNil(o.Scopes) { + return nil, false + } + return o.Scopes, true +} + +// HasScopes returns a boolean if a field has been set. +func (o *TokenCreateBatchRequestInner) HasScopes() bool { + if o != nil && !isNil(o.Scopes) { + return true + } + + return false +} + +// SetScopes gets a reference to the given []string and assigns it to the Scopes field. +func (o *TokenCreateBatchRequestInner) SetScopes(v []string) { + o.Scopes = v +} + +// GetAccessTokenDuration returns the AccessTokenDuration field value if set, zero value otherwise. +func (o *TokenCreateBatchRequestInner) GetAccessTokenDuration() int64 { + if o == nil || isNil(o.AccessTokenDuration) { + var ret int64 + return ret + } + return *o.AccessTokenDuration +} + +// GetAccessTokenDurationOk returns a tuple with the AccessTokenDuration field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *TokenCreateBatchRequestInner) GetAccessTokenDurationOk() (*int64, bool) { + if o == nil || isNil(o.AccessTokenDuration) { + return nil, false + } + return o.AccessTokenDuration, true +} + +// HasAccessTokenDuration returns a boolean if a field has been set. +func (o *TokenCreateBatchRequestInner) HasAccessTokenDuration() bool { + if o != nil && !isNil(o.AccessTokenDuration) { + return true + } + + return false +} + +// SetAccessTokenDuration gets a reference to the given int64 and assigns it to the AccessTokenDuration field. +func (o *TokenCreateBatchRequestInner) SetAccessTokenDuration(v int64) { + o.AccessTokenDuration = &v +} + +// GetRefreshTokenDuration returns the RefreshTokenDuration field value if set, zero value otherwise. +func (o *TokenCreateBatchRequestInner) GetRefreshTokenDuration() int64 { + if o == nil || isNil(o.RefreshTokenDuration) { + var ret int64 + return ret + } + return *o.RefreshTokenDuration +} + +// GetRefreshTokenDurationOk returns a tuple with the RefreshTokenDuration field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *TokenCreateBatchRequestInner) GetRefreshTokenDurationOk() (*int64, bool) { + if o == nil || isNil(o.RefreshTokenDuration) { + return nil, false + } + return o.RefreshTokenDuration, true +} + +// HasRefreshTokenDuration returns a boolean if a field has been set. +func (o *TokenCreateBatchRequestInner) HasRefreshTokenDuration() bool { + if o != nil && !isNil(o.RefreshTokenDuration) { + return true + } + + return false +} + +// SetRefreshTokenDuration gets a reference to the given int64 and assigns it to the RefreshTokenDuration field. +func (o *TokenCreateBatchRequestInner) SetRefreshTokenDuration(v int64) { + o.RefreshTokenDuration = &v +} + +// GetProperties returns the Properties field value if set, zero value otherwise. +func (o *TokenCreateBatchRequestInner) GetProperties() []Property { + if o == nil || isNil(o.Properties) { + var ret []Property + return ret + } + return o.Properties +} + +// GetPropertiesOk returns a tuple with the Properties field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *TokenCreateBatchRequestInner) GetPropertiesOk() ([]Property, bool) { + if o == nil || isNil(o.Properties) { + return nil, false + } + return o.Properties, true +} + +// HasProperties returns a boolean if a field has been set. +func (o *TokenCreateBatchRequestInner) HasProperties() bool { + if o != nil && !isNil(o.Properties) { + return true + } + + return false +} + +// SetProperties gets a reference to the given []Property and assigns it to the Properties field. +func (o *TokenCreateBatchRequestInner) SetProperties(v []Property) { + o.Properties = v +} + +// GetClientIdAliasUsed returns the ClientIdAliasUsed field value if set, zero value otherwise. +func (o *TokenCreateBatchRequestInner) GetClientIdAliasUsed() bool { + if o == nil || isNil(o.ClientIdAliasUsed) { + var ret bool + return ret + } + return *o.ClientIdAliasUsed +} + +// GetClientIdAliasUsedOk returns a tuple with the ClientIdAliasUsed field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *TokenCreateBatchRequestInner) GetClientIdAliasUsedOk() (*bool, bool) { + if o == nil || isNil(o.ClientIdAliasUsed) { + return nil, false + } + return o.ClientIdAliasUsed, true +} + +// HasClientIdAliasUsed returns a boolean if a field has been set. +func (o *TokenCreateBatchRequestInner) HasClientIdAliasUsed() bool { + if o != nil && !isNil(o.ClientIdAliasUsed) { + return true + } + + return false +} + +// SetClientIdAliasUsed gets a reference to the given bool and assigns it to the ClientIdAliasUsed field. +func (o *TokenCreateBatchRequestInner) SetClientIdAliasUsed(v bool) { + o.ClientIdAliasUsed = &v +} + +// GetAccessToken returns the AccessToken field value +func (o *TokenCreateBatchRequestInner) GetAccessToken() string { + if o == nil { + var ret string + return ret + } + + return o.AccessToken +} + +// GetAccessTokenOk returns a tuple with the AccessToken field value +// and a boolean to check if the value has been set. +func (o *TokenCreateBatchRequestInner) GetAccessTokenOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.AccessToken, true +} + +// SetAccessToken sets field value +func (o *TokenCreateBatchRequestInner) SetAccessToken(v string) { + o.AccessToken = v +} + +// GetRefreshToken returns the RefreshToken field value if set, zero value otherwise. +func (o *TokenCreateBatchRequestInner) GetRefreshToken() string { + if o == nil || isNil(o.RefreshToken) { + var ret string + return ret + } + return *o.RefreshToken +} + +// GetRefreshTokenOk returns a tuple with the RefreshToken field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *TokenCreateBatchRequestInner) GetRefreshTokenOk() (*string, bool) { + if o == nil || isNil(o.RefreshToken) { + return nil, false + } + return o.RefreshToken, true +} + +// HasRefreshToken returns a boolean if a field has been set. +func (o *TokenCreateBatchRequestInner) HasRefreshToken() bool { + if o != nil && !isNil(o.RefreshToken) { + return true + } + + return false +} + +// SetRefreshToken gets a reference to the given string and assigns it to the RefreshToken field. +func (o *TokenCreateBatchRequestInner) SetRefreshToken(v string) { + o.RefreshToken = &v +} + +// GetAccessTokenPersistent returns the AccessTokenPersistent field value if set, zero value otherwise. +func (o *TokenCreateBatchRequestInner) GetAccessTokenPersistent() bool { + if o == nil || isNil(o.AccessTokenPersistent) { + var ret bool + return ret + } + return *o.AccessTokenPersistent +} + +// GetAccessTokenPersistentOk returns a tuple with the AccessTokenPersistent field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *TokenCreateBatchRequestInner) GetAccessTokenPersistentOk() (*bool, bool) { + if o == nil || isNil(o.AccessTokenPersistent) { + return nil, false + } + return o.AccessTokenPersistent, true +} + +// HasAccessTokenPersistent returns a boolean if a field has been set. +func (o *TokenCreateBatchRequestInner) HasAccessTokenPersistent() bool { + if o != nil && !isNil(o.AccessTokenPersistent) { + return true + } + + return false +} + +// SetAccessTokenPersistent gets a reference to the given bool and assigns it to the AccessTokenPersistent field. +func (o *TokenCreateBatchRequestInner) SetAccessTokenPersistent(v bool) { + o.AccessTokenPersistent = &v +} + +// GetCertificateThumbprint returns the CertificateThumbprint field value if set, zero value otherwise. +func (o *TokenCreateBatchRequestInner) GetCertificateThumbprint() string { + if o == nil || isNil(o.CertificateThumbprint) { + var ret string + return ret + } + return *o.CertificateThumbprint +} + +// GetCertificateThumbprintOk returns a tuple with the CertificateThumbprint field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *TokenCreateBatchRequestInner) GetCertificateThumbprintOk() (*string, bool) { + if o == nil || isNil(o.CertificateThumbprint) { + return nil, false + } + return o.CertificateThumbprint, true +} + +// HasCertificateThumbprint returns a boolean if a field has been set. +func (o *TokenCreateBatchRequestInner) HasCertificateThumbprint() bool { + if o != nil && !isNil(o.CertificateThumbprint) { + return true + } + + return false +} + +// SetCertificateThumbprint gets a reference to the given string and assigns it to the CertificateThumbprint field. +func (o *TokenCreateBatchRequestInner) SetCertificateThumbprint(v string) { + o.CertificateThumbprint = &v +} + +// GetDpopKeyThumbprint returns the DpopKeyThumbprint field value if set, zero value otherwise. +func (o *TokenCreateBatchRequestInner) GetDpopKeyThumbprint() string { + if o == nil || isNil(o.DpopKeyThumbprint) { + var ret string + return ret + } + return *o.DpopKeyThumbprint +} + +// GetDpopKeyThumbprintOk returns a tuple with the DpopKeyThumbprint field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *TokenCreateBatchRequestInner) GetDpopKeyThumbprintOk() (*string, bool) { + if o == nil || isNil(o.DpopKeyThumbprint) { + return nil, false + } + return o.DpopKeyThumbprint, true +} + +// HasDpopKeyThumbprint returns a boolean if a field has been set. +func (o *TokenCreateBatchRequestInner) HasDpopKeyThumbprint() bool { + if o != nil && !isNil(o.DpopKeyThumbprint) { + return true + } + + return false +} + +// SetDpopKeyThumbprint gets a reference to the given string and assigns it to the DpopKeyThumbprint field. +func (o *TokenCreateBatchRequestInner) SetDpopKeyThumbprint(v string) { + o.DpopKeyThumbprint = &v +} + +// GetAuthorizationDetails returns the AuthorizationDetails field value if set, zero value otherwise. +func (o *TokenCreateBatchRequestInner) GetAuthorizationDetails() AuthzDetails { + if o == nil || isNil(o.AuthorizationDetails) { + var ret AuthzDetails + return ret + } + return *o.AuthorizationDetails +} + +// GetAuthorizationDetailsOk returns a tuple with the AuthorizationDetails field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *TokenCreateBatchRequestInner) GetAuthorizationDetailsOk() (*AuthzDetails, bool) { + if o == nil || isNil(o.AuthorizationDetails) { + return nil, false + } + return o.AuthorizationDetails, true +} + +// HasAuthorizationDetails returns a boolean if a field has been set. +func (o *TokenCreateBatchRequestInner) HasAuthorizationDetails() bool { + if o != nil && !isNil(o.AuthorizationDetails) { + return true + } + + return false +} + +// SetAuthorizationDetails gets a reference to the given AuthzDetails and assigns it to the AuthorizationDetails field. +func (o *TokenCreateBatchRequestInner) SetAuthorizationDetails(v AuthzDetails) { + o.AuthorizationDetails = &v +} + +// GetResources returns the Resources field value if set, zero value otherwise. +func (o *TokenCreateBatchRequestInner) GetResources() []string { + if o == nil || isNil(o.Resources) { + var ret []string + return ret + } + return o.Resources +} + +// GetResourcesOk returns a tuple with the Resources field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *TokenCreateBatchRequestInner) GetResourcesOk() ([]string, bool) { + if o == nil || isNil(o.Resources) { + return nil, false + } + return o.Resources, true +} + +// HasResources returns a boolean if a field has been set. +func (o *TokenCreateBatchRequestInner) HasResources() bool { + if o != nil && !isNil(o.Resources) { + return true + } + + return false +} + +// SetResources gets a reference to the given []string and assigns it to the Resources field. +func (o *TokenCreateBatchRequestInner) SetResources(v []string) { + o.Resources = v +} + +// GetForExternalAttachment returns the ForExternalAttachment field value if set, zero value otherwise. +func (o *TokenCreateBatchRequestInner) GetForExternalAttachment() bool { + if o == nil || isNil(o.ForExternalAttachment) { + var ret bool + return ret + } + return *o.ForExternalAttachment +} + +// GetForExternalAttachmentOk returns a tuple with the ForExternalAttachment field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *TokenCreateBatchRequestInner) GetForExternalAttachmentOk() (*bool, bool) { + if o == nil || isNil(o.ForExternalAttachment) { + return nil, false + } + return o.ForExternalAttachment, true +} + +// HasForExternalAttachment returns a boolean if a field has been set. +func (o *TokenCreateBatchRequestInner) HasForExternalAttachment() bool { + if o != nil && !isNil(o.ForExternalAttachment) { + return true + } + + return false +} + +// SetForExternalAttachment gets a reference to the given bool and assigns it to the ForExternalAttachment field. +func (o *TokenCreateBatchRequestInner) SetForExternalAttachment(v bool) { + o.ForExternalAttachment = &v +} + +// GetJwtAtClaims returns the JwtAtClaims field value if set, zero value otherwise. +func (o *TokenCreateBatchRequestInner) GetJwtAtClaims() string { + if o == nil || isNil(o.JwtAtClaims) { + var ret string + return ret + } + return *o.JwtAtClaims +} + +// GetJwtAtClaimsOk returns a tuple with the JwtAtClaims field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *TokenCreateBatchRequestInner) GetJwtAtClaimsOk() (*string, bool) { + if o == nil || isNil(o.JwtAtClaims) { + return nil, false + } + return o.JwtAtClaims, true +} + +// HasJwtAtClaims returns a boolean if a field has been set. +func (o *TokenCreateBatchRequestInner) HasJwtAtClaims() bool { + if o != nil && !isNil(o.JwtAtClaims) { + return true + } + + return false +} + +// SetJwtAtClaims gets a reference to the given string and assigns it to the JwtAtClaims field. +func (o *TokenCreateBatchRequestInner) SetJwtAtClaims(v string) { + o.JwtAtClaims = &v +} + +// GetAcr returns the Acr field value if set, zero value otherwise. +func (o *TokenCreateBatchRequestInner) GetAcr() string { + if o == nil || isNil(o.Acr) { + var ret string + return ret + } + return *o.Acr +} + +// GetAcrOk returns a tuple with the Acr field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *TokenCreateBatchRequestInner) GetAcrOk() (*string, bool) { + if o == nil || isNil(o.Acr) { + return nil, false + } + return o.Acr, true +} + +// HasAcr returns a boolean if a field has been set. +func (o *TokenCreateBatchRequestInner) HasAcr() bool { + if o != nil && !isNil(o.Acr) { + return true + } + + return false +} + +// SetAcr gets a reference to the given string and assigns it to the Acr field. +func (o *TokenCreateBatchRequestInner) SetAcr(v string) { + o.Acr = &v +} + +// GetAuthTime returns the AuthTime field value if set, zero value otherwise. +func (o *TokenCreateBatchRequestInner) GetAuthTime() int64 { + if o == nil || isNil(o.AuthTime) { + var ret int64 + return ret + } + return *o.AuthTime +} + +// GetAuthTimeOk returns a tuple with the AuthTime field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *TokenCreateBatchRequestInner) GetAuthTimeOk() (*int64, bool) { + if o == nil || isNil(o.AuthTime) { + return nil, false + } + return o.AuthTime, true +} + +// HasAuthTime returns a boolean if a field has been set. +func (o *TokenCreateBatchRequestInner) HasAuthTime() bool { + if o != nil && !isNil(o.AuthTime) { + return true + } + + return false +} + +// SetAuthTime gets a reference to the given int64 and assigns it to the AuthTime field. +func (o *TokenCreateBatchRequestInner) SetAuthTime(v int64) { + o.AuthTime = &v +} + +// GetClientEntityIdUsed returns the ClientEntityIdUsed field value if set, zero value otherwise. +func (o *TokenCreateBatchRequestInner) GetClientEntityIdUsed() bool { + if o == nil || isNil(o.ClientEntityIdUsed) { + var ret bool + return ret + } + return *o.ClientEntityIdUsed +} + +// GetClientEntityIdUsedOk returns a tuple with the ClientEntityIdUsed field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *TokenCreateBatchRequestInner) GetClientEntityIdUsedOk() (*bool, bool) { + if o == nil || isNil(o.ClientEntityIdUsed) { + return nil, false + } + return o.ClientEntityIdUsed, true +} + +// HasClientEntityIdUsed returns a boolean if a field has been set. +func (o *TokenCreateBatchRequestInner) HasClientEntityIdUsed() bool { + if o != nil && !isNil(o.ClientEntityIdUsed) { + return true + } + + return false +} + +// SetClientEntityIdUsed gets a reference to the given bool and assigns it to the ClientEntityIdUsed field. +func (o *TokenCreateBatchRequestInner) SetClientEntityIdUsed(v bool) { + o.ClientEntityIdUsed = &v +} + +func (o TokenCreateBatchRequestInner) MarshalJSON() ([]byte, error) { + toSerialize,err := o.ToMap() + if err != nil { + return []byte{}, err + } + return json.Marshal(toSerialize) +} + +func (o TokenCreateBatchRequestInner) ToMap() (map[string]interface{}, error) { + toSerialize := map[string]interface{}{} + toSerialize["grantType"] = o.GrantType + toSerialize["clientId"] = o.ClientId + if !isNil(o.Subject) { + toSerialize["subject"] = o.Subject + } + if !isNil(o.Scopes) { + toSerialize["scopes"] = o.Scopes + } + if !isNil(o.AccessTokenDuration) { + toSerialize["accessTokenDuration"] = o.AccessTokenDuration + } + if !isNil(o.RefreshTokenDuration) { + toSerialize["refreshTokenDuration"] = o.RefreshTokenDuration + } + if !isNil(o.Properties) { + toSerialize["properties"] = o.Properties + } + if !isNil(o.ClientIdAliasUsed) { + toSerialize["clientIdAliasUsed"] = o.ClientIdAliasUsed + } + toSerialize["accessToken"] = o.AccessToken + if !isNil(o.RefreshToken) { + toSerialize["refreshToken"] = o.RefreshToken + } + if !isNil(o.AccessTokenPersistent) { + toSerialize["accessTokenPersistent"] = o.AccessTokenPersistent + } + if !isNil(o.CertificateThumbprint) { + toSerialize["certificateThumbprint"] = o.CertificateThumbprint + } + if !isNil(o.DpopKeyThumbprint) { + toSerialize["dpopKeyThumbprint"] = o.DpopKeyThumbprint + } + if !isNil(o.AuthorizationDetails) { + toSerialize["authorizationDetails"] = o.AuthorizationDetails + } + if !isNil(o.Resources) { + toSerialize["resources"] = o.Resources + } + if !isNil(o.ForExternalAttachment) { + toSerialize["forExternalAttachment"] = o.ForExternalAttachment + } + if !isNil(o.JwtAtClaims) { + toSerialize["jwtAtClaims"] = o.JwtAtClaims + } + if !isNil(o.Acr) { + toSerialize["acr"] = o.Acr + } + if !isNil(o.AuthTime) { + toSerialize["authTime"] = o.AuthTime + } + if !isNil(o.ClientEntityIdUsed) { + toSerialize["clientEntityIdUsed"] = o.ClientEntityIdUsed + } + return toSerialize, nil +} + +type NullableTokenCreateBatchRequestInner struct { + value *TokenCreateBatchRequestInner + isSet bool +} + +func (v NullableTokenCreateBatchRequestInner) Get() *TokenCreateBatchRequestInner { + return v.value +} + +func (v *NullableTokenCreateBatchRequestInner) Set(val *TokenCreateBatchRequestInner) { + v.value = val + v.isSet = true +} + +func (v NullableTokenCreateBatchRequestInner) IsSet() bool { + return v.isSet +} + +func (v *NullableTokenCreateBatchRequestInner) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableTokenCreateBatchRequestInner(val *TokenCreateBatchRequestInner) *NullableTokenCreateBatchRequestInner { + return &NullableTokenCreateBatchRequestInner{value: val, isSet: true} +} + +func (v NullableTokenCreateBatchRequestInner) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableTokenCreateBatchRequestInner) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/model_token_create_batch_response.go b/model_token_create_batch_response.go new file mode 100644 index 0000000..0f658d1 --- /dev/null +++ b/model_token_create_batch_response.go @@ -0,0 +1,201 @@ +/* +Authlete API + +Authlete API Document. + +API version: 3.0.0 +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package authlete + +import ( + "encoding/json" +) + +// checks if the TokenCreateBatchResponse type satisfies the MappedNullable interface at compile time +var _ MappedNullable = &TokenCreateBatchResponse{} + +// TokenCreateBatchResponse struct for TokenCreateBatchResponse +type TokenCreateBatchResponse struct { + // The code which represents the result of the API call. + ResultCode *string `json:"resultCode,omitempty"` + // A short message which explains the result of the API call. + ResultMessage *string `json:"resultMessage,omitempty"` + // The ID for the requested batch operation. + RequestId *string `json:"requestId,omitempty"` +} + +// NewTokenCreateBatchResponse instantiates a new TokenCreateBatchResponse object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewTokenCreateBatchResponse() *TokenCreateBatchResponse { + this := TokenCreateBatchResponse{} + return &this +} + +// NewTokenCreateBatchResponseWithDefaults instantiates a new TokenCreateBatchResponse object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewTokenCreateBatchResponseWithDefaults() *TokenCreateBatchResponse { + this := TokenCreateBatchResponse{} + return &this +} + +// GetResultCode returns the ResultCode field value if set, zero value otherwise. +func (o *TokenCreateBatchResponse) GetResultCode() string { + if o == nil || isNil(o.ResultCode) { + var ret string + return ret + } + return *o.ResultCode +} + +// GetResultCodeOk returns a tuple with the ResultCode field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *TokenCreateBatchResponse) GetResultCodeOk() (*string, bool) { + if o == nil || isNil(o.ResultCode) { + return nil, false + } + return o.ResultCode, true +} + +// HasResultCode returns a boolean if a field has been set. +func (o *TokenCreateBatchResponse) HasResultCode() bool { + if o != nil && !isNil(o.ResultCode) { + return true + } + + return false +} + +// SetResultCode gets a reference to the given string and assigns it to the ResultCode field. +func (o *TokenCreateBatchResponse) SetResultCode(v string) { + o.ResultCode = &v +} + +// GetResultMessage returns the ResultMessage field value if set, zero value otherwise. +func (o *TokenCreateBatchResponse) GetResultMessage() string { + if o == nil || isNil(o.ResultMessage) { + var ret string + return ret + } + return *o.ResultMessage +} + +// GetResultMessageOk returns a tuple with the ResultMessage field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *TokenCreateBatchResponse) GetResultMessageOk() (*string, bool) { + if o == nil || isNil(o.ResultMessage) { + return nil, false + } + return o.ResultMessage, true +} + +// HasResultMessage returns a boolean if a field has been set. +func (o *TokenCreateBatchResponse) HasResultMessage() bool { + if o != nil && !isNil(o.ResultMessage) { + return true + } + + return false +} + +// SetResultMessage gets a reference to the given string and assigns it to the ResultMessage field. +func (o *TokenCreateBatchResponse) SetResultMessage(v string) { + o.ResultMessage = &v +} + +// GetRequestId returns the RequestId field value if set, zero value otherwise. +func (o *TokenCreateBatchResponse) GetRequestId() string { + if o == nil || isNil(o.RequestId) { + var ret string + return ret + } + return *o.RequestId +} + +// GetRequestIdOk returns a tuple with the RequestId field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *TokenCreateBatchResponse) GetRequestIdOk() (*string, bool) { + if o == nil || isNil(o.RequestId) { + return nil, false + } + return o.RequestId, true +} + +// HasRequestId returns a boolean if a field has been set. +func (o *TokenCreateBatchResponse) HasRequestId() bool { + if o != nil && !isNil(o.RequestId) { + return true + } + + return false +} + +// SetRequestId gets a reference to the given string and assigns it to the RequestId field. +func (o *TokenCreateBatchResponse) SetRequestId(v string) { + o.RequestId = &v +} + +func (o TokenCreateBatchResponse) MarshalJSON() ([]byte, error) { + toSerialize,err := o.ToMap() + if err != nil { + return []byte{}, err + } + return json.Marshal(toSerialize) +} + +func (o TokenCreateBatchResponse) ToMap() (map[string]interface{}, error) { + toSerialize := map[string]interface{}{} + if !isNil(o.ResultCode) { + toSerialize["resultCode"] = o.ResultCode + } + if !isNil(o.ResultMessage) { + toSerialize["resultMessage"] = o.ResultMessage + } + if !isNil(o.RequestId) { + toSerialize["requestId"] = o.RequestId + } + return toSerialize, nil +} + +type NullableTokenCreateBatchResponse struct { + value *TokenCreateBatchResponse + isSet bool +} + +func (v NullableTokenCreateBatchResponse) Get() *TokenCreateBatchResponse { + return v.value +} + +func (v *NullableTokenCreateBatchResponse) Set(val *TokenCreateBatchResponse) { + v.value = val + v.isSet = true +} + +func (v NullableTokenCreateBatchResponse) IsSet() bool { + return v.isSet +} + +func (v *NullableTokenCreateBatchResponse) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableTokenCreateBatchResponse(val *TokenCreateBatchResponse) *NullableTokenCreateBatchResponse { + return &NullableTokenCreateBatchResponse{value: val, isSet: true} +} + +func (v NullableTokenCreateBatchResponse) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableTokenCreateBatchResponse) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/model_token_create_batch_status_response.go b/model_token_create_batch_status_response.go new file mode 100644 index 0000000..3bc268e --- /dev/null +++ b/model_token_create_batch_status_response.go @@ -0,0 +1,200 @@ +/* +Authlete API + +Authlete API Document. + +API version: 3.0.0 +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package authlete + +import ( + "encoding/json" +) + +// checks if the TokenCreateBatchStatusResponse type satisfies the MappedNullable interface at compile time +var _ MappedNullable = &TokenCreateBatchStatusResponse{} + +// TokenCreateBatchStatusResponse struct for TokenCreateBatchStatusResponse +type TokenCreateBatchStatusResponse struct { + // The code which represents the result of the API call. + ResultCode *string `json:"resultCode,omitempty"` + // A short message which explains the result of the API call. + ResultMessage *string `json:"resultMessage,omitempty"` + Status *TokenBatchStatus `json:"status,omitempty"` +} + +// NewTokenCreateBatchStatusResponse instantiates a new TokenCreateBatchStatusResponse object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewTokenCreateBatchStatusResponse() *TokenCreateBatchStatusResponse { + this := TokenCreateBatchStatusResponse{} + return &this +} + +// NewTokenCreateBatchStatusResponseWithDefaults instantiates a new TokenCreateBatchStatusResponse object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewTokenCreateBatchStatusResponseWithDefaults() *TokenCreateBatchStatusResponse { + this := TokenCreateBatchStatusResponse{} + return &this +} + +// GetResultCode returns the ResultCode field value if set, zero value otherwise. +func (o *TokenCreateBatchStatusResponse) GetResultCode() string { + if o == nil || isNil(o.ResultCode) { + var ret string + return ret + } + return *o.ResultCode +} + +// GetResultCodeOk returns a tuple with the ResultCode field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *TokenCreateBatchStatusResponse) GetResultCodeOk() (*string, bool) { + if o == nil || isNil(o.ResultCode) { + return nil, false + } + return o.ResultCode, true +} + +// HasResultCode returns a boolean if a field has been set. +func (o *TokenCreateBatchStatusResponse) HasResultCode() bool { + if o != nil && !isNil(o.ResultCode) { + return true + } + + return false +} + +// SetResultCode gets a reference to the given string and assigns it to the ResultCode field. +func (o *TokenCreateBatchStatusResponse) SetResultCode(v string) { + o.ResultCode = &v +} + +// GetResultMessage returns the ResultMessage field value if set, zero value otherwise. +func (o *TokenCreateBatchStatusResponse) GetResultMessage() string { + if o == nil || isNil(o.ResultMessage) { + var ret string + return ret + } + return *o.ResultMessage +} + +// GetResultMessageOk returns a tuple with the ResultMessage field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *TokenCreateBatchStatusResponse) GetResultMessageOk() (*string, bool) { + if o == nil || isNil(o.ResultMessage) { + return nil, false + } + return o.ResultMessage, true +} + +// HasResultMessage returns a boolean if a field has been set. +func (o *TokenCreateBatchStatusResponse) HasResultMessage() bool { + if o != nil && !isNil(o.ResultMessage) { + return true + } + + return false +} + +// SetResultMessage gets a reference to the given string and assigns it to the ResultMessage field. +func (o *TokenCreateBatchStatusResponse) SetResultMessage(v string) { + o.ResultMessage = &v +} + +// GetStatus returns the Status field value if set, zero value otherwise. +func (o *TokenCreateBatchStatusResponse) GetStatus() TokenBatchStatus { + if o == nil || isNil(o.Status) { + var ret TokenBatchStatus + return ret + } + return *o.Status +} + +// GetStatusOk returns a tuple with the Status field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *TokenCreateBatchStatusResponse) GetStatusOk() (*TokenBatchStatus, bool) { + if o == nil || isNil(o.Status) { + return nil, false + } + return o.Status, true +} + +// HasStatus returns a boolean if a field has been set. +func (o *TokenCreateBatchStatusResponse) HasStatus() bool { + if o != nil && !isNil(o.Status) { + return true + } + + return false +} + +// SetStatus gets a reference to the given TokenBatchStatus and assigns it to the Status field. +func (o *TokenCreateBatchStatusResponse) SetStatus(v TokenBatchStatus) { + o.Status = &v +} + +func (o TokenCreateBatchStatusResponse) MarshalJSON() ([]byte, error) { + toSerialize,err := o.ToMap() + if err != nil { + return []byte{}, err + } + return json.Marshal(toSerialize) +} + +func (o TokenCreateBatchStatusResponse) ToMap() (map[string]interface{}, error) { + toSerialize := map[string]interface{}{} + if !isNil(o.ResultCode) { + toSerialize["resultCode"] = o.ResultCode + } + if !isNil(o.ResultMessage) { + toSerialize["resultMessage"] = o.ResultMessage + } + if !isNil(o.Status) { + toSerialize["status"] = o.Status + } + return toSerialize, nil +} + +type NullableTokenCreateBatchStatusResponse struct { + value *TokenCreateBatchStatusResponse + isSet bool +} + +func (v NullableTokenCreateBatchStatusResponse) Get() *TokenCreateBatchStatusResponse { + return v.value +} + +func (v *NullableTokenCreateBatchStatusResponse) Set(val *TokenCreateBatchStatusResponse) { + v.value = val + v.isSet = true +} + +func (v NullableTokenCreateBatchStatusResponse) IsSet() bool { + return v.isSet +} + +func (v *NullableTokenCreateBatchStatusResponse) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableTokenCreateBatchStatusResponse(val *TokenCreateBatchStatusResponse) *NullableTokenCreateBatchStatusResponse { + return &NullableTokenCreateBatchStatusResponse{value: val, isSet: true} +} + +func (v NullableTokenCreateBatchStatusResponse) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableTokenCreateBatchStatusResponse) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/model_token_create_request.go b/model_token_create_request.go index cc311f2..50dc74c 100644 --- a/model_token_create_request.go +++ b/model_token_create_request.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_token_create_response.go b/model_token_create_response.go index ad4e754..f2b4388 100644 --- a/model_token_create_response.go +++ b/model_token_create_response.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. @@ -48,8 +48,12 @@ type TokenCreateResponse struct { // If the authorization server is configured to issue JWT-based access tokens (= if `Service.accessTokenSignAlg` is set to a `non-null` value), a JWT-based access token is issued along with the original random-string one. JwtAccessToken *string `json:"jwtAccessToken,omitempty"` AuthorizationDetails *AuthzDetails `json:"authorizationDetails,omitempty"` - // the flag which indicates whether the access token is for an external attachment. + // the flag which indicates whether the access token is for an external attachment. ForExternalAttachment *bool `json:"forExternalAttachment,omitempty"` + // Set the unique token identifier. + TokenId *string `json:"tokenId,omitempty"` + // The scopes associated with the refresh token. May be null. + RefreshTokenScopes []string `json:"refreshTokenScopes,omitempty"` } // NewTokenCreateResponse instantiates a new TokenCreateResponse object @@ -581,6 +585,70 @@ func (o *TokenCreateResponse) SetForExternalAttachment(v bool) { o.ForExternalAttachment = &v } +// GetTokenId returns the TokenId field value if set, zero value otherwise. +func (o *TokenCreateResponse) GetTokenId() string { + if o == nil || isNil(o.TokenId) { + var ret string + return ret + } + return *o.TokenId +} + +// GetTokenIdOk returns a tuple with the TokenId field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *TokenCreateResponse) GetTokenIdOk() (*string, bool) { + if o == nil || isNil(o.TokenId) { + return nil, false + } + return o.TokenId, true +} + +// HasTokenId returns a boolean if a field has been set. +func (o *TokenCreateResponse) HasTokenId() bool { + if o != nil && !isNil(o.TokenId) { + return true + } + + return false +} + +// SetTokenId gets a reference to the given string and assigns it to the TokenId field. +func (o *TokenCreateResponse) SetTokenId(v string) { + o.TokenId = &v +} + +// GetRefreshTokenScopes returns the RefreshTokenScopes field value if set, zero value otherwise. +func (o *TokenCreateResponse) GetRefreshTokenScopes() []string { + if o == nil || isNil(o.RefreshTokenScopes) { + var ret []string + return ret + } + return o.RefreshTokenScopes +} + +// GetRefreshTokenScopesOk returns a tuple with the RefreshTokenScopes field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *TokenCreateResponse) GetRefreshTokenScopesOk() ([]string, bool) { + if o == nil || isNil(o.RefreshTokenScopes) { + return nil, false + } + return o.RefreshTokenScopes, true +} + +// HasRefreshTokenScopes returns a boolean if a field has been set. +func (o *TokenCreateResponse) HasRefreshTokenScopes() bool { + if o != nil && !isNil(o.RefreshTokenScopes) { + return true + } + + return false +} + +// SetRefreshTokenScopes gets a reference to the given []string and assigns it to the RefreshTokenScopes field. +func (o *TokenCreateResponse) SetRefreshTokenScopes(v []string) { + o.RefreshTokenScopes = v +} + func (o TokenCreateResponse) MarshalJSON() ([]byte, error) { toSerialize,err := o.ToMap() if err != nil { @@ -639,6 +707,12 @@ func (o TokenCreateResponse) ToMap() (map[string]interface{}, error) { if !isNil(o.ForExternalAttachment) { toSerialize["forExternalAttachment"] = o.ForExternalAttachment } + if !isNil(o.TokenId) { + toSerialize["tokenId"] = o.TokenId + } + if !isNil(o.RefreshTokenScopes) { + toSerialize["refreshTokenScopes"] = o.RefreshTokenScopes + } return toSerialize, nil } diff --git a/model_token_fail_request.go b/model_token_fail_request.go index 402c627..9620593 100644 --- a/model_token_fail_request.go +++ b/model_token_fail_request.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_token_fail_response.go b/model_token_fail_response.go index 90729a7..30079bb 100644 --- a/model_token_fail_response.go +++ b/model_token_fail_response.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_token_get_list_response.go b/model_token_get_list_response.go index 1f422d3..ba1c057 100644 --- a/model_token_get_list_response.go +++ b/model_token_get_list_response.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. @@ -25,7 +25,7 @@ type TokenGetListResponse struct { End *int32 `json:"end,omitempty"` // Unique ID of a client developer. TotalCount *int32 `json:"totalCount,omitempty"` - Client *Client `json:"client,omitempty"` + Client *ClientLimited `json:"client,omitempty"` // Unique user ID of an end-user. Subject *string `json:"subject,omitempty"` // An array of access tokens. @@ -146,9 +146,9 @@ func (o *TokenGetListResponse) SetTotalCount(v int32) { } // GetClient returns the Client field value if set, zero value otherwise. -func (o *TokenGetListResponse) GetClient() Client { +func (o *TokenGetListResponse) GetClient() ClientLimited { if o == nil || isNil(o.Client) { - var ret Client + var ret ClientLimited return ret } return *o.Client @@ -156,7 +156,7 @@ func (o *TokenGetListResponse) GetClient() Client { // GetClientOk returns a tuple with the Client field value if set, nil otherwise // and a boolean to check if the value has been set. -func (o *TokenGetListResponse) GetClientOk() (*Client, bool) { +func (o *TokenGetListResponse) GetClientOk() (*ClientLimited, bool) { if o == nil || isNil(o.Client) { return nil, false } @@ -172,8 +172,8 @@ func (o *TokenGetListResponse) HasClient() bool { return false } -// SetClient gets a reference to the given Client and assigns it to the Client field. -func (o *TokenGetListResponse) SetClient(v Client) { +// SetClient gets a reference to the given ClientLimited and assigns it to the Client field. +func (o *TokenGetListResponse) SetClient(v ClientLimited) { o.Client = &v } diff --git a/model_token_info.go b/model_token_info.go index 2cc10dc..2bca27b 100644 --- a/model_token_info.go +++ b/model_token_info.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_token_issue_request.go b/model_token_issue_request.go index e243b58..15bc791 100644 --- a/model_token_issue_request.go +++ b/model_token_issue_request.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_token_issue_response.go b/model_token_issue_response.go index edb9f98..da60e48 100644 --- a/model_token_issue_response.go +++ b/model_token_issue_response.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. @@ -62,8 +62,10 @@ type TokenIssueResponse struct { ClientAttributes []Pair `json:"clientAttributes,omitempty"` // The entity ID of the client. ClientEntityId *string `json:"clientEntityId,omitempty"` - // Flag which indicates whether the entity ID of the client was used when the request for the access token was made. + // Flag which indicates whether the entity ID of the client was used when the request for the access token was made. ClientEntityIdUsed *bool `json:"clientEntityIdUsed,omitempty"` + // The scopes associated with the refresh token. May be null. + RefreshTokenScopes []string `json:"refreshTokenScopes,omitempty"` } // NewTokenIssueResponse instantiates a new TokenIssueResponse object @@ -819,6 +821,38 @@ func (o *TokenIssueResponse) SetClientEntityIdUsed(v bool) { o.ClientEntityIdUsed = &v } +// GetRefreshTokenScopes returns the RefreshTokenScopes field value if set, zero value otherwise. +func (o *TokenIssueResponse) GetRefreshTokenScopes() []string { + if o == nil || isNil(o.RefreshTokenScopes) { + var ret []string + return ret + } + return o.RefreshTokenScopes +} + +// GetRefreshTokenScopesOk returns a tuple with the RefreshTokenScopes field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *TokenIssueResponse) GetRefreshTokenScopesOk() ([]string, bool) { + if o == nil || isNil(o.RefreshTokenScopes) { + return nil, false + } + return o.RefreshTokenScopes, true +} + +// HasRefreshTokenScopes returns a boolean if a field has been set. +func (o *TokenIssueResponse) HasRefreshTokenScopes() bool { + if o != nil && !isNil(o.RefreshTokenScopes) { + return true + } + + return false +} + +// SetRefreshTokenScopes gets a reference to the given []string and assigns it to the RefreshTokenScopes field. +func (o *TokenIssueResponse) SetRefreshTokenScopes(v []string) { + o.RefreshTokenScopes = v +} + func (o TokenIssueResponse) MarshalJSON() ([]byte, error) { toSerialize,err := o.ToMap() if err != nil { @@ -898,6 +932,9 @@ func (o TokenIssueResponse) ToMap() (map[string]interface{}, error) { if !isNil(o.ClientEntityIdUsed) { toSerialize["clientEntityIdUsed"] = o.ClientEntityIdUsed } + if !isNil(o.RefreshTokenScopes) { + toSerialize["refreshTokenScopes"] = o.RefreshTokenScopes + } return toSerialize, nil } diff --git a/model_token_request.go b/model_token_request.go index 0b887f1..0de801c 100644 --- a/model_token_request.go +++ b/model_token_request.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_token_response.go b/model_token_response.go index a2c9311..3d366a1 100644 --- a/model_token_response.go +++ b/model_token_response.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. @@ -72,6 +72,8 @@ type TokenResponse struct { ServiceAttributes []Pair `json:"serviceAttributes,omitempty"` // The attributes of the client. ClientAttributes []Pair `json:"clientAttributes,omitempty"` + // The client authentication method that was performed at the token endpoint. + ClientAuthMethod *string `json:"clientAuthMethod,omitempty"` // the value of the `grant_id` request parameter of the device authorization request. The `grant_id` request parameter is defined in [Grant Management for OAuth 2.0](https://openid.net/specs/fapi-grant-management.html) , which is supported by Authlete 2.3 and newer versions. GrantId *string `json:"grantId,omitempty"` // The audiences on the token exchange request @@ -89,8 +91,20 @@ type TokenResponse struct { PreviousRefreshTokenUsed *bool `json:"previousRefreshTokenUsed,omitempty"` // The entity ID of the client. ClientEntityId *string `json:"clientEntityId,omitempty"` - // Flag which indicates whether the entity ID of the client was used when the request for the access token was made. + // Flag which indicates whether the entity ID of the client was used when the request for the access token was made. ClientEntityIdUsed *bool `json:"clientEntityIdUsed,omitempty"` + // Duration of the `c_nonce` in seconds. + CnonceDuration *int64 `json:"cnonceDuration,omitempty"` + // Get the expected nonce value for DPoP proof JWT, which should be used as the value of the `DPoP-Nonce` HTTP header. + DpopNonce *string `json:"dpopNonce,omitempty"` + // Get the `c_nonce`. + Cnonce *string `json:"cnonce,omitempty"` + // Get the time at which the `c_nonce` expires in milliseconds since the Unix epoch (1970-01-01). + CnonceExpiresAt *int64 `json:"cnonceExpiresAt,omitempty"` + // Get the names of the claims that the authorization request (which resulted in generation of the access token) requested to be embedded in ID tokens. + RequestedIdTokenClaims []string `json:"requestedIdTokenClaims,omitempty"` + // Scopes associated with the refresh token. + RefreshTokenScopes []string `json:"refreshTokenScopes,omitempty"` } // NewTokenResponse instantiates a new TokenResponse object @@ -974,6 +988,38 @@ func (o *TokenResponse) SetClientAttributes(v []Pair) { o.ClientAttributes = v } +// GetClientAuthMethod returns the ClientAuthMethod field value if set, zero value otherwise. +func (o *TokenResponse) GetClientAuthMethod() string { + if o == nil || isNil(o.ClientAuthMethod) { + var ret string + return ret + } + return *o.ClientAuthMethod +} + +// GetClientAuthMethodOk returns a tuple with the ClientAuthMethod field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *TokenResponse) GetClientAuthMethodOk() (*string, bool) { + if o == nil || isNil(o.ClientAuthMethod) { + return nil, false + } + return o.ClientAuthMethod, true +} + +// HasClientAuthMethod returns a boolean if a field has been set. +func (o *TokenResponse) HasClientAuthMethod() bool { + if o != nil && !isNil(o.ClientAuthMethod) { + return true + } + + return false +} + +// SetClientAuthMethod gets a reference to the given string and assigns it to the ClientAuthMethod field. +func (o *TokenResponse) SetClientAuthMethod(v string) { + o.ClientAuthMethod = &v +} + // GetGrantId returns the GrantId field value if set, zero value otherwise. func (o *TokenResponse) GetGrantId() string { if o == nil || isNil(o.GrantId) { @@ -1390,6 +1436,198 @@ func (o *TokenResponse) SetClientEntityIdUsed(v bool) { o.ClientEntityIdUsed = &v } +// GetCnonceDuration returns the CnonceDuration field value if set, zero value otherwise. +func (o *TokenResponse) GetCnonceDuration() int64 { + if o == nil || isNil(o.CnonceDuration) { + var ret int64 + return ret + } + return *o.CnonceDuration +} + +// GetCnonceDurationOk returns a tuple with the CnonceDuration field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *TokenResponse) GetCnonceDurationOk() (*int64, bool) { + if o == nil || isNil(o.CnonceDuration) { + return nil, false + } + return o.CnonceDuration, true +} + +// HasCnonceDuration returns a boolean if a field has been set. +func (o *TokenResponse) HasCnonceDuration() bool { + if o != nil && !isNil(o.CnonceDuration) { + return true + } + + return false +} + +// SetCnonceDuration gets a reference to the given int64 and assigns it to the CnonceDuration field. +func (o *TokenResponse) SetCnonceDuration(v int64) { + o.CnonceDuration = &v +} + +// GetDpopNonce returns the DpopNonce field value if set, zero value otherwise. +func (o *TokenResponse) GetDpopNonce() string { + if o == nil || isNil(o.DpopNonce) { + var ret string + return ret + } + return *o.DpopNonce +} + +// GetDpopNonceOk returns a tuple with the DpopNonce field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *TokenResponse) GetDpopNonceOk() (*string, bool) { + if o == nil || isNil(o.DpopNonce) { + return nil, false + } + return o.DpopNonce, true +} + +// HasDpopNonce returns a boolean if a field has been set. +func (o *TokenResponse) HasDpopNonce() bool { + if o != nil && !isNil(o.DpopNonce) { + return true + } + + return false +} + +// SetDpopNonce gets a reference to the given string and assigns it to the DpopNonce field. +func (o *TokenResponse) SetDpopNonce(v string) { + o.DpopNonce = &v +} + +// GetCnonce returns the Cnonce field value if set, zero value otherwise. +func (o *TokenResponse) GetCnonce() string { + if o == nil || isNil(o.Cnonce) { + var ret string + return ret + } + return *o.Cnonce +} + +// GetCnonceOk returns a tuple with the Cnonce field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *TokenResponse) GetCnonceOk() (*string, bool) { + if o == nil || isNil(o.Cnonce) { + return nil, false + } + return o.Cnonce, true +} + +// HasCnonce returns a boolean if a field has been set. +func (o *TokenResponse) HasCnonce() bool { + if o != nil && !isNil(o.Cnonce) { + return true + } + + return false +} + +// SetCnonce gets a reference to the given string and assigns it to the Cnonce field. +func (o *TokenResponse) SetCnonce(v string) { + o.Cnonce = &v +} + +// GetCnonceExpiresAt returns the CnonceExpiresAt field value if set, zero value otherwise. +func (o *TokenResponse) GetCnonceExpiresAt() int64 { + if o == nil || isNil(o.CnonceExpiresAt) { + var ret int64 + return ret + } + return *o.CnonceExpiresAt +} + +// GetCnonceExpiresAtOk returns a tuple with the CnonceExpiresAt field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *TokenResponse) GetCnonceExpiresAtOk() (*int64, bool) { + if o == nil || isNil(o.CnonceExpiresAt) { + return nil, false + } + return o.CnonceExpiresAt, true +} + +// HasCnonceExpiresAt returns a boolean if a field has been set. +func (o *TokenResponse) HasCnonceExpiresAt() bool { + if o != nil && !isNil(o.CnonceExpiresAt) { + return true + } + + return false +} + +// SetCnonceExpiresAt gets a reference to the given int64 and assigns it to the CnonceExpiresAt field. +func (o *TokenResponse) SetCnonceExpiresAt(v int64) { + o.CnonceExpiresAt = &v +} + +// GetRequestedIdTokenClaims returns the RequestedIdTokenClaims field value if set, zero value otherwise. +func (o *TokenResponse) GetRequestedIdTokenClaims() []string { + if o == nil || isNil(o.RequestedIdTokenClaims) { + var ret []string + return ret + } + return o.RequestedIdTokenClaims +} + +// GetRequestedIdTokenClaimsOk returns a tuple with the RequestedIdTokenClaims field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *TokenResponse) GetRequestedIdTokenClaimsOk() ([]string, bool) { + if o == nil || isNil(o.RequestedIdTokenClaims) { + return nil, false + } + return o.RequestedIdTokenClaims, true +} + +// HasRequestedIdTokenClaims returns a boolean if a field has been set. +func (o *TokenResponse) HasRequestedIdTokenClaims() bool { + if o != nil && !isNil(o.RequestedIdTokenClaims) { + return true + } + + return false +} + +// SetRequestedIdTokenClaims gets a reference to the given []string and assigns it to the RequestedIdTokenClaims field. +func (o *TokenResponse) SetRequestedIdTokenClaims(v []string) { + o.RequestedIdTokenClaims = v +} + +// GetRefreshTokenScopes returns the RefreshTokenScopes field value if set, zero value otherwise. +func (o *TokenResponse) GetRefreshTokenScopes() []string { + if o == nil || isNil(o.RefreshTokenScopes) { + var ret []string + return ret + } + return o.RefreshTokenScopes +} + +// GetRefreshTokenScopesOk returns a tuple with the RefreshTokenScopes field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *TokenResponse) GetRefreshTokenScopesOk() ([]string, bool) { + if o == nil || isNil(o.RefreshTokenScopes) { + return nil, false + } + return o.RefreshTokenScopes, true +} + +// HasRefreshTokenScopes returns a boolean if a field has been set. +func (o *TokenResponse) HasRefreshTokenScopes() bool { + if o != nil && !isNil(o.RefreshTokenScopes) { + return true + } + + return false +} + +// SetRefreshTokenScopes gets a reference to the given []string and assigns it to the RefreshTokenScopes field. +func (o *TokenResponse) SetRefreshTokenScopes(v []string) { + o.RefreshTokenScopes = v +} + func (o TokenResponse) MarshalJSON() ([]byte, error) { toSerialize,err := o.ToMap() if err != nil { @@ -1481,6 +1719,9 @@ func (o TokenResponse) ToMap() (map[string]interface{}, error) { if !isNil(o.ClientAttributes) { toSerialize["clientAttributes"] = o.ClientAttributes } + if !isNil(o.ClientAuthMethod) { + toSerialize["clientAuthMethod"] = o.ClientAuthMethod + } if !isNil(o.GrantId) { toSerialize["grantId"] = o.GrantId } @@ -1520,6 +1761,24 @@ func (o TokenResponse) ToMap() (map[string]interface{}, error) { if !isNil(o.ClientEntityIdUsed) { toSerialize["clientEntityIdUsed"] = o.ClientEntityIdUsed } + if !isNil(o.CnonceDuration) { + toSerialize["cnonceDuration"] = o.CnonceDuration + } + if !isNil(o.DpopNonce) { + toSerialize["dpopNonce"] = o.DpopNonce + } + if !isNil(o.Cnonce) { + toSerialize["cnonce"] = o.Cnonce + } + if !isNil(o.CnonceExpiresAt) { + toSerialize["cnonceExpiresAt"] = o.CnonceExpiresAt + } + if !isNil(o.RequestedIdTokenClaims) { + toSerialize["requestedIdTokenClaims"] = o.RequestedIdTokenClaims + } + if !isNil(o.RefreshTokenScopes) { + toSerialize["refreshTokenScopes"] = o.RefreshTokenScopes + } return toSerialize, nil } diff --git a/model_token_revoke_request.go b/model_token_revoke_request.go index 162c038..5458771 100644 --- a/model_token_revoke_request.go +++ b/model_token_revoke_request.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_token_revoke_response.go b/model_token_revoke_response.go index e438f8b..298ef75 100644 --- a/model_token_revoke_response.go +++ b/model_token_revoke_response.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_token_type.go b/model_token_type.go index 66e55ba..a2d75cf 100644 --- a/model_token_type.go +++ b/model_token_type.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_token_update_request.go b/model_token_update_request.go index a2a9dfb..eb9c7c1 100644 --- a/model_token_update_request.go +++ b/model_token_update_request.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_token_update_response.go b/model_token_update_response.go index d8f8a6f..4384148 100644 --- a/model_token_update_response.go +++ b/model_token_update_response.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. @@ -38,7 +38,9 @@ type TokenUpdateResponse struct { TokenType *string `json:"tokenType,omitempty"` // the flag which indicates whether the access token is for an external attachment. ForExternalAttachment *bool `json:"forExternalAttachment,omitempty"` - // The date at which the refresh token will expire. + // Set the unique token identifier. + TokenId *string `json:"tokenId,omitempty"` + // The datetime at which the newly issued refresh token will expire. The value is represented in milliseconds since the Unix epoch (1970-01-01). RefreshTokenExpiresAt *int64 `json:"refreshTokenExpiresAt,omitempty"` } @@ -379,6 +381,38 @@ func (o *TokenUpdateResponse) SetForExternalAttachment(v bool) { o.ForExternalAttachment = &v } +// GetTokenId returns the TokenId field value if set, zero value otherwise. +func (o *TokenUpdateResponse) GetTokenId() string { + if o == nil || isNil(o.TokenId) { + var ret string + return ret + } + return *o.TokenId +} + +// GetTokenIdOk returns a tuple with the TokenId field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *TokenUpdateResponse) GetTokenIdOk() (*string, bool) { + if o == nil || isNil(o.TokenId) { + return nil, false + } + return o.TokenId, true +} + +// HasTokenId returns a boolean if a field has been set. +func (o *TokenUpdateResponse) HasTokenId() bool { + if o != nil && !isNil(o.TokenId) { + return true + } + + return false +} + +// SetTokenId gets a reference to the given string and assigns it to the TokenId field. +func (o *TokenUpdateResponse) SetTokenId(v string) { + o.TokenId = &v +} + // GetRefreshTokenExpiresAt returns the RefreshTokenExpiresAt field value if set, zero value otherwise. func (o *TokenUpdateResponse) GetRefreshTokenExpiresAt() int64 { if o == nil || isNil(o.RefreshTokenExpiresAt) { @@ -451,6 +485,9 @@ func (o TokenUpdateResponse) ToMap() (map[string]interface{}, error) { if !isNil(o.ForExternalAttachment) { toSerialize["forExternalAttachment"] = o.ForExternalAttachment } + if !isNil(o.TokenId) { + toSerialize["tokenId"] = o.TokenId + } if !isNil(o.RefreshTokenExpiresAt) { toSerialize["refreshTokenExpiresAt"] = o.RefreshTokenExpiresAt } diff --git a/model_trust_anchor.go b/model_trust_anchor.go index 2690410..7fa67e6 100644 --- a/model_trust_anchor.go +++ b/model_trust_anchor.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_user_code_charset.go b/model_user_code_charset.go index 3469f4d..ef4c325 100644 --- a/model_user_code_charset.go +++ b/model_user_code_charset.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_userinfo_issue_request.go b/model_userinfo_issue_request.go index ef5485f..d54654f 100644 --- a/model_userinfo_issue_request.go +++ b/model_userinfo_issue_request.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_userinfo_issue_response.go b/model_userinfo_issue_response.go index 8a71d6c..505601f 100644 --- a/model_userinfo_issue_response.go +++ b/model_userinfo_issue_response.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_userinfo_request.go b/model_userinfo_request.go index 8e1bc31..268fc24 100644 --- a/model_userinfo_request.go +++ b/model_userinfo_request.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_userinfo_response.go b/model_userinfo_response.go index 9c8daf1..06909c9 100644 --- a/model_userinfo_response.go +++ b/model_userinfo_response.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. @@ -59,8 +59,10 @@ type UserinfoResponse struct { TransformedClaims *string `json:"transformedClaims,omitempty"` // The entity ID of the client. ClientEntityId *string `json:"clientEntityId,omitempty"` - // Flag which indicates whether the entity ID of the client was used when the request for the access token was made. + // Flag which indicates whether the entity ID of the client was used when the request for the access token was made. ClientEntityIdUsed *bool `json:"clientEntityIdUsed,omitempty"` + // The expected nonce value for DPoP proof JWT, which should be used as the value of the `DPoP-Nonce` HTTP header. + DpopNonce *string `json:"dpopNonce,omitempty"` } // NewUserinfoResponse instantiates a new UserinfoResponse object @@ -752,6 +754,38 @@ func (o *UserinfoResponse) SetClientEntityIdUsed(v bool) { o.ClientEntityIdUsed = &v } +// GetDpopNonce returns the DpopNonce field value if set, zero value otherwise. +func (o *UserinfoResponse) GetDpopNonce() string { + if o == nil || isNil(o.DpopNonce) { + var ret string + return ret + } + return *o.DpopNonce +} + +// GetDpopNonceOk returns a tuple with the DpopNonce field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *UserinfoResponse) GetDpopNonceOk() (*string, bool) { + if o == nil || isNil(o.DpopNonce) { + return nil, false + } + return o.DpopNonce, true +} + +// HasDpopNonce returns a boolean if a field has been set. +func (o *UserinfoResponse) HasDpopNonce() bool { + if o != nil && !isNil(o.DpopNonce) { + return true + } + + return false +} + +// SetDpopNonce gets a reference to the given string and assigns it to the DpopNonce field. +func (o *UserinfoResponse) SetDpopNonce(v string) { + o.DpopNonce = &v +} + func (o UserinfoResponse) MarshalJSON() ([]byte, error) { toSerialize,err := o.ToMap() if err != nil { @@ -825,6 +859,9 @@ func (o UserinfoResponse) ToMap() (map[string]interface{}, error) { if !isNil(o.ClientEntityIdUsed) { toSerialize["clientEntityIdUsed"] = o.ClientEntityIdUsed } + if !isNil(o.DpopNonce) { + toSerialize["dpopNonce"] = o.DpopNonce + } return toSerialize, nil } diff --git a/model_vci_batch_issue_request.go b/model_vci_batch_issue_request.go new file mode 100644 index 0000000..53bed43 --- /dev/null +++ b/model_vci_batch_issue_request.go @@ -0,0 +1,164 @@ +/* +Authlete API + +Authlete API Document. + +API version: 3.0.0 +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package authlete + +import ( + "encoding/json" +) + +// checks if the VciBatchIssueRequest type satisfies the MappedNullable interface at compile time +var _ MappedNullable = &VciBatchIssueRequest{} + +// VciBatchIssueRequest struct for VciBatchIssueRequest +type VciBatchIssueRequest struct { + // The access token that came along with the credential request. + AccessToken *string `json:"accessToken,omitempty"` + // The instructions for issuance of credentials and/or transaction IDs. + Orders []CredentialIssuanceOrder `json:"orders,omitempty"` +} + +// NewVciBatchIssueRequest instantiates a new VciBatchIssueRequest object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewVciBatchIssueRequest() *VciBatchIssueRequest { + this := VciBatchIssueRequest{} + return &this +} + +// NewVciBatchIssueRequestWithDefaults instantiates a new VciBatchIssueRequest object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewVciBatchIssueRequestWithDefaults() *VciBatchIssueRequest { + this := VciBatchIssueRequest{} + return &this +} + +// GetAccessToken returns the AccessToken field value if set, zero value otherwise. +func (o *VciBatchIssueRequest) GetAccessToken() string { + if o == nil || isNil(o.AccessToken) { + var ret string + return ret + } + return *o.AccessToken +} + +// GetAccessTokenOk returns a tuple with the AccessToken field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciBatchIssueRequest) GetAccessTokenOk() (*string, bool) { + if o == nil || isNil(o.AccessToken) { + return nil, false + } + return o.AccessToken, true +} + +// HasAccessToken returns a boolean if a field has been set. +func (o *VciBatchIssueRequest) HasAccessToken() bool { + if o != nil && !isNil(o.AccessToken) { + return true + } + + return false +} + +// SetAccessToken gets a reference to the given string and assigns it to the AccessToken field. +func (o *VciBatchIssueRequest) SetAccessToken(v string) { + o.AccessToken = &v +} + +// GetOrders returns the Orders field value if set, zero value otherwise. +func (o *VciBatchIssueRequest) GetOrders() []CredentialIssuanceOrder { + if o == nil || isNil(o.Orders) { + var ret []CredentialIssuanceOrder + return ret + } + return o.Orders +} + +// GetOrdersOk returns a tuple with the Orders field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciBatchIssueRequest) GetOrdersOk() ([]CredentialIssuanceOrder, bool) { + if o == nil || isNil(o.Orders) { + return nil, false + } + return o.Orders, true +} + +// HasOrders returns a boolean if a field has been set. +func (o *VciBatchIssueRequest) HasOrders() bool { + if o != nil && !isNil(o.Orders) { + return true + } + + return false +} + +// SetOrders gets a reference to the given []CredentialIssuanceOrder and assigns it to the Orders field. +func (o *VciBatchIssueRequest) SetOrders(v []CredentialIssuanceOrder) { + o.Orders = v +} + +func (o VciBatchIssueRequest) MarshalJSON() ([]byte, error) { + toSerialize,err := o.ToMap() + if err != nil { + return []byte{}, err + } + return json.Marshal(toSerialize) +} + +func (o VciBatchIssueRequest) ToMap() (map[string]interface{}, error) { + toSerialize := map[string]interface{}{} + if !isNil(o.AccessToken) { + toSerialize["accessToken"] = o.AccessToken + } + if !isNil(o.Orders) { + toSerialize["orders"] = o.Orders + } + return toSerialize, nil +} + +type NullableVciBatchIssueRequest struct { + value *VciBatchIssueRequest + isSet bool +} + +func (v NullableVciBatchIssueRequest) Get() *VciBatchIssueRequest { + return v.value +} + +func (v *NullableVciBatchIssueRequest) Set(val *VciBatchIssueRequest) { + v.value = val + v.isSet = true +} + +func (v NullableVciBatchIssueRequest) IsSet() bool { + return v.isSet +} + +func (v *NullableVciBatchIssueRequest) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableVciBatchIssueRequest(val *VciBatchIssueRequest) *NullableVciBatchIssueRequest { + return &NullableVciBatchIssueRequest{value: val, isSet: true} +} + +func (v NullableVciBatchIssueRequest) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableVciBatchIssueRequest) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/model_vci_batch_issue_response.go b/model_vci_batch_issue_response.go new file mode 100644 index 0000000..077436a --- /dev/null +++ b/model_vci_batch_issue_response.go @@ -0,0 +1,238 @@ +/* +Authlete API + +Authlete API Document. + +API version: 3.0.0 +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package authlete + +import ( + "encoding/json" +) + +// checks if the VciBatchIssueResponse type satisfies the MappedNullable interface at compile time +var _ MappedNullable = &VciBatchIssueResponse{} + +// VciBatchIssueResponse struct for VciBatchIssueResponse +type VciBatchIssueResponse struct { + // The code which represents the result of the API call. + ResultCode *string `json:"resultCode,omitempty"` + // A short message which explains the result of the API call. + ResultMessage *string `json:"resultMessage,omitempty"` + // The next action that the implementation of the batch credential endpoint should take. + Action *string `json:"action,omitempty"` + // The content of the response that the implementation of the batch credential endpoint should return. + ResponseContent *string `json:"responseContent,omitempty"` +} + +// NewVciBatchIssueResponse instantiates a new VciBatchIssueResponse object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewVciBatchIssueResponse() *VciBatchIssueResponse { + this := VciBatchIssueResponse{} + return &this +} + +// NewVciBatchIssueResponseWithDefaults instantiates a new VciBatchIssueResponse object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewVciBatchIssueResponseWithDefaults() *VciBatchIssueResponse { + this := VciBatchIssueResponse{} + return &this +} + +// GetResultCode returns the ResultCode field value if set, zero value otherwise. +func (o *VciBatchIssueResponse) GetResultCode() string { + if o == nil || isNil(o.ResultCode) { + var ret string + return ret + } + return *o.ResultCode +} + +// GetResultCodeOk returns a tuple with the ResultCode field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciBatchIssueResponse) GetResultCodeOk() (*string, bool) { + if o == nil || isNil(o.ResultCode) { + return nil, false + } + return o.ResultCode, true +} + +// HasResultCode returns a boolean if a field has been set. +func (o *VciBatchIssueResponse) HasResultCode() bool { + if o != nil && !isNil(o.ResultCode) { + return true + } + + return false +} + +// SetResultCode gets a reference to the given string and assigns it to the ResultCode field. +func (o *VciBatchIssueResponse) SetResultCode(v string) { + o.ResultCode = &v +} + +// GetResultMessage returns the ResultMessage field value if set, zero value otherwise. +func (o *VciBatchIssueResponse) GetResultMessage() string { + if o == nil || isNil(o.ResultMessage) { + var ret string + return ret + } + return *o.ResultMessage +} + +// GetResultMessageOk returns a tuple with the ResultMessage field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciBatchIssueResponse) GetResultMessageOk() (*string, bool) { + if o == nil || isNil(o.ResultMessage) { + return nil, false + } + return o.ResultMessage, true +} + +// HasResultMessage returns a boolean if a field has been set. +func (o *VciBatchIssueResponse) HasResultMessage() bool { + if o != nil && !isNil(o.ResultMessage) { + return true + } + + return false +} + +// SetResultMessage gets a reference to the given string and assigns it to the ResultMessage field. +func (o *VciBatchIssueResponse) SetResultMessage(v string) { + o.ResultMessage = &v +} + +// GetAction returns the Action field value if set, zero value otherwise. +func (o *VciBatchIssueResponse) GetAction() string { + if o == nil || isNil(o.Action) { + var ret string + return ret + } + return *o.Action +} + +// GetActionOk returns a tuple with the Action field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciBatchIssueResponse) GetActionOk() (*string, bool) { + if o == nil || isNil(o.Action) { + return nil, false + } + return o.Action, true +} + +// HasAction returns a boolean if a field has been set. +func (o *VciBatchIssueResponse) HasAction() bool { + if o != nil && !isNil(o.Action) { + return true + } + + return false +} + +// SetAction gets a reference to the given string and assigns it to the Action field. +func (o *VciBatchIssueResponse) SetAction(v string) { + o.Action = &v +} + +// GetResponseContent returns the ResponseContent field value if set, zero value otherwise. +func (o *VciBatchIssueResponse) GetResponseContent() string { + if o == nil || isNil(o.ResponseContent) { + var ret string + return ret + } + return *o.ResponseContent +} + +// GetResponseContentOk returns a tuple with the ResponseContent field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciBatchIssueResponse) GetResponseContentOk() (*string, bool) { + if o == nil || isNil(o.ResponseContent) { + return nil, false + } + return o.ResponseContent, true +} + +// HasResponseContent returns a boolean if a field has been set. +func (o *VciBatchIssueResponse) HasResponseContent() bool { + if o != nil && !isNil(o.ResponseContent) { + return true + } + + return false +} + +// SetResponseContent gets a reference to the given string and assigns it to the ResponseContent field. +func (o *VciBatchIssueResponse) SetResponseContent(v string) { + o.ResponseContent = &v +} + +func (o VciBatchIssueResponse) MarshalJSON() ([]byte, error) { + toSerialize,err := o.ToMap() + if err != nil { + return []byte{}, err + } + return json.Marshal(toSerialize) +} + +func (o VciBatchIssueResponse) ToMap() (map[string]interface{}, error) { + toSerialize := map[string]interface{}{} + if !isNil(o.ResultCode) { + toSerialize["resultCode"] = o.ResultCode + } + if !isNil(o.ResultMessage) { + toSerialize["resultMessage"] = o.ResultMessage + } + if !isNil(o.Action) { + toSerialize["action"] = o.Action + } + if !isNil(o.ResponseContent) { + toSerialize["responseContent"] = o.ResponseContent + } + return toSerialize, nil +} + +type NullableVciBatchIssueResponse struct { + value *VciBatchIssueResponse + isSet bool +} + +func (v NullableVciBatchIssueResponse) Get() *VciBatchIssueResponse { + return v.value +} + +func (v *NullableVciBatchIssueResponse) Set(val *VciBatchIssueResponse) { + v.value = val + v.isSet = true +} + +func (v NullableVciBatchIssueResponse) IsSet() bool { + return v.isSet +} + +func (v *NullableVciBatchIssueResponse) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableVciBatchIssueResponse(val *VciBatchIssueResponse) *NullableVciBatchIssueResponse { + return &NullableVciBatchIssueResponse{value: val, isSet: true} +} + +func (v NullableVciBatchIssueResponse) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableVciBatchIssueResponse) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/model_vci_batch_parse_request.go b/model_vci_batch_parse_request.go new file mode 100644 index 0000000..d871b93 --- /dev/null +++ b/model_vci_batch_parse_request.go @@ -0,0 +1,164 @@ +/* +Authlete API + +Authlete API Document. + +API version: 3.0.0 +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package authlete + +import ( + "encoding/json" +) + +// checks if the VciBatchParseRequest type satisfies the MappedNullable interface at compile time +var _ MappedNullable = &VciBatchParseRequest{} + +// VciBatchParseRequest struct for VciBatchParseRequest +type VciBatchParseRequest struct { + // The access token that came along with the credential request. + AccessToken *string `json:"accessToken,omitempty"` + // The message body of the batch credential request. + RequestContent *string `json:"requestContent,omitempty"` +} + +// NewVciBatchParseRequest instantiates a new VciBatchParseRequest object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewVciBatchParseRequest() *VciBatchParseRequest { + this := VciBatchParseRequest{} + return &this +} + +// NewVciBatchParseRequestWithDefaults instantiates a new VciBatchParseRequest object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewVciBatchParseRequestWithDefaults() *VciBatchParseRequest { + this := VciBatchParseRequest{} + return &this +} + +// GetAccessToken returns the AccessToken field value if set, zero value otherwise. +func (o *VciBatchParseRequest) GetAccessToken() string { + if o == nil || isNil(o.AccessToken) { + var ret string + return ret + } + return *o.AccessToken +} + +// GetAccessTokenOk returns a tuple with the AccessToken field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciBatchParseRequest) GetAccessTokenOk() (*string, bool) { + if o == nil || isNil(o.AccessToken) { + return nil, false + } + return o.AccessToken, true +} + +// HasAccessToken returns a boolean if a field has been set. +func (o *VciBatchParseRequest) HasAccessToken() bool { + if o != nil && !isNil(o.AccessToken) { + return true + } + + return false +} + +// SetAccessToken gets a reference to the given string and assigns it to the AccessToken field. +func (o *VciBatchParseRequest) SetAccessToken(v string) { + o.AccessToken = &v +} + +// GetRequestContent returns the RequestContent field value if set, zero value otherwise. +func (o *VciBatchParseRequest) GetRequestContent() string { + if o == nil || isNil(o.RequestContent) { + var ret string + return ret + } + return *o.RequestContent +} + +// GetRequestContentOk returns a tuple with the RequestContent field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciBatchParseRequest) GetRequestContentOk() (*string, bool) { + if o == nil || isNil(o.RequestContent) { + return nil, false + } + return o.RequestContent, true +} + +// HasRequestContent returns a boolean if a field has been set. +func (o *VciBatchParseRequest) HasRequestContent() bool { + if o != nil && !isNil(o.RequestContent) { + return true + } + + return false +} + +// SetRequestContent gets a reference to the given string and assigns it to the RequestContent field. +func (o *VciBatchParseRequest) SetRequestContent(v string) { + o.RequestContent = &v +} + +func (o VciBatchParseRequest) MarshalJSON() ([]byte, error) { + toSerialize,err := o.ToMap() + if err != nil { + return []byte{}, err + } + return json.Marshal(toSerialize) +} + +func (o VciBatchParseRequest) ToMap() (map[string]interface{}, error) { + toSerialize := map[string]interface{}{} + if !isNil(o.AccessToken) { + toSerialize["accessToken"] = o.AccessToken + } + if !isNil(o.RequestContent) { + toSerialize["requestContent"] = o.RequestContent + } + return toSerialize, nil +} + +type NullableVciBatchParseRequest struct { + value *VciBatchParseRequest + isSet bool +} + +func (v NullableVciBatchParseRequest) Get() *VciBatchParseRequest { + return v.value +} + +func (v *NullableVciBatchParseRequest) Set(val *VciBatchParseRequest) { + v.value = val + v.isSet = true +} + +func (v NullableVciBatchParseRequest) IsSet() bool { + return v.isSet +} + +func (v *NullableVciBatchParseRequest) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableVciBatchParseRequest(val *VciBatchParseRequest) *NullableVciBatchParseRequest { + return &NullableVciBatchParseRequest{value: val, isSet: true} +} + +func (v NullableVciBatchParseRequest) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableVciBatchParseRequest) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/model_vci_batch_parse_response.go b/model_vci_batch_parse_response.go new file mode 100644 index 0000000..fdcb794 --- /dev/null +++ b/model_vci_batch_parse_response.go @@ -0,0 +1,275 @@ +/* +Authlete API + +Authlete API Document. + +API version: 3.0.0 +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package authlete + +import ( + "encoding/json" +) + +// checks if the VciBatchParseResponse type satisfies the MappedNullable interface at compile time +var _ MappedNullable = &VciBatchParseResponse{} + +// VciBatchParseResponse struct for VciBatchParseResponse +type VciBatchParseResponse struct { + // The code which represents the result of the API call. + ResultCode *string `json:"resultCode,omitempty"` + // A short message which explains the result of the API call. + ResultMessage *string `json:"resultMessage,omitempty"` + // The next action that the batch credential endpoint should take. + Action *string `json:"action,omitempty"` + // The content of the response to the request sender. + ResponseContent *string `json:"responseContent,omitempty"` + // Information about the credential requests in the batch credential request. + Info []CredentialRequestInfo `json:"info,omitempty"` +} + +// NewVciBatchParseResponse instantiates a new VciBatchParseResponse object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewVciBatchParseResponse() *VciBatchParseResponse { + this := VciBatchParseResponse{} + return &this +} + +// NewVciBatchParseResponseWithDefaults instantiates a new VciBatchParseResponse object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewVciBatchParseResponseWithDefaults() *VciBatchParseResponse { + this := VciBatchParseResponse{} + return &this +} + +// GetResultCode returns the ResultCode field value if set, zero value otherwise. +func (o *VciBatchParseResponse) GetResultCode() string { + if o == nil || isNil(o.ResultCode) { + var ret string + return ret + } + return *o.ResultCode +} + +// GetResultCodeOk returns a tuple with the ResultCode field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciBatchParseResponse) GetResultCodeOk() (*string, bool) { + if o == nil || isNil(o.ResultCode) { + return nil, false + } + return o.ResultCode, true +} + +// HasResultCode returns a boolean if a field has been set. +func (o *VciBatchParseResponse) HasResultCode() bool { + if o != nil && !isNil(o.ResultCode) { + return true + } + + return false +} + +// SetResultCode gets a reference to the given string and assigns it to the ResultCode field. +func (o *VciBatchParseResponse) SetResultCode(v string) { + o.ResultCode = &v +} + +// GetResultMessage returns the ResultMessage field value if set, zero value otherwise. +func (o *VciBatchParseResponse) GetResultMessage() string { + if o == nil || isNil(o.ResultMessage) { + var ret string + return ret + } + return *o.ResultMessage +} + +// GetResultMessageOk returns a tuple with the ResultMessage field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciBatchParseResponse) GetResultMessageOk() (*string, bool) { + if o == nil || isNil(o.ResultMessage) { + return nil, false + } + return o.ResultMessage, true +} + +// HasResultMessage returns a boolean if a field has been set. +func (o *VciBatchParseResponse) HasResultMessage() bool { + if o != nil && !isNil(o.ResultMessage) { + return true + } + + return false +} + +// SetResultMessage gets a reference to the given string and assigns it to the ResultMessage field. +func (o *VciBatchParseResponse) SetResultMessage(v string) { + o.ResultMessage = &v +} + +// GetAction returns the Action field value if set, zero value otherwise. +func (o *VciBatchParseResponse) GetAction() string { + if o == nil || isNil(o.Action) { + var ret string + return ret + } + return *o.Action +} + +// GetActionOk returns a tuple with the Action field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciBatchParseResponse) GetActionOk() (*string, bool) { + if o == nil || isNil(o.Action) { + return nil, false + } + return o.Action, true +} + +// HasAction returns a boolean if a field has been set. +func (o *VciBatchParseResponse) HasAction() bool { + if o != nil && !isNil(o.Action) { + return true + } + + return false +} + +// SetAction gets a reference to the given string and assigns it to the Action field. +func (o *VciBatchParseResponse) SetAction(v string) { + o.Action = &v +} + +// GetResponseContent returns the ResponseContent field value if set, zero value otherwise. +func (o *VciBatchParseResponse) GetResponseContent() string { + if o == nil || isNil(o.ResponseContent) { + var ret string + return ret + } + return *o.ResponseContent +} + +// GetResponseContentOk returns a tuple with the ResponseContent field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciBatchParseResponse) GetResponseContentOk() (*string, bool) { + if o == nil || isNil(o.ResponseContent) { + return nil, false + } + return o.ResponseContent, true +} + +// HasResponseContent returns a boolean if a field has been set. +func (o *VciBatchParseResponse) HasResponseContent() bool { + if o != nil && !isNil(o.ResponseContent) { + return true + } + + return false +} + +// SetResponseContent gets a reference to the given string and assigns it to the ResponseContent field. +func (o *VciBatchParseResponse) SetResponseContent(v string) { + o.ResponseContent = &v +} + +// GetInfo returns the Info field value if set, zero value otherwise. +func (o *VciBatchParseResponse) GetInfo() []CredentialRequestInfo { + if o == nil || isNil(o.Info) { + var ret []CredentialRequestInfo + return ret + } + return o.Info +} + +// GetInfoOk returns a tuple with the Info field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciBatchParseResponse) GetInfoOk() ([]CredentialRequestInfo, bool) { + if o == nil || isNil(o.Info) { + return nil, false + } + return o.Info, true +} + +// HasInfo returns a boolean if a field has been set. +func (o *VciBatchParseResponse) HasInfo() bool { + if o != nil && !isNil(o.Info) { + return true + } + + return false +} + +// SetInfo gets a reference to the given []CredentialRequestInfo and assigns it to the Info field. +func (o *VciBatchParseResponse) SetInfo(v []CredentialRequestInfo) { + o.Info = v +} + +func (o VciBatchParseResponse) MarshalJSON() ([]byte, error) { + toSerialize,err := o.ToMap() + if err != nil { + return []byte{}, err + } + return json.Marshal(toSerialize) +} + +func (o VciBatchParseResponse) ToMap() (map[string]interface{}, error) { + toSerialize := map[string]interface{}{} + if !isNil(o.ResultCode) { + toSerialize["resultCode"] = o.ResultCode + } + if !isNil(o.ResultMessage) { + toSerialize["resultMessage"] = o.ResultMessage + } + if !isNil(o.Action) { + toSerialize["action"] = o.Action + } + if !isNil(o.ResponseContent) { + toSerialize["responseContent"] = o.ResponseContent + } + if !isNil(o.Info) { + toSerialize["info"] = o.Info + } + return toSerialize, nil +} + +type NullableVciBatchParseResponse struct { + value *VciBatchParseResponse + isSet bool +} + +func (v NullableVciBatchParseResponse) Get() *VciBatchParseResponse { + return v.value +} + +func (v *NullableVciBatchParseResponse) Set(val *VciBatchParseResponse) { + v.value = val + v.isSet = true +} + +func (v NullableVciBatchParseResponse) IsSet() bool { + return v.isSet +} + +func (v *NullableVciBatchParseResponse) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableVciBatchParseResponse(val *VciBatchParseResponse) *NullableVciBatchParseResponse { + return &NullableVciBatchParseResponse{value: val, isSet: true} +} + +func (v NullableVciBatchParseResponse) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableVciBatchParseResponse) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/model_vci_deferred_issue_request.go b/model_vci_deferred_issue_request.go new file mode 100644 index 0000000..f371aa8 --- /dev/null +++ b/model_vci_deferred_issue_request.go @@ -0,0 +1,126 @@ +/* +Authlete API + +Authlete API Document. + +API version: 3.0.0 +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package authlete + +import ( + "encoding/json" +) + +// checks if the VciDeferredIssueRequest type satisfies the MappedNullable interface at compile time +var _ MappedNullable = &VciDeferredIssueRequest{} + +// VciDeferredIssueRequest struct for VciDeferredIssueRequest +type VciDeferredIssueRequest struct { + Order *CredentialIssuanceOrder `json:"order,omitempty"` +} + +// NewVciDeferredIssueRequest instantiates a new VciDeferredIssueRequest object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewVciDeferredIssueRequest() *VciDeferredIssueRequest { + this := VciDeferredIssueRequest{} + return &this +} + +// NewVciDeferredIssueRequestWithDefaults instantiates a new VciDeferredIssueRequest object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewVciDeferredIssueRequestWithDefaults() *VciDeferredIssueRequest { + this := VciDeferredIssueRequest{} + return &this +} + +// GetOrder returns the Order field value if set, zero value otherwise. +func (o *VciDeferredIssueRequest) GetOrder() CredentialIssuanceOrder { + if o == nil || isNil(o.Order) { + var ret CredentialIssuanceOrder + return ret + } + return *o.Order +} + +// GetOrderOk returns a tuple with the Order field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciDeferredIssueRequest) GetOrderOk() (*CredentialIssuanceOrder, bool) { + if o == nil || isNil(o.Order) { + return nil, false + } + return o.Order, true +} + +// HasOrder returns a boolean if a field has been set. +func (o *VciDeferredIssueRequest) HasOrder() bool { + if o != nil && !isNil(o.Order) { + return true + } + + return false +} + +// SetOrder gets a reference to the given CredentialIssuanceOrder and assigns it to the Order field. +func (o *VciDeferredIssueRequest) SetOrder(v CredentialIssuanceOrder) { + o.Order = &v +} + +func (o VciDeferredIssueRequest) MarshalJSON() ([]byte, error) { + toSerialize,err := o.ToMap() + if err != nil { + return []byte{}, err + } + return json.Marshal(toSerialize) +} + +func (o VciDeferredIssueRequest) ToMap() (map[string]interface{}, error) { + toSerialize := map[string]interface{}{} + if !isNil(o.Order) { + toSerialize["order"] = o.Order + } + return toSerialize, nil +} + +type NullableVciDeferredIssueRequest struct { + value *VciDeferredIssueRequest + isSet bool +} + +func (v NullableVciDeferredIssueRequest) Get() *VciDeferredIssueRequest { + return v.value +} + +func (v *NullableVciDeferredIssueRequest) Set(val *VciDeferredIssueRequest) { + v.value = val + v.isSet = true +} + +func (v NullableVciDeferredIssueRequest) IsSet() bool { + return v.isSet +} + +func (v *NullableVciDeferredIssueRequest) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableVciDeferredIssueRequest(val *VciDeferredIssueRequest) *NullableVciDeferredIssueRequest { + return &NullableVciDeferredIssueRequest{value: val, isSet: true} +} + +func (v NullableVciDeferredIssueRequest) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableVciDeferredIssueRequest) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/model_vci_deferred_issue_response.go b/model_vci_deferred_issue_response.go new file mode 100644 index 0000000..9bbef4b --- /dev/null +++ b/model_vci_deferred_issue_response.go @@ -0,0 +1,238 @@ +/* +Authlete API + +Authlete API Document. + +API version: 3.0.0 +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package authlete + +import ( + "encoding/json" +) + +// checks if the VciDeferredIssueResponse type satisfies the MappedNullable interface at compile time +var _ MappedNullable = &VciDeferredIssueResponse{} + +// VciDeferredIssueResponse struct for VciDeferredIssueResponse +type VciDeferredIssueResponse struct { + // The code which represents the result of the API call. + ResultCode *string `json:"resultCode,omitempty"` + // A short message which explains the result of the API call. + ResultMessage *string `json:"resultMessage,omitempty"` + // The next action that the implementation of the deferred credential endpoint should take. + Action *string `json:"action,omitempty"` + // The content of the response that the implementation of the deferred credential endpoint should return. + ResponseContent *string `json:"responseContent,omitempty"` +} + +// NewVciDeferredIssueResponse instantiates a new VciDeferredIssueResponse object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewVciDeferredIssueResponse() *VciDeferredIssueResponse { + this := VciDeferredIssueResponse{} + return &this +} + +// NewVciDeferredIssueResponseWithDefaults instantiates a new VciDeferredIssueResponse object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewVciDeferredIssueResponseWithDefaults() *VciDeferredIssueResponse { + this := VciDeferredIssueResponse{} + return &this +} + +// GetResultCode returns the ResultCode field value if set, zero value otherwise. +func (o *VciDeferredIssueResponse) GetResultCode() string { + if o == nil || isNil(o.ResultCode) { + var ret string + return ret + } + return *o.ResultCode +} + +// GetResultCodeOk returns a tuple with the ResultCode field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciDeferredIssueResponse) GetResultCodeOk() (*string, bool) { + if o == nil || isNil(o.ResultCode) { + return nil, false + } + return o.ResultCode, true +} + +// HasResultCode returns a boolean if a field has been set. +func (o *VciDeferredIssueResponse) HasResultCode() bool { + if o != nil && !isNil(o.ResultCode) { + return true + } + + return false +} + +// SetResultCode gets a reference to the given string and assigns it to the ResultCode field. +func (o *VciDeferredIssueResponse) SetResultCode(v string) { + o.ResultCode = &v +} + +// GetResultMessage returns the ResultMessage field value if set, zero value otherwise. +func (o *VciDeferredIssueResponse) GetResultMessage() string { + if o == nil || isNil(o.ResultMessage) { + var ret string + return ret + } + return *o.ResultMessage +} + +// GetResultMessageOk returns a tuple with the ResultMessage field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciDeferredIssueResponse) GetResultMessageOk() (*string, bool) { + if o == nil || isNil(o.ResultMessage) { + return nil, false + } + return o.ResultMessage, true +} + +// HasResultMessage returns a boolean if a field has been set. +func (o *VciDeferredIssueResponse) HasResultMessage() bool { + if o != nil && !isNil(o.ResultMessage) { + return true + } + + return false +} + +// SetResultMessage gets a reference to the given string and assigns it to the ResultMessage field. +func (o *VciDeferredIssueResponse) SetResultMessage(v string) { + o.ResultMessage = &v +} + +// GetAction returns the Action field value if set, zero value otherwise. +func (o *VciDeferredIssueResponse) GetAction() string { + if o == nil || isNil(o.Action) { + var ret string + return ret + } + return *o.Action +} + +// GetActionOk returns a tuple with the Action field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciDeferredIssueResponse) GetActionOk() (*string, bool) { + if o == nil || isNil(o.Action) { + return nil, false + } + return o.Action, true +} + +// HasAction returns a boolean if a field has been set. +func (o *VciDeferredIssueResponse) HasAction() bool { + if o != nil && !isNil(o.Action) { + return true + } + + return false +} + +// SetAction gets a reference to the given string and assigns it to the Action field. +func (o *VciDeferredIssueResponse) SetAction(v string) { + o.Action = &v +} + +// GetResponseContent returns the ResponseContent field value if set, zero value otherwise. +func (o *VciDeferredIssueResponse) GetResponseContent() string { + if o == nil || isNil(o.ResponseContent) { + var ret string + return ret + } + return *o.ResponseContent +} + +// GetResponseContentOk returns a tuple with the ResponseContent field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciDeferredIssueResponse) GetResponseContentOk() (*string, bool) { + if o == nil || isNil(o.ResponseContent) { + return nil, false + } + return o.ResponseContent, true +} + +// HasResponseContent returns a boolean if a field has been set. +func (o *VciDeferredIssueResponse) HasResponseContent() bool { + if o != nil && !isNil(o.ResponseContent) { + return true + } + + return false +} + +// SetResponseContent gets a reference to the given string and assigns it to the ResponseContent field. +func (o *VciDeferredIssueResponse) SetResponseContent(v string) { + o.ResponseContent = &v +} + +func (o VciDeferredIssueResponse) MarshalJSON() ([]byte, error) { + toSerialize,err := o.ToMap() + if err != nil { + return []byte{}, err + } + return json.Marshal(toSerialize) +} + +func (o VciDeferredIssueResponse) ToMap() (map[string]interface{}, error) { + toSerialize := map[string]interface{}{} + if !isNil(o.ResultCode) { + toSerialize["resultCode"] = o.ResultCode + } + if !isNil(o.ResultMessage) { + toSerialize["resultMessage"] = o.ResultMessage + } + if !isNil(o.Action) { + toSerialize["action"] = o.Action + } + if !isNil(o.ResponseContent) { + toSerialize["responseContent"] = o.ResponseContent + } + return toSerialize, nil +} + +type NullableVciDeferredIssueResponse struct { + value *VciDeferredIssueResponse + isSet bool +} + +func (v NullableVciDeferredIssueResponse) Get() *VciDeferredIssueResponse { + return v.value +} + +func (v *NullableVciDeferredIssueResponse) Set(val *VciDeferredIssueResponse) { + v.value = val + v.isSet = true +} + +func (v NullableVciDeferredIssueResponse) IsSet() bool { + return v.isSet +} + +func (v *NullableVciDeferredIssueResponse) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableVciDeferredIssueResponse(val *VciDeferredIssueResponse) *NullableVciDeferredIssueResponse { + return &NullableVciDeferredIssueResponse{value: val, isSet: true} +} + +func (v NullableVciDeferredIssueResponse) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableVciDeferredIssueResponse) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/model_vci_deferred_parse_request.go b/model_vci_deferred_parse_request.go new file mode 100644 index 0000000..60d0969 --- /dev/null +++ b/model_vci_deferred_parse_request.go @@ -0,0 +1,164 @@ +/* +Authlete API + +Authlete API Document. + +API version: 3.0.0 +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package authlete + +import ( + "encoding/json" +) + +// checks if the VciDeferredParseRequest type satisfies the MappedNullable interface at compile time +var _ MappedNullable = &VciDeferredParseRequest{} + +// VciDeferredParseRequest struct for VciDeferredParseRequest +type VciDeferredParseRequest struct { + // The access token that came along with the deferred credential request. + AccessToken *string `json:"accessToken,omitempty"` + // The message body of the deferred credential request. + RequestContent *string `json:"requestContent,omitempty"` +} + +// NewVciDeferredParseRequest instantiates a new VciDeferredParseRequest object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewVciDeferredParseRequest() *VciDeferredParseRequest { + this := VciDeferredParseRequest{} + return &this +} + +// NewVciDeferredParseRequestWithDefaults instantiates a new VciDeferredParseRequest object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewVciDeferredParseRequestWithDefaults() *VciDeferredParseRequest { + this := VciDeferredParseRequest{} + return &this +} + +// GetAccessToken returns the AccessToken field value if set, zero value otherwise. +func (o *VciDeferredParseRequest) GetAccessToken() string { + if o == nil || isNil(o.AccessToken) { + var ret string + return ret + } + return *o.AccessToken +} + +// GetAccessTokenOk returns a tuple with the AccessToken field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciDeferredParseRequest) GetAccessTokenOk() (*string, bool) { + if o == nil || isNil(o.AccessToken) { + return nil, false + } + return o.AccessToken, true +} + +// HasAccessToken returns a boolean if a field has been set. +func (o *VciDeferredParseRequest) HasAccessToken() bool { + if o != nil && !isNil(o.AccessToken) { + return true + } + + return false +} + +// SetAccessToken gets a reference to the given string and assigns it to the AccessToken field. +func (o *VciDeferredParseRequest) SetAccessToken(v string) { + o.AccessToken = &v +} + +// GetRequestContent returns the RequestContent field value if set, zero value otherwise. +func (o *VciDeferredParseRequest) GetRequestContent() string { + if o == nil || isNil(o.RequestContent) { + var ret string + return ret + } + return *o.RequestContent +} + +// GetRequestContentOk returns a tuple with the RequestContent field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciDeferredParseRequest) GetRequestContentOk() (*string, bool) { + if o == nil || isNil(o.RequestContent) { + return nil, false + } + return o.RequestContent, true +} + +// HasRequestContent returns a boolean if a field has been set. +func (o *VciDeferredParseRequest) HasRequestContent() bool { + if o != nil && !isNil(o.RequestContent) { + return true + } + + return false +} + +// SetRequestContent gets a reference to the given string and assigns it to the RequestContent field. +func (o *VciDeferredParseRequest) SetRequestContent(v string) { + o.RequestContent = &v +} + +func (o VciDeferredParseRequest) MarshalJSON() ([]byte, error) { + toSerialize,err := o.ToMap() + if err != nil { + return []byte{}, err + } + return json.Marshal(toSerialize) +} + +func (o VciDeferredParseRequest) ToMap() (map[string]interface{}, error) { + toSerialize := map[string]interface{}{} + if !isNil(o.AccessToken) { + toSerialize["accessToken"] = o.AccessToken + } + if !isNil(o.RequestContent) { + toSerialize["requestContent"] = o.RequestContent + } + return toSerialize, nil +} + +type NullableVciDeferredParseRequest struct { + value *VciDeferredParseRequest + isSet bool +} + +func (v NullableVciDeferredParseRequest) Get() *VciDeferredParseRequest { + return v.value +} + +func (v *NullableVciDeferredParseRequest) Set(val *VciDeferredParseRequest) { + v.value = val + v.isSet = true +} + +func (v NullableVciDeferredParseRequest) IsSet() bool { + return v.isSet +} + +func (v *NullableVciDeferredParseRequest) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableVciDeferredParseRequest(val *VciDeferredParseRequest) *NullableVciDeferredParseRequest { + return &NullableVciDeferredParseRequest{value: val, isSet: true} +} + +func (v NullableVciDeferredParseRequest) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableVciDeferredParseRequest) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/model_vci_deferred_parse_response.go b/model_vci_deferred_parse_response.go new file mode 100644 index 0000000..329d9e7 --- /dev/null +++ b/model_vci_deferred_parse_response.go @@ -0,0 +1,274 @@ +/* +Authlete API + +Authlete API Document. + +API version: 3.0.0 +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package authlete + +import ( + "encoding/json" +) + +// checks if the VciDeferredParseResponse type satisfies the MappedNullable interface at compile time +var _ MappedNullable = &VciDeferredParseResponse{} + +// VciDeferredParseResponse struct for VciDeferredParseResponse +type VciDeferredParseResponse struct { + // The code which represents the result of the API call. + ResultCode *string `json:"resultCode,omitempty"` + // A short message which explains the result of the API call. + ResultMessage *string `json:"resultMessage,omitempty"` + // The next action that the deferred credential endpoint should take. + Action *string `json:"action,omitempty"` + // The content of the response to the request sender. + ResponseContent *string `json:"responseContent,omitempty"` + Info *CredentialRequestInfo `json:"info,omitempty"` +} + +// NewVciDeferredParseResponse instantiates a new VciDeferredParseResponse object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewVciDeferredParseResponse() *VciDeferredParseResponse { + this := VciDeferredParseResponse{} + return &this +} + +// NewVciDeferredParseResponseWithDefaults instantiates a new VciDeferredParseResponse object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewVciDeferredParseResponseWithDefaults() *VciDeferredParseResponse { + this := VciDeferredParseResponse{} + return &this +} + +// GetResultCode returns the ResultCode field value if set, zero value otherwise. +func (o *VciDeferredParseResponse) GetResultCode() string { + if o == nil || isNil(o.ResultCode) { + var ret string + return ret + } + return *o.ResultCode +} + +// GetResultCodeOk returns a tuple with the ResultCode field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciDeferredParseResponse) GetResultCodeOk() (*string, bool) { + if o == nil || isNil(o.ResultCode) { + return nil, false + } + return o.ResultCode, true +} + +// HasResultCode returns a boolean if a field has been set. +func (o *VciDeferredParseResponse) HasResultCode() bool { + if o != nil && !isNil(o.ResultCode) { + return true + } + + return false +} + +// SetResultCode gets a reference to the given string and assigns it to the ResultCode field. +func (o *VciDeferredParseResponse) SetResultCode(v string) { + o.ResultCode = &v +} + +// GetResultMessage returns the ResultMessage field value if set, zero value otherwise. +func (o *VciDeferredParseResponse) GetResultMessage() string { + if o == nil || isNil(o.ResultMessage) { + var ret string + return ret + } + return *o.ResultMessage +} + +// GetResultMessageOk returns a tuple with the ResultMessage field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciDeferredParseResponse) GetResultMessageOk() (*string, bool) { + if o == nil || isNil(o.ResultMessage) { + return nil, false + } + return o.ResultMessage, true +} + +// HasResultMessage returns a boolean if a field has been set. +func (o *VciDeferredParseResponse) HasResultMessage() bool { + if o != nil && !isNil(o.ResultMessage) { + return true + } + + return false +} + +// SetResultMessage gets a reference to the given string and assigns it to the ResultMessage field. +func (o *VciDeferredParseResponse) SetResultMessage(v string) { + o.ResultMessage = &v +} + +// GetAction returns the Action field value if set, zero value otherwise. +func (o *VciDeferredParseResponse) GetAction() string { + if o == nil || isNil(o.Action) { + var ret string + return ret + } + return *o.Action +} + +// GetActionOk returns a tuple with the Action field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciDeferredParseResponse) GetActionOk() (*string, bool) { + if o == nil || isNil(o.Action) { + return nil, false + } + return o.Action, true +} + +// HasAction returns a boolean if a field has been set. +func (o *VciDeferredParseResponse) HasAction() bool { + if o != nil && !isNil(o.Action) { + return true + } + + return false +} + +// SetAction gets a reference to the given string and assigns it to the Action field. +func (o *VciDeferredParseResponse) SetAction(v string) { + o.Action = &v +} + +// GetResponseContent returns the ResponseContent field value if set, zero value otherwise. +func (o *VciDeferredParseResponse) GetResponseContent() string { + if o == nil || isNil(o.ResponseContent) { + var ret string + return ret + } + return *o.ResponseContent +} + +// GetResponseContentOk returns a tuple with the ResponseContent field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciDeferredParseResponse) GetResponseContentOk() (*string, bool) { + if o == nil || isNil(o.ResponseContent) { + return nil, false + } + return o.ResponseContent, true +} + +// HasResponseContent returns a boolean if a field has been set. +func (o *VciDeferredParseResponse) HasResponseContent() bool { + if o != nil && !isNil(o.ResponseContent) { + return true + } + + return false +} + +// SetResponseContent gets a reference to the given string and assigns it to the ResponseContent field. +func (o *VciDeferredParseResponse) SetResponseContent(v string) { + o.ResponseContent = &v +} + +// GetInfo returns the Info field value if set, zero value otherwise. +func (o *VciDeferredParseResponse) GetInfo() CredentialRequestInfo { + if o == nil || isNil(o.Info) { + var ret CredentialRequestInfo + return ret + } + return *o.Info +} + +// GetInfoOk returns a tuple with the Info field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciDeferredParseResponse) GetInfoOk() (*CredentialRequestInfo, bool) { + if o == nil || isNil(o.Info) { + return nil, false + } + return o.Info, true +} + +// HasInfo returns a boolean if a field has been set. +func (o *VciDeferredParseResponse) HasInfo() bool { + if o != nil && !isNil(o.Info) { + return true + } + + return false +} + +// SetInfo gets a reference to the given CredentialRequestInfo and assigns it to the Info field. +func (o *VciDeferredParseResponse) SetInfo(v CredentialRequestInfo) { + o.Info = &v +} + +func (o VciDeferredParseResponse) MarshalJSON() ([]byte, error) { + toSerialize,err := o.ToMap() + if err != nil { + return []byte{}, err + } + return json.Marshal(toSerialize) +} + +func (o VciDeferredParseResponse) ToMap() (map[string]interface{}, error) { + toSerialize := map[string]interface{}{} + if !isNil(o.ResultCode) { + toSerialize["resultCode"] = o.ResultCode + } + if !isNil(o.ResultMessage) { + toSerialize["resultMessage"] = o.ResultMessage + } + if !isNil(o.Action) { + toSerialize["action"] = o.Action + } + if !isNil(o.ResponseContent) { + toSerialize["responseContent"] = o.ResponseContent + } + if !isNil(o.Info) { + toSerialize["info"] = o.Info + } + return toSerialize, nil +} + +type NullableVciDeferredParseResponse struct { + value *VciDeferredParseResponse + isSet bool +} + +func (v NullableVciDeferredParseResponse) Get() *VciDeferredParseResponse { + return v.value +} + +func (v *NullableVciDeferredParseResponse) Set(val *VciDeferredParseResponse) { + v.value = val + v.isSet = true +} + +func (v NullableVciDeferredParseResponse) IsSet() bool { + return v.isSet +} + +func (v *NullableVciDeferredParseResponse) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableVciDeferredParseResponse(val *VciDeferredParseResponse) *NullableVciDeferredParseResponse { + return &NullableVciDeferredParseResponse{value: val, isSet: true} +} + +func (v NullableVciDeferredParseResponse) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableVciDeferredParseResponse) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/model_vci_jwks_request.go b/model_vci_jwks_request.go new file mode 100644 index 0000000..50507c0 --- /dev/null +++ b/model_vci_jwks_request.go @@ -0,0 +1,118 @@ +/* +Authlete API + +Authlete API Document. + +API version: 3.0.0 +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package authlete + +import ( + "encoding/json" +) + +// checks if the VciJwksRequest type satisfies the MappedNullable interface at compile time +var _ MappedNullable = &VciJwksRequest{} + +// VciJwksRequest struct for VciJwksRequest +type VciJwksRequest struct { + // The flag indicating whether the metadata is written in the pretty format or not. + Pretty bool `json:"pretty"` +} + +// NewVciJwksRequest instantiates a new VciJwksRequest object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewVciJwksRequest(pretty bool) *VciJwksRequest { + this := VciJwksRequest{} + this.Pretty = pretty + return &this +} + +// NewVciJwksRequestWithDefaults instantiates a new VciJwksRequest object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewVciJwksRequestWithDefaults() *VciJwksRequest { + this := VciJwksRequest{} + return &this +} + +// GetPretty returns the Pretty field value +func (o *VciJwksRequest) GetPretty() bool { + if o == nil { + var ret bool + return ret + } + + return o.Pretty +} + +// GetPrettyOk returns a tuple with the Pretty field value +// and a boolean to check if the value has been set. +func (o *VciJwksRequest) GetPrettyOk() (*bool, bool) { + if o == nil { + return nil, false + } + return &o.Pretty, true +} + +// SetPretty sets field value +func (o *VciJwksRequest) SetPretty(v bool) { + o.Pretty = v +} + +func (o VciJwksRequest) MarshalJSON() ([]byte, error) { + toSerialize,err := o.ToMap() + if err != nil { + return []byte{}, err + } + return json.Marshal(toSerialize) +} + +func (o VciJwksRequest) ToMap() (map[string]interface{}, error) { + toSerialize := map[string]interface{}{} + toSerialize["pretty"] = o.Pretty + return toSerialize, nil +} + +type NullableVciJwksRequest struct { + value *VciJwksRequest + isSet bool +} + +func (v NullableVciJwksRequest) Get() *VciJwksRequest { + return v.value +} + +func (v *NullableVciJwksRequest) Set(val *VciJwksRequest) { + v.value = val + v.isSet = true +} + +func (v NullableVciJwksRequest) IsSet() bool { + return v.isSet +} + +func (v *NullableVciJwksRequest) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableVciJwksRequest(val *VciJwksRequest) *NullableVciJwksRequest { + return &NullableVciJwksRequest{value: val, isSet: true} +} + +func (v NullableVciJwksRequest) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableVciJwksRequest) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/model_vci_jwks_response.go b/model_vci_jwks_response.go new file mode 100644 index 0000000..06f5882 --- /dev/null +++ b/model_vci_jwks_response.go @@ -0,0 +1,238 @@ +/* +Authlete API + +Authlete API Document. + +API version: 3.0.0 +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package authlete + +import ( + "encoding/json" +) + +// checks if the VciJwksResponse type satisfies the MappedNullable interface at compile time +var _ MappedNullable = &VciJwksResponse{} + +// VciJwksResponse struct for VciJwksResponse +type VciJwksResponse struct { + // The code which represents the result of the API call. + ResultCode *string `json:"resultCode,omitempty"` + // A short message which explains the result of the API call. + ResultMessage *string `json:"resultMessage,omitempty"` + // The next action that the implementation of the JWK Set document endpoint of the credential issuer should take after getting a response from Authlete's `/vci/jwks` API. + Action *string `json:"action,omitempty"` + // Get the content that the implementation of the credential issuer metadata endpoint should use when it constructs a response. + ResponseContent *string `json:"responseContent,omitempty"` +} + +// NewVciJwksResponse instantiates a new VciJwksResponse object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewVciJwksResponse() *VciJwksResponse { + this := VciJwksResponse{} + return &this +} + +// NewVciJwksResponseWithDefaults instantiates a new VciJwksResponse object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewVciJwksResponseWithDefaults() *VciJwksResponse { + this := VciJwksResponse{} + return &this +} + +// GetResultCode returns the ResultCode field value if set, zero value otherwise. +func (o *VciJwksResponse) GetResultCode() string { + if o == nil || isNil(o.ResultCode) { + var ret string + return ret + } + return *o.ResultCode +} + +// GetResultCodeOk returns a tuple with the ResultCode field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciJwksResponse) GetResultCodeOk() (*string, bool) { + if o == nil || isNil(o.ResultCode) { + return nil, false + } + return o.ResultCode, true +} + +// HasResultCode returns a boolean if a field has been set. +func (o *VciJwksResponse) HasResultCode() bool { + if o != nil && !isNil(o.ResultCode) { + return true + } + + return false +} + +// SetResultCode gets a reference to the given string and assigns it to the ResultCode field. +func (o *VciJwksResponse) SetResultCode(v string) { + o.ResultCode = &v +} + +// GetResultMessage returns the ResultMessage field value if set, zero value otherwise. +func (o *VciJwksResponse) GetResultMessage() string { + if o == nil || isNil(o.ResultMessage) { + var ret string + return ret + } + return *o.ResultMessage +} + +// GetResultMessageOk returns a tuple with the ResultMessage field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciJwksResponse) GetResultMessageOk() (*string, bool) { + if o == nil || isNil(o.ResultMessage) { + return nil, false + } + return o.ResultMessage, true +} + +// HasResultMessage returns a boolean if a field has been set. +func (o *VciJwksResponse) HasResultMessage() bool { + if o != nil && !isNil(o.ResultMessage) { + return true + } + + return false +} + +// SetResultMessage gets a reference to the given string and assigns it to the ResultMessage field. +func (o *VciJwksResponse) SetResultMessage(v string) { + o.ResultMessage = &v +} + +// GetAction returns the Action field value if set, zero value otherwise. +func (o *VciJwksResponse) GetAction() string { + if o == nil || isNil(o.Action) { + var ret string + return ret + } + return *o.Action +} + +// GetActionOk returns a tuple with the Action field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciJwksResponse) GetActionOk() (*string, bool) { + if o == nil || isNil(o.Action) { + return nil, false + } + return o.Action, true +} + +// HasAction returns a boolean if a field has been set. +func (o *VciJwksResponse) HasAction() bool { + if o != nil && !isNil(o.Action) { + return true + } + + return false +} + +// SetAction gets a reference to the given string and assigns it to the Action field. +func (o *VciJwksResponse) SetAction(v string) { + o.Action = &v +} + +// GetResponseContent returns the ResponseContent field value if set, zero value otherwise. +func (o *VciJwksResponse) GetResponseContent() string { + if o == nil || isNil(o.ResponseContent) { + var ret string + return ret + } + return *o.ResponseContent +} + +// GetResponseContentOk returns a tuple with the ResponseContent field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciJwksResponse) GetResponseContentOk() (*string, bool) { + if o == nil || isNil(o.ResponseContent) { + return nil, false + } + return o.ResponseContent, true +} + +// HasResponseContent returns a boolean if a field has been set. +func (o *VciJwksResponse) HasResponseContent() bool { + if o != nil && !isNil(o.ResponseContent) { + return true + } + + return false +} + +// SetResponseContent gets a reference to the given string and assigns it to the ResponseContent field. +func (o *VciJwksResponse) SetResponseContent(v string) { + o.ResponseContent = &v +} + +func (o VciJwksResponse) MarshalJSON() ([]byte, error) { + toSerialize,err := o.ToMap() + if err != nil { + return []byte{}, err + } + return json.Marshal(toSerialize) +} + +func (o VciJwksResponse) ToMap() (map[string]interface{}, error) { + toSerialize := map[string]interface{}{} + if !isNil(o.ResultCode) { + toSerialize["resultCode"] = o.ResultCode + } + if !isNil(o.ResultMessage) { + toSerialize["resultMessage"] = o.ResultMessage + } + if !isNil(o.Action) { + toSerialize["action"] = o.Action + } + if !isNil(o.ResponseContent) { + toSerialize["responseContent"] = o.ResponseContent + } + return toSerialize, nil +} + +type NullableVciJwksResponse struct { + value *VciJwksResponse + isSet bool +} + +func (v NullableVciJwksResponse) Get() *VciJwksResponse { + return v.value +} + +func (v *NullableVciJwksResponse) Set(val *VciJwksResponse) { + v.value = val + v.isSet = true +} + +func (v NullableVciJwksResponse) IsSet() bool { + return v.isSet +} + +func (v *NullableVciJwksResponse) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableVciJwksResponse(val *VciJwksResponse) *NullableVciJwksResponse { + return &NullableVciJwksResponse{value: val, isSet: true} +} + +func (v NullableVciJwksResponse) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableVciJwksResponse) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/model_vci_jwtissuer_request.go b/model_vci_jwtissuer_request.go new file mode 100644 index 0000000..a77da05 --- /dev/null +++ b/model_vci_jwtissuer_request.go @@ -0,0 +1,118 @@ +/* +Authlete API + +Authlete API Document. + +API version: 3.0.0 +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package authlete + +import ( + "encoding/json" +) + +// checks if the VciJwtissuerRequest type satisfies the MappedNullable interface at compile time +var _ MappedNullable = &VciJwtissuerRequest{} + +// VciJwtissuerRequest struct for VciJwtissuerRequest +type VciJwtissuerRequest struct { + // The flag indicating whether the metadata is written in the pretty format or not. + Pretty bool `json:"pretty"` +} + +// NewVciJwtissuerRequest instantiates a new VciJwtissuerRequest object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewVciJwtissuerRequest(pretty bool) *VciJwtissuerRequest { + this := VciJwtissuerRequest{} + this.Pretty = pretty + return &this +} + +// NewVciJwtissuerRequestWithDefaults instantiates a new VciJwtissuerRequest object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewVciJwtissuerRequestWithDefaults() *VciJwtissuerRequest { + this := VciJwtissuerRequest{} + return &this +} + +// GetPretty returns the Pretty field value +func (o *VciJwtissuerRequest) GetPretty() bool { + if o == nil { + var ret bool + return ret + } + + return o.Pretty +} + +// GetPrettyOk returns a tuple with the Pretty field value +// and a boolean to check if the value has been set. +func (o *VciJwtissuerRequest) GetPrettyOk() (*bool, bool) { + if o == nil { + return nil, false + } + return &o.Pretty, true +} + +// SetPretty sets field value +func (o *VciJwtissuerRequest) SetPretty(v bool) { + o.Pretty = v +} + +func (o VciJwtissuerRequest) MarshalJSON() ([]byte, error) { + toSerialize,err := o.ToMap() + if err != nil { + return []byte{}, err + } + return json.Marshal(toSerialize) +} + +func (o VciJwtissuerRequest) ToMap() (map[string]interface{}, error) { + toSerialize := map[string]interface{}{} + toSerialize["pretty"] = o.Pretty + return toSerialize, nil +} + +type NullableVciJwtissuerRequest struct { + value *VciJwtissuerRequest + isSet bool +} + +func (v NullableVciJwtissuerRequest) Get() *VciJwtissuerRequest { + return v.value +} + +func (v *NullableVciJwtissuerRequest) Set(val *VciJwtissuerRequest) { + v.value = val + v.isSet = true +} + +func (v NullableVciJwtissuerRequest) IsSet() bool { + return v.isSet +} + +func (v *NullableVciJwtissuerRequest) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableVciJwtissuerRequest(val *VciJwtissuerRequest) *NullableVciJwtissuerRequest { + return &NullableVciJwtissuerRequest{value: val, isSet: true} +} + +func (v NullableVciJwtissuerRequest) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableVciJwtissuerRequest) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/model_vci_jwtissuer_response.go b/model_vci_jwtissuer_response.go new file mode 100644 index 0000000..9045fff --- /dev/null +++ b/model_vci_jwtissuer_response.go @@ -0,0 +1,238 @@ +/* +Authlete API + +Authlete API Document. + +API version: 3.0.0 +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package authlete + +import ( + "encoding/json" +) + +// checks if the VciJwtissuerResponse type satisfies the MappedNullable interface at compile time +var _ MappedNullable = &VciJwtissuerResponse{} + +// VciJwtissuerResponse struct for VciJwtissuerResponse +type VciJwtissuerResponse struct { + // The code which represents the result of the API call. + ResultCode *string `json:"resultCode,omitempty"` + // A short message which explains the result of the API call. + ResultMessage *string `json:"resultMessage,omitempty"` + // The next action that the implementation of the JWT issuer metadata endpoint (`/.well-known/jwt-issuer`) should take after getting a response from Authlete's `/vci/jwtissuer` API. + Action *string `json:"action,omitempty"` + // Get the content that the implementation of the credential issuer metadata endpoint should use when it constructs a response. + ResponseContent *string `json:"responseContent,omitempty"` +} + +// NewVciJwtissuerResponse instantiates a new VciJwtissuerResponse object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewVciJwtissuerResponse() *VciJwtissuerResponse { + this := VciJwtissuerResponse{} + return &this +} + +// NewVciJwtissuerResponseWithDefaults instantiates a new VciJwtissuerResponse object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewVciJwtissuerResponseWithDefaults() *VciJwtissuerResponse { + this := VciJwtissuerResponse{} + return &this +} + +// GetResultCode returns the ResultCode field value if set, zero value otherwise. +func (o *VciJwtissuerResponse) GetResultCode() string { + if o == nil || isNil(o.ResultCode) { + var ret string + return ret + } + return *o.ResultCode +} + +// GetResultCodeOk returns a tuple with the ResultCode field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciJwtissuerResponse) GetResultCodeOk() (*string, bool) { + if o == nil || isNil(o.ResultCode) { + return nil, false + } + return o.ResultCode, true +} + +// HasResultCode returns a boolean if a field has been set. +func (o *VciJwtissuerResponse) HasResultCode() bool { + if o != nil && !isNil(o.ResultCode) { + return true + } + + return false +} + +// SetResultCode gets a reference to the given string and assigns it to the ResultCode field. +func (o *VciJwtissuerResponse) SetResultCode(v string) { + o.ResultCode = &v +} + +// GetResultMessage returns the ResultMessage field value if set, zero value otherwise. +func (o *VciJwtissuerResponse) GetResultMessage() string { + if o == nil || isNil(o.ResultMessage) { + var ret string + return ret + } + return *o.ResultMessage +} + +// GetResultMessageOk returns a tuple with the ResultMessage field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciJwtissuerResponse) GetResultMessageOk() (*string, bool) { + if o == nil || isNil(o.ResultMessage) { + return nil, false + } + return o.ResultMessage, true +} + +// HasResultMessage returns a boolean if a field has been set. +func (o *VciJwtissuerResponse) HasResultMessage() bool { + if o != nil && !isNil(o.ResultMessage) { + return true + } + + return false +} + +// SetResultMessage gets a reference to the given string and assigns it to the ResultMessage field. +func (o *VciJwtissuerResponse) SetResultMessage(v string) { + o.ResultMessage = &v +} + +// GetAction returns the Action field value if set, zero value otherwise. +func (o *VciJwtissuerResponse) GetAction() string { + if o == nil || isNil(o.Action) { + var ret string + return ret + } + return *o.Action +} + +// GetActionOk returns a tuple with the Action field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciJwtissuerResponse) GetActionOk() (*string, bool) { + if o == nil || isNil(o.Action) { + return nil, false + } + return o.Action, true +} + +// HasAction returns a boolean if a field has been set. +func (o *VciJwtissuerResponse) HasAction() bool { + if o != nil && !isNil(o.Action) { + return true + } + + return false +} + +// SetAction gets a reference to the given string and assigns it to the Action field. +func (o *VciJwtissuerResponse) SetAction(v string) { + o.Action = &v +} + +// GetResponseContent returns the ResponseContent field value if set, zero value otherwise. +func (o *VciJwtissuerResponse) GetResponseContent() string { + if o == nil || isNil(o.ResponseContent) { + var ret string + return ret + } + return *o.ResponseContent +} + +// GetResponseContentOk returns a tuple with the ResponseContent field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciJwtissuerResponse) GetResponseContentOk() (*string, bool) { + if o == nil || isNil(o.ResponseContent) { + return nil, false + } + return o.ResponseContent, true +} + +// HasResponseContent returns a boolean if a field has been set. +func (o *VciJwtissuerResponse) HasResponseContent() bool { + if o != nil && !isNil(o.ResponseContent) { + return true + } + + return false +} + +// SetResponseContent gets a reference to the given string and assigns it to the ResponseContent field. +func (o *VciJwtissuerResponse) SetResponseContent(v string) { + o.ResponseContent = &v +} + +func (o VciJwtissuerResponse) MarshalJSON() ([]byte, error) { + toSerialize,err := o.ToMap() + if err != nil { + return []byte{}, err + } + return json.Marshal(toSerialize) +} + +func (o VciJwtissuerResponse) ToMap() (map[string]interface{}, error) { + toSerialize := map[string]interface{}{} + if !isNil(o.ResultCode) { + toSerialize["resultCode"] = o.ResultCode + } + if !isNil(o.ResultMessage) { + toSerialize["resultMessage"] = o.ResultMessage + } + if !isNil(o.Action) { + toSerialize["action"] = o.Action + } + if !isNil(o.ResponseContent) { + toSerialize["responseContent"] = o.ResponseContent + } + return toSerialize, nil +} + +type NullableVciJwtissuerResponse struct { + value *VciJwtissuerResponse + isSet bool +} + +func (v NullableVciJwtissuerResponse) Get() *VciJwtissuerResponse { + return v.value +} + +func (v *NullableVciJwtissuerResponse) Set(val *VciJwtissuerResponse) { + v.value = val + v.isSet = true +} + +func (v NullableVciJwtissuerResponse) IsSet() bool { + return v.isSet +} + +func (v *NullableVciJwtissuerResponse) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableVciJwtissuerResponse(val *VciJwtissuerResponse) *NullableVciJwtissuerResponse { + return &NullableVciJwtissuerResponse{value: val, isSet: true} +} + +func (v NullableVciJwtissuerResponse) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableVciJwtissuerResponse) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/model_vci_metadata_request.go b/model_vci_metadata_request.go new file mode 100644 index 0000000..1b9a515 --- /dev/null +++ b/model_vci_metadata_request.go @@ -0,0 +1,118 @@ +/* +Authlete API + +Authlete API Document. + +API version: 3.0.0 +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package authlete + +import ( + "encoding/json" +) + +// checks if the VciMetadataRequest type satisfies the MappedNullable interface at compile time +var _ MappedNullable = &VciMetadataRequest{} + +// VciMetadataRequest struct for VciMetadataRequest +type VciMetadataRequest struct { + // The flag indicating whether the metadata is written in the pretty format or not. + Pretty bool `json:"pretty"` +} + +// NewVciMetadataRequest instantiates a new VciMetadataRequest object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewVciMetadataRequest(pretty bool) *VciMetadataRequest { + this := VciMetadataRequest{} + this.Pretty = pretty + return &this +} + +// NewVciMetadataRequestWithDefaults instantiates a new VciMetadataRequest object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewVciMetadataRequestWithDefaults() *VciMetadataRequest { + this := VciMetadataRequest{} + return &this +} + +// GetPretty returns the Pretty field value +func (o *VciMetadataRequest) GetPretty() bool { + if o == nil { + var ret bool + return ret + } + + return o.Pretty +} + +// GetPrettyOk returns a tuple with the Pretty field value +// and a boolean to check if the value has been set. +func (o *VciMetadataRequest) GetPrettyOk() (*bool, bool) { + if o == nil { + return nil, false + } + return &o.Pretty, true +} + +// SetPretty sets field value +func (o *VciMetadataRequest) SetPretty(v bool) { + o.Pretty = v +} + +func (o VciMetadataRequest) MarshalJSON() ([]byte, error) { + toSerialize,err := o.ToMap() + if err != nil { + return []byte{}, err + } + return json.Marshal(toSerialize) +} + +func (o VciMetadataRequest) ToMap() (map[string]interface{}, error) { + toSerialize := map[string]interface{}{} + toSerialize["pretty"] = o.Pretty + return toSerialize, nil +} + +type NullableVciMetadataRequest struct { + value *VciMetadataRequest + isSet bool +} + +func (v NullableVciMetadataRequest) Get() *VciMetadataRequest { + return v.value +} + +func (v *NullableVciMetadataRequest) Set(val *VciMetadataRequest) { + v.value = val + v.isSet = true +} + +func (v NullableVciMetadataRequest) IsSet() bool { + return v.isSet +} + +func (v *NullableVciMetadataRequest) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableVciMetadataRequest(val *VciMetadataRequest) *NullableVciMetadataRequest { + return &NullableVciMetadataRequest{value: val, isSet: true} +} + +func (v NullableVciMetadataRequest) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableVciMetadataRequest) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/model_vci_metadata_response.go b/model_vci_metadata_response.go new file mode 100644 index 0000000..9f731db --- /dev/null +++ b/model_vci_metadata_response.go @@ -0,0 +1,238 @@ +/* +Authlete API + +Authlete API Document. + +API version: 3.0.0 +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package authlete + +import ( + "encoding/json" +) + +// checks if the VciMetadataResponse type satisfies the MappedNullable interface at compile time +var _ MappedNullable = &VciMetadataResponse{} + +// VciMetadataResponse struct for VciMetadataResponse +type VciMetadataResponse struct { + // The code which represents the result of the API call. + ResultCode *string `json:"resultCode,omitempty"` + // A short message which explains the result of the API call. + ResultMessage *string `json:"resultMessage,omitempty"` + // The next action that the implementation of the credential issuer metadata endpoint (`/.well-known/openid-credential-issuer`) should take after getting a response from Authlete's `/vci/metadata` API. + Action *string `json:"action,omitempty"` + // Get the content that the implementation of the credential issuer metadata endpoint should use when it constructs a response. + ResponseContent *string `json:"responseContent,omitempty"` +} + +// NewVciMetadataResponse instantiates a new VciMetadataResponse object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewVciMetadataResponse() *VciMetadataResponse { + this := VciMetadataResponse{} + return &this +} + +// NewVciMetadataResponseWithDefaults instantiates a new VciMetadataResponse object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewVciMetadataResponseWithDefaults() *VciMetadataResponse { + this := VciMetadataResponse{} + return &this +} + +// GetResultCode returns the ResultCode field value if set, zero value otherwise. +func (o *VciMetadataResponse) GetResultCode() string { + if o == nil || isNil(o.ResultCode) { + var ret string + return ret + } + return *o.ResultCode +} + +// GetResultCodeOk returns a tuple with the ResultCode field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciMetadataResponse) GetResultCodeOk() (*string, bool) { + if o == nil || isNil(o.ResultCode) { + return nil, false + } + return o.ResultCode, true +} + +// HasResultCode returns a boolean if a field has been set. +func (o *VciMetadataResponse) HasResultCode() bool { + if o != nil && !isNil(o.ResultCode) { + return true + } + + return false +} + +// SetResultCode gets a reference to the given string and assigns it to the ResultCode field. +func (o *VciMetadataResponse) SetResultCode(v string) { + o.ResultCode = &v +} + +// GetResultMessage returns the ResultMessage field value if set, zero value otherwise. +func (o *VciMetadataResponse) GetResultMessage() string { + if o == nil || isNil(o.ResultMessage) { + var ret string + return ret + } + return *o.ResultMessage +} + +// GetResultMessageOk returns a tuple with the ResultMessage field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciMetadataResponse) GetResultMessageOk() (*string, bool) { + if o == nil || isNil(o.ResultMessage) { + return nil, false + } + return o.ResultMessage, true +} + +// HasResultMessage returns a boolean if a field has been set. +func (o *VciMetadataResponse) HasResultMessage() bool { + if o != nil && !isNil(o.ResultMessage) { + return true + } + + return false +} + +// SetResultMessage gets a reference to the given string and assigns it to the ResultMessage field. +func (o *VciMetadataResponse) SetResultMessage(v string) { + o.ResultMessage = &v +} + +// GetAction returns the Action field value if set, zero value otherwise. +func (o *VciMetadataResponse) GetAction() string { + if o == nil || isNil(o.Action) { + var ret string + return ret + } + return *o.Action +} + +// GetActionOk returns a tuple with the Action field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciMetadataResponse) GetActionOk() (*string, bool) { + if o == nil || isNil(o.Action) { + return nil, false + } + return o.Action, true +} + +// HasAction returns a boolean if a field has been set. +func (o *VciMetadataResponse) HasAction() bool { + if o != nil && !isNil(o.Action) { + return true + } + + return false +} + +// SetAction gets a reference to the given string and assigns it to the Action field. +func (o *VciMetadataResponse) SetAction(v string) { + o.Action = &v +} + +// GetResponseContent returns the ResponseContent field value if set, zero value otherwise. +func (o *VciMetadataResponse) GetResponseContent() string { + if o == nil || isNil(o.ResponseContent) { + var ret string + return ret + } + return *o.ResponseContent +} + +// GetResponseContentOk returns a tuple with the ResponseContent field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciMetadataResponse) GetResponseContentOk() (*string, bool) { + if o == nil || isNil(o.ResponseContent) { + return nil, false + } + return o.ResponseContent, true +} + +// HasResponseContent returns a boolean if a field has been set. +func (o *VciMetadataResponse) HasResponseContent() bool { + if o != nil && !isNil(o.ResponseContent) { + return true + } + + return false +} + +// SetResponseContent gets a reference to the given string and assigns it to the ResponseContent field. +func (o *VciMetadataResponse) SetResponseContent(v string) { + o.ResponseContent = &v +} + +func (o VciMetadataResponse) MarshalJSON() ([]byte, error) { + toSerialize,err := o.ToMap() + if err != nil { + return []byte{}, err + } + return json.Marshal(toSerialize) +} + +func (o VciMetadataResponse) ToMap() (map[string]interface{}, error) { + toSerialize := map[string]interface{}{} + if !isNil(o.ResultCode) { + toSerialize["resultCode"] = o.ResultCode + } + if !isNil(o.ResultMessage) { + toSerialize["resultMessage"] = o.ResultMessage + } + if !isNil(o.Action) { + toSerialize["action"] = o.Action + } + if !isNil(o.ResponseContent) { + toSerialize["responseContent"] = o.ResponseContent + } + return toSerialize, nil +} + +type NullableVciMetadataResponse struct { + value *VciMetadataResponse + isSet bool +} + +func (v NullableVciMetadataResponse) Get() *VciMetadataResponse { + return v.value +} + +func (v *NullableVciMetadataResponse) Set(val *VciMetadataResponse) { + v.value = val + v.isSet = true +} + +func (v NullableVciMetadataResponse) IsSet() bool { + return v.isSet +} + +func (v *NullableVciMetadataResponse) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableVciMetadataResponse(val *VciMetadataResponse) *NullableVciMetadataResponse { + return &NullableVciMetadataResponse{value: val, isSet: true} +} + +func (v NullableVciMetadataResponse) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableVciMetadataResponse) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/model_vci_offer_create_request.go b/model_vci_offer_create_request.go new file mode 100644 index 0000000..8d0945d --- /dev/null +++ b/model_vci_offer_create_request.go @@ -0,0 +1,571 @@ +/* +Authlete API + +Authlete API Document. + +API version: 3.0.0 +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package authlete + +import ( + "encoding/json" +) + +// checks if the VciOfferCreateRequest type satisfies the MappedNullable interface at compile time +var _ MappedNullable = &VciOfferCreateRequest{} + +// VciOfferCreateRequest struct for VciOfferCreateRequest +type VciOfferCreateRequest struct { + // The value of the `credentials` object in the JSON format. + Credentials *string `json:"credentials,omitempty"` + // The flag indicating whether the `authorization_code` object is included in the `grants` object. + AuthorizationCodeGrantIncluded *bool `json:"authorizationCodeGrantIncluded,omitempty"` + // The flag indicating whether the `issuer_state` property is included in the `authorization_code` object in the `grants` object. + IssuerStateIncluded *bool `json:"issuerStateIncluded,omitempty"` + // The flag to include the `urn:ietf:params:oauth:grant-type:pre-authorized_code` object in the `grants` object. + PreAuthorizedCodeGrantIncluded *bool `json:"preAuthorizedCodeGrantIncluded,omitempty"` + // The value of the `user_pin_required` property in the `urn:ietf:params:oauth:grant-type:pre-authorized_code` object in the `grants` object. + UserPinRequired *bool `json:"userPinRequired,omitempty"` + // The length of the user PIN to generate. + UserPinLength *int32 `json:"userPinLength,omitempty"` + // The subject associated with the credential offer. + Subject *string `json:"subject,omitempty"` + // The duration of the credential offer. + Duration *int64 `json:"duration,omitempty"` + // The general-purpose arbitrary string. + Context *string `json:"context,omitempty"` + // Extra properties to associate with the credential offer. + Properties []Property `json:"properties,omitempty"` + // Additional claims that are added to the payload part of the JWT access token. + JwtAtClaims *string `json:"jwtAtClaims,omitempty"` + // The time at which the user authentication was performed during the course of issuing the credential offer. + AuthTime *int64 `json:"authTime,omitempty"` + // The Authentication Context Class Reference of the user authentication performed during the course of issuing the credential offer. + Acr *string `json:"acr,omitempty"` +} + +// NewVciOfferCreateRequest instantiates a new VciOfferCreateRequest object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewVciOfferCreateRequest() *VciOfferCreateRequest { + this := VciOfferCreateRequest{} + return &this +} + +// NewVciOfferCreateRequestWithDefaults instantiates a new VciOfferCreateRequest object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewVciOfferCreateRequestWithDefaults() *VciOfferCreateRequest { + this := VciOfferCreateRequest{} + return &this +} + +// GetCredentials returns the Credentials field value if set, zero value otherwise. +func (o *VciOfferCreateRequest) GetCredentials() string { + if o == nil || isNil(o.Credentials) { + var ret string + return ret + } + return *o.Credentials +} + +// GetCredentialsOk returns a tuple with the Credentials field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciOfferCreateRequest) GetCredentialsOk() (*string, bool) { + if o == nil || isNil(o.Credentials) { + return nil, false + } + return o.Credentials, true +} + +// HasCredentials returns a boolean if a field has been set. +func (o *VciOfferCreateRequest) HasCredentials() bool { + if o != nil && !isNil(o.Credentials) { + return true + } + + return false +} + +// SetCredentials gets a reference to the given string and assigns it to the Credentials field. +func (o *VciOfferCreateRequest) SetCredentials(v string) { + o.Credentials = &v +} + +// GetAuthorizationCodeGrantIncluded returns the AuthorizationCodeGrantIncluded field value if set, zero value otherwise. +func (o *VciOfferCreateRequest) GetAuthorizationCodeGrantIncluded() bool { + if o == nil || isNil(o.AuthorizationCodeGrantIncluded) { + var ret bool + return ret + } + return *o.AuthorizationCodeGrantIncluded +} + +// GetAuthorizationCodeGrantIncludedOk returns a tuple with the AuthorizationCodeGrantIncluded field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciOfferCreateRequest) GetAuthorizationCodeGrantIncludedOk() (*bool, bool) { + if o == nil || isNil(o.AuthorizationCodeGrantIncluded) { + return nil, false + } + return o.AuthorizationCodeGrantIncluded, true +} + +// HasAuthorizationCodeGrantIncluded returns a boolean if a field has been set. +func (o *VciOfferCreateRequest) HasAuthorizationCodeGrantIncluded() bool { + if o != nil && !isNil(o.AuthorizationCodeGrantIncluded) { + return true + } + + return false +} + +// SetAuthorizationCodeGrantIncluded gets a reference to the given bool and assigns it to the AuthorizationCodeGrantIncluded field. +func (o *VciOfferCreateRequest) SetAuthorizationCodeGrantIncluded(v bool) { + o.AuthorizationCodeGrantIncluded = &v +} + +// GetIssuerStateIncluded returns the IssuerStateIncluded field value if set, zero value otherwise. +func (o *VciOfferCreateRequest) GetIssuerStateIncluded() bool { + if o == nil || isNil(o.IssuerStateIncluded) { + var ret bool + return ret + } + return *o.IssuerStateIncluded +} + +// GetIssuerStateIncludedOk returns a tuple with the IssuerStateIncluded field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciOfferCreateRequest) GetIssuerStateIncludedOk() (*bool, bool) { + if o == nil || isNil(o.IssuerStateIncluded) { + return nil, false + } + return o.IssuerStateIncluded, true +} + +// HasIssuerStateIncluded returns a boolean if a field has been set. +func (o *VciOfferCreateRequest) HasIssuerStateIncluded() bool { + if o != nil && !isNil(o.IssuerStateIncluded) { + return true + } + + return false +} + +// SetIssuerStateIncluded gets a reference to the given bool and assigns it to the IssuerStateIncluded field. +func (o *VciOfferCreateRequest) SetIssuerStateIncluded(v bool) { + o.IssuerStateIncluded = &v +} + +// GetPreAuthorizedCodeGrantIncluded returns the PreAuthorizedCodeGrantIncluded field value if set, zero value otherwise. +func (o *VciOfferCreateRequest) GetPreAuthorizedCodeGrantIncluded() bool { + if o == nil || isNil(o.PreAuthorizedCodeGrantIncluded) { + var ret bool + return ret + } + return *o.PreAuthorizedCodeGrantIncluded +} + +// GetPreAuthorizedCodeGrantIncludedOk returns a tuple with the PreAuthorizedCodeGrantIncluded field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciOfferCreateRequest) GetPreAuthorizedCodeGrantIncludedOk() (*bool, bool) { + if o == nil || isNil(o.PreAuthorizedCodeGrantIncluded) { + return nil, false + } + return o.PreAuthorizedCodeGrantIncluded, true +} + +// HasPreAuthorizedCodeGrantIncluded returns a boolean if a field has been set. +func (o *VciOfferCreateRequest) HasPreAuthorizedCodeGrantIncluded() bool { + if o != nil && !isNil(o.PreAuthorizedCodeGrantIncluded) { + return true + } + + return false +} + +// SetPreAuthorizedCodeGrantIncluded gets a reference to the given bool and assigns it to the PreAuthorizedCodeGrantIncluded field. +func (o *VciOfferCreateRequest) SetPreAuthorizedCodeGrantIncluded(v bool) { + o.PreAuthorizedCodeGrantIncluded = &v +} + +// GetUserPinRequired returns the UserPinRequired field value if set, zero value otherwise. +func (o *VciOfferCreateRequest) GetUserPinRequired() bool { + if o == nil || isNil(o.UserPinRequired) { + var ret bool + return ret + } + return *o.UserPinRequired +} + +// GetUserPinRequiredOk returns a tuple with the UserPinRequired field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciOfferCreateRequest) GetUserPinRequiredOk() (*bool, bool) { + if o == nil || isNil(o.UserPinRequired) { + return nil, false + } + return o.UserPinRequired, true +} + +// HasUserPinRequired returns a boolean if a field has been set. +func (o *VciOfferCreateRequest) HasUserPinRequired() bool { + if o != nil && !isNil(o.UserPinRequired) { + return true + } + + return false +} + +// SetUserPinRequired gets a reference to the given bool and assigns it to the UserPinRequired field. +func (o *VciOfferCreateRequest) SetUserPinRequired(v bool) { + o.UserPinRequired = &v +} + +// GetUserPinLength returns the UserPinLength field value if set, zero value otherwise. +func (o *VciOfferCreateRequest) GetUserPinLength() int32 { + if o == nil || isNil(o.UserPinLength) { + var ret int32 + return ret + } + return *o.UserPinLength +} + +// GetUserPinLengthOk returns a tuple with the UserPinLength field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciOfferCreateRequest) GetUserPinLengthOk() (*int32, bool) { + if o == nil || isNil(o.UserPinLength) { + return nil, false + } + return o.UserPinLength, true +} + +// HasUserPinLength returns a boolean if a field has been set. +func (o *VciOfferCreateRequest) HasUserPinLength() bool { + if o != nil && !isNil(o.UserPinLength) { + return true + } + + return false +} + +// SetUserPinLength gets a reference to the given int32 and assigns it to the UserPinLength field. +func (o *VciOfferCreateRequest) SetUserPinLength(v int32) { + o.UserPinLength = &v +} + +// GetSubject returns the Subject field value if set, zero value otherwise. +func (o *VciOfferCreateRequest) GetSubject() string { + if o == nil || isNil(o.Subject) { + var ret string + return ret + } + return *o.Subject +} + +// GetSubjectOk returns a tuple with the Subject field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciOfferCreateRequest) GetSubjectOk() (*string, bool) { + if o == nil || isNil(o.Subject) { + return nil, false + } + return o.Subject, true +} + +// HasSubject returns a boolean if a field has been set. +func (o *VciOfferCreateRequest) HasSubject() bool { + if o != nil && !isNil(o.Subject) { + return true + } + + return false +} + +// SetSubject gets a reference to the given string and assigns it to the Subject field. +func (o *VciOfferCreateRequest) SetSubject(v string) { + o.Subject = &v +} + +// GetDuration returns the Duration field value if set, zero value otherwise. +func (o *VciOfferCreateRequest) GetDuration() int64 { + if o == nil || isNil(o.Duration) { + var ret int64 + return ret + } + return *o.Duration +} + +// GetDurationOk returns a tuple with the Duration field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciOfferCreateRequest) GetDurationOk() (*int64, bool) { + if o == nil || isNil(o.Duration) { + return nil, false + } + return o.Duration, true +} + +// HasDuration returns a boolean if a field has been set. +func (o *VciOfferCreateRequest) HasDuration() bool { + if o != nil && !isNil(o.Duration) { + return true + } + + return false +} + +// SetDuration gets a reference to the given int64 and assigns it to the Duration field. +func (o *VciOfferCreateRequest) SetDuration(v int64) { + o.Duration = &v +} + +// GetContext returns the Context field value if set, zero value otherwise. +func (o *VciOfferCreateRequest) GetContext() string { + if o == nil || isNil(o.Context) { + var ret string + return ret + } + return *o.Context +} + +// GetContextOk returns a tuple with the Context field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciOfferCreateRequest) GetContextOk() (*string, bool) { + if o == nil || isNil(o.Context) { + return nil, false + } + return o.Context, true +} + +// HasContext returns a boolean if a field has been set. +func (o *VciOfferCreateRequest) HasContext() bool { + if o != nil && !isNil(o.Context) { + return true + } + + return false +} + +// SetContext gets a reference to the given string and assigns it to the Context field. +func (o *VciOfferCreateRequest) SetContext(v string) { + o.Context = &v +} + +// GetProperties returns the Properties field value if set, zero value otherwise. +func (o *VciOfferCreateRequest) GetProperties() []Property { + if o == nil || isNil(o.Properties) { + var ret []Property + return ret + } + return o.Properties +} + +// GetPropertiesOk returns a tuple with the Properties field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciOfferCreateRequest) GetPropertiesOk() ([]Property, bool) { + if o == nil || isNil(o.Properties) { + return nil, false + } + return o.Properties, true +} + +// HasProperties returns a boolean if a field has been set. +func (o *VciOfferCreateRequest) HasProperties() bool { + if o != nil && !isNil(o.Properties) { + return true + } + + return false +} + +// SetProperties gets a reference to the given []Property and assigns it to the Properties field. +func (o *VciOfferCreateRequest) SetProperties(v []Property) { + o.Properties = v +} + +// GetJwtAtClaims returns the JwtAtClaims field value if set, zero value otherwise. +func (o *VciOfferCreateRequest) GetJwtAtClaims() string { + if o == nil || isNil(o.JwtAtClaims) { + var ret string + return ret + } + return *o.JwtAtClaims +} + +// GetJwtAtClaimsOk returns a tuple with the JwtAtClaims field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciOfferCreateRequest) GetJwtAtClaimsOk() (*string, bool) { + if o == nil || isNil(o.JwtAtClaims) { + return nil, false + } + return o.JwtAtClaims, true +} + +// HasJwtAtClaims returns a boolean if a field has been set. +func (o *VciOfferCreateRequest) HasJwtAtClaims() bool { + if o != nil && !isNil(o.JwtAtClaims) { + return true + } + + return false +} + +// SetJwtAtClaims gets a reference to the given string and assigns it to the JwtAtClaims field. +func (o *VciOfferCreateRequest) SetJwtAtClaims(v string) { + o.JwtAtClaims = &v +} + +// GetAuthTime returns the AuthTime field value if set, zero value otherwise. +func (o *VciOfferCreateRequest) GetAuthTime() int64 { + if o == nil || isNil(o.AuthTime) { + var ret int64 + return ret + } + return *o.AuthTime +} + +// GetAuthTimeOk returns a tuple with the AuthTime field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciOfferCreateRequest) GetAuthTimeOk() (*int64, bool) { + if o == nil || isNil(o.AuthTime) { + return nil, false + } + return o.AuthTime, true +} + +// HasAuthTime returns a boolean if a field has been set. +func (o *VciOfferCreateRequest) HasAuthTime() bool { + if o != nil && !isNil(o.AuthTime) { + return true + } + + return false +} + +// SetAuthTime gets a reference to the given int64 and assigns it to the AuthTime field. +func (o *VciOfferCreateRequest) SetAuthTime(v int64) { + o.AuthTime = &v +} + +// GetAcr returns the Acr field value if set, zero value otherwise. +func (o *VciOfferCreateRequest) GetAcr() string { + if o == nil || isNil(o.Acr) { + var ret string + return ret + } + return *o.Acr +} + +// GetAcrOk returns a tuple with the Acr field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciOfferCreateRequest) GetAcrOk() (*string, bool) { + if o == nil || isNil(o.Acr) { + return nil, false + } + return o.Acr, true +} + +// HasAcr returns a boolean if a field has been set. +func (o *VciOfferCreateRequest) HasAcr() bool { + if o != nil && !isNil(o.Acr) { + return true + } + + return false +} + +// SetAcr gets a reference to the given string and assigns it to the Acr field. +func (o *VciOfferCreateRequest) SetAcr(v string) { + o.Acr = &v +} + +func (o VciOfferCreateRequest) MarshalJSON() ([]byte, error) { + toSerialize,err := o.ToMap() + if err != nil { + return []byte{}, err + } + return json.Marshal(toSerialize) +} + +func (o VciOfferCreateRequest) ToMap() (map[string]interface{}, error) { + toSerialize := map[string]interface{}{} + if !isNil(o.Credentials) { + toSerialize["credentials"] = o.Credentials + } + if !isNil(o.AuthorizationCodeGrantIncluded) { + toSerialize["authorizationCodeGrantIncluded"] = o.AuthorizationCodeGrantIncluded + } + if !isNil(o.IssuerStateIncluded) { + toSerialize["issuerStateIncluded"] = o.IssuerStateIncluded + } + if !isNil(o.PreAuthorizedCodeGrantIncluded) { + toSerialize["preAuthorizedCodeGrantIncluded"] = o.PreAuthorizedCodeGrantIncluded + } + if !isNil(o.UserPinRequired) { + toSerialize["userPinRequired"] = o.UserPinRequired + } + if !isNil(o.UserPinLength) { + toSerialize["userPinLength"] = o.UserPinLength + } + if !isNil(o.Subject) { + toSerialize["subject"] = o.Subject + } + if !isNil(o.Duration) { + toSerialize["duration"] = o.Duration + } + if !isNil(o.Context) { + toSerialize["context"] = o.Context + } + if !isNil(o.Properties) { + toSerialize["properties"] = o.Properties + } + if !isNil(o.JwtAtClaims) { + toSerialize["jwtAtClaims"] = o.JwtAtClaims + } + if !isNil(o.AuthTime) { + toSerialize["authTime"] = o.AuthTime + } + if !isNil(o.Acr) { + toSerialize["acr"] = o.Acr + } + return toSerialize, nil +} + +type NullableVciOfferCreateRequest struct { + value *VciOfferCreateRequest + isSet bool +} + +func (v NullableVciOfferCreateRequest) Get() *VciOfferCreateRequest { + return v.value +} + +func (v *NullableVciOfferCreateRequest) Set(val *VciOfferCreateRequest) { + v.value = val + v.isSet = true +} + +func (v NullableVciOfferCreateRequest) IsSet() bool { + return v.isSet +} + +func (v *NullableVciOfferCreateRequest) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableVciOfferCreateRequest(val *VciOfferCreateRequest) *NullableVciOfferCreateRequest { + return &NullableVciOfferCreateRequest{value: val, isSet: true} +} + +func (v NullableVciOfferCreateRequest) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableVciOfferCreateRequest) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/model_vci_offer_create_response.go b/model_vci_offer_create_response.go new file mode 100644 index 0000000..1365ed6 --- /dev/null +++ b/model_vci_offer_create_response.go @@ -0,0 +1,237 @@ +/* +Authlete API + +Authlete API Document. + +API version: 3.0.0 +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package authlete + +import ( + "encoding/json" +) + +// checks if the VciOfferCreateResponse type satisfies the MappedNullable interface at compile time +var _ MappedNullable = &VciOfferCreateResponse{} + +// VciOfferCreateResponse struct for VciOfferCreateResponse +type VciOfferCreateResponse struct { + // The code which represents the result of the API call. + ResultCode *string `json:"resultCode,omitempty"` + // A short message which explains the result of the API call. + ResultMessage *string `json:"resultMessage,omitempty"` + // The result of the `/vci/offer/create` API call. + Action *string `json:"action,omitempty"` + Info *CredentialOfferInfo `json:"info,omitempty"` +} + +// NewVciOfferCreateResponse instantiates a new VciOfferCreateResponse object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewVciOfferCreateResponse() *VciOfferCreateResponse { + this := VciOfferCreateResponse{} + return &this +} + +// NewVciOfferCreateResponseWithDefaults instantiates a new VciOfferCreateResponse object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewVciOfferCreateResponseWithDefaults() *VciOfferCreateResponse { + this := VciOfferCreateResponse{} + return &this +} + +// GetResultCode returns the ResultCode field value if set, zero value otherwise. +func (o *VciOfferCreateResponse) GetResultCode() string { + if o == nil || isNil(o.ResultCode) { + var ret string + return ret + } + return *o.ResultCode +} + +// GetResultCodeOk returns a tuple with the ResultCode field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciOfferCreateResponse) GetResultCodeOk() (*string, bool) { + if o == nil || isNil(o.ResultCode) { + return nil, false + } + return o.ResultCode, true +} + +// HasResultCode returns a boolean if a field has been set. +func (o *VciOfferCreateResponse) HasResultCode() bool { + if o != nil && !isNil(o.ResultCode) { + return true + } + + return false +} + +// SetResultCode gets a reference to the given string and assigns it to the ResultCode field. +func (o *VciOfferCreateResponse) SetResultCode(v string) { + o.ResultCode = &v +} + +// GetResultMessage returns the ResultMessage field value if set, zero value otherwise. +func (o *VciOfferCreateResponse) GetResultMessage() string { + if o == nil || isNil(o.ResultMessage) { + var ret string + return ret + } + return *o.ResultMessage +} + +// GetResultMessageOk returns a tuple with the ResultMessage field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciOfferCreateResponse) GetResultMessageOk() (*string, bool) { + if o == nil || isNil(o.ResultMessage) { + return nil, false + } + return o.ResultMessage, true +} + +// HasResultMessage returns a boolean if a field has been set. +func (o *VciOfferCreateResponse) HasResultMessage() bool { + if o != nil && !isNil(o.ResultMessage) { + return true + } + + return false +} + +// SetResultMessage gets a reference to the given string and assigns it to the ResultMessage field. +func (o *VciOfferCreateResponse) SetResultMessage(v string) { + o.ResultMessage = &v +} + +// GetAction returns the Action field value if set, zero value otherwise. +func (o *VciOfferCreateResponse) GetAction() string { + if o == nil || isNil(o.Action) { + var ret string + return ret + } + return *o.Action +} + +// GetActionOk returns a tuple with the Action field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciOfferCreateResponse) GetActionOk() (*string, bool) { + if o == nil || isNil(o.Action) { + return nil, false + } + return o.Action, true +} + +// HasAction returns a boolean if a field has been set. +func (o *VciOfferCreateResponse) HasAction() bool { + if o != nil && !isNil(o.Action) { + return true + } + + return false +} + +// SetAction gets a reference to the given string and assigns it to the Action field. +func (o *VciOfferCreateResponse) SetAction(v string) { + o.Action = &v +} + +// GetInfo returns the Info field value if set, zero value otherwise. +func (o *VciOfferCreateResponse) GetInfo() CredentialOfferInfo { + if o == nil || isNil(o.Info) { + var ret CredentialOfferInfo + return ret + } + return *o.Info +} + +// GetInfoOk returns a tuple with the Info field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciOfferCreateResponse) GetInfoOk() (*CredentialOfferInfo, bool) { + if o == nil || isNil(o.Info) { + return nil, false + } + return o.Info, true +} + +// HasInfo returns a boolean if a field has been set. +func (o *VciOfferCreateResponse) HasInfo() bool { + if o != nil && !isNil(o.Info) { + return true + } + + return false +} + +// SetInfo gets a reference to the given CredentialOfferInfo and assigns it to the Info field. +func (o *VciOfferCreateResponse) SetInfo(v CredentialOfferInfo) { + o.Info = &v +} + +func (o VciOfferCreateResponse) MarshalJSON() ([]byte, error) { + toSerialize,err := o.ToMap() + if err != nil { + return []byte{}, err + } + return json.Marshal(toSerialize) +} + +func (o VciOfferCreateResponse) ToMap() (map[string]interface{}, error) { + toSerialize := map[string]interface{}{} + if !isNil(o.ResultCode) { + toSerialize["resultCode"] = o.ResultCode + } + if !isNil(o.ResultMessage) { + toSerialize["resultMessage"] = o.ResultMessage + } + if !isNil(o.Action) { + toSerialize["action"] = o.Action + } + if !isNil(o.Info) { + toSerialize["info"] = o.Info + } + return toSerialize, nil +} + +type NullableVciOfferCreateResponse struct { + value *VciOfferCreateResponse + isSet bool +} + +func (v NullableVciOfferCreateResponse) Get() *VciOfferCreateResponse { + return v.value +} + +func (v *NullableVciOfferCreateResponse) Set(val *VciOfferCreateResponse) { + v.value = val + v.isSet = true +} + +func (v NullableVciOfferCreateResponse) IsSet() bool { + return v.isSet +} + +func (v *NullableVciOfferCreateResponse) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableVciOfferCreateResponse(val *VciOfferCreateResponse) *NullableVciOfferCreateResponse { + return &NullableVciOfferCreateResponse{value: val, isSet: true} +} + +func (v NullableVciOfferCreateResponse) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableVciOfferCreateResponse) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/model_vci_offer_info_request.go b/model_vci_offer_info_request.go new file mode 100644 index 0000000..42e4e5e --- /dev/null +++ b/model_vci_offer_info_request.go @@ -0,0 +1,127 @@ +/* +Authlete API + +Authlete API Document. + +API version: 3.0.0 +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package authlete + +import ( + "encoding/json" +) + +// checks if the VciOfferInfoRequest type satisfies the MappedNullable interface at compile time +var _ MappedNullable = &VciOfferInfoRequest{} + +// VciOfferInfoRequest struct for VciOfferInfoRequest +type VciOfferInfoRequest struct { + // The identifier of the credential offer. + Identifier *string `json:"identifier,omitempty"` +} + +// NewVciOfferInfoRequest instantiates a new VciOfferInfoRequest object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewVciOfferInfoRequest() *VciOfferInfoRequest { + this := VciOfferInfoRequest{} + return &this +} + +// NewVciOfferInfoRequestWithDefaults instantiates a new VciOfferInfoRequest object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewVciOfferInfoRequestWithDefaults() *VciOfferInfoRequest { + this := VciOfferInfoRequest{} + return &this +} + +// GetIdentifier returns the Identifier field value if set, zero value otherwise. +func (o *VciOfferInfoRequest) GetIdentifier() string { + if o == nil || isNil(o.Identifier) { + var ret string + return ret + } + return *o.Identifier +} + +// GetIdentifierOk returns a tuple with the Identifier field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciOfferInfoRequest) GetIdentifierOk() (*string, bool) { + if o == nil || isNil(o.Identifier) { + return nil, false + } + return o.Identifier, true +} + +// HasIdentifier returns a boolean if a field has been set. +func (o *VciOfferInfoRequest) HasIdentifier() bool { + if o != nil && !isNil(o.Identifier) { + return true + } + + return false +} + +// SetIdentifier gets a reference to the given string and assigns it to the Identifier field. +func (o *VciOfferInfoRequest) SetIdentifier(v string) { + o.Identifier = &v +} + +func (o VciOfferInfoRequest) MarshalJSON() ([]byte, error) { + toSerialize,err := o.ToMap() + if err != nil { + return []byte{}, err + } + return json.Marshal(toSerialize) +} + +func (o VciOfferInfoRequest) ToMap() (map[string]interface{}, error) { + toSerialize := map[string]interface{}{} + if !isNil(o.Identifier) { + toSerialize["identifier"] = o.Identifier + } + return toSerialize, nil +} + +type NullableVciOfferInfoRequest struct { + value *VciOfferInfoRequest + isSet bool +} + +func (v NullableVciOfferInfoRequest) Get() *VciOfferInfoRequest { + return v.value +} + +func (v *NullableVciOfferInfoRequest) Set(val *VciOfferInfoRequest) { + v.value = val + v.isSet = true +} + +func (v NullableVciOfferInfoRequest) IsSet() bool { + return v.isSet +} + +func (v *NullableVciOfferInfoRequest) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableVciOfferInfoRequest(val *VciOfferInfoRequest) *NullableVciOfferInfoRequest { + return &NullableVciOfferInfoRequest{value: val, isSet: true} +} + +func (v NullableVciOfferInfoRequest) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableVciOfferInfoRequest) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/model_vci_offer_info_response.go b/model_vci_offer_info_response.go new file mode 100644 index 0000000..6cf905e --- /dev/null +++ b/model_vci_offer_info_response.go @@ -0,0 +1,237 @@ +/* +Authlete API + +Authlete API Document. + +API version: 3.0.0 +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package authlete + +import ( + "encoding/json" +) + +// checks if the VciOfferInfoResponse type satisfies the MappedNullable interface at compile time +var _ MappedNullable = &VciOfferInfoResponse{} + +// VciOfferInfoResponse struct for VciOfferInfoResponse +type VciOfferInfoResponse struct { + // The code which represents the result of the API call. + ResultCode *string `json:"resultCode,omitempty"` + // A short message which explains the result of the API call. + ResultMessage *string `json:"resultMessage,omitempty"` + // The result of the `/vci/offer/info` API call. + Action *string `json:"action,omitempty"` + Info *CredentialOfferInfo `json:"info,omitempty"` +} + +// NewVciOfferInfoResponse instantiates a new VciOfferInfoResponse object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewVciOfferInfoResponse() *VciOfferInfoResponse { + this := VciOfferInfoResponse{} + return &this +} + +// NewVciOfferInfoResponseWithDefaults instantiates a new VciOfferInfoResponse object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewVciOfferInfoResponseWithDefaults() *VciOfferInfoResponse { + this := VciOfferInfoResponse{} + return &this +} + +// GetResultCode returns the ResultCode field value if set, zero value otherwise. +func (o *VciOfferInfoResponse) GetResultCode() string { + if o == nil || isNil(o.ResultCode) { + var ret string + return ret + } + return *o.ResultCode +} + +// GetResultCodeOk returns a tuple with the ResultCode field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciOfferInfoResponse) GetResultCodeOk() (*string, bool) { + if o == nil || isNil(o.ResultCode) { + return nil, false + } + return o.ResultCode, true +} + +// HasResultCode returns a boolean if a field has been set. +func (o *VciOfferInfoResponse) HasResultCode() bool { + if o != nil && !isNil(o.ResultCode) { + return true + } + + return false +} + +// SetResultCode gets a reference to the given string and assigns it to the ResultCode field. +func (o *VciOfferInfoResponse) SetResultCode(v string) { + o.ResultCode = &v +} + +// GetResultMessage returns the ResultMessage field value if set, zero value otherwise. +func (o *VciOfferInfoResponse) GetResultMessage() string { + if o == nil || isNil(o.ResultMessage) { + var ret string + return ret + } + return *o.ResultMessage +} + +// GetResultMessageOk returns a tuple with the ResultMessage field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciOfferInfoResponse) GetResultMessageOk() (*string, bool) { + if o == nil || isNil(o.ResultMessage) { + return nil, false + } + return o.ResultMessage, true +} + +// HasResultMessage returns a boolean if a field has been set. +func (o *VciOfferInfoResponse) HasResultMessage() bool { + if o != nil && !isNil(o.ResultMessage) { + return true + } + + return false +} + +// SetResultMessage gets a reference to the given string and assigns it to the ResultMessage field. +func (o *VciOfferInfoResponse) SetResultMessage(v string) { + o.ResultMessage = &v +} + +// GetAction returns the Action field value if set, zero value otherwise. +func (o *VciOfferInfoResponse) GetAction() string { + if o == nil || isNil(o.Action) { + var ret string + return ret + } + return *o.Action +} + +// GetActionOk returns a tuple with the Action field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciOfferInfoResponse) GetActionOk() (*string, bool) { + if o == nil || isNil(o.Action) { + return nil, false + } + return o.Action, true +} + +// HasAction returns a boolean if a field has been set. +func (o *VciOfferInfoResponse) HasAction() bool { + if o != nil && !isNil(o.Action) { + return true + } + + return false +} + +// SetAction gets a reference to the given string and assigns it to the Action field. +func (o *VciOfferInfoResponse) SetAction(v string) { + o.Action = &v +} + +// GetInfo returns the Info field value if set, zero value otherwise. +func (o *VciOfferInfoResponse) GetInfo() CredentialOfferInfo { + if o == nil || isNil(o.Info) { + var ret CredentialOfferInfo + return ret + } + return *o.Info +} + +// GetInfoOk returns a tuple with the Info field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciOfferInfoResponse) GetInfoOk() (*CredentialOfferInfo, bool) { + if o == nil || isNil(o.Info) { + return nil, false + } + return o.Info, true +} + +// HasInfo returns a boolean if a field has been set. +func (o *VciOfferInfoResponse) HasInfo() bool { + if o != nil && !isNil(o.Info) { + return true + } + + return false +} + +// SetInfo gets a reference to the given CredentialOfferInfo and assigns it to the Info field. +func (o *VciOfferInfoResponse) SetInfo(v CredentialOfferInfo) { + o.Info = &v +} + +func (o VciOfferInfoResponse) MarshalJSON() ([]byte, error) { + toSerialize,err := o.ToMap() + if err != nil { + return []byte{}, err + } + return json.Marshal(toSerialize) +} + +func (o VciOfferInfoResponse) ToMap() (map[string]interface{}, error) { + toSerialize := map[string]interface{}{} + if !isNil(o.ResultCode) { + toSerialize["resultCode"] = o.ResultCode + } + if !isNil(o.ResultMessage) { + toSerialize["resultMessage"] = o.ResultMessage + } + if !isNil(o.Action) { + toSerialize["action"] = o.Action + } + if !isNil(o.Info) { + toSerialize["info"] = o.Info + } + return toSerialize, nil +} + +type NullableVciOfferInfoResponse struct { + value *VciOfferInfoResponse + isSet bool +} + +func (v NullableVciOfferInfoResponse) Get() *VciOfferInfoResponse { + return v.value +} + +func (v *NullableVciOfferInfoResponse) Set(val *VciOfferInfoResponse) { + v.value = val + v.isSet = true +} + +func (v NullableVciOfferInfoResponse) IsSet() bool { + return v.isSet +} + +func (v *NullableVciOfferInfoResponse) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableVciOfferInfoResponse(val *VciOfferInfoResponse) *NullableVciOfferInfoResponse { + return &NullableVciOfferInfoResponse{value: val, isSet: true} +} + +func (v NullableVciOfferInfoResponse) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableVciOfferInfoResponse) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/model_vci_single_issue_request.go b/model_vci_single_issue_request.go new file mode 100644 index 0000000..620fbf4 --- /dev/null +++ b/model_vci_single_issue_request.go @@ -0,0 +1,163 @@ +/* +Authlete API + +Authlete API Document. + +API version: 3.0.0 +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package authlete + +import ( + "encoding/json" +) + +// checks if the VciSingleIssueRequest type satisfies the MappedNullable interface at compile time +var _ MappedNullable = &VciSingleIssueRequest{} + +// VciSingleIssueRequest struct for VciSingleIssueRequest +type VciSingleIssueRequest struct { + // The access token that came along with the credential request. + AccessToken *string `json:"accessToken,omitempty"` + Order *CredentialIssuanceOrder `json:"order,omitempty"` +} + +// NewVciSingleIssueRequest instantiates a new VciSingleIssueRequest object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewVciSingleIssueRequest() *VciSingleIssueRequest { + this := VciSingleIssueRequest{} + return &this +} + +// NewVciSingleIssueRequestWithDefaults instantiates a new VciSingleIssueRequest object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewVciSingleIssueRequestWithDefaults() *VciSingleIssueRequest { + this := VciSingleIssueRequest{} + return &this +} + +// GetAccessToken returns the AccessToken field value if set, zero value otherwise. +func (o *VciSingleIssueRequest) GetAccessToken() string { + if o == nil || isNil(o.AccessToken) { + var ret string + return ret + } + return *o.AccessToken +} + +// GetAccessTokenOk returns a tuple with the AccessToken field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciSingleIssueRequest) GetAccessTokenOk() (*string, bool) { + if o == nil || isNil(o.AccessToken) { + return nil, false + } + return o.AccessToken, true +} + +// HasAccessToken returns a boolean if a field has been set. +func (o *VciSingleIssueRequest) HasAccessToken() bool { + if o != nil && !isNil(o.AccessToken) { + return true + } + + return false +} + +// SetAccessToken gets a reference to the given string and assigns it to the AccessToken field. +func (o *VciSingleIssueRequest) SetAccessToken(v string) { + o.AccessToken = &v +} + +// GetOrder returns the Order field value if set, zero value otherwise. +func (o *VciSingleIssueRequest) GetOrder() CredentialIssuanceOrder { + if o == nil || isNil(o.Order) { + var ret CredentialIssuanceOrder + return ret + } + return *o.Order +} + +// GetOrderOk returns a tuple with the Order field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciSingleIssueRequest) GetOrderOk() (*CredentialIssuanceOrder, bool) { + if o == nil || isNil(o.Order) { + return nil, false + } + return o.Order, true +} + +// HasOrder returns a boolean if a field has been set. +func (o *VciSingleIssueRequest) HasOrder() bool { + if o != nil && !isNil(o.Order) { + return true + } + + return false +} + +// SetOrder gets a reference to the given CredentialIssuanceOrder and assigns it to the Order field. +func (o *VciSingleIssueRequest) SetOrder(v CredentialIssuanceOrder) { + o.Order = &v +} + +func (o VciSingleIssueRequest) MarshalJSON() ([]byte, error) { + toSerialize,err := o.ToMap() + if err != nil { + return []byte{}, err + } + return json.Marshal(toSerialize) +} + +func (o VciSingleIssueRequest) ToMap() (map[string]interface{}, error) { + toSerialize := map[string]interface{}{} + if !isNil(o.AccessToken) { + toSerialize["accessToken"] = o.AccessToken + } + if !isNil(o.Order) { + toSerialize["order"] = o.Order + } + return toSerialize, nil +} + +type NullableVciSingleIssueRequest struct { + value *VciSingleIssueRequest + isSet bool +} + +func (v NullableVciSingleIssueRequest) Get() *VciSingleIssueRequest { + return v.value +} + +func (v *NullableVciSingleIssueRequest) Set(val *VciSingleIssueRequest) { + v.value = val + v.isSet = true +} + +func (v NullableVciSingleIssueRequest) IsSet() bool { + return v.isSet +} + +func (v *NullableVciSingleIssueRequest) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableVciSingleIssueRequest(val *VciSingleIssueRequest) *NullableVciSingleIssueRequest { + return &NullableVciSingleIssueRequest{value: val, isSet: true} +} + +func (v NullableVciSingleIssueRequest) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableVciSingleIssueRequest) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/model_vci_single_issue_response.go b/model_vci_single_issue_response.go new file mode 100644 index 0000000..2e7e1d9 --- /dev/null +++ b/model_vci_single_issue_response.go @@ -0,0 +1,275 @@ +/* +Authlete API + +Authlete API Document. + +API version: 3.0.0 +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package authlete + +import ( + "encoding/json" +) + +// checks if the VciSingleIssueResponse type satisfies the MappedNullable interface at compile time +var _ MappedNullable = &VciSingleIssueResponse{} + +// VciSingleIssueResponse struct for VciSingleIssueResponse +type VciSingleIssueResponse struct { + // The code which represents the result of the API call. + ResultCode *string `json:"resultCode,omitempty"` + // A short message which explains the result of the API call. + ResultMessage *string `json:"resultMessage,omitempty"` + // The next action that the implementation of the credential endpoint should take. + Action *string `json:"action,omitempty"` + // The content of the response that the implementation of the credential endpoint should return. + ResponseContent *string `json:"responseContent,omitempty"` + // The issued transaction ID. + TransactionId *string `json:"transactionId,omitempty"` +} + +// NewVciSingleIssueResponse instantiates a new VciSingleIssueResponse object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewVciSingleIssueResponse() *VciSingleIssueResponse { + this := VciSingleIssueResponse{} + return &this +} + +// NewVciSingleIssueResponseWithDefaults instantiates a new VciSingleIssueResponse object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewVciSingleIssueResponseWithDefaults() *VciSingleIssueResponse { + this := VciSingleIssueResponse{} + return &this +} + +// GetResultCode returns the ResultCode field value if set, zero value otherwise. +func (o *VciSingleIssueResponse) GetResultCode() string { + if o == nil || isNil(o.ResultCode) { + var ret string + return ret + } + return *o.ResultCode +} + +// GetResultCodeOk returns a tuple with the ResultCode field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciSingleIssueResponse) GetResultCodeOk() (*string, bool) { + if o == nil || isNil(o.ResultCode) { + return nil, false + } + return o.ResultCode, true +} + +// HasResultCode returns a boolean if a field has been set. +func (o *VciSingleIssueResponse) HasResultCode() bool { + if o != nil && !isNil(o.ResultCode) { + return true + } + + return false +} + +// SetResultCode gets a reference to the given string and assigns it to the ResultCode field. +func (o *VciSingleIssueResponse) SetResultCode(v string) { + o.ResultCode = &v +} + +// GetResultMessage returns the ResultMessage field value if set, zero value otherwise. +func (o *VciSingleIssueResponse) GetResultMessage() string { + if o == nil || isNil(o.ResultMessage) { + var ret string + return ret + } + return *o.ResultMessage +} + +// GetResultMessageOk returns a tuple with the ResultMessage field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciSingleIssueResponse) GetResultMessageOk() (*string, bool) { + if o == nil || isNil(o.ResultMessage) { + return nil, false + } + return o.ResultMessage, true +} + +// HasResultMessage returns a boolean if a field has been set. +func (o *VciSingleIssueResponse) HasResultMessage() bool { + if o != nil && !isNil(o.ResultMessage) { + return true + } + + return false +} + +// SetResultMessage gets a reference to the given string and assigns it to the ResultMessage field. +func (o *VciSingleIssueResponse) SetResultMessage(v string) { + o.ResultMessage = &v +} + +// GetAction returns the Action field value if set, zero value otherwise. +func (o *VciSingleIssueResponse) GetAction() string { + if o == nil || isNil(o.Action) { + var ret string + return ret + } + return *o.Action +} + +// GetActionOk returns a tuple with the Action field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciSingleIssueResponse) GetActionOk() (*string, bool) { + if o == nil || isNil(o.Action) { + return nil, false + } + return o.Action, true +} + +// HasAction returns a boolean if a field has been set. +func (o *VciSingleIssueResponse) HasAction() bool { + if o != nil && !isNil(o.Action) { + return true + } + + return false +} + +// SetAction gets a reference to the given string and assigns it to the Action field. +func (o *VciSingleIssueResponse) SetAction(v string) { + o.Action = &v +} + +// GetResponseContent returns the ResponseContent field value if set, zero value otherwise. +func (o *VciSingleIssueResponse) GetResponseContent() string { + if o == nil || isNil(o.ResponseContent) { + var ret string + return ret + } + return *o.ResponseContent +} + +// GetResponseContentOk returns a tuple with the ResponseContent field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciSingleIssueResponse) GetResponseContentOk() (*string, bool) { + if o == nil || isNil(o.ResponseContent) { + return nil, false + } + return o.ResponseContent, true +} + +// HasResponseContent returns a boolean if a field has been set. +func (o *VciSingleIssueResponse) HasResponseContent() bool { + if o != nil && !isNil(o.ResponseContent) { + return true + } + + return false +} + +// SetResponseContent gets a reference to the given string and assigns it to the ResponseContent field. +func (o *VciSingleIssueResponse) SetResponseContent(v string) { + o.ResponseContent = &v +} + +// GetTransactionId returns the TransactionId field value if set, zero value otherwise. +func (o *VciSingleIssueResponse) GetTransactionId() string { + if o == nil || isNil(o.TransactionId) { + var ret string + return ret + } + return *o.TransactionId +} + +// GetTransactionIdOk returns a tuple with the TransactionId field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciSingleIssueResponse) GetTransactionIdOk() (*string, bool) { + if o == nil || isNil(o.TransactionId) { + return nil, false + } + return o.TransactionId, true +} + +// HasTransactionId returns a boolean if a field has been set. +func (o *VciSingleIssueResponse) HasTransactionId() bool { + if o != nil && !isNil(o.TransactionId) { + return true + } + + return false +} + +// SetTransactionId gets a reference to the given string and assigns it to the TransactionId field. +func (o *VciSingleIssueResponse) SetTransactionId(v string) { + o.TransactionId = &v +} + +func (o VciSingleIssueResponse) MarshalJSON() ([]byte, error) { + toSerialize,err := o.ToMap() + if err != nil { + return []byte{}, err + } + return json.Marshal(toSerialize) +} + +func (o VciSingleIssueResponse) ToMap() (map[string]interface{}, error) { + toSerialize := map[string]interface{}{} + if !isNil(o.ResultCode) { + toSerialize["resultCode"] = o.ResultCode + } + if !isNil(o.ResultMessage) { + toSerialize["resultMessage"] = o.ResultMessage + } + if !isNil(o.Action) { + toSerialize["action"] = o.Action + } + if !isNil(o.ResponseContent) { + toSerialize["responseContent"] = o.ResponseContent + } + if !isNil(o.TransactionId) { + toSerialize["transactionId"] = o.TransactionId + } + return toSerialize, nil +} + +type NullableVciSingleIssueResponse struct { + value *VciSingleIssueResponse + isSet bool +} + +func (v NullableVciSingleIssueResponse) Get() *VciSingleIssueResponse { + return v.value +} + +func (v *NullableVciSingleIssueResponse) Set(val *VciSingleIssueResponse) { + v.value = val + v.isSet = true +} + +func (v NullableVciSingleIssueResponse) IsSet() bool { + return v.isSet +} + +func (v *NullableVciSingleIssueResponse) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableVciSingleIssueResponse(val *VciSingleIssueResponse) *NullableVciSingleIssueResponse { + return &NullableVciSingleIssueResponse{value: val, isSet: true} +} + +func (v NullableVciSingleIssueResponse) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableVciSingleIssueResponse) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/model_vci_single_parse_request.go b/model_vci_single_parse_request.go new file mode 100644 index 0000000..b34eabe --- /dev/null +++ b/model_vci_single_parse_request.go @@ -0,0 +1,164 @@ +/* +Authlete API + +Authlete API Document. + +API version: 3.0.0 +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package authlete + +import ( + "encoding/json" +) + +// checks if the VciSingleParseRequest type satisfies the MappedNullable interface at compile time +var _ MappedNullable = &VciSingleParseRequest{} + +// VciSingleParseRequest struct for VciSingleParseRequest +type VciSingleParseRequest struct { + // The access token that came along with the credential request. + AccessToken *string `json:"accessToken,omitempty"` + // The message body of the credential request. + RequestContent *string `json:"requestContent,omitempty"` +} + +// NewVciSingleParseRequest instantiates a new VciSingleParseRequest object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewVciSingleParseRequest() *VciSingleParseRequest { + this := VciSingleParseRequest{} + return &this +} + +// NewVciSingleParseRequestWithDefaults instantiates a new VciSingleParseRequest object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewVciSingleParseRequestWithDefaults() *VciSingleParseRequest { + this := VciSingleParseRequest{} + return &this +} + +// GetAccessToken returns the AccessToken field value if set, zero value otherwise. +func (o *VciSingleParseRequest) GetAccessToken() string { + if o == nil || isNil(o.AccessToken) { + var ret string + return ret + } + return *o.AccessToken +} + +// GetAccessTokenOk returns a tuple with the AccessToken field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciSingleParseRequest) GetAccessTokenOk() (*string, bool) { + if o == nil || isNil(o.AccessToken) { + return nil, false + } + return o.AccessToken, true +} + +// HasAccessToken returns a boolean if a field has been set. +func (o *VciSingleParseRequest) HasAccessToken() bool { + if o != nil && !isNil(o.AccessToken) { + return true + } + + return false +} + +// SetAccessToken gets a reference to the given string and assigns it to the AccessToken field. +func (o *VciSingleParseRequest) SetAccessToken(v string) { + o.AccessToken = &v +} + +// GetRequestContent returns the RequestContent field value if set, zero value otherwise. +func (o *VciSingleParseRequest) GetRequestContent() string { + if o == nil || isNil(o.RequestContent) { + var ret string + return ret + } + return *o.RequestContent +} + +// GetRequestContentOk returns a tuple with the RequestContent field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciSingleParseRequest) GetRequestContentOk() (*string, bool) { + if o == nil || isNil(o.RequestContent) { + return nil, false + } + return o.RequestContent, true +} + +// HasRequestContent returns a boolean if a field has been set. +func (o *VciSingleParseRequest) HasRequestContent() bool { + if o != nil && !isNil(o.RequestContent) { + return true + } + + return false +} + +// SetRequestContent gets a reference to the given string and assigns it to the RequestContent field. +func (o *VciSingleParseRequest) SetRequestContent(v string) { + o.RequestContent = &v +} + +func (o VciSingleParseRequest) MarshalJSON() ([]byte, error) { + toSerialize,err := o.ToMap() + if err != nil { + return []byte{}, err + } + return json.Marshal(toSerialize) +} + +func (o VciSingleParseRequest) ToMap() (map[string]interface{}, error) { + toSerialize := map[string]interface{}{} + if !isNil(o.AccessToken) { + toSerialize["accessToken"] = o.AccessToken + } + if !isNil(o.RequestContent) { + toSerialize["requestContent"] = o.RequestContent + } + return toSerialize, nil +} + +type NullableVciSingleParseRequest struct { + value *VciSingleParseRequest + isSet bool +} + +func (v NullableVciSingleParseRequest) Get() *VciSingleParseRequest { + return v.value +} + +func (v *NullableVciSingleParseRequest) Set(val *VciSingleParseRequest) { + v.value = val + v.isSet = true +} + +func (v NullableVciSingleParseRequest) IsSet() bool { + return v.isSet +} + +func (v *NullableVciSingleParseRequest) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableVciSingleParseRequest(val *VciSingleParseRequest) *NullableVciSingleParseRequest { + return &NullableVciSingleParseRequest{value: val, isSet: true} +} + +func (v NullableVciSingleParseRequest) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableVciSingleParseRequest) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/model_vci_single_parse_response.go b/model_vci_single_parse_response.go new file mode 100644 index 0000000..f925760 --- /dev/null +++ b/model_vci_single_parse_response.go @@ -0,0 +1,274 @@ +/* +Authlete API + +Authlete API Document. + +API version: 3.0.0 +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package authlete + +import ( + "encoding/json" +) + +// checks if the VciSingleParseResponse type satisfies the MappedNullable interface at compile time +var _ MappedNullable = &VciSingleParseResponse{} + +// VciSingleParseResponse struct for VciSingleParseResponse +type VciSingleParseResponse struct { + // The code which represents the result of the API call. + ResultCode *string `json:"resultCode,omitempty"` + // A short message which explains the result of the API call. + ResultMessage *string `json:"resultMessage,omitempty"` + // The next action that the credential endpoint should take. + Action *string `json:"action,omitempty"` + // The content of the response to the request sender. + ResponseContent *string `json:"responseContent,omitempty"` + Info *CredentialRequestInfo `json:"info,omitempty"` +} + +// NewVciSingleParseResponse instantiates a new VciSingleParseResponse object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewVciSingleParseResponse() *VciSingleParseResponse { + this := VciSingleParseResponse{} + return &this +} + +// NewVciSingleParseResponseWithDefaults instantiates a new VciSingleParseResponse object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewVciSingleParseResponseWithDefaults() *VciSingleParseResponse { + this := VciSingleParseResponse{} + return &this +} + +// GetResultCode returns the ResultCode field value if set, zero value otherwise. +func (o *VciSingleParseResponse) GetResultCode() string { + if o == nil || isNil(o.ResultCode) { + var ret string + return ret + } + return *o.ResultCode +} + +// GetResultCodeOk returns a tuple with the ResultCode field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciSingleParseResponse) GetResultCodeOk() (*string, bool) { + if o == nil || isNil(o.ResultCode) { + return nil, false + } + return o.ResultCode, true +} + +// HasResultCode returns a boolean if a field has been set. +func (o *VciSingleParseResponse) HasResultCode() bool { + if o != nil && !isNil(o.ResultCode) { + return true + } + + return false +} + +// SetResultCode gets a reference to the given string and assigns it to the ResultCode field. +func (o *VciSingleParseResponse) SetResultCode(v string) { + o.ResultCode = &v +} + +// GetResultMessage returns the ResultMessage field value if set, zero value otherwise. +func (o *VciSingleParseResponse) GetResultMessage() string { + if o == nil || isNil(o.ResultMessage) { + var ret string + return ret + } + return *o.ResultMessage +} + +// GetResultMessageOk returns a tuple with the ResultMessage field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciSingleParseResponse) GetResultMessageOk() (*string, bool) { + if o == nil || isNil(o.ResultMessage) { + return nil, false + } + return o.ResultMessage, true +} + +// HasResultMessage returns a boolean if a field has been set. +func (o *VciSingleParseResponse) HasResultMessage() bool { + if o != nil && !isNil(o.ResultMessage) { + return true + } + + return false +} + +// SetResultMessage gets a reference to the given string and assigns it to the ResultMessage field. +func (o *VciSingleParseResponse) SetResultMessage(v string) { + o.ResultMessage = &v +} + +// GetAction returns the Action field value if set, zero value otherwise. +func (o *VciSingleParseResponse) GetAction() string { + if o == nil || isNil(o.Action) { + var ret string + return ret + } + return *o.Action +} + +// GetActionOk returns a tuple with the Action field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciSingleParseResponse) GetActionOk() (*string, bool) { + if o == nil || isNil(o.Action) { + return nil, false + } + return o.Action, true +} + +// HasAction returns a boolean if a field has been set. +func (o *VciSingleParseResponse) HasAction() bool { + if o != nil && !isNil(o.Action) { + return true + } + + return false +} + +// SetAction gets a reference to the given string and assigns it to the Action field. +func (o *VciSingleParseResponse) SetAction(v string) { + o.Action = &v +} + +// GetResponseContent returns the ResponseContent field value if set, zero value otherwise. +func (o *VciSingleParseResponse) GetResponseContent() string { + if o == nil || isNil(o.ResponseContent) { + var ret string + return ret + } + return *o.ResponseContent +} + +// GetResponseContentOk returns a tuple with the ResponseContent field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciSingleParseResponse) GetResponseContentOk() (*string, bool) { + if o == nil || isNil(o.ResponseContent) { + return nil, false + } + return o.ResponseContent, true +} + +// HasResponseContent returns a boolean if a field has been set. +func (o *VciSingleParseResponse) HasResponseContent() bool { + if o != nil && !isNil(o.ResponseContent) { + return true + } + + return false +} + +// SetResponseContent gets a reference to the given string and assigns it to the ResponseContent field. +func (o *VciSingleParseResponse) SetResponseContent(v string) { + o.ResponseContent = &v +} + +// GetInfo returns the Info field value if set, zero value otherwise. +func (o *VciSingleParseResponse) GetInfo() CredentialRequestInfo { + if o == nil || isNil(o.Info) { + var ret CredentialRequestInfo + return ret + } + return *o.Info +} + +// GetInfoOk returns a tuple with the Info field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VciSingleParseResponse) GetInfoOk() (*CredentialRequestInfo, bool) { + if o == nil || isNil(o.Info) { + return nil, false + } + return o.Info, true +} + +// HasInfo returns a boolean if a field has been set. +func (o *VciSingleParseResponse) HasInfo() bool { + if o != nil && !isNil(o.Info) { + return true + } + + return false +} + +// SetInfo gets a reference to the given CredentialRequestInfo and assigns it to the Info field. +func (o *VciSingleParseResponse) SetInfo(v CredentialRequestInfo) { + o.Info = &v +} + +func (o VciSingleParseResponse) MarshalJSON() ([]byte, error) { + toSerialize,err := o.ToMap() + if err != nil { + return []byte{}, err + } + return json.Marshal(toSerialize) +} + +func (o VciSingleParseResponse) ToMap() (map[string]interface{}, error) { + toSerialize := map[string]interface{}{} + if !isNil(o.ResultCode) { + toSerialize["resultCode"] = o.ResultCode + } + if !isNil(o.ResultMessage) { + toSerialize["resultMessage"] = o.ResultMessage + } + if !isNil(o.Action) { + toSerialize["action"] = o.Action + } + if !isNil(o.ResponseContent) { + toSerialize["responseContent"] = o.ResponseContent + } + if !isNil(o.Info) { + toSerialize["info"] = o.Info + } + return toSerialize, nil +} + +type NullableVciSingleParseResponse struct { + value *VciSingleParseResponse + isSet bool +} + +func (v NullableVciSingleParseResponse) Get() *VciSingleParseResponse { + return v.value +} + +func (v *NullableVciSingleParseResponse) Set(val *VciSingleParseResponse) { + v.value = val + v.isSet = true +} + +func (v NullableVciSingleParseResponse) IsSet() bool { + return v.isSet +} + +func (v *NullableVciSingleParseResponse) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableVciSingleParseResponse(val *VciSingleParseResponse) *NullableVciSingleParseResponse { + return &NullableVciSingleParseResponse{value: val, isSet: true} +} + +func (v NullableVciSingleParseResponse) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableVciSingleParseResponse) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/model_verified_claims_validation_schema.go b/model_verified_claims_validation_schema.go index c7800fc..8026f8c 100644 --- a/model_verified_claims_validation_schema.go +++ b/model_verified_claims_validation_schema.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/response.go b/response.go index 8a7a4e7..e83184b 100644 --- a/response.go +++ b/response.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/test/api_vci_endpoint_test.go b/test/api_vci_endpoint_test.go new file mode 100644 index 0000000..1e0860f --- /dev/null +++ b/test/api_vci_endpoint_test.go @@ -0,0 +1,179 @@ +/* +Authlete API + +Testing VciEndpointApiService + +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); + +package authlete + +import ( + "context" + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" + "testing" + openapiclient "github.com/authlete/openapi-for-go" +) + +func Test_authlete_VciEndpointApiService(t *testing.T) { + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + + t.Run("Test VciEndpointApiService VciBatchIssueApi", func(t *testing.T) { + + t.Skip("skip test") // remove to run test + + var serviceId string + + resp, httpRes, err := apiClient.VciEndpointApi.VciBatchIssueApi(context.Background(), serviceId).Execute() + + require.Nil(t, err) + require.NotNil(t, resp) + assert.Equal(t, 200, httpRes.StatusCode) + + }) + + t.Run("Test VciEndpointApiService VciBatchParseApi", func(t *testing.T) { + + t.Skip("skip test") // remove to run test + + var serviceId string + + resp, httpRes, err := apiClient.VciEndpointApi.VciBatchParseApi(context.Background(), serviceId).Execute() + + require.Nil(t, err) + require.NotNil(t, resp) + assert.Equal(t, 200, httpRes.StatusCode) + + }) + + t.Run("Test VciEndpointApiService VciDeferredIssueApi", func(t *testing.T) { + + t.Skip("skip test") // remove to run test + + var serviceId string + + resp, httpRes, err := apiClient.VciEndpointApi.VciDeferredIssueApi(context.Background(), serviceId).Execute() + + require.Nil(t, err) + require.NotNil(t, resp) + assert.Equal(t, 200, httpRes.StatusCode) + + }) + + t.Run("Test VciEndpointApiService VciDeferredParseApi", func(t *testing.T) { + + t.Skip("skip test") // remove to run test + + var serviceId string + + resp, httpRes, err := apiClient.VciEndpointApi.VciDeferredParseApi(context.Background(), serviceId).Execute() + + require.Nil(t, err) + require.NotNil(t, resp) + assert.Equal(t, 200, httpRes.StatusCode) + + }) + + t.Run("Test VciEndpointApiService VciJwksApi", func(t *testing.T) { + + t.Skip("skip test") // remove to run test + + var serviceId string + + resp, httpRes, err := apiClient.VciEndpointApi.VciJwksApi(context.Background(), serviceId).Execute() + + require.Nil(t, err) + require.NotNil(t, resp) + assert.Equal(t, 200, httpRes.StatusCode) + + }) + + t.Run("Test VciEndpointApiService VciJwtissuerApi", func(t *testing.T) { + + t.Skip("skip test") // remove to run test + + var serviceId string + + resp, httpRes, err := apiClient.VciEndpointApi.VciJwtissuerApi(context.Background(), serviceId).Execute() + + require.Nil(t, err) + require.NotNil(t, resp) + assert.Equal(t, 200, httpRes.StatusCode) + + }) + + t.Run("Test VciEndpointApiService VciMetadataApi", func(t *testing.T) { + + t.Skip("skip test") // remove to run test + + var serviceId string + + resp, httpRes, err := apiClient.VciEndpointApi.VciMetadataApi(context.Background(), serviceId).Execute() + + require.Nil(t, err) + require.NotNil(t, resp) + assert.Equal(t, 200, httpRes.StatusCode) + + }) + + t.Run("Test VciEndpointApiService VciOfferCreateApi", func(t *testing.T) { + + t.Skip("skip test") // remove to run test + + var serviceId string + + resp, httpRes, err := apiClient.VciEndpointApi.VciOfferCreateApi(context.Background(), serviceId).Execute() + + require.Nil(t, err) + require.NotNil(t, resp) + assert.Equal(t, 200, httpRes.StatusCode) + + }) + + t.Run("Test VciEndpointApiService VciOfferInfoApi", func(t *testing.T) { + + t.Skip("skip test") // remove to run test + + var serviceId string + + resp, httpRes, err := apiClient.VciEndpointApi.VciOfferInfoApi(context.Background(), serviceId).Execute() + + require.Nil(t, err) + require.NotNil(t, resp) + assert.Equal(t, 200, httpRes.StatusCode) + + }) + + t.Run("Test VciEndpointApiService VciSingleIssueApi", func(t *testing.T) { + + t.Skip("skip test") // remove to run test + + var serviceId string + + resp, httpRes, err := apiClient.VciEndpointApi.VciSingleIssueApi(context.Background(), serviceId).Execute() + + require.Nil(t, err) + require.NotNil(t, resp) + assert.Equal(t, 200, httpRes.StatusCode) + + }) + + t.Run("Test VciEndpointApiService VciSingleParseApi", func(t *testing.T) { + + t.Skip("skip test") // remove to run test + + var serviceId string + + resp, httpRes, err := apiClient.VciEndpointApi.VciSingleParseApi(context.Background(), serviceId).Execute() + + require.Nil(t, err) + require.NotNil(t, resp) + assert.Equal(t, 200, httpRes.StatusCode) + + }) + +} diff --git a/utils.go b/utils.go index 57715b8..0663d86 100644 --- a/utils.go +++ b/utils.go @@ -3,7 +3,7 @@ Authlete API Authlete API Document. -API version: 2.3.12 +API version: 3.0.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT.