ibm_cloud_iam 1.0.2 → 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/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 -6
- 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 +34 -105
- 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 +549 -35
- 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/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,1414 @@
|
|
|
1
|
+
# IbmCloudIam::TrustedProfilesApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://iam.cloud.ibm.com*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**create_claim_rule**](TrustedProfilesApi.md#create_claim_rule) | **POST** /v1/profiles/{profile-id}/rules | Create claim rule for a trusted profile |
|
|
8
|
+
| [**create_link**](TrustedProfilesApi.md#create_link) | **POST** /v1/profiles/{profile-id}/links | Create link to a trusted profile |
|
|
9
|
+
| [**create_profile**](TrustedProfilesApi.md#create_profile) | **POST** /v1/profiles | Create a trusted profile |
|
|
10
|
+
| [**delete_claim_rule**](TrustedProfilesApi.md#delete_claim_rule) | **DELETE** /v1/profiles/{profile-id}/rules/{rule-id} | Delete a claim rule |
|
|
11
|
+
| [**delete_link**](TrustedProfilesApi.md#delete_link) | **DELETE** /v1/profiles/{profile-id}/links/{link-id} | Delete link to a trusted profile |
|
|
12
|
+
| [**delete_link_by_parameters**](TrustedProfilesApi.md#delete_link_by_parameters) | **DELETE** /v1/profiles/{profile-id}/links | Delete compute resource link to profile by given parameters. |
|
|
13
|
+
| [**delete_profile**](TrustedProfilesApi.md#delete_profile) | **DELETE** /v1/profiles/{profile-id} | Delete a trusted profile |
|
|
14
|
+
| [**delete_profile_identity**](TrustedProfilesApi.md#delete_profile_identity) | **DELETE** /v1/profiles/{profile-id}/identities/{identity-type}/{identifier-id} | Delete the identity that can assume the trusted profile |
|
|
15
|
+
| [**get_claim_rule**](TrustedProfilesApi.md#get_claim_rule) | **GET** /v1/profiles/{profile-id}/rules/{rule-id} | Get a claim rule for a trusted profile |
|
|
16
|
+
| [**get_link**](TrustedProfilesApi.md#get_link) | **GET** /v1/profiles/{profile-id}/links/{link-id} | Get link to a trusted profile |
|
|
17
|
+
| [**get_profile**](TrustedProfilesApi.md#get_profile) | **GET** /v1/profiles/{profile-id} | Get a trusted profile |
|
|
18
|
+
| [**get_profile_identities**](TrustedProfilesApi.md#get_profile_identities) | **GET** /v1/profiles/{profile-id}/identities | Get a list of identities that can assume the trusted profile |
|
|
19
|
+
| [**get_profile_identity**](TrustedProfilesApi.md#get_profile_identity) | **GET** /v1/profiles/{profile-id}/identities/{identity-type}/{identifier-id} | Get the identity that can assume the trusted profile |
|
|
20
|
+
| [**list_claim_rules**](TrustedProfilesApi.md#list_claim_rules) | **GET** /v1/profiles/{profile-id}/rules | List claim rules for a trusted profile |
|
|
21
|
+
| [**list_links**](TrustedProfilesApi.md#list_links) | **GET** /v1/profiles/{profile-id}/links | List links to a trusted profile |
|
|
22
|
+
| [**list_profiles**](TrustedProfilesApi.md#list_profiles) | **GET** /v1/profiles | List trusted profiles |
|
|
23
|
+
| [**set_profile_identities**](TrustedProfilesApi.md#set_profile_identities) | **PUT** /v1/profiles/{profile-id}/identities | Update the list of identities that can assume the trusted profile |
|
|
24
|
+
| [**set_profile_identity**](TrustedProfilesApi.md#set_profile_identity) | **POST** /v1/profiles/{profile-id}/identities/{identity-type} | Add a specific identity that can assume the trusted profile |
|
|
25
|
+
| [**update_claim_rule**](TrustedProfilesApi.md#update_claim_rule) | **PUT** /v1/profiles/{profile-id}/rules/{rule-id} | Update claim rule for a trusted profile |
|
|
26
|
+
| [**update_profile**](TrustedProfilesApi.md#update_profile) | **PUT** /v1/profiles/{profile-id} | Update a trusted profile |
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
## create_claim_rule
|
|
30
|
+
|
|
31
|
+
> <ProfileClaimRule> create_claim_rule(authorization, profile_id, profile_claim_rule_request)
|
|
32
|
+
|
|
33
|
+
Create claim rule for a trusted profile
|
|
34
|
+
|
|
35
|
+
Create a claim rule for a trusted profile. There is a limit of 20 rules per trusted profile.
|
|
36
|
+
|
|
37
|
+
### Examples
|
|
38
|
+
|
|
39
|
+
```ruby
|
|
40
|
+
require 'time'
|
|
41
|
+
require 'ibm_cloud_iam'
|
|
42
|
+
|
|
43
|
+
api_instance = IbmCloudIam::TrustedProfilesApi.new
|
|
44
|
+
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.
|
|
45
|
+
profile_id = 'profile_id_example' # String | ID of the trusted profile to create a claim rule.
|
|
46
|
+
profile_claim_rule_request = IbmCloudIam::ProfileClaimRuleRequest.new({type: 'type_example', conditions: [IbmCloudIam::ProfileClaimRuleConditions.new({claim: 'claim_example', operator: 'operator_example', value: 'value_example'})]}) # ProfileClaimRuleRequest | Request to create a claim rule for trusted profile.
|
|
47
|
+
|
|
48
|
+
begin
|
|
49
|
+
# Create claim rule for a trusted profile
|
|
50
|
+
result = api_instance.create_claim_rule(authorization, profile_id, profile_claim_rule_request)
|
|
51
|
+
p result
|
|
52
|
+
rescue IbmCloudIam::ApiError => e
|
|
53
|
+
puts "Error when calling TrustedProfilesApi->create_claim_rule: #{e}"
|
|
54
|
+
end
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
#### Using the create_claim_rule_with_http_info variant
|
|
58
|
+
|
|
59
|
+
This returns an Array which contains the response data, status code and headers.
|
|
60
|
+
|
|
61
|
+
> <Array(<ProfileClaimRule>, Integer, Hash)> create_claim_rule_with_http_info(authorization, profile_id, profile_claim_rule_request)
|
|
62
|
+
|
|
63
|
+
```ruby
|
|
64
|
+
begin
|
|
65
|
+
# Create claim rule for a trusted profile
|
|
66
|
+
data, status_code, headers = api_instance.create_claim_rule_with_http_info(authorization, profile_id, profile_claim_rule_request)
|
|
67
|
+
p status_code # => 2xx
|
|
68
|
+
p headers # => { ... }
|
|
69
|
+
p data # => <ProfileClaimRule>
|
|
70
|
+
rescue IbmCloudIam::ApiError => e
|
|
71
|
+
puts "Error when calling TrustedProfilesApi->create_claim_rule_with_http_info: #{e}"
|
|
72
|
+
end
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
### Parameters
|
|
76
|
+
|
|
77
|
+
| Name | Type | Description | Notes |
|
|
78
|
+
| ---- | ---- | ----------- | ----- |
|
|
79
|
+
| **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. | |
|
|
80
|
+
| **profile_id** | **String** | ID of the trusted profile to create a claim rule. | |
|
|
81
|
+
| **profile_claim_rule_request** | [**ProfileClaimRuleRequest**](ProfileClaimRuleRequest.md) | Request to create a claim rule for trusted profile. | |
|
|
82
|
+
|
|
83
|
+
### Return type
|
|
84
|
+
|
|
85
|
+
[**ProfileClaimRule**](ProfileClaimRule.md)
|
|
86
|
+
|
|
87
|
+
### Authorization
|
|
88
|
+
|
|
89
|
+
No authorization required
|
|
90
|
+
|
|
91
|
+
### HTTP request headers
|
|
92
|
+
|
|
93
|
+
- **Content-Type**: application/json
|
|
94
|
+
- **Accept**: application/json
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
## create_link
|
|
98
|
+
|
|
99
|
+
> <ProfileLink> create_link(profile_id, authorization, create_profile_link_request)
|
|
100
|
+
|
|
101
|
+
Create link to a trusted profile
|
|
102
|
+
|
|
103
|
+
Create a direct link between a specific compute resource and a trusted profile, rather than creating conditions that a compute resource must fulfill to apply a trusted profile.
|
|
104
|
+
|
|
105
|
+
### Examples
|
|
106
|
+
|
|
107
|
+
```ruby
|
|
108
|
+
require 'time'
|
|
109
|
+
require 'ibm_cloud_iam'
|
|
110
|
+
|
|
111
|
+
api_instance = IbmCloudIam::TrustedProfilesApi.new
|
|
112
|
+
profile_id = 'profile_id_example' # String | ID of the trusted profile.
|
|
113
|
+
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.
|
|
114
|
+
create_profile_link_request = IbmCloudIam::CreateProfileLinkRequest.new({cr_type: 'cr_type_example', link: IbmCloudIam::CreateProfileLinkRequestLink.new({crn: 'crn_example'})}) # CreateProfileLinkRequest | Request to create a Link to Trusted profile.
|
|
115
|
+
|
|
116
|
+
begin
|
|
117
|
+
# Create link to a trusted profile
|
|
118
|
+
result = api_instance.create_link(profile_id, authorization, create_profile_link_request)
|
|
119
|
+
p result
|
|
120
|
+
rescue IbmCloudIam::ApiError => e
|
|
121
|
+
puts "Error when calling TrustedProfilesApi->create_link: #{e}"
|
|
122
|
+
end
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
#### Using the create_link_with_http_info variant
|
|
126
|
+
|
|
127
|
+
This returns an Array which contains the response data, status code and headers.
|
|
128
|
+
|
|
129
|
+
> <Array(<ProfileLink>, Integer, Hash)> create_link_with_http_info(profile_id, authorization, create_profile_link_request)
|
|
130
|
+
|
|
131
|
+
```ruby
|
|
132
|
+
begin
|
|
133
|
+
# Create link to a trusted profile
|
|
134
|
+
data, status_code, headers = api_instance.create_link_with_http_info(profile_id, authorization, create_profile_link_request)
|
|
135
|
+
p status_code # => 2xx
|
|
136
|
+
p headers # => { ... }
|
|
137
|
+
p data # => <ProfileLink>
|
|
138
|
+
rescue IbmCloudIam::ApiError => e
|
|
139
|
+
puts "Error when calling TrustedProfilesApi->create_link_with_http_info: #{e}"
|
|
140
|
+
end
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
### Parameters
|
|
144
|
+
|
|
145
|
+
| Name | Type | Description | Notes |
|
|
146
|
+
| ---- | ---- | ----------- | ----- |
|
|
147
|
+
| **profile_id** | **String** | ID of the trusted profile. | |
|
|
148
|
+
| **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. | |
|
|
149
|
+
| **create_profile_link_request** | [**CreateProfileLinkRequest**](CreateProfileLinkRequest.md) | Request to create a Link to Trusted profile. | |
|
|
150
|
+
|
|
151
|
+
### Return type
|
|
152
|
+
|
|
153
|
+
[**ProfileLink**](ProfileLink.md)
|
|
154
|
+
|
|
155
|
+
### Authorization
|
|
156
|
+
|
|
157
|
+
No authorization required
|
|
158
|
+
|
|
159
|
+
### HTTP request headers
|
|
160
|
+
|
|
161
|
+
- **Content-Type**: application/json
|
|
162
|
+
- **Accept**: application/json
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
## create_profile
|
|
166
|
+
|
|
167
|
+
> <TrustedProfile> create_profile(authorization, create_trusted_profile_request)
|
|
168
|
+
|
|
169
|
+
Create a trusted profile
|
|
170
|
+
|
|
171
|
+
Create a trusted profile for a given account ID.
|
|
172
|
+
|
|
173
|
+
### Examples
|
|
174
|
+
|
|
175
|
+
```ruby
|
|
176
|
+
require 'time'
|
|
177
|
+
require 'ibm_cloud_iam'
|
|
178
|
+
|
|
179
|
+
api_instance = IbmCloudIam::TrustedProfilesApi.new
|
|
180
|
+
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.
|
|
181
|
+
create_trusted_profile_request = IbmCloudIam::CreateTrustedProfileRequest.new({name: 'name_example', account_id: 'account_id_example'}) # CreateTrustedProfileRequest | Request to create a trusted profile.
|
|
182
|
+
|
|
183
|
+
begin
|
|
184
|
+
# Create a trusted profile
|
|
185
|
+
result = api_instance.create_profile(authorization, create_trusted_profile_request)
|
|
186
|
+
p result
|
|
187
|
+
rescue IbmCloudIam::ApiError => e
|
|
188
|
+
puts "Error when calling TrustedProfilesApi->create_profile: #{e}"
|
|
189
|
+
end
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
#### Using the create_profile_with_http_info variant
|
|
193
|
+
|
|
194
|
+
This returns an Array which contains the response data, status code and headers.
|
|
195
|
+
|
|
196
|
+
> <Array(<TrustedProfile>, Integer, Hash)> create_profile_with_http_info(authorization, create_trusted_profile_request)
|
|
197
|
+
|
|
198
|
+
```ruby
|
|
199
|
+
begin
|
|
200
|
+
# Create a trusted profile
|
|
201
|
+
data, status_code, headers = api_instance.create_profile_with_http_info(authorization, create_trusted_profile_request)
|
|
202
|
+
p status_code # => 2xx
|
|
203
|
+
p headers # => { ... }
|
|
204
|
+
p data # => <TrustedProfile>
|
|
205
|
+
rescue IbmCloudIam::ApiError => e
|
|
206
|
+
puts "Error when calling TrustedProfilesApi->create_profile_with_http_info: #{e}"
|
|
207
|
+
end
|
|
208
|
+
```
|
|
209
|
+
|
|
210
|
+
### Parameters
|
|
211
|
+
|
|
212
|
+
| Name | Type | Description | Notes |
|
|
213
|
+
| ---- | ---- | ----------- | ----- |
|
|
214
|
+
| **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. | |
|
|
215
|
+
| **create_trusted_profile_request** | [**CreateTrustedProfileRequest**](CreateTrustedProfileRequest.md) | Request to create a trusted profile. | |
|
|
216
|
+
|
|
217
|
+
### Return type
|
|
218
|
+
|
|
219
|
+
[**TrustedProfile**](TrustedProfile.md)
|
|
220
|
+
|
|
221
|
+
### Authorization
|
|
222
|
+
|
|
223
|
+
No authorization required
|
|
224
|
+
|
|
225
|
+
### HTTP request headers
|
|
226
|
+
|
|
227
|
+
- **Content-Type**: application/json
|
|
228
|
+
- **Accept**: application/json
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
## delete_claim_rule
|
|
232
|
+
|
|
233
|
+
> delete_claim_rule(profile_id, rule_id, authorization)
|
|
234
|
+
|
|
235
|
+
Delete a claim rule
|
|
236
|
+
|
|
237
|
+
Delete a claim rule. When you delete a claim rule, federated user or compute resources are no longer required to meet the conditions of the claim rule in order to apply the trusted profile.
|
|
238
|
+
|
|
239
|
+
### Examples
|
|
240
|
+
|
|
241
|
+
```ruby
|
|
242
|
+
require 'time'
|
|
243
|
+
require 'ibm_cloud_iam'
|
|
244
|
+
|
|
245
|
+
api_instance = IbmCloudIam::TrustedProfilesApi.new
|
|
246
|
+
profile_id = 'profile_id_example' # String | ID of the trusted profile.
|
|
247
|
+
rule_id = 'rule_id_example' # String | ID of the claim rule to delete.
|
|
248
|
+
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.
|
|
249
|
+
|
|
250
|
+
begin
|
|
251
|
+
# Delete a claim rule
|
|
252
|
+
api_instance.delete_claim_rule(profile_id, rule_id, authorization)
|
|
253
|
+
rescue IbmCloudIam::ApiError => e
|
|
254
|
+
puts "Error when calling TrustedProfilesApi->delete_claim_rule: #{e}"
|
|
255
|
+
end
|
|
256
|
+
```
|
|
257
|
+
|
|
258
|
+
#### Using the delete_claim_rule_with_http_info variant
|
|
259
|
+
|
|
260
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
261
|
+
|
|
262
|
+
> <Array(nil, Integer, Hash)> delete_claim_rule_with_http_info(profile_id, rule_id, authorization)
|
|
263
|
+
|
|
264
|
+
```ruby
|
|
265
|
+
begin
|
|
266
|
+
# Delete a claim rule
|
|
267
|
+
data, status_code, headers = api_instance.delete_claim_rule_with_http_info(profile_id, rule_id, authorization)
|
|
268
|
+
p status_code # => 2xx
|
|
269
|
+
p headers # => { ... }
|
|
270
|
+
p data # => nil
|
|
271
|
+
rescue IbmCloudIam::ApiError => e
|
|
272
|
+
puts "Error when calling TrustedProfilesApi->delete_claim_rule_with_http_info: #{e}"
|
|
273
|
+
end
|
|
274
|
+
```
|
|
275
|
+
|
|
276
|
+
### Parameters
|
|
277
|
+
|
|
278
|
+
| Name | Type | Description | Notes |
|
|
279
|
+
| ---- | ---- | ----------- | ----- |
|
|
280
|
+
| **profile_id** | **String** | ID of the trusted profile. | |
|
|
281
|
+
| **rule_id** | **String** | ID of the claim rule to delete. | |
|
|
282
|
+
| **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. | |
|
|
283
|
+
|
|
284
|
+
### Return type
|
|
285
|
+
|
|
286
|
+
nil (empty response body)
|
|
287
|
+
|
|
288
|
+
### Authorization
|
|
289
|
+
|
|
290
|
+
No authorization required
|
|
291
|
+
|
|
292
|
+
### HTTP request headers
|
|
293
|
+
|
|
294
|
+
- **Content-Type**: Not defined
|
|
295
|
+
- **Accept**: Not defined
|
|
296
|
+
|
|
297
|
+
|
|
298
|
+
## delete_link
|
|
299
|
+
|
|
300
|
+
> delete_link(profile_id, link_id, authorization)
|
|
301
|
+
|
|
302
|
+
Delete link to a trusted profile
|
|
303
|
+
|
|
304
|
+
Delete a link between a compute resource and a trusted profile.
|
|
305
|
+
|
|
306
|
+
### Examples
|
|
307
|
+
|
|
308
|
+
```ruby
|
|
309
|
+
require 'time'
|
|
310
|
+
require 'ibm_cloud_iam'
|
|
311
|
+
|
|
312
|
+
api_instance = IbmCloudIam::TrustedProfilesApi.new
|
|
313
|
+
profile_id = 'profile_id_example' # String | ID of the trusted profile
|
|
314
|
+
link_id = 'link_id_example' # String | ID of the link
|
|
315
|
+
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.
|
|
316
|
+
|
|
317
|
+
begin
|
|
318
|
+
# Delete link to a trusted profile
|
|
319
|
+
api_instance.delete_link(profile_id, link_id, authorization)
|
|
320
|
+
rescue IbmCloudIam::ApiError => e
|
|
321
|
+
puts "Error when calling TrustedProfilesApi->delete_link: #{e}"
|
|
322
|
+
end
|
|
323
|
+
```
|
|
324
|
+
|
|
325
|
+
#### Using the delete_link_with_http_info variant
|
|
326
|
+
|
|
327
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
328
|
+
|
|
329
|
+
> <Array(nil, Integer, Hash)> delete_link_with_http_info(profile_id, link_id, authorization)
|
|
330
|
+
|
|
331
|
+
```ruby
|
|
332
|
+
begin
|
|
333
|
+
# Delete link to a trusted profile
|
|
334
|
+
data, status_code, headers = api_instance.delete_link_with_http_info(profile_id, link_id, authorization)
|
|
335
|
+
p status_code # => 2xx
|
|
336
|
+
p headers # => { ... }
|
|
337
|
+
p data # => nil
|
|
338
|
+
rescue IbmCloudIam::ApiError => e
|
|
339
|
+
puts "Error when calling TrustedProfilesApi->delete_link_with_http_info: #{e}"
|
|
340
|
+
end
|
|
341
|
+
```
|
|
342
|
+
|
|
343
|
+
### Parameters
|
|
344
|
+
|
|
345
|
+
| Name | Type | Description | Notes |
|
|
346
|
+
| ---- | ---- | ----------- | ----- |
|
|
347
|
+
| **profile_id** | **String** | ID of the trusted profile | |
|
|
348
|
+
| **link_id** | **String** | ID of the link | |
|
|
349
|
+
| **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. | |
|
|
350
|
+
|
|
351
|
+
### Return type
|
|
352
|
+
|
|
353
|
+
nil (empty response body)
|
|
354
|
+
|
|
355
|
+
### Authorization
|
|
356
|
+
|
|
357
|
+
No authorization required
|
|
358
|
+
|
|
359
|
+
### HTTP request headers
|
|
360
|
+
|
|
361
|
+
- **Content-Type**: Not defined
|
|
362
|
+
- **Accept**: Not defined
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
## delete_link_by_parameters
|
|
366
|
+
|
|
367
|
+
> delete_link_by_parameters(profile_id, type, authorization, opts)
|
|
368
|
+
|
|
369
|
+
Delete compute resource link to profile by given parameters.
|
|
370
|
+
|
|
371
|
+
Deletes compute resource link of a Trusted Profile matching the given parameters.
|
|
372
|
+
|
|
373
|
+
### Examples
|
|
374
|
+
|
|
375
|
+
```ruby
|
|
376
|
+
require 'time'
|
|
377
|
+
require 'ibm_cloud_iam'
|
|
378
|
+
|
|
379
|
+
api_instance = IbmCloudIam::TrustedProfilesApi.new
|
|
380
|
+
profile_id = 'profile_id_example' # String | The unique ID of the Trusted Profile
|
|
381
|
+
type = 'type_example' # String | The compute resource type. Valid values are VSI, PVS, BMS, IKS_SA, ROKS_SA, CE
|
|
382
|
+
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.
|
|
383
|
+
opts = {
|
|
384
|
+
crn: 'crn_example', # String | CRN of the compute resource (VSI/PVS/BMS/IKS/ROKS/CE)
|
|
385
|
+
namespace: 'namespace_example', # String | Namespace of the compute resource (IKS/ROKS).
|
|
386
|
+
name: 'name_example', # String | Name of the compute resource (IKS/ROKS).
|
|
387
|
+
component_type: 'component_type_example', # String | Component type of the compute resource, only required if type is CE
|
|
388
|
+
component_name: 'component_name_example' # String | Component name of the compute resource, only required if type is CE
|
|
389
|
+
}
|
|
390
|
+
|
|
391
|
+
begin
|
|
392
|
+
# Delete compute resource link to profile by given parameters.
|
|
393
|
+
api_instance.delete_link_by_parameters(profile_id, type, authorization, opts)
|
|
394
|
+
rescue IbmCloudIam::ApiError => e
|
|
395
|
+
puts "Error when calling TrustedProfilesApi->delete_link_by_parameters: #{e}"
|
|
396
|
+
end
|
|
397
|
+
```
|
|
398
|
+
|
|
399
|
+
#### Using the delete_link_by_parameters_with_http_info variant
|
|
400
|
+
|
|
401
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
402
|
+
|
|
403
|
+
> <Array(nil, Integer, Hash)> delete_link_by_parameters_with_http_info(profile_id, type, authorization, opts)
|
|
404
|
+
|
|
405
|
+
```ruby
|
|
406
|
+
begin
|
|
407
|
+
# Delete compute resource link to profile by given parameters.
|
|
408
|
+
data, status_code, headers = api_instance.delete_link_by_parameters_with_http_info(profile_id, type, authorization, opts)
|
|
409
|
+
p status_code # => 2xx
|
|
410
|
+
p headers # => { ... }
|
|
411
|
+
p data # => nil
|
|
412
|
+
rescue IbmCloudIam::ApiError => e
|
|
413
|
+
puts "Error when calling TrustedProfilesApi->delete_link_by_parameters_with_http_info: #{e}"
|
|
414
|
+
end
|
|
415
|
+
```
|
|
416
|
+
|
|
417
|
+
### Parameters
|
|
418
|
+
|
|
419
|
+
| Name | Type | Description | Notes |
|
|
420
|
+
| ---- | ---- | ----------- | ----- |
|
|
421
|
+
| **profile_id** | **String** | The unique ID of the Trusted Profile | |
|
|
422
|
+
| **type** | **String** | The compute resource type. Valid values are VSI, PVS, BMS, IKS_SA, ROKS_SA, CE | |
|
|
423
|
+
| **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. | |
|
|
424
|
+
| **crn** | **String** | CRN of the compute resource (VSI/PVS/BMS/IKS/ROKS/CE) | [optional] |
|
|
425
|
+
| **namespace** | **String** | Namespace of the compute resource (IKS/ROKS). | [optional] |
|
|
426
|
+
| **name** | **String** | Name of the compute resource (IKS/ROKS). | [optional] |
|
|
427
|
+
| **component_type** | **String** | Component type of the compute resource, only required if type is CE | [optional] |
|
|
428
|
+
| **component_name** | **String** | Component name of the compute resource, only required if type is CE | [optional] |
|
|
429
|
+
|
|
430
|
+
### Return type
|
|
431
|
+
|
|
432
|
+
nil (empty response body)
|
|
433
|
+
|
|
434
|
+
### Authorization
|
|
435
|
+
|
|
436
|
+
No authorization required
|
|
437
|
+
|
|
438
|
+
### HTTP request headers
|
|
439
|
+
|
|
440
|
+
- **Content-Type**: Not defined
|
|
441
|
+
- **Accept**: Not defined
|
|
442
|
+
|
|
443
|
+
|
|
444
|
+
## delete_profile
|
|
445
|
+
|
|
446
|
+
> delete_profile(profile_id, authorization)
|
|
447
|
+
|
|
448
|
+
Delete a trusted profile
|
|
449
|
+
|
|
450
|
+
Delete a trusted profile. When you delete trusted profile, compute resources and federated users are unlinked from the profile and can no longer apply the trusted profile identity.
|
|
451
|
+
|
|
452
|
+
### Examples
|
|
453
|
+
|
|
454
|
+
```ruby
|
|
455
|
+
require 'time'
|
|
456
|
+
require 'ibm_cloud_iam'
|
|
457
|
+
|
|
458
|
+
api_instance = IbmCloudIam::TrustedProfilesApi.new
|
|
459
|
+
profile_id = 'profile_id_example' # String | ID of the trusted profile.
|
|
460
|
+
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.
|
|
461
|
+
|
|
462
|
+
begin
|
|
463
|
+
# Delete a trusted profile
|
|
464
|
+
api_instance.delete_profile(profile_id, authorization)
|
|
465
|
+
rescue IbmCloudIam::ApiError => e
|
|
466
|
+
puts "Error when calling TrustedProfilesApi->delete_profile: #{e}"
|
|
467
|
+
end
|
|
468
|
+
```
|
|
469
|
+
|
|
470
|
+
#### Using the delete_profile_with_http_info variant
|
|
471
|
+
|
|
472
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
473
|
+
|
|
474
|
+
> <Array(nil, Integer, Hash)> delete_profile_with_http_info(profile_id, authorization)
|
|
475
|
+
|
|
476
|
+
```ruby
|
|
477
|
+
begin
|
|
478
|
+
# Delete a trusted profile
|
|
479
|
+
data, status_code, headers = api_instance.delete_profile_with_http_info(profile_id, authorization)
|
|
480
|
+
p status_code # => 2xx
|
|
481
|
+
p headers # => { ... }
|
|
482
|
+
p data # => nil
|
|
483
|
+
rescue IbmCloudIam::ApiError => e
|
|
484
|
+
puts "Error when calling TrustedProfilesApi->delete_profile_with_http_info: #{e}"
|
|
485
|
+
end
|
|
486
|
+
```
|
|
487
|
+
|
|
488
|
+
### Parameters
|
|
489
|
+
|
|
490
|
+
| Name | Type | Description | Notes |
|
|
491
|
+
| ---- | ---- | ----------- | ----- |
|
|
492
|
+
| **profile_id** | **String** | ID of the trusted profile. | |
|
|
493
|
+
| **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. | |
|
|
494
|
+
|
|
495
|
+
### Return type
|
|
496
|
+
|
|
497
|
+
nil (empty response body)
|
|
498
|
+
|
|
499
|
+
### Authorization
|
|
500
|
+
|
|
501
|
+
No authorization required
|
|
502
|
+
|
|
503
|
+
### HTTP request headers
|
|
504
|
+
|
|
505
|
+
- **Content-Type**: Not defined
|
|
506
|
+
- **Accept**: Not defined
|
|
507
|
+
|
|
508
|
+
|
|
509
|
+
## delete_profile_identity
|
|
510
|
+
|
|
511
|
+
> delete_profile_identity(profile_id, identity_type, identifier_id, authorization)
|
|
512
|
+
|
|
513
|
+
Delete the identity that can assume the trusted profile
|
|
514
|
+
|
|
515
|
+
Delete the identity that can assume the trusted profile. **Note:** This API will update the trusted profile itself, thus calling it repeatedly for the same profile can lead to conflicts responded with HTTP code 409. Make sure to call this API only once in a few seconds for the same trusted profile.
|
|
516
|
+
|
|
517
|
+
### Examples
|
|
518
|
+
|
|
519
|
+
```ruby
|
|
520
|
+
require 'time'
|
|
521
|
+
require 'ibm_cloud_iam'
|
|
522
|
+
|
|
523
|
+
api_instance = IbmCloudIam::TrustedProfilesApi.new
|
|
524
|
+
profile_id = 'profile_id_example' # String | ID of the trusted profile
|
|
525
|
+
identity_type = 'user' # String | Type of the identity
|
|
526
|
+
identifier_id = 'identifier_id_example' # String | Identifier of the identity that can assume the trusted profiles.
|
|
527
|
+
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.
|
|
528
|
+
|
|
529
|
+
begin
|
|
530
|
+
# Delete the identity that can assume the trusted profile
|
|
531
|
+
api_instance.delete_profile_identity(profile_id, identity_type, identifier_id, authorization)
|
|
532
|
+
rescue IbmCloudIam::ApiError => e
|
|
533
|
+
puts "Error when calling TrustedProfilesApi->delete_profile_identity: #{e}"
|
|
534
|
+
end
|
|
535
|
+
```
|
|
536
|
+
|
|
537
|
+
#### Using the delete_profile_identity_with_http_info variant
|
|
538
|
+
|
|
539
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
540
|
+
|
|
541
|
+
> <Array(nil, Integer, Hash)> delete_profile_identity_with_http_info(profile_id, identity_type, identifier_id, authorization)
|
|
542
|
+
|
|
543
|
+
```ruby
|
|
544
|
+
begin
|
|
545
|
+
# Delete the identity that can assume the trusted profile
|
|
546
|
+
data, status_code, headers = api_instance.delete_profile_identity_with_http_info(profile_id, identity_type, identifier_id, authorization)
|
|
547
|
+
p status_code # => 2xx
|
|
548
|
+
p headers # => { ... }
|
|
549
|
+
p data # => nil
|
|
550
|
+
rescue IbmCloudIam::ApiError => e
|
|
551
|
+
puts "Error when calling TrustedProfilesApi->delete_profile_identity_with_http_info: #{e}"
|
|
552
|
+
end
|
|
553
|
+
```
|
|
554
|
+
|
|
555
|
+
### Parameters
|
|
556
|
+
|
|
557
|
+
| Name | Type | Description | Notes |
|
|
558
|
+
| ---- | ---- | ----------- | ----- |
|
|
559
|
+
| **profile_id** | **String** | ID of the trusted profile | |
|
|
560
|
+
| **identity_type** | **String** | Type of the identity | |
|
|
561
|
+
| **identifier_id** | **String** | Identifier of the identity that can assume the trusted profiles. | |
|
|
562
|
+
| **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. | |
|
|
563
|
+
|
|
564
|
+
### Return type
|
|
565
|
+
|
|
566
|
+
nil (empty response body)
|
|
567
|
+
|
|
568
|
+
### Authorization
|
|
569
|
+
|
|
570
|
+
No authorization required
|
|
571
|
+
|
|
572
|
+
### HTTP request headers
|
|
573
|
+
|
|
574
|
+
- **Content-Type**: Not defined
|
|
575
|
+
- **Accept**: Not defined
|
|
576
|
+
|
|
577
|
+
|
|
578
|
+
## get_claim_rule
|
|
579
|
+
|
|
580
|
+
> <ProfileClaimRule> get_claim_rule(profile_id, rule_id, authorization)
|
|
581
|
+
|
|
582
|
+
Get a claim rule for a trusted profile
|
|
583
|
+
|
|
584
|
+
A specific claim rule can be fetched for a given trusted profile ID and rule ID.
|
|
585
|
+
|
|
586
|
+
### Examples
|
|
587
|
+
|
|
588
|
+
```ruby
|
|
589
|
+
require 'time'
|
|
590
|
+
require 'ibm_cloud_iam'
|
|
591
|
+
|
|
592
|
+
api_instance = IbmCloudIam::TrustedProfilesApi.new
|
|
593
|
+
profile_id = 'profile_id_example' # String | ID of the trusted profile.
|
|
594
|
+
rule_id = 'rule_id_example' # String | ID of the claim rule to get.
|
|
595
|
+
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.
|
|
596
|
+
|
|
597
|
+
begin
|
|
598
|
+
# Get a claim rule for a trusted profile
|
|
599
|
+
result = api_instance.get_claim_rule(profile_id, rule_id, authorization)
|
|
600
|
+
p result
|
|
601
|
+
rescue IbmCloudIam::ApiError => e
|
|
602
|
+
puts "Error when calling TrustedProfilesApi->get_claim_rule: #{e}"
|
|
603
|
+
end
|
|
604
|
+
```
|
|
605
|
+
|
|
606
|
+
#### Using the get_claim_rule_with_http_info variant
|
|
607
|
+
|
|
608
|
+
This returns an Array which contains the response data, status code and headers.
|
|
609
|
+
|
|
610
|
+
> <Array(<ProfileClaimRule>, Integer, Hash)> get_claim_rule_with_http_info(profile_id, rule_id, authorization)
|
|
611
|
+
|
|
612
|
+
```ruby
|
|
613
|
+
begin
|
|
614
|
+
# Get a claim rule for a trusted profile
|
|
615
|
+
data, status_code, headers = api_instance.get_claim_rule_with_http_info(profile_id, rule_id, authorization)
|
|
616
|
+
p status_code # => 2xx
|
|
617
|
+
p headers # => { ... }
|
|
618
|
+
p data # => <ProfileClaimRule>
|
|
619
|
+
rescue IbmCloudIam::ApiError => e
|
|
620
|
+
puts "Error when calling TrustedProfilesApi->get_claim_rule_with_http_info: #{e}"
|
|
621
|
+
end
|
|
622
|
+
```
|
|
623
|
+
|
|
624
|
+
### Parameters
|
|
625
|
+
|
|
626
|
+
| Name | Type | Description | Notes |
|
|
627
|
+
| ---- | ---- | ----------- | ----- |
|
|
628
|
+
| **profile_id** | **String** | ID of the trusted profile. | |
|
|
629
|
+
| **rule_id** | **String** | ID of the claim rule to get. | |
|
|
630
|
+
| **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. | |
|
|
631
|
+
|
|
632
|
+
### Return type
|
|
633
|
+
|
|
634
|
+
[**ProfileClaimRule**](ProfileClaimRule.md)
|
|
635
|
+
|
|
636
|
+
### Authorization
|
|
637
|
+
|
|
638
|
+
No authorization required
|
|
639
|
+
|
|
640
|
+
### HTTP request headers
|
|
641
|
+
|
|
642
|
+
- **Content-Type**: Not defined
|
|
643
|
+
- **Accept**: application/json
|
|
644
|
+
|
|
645
|
+
|
|
646
|
+
## get_link
|
|
647
|
+
|
|
648
|
+
> <ProfileLink> get_link(profile_id, link_id, authorization)
|
|
649
|
+
|
|
650
|
+
Get link to a trusted profile
|
|
651
|
+
|
|
652
|
+
Get a specific link to a trusted profile by `link_id`.
|
|
653
|
+
|
|
654
|
+
### Examples
|
|
655
|
+
|
|
656
|
+
```ruby
|
|
657
|
+
require 'time'
|
|
658
|
+
require 'ibm_cloud_iam'
|
|
659
|
+
|
|
660
|
+
api_instance = IbmCloudIam::TrustedProfilesApi.new
|
|
661
|
+
profile_id = 'profile_id_example' # String | ID of the trusted profile
|
|
662
|
+
link_id = 'link_id_example' # String | ID of the link
|
|
663
|
+
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.
|
|
664
|
+
|
|
665
|
+
begin
|
|
666
|
+
# Get link to a trusted profile
|
|
667
|
+
result = api_instance.get_link(profile_id, link_id, authorization)
|
|
668
|
+
p result
|
|
669
|
+
rescue IbmCloudIam::ApiError => e
|
|
670
|
+
puts "Error when calling TrustedProfilesApi->get_link: #{e}"
|
|
671
|
+
end
|
|
672
|
+
```
|
|
673
|
+
|
|
674
|
+
#### Using the get_link_with_http_info variant
|
|
675
|
+
|
|
676
|
+
This returns an Array which contains the response data, status code and headers.
|
|
677
|
+
|
|
678
|
+
> <Array(<ProfileLink>, Integer, Hash)> get_link_with_http_info(profile_id, link_id, authorization)
|
|
679
|
+
|
|
680
|
+
```ruby
|
|
681
|
+
begin
|
|
682
|
+
# Get link to a trusted profile
|
|
683
|
+
data, status_code, headers = api_instance.get_link_with_http_info(profile_id, link_id, authorization)
|
|
684
|
+
p status_code # => 2xx
|
|
685
|
+
p headers # => { ... }
|
|
686
|
+
p data # => <ProfileLink>
|
|
687
|
+
rescue IbmCloudIam::ApiError => e
|
|
688
|
+
puts "Error when calling TrustedProfilesApi->get_link_with_http_info: #{e}"
|
|
689
|
+
end
|
|
690
|
+
```
|
|
691
|
+
|
|
692
|
+
### Parameters
|
|
693
|
+
|
|
694
|
+
| Name | Type | Description | Notes |
|
|
695
|
+
| ---- | ---- | ----------- | ----- |
|
|
696
|
+
| **profile_id** | **String** | ID of the trusted profile | |
|
|
697
|
+
| **link_id** | **String** | ID of the link | |
|
|
698
|
+
| **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. | |
|
|
699
|
+
|
|
700
|
+
### Return type
|
|
701
|
+
|
|
702
|
+
[**ProfileLink**](ProfileLink.md)
|
|
703
|
+
|
|
704
|
+
### Authorization
|
|
705
|
+
|
|
706
|
+
No authorization required
|
|
707
|
+
|
|
708
|
+
### HTTP request headers
|
|
709
|
+
|
|
710
|
+
- **Content-Type**: Not defined
|
|
711
|
+
- **Accept**: application/json
|
|
712
|
+
|
|
713
|
+
|
|
714
|
+
## get_profile
|
|
715
|
+
|
|
716
|
+
> <TrustedProfile> get_profile(profile_id, authorization, opts)
|
|
717
|
+
|
|
718
|
+
Get a trusted profile
|
|
719
|
+
|
|
720
|
+
Retrieve a trusted profile by its `profile-id`. Only the trusted profile's data is returned (`name`, `description`, `iam_id`, etc.), not the federated users or compute resources that qualify to apply the trusted profile.
|
|
721
|
+
|
|
722
|
+
### Examples
|
|
723
|
+
|
|
724
|
+
```ruby
|
|
725
|
+
require 'time'
|
|
726
|
+
require 'ibm_cloud_iam'
|
|
727
|
+
|
|
728
|
+
api_instance = IbmCloudIam::TrustedProfilesApi.new
|
|
729
|
+
profile_id = 'profile_id_example' # String | ID of the trusted profile to get.
|
|
730
|
+
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.
|
|
731
|
+
opts = {
|
|
732
|
+
include_activity: true # Boolean | Defines if the entity's activity is included in the response. Retrieving activity data is an expensive operation, so only request this when needed.
|
|
733
|
+
}
|
|
734
|
+
|
|
735
|
+
begin
|
|
736
|
+
# Get a trusted profile
|
|
737
|
+
result = api_instance.get_profile(profile_id, authorization, opts)
|
|
738
|
+
p result
|
|
739
|
+
rescue IbmCloudIam::ApiError => e
|
|
740
|
+
puts "Error when calling TrustedProfilesApi->get_profile: #{e}"
|
|
741
|
+
end
|
|
742
|
+
```
|
|
743
|
+
|
|
744
|
+
#### Using the get_profile_with_http_info variant
|
|
745
|
+
|
|
746
|
+
This returns an Array which contains the response data, status code and headers.
|
|
747
|
+
|
|
748
|
+
> <Array(<TrustedProfile>, Integer, Hash)> get_profile_with_http_info(profile_id, authorization, opts)
|
|
749
|
+
|
|
750
|
+
```ruby
|
|
751
|
+
begin
|
|
752
|
+
# Get a trusted profile
|
|
753
|
+
data, status_code, headers = api_instance.get_profile_with_http_info(profile_id, authorization, opts)
|
|
754
|
+
p status_code # => 2xx
|
|
755
|
+
p headers # => { ... }
|
|
756
|
+
p data # => <TrustedProfile>
|
|
757
|
+
rescue IbmCloudIam::ApiError => e
|
|
758
|
+
puts "Error when calling TrustedProfilesApi->get_profile_with_http_info: #{e}"
|
|
759
|
+
end
|
|
760
|
+
```
|
|
761
|
+
|
|
762
|
+
### Parameters
|
|
763
|
+
|
|
764
|
+
| Name | Type | Description | Notes |
|
|
765
|
+
| ---- | ---- | ----------- | ----- |
|
|
766
|
+
| **profile_id** | **String** | ID of the trusted profile to get. | |
|
|
767
|
+
| **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. | |
|
|
768
|
+
| **include_activity** | **Boolean** | Defines if the entity's activity is included in the response. Retrieving activity data is an expensive operation, so only request this when needed. | [optional][default to false] |
|
|
769
|
+
|
|
770
|
+
### Return type
|
|
771
|
+
|
|
772
|
+
[**TrustedProfile**](TrustedProfile.md)
|
|
773
|
+
|
|
774
|
+
### Authorization
|
|
775
|
+
|
|
776
|
+
No authorization required
|
|
777
|
+
|
|
778
|
+
### HTTP request headers
|
|
779
|
+
|
|
780
|
+
- **Content-Type**: Not defined
|
|
781
|
+
- **Accept**: application/json
|
|
782
|
+
|
|
783
|
+
|
|
784
|
+
## get_profile_identities
|
|
785
|
+
|
|
786
|
+
> <ProfileIdentitiesResponse> get_profile_identities(profile_id, authorization)
|
|
787
|
+
|
|
788
|
+
Get a list of identities that can assume the trusted profile
|
|
789
|
+
|
|
790
|
+
Get a list of identities that can assume the trusted profile
|
|
791
|
+
|
|
792
|
+
### Examples
|
|
793
|
+
|
|
794
|
+
```ruby
|
|
795
|
+
require 'time'
|
|
796
|
+
require 'ibm_cloud_iam'
|
|
797
|
+
|
|
798
|
+
api_instance = IbmCloudIam::TrustedProfilesApi.new
|
|
799
|
+
profile_id = 'profile_id_example' # String | ID of the trusted profile.
|
|
800
|
+
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.
|
|
801
|
+
|
|
802
|
+
begin
|
|
803
|
+
# Get a list of identities that can assume the trusted profile
|
|
804
|
+
result = api_instance.get_profile_identities(profile_id, authorization)
|
|
805
|
+
p result
|
|
806
|
+
rescue IbmCloudIam::ApiError => e
|
|
807
|
+
puts "Error when calling TrustedProfilesApi->get_profile_identities: #{e}"
|
|
808
|
+
end
|
|
809
|
+
```
|
|
810
|
+
|
|
811
|
+
#### Using the get_profile_identities_with_http_info variant
|
|
812
|
+
|
|
813
|
+
This returns an Array which contains the response data, status code and headers.
|
|
814
|
+
|
|
815
|
+
> <Array(<ProfileIdentitiesResponse>, Integer, Hash)> get_profile_identities_with_http_info(profile_id, authorization)
|
|
816
|
+
|
|
817
|
+
```ruby
|
|
818
|
+
begin
|
|
819
|
+
# Get a list of identities that can assume the trusted profile
|
|
820
|
+
data, status_code, headers = api_instance.get_profile_identities_with_http_info(profile_id, authorization)
|
|
821
|
+
p status_code # => 2xx
|
|
822
|
+
p headers # => { ... }
|
|
823
|
+
p data # => <ProfileIdentitiesResponse>
|
|
824
|
+
rescue IbmCloudIam::ApiError => e
|
|
825
|
+
puts "Error when calling TrustedProfilesApi->get_profile_identities_with_http_info: #{e}"
|
|
826
|
+
end
|
|
827
|
+
```
|
|
828
|
+
|
|
829
|
+
### Parameters
|
|
830
|
+
|
|
831
|
+
| Name | Type | Description | Notes |
|
|
832
|
+
| ---- | ---- | ----------- | ----- |
|
|
833
|
+
| **profile_id** | **String** | ID of the trusted profile. | |
|
|
834
|
+
| **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. | |
|
|
835
|
+
|
|
836
|
+
### Return type
|
|
837
|
+
|
|
838
|
+
[**ProfileIdentitiesResponse**](ProfileIdentitiesResponse.md)
|
|
839
|
+
|
|
840
|
+
### Authorization
|
|
841
|
+
|
|
842
|
+
No authorization required
|
|
843
|
+
|
|
844
|
+
### HTTP request headers
|
|
845
|
+
|
|
846
|
+
- **Content-Type**: Not defined
|
|
847
|
+
- **Accept**: application/json
|
|
848
|
+
|
|
849
|
+
|
|
850
|
+
## get_profile_identity
|
|
851
|
+
|
|
852
|
+
> <ProfileIdentityResponse> get_profile_identity(profile_id, identity_type, identifier_id, authorization)
|
|
853
|
+
|
|
854
|
+
Get the identity that can assume the trusted profile
|
|
855
|
+
|
|
856
|
+
Get the identity that can assume the trusted profile
|
|
857
|
+
|
|
858
|
+
### Examples
|
|
859
|
+
|
|
860
|
+
```ruby
|
|
861
|
+
require 'time'
|
|
862
|
+
require 'ibm_cloud_iam'
|
|
863
|
+
|
|
864
|
+
api_instance = IbmCloudIam::TrustedProfilesApi.new
|
|
865
|
+
profile_id = 'profile_id_example' # String | ID of the trusted profile
|
|
866
|
+
identity_type = 'user' # String | Type of the identity
|
|
867
|
+
identifier_id = 'identifier_id_example' # String | Identifier of the identity that can assume the trusted profiles.
|
|
868
|
+
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.
|
|
869
|
+
|
|
870
|
+
begin
|
|
871
|
+
# Get the identity that can assume the trusted profile
|
|
872
|
+
result = api_instance.get_profile_identity(profile_id, identity_type, identifier_id, authorization)
|
|
873
|
+
p result
|
|
874
|
+
rescue IbmCloudIam::ApiError => e
|
|
875
|
+
puts "Error when calling TrustedProfilesApi->get_profile_identity: #{e}"
|
|
876
|
+
end
|
|
877
|
+
```
|
|
878
|
+
|
|
879
|
+
#### Using the get_profile_identity_with_http_info variant
|
|
880
|
+
|
|
881
|
+
This returns an Array which contains the response data, status code and headers.
|
|
882
|
+
|
|
883
|
+
> <Array(<ProfileIdentityResponse>, Integer, Hash)> get_profile_identity_with_http_info(profile_id, identity_type, identifier_id, authorization)
|
|
884
|
+
|
|
885
|
+
```ruby
|
|
886
|
+
begin
|
|
887
|
+
# Get the identity that can assume the trusted profile
|
|
888
|
+
data, status_code, headers = api_instance.get_profile_identity_with_http_info(profile_id, identity_type, identifier_id, authorization)
|
|
889
|
+
p status_code # => 2xx
|
|
890
|
+
p headers # => { ... }
|
|
891
|
+
p data # => <ProfileIdentityResponse>
|
|
892
|
+
rescue IbmCloudIam::ApiError => e
|
|
893
|
+
puts "Error when calling TrustedProfilesApi->get_profile_identity_with_http_info: #{e}"
|
|
894
|
+
end
|
|
895
|
+
```
|
|
896
|
+
|
|
897
|
+
### Parameters
|
|
898
|
+
|
|
899
|
+
| Name | Type | Description | Notes |
|
|
900
|
+
| ---- | ---- | ----------- | ----- |
|
|
901
|
+
| **profile_id** | **String** | ID of the trusted profile | |
|
|
902
|
+
| **identity_type** | **String** | Type of the identity | |
|
|
903
|
+
| **identifier_id** | **String** | Identifier of the identity that can assume the trusted profiles. | |
|
|
904
|
+
| **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. | |
|
|
905
|
+
|
|
906
|
+
### Return type
|
|
907
|
+
|
|
908
|
+
[**ProfileIdentityResponse**](ProfileIdentityResponse.md)
|
|
909
|
+
|
|
910
|
+
### Authorization
|
|
911
|
+
|
|
912
|
+
No authorization required
|
|
913
|
+
|
|
914
|
+
### HTTP request headers
|
|
915
|
+
|
|
916
|
+
- **Content-Type**: Not defined
|
|
917
|
+
- **Accept**: application/json
|
|
918
|
+
|
|
919
|
+
|
|
920
|
+
## list_claim_rules
|
|
921
|
+
|
|
922
|
+
> <ProfileClaimRuleList> list_claim_rules(profile_id, authorization)
|
|
923
|
+
|
|
924
|
+
List claim rules for a trusted profile
|
|
925
|
+
|
|
926
|
+
Get a list of all claim rules for a trusted profile. The `profile-id` query parameter determines the profile from which to retrieve the list of claim rules.
|
|
927
|
+
|
|
928
|
+
### Examples
|
|
929
|
+
|
|
930
|
+
```ruby
|
|
931
|
+
require 'time'
|
|
932
|
+
require 'ibm_cloud_iam'
|
|
933
|
+
|
|
934
|
+
api_instance = IbmCloudIam::TrustedProfilesApi.new
|
|
935
|
+
profile_id = 'profile_id_example' # String | ID of the trusted profile.
|
|
936
|
+
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.
|
|
937
|
+
|
|
938
|
+
begin
|
|
939
|
+
# List claim rules for a trusted profile
|
|
940
|
+
result = api_instance.list_claim_rules(profile_id, authorization)
|
|
941
|
+
p result
|
|
942
|
+
rescue IbmCloudIam::ApiError => e
|
|
943
|
+
puts "Error when calling TrustedProfilesApi->list_claim_rules: #{e}"
|
|
944
|
+
end
|
|
945
|
+
```
|
|
946
|
+
|
|
947
|
+
#### Using the list_claim_rules_with_http_info variant
|
|
948
|
+
|
|
949
|
+
This returns an Array which contains the response data, status code and headers.
|
|
950
|
+
|
|
951
|
+
> <Array(<ProfileClaimRuleList>, Integer, Hash)> list_claim_rules_with_http_info(profile_id, authorization)
|
|
952
|
+
|
|
953
|
+
```ruby
|
|
954
|
+
begin
|
|
955
|
+
# List claim rules for a trusted profile
|
|
956
|
+
data, status_code, headers = api_instance.list_claim_rules_with_http_info(profile_id, authorization)
|
|
957
|
+
p status_code # => 2xx
|
|
958
|
+
p headers # => { ... }
|
|
959
|
+
p data # => <ProfileClaimRuleList>
|
|
960
|
+
rescue IbmCloudIam::ApiError => e
|
|
961
|
+
puts "Error when calling TrustedProfilesApi->list_claim_rules_with_http_info: #{e}"
|
|
962
|
+
end
|
|
963
|
+
```
|
|
964
|
+
|
|
965
|
+
### Parameters
|
|
966
|
+
|
|
967
|
+
| Name | Type | Description | Notes |
|
|
968
|
+
| ---- | ---- | ----------- | ----- |
|
|
969
|
+
| **profile_id** | **String** | ID of the trusted profile. | |
|
|
970
|
+
| **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. | |
|
|
971
|
+
|
|
972
|
+
### Return type
|
|
973
|
+
|
|
974
|
+
[**ProfileClaimRuleList**](ProfileClaimRuleList.md)
|
|
975
|
+
|
|
976
|
+
### Authorization
|
|
977
|
+
|
|
978
|
+
No authorization required
|
|
979
|
+
|
|
980
|
+
### HTTP request headers
|
|
981
|
+
|
|
982
|
+
- **Content-Type**: Not defined
|
|
983
|
+
- **Accept**: application/json
|
|
984
|
+
|
|
985
|
+
|
|
986
|
+
## list_links
|
|
987
|
+
|
|
988
|
+
> <ProfileLinkList> list_links(profile_id, authorization)
|
|
989
|
+
|
|
990
|
+
List links to a trusted profile
|
|
991
|
+
|
|
992
|
+
Get a list of links to a trusted profile.
|
|
993
|
+
|
|
994
|
+
### Examples
|
|
995
|
+
|
|
996
|
+
```ruby
|
|
997
|
+
require 'time'
|
|
998
|
+
require 'ibm_cloud_iam'
|
|
999
|
+
|
|
1000
|
+
api_instance = IbmCloudIam::TrustedProfilesApi.new
|
|
1001
|
+
profile_id = 'profile_id_example' # String | ID of the trusted profile
|
|
1002
|
+
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.
|
|
1003
|
+
|
|
1004
|
+
begin
|
|
1005
|
+
# List links to a trusted profile
|
|
1006
|
+
result = api_instance.list_links(profile_id, authorization)
|
|
1007
|
+
p result
|
|
1008
|
+
rescue IbmCloudIam::ApiError => e
|
|
1009
|
+
puts "Error when calling TrustedProfilesApi->list_links: #{e}"
|
|
1010
|
+
end
|
|
1011
|
+
```
|
|
1012
|
+
|
|
1013
|
+
#### Using the list_links_with_http_info variant
|
|
1014
|
+
|
|
1015
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1016
|
+
|
|
1017
|
+
> <Array(<ProfileLinkList>, Integer, Hash)> list_links_with_http_info(profile_id, authorization)
|
|
1018
|
+
|
|
1019
|
+
```ruby
|
|
1020
|
+
begin
|
|
1021
|
+
# List links to a trusted profile
|
|
1022
|
+
data, status_code, headers = api_instance.list_links_with_http_info(profile_id, authorization)
|
|
1023
|
+
p status_code # => 2xx
|
|
1024
|
+
p headers # => { ... }
|
|
1025
|
+
p data # => <ProfileLinkList>
|
|
1026
|
+
rescue IbmCloudIam::ApiError => e
|
|
1027
|
+
puts "Error when calling TrustedProfilesApi->list_links_with_http_info: #{e}"
|
|
1028
|
+
end
|
|
1029
|
+
```
|
|
1030
|
+
|
|
1031
|
+
### Parameters
|
|
1032
|
+
|
|
1033
|
+
| Name | Type | Description | Notes |
|
|
1034
|
+
| ---- | ---- | ----------- | ----- |
|
|
1035
|
+
| **profile_id** | **String** | ID of the trusted profile | |
|
|
1036
|
+
| **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. | |
|
|
1037
|
+
|
|
1038
|
+
### Return type
|
|
1039
|
+
|
|
1040
|
+
[**ProfileLinkList**](ProfileLinkList.md)
|
|
1041
|
+
|
|
1042
|
+
### Authorization
|
|
1043
|
+
|
|
1044
|
+
No authorization required
|
|
1045
|
+
|
|
1046
|
+
### HTTP request headers
|
|
1047
|
+
|
|
1048
|
+
- **Content-Type**: Not defined
|
|
1049
|
+
- **Accept**: application/json
|
|
1050
|
+
|
|
1051
|
+
|
|
1052
|
+
## list_profiles
|
|
1053
|
+
|
|
1054
|
+
> <TrustedProfilesList> list_profiles(account_id, authorization, opts)
|
|
1055
|
+
|
|
1056
|
+
List trusted profiles
|
|
1057
|
+
|
|
1058
|
+
List the trusted profiles in an account. The `account_id` query parameter determines the account from which to retrieve the list of trusted profiles.
|
|
1059
|
+
|
|
1060
|
+
### Examples
|
|
1061
|
+
|
|
1062
|
+
```ruby
|
|
1063
|
+
require 'time'
|
|
1064
|
+
require 'ibm_cloud_iam'
|
|
1065
|
+
|
|
1066
|
+
api_instance = IbmCloudIam::TrustedProfilesApi.new
|
|
1067
|
+
account_id = 'account_id_example' # String | Account ID to query for trusted profiles.
|
|
1068
|
+
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.
|
|
1069
|
+
opts = {
|
|
1070
|
+
name: 'name_example', # String | Name of the trusted profile to query.
|
|
1071
|
+
pagesize: 56, # Integer | Optional size of a single page. Default is 20 items per page. Valid range is 1 to 100.
|
|
1072
|
+
sort: 'sort_example', # String | Optional sort property, valid values are name, description, created_at and modified_at. If specified, the items are sorted by the value of this property.
|
|
1073
|
+
order: 'asc', # String | Optional sort order, valid values are asc and desc. Default: asc.
|
|
1074
|
+
include_history: true, # Boolean | Defines if the entity history is included in the response.
|
|
1075
|
+
pagetoken: 'pagetoken_example', # String | Optional Prev or Next page token returned from a previous query execution. Default is start with first page.
|
|
1076
|
+
filter: 'filter_example' # String | An optional filter query parameter used to refine the results of the search operation. For more information see [Filtering list results](#filter-list-results) section.
|
|
1077
|
+
}
|
|
1078
|
+
|
|
1079
|
+
begin
|
|
1080
|
+
# List trusted profiles
|
|
1081
|
+
result = api_instance.list_profiles(account_id, authorization, opts)
|
|
1082
|
+
p result
|
|
1083
|
+
rescue IbmCloudIam::ApiError => e
|
|
1084
|
+
puts "Error when calling TrustedProfilesApi->list_profiles: #{e}"
|
|
1085
|
+
end
|
|
1086
|
+
```
|
|
1087
|
+
|
|
1088
|
+
#### Using the list_profiles_with_http_info variant
|
|
1089
|
+
|
|
1090
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1091
|
+
|
|
1092
|
+
> <Array(<TrustedProfilesList>, Integer, Hash)> list_profiles_with_http_info(account_id, authorization, opts)
|
|
1093
|
+
|
|
1094
|
+
```ruby
|
|
1095
|
+
begin
|
|
1096
|
+
# List trusted profiles
|
|
1097
|
+
data, status_code, headers = api_instance.list_profiles_with_http_info(account_id, authorization, opts)
|
|
1098
|
+
p status_code # => 2xx
|
|
1099
|
+
p headers # => { ... }
|
|
1100
|
+
p data # => <TrustedProfilesList>
|
|
1101
|
+
rescue IbmCloudIam::ApiError => e
|
|
1102
|
+
puts "Error when calling TrustedProfilesApi->list_profiles_with_http_info: #{e}"
|
|
1103
|
+
end
|
|
1104
|
+
```
|
|
1105
|
+
|
|
1106
|
+
### Parameters
|
|
1107
|
+
|
|
1108
|
+
| Name | Type | Description | Notes |
|
|
1109
|
+
| ---- | ---- | ----------- | ----- |
|
|
1110
|
+
| **account_id** | **String** | Account ID to query for trusted profiles. | |
|
|
1111
|
+
| **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. | |
|
|
1112
|
+
| **name** | **String** | Name of the trusted profile to query. | [optional] |
|
|
1113
|
+
| **pagesize** | **Integer** | Optional size of a single page. Default is 20 items per page. Valid range is 1 to 100. | [optional] |
|
|
1114
|
+
| **sort** | **String** | Optional sort property, valid values are name, description, created_at and modified_at. If specified, the items are sorted by the value of this property. | [optional] |
|
|
1115
|
+
| **order** | **String** | Optional sort order, valid values are asc and desc. Default: asc. | [optional][default to 'asc'] |
|
|
1116
|
+
| **include_history** | **Boolean** | Defines if the entity history is included in the response. | [optional][default to false] |
|
|
1117
|
+
| **pagetoken** | **String** | Optional Prev or Next page token returned from a previous query execution. Default is start with first page. | [optional] |
|
|
1118
|
+
| **filter** | **String** | An optional filter query parameter used to refine the results of the search operation. For more information see [Filtering list results](#filter-list-results) section. | [optional] |
|
|
1119
|
+
|
|
1120
|
+
### Return type
|
|
1121
|
+
|
|
1122
|
+
[**TrustedProfilesList**](TrustedProfilesList.md)
|
|
1123
|
+
|
|
1124
|
+
### Authorization
|
|
1125
|
+
|
|
1126
|
+
No authorization required
|
|
1127
|
+
|
|
1128
|
+
### HTTP request headers
|
|
1129
|
+
|
|
1130
|
+
- **Content-Type**: Not defined
|
|
1131
|
+
- **Accept**: application/json
|
|
1132
|
+
|
|
1133
|
+
|
|
1134
|
+
## set_profile_identities
|
|
1135
|
+
|
|
1136
|
+
> <ProfileIdentitiesResponse> set_profile_identities(profile_id, if_match, authorization, profile_identities_update_request)
|
|
1137
|
+
|
|
1138
|
+
Update the list of identities that can assume the trusted profile
|
|
1139
|
+
|
|
1140
|
+
Update the list of identities that can assume the trusted profile
|
|
1141
|
+
|
|
1142
|
+
### Examples
|
|
1143
|
+
|
|
1144
|
+
```ruby
|
|
1145
|
+
require 'time'
|
|
1146
|
+
require 'ibm_cloud_iam'
|
|
1147
|
+
|
|
1148
|
+
api_instance = IbmCloudIam::TrustedProfilesApi.new
|
|
1149
|
+
profile_id = 'profile_id_example' # String | ID of the trusted profile.
|
|
1150
|
+
if_match = 'if_match_example' # String | Entity tag of the Identities to be updated. Specify the tag that you retrieved when reading the Profile Identities. This value helps identify parallel usage of this API. Pass * to indicate updating any available version, which may result in stale updates.
|
|
1151
|
+
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.
|
|
1152
|
+
profile_identities_update_request = IbmCloudIam::ProfileIdentitiesUpdateRequest.new # ProfileIdentitiesUpdateRequest | Request to update identities.
|
|
1153
|
+
|
|
1154
|
+
begin
|
|
1155
|
+
# Update the list of identities that can assume the trusted profile
|
|
1156
|
+
result = api_instance.set_profile_identities(profile_id, if_match, authorization, profile_identities_update_request)
|
|
1157
|
+
p result
|
|
1158
|
+
rescue IbmCloudIam::ApiError => e
|
|
1159
|
+
puts "Error when calling TrustedProfilesApi->set_profile_identities: #{e}"
|
|
1160
|
+
end
|
|
1161
|
+
```
|
|
1162
|
+
|
|
1163
|
+
#### Using the set_profile_identities_with_http_info variant
|
|
1164
|
+
|
|
1165
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1166
|
+
|
|
1167
|
+
> <Array(<ProfileIdentitiesResponse>, Integer, Hash)> set_profile_identities_with_http_info(profile_id, if_match, authorization, profile_identities_update_request)
|
|
1168
|
+
|
|
1169
|
+
```ruby
|
|
1170
|
+
begin
|
|
1171
|
+
# Update the list of identities that can assume the trusted profile
|
|
1172
|
+
data, status_code, headers = api_instance.set_profile_identities_with_http_info(profile_id, if_match, authorization, profile_identities_update_request)
|
|
1173
|
+
p status_code # => 2xx
|
|
1174
|
+
p headers # => { ... }
|
|
1175
|
+
p data # => <ProfileIdentitiesResponse>
|
|
1176
|
+
rescue IbmCloudIam::ApiError => e
|
|
1177
|
+
puts "Error when calling TrustedProfilesApi->set_profile_identities_with_http_info: #{e}"
|
|
1178
|
+
end
|
|
1179
|
+
```
|
|
1180
|
+
|
|
1181
|
+
### Parameters
|
|
1182
|
+
|
|
1183
|
+
| Name | Type | Description | Notes |
|
|
1184
|
+
| ---- | ---- | ----------- | ----- |
|
|
1185
|
+
| **profile_id** | **String** | ID of the trusted profile. | |
|
|
1186
|
+
| **if_match** | **String** | Entity tag of the Identities to be updated. Specify the tag that you retrieved when reading the Profile Identities. This value helps identify parallel usage of this API. Pass * to indicate updating any available version, which may result in stale updates. | |
|
|
1187
|
+
| **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. | |
|
|
1188
|
+
| **profile_identities_update_request** | [**ProfileIdentitiesUpdateRequest**](ProfileIdentitiesUpdateRequest.md) | Request to update identities. | |
|
|
1189
|
+
|
|
1190
|
+
### Return type
|
|
1191
|
+
|
|
1192
|
+
[**ProfileIdentitiesResponse**](ProfileIdentitiesResponse.md)
|
|
1193
|
+
|
|
1194
|
+
### Authorization
|
|
1195
|
+
|
|
1196
|
+
No authorization required
|
|
1197
|
+
|
|
1198
|
+
### HTTP request headers
|
|
1199
|
+
|
|
1200
|
+
- **Content-Type**: application/json
|
|
1201
|
+
- **Accept**: application/json
|
|
1202
|
+
|
|
1203
|
+
|
|
1204
|
+
## set_profile_identity
|
|
1205
|
+
|
|
1206
|
+
> <ProfileIdentityResponse> set_profile_identity(profile_id, identity_type, authorization, profile_identity_request)
|
|
1207
|
+
|
|
1208
|
+
Add a specific identity that can assume the trusted profile
|
|
1209
|
+
|
|
1210
|
+
Add a specific identity that can assume the trusted profile. **Note:** This API will update the trusted profile itself, thus calling it repeatedly for the same profile can lead to conflicts responded with HTTP code 409. Make sure to call this API only once in a few seconds for the same trusted profile.
|
|
1211
|
+
|
|
1212
|
+
### Examples
|
|
1213
|
+
|
|
1214
|
+
```ruby
|
|
1215
|
+
require 'time'
|
|
1216
|
+
require 'ibm_cloud_iam'
|
|
1217
|
+
|
|
1218
|
+
api_instance = IbmCloudIam::TrustedProfilesApi.new
|
|
1219
|
+
profile_id = 'profile_id_example' # String | ID of the trusted profile
|
|
1220
|
+
identity_type = 'user' # String | Type of the identity
|
|
1221
|
+
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.
|
|
1222
|
+
profile_identity_request = IbmCloudIam::ProfileIdentityRequest.new({identifier: 'identifier_example', type: 'user'}) # ProfileIdentityRequest | Request to update identities.
|
|
1223
|
+
|
|
1224
|
+
begin
|
|
1225
|
+
# Add a specific identity that can assume the trusted profile
|
|
1226
|
+
result = api_instance.set_profile_identity(profile_id, identity_type, authorization, profile_identity_request)
|
|
1227
|
+
p result
|
|
1228
|
+
rescue IbmCloudIam::ApiError => e
|
|
1229
|
+
puts "Error when calling TrustedProfilesApi->set_profile_identity: #{e}"
|
|
1230
|
+
end
|
|
1231
|
+
```
|
|
1232
|
+
|
|
1233
|
+
#### Using the set_profile_identity_with_http_info variant
|
|
1234
|
+
|
|
1235
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1236
|
+
|
|
1237
|
+
> <Array(<ProfileIdentityResponse>, Integer, Hash)> set_profile_identity_with_http_info(profile_id, identity_type, authorization, profile_identity_request)
|
|
1238
|
+
|
|
1239
|
+
```ruby
|
|
1240
|
+
begin
|
|
1241
|
+
# Add a specific identity that can assume the trusted profile
|
|
1242
|
+
data, status_code, headers = api_instance.set_profile_identity_with_http_info(profile_id, identity_type, authorization, profile_identity_request)
|
|
1243
|
+
p status_code # => 2xx
|
|
1244
|
+
p headers # => { ... }
|
|
1245
|
+
p data # => <ProfileIdentityResponse>
|
|
1246
|
+
rescue IbmCloudIam::ApiError => e
|
|
1247
|
+
puts "Error when calling TrustedProfilesApi->set_profile_identity_with_http_info: #{e}"
|
|
1248
|
+
end
|
|
1249
|
+
```
|
|
1250
|
+
|
|
1251
|
+
### Parameters
|
|
1252
|
+
|
|
1253
|
+
| Name | Type | Description | Notes |
|
|
1254
|
+
| ---- | ---- | ----------- | ----- |
|
|
1255
|
+
| **profile_id** | **String** | ID of the trusted profile | |
|
|
1256
|
+
| **identity_type** | **String** | Type of the identity | |
|
|
1257
|
+
| **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. | |
|
|
1258
|
+
| **profile_identity_request** | [**ProfileIdentityRequest**](ProfileIdentityRequest.md) | Request to update identities. | |
|
|
1259
|
+
|
|
1260
|
+
### Return type
|
|
1261
|
+
|
|
1262
|
+
[**ProfileIdentityResponse**](ProfileIdentityResponse.md)
|
|
1263
|
+
|
|
1264
|
+
### Authorization
|
|
1265
|
+
|
|
1266
|
+
No authorization required
|
|
1267
|
+
|
|
1268
|
+
### HTTP request headers
|
|
1269
|
+
|
|
1270
|
+
- **Content-Type**: application/json
|
|
1271
|
+
- **Accept**: application/json
|
|
1272
|
+
|
|
1273
|
+
|
|
1274
|
+
## update_claim_rule
|
|
1275
|
+
|
|
1276
|
+
> <ProfileClaimRule> update_claim_rule(profile_id, rule_id, authorization, if_match, profile_claim_rule_request)
|
|
1277
|
+
|
|
1278
|
+
Update claim rule for a trusted profile
|
|
1279
|
+
|
|
1280
|
+
Update a specific claim rule for a given trusted profile ID and rule ID.
|
|
1281
|
+
|
|
1282
|
+
### Examples
|
|
1283
|
+
|
|
1284
|
+
```ruby
|
|
1285
|
+
require 'time'
|
|
1286
|
+
require 'ibm_cloud_iam'
|
|
1287
|
+
|
|
1288
|
+
api_instance = IbmCloudIam::TrustedProfilesApi.new
|
|
1289
|
+
profile_id = 'profile_id_example' # String | ID of the trusted profile.
|
|
1290
|
+
rule_id = 'rule_id_example' # String | ID of the claim rule to update.
|
|
1291
|
+
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.
|
|
1292
|
+
if_match = 'if_match_example' # String | Version of the claim rule to be updated. Specify the version that you retrived when reading list of claim rules. This value helps to identify any parallel usage of claim rule. Pass * to indicate to update any version available. This might result in stale updates.
|
|
1293
|
+
profile_claim_rule_request = IbmCloudIam::ProfileClaimRuleRequest.new({type: 'type_example', conditions: [IbmCloudIam::ProfileClaimRuleConditions.new({claim: 'claim_example', operator: 'operator_example', value: 'value_example'})]}) # ProfileClaimRuleRequest | Request to update a claim rule.
|
|
1294
|
+
|
|
1295
|
+
begin
|
|
1296
|
+
# Update claim rule for a trusted profile
|
|
1297
|
+
result = api_instance.update_claim_rule(profile_id, rule_id, authorization, if_match, profile_claim_rule_request)
|
|
1298
|
+
p result
|
|
1299
|
+
rescue IbmCloudIam::ApiError => e
|
|
1300
|
+
puts "Error when calling TrustedProfilesApi->update_claim_rule: #{e}"
|
|
1301
|
+
end
|
|
1302
|
+
```
|
|
1303
|
+
|
|
1304
|
+
#### Using the update_claim_rule_with_http_info variant
|
|
1305
|
+
|
|
1306
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1307
|
+
|
|
1308
|
+
> <Array(<ProfileClaimRule>, Integer, Hash)> update_claim_rule_with_http_info(profile_id, rule_id, authorization, if_match, profile_claim_rule_request)
|
|
1309
|
+
|
|
1310
|
+
```ruby
|
|
1311
|
+
begin
|
|
1312
|
+
# Update claim rule for a trusted profile
|
|
1313
|
+
data, status_code, headers = api_instance.update_claim_rule_with_http_info(profile_id, rule_id, authorization, if_match, profile_claim_rule_request)
|
|
1314
|
+
p status_code # => 2xx
|
|
1315
|
+
p headers # => { ... }
|
|
1316
|
+
p data # => <ProfileClaimRule>
|
|
1317
|
+
rescue IbmCloudIam::ApiError => e
|
|
1318
|
+
puts "Error when calling TrustedProfilesApi->update_claim_rule_with_http_info: #{e}"
|
|
1319
|
+
end
|
|
1320
|
+
```
|
|
1321
|
+
|
|
1322
|
+
### Parameters
|
|
1323
|
+
|
|
1324
|
+
| Name | Type | Description | Notes |
|
|
1325
|
+
| ---- | ---- | ----------- | ----- |
|
|
1326
|
+
| **profile_id** | **String** | ID of the trusted profile. | |
|
|
1327
|
+
| **rule_id** | **String** | ID of the claim rule to update. | |
|
|
1328
|
+
| **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. | |
|
|
1329
|
+
| **if_match** | **String** | Version of the claim rule to be updated. Specify the version that you retrived when reading list of claim rules. This value helps to identify any parallel usage of claim rule. Pass * to indicate to update any version available. This might result in stale updates. | |
|
|
1330
|
+
| **profile_claim_rule_request** | [**ProfileClaimRuleRequest**](ProfileClaimRuleRequest.md) | Request to update a claim rule. | |
|
|
1331
|
+
|
|
1332
|
+
### Return type
|
|
1333
|
+
|
|
1334
|
+
[**ProfileClaimRule**](ProfileClaimRule.md)
|
|
1335
|
+
|
|
1336
|
+
### Authorization
|
|
1337
|
+
|
|
1338
|
+
No authorization required
|
|
1339
|
+
|
|
1340
|
+
### HTTP request headers
|
|
1341
|
+
|
|
1342
|
+
- **Content-Type**: application/json
|
|
1343
|
+
- **Accept**: application/json
|
|
1344
|
+
|
|
1345
|
+
|
|
1346
|
+
## update_profile
|
|
1347
|
+
|
|
1348
|
+
> <TrustedProfile> update_profile(profile_id, authorization, if_match, update_trusted_profile_request)
|
|
1349
|
+
|
|
1350
|
+
Update a trusted profile
|
|
1351
|
+
|
|
1352
|
+
Update the name or description of an existing trusted profile.
|
|
1353
|
+
|
|
1354
|
+
### Examples
|
|
1355
|
+
|
|
1356
|
+
```ruby
|
|
1357
|
+
require 'time'
|
|
1358
|
+
require 'ibm_cloud_iam'
|
|
1359
|
+
|
|
1360
|
+
api_instance = IbmCloudIam::TrustedProfilesApi.new
|
|
1361
|
+
profile_id = 'profile_id_example' # String | ID of the trusted profile to be updated.
|
|
1362
|
+
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.
|
|
1363
|
+
if_match = 'if_match_example' # String | Version of the trusted profile to be updated. Specify the version that you retrived when reading list of trusted profiles. This value helps to identify any parallel usage of trusted profile. Pass * to indicate to update any version available. This might result in stale updates.
|
|
1364
|
+
update_trusted_profile_request = IbmCloudIam::UpdateTrustedProfileRequest.new # UpdateTrustedProfileRequest | Request to update a trusted profile.
|
|
1365
|
+
|
|
1366
|
+
begin
|
|
1367
|
+
# Update a trusted profile
|
|
1368
|
+
result = api_instance.update_profile(profile_id, authorization, if_match, update_trusted_profile_request)
|
|
1369
|
+
p result
|
|
1370
|
+
rescue IbmCloudIam::ApiError => e
|
|
1371
|
+
puts "Error when calling TrustedProfilesApi->update_profile: #{e}"
|
|
1372
|
+
end
|
|
1373
|
+
```
|
|
1374
|
+
|
|
1375
|
+
#### Using the update_profile_with_http_info variant
|
|
1376
|
+
|
|
1377
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1378
|
+
|
|
1379
|
+
> <Array(<TrustedProfile>, Integer, Hash)> update_profile_with_http_info(profile_id, authorization, if_match, update_trusted_profile_request)
|
|
1380
|
+
|
|
1381
|
+
```ruby
|
|
1382
|
+
begin
|
|
1383
|
+
# Update a trusted profile
|
|
1384
|
+
data, status_code, headers = api_instance.update_profile_with_http_info(profile_id, authorization, if_match, update_trusted_profile_request)
|
|
1385
|
+
p status_code # => 2xx
|
|
1386
|
+
p headers # => { ... }
|
|
1387
|
+
p data # => <TrustedProfile>
|
|
1388
|
+
rescue IbmCloudIam::ApiError => e
|
|
1389
|
+
puts "Error when calling TrustedProfilesApi->update_profile_with_http_info: #{e}"
|
|
1390
|
+
end
|
|
1391
|
+
```
|
|
1392
|
+
|
|
1393
|
+
### Parameters
|
|
1394
|
+
|
|
1395
|
+
| Name | Type | Description | Notes |
|
|
1396
|
+
| ---- | ---- | ----------- | ----- |
|
|
1397
|
+
| **profile_id** | **String** | ID of the trusted profile to be updated. | |
|
|
1398
|
+
| **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. | |
|
|
1399
|
+
| **if_match** | **String** | Version of the trusted profile to be updated. Specify the version that you retrived when reading list of trusted profiles. This value helps to identify any parallel usage of trusted profile. Pass * to indicate to update any version available. This might result in stale updates. | |
|
|
1400
|
+
| **update_trusted_profile_request** | [**UpdateTrustedProfileRequest**](UpdateTrustedProfileRequest.md) | Request to update a trusted profile. | |
|
|
1401
|
+
|
|
1402
|
+
### Return type
|
|
1403
|
+
|
|
1404
|
+
[**TrustedProfile**](TrustedProfile.md)
|
|
1405
|
+
|
|
1406
|
+
### Authorization
|
|
1407
|
+
|
|
1408
|
+
No authorization required
|
|
1409
|
+
|
|
1410
|
+
### HTTP request headers
|
|
1411
|
+
|
|
1412
|
+
- **Content-Type**: application/json
|
|
1413
|
+
- **Accept**: application/json
|
|
1414
|
+
|