ibm_cloud_iam 1.0.1 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/LICENSE.txt +202 -0
- data/README.md +548 -36
- data/docs/APIKeysApi.md +714 -0
- data/docs/AccessGroupCount.md +20 -0
- data/docs/AccountBasedMfaEnrollment.md +24 -0
- data/docs/AccountIdpSettings.md +32 -0
- data/docs/AccountLimitsApi.md +173 -0
- data/docs/AccountLoginSettings.md +18 -0
- data/docs/AccountSettingsApi.md +224 -0
- data/docs/AccountSettingsAssignedTemplatesSection.md +46 -0
- data/docs/AccountSettingsEffectiveSection.md +38 -0
- data/docs/AccountSettingsForIdPApi.md +489 -0
- data/docs/AccountSettingsMeta.md +24 -0
- data/docs/AccountSettingsRequest.md +40 -0
- data/docs/AccountSettingsResponse.md +48 -0
- data/docs/AccountSettingsTemplateApi.md +720 -0
- data/docs/AccountSettingsTemplateAssignmentsApi.md +376 -0
- data/docs/AccountSettingsTemplateList.md +30 -0
- data/docs/AccountSettingsTemplateRequest.md +24 -0
- data/docs/AccountSettingsTemplateResponse.md +44 -0
- data/docs/AccountSettingsUserDomainRestriction.md +22 -0
- data/docs/AccountSettingsUserMFAResponse.md +28 -0
- data/docs/ActionControls.md +22 -0
- data/docs/ActionControlsIdentities.md +20 -0
- data/docs/ActivitiesApi.md +149 -0
- data/docs/Activity.md +20 -0
- data/docs/AddAccountIdpSettingRequest.md +22 -0
- data/docs/ApiKey.md +44 -33
- data/docs/ApiKeyInsideCreateServiceIdRequest.md +18 -13
- data/docs/ApiKeyList.md +20 -19
- data/docs/ApikeyActivity.md +28 -0
- data/docs/ApikeyActivityServiceid.md +20 -0
- data/docs/ApikeyActivityUser.md +24 -0
- data/docs/AssignedTemplatesAccountSettings.md +40 -0
- data/docs/CommonAccountSettingsRequest.md +36 -0
- data/docs/CommonAccountSettingsResponse.md +34 -0
- data/docs/ConsumersResponse.md +20 -0
- data/docs/ConsumersResponseConsumersInner.md +20 -0
- data/docs/CreateApiKeyRequest.md +24 -17
- data/docs/CreateIdpRequest.md +30 -0
- data/docs/CreateIdpRequestProperties.md +20 -0
- data/docs/CreateIdpRequestPropertiesIdp.md +26 -0
- data/docs/CreateIdpRequestPropertiesSp.md +32 -0
- data/docs/CreateIdpRequestPropertiesSpAuthnContext.md +20 -0
- data/docs/CreateIdpRequestSecrets.md +20 -0
- data/docs/CreateIdpRequestSecretsIdp.md +22 -0
- data/docs/CreateIdpRequestSecretsIdpSigningInner.md +20 -0
- data/docs/CreateIdpRequestSecretsSp.md +18 -0
- data/docs/CreateIdpRequestSecretsSpSigningInner.md +24 -0
- data/docs/CreateProfileLinkRequest.md +24 -0
- data/docs/CreateProfileLinkRequestLink.md +26 -0
- data/docs/CreateServiceIdGroupRequest.md +22 -0
- data/docs/CreateServiceIdRequest.md +18 -15
- data/docs/CreateTemplateAssignmentRequest.md +24 -0
- data/docs/CreateTrustedProfileRequest.md +24 -0
- data/docs/EffectiveAccountSettingsResponse.md +26 -0
- data/docs/EnityHistoryRecord.md +18 -17
- data/docs/EntityActivity.md +22 -0
- data/docs/Error.md +14 -13
- data/docs/ExceptionResponse.md +14 -13
- data/docs/ExceptionResponseContext.md +30 -29
- data/docs/IDPManagementApi.md +692 -0
- data/docs/IdBasedMfaEnrollment.md +26 -0
- data/docs/IdentityCount.md +20 -0
- data/docs/IdentityLimitsUsageRequest.md +42 -0
- data/docs/IdentityLimitsUsageResponse.md +44 -0
- data/docs/IdentityLimitsUsageResponseApikeysPerIdentity.md +20 -0
- data/docs/IdentityLimitsUsageResponseClaimRulesPerGroup.md +20 -0
- data/docs/IdentityLimitsUsageResponseClaimRulesPerProfile.md +20 -0
- data/docs/IdentityLimitsUsageResponseServiceidsPerGroup.md +20 -0
- data/docs/IdentityLimitsUsageResponseTemplateVersionsPerTemplate.md +20 -0
- data/docs/IdentityPreferenceResponse.md +28 -0
- data/docs/IdentityPreferencesApi.md +304 -0
- data/docs/IdentityPreferencesResponse.md +18 -0
- data/docs/Idp.md +38 -0
- data/docs/LimitCount.md +20 -0
- data/docs/ListIdPSettings200Response.md +18 -0
- data/docs/ListIdps200Response.md +18 -0
- data/docs/MFAEnrollmentStatusApi.md +216 -0
- data/docs/MFARequirementsResponse.md +12 -11
- data/docs/MfaEnrollmentTypeStatus.md +20 -0
- data/docs/MfaOptions.md +15 -0
- data/docs/OidcExceptionResponse.md +16 -15
- data/docs/PolicyTemplateReference.md +20 -0
- data/docs/ProfileClaimRule.md +36 -0
- data/docs/ProfileClaimRuleConditions.md +22 -0
- data/docs/ProfileClaimRuleList.md +20 -0
- data/docs/ProfileClaimRuleRequest.md +30 -0
- data/docs/ProfileCount.md +20 -0
- data/docs/ProfileIdentitiesResponse.md +20 -0
- data/docs/ProfileIdentitiesUpdateRequest.md +18 -0
- data/docs/ProfileIdentityRequest.md +24 -0
- data/docs/ProfileIdentityResponse.md +26 -0
- data/docs/ProfileLink.md +32 -0
- data/docs/ProfileLinkLink.md +26 -0
- data/docs/ProfileLinkList.md +18 -0
- data/docs/Report.md +34 -0
- data/docs/ReportMfaEnrollmentStatus.md +28 -0
- data/docs/ReportReference.md +18 -0
- data/docs/ResponseContext.md +28 -27
- data/docs/RetrictActions.md +15 -0
- data/docs/SamlMetadataImportResponse.md +42 -0
- data/docs/ServiceIDGroupsApi.md +347 -0
- data/docs/ServiceIDsApi.md +515 -0
- data/docs/ServiceId.md +38 -33
- data/docs/ServiceIdGroup.md +34 -0
- data/docs/ServiceIdGroupCount.md +20 -0
- data/docs/ServiceIdGroupList.md +18 -0
- data/docs/ServiceIdList.md +20 -19
- data/docs/ShareScope.md +20 -0
- data/docs/TemplateAccountSettings.md +40 -0
- data/docs/TemplateAccountSettingsAllOfRestrictUserDomains.md +20 -0
- data/docs/TemplateAssignmentListResponse.md +30 -0
- data/docs/TemplateAssignmentResource.md +18 -0
- data/docs/TemplateAssignmentResourceError.md +24 -0
- data/docs/TemplateAssignmentResponse.md +48 -0
- data/docs/TemplateAssignmentResponseResource.md +24 -0
- data/docs/TemplateAssignmentResponseResourceDetail.md +26 -0
- data/docs/TemplateCount.md +20 -0
- data/docs/TemplateProfileComponentRequest.md +26 -0
- data/docs/TemplateProfileComponentResponse.md +26 -0
- data/docs/TestResult.md +28 -0
- data/docs/TestResultStepsInner.md +24 -0
- data/docs/TestTriggerResponse.md +20 -0
- data/docs/TokenResponse.md +18 -17
- data/docs/TokenRetrievalApi.md +461 -0
- data/docs/TrustedProfile.md +50 -0
- data/docs/TrustedProfileTemplateApi.md +720 -0
- data/docs/TrustedProfileTemplateAssignmentsApi.md +376 -0
- data/docs/TrustedProfileTemplateClaimRule.md +26 -0
- data/docs/TrustedProfileTemplateList.md +30 -0
- data/docs/TrustedProfileTemplateRequest.md +28 -0
- data/docs/TrustedProfileTemplateResponse.md +48 -0
- data/docs/TrustedProfilesApi.md +1414 -0
- data/docs/TrustedProfilesList.md +30 -0
- data/docs/UpdateAccountIdpSettingRequest.md +22 -0
- data/docs/UpdateAccountLoginSettings.md +18 -0
- data/docs/UpdateApiKeyRequest.md +16 -9
- data/docs/UpdateIdPRequest.md +28 -0
- data/docs/UpdateIdPRequestProperties.md +20 -0
- data/docs/UpdateIdPRequestPropertiesIdp.md +24 -0
- data/docs/UpdateIdPRequestSecrets.md +20 -0
- data/docs/UpdateIdPRequestSecretsIdp.md +20 -0
- data/docs/UpdatePreferenceRequest.md +20 -0
- data/docs/UpdateServiceIdGroupRequest.md +20 -0
- data/docs/UpdateServiceIdRequest.md +12 -11
- data/docs/UpdateTemplateAssignmentRequest.md +18 -0
- data/docs/UpdateTrustedProfileRequest.md +22 -0
- data/docs/UserActivity.md +26 -0
- data/docs/UserMFAResolved.md +24 -0
- data/docs/UserMfa.md +20 -0
- data/docs/UserMfaEnrollments.md +24 -0
- data/docs/UserReportMfaEnrollmentStatus.md +30 -0
- data/docs/UserVisbilityRetrictActions.md +15 -0
- data/docs/UserVisbilityRetrictActionsForTemplate.md +15 -0
- data/git_push.sh +3 -4
- data/ibm_cloud_iam.gemspec +6 -5
- data/lib/ibm_cloud_iam/api/account_limits_api.rb +208 -0
- data/lib/ibm_cloud_iam/api/account_settings_api.rb +262 -0
- data/lib/ibm_cloud_iam/api/account_settings_for_id_p_api.rb +571 -0
- data/lib/ibm_cloud_iam/api/account_settings_template_api.rb +823 -0
- data/lib/ibm_cloud_iam/api/account_settings_template_assignments_api.rb +422 -0
- data/lib/ibm_cloud_iam/api/activities_api.rb +174 -0
- data/lib/ibm_cloud_iam/api/api_keys_api.rb +786 -0
- data/lib/ibm_cloud_iam/api/identity_preferences_api.rb +357 -0
- data/lib/ibm_cloud_iam/api/idp_management_api.rb +744 -0
- data/lib/ibm_cloud_iam/api/mfa_enrollment_status_api.rb +248 -0
- data/lib/ibm_cloud_iam/api/service_id_groups_api.rb +392 -0
- data/lib/ibm_cloud_iam/api/service_ids_api.rb +575 -0
- data/lib/ibm_cloud_iam/api/token_retrieval_api.rb +557 -0
- data/lib/ibm_cloud_iam/api/trusted_profile_template_api.rb +823 -0
- data/lib/ibm_cloud_iam/api/trusted_profile_template_assignments_api.rb +422 -0
- data/lib/ibm_cloud_iam/api/trusted_profiles_api.rb +1630 -0
- data/lib/ibm_cloud_iam/api_client.rb +74 -65
- data/lib/ibm_cloud_iam/api_error.rb +4 -3
- data/lib/ibm_cloud_iam/api_model_base.rb +88 -0
- data/lib/ibm_cloud_iam/configuration.rb +75 -15
- data/lib/ibm_cloud_iam/models/access_group_count.rb +159 -0
- data/lib/ibm_cloud_iam/models/account_based_mfa_enrollment.rb +243 -0
- data/lib/ibm_cloud_iam/models/account_idp_settings.rb +244 -0
- data/lib/ibm_cloud_iam/models/account_login_settings.rb +147 -0
- data/lib/ibm_cloud_iam/models/account_settings_assigned_templates_section.rb +377 -0
- data/lib/ibm_cloud_iam/models/account_settings_effective_section.rb +282 -0
- data/lib/ibm_cloud_iam/models/account_settings_meta.rb +179 -0
- data/lib/ibm_cloud_iam/models/account_settings_request.rb +301 -0
- data/lib/ibm_cloud_iam/models/account_settings_response.rb +567 -0
- data/lib/ibm_cloud_iam/models/account_settings_template_list.rb +256 -0
- data/lib/ibm_cloud_iam/models/account_settings_template_request.rb +178 -0
- data/lib/ibm_cloud_iam/models/account_settings_template_response.rb +416 -0
- data/lib/ibm_cloud_iam/models/account_settings_user_domain_restriction.rb +188 -0
- data/lib/ibm_cloud_iam/models/account_settings_user_mfa_response.rb +261 -0
- data/lib/ibm_cloud_iam/models/action_controls.rb +199 -0
- data/lib/ibm_cloud_iam/models/action_controls_identities.rb +190 -0
- data/lib/ibm_cloud_iam/models/activity.rb +175 -0
- data/lib/ibm_cloud_iam/models/add_account_idp_setting_request.rb +243 -0
- data/lib/ibm_cloud_iam/models/api_key.rb +188 -104
- data/lib/ibm_cloud_iam/models/api_key_inside_create_service_id_request.rb +70 -99
- data/lib/ibm_cloud_iam/models/api_key_list.rb +46 -95
- data/lib/ibm_cloud_iam/models/apikey_activity.rb +231 -0
- data/lib/ibm_cloud_iam/models/apikey_activity_serviceid.rb +159 -0
- data/lib/ibm_cloud_iam/models/apikey_activity_user.rb +179 -0
- data/lib/ibm_cloud_iam/models/assigned_templates_account_settings.rb +296 -0
- data/lib/ibm_cloud_iam/models/common_account_settings_request.rb +272 -0
- data/lib/ibm_cloud_iam/models/common_account_settings_response.rb +260 -0
- data/lib/ibm_cloud_iam/models/consumers_response.rb +158 -0
- data/lib/ibm_cloud_iam/models/consumers_response_consumers_inner.rb +158 -0
- data/lib/ibm_cloud_iam/models/create_api_key_request.rb +92 -99
- data/lib/ibm_cloud_iam/models/create_idp_request.rb +283 -0
- data/lib/ibm_cloud_iam/models/create_idp_request_properties.rb +157 -0
- data/lib/ibm_cloud_iam/models/create_idp_request_properties_idp.rb +189 -0
- data/lib/ibm_cloud_iam/models/create_idp_request_properties_sp.rb +222 -0
- data/lib/ibm_cloud_iam/models/create_idp_request_properties_sp_authn_context.rb +163 -0
- data/lib/ibm_cloud_iam/models/create_idp_request_secrets.rb +157 -0
- data/lib/ibm_cloud_iam/models/create_idp_request_secrets_idp.rb +173 -0
- data/lib/ibm_cloud_iam/models/create_idp_request_secrets_idp_signing_inner.rb +192 -0
- data/lib/ibm_cloud_iam/models/create_idp_request_secrets_sp.rb +151 -0
- data/lib/ibm_cloud_iam/models/create_idp_request_secrets_sp_signing_inner.rb +212 -0
- data/lib/ibm_cloud_iam/models/create_profile_link_request.rb +211 -0
- data/lib/ibm_cloud_iam/models/create_profile_link_request_link.rb +206 -0
- data/lib/ibm_cloud_iam/models/create_service_id_group_request.rb +203 -0
- data/lib/ibm_cloud_iam/models/create_service_id_request.rb +68 -95
- data/lib/ibm_cloud_iam/models/create_template_assignment_request.rb +280 -0
- data/lib/ibm_cloud_iam/models/create_trusted_profile_request.rb +213 -0
- data/lib/ibm_cloud_iam/models/effective_account_settings_response.rb +239 -0
- data/lib/ibm_cloud_iam/models/enity_history_record.rb +112 -101
- data/lib/ibm_cloud_iam/models/entity_activity.rb +185 -0
- data/lib/ibm_cloud_iam/models/error.rb +69 -94
- data/lib/ibm_cloud_iam/models/exception_response.rb +57 -94
- data/lib/ibm_cloud_iam/models/exception_response_context.rb +33 -94
- data/lib/ibm_cloud_iam/models/id_based_mfa_enrollment.rb +270 -0
- data/lib/ibm_cloud_iam/models/identity_count.rb +159 -0
- data/lib/ibm_cloud_iam/models/identity_limits_usage_request.rb +283 -0
- data/lib/ibm_cloud_iam/models/identity_limits_usage_response.rb +265 -0
- data/lib/ibm_cloud_iam/models/identity_limits_usage_response_apikeys_per_identity.rb +178 -0
- data/lib/ibm_cloud_iam/models/identity_limits_usage_response_claim_rules_per_group.rb +178 -0
- data/lib/ibm_cloud_iam/models/identity_limits_usage_response_claim_rules_per_profile.rb +178 -0
- data/lib/ibm_cloud_iam/models/identity_limits_usage_response_serviceids_per_group.rb +178 -0
- data/lib/ibm_cloud_iam/models/identity_limits_usage_response_template_versions_per_template.rb +178 -0
- data/lib/ibm_cloud_iam/models/identity_preference_response.rb +200 -0
- data/lib/ibm_cloud_iam/models/identity_preferences_response.rb +167 -0
- data/lib/ibm_cloud_iam/models/idp.rb +239 -0
- data/lib/ibm_cloud_iam/models/limit_count.rb +176 -0
- data/lib/ibm_cloud_iam/models/list_id_p_settings200_response.rb +149 -0
- data/lib/ibm_cloud_iam/models/list_idps200_response.rb +149 -0
- data/lib/ibm_cloud_iam/models/mfa_enrollment_type_status.rb +192 -0
- data/lib/ibm_cloud_iam/models/mfa_options.rb +45 -0
- data/lib/ibm_cloud_iam/models/mfa_requirements_response.rb +69 -94
- data/lib/ibm_cloud_iam/models/oidc_exception_response.rb +57 -94
- data/lib/ibm_cloud_iam/models/policy_template_reference.rb +193 -0
- data/lib/ibm_cloud_iam/models/profile_claim_rule.rb +342 -0
- data/lib/ibm_cloud_iam/models/profile_claim_rule_conditions.rb +219 -0
- data/lib/ibm_cloud_iam/models/profile_claim_rule_list.rb +176 -0
- data/lib/ibm_cloud_iam/models/profile_claim_rule_request.rb +243 -0
- data/lib/ibm_cloud_iam/models/profile_count.rb +159 -0
- data/lib/ibm_cloud_iam/models/profile_identities_response.rb +160 -0
- data/lib/ibm_cloud_iam/models/profile_identities_update_request.rb +150 -0
- data/lib/ibm_cloud_iam/models/profile_identity_request.rb +238 -0
- data/lib/ibm_cloud_iam/models/profile_identity_response.rb +265 -0
- data/lib/ibm_cloud_iam/models/profile_link.rb +320 -0
- data/lib/ibm_cloud_iam/models/profile_link_link.rb +188 -0
- data/lib/ibm_cloud_iam/models/profile_link_list.rb +167 -0
- data/lib/ibm_cloud_iam/models/report.rb +321 -0
- data/lib/ibm_cloud_iam/models/report_mfa_enrollment_status.rb +268 -0
- data/lib/ibm_cloud_iam/models/report_reference.rb +165 -0
- data/lib/ibm_cloud_iam/models/response_context.rb +33 -94
- data/lib/ibm_cloud_iam/models/retrict_actions.rb +41 -0
- data/lib/ibm_cloud_iam/models/saml_metadata_import_response.rb +494 -0
- data/lib/ibm_cloud_iam/models/service_id.rb +184 -108
- data/lib/ibm_cloud_iam/models/service_id_group.rb +313 -0
- data/lib/ibm_cloud_iam/models/service_id_group_count.rb +159 -0
- data/lib/ibm_cloud_iam/models/service_id_group_list.rb +167 -0
- data/lib/ibm_cloud_iam/models/service_id_list.rb +47 -96
- data/lib/ibm_cloud_iam/models/share_scope.rb +190 -0
- data/lib/ibm_cloud_iam/models/template_account_settings.rb +296 -0
- data/lib/ibm_cloud_iam/models/template_account_settings_all_of_restrict_user_domains.rb +159 -0
- data/lib/ibm_cloud_iam/models/template_assignment_list_response.rb +227 -0
- data/lib/ibm_cloud_iam/models/template_assignment_resource.rb +149 -0
- data/lib/ibm_cloud_iam/models/template_assignment_resource_error.rb +179 -0
- data/lib/ibm_cloud_iam/models/template_assignment_response.rb +506 -0
- data/lib/ibm_cloud_iam/models/template_assignment_response_resource.rb +196 -0
- data/lib/ibm_cloud_iam/models/template_assignment_response_resource_detail.rb +203 -0
- data/lib/ibm_cloud_iam/models/template_count.rb +159 -0
- data/lib/ibm_cloud_iam/models/template_profile_component_request.rb +210 -0
- data/lib/ibm_cloud_iam/models/template_profile_component_response.rb +210 -0
- data/lib/ibm_cloud_iam/models/test_result.rb +194 -0
- data/lib/ibm_cloud_iam/models/test_result_steps_inner.rb +174 -0
- data/lib/ibm_cloud_iam/models/test_trigger_response.rb +156 -0
- data/lib/ibm_cloud_iam/models/token_response.rb +33 -94
- data/lib/ibm_cloud_iam/models/trusted_profile.rb +411 -0
- data/lib/ibm_cloud_iam/models/trusted_profile_template_claim_rule.rb +248 -0
- data/lib/ibm_cloud_iam/models/trusted_profile_template_list.rb +256 -0
- data/lib/ibm_cloud_iam/models/trusted_profile_template_request.rb +199 -0
- data/lib/ibm_cloud_iam/models/trusted_profile_template_response.rb +369 -0
- data/lib/ibm_cloud_iam/models/trusted_profiles_list.rb +227 -0
- data/lib/ibm_cloud_iam/models/update_account_idp_setting_request.rb +202 -0
- data/lib/ibm_cloud_iam/models/update_account_login_settings.rb +148 -0
- data/lib/ibm_cloud_iam/models/update_api_key_request.rb +68 -99
- data/lib/ibm_cloud_iam/models/update_id_p_request.rb +198 -0
- data/lib/ibm_cloud_iam/models/update_id_p_request_properties.rb +157 -0
- data/lib/ibm_cloud_iam/models/update_id_p_request_properties_idp.rb +179 -0
- data/lib/ibm_cloud_iam/models/update_id_p_request_secrets.rb +157 -0
- data/lib/ibm_cloud_iam/models/update_id_p_request_secrets_idp.rb +163 -0
- data/lib/ibm_cloud_iam/models/update_preference_request.rb +161 -0
- data/lib/ibm_cloud_iam/models/update_service_id_group_request.rb +176 -0
- data/lib/ibm_cloud_iam/models/update_service_id_request.rb +34 -95
- data/lib/ibm_cloud_iam/models/update_template_assignment_request.rb +175 -0
- data/lib/ibm_cloud_iam/models/update_trusted_profile_request.rb +169 -0
- data/lib/ibm_cloud_iam/models/user_activity.rb +222 -0
- data/lib/ibm_cloud_iam/models/user_mfa.rb +179 -0
- data/lib/ibm_cloud_iam/models/user_mfa_enrollments.rb +193 -0
- data/lib/ibm_cloud_iam/models/user_mfa_resolved.rb +178 -0
- data/lib/ibm_cloud_iam/models/user_report_mfa_enrollment_status.rb +291 -0
- data/lib/ibm_cloud_iam/models/user_visbility_retrict_actions.rb +40 -0
- data/lib/ibm_cloud_iam/models/user_visbility_retrict_actions_for_template.rb +41 -0
- data/lib/ibm_cloud_iam/version.rb +4 -4
- data/lib/ibm_cloud_iam.rb +140 -9
- data/spec/api/account_limits_api_spec.rb +75 -0
- data/spec/api/account_settings_api_spec.rb +80 -0
- data/spec/api/account_settings_for_id_p_api_spec.rb +132 -0
- data/spec/api/account_settings_template_api_spec.rb +184 -0
- data/spec/api/account_settings_template_assignments_api_spec.rb +112 -0
- data/spec/api/activities_api_spec.rb +64 -0
- data/spec/api/api_keys_api_spec.rb +182 -0
- data/spec/api/identity_preferences_api_spec.rb +98 -0
- data/spec/api/idp_management_api_spec.rb +166 -0
- data/spec/api/mfa_enrollment_status_api_spec.rb +77 -0
- data/spec/api/service_id_groups_api_spec.rb +102 -0
- data/spec/api/service_ids_api_spec.rb +143 -0
- data/spec/api/token_retrieval_api_spec.rb +134 -0
- data/spec/api/trusted_profile_template_api_spec.rb +184 -0
- data/spec/api/trusted_profile_template_assignments_api_spec.rb +112 -0
- data/spec/api/trusted_profiles_api_spec.rb +328 -0
- data/spec/models/access_group_count_spec.rb +42 -0
- data/spec/models/account_based_mfa_enrollment_spec.rb +54 -0
- data/spec/models/account_idp_settings_spec.rb +82 -0
- data/spec/models/account_login_settings_spec.rb +36 -0
- data/spec/models/account_settings_assigned_templates_section_spec.rb +120 -0
- data/spec/models/account_settings_effective_section_spec.rb +96 -0
- data/spec/models/account_settings_meta_spec.rb +54 -0
- data/spec/models/account_settings_request_spec.rb +102 -0
- data/spec/models/account_settings_response_spec.rb +126 -0
- data/spec/models/account_settings_template_list_spec.rb +72 -0
- data/spec/models/account_settings_template_request_spec.rb +54 -0
- data/spec/models/account_settings_template_response_spec.rb +114 -0
- data/spec/models/account_settings_user_domain_restriction_spec.rb +48 -0
- data/spec/models/account_settings_user_mfa_response_spec.rb +66 -0
- data/spec/models/action_controls_identities_spec.rb +42 -0
- data/spec/models/action_controls_spec.rb +48 -0
- data/spec/models/activity_spec.rb +42 -0
- data/spec/models/add_account_idp_setting_request_spec.rb +52 -0
- data/spec/models/api_key_inside_create_service_id_request_spec.rb +24 -17
- data/spec/models/api_key_list_spec.rb +15 -20
- data/spec/models/api_key_spec.rb +52 -27
- data/spec/models/apikey_activity_serviceid_spec.rb +42 -0
- data/spec/models/apikey_activity_spec.rb +66 -0
- data/spec/models/apikey_activity_user_spec.rb +54 -0
- data/spec/models/assigned_templates_account_settings_spec.rb +102 -0
- data/spec/models/common_account_settings_request_spec.rb +90 -0
- data/spec/models/common_account_settings_response_spec.rb +84 -0
- data/spec/models/consumers_response_consumers_inner_spec.rb +42 -0
- data/spec/models/consumers_response_spec.rb +42 -0
- data/spec/models/create_api_key_request_spec.rb +32 -19
- data/spec/models/create_idp_request_properties_idp_spec.rb +60 -0
- data/spec/models/create_idp_request_properties_sp_authn_context_spec.rb +42 -0
- data/spec/models/create_idp_request_properties_sp_spec.rb +78 -0
- data/spec/models/create_idp_request_properties_spec.rb +42 -0
- data/spec/models/create_idp_request_secrets_idp_signing_inner_spec.rb +46 -0
- data/spec/models/create_idp_request_secrets_idp_spec.rb +48 -0
- data/spec/models/create_idp_request_secrets_sp_signing_inner_spec.rb +58 -0
- data/spec/models/create_idp_request_secrets_sp_spec.rb +36 -0
- data/spec/models/create_idp_request_secrets_spec.rb +42 -0
- data/spec/models/create_idp_request_spec.rb +76 -0
- data/spec/models/create_profile_link_request_link_spec.rb +60 -0
- data/spec/models/create_profile_link_request_spec.rb +54 -0
- data/spec/models/create_service_id_group_request_spec.rb +48 -0
- data/spec/models/create_service_id_request_spec.rb +19 -18
- data/spec/models/create_template_assignment_request_spec.rb +58 -0
- data/spec/models/create_trusted_profile_request_spec.rb +54 -0
- data/spec/models/effective_account_settings_response_spec.rb +60 -0
- data/spec/models/enity_history_record_spec.rb +14 -19
- data/spec/models/entity_activity_spec.rb +48 -0
- data/spec/models/error_spec.rb +12 -17
- data/spec/models/exception_response_context_spec.rb +20 -25
- data/spec/models/exception_response_spec.rb +12 -17
- data/spec/models/id_based_mfa_enrollment_spec.rb +64 -0
- data/spec/models/identity_count_spec.rb +42 -0
- data/spec/models/identity_limits_usage_request_spec.rb +108 -0
- data/spec/models/identity_limits_usage_response_apikeys_per_identity_spec.rb +42 -0
- data/spec/models/identity_limits_usage_response_claim_rules_per_group_spec.rb +42 -0
- data/spec/models/identity_limits_usage_response_claim_rules_per_profile_spec.rb +42 -0
- data/spec/models/identity_limits_usage_response_serviceids_per_group_spec.rb +42 -0
- data/spec/models/identity_limits_usage_response_spec.rb +114 -0
- data/spec/models/identity_limits_usage_response_template_versions_per_template_spec.rb +42 -0
- data/spec/models/identity_preference_response_spec.rb +66 -0
- data/spec/models/identity_preferences_response_spec.rb +36 -0
- data/spec/models/idp_spec.rb +96 -0
- data/spec/models/limit_count_spec.rb +42 -0
- data/spec/models/list_id_p_settings200_response_spec.rb +36 -0
- data/spec/models/list_idps200_response_spec.rb +36 -0
- data/spec/models/mfa_enrollment_type_status_spec.rb +42 -0
- data/spec/models/mfa_options_spec.rb +30 -0
- data/spec/models/mfa_requirements_response_spec.rb +11 -16
- data/spec/models/oidc_exception_response_spec.rb +13 -18
- data/spec/models/policy_template_reference_spec.rb +42 -0
- data/spec/models/profile_claim_rule_conditions_spec.rb +48 -0
- data/spec/models/profile_claim_rule_list_spec.rb +42 -0
- data/spec/models/profile_claim_rule_request_spec.rb +72 -0
- data/spec/models/profile_claim_rule_spec.rb +90 -0
- data/spec/models/profile_count_spec.rb +42 -0
- data/spec/models/profile_identities_response_spec.rb +42 -0
- data/spec/models/profile_identities_update_request_spec.rb +36 -0
- data/spec/models/profile_identity_request_spec.rb +58 -0
- data/spec/models/profile_identity_response_spec.rb +64 -0
- data/spec/models/profile_link_link_spec.rb +60 -0
- data/spec/models/profile_link_list_spec.rb +36 -0
- data/spec/models/profile_link_spec.rb +78 -0
- data/spec/models/report_mfa_enrollment_status_spec.rb +66 -0
- data/spec/models/report_reference_spec.rb +36 -0
- data/spec/models/report_spec.rb +84 -0
- data/spec/models/response_context_spec.rb +19 -24
- data/spec/models/retrict_actions_spec.rb +30 -0
- data/spec/models/saml_metadata_import_response_spec.rb +112 -0
- data/spec/models/service_id_group_count_spec.rb +42 -0
- data/spec/models/service_id_group_list_spec.rb +36 -0
- data/spec/models/service_id_group_spec.rb +84 -0
- data/spec/models/service_id_list_spec.rb +15 -20
- data/spec/models/service_id_spec.rb +34 -27
- data/spec/models/share_scope_spec.rb +46 -0
- data/spec/models/template_account_settings_all_of_restrict_user_domains_spec.rb +42 -0
- data/spec/models/template_account_settings_spec.rb +102 -0
- data/spec/models/template_assignment_list_response_spec.rb +72 -0
- data/spec/models/template_assignment_resource_error_spec.rb +54 -0
- data/spec/models/template_assignment_resource_spec.rb +36 -0
- data/spec/models/template_assignment_response_resource_detail_spec.rb +60 -0
- data/spec/models/template_assignment_response_resource_spec.rb +54 -0
- data/spec/models/template_assignment_response_spec.rb +126 -0
- data/spec/models/template_count_spec.rb +42 -0
- data/spec/models/template_profile_component_request_spec.rb +60 -0
- data/spec/models/template_profile_component_response_spec.rb +60 -0
- data/spec/models/test_result_spec.rb +66 -0
- data/spec/models/test_result_steps_inner_spec.rb +54 -0
- data/spec/models/test_trigger_response_spec.rb +42 -0
- data/spec/models/token_response_spec.rb +14 -19
- data/spec/models/trusted_profile_spec.rb +132 -0
- data/spec/models/trusted_profile_template_claim_rule_spec.rb +64 -0
- data/spec/models/trusted_profile_template_list_spec.rb +72 -0
- data/spec/models/trusted_profile_template_request_spec.rb +66 -0
- data/spec/models/trusted_profile_template_response_spec.rb +126 -0
- data/spec/models/trusted_profiles_list_spec.rb +72 -0
- data/spec/models/update_account_idp_setting_request_spec.rb +52 -0
- data/spec/models/update_account_login_settings_spec.rb +36 -0
- data/spec/models/update_api_key_request_spec.rb +28 -15
- data/spec/models/update_id_p_request_properties_idp_spec.rb +54 -0
- data/spec/models/update_id_p_request_properties_spec.rb +42 -0
- data/spec/models/update_id_p_request_secrets_idp_spec.rb +42 -0
- data/spec/models/update_id_p_request_secrets_spec.rb +42 -0
- data/spec/models/update_id_p_request_spec.rb +66 -0
- data/spec/models/update_preference_request_spec.rb +42 -0
- data/spec/models/update_service_id_group_request_spec.rb +42 -0
- data/spec/models/update_service_id_request_spec.rb +11 -16
- data/spec/models/update_template_assignment_request_spec.rb +36 -0
- data/spec/models/update_trusted_profile_request_spec.rb +48 -0
- data/spec/models/user_activity_spec.rb +60 -0
- data/spec/models/user_mfa_enrollments_spec.rb +54 -0
- data/spec/models/user_mfa_resolved_spec.rb +54 -0
- data/spec/models/user_mfa_spec.rb +42 -0
- data/spec/models/user_report_mfa_enrollment_status_spec.rb +72 -0
- data/spec/models/user_visbility_retrict_actions_for_template_spec.rb +30 -0
- data/spec/models/user_visbility_retrict_actions_spec.rb +30 -0
- data/spec/spec_helper.rb +3 -3
- metadata +550 -36
- data/docs/IdentityOperationsApi.md +0 -828
- data/docs/InlineObject.md +0 -19
- data/docs/InlineObject1.md +0 -23
- data/docs/InlineObject2.md +0 -21
- data/docs/InlineObject3.md +0 -25
- data/docs/TokenOperationsApi.md +0 -226
- data/ibm_cloud_iam-1.0.0.gem +0 -0
- data/lib/ibm_cloud_iam/api/identity_operations_api.rb +0 -1083
- data/lib/ibm_cloud_iam/api/token_operations_api.rb +0 -351
- data/lib/ibm_cloud_iam/models/inline_object.rb +0 -229
- data/lib/ibm_cloud_iam/models/inline_object1.rb +0 -254
- data/lib/ibm_cloud_iam/models/inline_object2.rb +0 -244
- data/lib/ibm_cloud_iam/models/inline_object3.rb +0 -269
- data/spec/api/identity_operations_api_spec.rb +0 -253
- data/spec/api/token_operations_api_spec.rb +0 -94
- data/spec/api_client_spec.rb +0 -226
- data/spec/configuration_spec.rb +0 -42
- data/spec/models/inline_object1_spec.rb +0 -59
- data/spec/models/inline_object2_spec.rb +0 -53
- data/spec/models/inline_object3_spec.rb +0 -65
- data/spec/models/inline_object_spec.rb +0 -47
|
@@ -0,0 +1,720 @@
|
|
|
1
|
+
# IbmCloudIam::TrustedProfileTemplateApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://iam.cloud.ibm.com*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**commit_profile_template**](TrustedProfileTemplateApi.md#commit_profile_template) | **POST** /v1/profile_templates/{template_id}/versions/{version}/commit | Commit a template version |
|
|
8
|
+
| [**create_profile_template**](TrustedProfileTemplateApi.md#create_profile_template) | **POST** /v1/profile_templates | Create a trusted profile template |
|
|
9
|
+
| [**create_profile_template_version**](TrustedProfileTemplateApi.md#create_profile_template_version) | **POST** /v1/profile_templates/{template_id}/versions | Create new version of a trusted profile template |
|
|
10
|
+
| [**delete_all_versions_of_profile_template**](TrustedProfileTemplateApi.md#delete_all_versions_of_profile_template) | **DELETE** /v1/profile_templates/{template_id} | Delete all versions of a trusted profile template |
|
|
11
|
+
| [**delete_profile_template_version**](TrustedProfileTemplateApi.md#delete_profile_template_version) | **DELETE** /v1/profile_templates/{template_id}/versions/{version} | Delete version of trusted profile template |
|
|
12
|
+
| [**get_latest_profile_template_version**](TrustedProfileTemplateApi.md#get_latest_profile_template_version) | **GET** /v1/profile_templates/{template_id} | Get latest version of a trusted profile template |
|
|
13
|
+
| [**get_profile_template_version**](TrustedProfileTemplateApi.md#get_profile_template_version) | **GET** /v1/profile_templates/{template_id}/versions/{version} | Get version of trusted profile template |
|
|
14
|
+
| [**list_profile_templates**](TrustedProfileTemplateApi.md#list_profile_templates) | **GET** /v1/profile_templates | List trusted profile templates |
|
|
15
|
+
| [**list_versions_of_profile_template**](TrustedProfileTemplateApi.md#list_versions_of_profile_template) | **GET** /v1/profile_templates/{template_id}/versions | List trusted profile template versions |
|
|
16
|
+
| [**update_profile_template_version**](TrustedProfileTemplateApi.md#update_profile_template_version) | **PUT** /v1/profile_templates/{template_id}/versions/{version} | Update version of trusted profile template |
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
## commit_profile_template
|
|
20
|
+
|
|
21
|
+
> commit_profile_template(template_id, version, authorization)
|
|
22
|
+
|
|
23
|
+
Commit a template version
|
|
24
|
+
|
|
25
|
+
Commit a specific version of a trusted profile template in an enterprise account. You must commit a template before you can assign it to child accounts. Once a template is committed, you can no longer modify the template.
|
|
26
|
+
|
|
27
|
+
### Examples
|
|
28
|
+
|
|
29
|
+
```ruby
|
|
30
|
+
require 'time'
|
|
31
|
+
require 'ibm_cloud_iam'
|
|
32
|
+
|
|
33
|
+
api_instance = IbmCloudIam::TrustedProfileTemplateApi.new
|
|
34
|
+
template_id = 'template_id_example' # String | ID of the trusted profile template
|
|
35
|
+
version = 'version_example' # String | Version of the Profile Template
|
|
36
|
+
authorization = 'authorization_example' # String | Authorization Token used for the request. The supported token type is a Cloud IAM Access Token. If the token is omitted the request will fail with BXNIM0308E: 'No authorization header found'. Make sure that the provided token has the required authority for the request.
|
|
37
|
+
|
|
38
|
+
begin
|
|
39
|
+
# Commit a template version
|
|
40
|
+
api_instance.commit_profile_template(template_id, version, authorization)
|
|
41
|
+
rescue IbmCloudIam::ApiError => e
|
|
42
|
+
puts "Error when calling TrustedProfileTemplateApi->commit_profile_template: #{e}"
|
|
43
|
+
end
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
#### Using the commit_profile_template_with_http_info variant
|
|
47
|
+
|
|
48
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
49
|
+
|
|
50
|
+
> <Array(nil, Integer, Hash)> commit_profile_template_with_http_info(template_id, version, authorization)
|
|
51
|
+
|
|
52
|
+
```ruby
|
|
53
|
+
begin
|
|
54
|
+
# Commit a template version
|
|
55
|
+
data, status_code, headers = api_instance.commit_profile_template_with_http_info(template_id, version, authorization)
|
|
56
|
+
p status_code # => 2xx
|
|
57
|
+
p headers # => { ... }
|
|
58
|
+
p data # => nil
|
|
59
|
+
rescue IbmCloudIam::ApiError => e
|
|
60
|
+
puts "Error when calling TrustedProfileTemplateApi->commit_profile_template_with_http_info: #{e}"
|
|
61
|
+
end
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
### Parameters
|
|
65
|
+
|
|
66
|
+
| Name | Type | Description | Notes |
|
|
67
|
+
| ---- | ---- | ----------- | ----- |
|
|
68
|
+
| **template_id** | **String** | ID of the trusted profile template | |
|
|
69
|
+
| **version** | **String** | Version of the Profile Template | |
|
|
70
|
+
| **authorization** | **String** | Authorization Token used for the request. The supported token type is a Cloud IAM Access Token. If the token is omitted the request will fail with BXNIM0308E: 'No authorization header found'. Make sure that the provided token has the required authority for the request. | |
|
|
71
|
+
|
|
72
|
+
### Return type
|
|
73
|
+
|
|
74
|
+
nil (empty response body)
|
|
75
|
+
|
|
76
|
+
### Authorization
|
|
77
|
+
|
|
78
|
+
No authorization required
|
|
79
|
+
|
|
80
|
+
### HTTP request headers
|
|
81
|
+
|
|
82
|
+
- **Content-Type**: Not defined
|
|
83
|
+
- **Accept**: Not defined
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
## create_profile_template
|
|
87
|
+
|
|
88
|
+
> <TrustedProfileTemplateResponse> create_profile_template(authorization, trusted_profile_template_request)
|
|
89
|
+
|
|
90
|
+
Create a trusted profile template
|
|
91
|
+
|
|
92
|
+
Create a new trusted profile template in an enterprise account.
|
|
93
|
+
|
|
94
|
+
### Examples
|
|
95
|
+
|
|
96
|
+
```ruby
|
|
97
|
+
require 'time'
|
|
98
|
+
require 'ibm_cloud_iam'
|
|
99
|
+
|
|
100
|
+
api_instance = IbmCloudIam::TrustedProfileTemplateApi.new
|
|
101
|
+
authorization = 'authorization_example' # String | Authorization Token used for the request. The supported token type is a Cloud IAM Access Token. If the token is omitted the request will fail with BXNIM0308E: 'No authorization header found'. Make sure that the provided token has the required authority for the request.
|
|
102
|
+
trusted_profile_template_request = IbmCloudIam::TrustedProfileTemplateRequest.new # TrustedProfileTemplateRequest | Request to create a trusted profile template.
|
|
103
|
+
|
|
104
|
+
begin
|
|
105
|
+
# Create a trusted profile template
|
|
106
|
+
result = api_instance.create_profile_template(authorization, trusted_profile_template_request)
|
|
107
|
+
p result
|
|
108
|
+
rescue IbmCloudIam::ApiError => e
|
|
109
|
+
puts "Error when calling TrustedProfileTemplateApi->create_profile_template: #{e}"
|
|
110
|
+
end
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
#### Using the create_profile_template_with_http_info variant
|
|
114
|
+
|
|
115
|
+
This returns an Array which contains the response data, status code and headers.
|
|
116
|
+
|
|
117
|
+
> <Array(<TrustedProfileTemplateResponse>, Integer, Hash)> create_profile_template_with_http_info(authorization, trusted_profile_template_request)
|
|
118
|
+
|
|
119
|
+
```ruby
|
|
120
|
+
begin
|
|
121
|
+
# Create a trusted profile template
|
|
122
|
+
data, status_code, headers = api_instance.create_profile_template_with_http_info(authorization, trusted_profile_template_request)
|
|
123
|
+
p status_code # => 2xx
|
|
124
|
+
p headers # => { ... }
|
|
125
|
+
p data # => <TrustedProfileTemplateResponse>
|
|
126
|
+
rescue IbmCloudIam::ApiError => e
|
|
127
|
+
puts "Error when calling TrustedProfileTemplateApi->create_profile_template_with_http_info: #{e}"
|
|
128
|
+
end
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
### Parameters
|
|
132
|
+
|
|
133
|
+
| Name | Type | Description | Notes |
|
|
134
|
+
| ---- | ---- | ----------- | ----- |
|
|
135
|
+
| **authorization** | **String** | Authorization Token used for the request. The supported token type is a Cloud IAM Access Token. If the token is omitted the request will fail with BXNIM0308E: 'No authorization header found'. Make sure that the provided token has the required authority for the request. | |
|
|
136
|
+
| **trusted_profile_template_request** | [**TrustedProfileTemplateRequest**](TrustedProfileTemplateRequest.md) | Request to create a trusted profile template. | |
|
|
137
|
+
|
|
138
|
+
### Return type
|
|
139
|
+
|
|
140
|
+
[**TrustedProfileTemplateResponse**](TrustedProfileTemplateResponse.md)
|
|
141
|
+
|
|
142
|
+
### Authorization
|
|
143
|
+
|
|
144
|
+
No authorization required
|
|
145
|
+
|
|
146
|
+
### HTTP request headers
|
|
147
|
+
|
|
148
|
+
- **Content-Type**: application/json
|
|
149
|
+
- **Accept**: application/json
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
## create_profile_template_version
|
|
153
|
+
|
|
154
|
+
> <TrustedProfileTemplateResponse> create_profile_template_version(template_id, authorization, trusted_profile_template_request)
|
|
155
|
+
|
|
156
|
+
Create new version of a trusted profile template
|
|
157
|
+
|
|
158
|
+
Create a new version of a trusted profile template in an enterprise account.
|
|
159
|
+
|
|
160
|
+
### Examples
|
|
161
|
+
|
|
162
|
+
```ruby
|
|
163
|
+
require 'time'
|
|
164
|
+
require 'ibm_cloud_iam'
|
|
165
|
+
|
|
166
|
+
api_instance = IbmCloudIam::TrustedProfileTemplateApi.new
|
|
167
|
+
template_id = 'template_id_example' # String | ID of the trusted profile template
|
|
168
|
+
authorization = 'authorization_example' # String | Authorization Token used for the request. The supported token type is a Cloud IAM Access Token. If the token is omitted the request will fail with BXNIM0308E: 'No authorization header found'. Make sure that the provided token has the required authority for the request.
|
|
169
|
+
trusted_profile_template_request = IbmCloudIam::TrustedProfileTemplateRequest.new # TrustedProfileTemplateRequest | Request to create new version of a Trusted Profile Template
|
|
170
|
+
|
|
171
|
+
begin
|
|
172
|
+
# Create new version of a trusted profile template
|
|
173
|
+
result = api_instance.create_profile_template_version(template_id, authorization, trusted_profile_template_request)
|
|
174
|
+
p result
|
|
175
|
+
rescue IbmCloudIam::ApiError => e
|
|
176
|
+
puts "Error when calling TrustedProfileTemplateApi->create_profile_template_version: #{e}"
|
|
177
|
+
end
|
|
178
|
+
```
|
|
179
|
+
|
|
180
|
+
#### Using the create_profile_template_version_with_http_info variant
|
|
181
|
+
|
|
182
|
+
This returns an Array which contains the response data, status code and headers.
|
|
183
|
+
|
|
184
|
+
> <Array(<TrustedProfileTemplateResponse>, Integer, Hash)> create_profile_template_version_with_http_info(template_id, authorization, trusted_profile_template_request)
|
|
185
|
+
|
|
186
|
+
```ruby
|
|
187
|
+
begin
|
|
188
|
+
# Create new version of a trusted profile template
|
|
189
|
+
data, status_code, headers = api_instance.create_profile_template_version_with_http_info(template_id, authorization, trusted_profile_template_request)
|
|
190
|
+
p status_code # => 2xx
|
|
191
|
+
p headers # => { ... }
|
|
192
|
+
p data # => <TrustedProfileTemplateResponse>
|
|
193
|
+
rescue IbmCloudIam::ApiError => e
|
|
194
|
+
puts "Error when calling TrustedProfileTemplateApi->create_profile_template_version_with_http_info: #{e}"
|
|
195
|
+
end
|
|
196
|
+
```
|
|
197
|
+
|
|
198
|
+
### Parameters
|
|
199
|
+
|
|
200
|
+
| Name | Type | Description | Notes |
|
|
201
|
+
| ---- | ---- | ----------- | ----- |
|
|
202
|
+
| **template_id** | **String** | ID of the trusted profile template | |
|
|
203
|
+
| **authorization** | **String** | Authorization Token used for the request. The supported token type is a Cloud IAM Access Token. If the token is omitted the request will fail with BXNIM0308E: 'No authorization header found'. Make sure that the provided token has the required authority for the request. | |
|
|
204
|
+
| **trusted_profile_template_request** | [**TrustedProfileTemplateRequest**](TrustedProfileTemplateRequest.md) | Request to create new version of a Trusted Profile Template | |
|
|
205
|
+
|
|
206
|
+
### Return type
|
|
207
|
+
|
|
208
|
+
[**TrustedProfileTemplateResponse**](TrustedProfileTemplateResponse.md)
|
|
209
|
+
|
|
210
|
+
### Authorization
|
|
211
|
+
|
|
212
|
+
No authorization required
|
|
213
|
+
|
|
214
|
+
### HTTP request headers
|
|
215
|
+
|
|
216
|
+
- **Content-Type**: application/json
|
|
217
|
+
- **Accept**: application/json
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
## delete_all_versions_of_profile_template
|
|
221
|
+
|
|
222
|
+
> delete_all_versions_of_profile_template(template_id, authorization)
|
|
223
|
+
|
|
224
|
+
Delete all versions of a trusted profile template
|
|
225
|
+
|
|
226
|
+
Delete all versions of a trusted profile template in an enterprise account. If any version is assigned to child accounts, you must first delete the assignment.
|
|
227
|
+
|
|
228
|
+
### Examples
|
|
229
|
+
|
|
230
|
+
```ruby
|
|
231
|
+
require 'time'
|
|
232
|
+
require 'ibm_cloud_iam'
|
|
233
|
+
|
|
234
|
+
api_instance = IbmCloudIam::TrustedProfileTemplateApi.new
|
|
235
|
+
template_id = 'template_id_example' # String | ID of the trusted profile template
|
|
236
|
+
authorization = 'authorization_example' # String | Authorization Token used for the request. The supported token type is a Cloud IAM Access Token. If the token is omitted the request will fail with BXNIM0308E: 'No authorization header found'. Make sure that the provided token has the required authority for the request.
|
|
237
|
+
|
|
238
|
+
begin
|
|
239
|
+
# Delete all versions of a trusted profile template
|
|
240
|
+
api_instance.delete_all_versions_of_profile_template(template_id, authorization)
|
|
241
|
+
rescue IbmCloudIam::ApiError => e
|
|
242
|
+
puts "Error when calling TrustedProfileTemplateApi->delete_all_versions_of_profile_template: #{e}"
|
|
243
|
+
end
|
|
244
|
+
```
|
|
245
|
+
|
|
246
|
+
#### Using the delete_all_versions_of_profile_template_with_http_info variant
|
|
247
|
+
|
|
248
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
249
|
+
|
|
250
|
+
> <Array(nil, Integer, Hash)> delete_all_versions_of_profile_template_with_http_info(template_id, authorization)
|
|
251
|
+
|
|
252
|
+
```ruby
|
|
253
|
+
begin
|
|
254
|
+
# Delete all versions of a trusted profile template
|
|
255
|
+
data, status_code, headers = api_instance.delete_all_versions_of_profile_template_with_http_info(template_id, authorization)
|
|
256
|
+
p status_code # => 2xx
|
|
257
|
+
p headers # => { ... }
|
|
258
|
+
p data # => nil
|
|
259
|
+
rescue IbmCloudIam::ApiError => e
|
|
260
|
+
puts "Error when calling TrustedProfileTemplateApi->delete_all_versions_of_profile_template_with_http_info: #{e}"
|
|
261
|
+
end
|
|
262
|
+
```
|
|
263
|
+
|
|
264
|
+
### Parameters
|
|
265
|
+
|
|
266
|
+
| Name | Type | Description | Notes |
|
|
267
|
+
| ---- | ---- | ----------- | ----- |
|
|
268
|
+
| **template_id** | **String** | ID of the trusted profile template | |
|
|
269
|
+
| **authorization** | **String** | Authorization Token used for the request. The supported token type is a Cloud IAM Access Token. If the token is omitted the request will fail with BXNIM0308E: 'No authorization header found'. Make sure that the provided token has the required authority for the request. | |
|
|
270
|
+
|
|
271
|
+
### Return type
|
|
272
|
+
|
|
273
|
+
nil (empty response body)
|
|
274
|
+
|
|
275
|
+
### Authorization
|
|
276
|
+
|
|
277
|
+
No authorization required
|
|
278
|
+
|
|
279
|
+
### HTTP request headers
|
|
280
|
+
|
|
281
|
+
- **Content-Type**: Not defined
|
|
282
|
+
- **Accept**: Not defined
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
## delete_profile_template_version
|
|
286
|
+
|
|
287
|
+
> delete_profile_template_version(template_id, version, authorization)
|
|
288
|
+
|
|
289
|
+
Delete version of trusted profile template
|
|
290
|
+
|
|
291
|
+
Delete a specific version of a trusted profile template in an enterprise account. If the version is assigned to child accounts, you must first delete the assignment.
|
|
292
|
+
|
|
293
|
+
### Examples
|
|
294
|
+
|
|
295
|
+
```ruby
|
|
296
|
+
require 'time'
|
|
297
|
+
require 'ibm_cloud_iam'
|
|
298
|
+
|
|
299
|
+
api_instance = IbmCloudIam::TrustedProfileTemplateApi.new
|
|
300
|
+
template_id = 'template_id_example' # String | ID of the trusted profile template
|
|
301
|
+
version = 'version_example' # String | Version of the Profile Template
|
|
302
|
+
authorization = 'authorization_example' # String | Authorization Token used for the request. The supported token type is a Cloud IAM Access Token. If the token is omitted the request will fail with BXNIM0308E: 'No authorization header found'. Make sure that the provided token has the required authority for the request.
|
|
303
|
+
|
|
304
|
+
begin
|
|
305
|
+
# Delete version of trusted profile template
|
|
306
|
+
api_instance.delete_profile_template_version(template_id, version, authorization)
|
|
307
|
+
rescue IbmCloudIam::ApiError => e
|
|
308
|
+
puts "Error when calling TrustedProfileTemplateApi->delete_profile_template_version: #{e}"
|
|
309
|
+
end
|
|
310
|
+
```
|
|
311
|
+
|
|
312
|
+
#### Using the delete_profile_template_version_with_http_info variant
|
|
313
|
+
|
|
314
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
315
|
+
|
|
316
|
+
> <Array(nil, Integer, Hash)> delete_profile_template_version_with_http_info(template_id, version, authorization)
|
|
317
|
+
|
|
318
|
+
```ruby
|
|
319
|
+
begin
|
|
320
|
+
# Delete version of trusted profile template
|
|
321
|
+
data, status_code, headers = api_instance.delete_profile_template_version_with_http_info(template_id, version, authorization)
|
|
322
|
+
p status_code # => 2xx
|
|
323
|
+
p headers # => { ... }
|
|
324
|
+
p data # => nil
|
|
325
|
+
rescue IbmCloudIam::ApiError => e
|
|
326
|
+
puts "Error when calling TrustedProfileTemplateApi->delete_profile_template_version_with_http_info: #{e}"
|
|
327
|
+
end
|
|
328
|
+
```
|
|
329
|
+
|
|
330
|
+
### Parameters
|
|
331
|
+
|
|
332
|
+
| Name | Type | Description | Notes |
|
|
333
|
+
| ---- | ---- | ----------- | ----- |
|
|
334
|
+
| **template_id** | **String** | ID of the trusted profile template | |
|
|
335
|
+
| **version** | **String** | Version of the Profile Template | |
|
|
336
|
+
| **authorization** | **String** | Authorization Token used for the request. The supported token type is a Cloud IAM Access Token. If the token is omitted the request will fail with BXNIM0308E: 'No authorization header found'. Make sure that the provided token has the required authority for the request. | |
|
|
337
|
+
|
|
338
|
+
### Return type
|
|
339
|
+
|
|
340
|
+
nil (empty response body)
|
|
341
|
+
|
|
342
|
+
### Authorization
|
|
343
|
+
|
|
344
|
+
No authorization required
|
|
345
|
+
|
|
346
|
+
### HTTP request headers
|
|
347
|
+
|
|
348
|
+
- **Content-Type**: Not defined
|
|
349
|
+
- **Accept**: Not defined
|
|
350
|
+
|
|
351
|
+
|
|
352
|
+
## get_latest_profile_template_version
|
|
353
|
+
|
|
354
|
+
> <TrustedProfileTemplateResponse> get_latest_profile_template_version(template_id, authorization, opts)
|
|
355
|
+
|
|
356
|
+
Get latest version of a trusted profile template
|
|
357
|
+
|
|
358
|
+
Get the latest version of a trusted profile template in an enterprise account.
|
|
359
|
+
|
|
360
|
+
### Examples
|
|
361
|
+
|
|
362
|
+
```ruby
|
|
363
|
+
require 'time'
|
|
364
|
+
require 'ibm_cloud_iam'
|
|
365
|
+
|
|
366
|
+
api_instance = IbmCloudIam::TrustedProfileTemplateApi.new
|
|
367
|
+
template_id = 'template_id_example' # String | ID of the trusted profile template
|
|
368
|
+
authorization = 'authorization_example' # String | Authorization Token used for the request. The supported token type is a Cloud IAM Access Token. If the token is omitted the request will fail with BXNIM0308E: 'No authorization header found'. Make sure that the provided token has the required authority for the request.
|
|
369
|
+
opts = {
|
|
370
|
+
include_history: true # Boolean | Defines if the entity history is included in the response
|
|
371
|
+
}
|
|
372
|
+
|
|
373
|
+
begin
|
|
374
|
+
# Get latest version of a trusted profile template
|
|
375
|
+
result = api_instance.get_latest_profile_template_version(template_id, authorization, opts)
|
|
376
|
+
p result
|
|
377
|
+
rescue IbmCloudIam::ApiError => e
|
|
378
|
+
puts "Error when calling TrustedProfileTemplateApi->get_latest_profile_template_version: #{e}"
|
|
379
|
+
end
|
|
380
|
+
```
|
|
381
|
+
|
|
382
|
+
#### Using the get_latest_profile_template_version_with_http_info variant
|
|
383
|
+
|
|
384
|
+
This returns an Array which contains the response data, status code and headers.
|
|
385
|
+
|
|
386
|
+
> <Array(<TrustedProfileTemplateResponse>, Integer, Hash)> get_latest_profile_template_version_with_http_info(template_id, authorization, opts)
|
|
387
|
+
|
|
388
|
+
```ruby
|
|
389
|
+
begin
|
|
390
|
+
# Get latest version of a trusted profile template
|
|
391
|
+
data, status_code, headers = api_instance.get_latest_profile_template_version_with_http_info(template_id, authorization, opts)
|
|
392
|
+
p status_code # => 2xx
|
|
393
|
+
p headers # => { ... }
|
|
394
|
+
p data # => <TrustedProfileTemplateResponse>
|
|
395
|
+
rescue IbmCloudIam::ApiError => e
|
|
396
|
+
puts "Error when calling TrustedProfileTemplateApi->get_latest_profile_template_version_with_http_info: #{e}"
|
|
397
|
+
end
|
|
398
|
+
```
|
|
399
|
+
|
|
400
|
+
### Parameters
|
|
401
|
+
|
|
402
|
+
| Name | Type | Description | Notes |
|
|
403
|
+
| ---- | ---- | ----------- | ----- |
|
|
404
|
+
| **template_id** | **String** | ID of the trusted profile template | |
|
|
405
|
+
| **authorization** | **String** | Authorization Token used for the request. The supported token type is a Cloud IAM Access Token. If the token is omitted the request will fail with BXNIM0308E: 'No authorization header found'. Make sure that the provided token has the required authority for the request. | |
|
|
406
|
+
| **include_history** | **Boolean** | Defines if the entity history is included in the response | [optional][default to false] |
|
|
407
|
+
|
|
408
|
+
### Return type
|
|
409
|
+
|
|
410
|
+
[**TrustedProfileTemplateResponse**](TrustedProfileTemplateResponse.md)
|
|
411
|
+
|
|
412
|
+
### Authorization
|
|
413
|
+
|
|
414
|
+
No authorization required
|
|
415
|
+
|
|
416
|
+
### HTTP request headers
|
|
417
|
+
|
|
418
|
+
- **Content-Type**: Not defined
|
|
419
|
+
- **Accept**: application/json
|
|
420
|
+
|
|
421
|
+
|
|
422
|
+
## get_profile_template_version
|
|
423
|
+
|
|
424
|
+
> <TrustedProfileTemplateResponse> get_profile_template_version(template_id, version, authorization, opts)
|
|
425
|
+
|
|
426
|
+
Get version of trusted profile template
|
|
427
|
+
|
|
428
|
+
Get a specific version of a trusted profile template in an enterprise account.
|
|
429
|
+
|
|
430
|
+
### Examples
|
|
431
|
+
|
|
432
|
+
```ruby
|
|
433
|
+
require 'time'
|
|
434
|
+
require 'ibm_cloud_iam'
|
|
435
|
+
|
|
436
|
+
api_instance = IbmCloudIam::TrustedProfileTemplateApi.new
|
|
437
|
+
template_id = 'template_id_example' # String | ID of the trusted profile template
|
|
438
|
+
version = 'version_example' # String | Version of the Profile Template
|
|
439
|
+
authorization = 'authorization_example' # String | Authorization Token used for the request. The supported token type is a Cloud IAM Access Token. If the token is omitted the request will fail with BXNIM0308E: 'No authorization header found'. Make sure that the provided token has the required authority for the request.
|
|
440
|
+
opts = {
|
|
441
|
+
include_history: true # Boolean | Defines if the entity history is included in the response
|
|
442
|
+
}
|
|
443
|
+
|
|
444
|
+
begin
|
|
445
|
+
# Get version of trusted profile template
|
|
446
|
+
result = api_instance.get_profile_template_version(template_id, version, authorization, opts)
|
|
447
|
+
p result
|
|
448
|
+
rescue IbmCloudIam::ApiError => e
|
|
449
|
+
puts "Error when calling TrustedProfileTemplateApi->get_profile_template_version: #{e}"
|
|
450
|
+
end
|
|
451
|
+
```
|
|
452
|
+
|
|
453
|
+
#### Using the get_profile_template_version_with_http_info variant
|
|
454
|
+
|
|
455
|
+
This returns an Array which contains the response data, status code and headers.
|
|
456
|
+
|
|
457
|
+
> <Array(<TrustedProfileTemplateResponse>, Integer, Hash)> get_profile_template_version_with_http_info(template_id, version, authorization, opts)
|
|
458
|
+
|
|
459
|
+
```ruby
|
|
460
|
+
begin
|
|
461
|
+
# Get version of trusted profile template
|
|
462
|
+
data, status_code, headers = api_instance.get_profile_template_version_with_http_info(template_id, version, authorization, opts)
|
|
463
|
+
p status_code # => 2xx
|
|
464
|
+
p headers # => { ... }
|
|
465
|
+
p data # => <TrustedProfileTemplateResponse>
|
|
466
|
+
rescue IbmCloudIam::ApiError => e
|
|
467
|
+
puts "Error when calling TrustedProfileTemplateApi->get_profile_template_version_with_http_info: #{e}"
|
|
468
|
+
end
|
|
469
|
+
```
|
|
470
|
+
|
|
471
|
+
### Parameters
|
|
472
|
+
|
|
473
|
+
| Name | Type | Description | Notes |
|
|
474
|
+
| ---- | ---- | ----------- | ----- |
|
|
475
|
+
| **template_id** | **String** | ID of the trusted profile template | |
|
|
476
|
+
| **version** | **String** | Version of the Profile Template | |
|
|
477
|
+
| **authorization** | **String** | Authorization Token used for the request. The supported token type is a Cloud IAM Access Token. If the token is omitted the request will fail with BXNIM0308E: 'No authorization header found'. Make sure that the provided token has the required authority for the request. | |
|
|
478
|
+
| **include_history** | **Boolean** | Defines if the entity history is included in the response | [optional][default to false] |
|
|
479
|
+
|
|
480
|
+
### Return type
|
|
481
|
+
|
|
482
|
+
[**TrustedProfileTemplateResponse**](TrustedProfileTemplateResponse.md)
|
|
483
|
+
|
|
484
|
+
### Authorization
|
|
485
|
+
|
|
486
|
+
No authorization required
|
|
487
|
+
|
|
488
|
+
### HTTP request headers
|
|
489
|
+
|
|
490
|
+
- **Content-Type**: Not defined
|
|
491
|
+
- **Accept**: application/json
|
|
492
|
+
|
|
493
|
+
|
|
494
|
+
## list_profile_templates
|
|
495
|
+
|
|
496
|
+
> <TrustedProfileTemplateList> list_profile_templates(authorization, opts)
|
|
497
|
+
|
|
498
|
+
List trusted profile templates
|
|
499
|
+
|
|
500
|
+
List the trusted profile templates in an enterprise account.
|
|
501
|
+
|
|
502
|
+
### Examples
|
|
503
|
+
|
|
504
|
+
```ruby
|
|
505
|
+
require 'time'
|
|
506
|
+
require 'ibm_cloud_iam'
|
|
507
|
+
|
|
508
|
+
api_instance = IbmCloudIam::TrustedProfileTemplateApi.new
|
|
509
|
+
authorization = 'authorization_example' # String | Authorization Token used for the request. The supported token type is a Cloud IAM Access Token. If the token is omitted the request will fail with BXNIM0308E: 'No authorization header found'. Make sure that the provided token has the required authority for the request.
|
|
510
|
+
opts = {
|
|
511
|
+
account_id: 'account_id_example', # String | Account ID of the trusted profile templates to query. This parameter is required unless using a pagetoken.
|
|
512
|
+
limit: 'limit_example', # String | Optional size of a single page.
|
|
513
|
+
pagetoken: 'pagetoken_example', # String | Optional Prev or Next page token returned from a previous query execution. Default is start with first page.
|
|
514
|
+
sort: 'created_at', # String | Optional sort property. If specified, the returned templates are sorted according to this property.
|
|
515
|
+
order: 'asc', # String | Optional sort order.
|
|
516
|
+
include_history: 'include_history_example' # String | Defines if the entity history is included in the response.
|
|
517
|
+
}
|
|
518
|
+
|
|
519
|
+
begin
|
|
520
|
+
# List trusted profile templates
|
|
521
|
+
result = api_instance.list_profile_templates(authorization, opts)
|
|
522
|
+
p result
|
|
523
|
+
rescue IbmCloudIam::ApiError => e
|
|
524
|
+
puts "Error when calling TrustedProfileTemplateApi->list_profile_templates: #{e}"
|
|
525
|
+
end
|
|
526
|
+
```
|
|
527
|
+
|
|
528
|
+
#### Using the list_profile_templates_with_http_info variant
|
|
529
|
+
|
|
530
|
+
This returns an Array which contains the response data, status code and headers.
|
|
531
|
+
|
|
532
|
+
> <Array(<TrustedProfileTemplateList>, Integer, Hash)> list_profile_templates_with_http_info(authorization, opts)
|
|
533
|
+
|
|
534
|
+
```ruby
|
|
535
|
+
begin
|
|
536
|
+
# List trusted profile templates
|
|
537
|
+
data, status_code, headers = api_instance.list_profile_templates_with_http_info(authorization, opts)
|
|
538
|
+
p status_code # => 2xx
|
|
539
|
+
p headers # => { ... }
|
|
540
|
+
p data # => <TrustedProfileTemplateList>
|
|
541
|
+
rescue IbmCloudIam::ApiError => e
|
|
542
|
+
puts "Error when calling TrustedProfileTemplateApi->list_profile_templates_with_http_info: #{e}"
|
|
543
|
+
end
|
|
544
|
+
```
|
|
545
|
+
|
|
546
|
+
### Parameters
|
|
547
|
+
|
|
548
|
+
| Name | Type | Description | Notes |
|
|
549
|
+
| ---- | ---- | ----------- | ----- |
|
|
550
|
+
| **authorization** | **String** | Authorization Token used for the request. The supported token type is a Cloud IAM Access Token. If the token is omitted the request will fail with BXNIM0308E: 'No authorization header found'. Make sure that the provided token has the required authority for the request. | |
|
|
551
|
+
| **account_id** | **String** | Account ID of the trusted profile templates to query. This parameter is required unless using a pagetoken. | [optional] |
|
|
552
|
+
| **limit** | **String** | Optional size of a single page. | [optional][default to '20'] |
|
|
553
|
+
| **pagetoken** | **String** | Optional Prev or Next page token returned from a previous query execution. Default is start with first page. | [optional] |
|
|
554
|
+
| **sort** | **String** | Optional sort property. If specified, the returned templates are sorted according to this property. | [optional][default to 'created_at'] |
|
|
555
|
+
| **order** | **String** | Optional sort order. | [optional][default to 'asc'] |
|
|
556
|
+
| **include_history** | **String** | Defines if the entity history is included in the response. | [optional][default to 'false'] |
|
|
557
|
+
|
|
558
|
+
### Return type
|
|
559
|
+
|
|
560
|
+
[**TrustedProfileTemplateList**](TrustedProfileTemplateList.md)
|
|
561
|
+
|
|
562
|
+
### Authorization
|
|
563
|
+
|
|
564
|
+
No authorization required
|
|
565
|
+
|
|
566
|
+
### HTTP request headers
|
|
567
|
+
|
|
568
|
+
- **Content-Type**: Not defined
|
|
569
|
+
- **Accept**: application/json
|
|
570
|
+
|
|
571
|
+
|
|
572
|
+
## list_versions_of_profile_template
|
|
573
|
+
|
|
574
|
+
> <TrustedProfileTemplateList> list_versions_of_profile_template(template_id, authorization, opts)
|
|
575
|
+
|
|
576
|
+
List trusted profile template versions
|
|
577
|
+
|
|
578
|
+
List the versions of a trusted profile template in an enterprise account.
|
|
579
|
+
|
|
580
|
+
### Examples
|
|
581
|
+
|
|
582
|
+
```ruby
|
|
583
|
+
require 'time'
|
|
584
|
+
require 'ibm_cloud_iam'
|
|
585
|
+
|
|
586
|
+
api_instance = IbmCloudIam::TrustedProfileTemplateApi.new
|
|
587
|
+
template_id = 'template_id_example' # String | ID of the trusted profile template
|
|
588
|
+
authorization = 'authorization_example' # String | Authorization Token used for the request. The supported token type is a Cloud IAM Access Token. If the token is omitted the request will fail with BXNIM0308E: 'No authorization header found'. Make sure that the provided token has the required authority for the request.
|
|
589
|
+
opts = {
|
|
590
|
+
limit: 'limit_example', # String | Optional size of a single page.
|
|
591
|
+
pagetoken: 'pagetoken_example', # String | Optional Prev or Next page token returned from a previous query execution. Default is start with first page.
|
|
592
|
+
sort: 'created_at', # String | Optional sort property. If specified, the returned templated are sorted according to this property
|
|
593
|
+
order: 'asc', # String | Optional sort order.
|
|
594
|
+
include_history: 'include_history_example' # String | Defines if the entity history is included in the response
|
|
595
|
+
}
|
|
596
|
+
|
|
597
|
+
begin
|
|
598
|
+
# List trusted profile template versions
|
|
599
|
+
result = api_instance.list_versions_of_profile_template(template_id, authorization, opts)
|
|
600
|
+
p result
|
|
601
|
+
rescue IbmCloudIam::ApiError => e
|
|
602
|
+
puts "Error when calling TrustedProfileTemplateApi->list_versions_of_profile_template: #{e}"
|
|
603
|
+
end
|
|
604
|
+
```
|
|
605
|
+
|
|
606
|
+
#### Using the list_versions_of_profile_template_with_http_info variant
|
|
607
|
+
|
|
608
|
+
This returns an Array which contains the response data, status code and headers.
|
|
609
|
+
|
|
610
|
+
> <Array(<TrustedProfileTemplateList>, Integer, Hash)> list_versions_of_profile_template_with_http_info(template_id, authorization, opts)
|
|
611
|
+
|
|
612
|
+
```ruby
|
|
613
|
+
begin
|
|
614
|
+
# List trusted profile template versions
|
|
615
|
+
data, status_code, headers = api_instance.list_versions_of_profile_template_with_http_info(template_id, authorization, opts)
|
|
616
|
+
p status_code # => 2xx
|
|
617
|
+
p headers # => { ... }
|
|
618
|
+
p data # => <TrustedProfileTemplateList>
|
|
619
|
+
rescue IbmCloudIam::ApiError => e
|
|
620
|
+
puts "Error when calling TrustedProfileTemplateApi->list_versions_of_profile_template_with_http_info: #{e}"
|
|
621
|
+
end
|
|
622
|
+
```
|
|
623
|
+
|
|
624
|
+
### Parameters
|
|
625
|
+
|
|
626
|
+
| Name | Type | Description | Notes |
|
|
627
|
+
| ---- | ---- | ----------- | ----- |
|
|
628
|
+
| **template_id** | **String** | ID of the trusted profile template | |
|
|
629
|
+
| **authorization** | **String** | Authorization Token used for the request. The supported token type is a Cloud IAM Access Token. If the token is omitted the request will fail with BXNIM0308E: 'No authorization header found'. Make sure that the provided token has the required authority for the request. | |
|
|
630
|
+
| **limit** | **String** | Optional size of a single page. | [optional][default to '20'] |
|
|
631
|
+
| **pagetoken** | **String** | Optional Prev or Next page token returned from a previous query execution. Default is start with first page. | [optional] |
|
|
632
|
+
| **sort** | **String** | Optional sort property. If specified, the returned templated are sorted according to this property | [optional][default to 'created_at'] |
|
|
633
|
+
| **order** | **String** | Optional sort order. | [optional][default to 'asc'] |
|
|
634
|
+
| **include_history** | **String** | Defines if the entity history is included in the response | [optional][default to 'false'] |
|
|
635
|
+
|
|
636
|
+
### Return type
|
|
637
|
+
|
|
638
|
+
[**TrustedProfileTemplateList**](TrustedProfileTemplateList.md)
|
|
639
|
+
|
|
640
|
+
### Authorization
|
|
641
|
+
|
|
642
|
+
No authorization required
|
|
643
|
+
|
|
644
|
+
### HTTP request headers
|
|
645
|
+
|
|
646
|
+
- **Content-Type**: Not defined
|
|
647
|
+
- **Accept**: application/json
|
|
648
|
+
|
|
649
|
+
|
|
650
|
+
## update_profile_template_version
|
|
651
|
+
|
|
652
|
+
> <TrustedProfileTemplateResponse> update_profile_template_version(if_match, template_id, version, authorization, trusted_profile_template_request)
|
|
653
|
+
|
|
654
|
+
Update version of trusted profile template
|
|
655
|
+
|
|
656
|
+
Update a specific version of a trusted profile template in an enterprise account.
|
|
657
|
+
|
|
658
|
+
### Examples
|
|
659
|
+
|
|
660
|
+
```ruby
|
|
661
|
+
require 'time'
|
|
662
|
+
require 'ibm_cloud_iam'
|
|
663
|
+
|
|
664
|
+
api_instance = IbmCloudIam::TrustedProfileTemplateApi.new
|
|
665
|
+
if_match = 'if_match_example' # String | Entity tag of the Template to be updated. Specify the tag that you retrieved when reading the Profile Template. This value helps identifying parallel usage of this API. Pass * to indicate to update any version available. This might result in stale updates.
|
|
666
|
+
template_id = 'template_id_example' # String | ID of the trusted profile template
|
|
667
|
+
version = 'version_example' # String | Version of the Profile Template
|
|
668
|
+
authorization = 'authorization_example' # String | Authorization Token used for the request. The supported token type is a Cloud IAM Access Token. If the token is omitted the request will fail with BXNIM0308E: 'No authorization header found'. Make sure that the provided token has the required authority for the request.
|
|
669
|
+
trusted_profile_template_request = IbmCloudIam::TrustedProfileTemplateRequest.new # TrustedProfileTemplateRequest | Request to create a trusted profile template.
|
|
670
|
+
|
|
671
|
+
begin
|
|
672
|
+
# Update version of trusted profile template
|
|
673
|
+
result = api_instance.update_profile_template_version(if_match, template_id, version, authorization, trusted_profile_template_request)
|
|
674
|
+
p result
|
|
675
|
+
rescue IbmCloudIam::ApiError => e
|
|
676
|
+
puts "Error when calling TrustedProfileTemplateApi->update_profile_template_version: #{e}"
|
|
677
|
+
end
|
|
678
|
+
```
|
|
679
|
+
|
|
680
|
+
#### Using the update_profile_template_version_with_http_info variant
|
|
681
|
+
|
|
682
|
+
This returns an Array which contains the response data, status code and headers.
|
|
683
|
+
|
|
684
|
+
> <Array(<TrustedProfileTemplateResponse>, Integer, Hash)> update_profile_template_version_with_http_info(if_match, template_id, version, authorization, trusted_profile_template_request)
|
|
685
|
+
|
|
686
|
+
```ruby
|
|
687
|
+
begin
|
|
688
|
+
# Update version of trusted profile template
|
|
689
|
+
data, status_code, headers = api_instance.update_profile_template_version_with_http_info(if_match, template_id, version, authorization, trusted_profile_template_request)
|
|
690
|
+
p status_code # => 2xx
|
|
691
|
+
p headers # => { ... }
|
|
692
|
+
p data # => <TrustedProfileTemplateResponse>
|
|
693
|
+
rescue IbmCloudIam::ApiError => e
|
|
694
|
+
puts "Error when calling TrustedProfileTemplateApi->update_profile_template_version_with_http_info: #{e}"
|
|
695
|
+
end
|
|
696
|
+
```
|
|
697
|
+
|
|
698
|
+
### Parameters
|
|
699
|
+
|
|
700
|
+
| Name | Type | Description | Notes |
|
|
701
|
+
| ---- | ---- | ----------- | ----- |
|
|
702
|
+
| **if_match** | **String** | Entity tag of the Template to be updated. Specify the tag that you retrieved when reading the Profile Template. This value helps identifying parallel usage of this API. Pass * to indicate to update any version available. This might result in stale updates. | |
|
|
703
|
+
| **template_id** | **String** | ID of the trusted profile template | |
|
|
704
|
+
| **version** | **String** | Version of the Profile Template | |
|
|
705
|
+
| **authorization** | **String** | Authorization Token used for the request. The supported token type is a Cloud IAM Access Token. If the token is omitted the request will fail with BXNIM0308E: 'No authorization header found'. Make sure that the provided token has the required authority for the request. | |
|
|
706
|
+
| **trusted_profile_template_request** | [**TrustedProfileTemplateRequest**](TrustedProfileTemplateRequest.md) | Request to create a trusted profile template. | |
|
|
707
|
+
|
|
708
|
+
### Return type
|
|
709
|
+
|
|
710
|
+
[**TrustedProfileTemplateResponse**](TrustedProfileTemplateResponse.md)
|
|
711
|
+
|
|
712
|
+
### Authorization
|
|
713
|
+
|
|
714
|
+
No authorization required
|
|
715
|
+
|
|
716
|
+
### HTTP request headers
|
|
717
|
+
|
|
718
|
+
- **Content-Type**: application/json
|
|
719
|
+
- **Accept**: application/json
|
|
720
|
+
|