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
data/README.md
CHANGED
|
@@ -1,13 +1,318 @@
|
|
|
1
1
|
# ibm_cloud_iam
|
|
2
2
|
|
|
3
|
-
IbmCloudIam - the Ruby gem for the IAM Identity Services
|
|
3
|
+
IbmCloudIam - the Ruby gem for the IAM Identity Services
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
## Introduction
|
|
8
|
+
|
|
9
|
+
The IAM Identity Service API is used to manage service IDs, API key identities, trusted profiles, account security settings and to create IAM access tokens for a user or service ID.
|
|
10
|
+
|
|
11
|
+
With trusted profile templates and assignments you can centrally manage access for child accounts in your organization from the root enterprise account. Similarly with settings templates and assignments, you can centrally administer account security settings. For more information, see [Working with template versions](https://cloud.ibm.com/docs/secure-enterprise?topic=secure-enterprise-working-with-versions&interface=ui) and [Best practices for assigning access in an enterprise](https://cloud.ibm.com/docs/secure-enterprise?topic=secure-enterprise-access-enterprises).
|
|
12
|
+
|
|
13
|
+
SDKs for Java, Node, Python, and Go are available to make it easier to programmatically access the API from your code. The client libraries that are provided by the SDKs implement best practices for using the API and reduce the amount of code that you need to write. The tab for each language includes code examples that demonstrate how to use the client libraries. For more information about using the SDKs, see the [IBM Cloud SDK Common project](https://github.com/IBM/ibm-cloud-sdk-common) on GitHub.
|
|
14
|
+
|
|
15
|
+
Installing the Java SDK
|
|
16
|
+
|
|
17
|
+
Maven
|
|
18
|
+
|
|
19
|
+
```xml
|
|
20
|
+
<dependency>
|
|
21
|
+
<groupId>com.ibm.cloud</groupId>
|
|
22
|
+
<artifactId>iam-identity</artifactId>
|
|
23
|
+
<version>{version}</version>
|
|
24
|
+
</dependency>
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Gradle
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
compile 'com.ibm.cloud:iam-identity:{version}'
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
Replace `{version}` in these examples with the release version.
|
|
34
|
+
|
|
35
|
+
View on GitHub
|
|
36
|
+
|
|
37
|
+
[https://github.com/IBM/platform-services-java-sdk](https://github.com/IBM/platform-services-java-sdk)
|
|
38
|
+
|
|
39
|
+
Installing the Go SDK
|
|
40
|
+
|
|
41
|
+
Go modules (recommended): Add the following import in your code, and then run `go build` or `go mod tidy`
|
|
42
|
+
|
|
43
|
+
```go
|
|
44
|
+
import (
|
|
45
|
+
\"github.com/IBM/platform-services-go-sdk/iamidentityv1\"
|
|
46
|
+
)
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
go get -u github.com/IBM/platform-services-go-sdk/iamidentityv1
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
View on GitHub
|
|
54
|
+
|
|
55
|
+
[https://github.com/IBM/platform-services-go-sdk](https://github.com/IBM/platform-services-go-sdk)
|
|
56
|
+
|
|
57
|
+
Installing the Node SDK
|
|
58
|
+
|
|
59
|
+
```bash
|
|
60
|
+
npm install @ibm-cloud/platform-services
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
View on GitHub
|
|
64
|
+
|
|
65
|
+
[https://github.com/IBM/platform-services-node-sdk](https://github.com/IBM/platform-services-node-sdk)
|
|
66
|
+
|
|
67
|
+
Installing the Python SDK
|
|
68
|
+
|
|
69
|
+
```bash
|
|
70
|
+
pip install --upgrade \"ibm-platform-services\"
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
View on GitHub
|
|
74
|
+
|
|
75
|
+
[https://github.com/IBM/platform-services-python-sdk](https://github.com/IBM/platform-services-python-sdk)
|
|
76
|
+
|
|
77
|
+
The examples that are provided on this page demonstrate how to use IAM Identity Service For more information and detailed examples, check out the [IBM Cloud SDK Common project on GitHub](https://github.com/IBM/ibm-cloud-sdk-common/blob/master/README.md).
|
|
78
|
+
|
|
79
|
+
The examples that are provided on this page demonstrate how to use IAM Identity Service For more information and detailed examples, check out the [IBM Cloud SDK Common project on GitHub](https://github.com/IBM/ibm-cloud-sdk-common/blob/master/README.md).
|
|
80
|
+
|
|
81
|
+
The examples that are provided on this page demonstrate how to use IAM Identity Service For more information and detailed examples, check out the [IBM Cloud SDK Common project on GitHub](https://github.com/IBM/ibm-cloud-sdk-common/blob/master/README.md).
|
|
82
|
+
|
|
83
|
+
The examples that are provided on this page demonstrate how to use IAM Identity Service For more information and detailed examples, check out the [IBM Cloud SDK Common project on GitHub](https://github.com/IBM/ibm-cloud-sdk-common/blob/master/README.md).
|
|
84
|
+
|
|
85
|
+
## Endpoint URLs
|
|
86
|
+
|
|
87
|
+
The IAM Identity Services API uses the following public global endpoint URL. When you call the API, add the path for each method to form the complete API endpoint for your requests.
|
|
88
|
+
|
|
89
|
+
```bash
|
|
90
|
+
https://iam.cloud.ibm.com
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
Virtual private cloud (VPC) based access requires a virtual private endpoint gateway (VPE gateway). For more information , see [Creating an endpoint gateway](https://cloud.ibm.com/docs/vpc?topic=vpc-ordering-endpoint-gateway).
|
|
94
|
+
|
|
95
|
+
* Private endpoint URL for VPC infrastructure: `https://private.iam.cloud.ibm.com`.
|
|
96
|
+
|
|
97
|
+
VPE gateway creation is supported in all datacenters (see https://cloud.ibm.com/docs/overview?topic=overview-locations#regions).
|
|
98
|
+
|
|
99
|
+
If you enabled service endpoints in your account, you can send API requests over the IBM Cloud® private network at the following base endpoint URLs. For more information, see [Enabling VRF and service endpoints](https://cloud.ibm.com/docs/account?topic=account-vrf-service-endpoint).
|
|
100
|
+
|
|
101
|
+
* Private endpoint URLs for classic infrastructure. Supported URLs:
|
|
102
|
+
|
|
103
|
+
* Sydney: `https://private.au-syd.iam.cloud.ibm.com`
|
|
104
|
+
* Sao Paulo: `https://private.br-sao.iam.cloud.ibm.com`
|
|
105
|
+
* Montreal: `https://private.ca-mon.iam.cloud.ibm.com`
|
|
106
|
+
* Toronto: `https://private.ca-tor.iam.cloud.ibm.com`
|
|
107
|
+
* Frankfurt DC: `https://private.eu-de.iam.cloud.ibm.com`
|
|
108
|
+
* London: `https://private.eu-gb.iam.cloud.ibm.com`
|
|
109
|
+
* Madrid: `https://private.eu-es.iam.cloud.ibm.com`
|
|
110
|
+
* Tokyo: `https://private.jp-tok.iam.cloud.ibm.com`
|
|
111
|
+
* Osaka: `https://private.jp-osa.iam.cloud.ibm.com`
|
|
112
|
+
* Washington DC: `https://private.us-east.iam.cloud.ibm.com`
|
|
113
|
+
* Dallas: `https://private.us-south.iam.cloud.ibm.com`
|
|
114
|
+
|
|
115
|
+
IAM is a global service and deployed to multiple MZRs world wide. IAM can be reached from all locations using the public global endpoint or using one of the private endpoints. Each request is sent to the closest region related to the client that invokes the call to IAM.
|
|
116
|
+
|
|
117
|
+
Example API request
|
|
118
|
+
|
|
119
|
+
```bash
|
|
120
|
+
curl -u \"apikey:{apikey}\" -X {request_method} \"https://iam.cloud.ibm.com/{method_endpoint}\"
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
Replace `{apikey}`, `{request_method}`, and `{method_endpoint}` in this example with the values for your particular API call.
|
|
124
|
+
|
|
125
|
+
## Authentication
|
|
126
|
+
|
|
127
|
+
Authorization to the Identity Services REST API is enforced by using an IBM Cloud Identity and Access Management (IAM) access token. The token is used to determine the actions that a user or service ID has access to when they use the API.
|
|
128
|
+
|
|
129
|
+
You can generate an access token by first [creating an API key](https://cloud.ibm.com/docs/account?topic=account-iamtoken_from_apikey) and then exchanging your API key for an IBM Cloud IAM token.
|
|
130
|
+
|
|
131
|
+
Don't have an API key? Try running `ibmcloud iam oauth-tokens` in the [IBM Cloud Shell](https://cloud.ibm.com/shell) to quickly generate a personal access token.
|
|
132
|
+
|
|
133
|
+
When you use the SDK, configure an IAM authenticator with the IAM API key. The authenticator automatically obtains the IAM access token for the API key and includes it with each request. You can construct an authenticator in either of two ways:
|
|
134
|
+
- Programmatically by constructing an IAM authenticator instance and supplying your IAM API key
|
|
135
|
+
- By defining the API key in external configuration properties and then using the SDK authenticator factory to construct an IAM authenticator that uses the configured IAM API key
|
|
136
|
+
|
|
137
|
+
In this example of using external configuration properties, an IAM authenticator instance is created with the configured API key, and then the service client is constructed with this authenticator instance and the configured service URL.
|
|
138
|
+
|
|
139
|
+
For more information, see the Authentication section of the [IBM Cloud SDK Common](https://github.com/IBM/ibm-cloud-sdk-common/blob/main/README.md) documentation.
|
|
140
|
+
|
|
141
|
+
To call each method, you'll need to be assigned a role that includes the required IAM actions. Each method lists the associated action. For more information about IAM actions and how they map to roles, see [IAM Identity service](https://cloud.ibm.com/docs/account?topic=account-account-services#identity-service-account-management).
|
|
142
|
+
|
|
143
|
+
To retrieve your access token:
|
|
144
|
+
|
|
145
|
+
```bash
|
|
146
|
+
curl -X POST \\
|
|
147
|
+
\"https://iam.cloud.ibm.com/identity/token\" \\
|
|
148
|
+
--header 'Content-Type: application/x-www-form-urlencoded' \\
|
|
149
|
+
--header 'Accept: application/json' \\
|
|
150
|
+
--data-urlencode 'grant_type=urn:ibm:params:oauth:grant-type:apikey' \\
|
|
151
|
+
--data-urlencode 'apikey=<API_KEY>'
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
Replace `<API_KEY>` with your IAM API key.
|
|
155
|
+
|
|
156
|
+
Setting client options through external configuration
|
|
157
|
+
|
|
158
|
+
Example environment variables, where `<SERVICE_URL>` is the endpoint URL and `<API_KEY>` is your IAM API key
|
|
159
|
+
```sh
|
|
160
|
+
export IAM_IDENTITY_URL=<SERVICE_URL>
|
|
161
|
+
export IAM_IDENTITY_AUTHTYPE=iam
|
|
162
|
+
export IAM_IDENTITY_APIKEY=<API_KEY>
|
|
163
|
+
```
|
|
164
|
+
|
|
165
|
+
Example of constructing the service client
|
|
166
|
+
```go
|
|
167
|
+
import {
|
|
168
|
+
\"github.com/IBM/platform-services-go-sdk/iamidentityv1\"
|
|
169
|
+
}
|
|
170
|
+
...
|
|
171
|
+
serviceClientOptions := &iamidentityv1.IamIdentityV1Options{}
|
|
172
|
+
serviceClient, err := iamidentityv1.NewIamIdentityV1UsingExternalConfig(serviceClientOptions)
|
|
173
|
+
```
|
|
174
|
+
|
|
175
|
+
Setting client options through external configuration
|
|
176
|
+
|
|
177
|
+
Example environment variables, where `<SERVICE_URL>` is the endpoint URL and `<API_KEY>` is your IAM API key
|
|
178
|
+
```sh
|
|
179
|
+
export IAM_IDENTITY_URL=<SERVICE_URL>
|
|
180
|
+
export IAM_IDENTITY_AUTHTYPE=iam
|
|
181
|
+
export IAM_IDENTITY_APIKEY=<API_KEY>
|
|
182
|
+
```
|
|
183
|
+
|
|
184
|
+
Example of constructing the service client
|
|
185
|
+
```java
|
|
186
|
+
import com.ibm.cloud.platform_services.iam_identity.v1.IamIdentity;
|
|
187
|
+
...
|
|
188
|
+
IamIdentity serviceClient = IamIdentity.newInstance();
|
|
189
|
+
```
|
|
190
|
+
|
|
191
|
+
Setting client options through external configuration
|
|
192
|
+
|
|
193
|
+
Example environment variables, where `<SERVICE_URL>` is the endpoint URL and `<API_KEY>` is your IAM API key
|
|
194
|
+
```sh
|
|
195
|
+
export IAM_IDENTITY_URL=<SERVICE_URL>
|
|
196
|
+
export IAM_IDENTITY_AUTHTYPE=iam
|
|
197
|
+
export IAM_IDENTITY_APIKEY=<API_KEY>
|
|
198
|
+
```
|
|
199
|
+
|
|
200
|
+
Example of constructing the service client
|
|
201
|
+
```javascript
|
|
202
|
+
const IamIdentityV1 = require('@ibm-cloud/platform-services/iam-identity/v1');
|
|
203
|
+
...
|
|
204
|
+
const serviceClient = IamIdentityV1.newInstance({});
|
|
205
|
+
```
|
|
206
|
+
|
|
207
|
+
Setting client options through external configuration
|
|
208
|
+
|
|
209
|
+
Example environment variables, where `<SERVICE_URL>` is the endpoint URL and `<API_KEY>` is your IAM API key
|
|
210
|
+
```sh
|
|
211
|
+
export IAM_IDENTITY_URL=<SERVICE_URL>
|
|
212
|
+
export IAM_IDENTITY_AUTHTYPE=iam
|
|
213
|
+
export IAM_IDENTITY_APIKEY=<API_KEY>
|
|
214
|
+
```
|
|
215
|
+
|
|
216
|
+
Example of constructing the service client
|
|
217
|
+
```python
|
|
218
|
+
from ibm_platform_services import IamIdentityV1
|
|
219
|
+
...
|
|
220
|
+
service_client = IamIdentityV1.new_instance()
|
|
221
|
+
```
|
|
222
|
+
|
|
223
|
+
You authenticate to the API by using Cloud Identity and Access Management (IAM). You can pass either a bearer token in an authorization header or an [API key](https://cloud.ibm.com/docs/account?topic=account-manapikey).
|
|
224
|
+
|
|
225
|
+
The SDK provides initialization methods for each form of authentication.
|
|
226
|
+
|
|
227
|
+
- Use the API key to have the SDK manage the lifecycle of the access token. The SDK requests an access token, ensures that the access token is valid, includes the access token in each outgoing request, and refreshes it when it expires.
|
|
228
|
+
- Use the access token to manage the lifecycle yourself. Keep in mind that access tokens are valid for 1 hour, so you must refresh them regularly to maintain access.
|
|
229
|
+
|
|
230
|
+
For more information, see [IAM authentication with the SDK](https://github.com/IBM/ibm-cloud-sdk-common/blob/master/README.md#authentication).
|
|
231
|
+
|
|
232
|
+
For more information, see [IAM authentication with the SDK](https://github.com/IBM/ibm-cloud-sdk-common/blob/master/README.md#authentication).
|
|
233
|
+
|
|
234
|
+
For more information, see [IAM authentication with the SDK](https://github.com/IBM/ibm-cloud-sdk-common/blob/master/README.md#authentication).
|
|
235
|
+
|
|
236
|
+
For more information, see [IAM authentication with the SDK](https://github.com/IBM/ibm-cloud-sdk-common/blob/master/README.md#authentication).
|
|
237
|
+
|
|
238
|
+
## Auditing
|
|
239
|
+
|
|
240
|
+
You can monitor API activity within your account by using the IBM Cloud Logs service. Whenever an API method is called, an event is generated that you can then track and audit from within IBM Cloud Logs. The specific event type is listed for each individual method.
|
|
241
|
+
|
|
242
|
+
If an event is tracked for a method, you can find it listed with the method. For more information about how to track IAM activity, see [Activity tracking events for IAM](https://cloud.ibm.com/docs/account?topic=account-at_events_iam).
|
|
243
|
+
|
|
244
|
+
## Error handling
|
|
245
|
+
|
|
246
|
+
The IAM Token Service uses standard HTTP response codes to indicate whether a method completed successfully. A `200` response always indicates success. A `400` type response indicates that a parameter validation failed and can occur if required parameters are missing or if any parameter values are invalid. A `401` or `403` response indicates that the incoming request did not contain valid authentication information. A `500` type response indicates an internal server error that is seen in an unexpected error situation.
|
|
247
|
+
|
|
248
|
+
The Identity Services REST APIs return standard HTTP status codes to indicate the success or failure of a request. The format of the response is represented in JSON as follows:
|
|
249
|
+
```json
|
|
250
|
+
{
|
|
251
|
+
\"trace\": \"9daee671-916a-4678-850b-10b911f0236d\",
|
|
252
|
+
\"errors\": [
|
|
253
|
+
{
|
|
254
|
+
\"code\": \"invalid_access_token\",
|
|
255
|
+
\"message\": \"The provided access token provided is invalid.\"
|
|
256
|
+
}
|
|
257
|
+
]
|
|
258
|
+
\"status_code\": 401
|
|
259
|
+
}
|
|
260
|
+
```
|
|
261
|
+
If an operation cannot be fulfilled, an appropriate 400 or 500 series HTTP response is returned from the server. The operations that are defined in the `Reference` section describe example errors that might be returned from a failed request. All responses from the Identity Services REST API are in JSON format.
|
|
262
|
+
|
|
263
|
+
The following table show the potential error codes the API might return.
|
|
264
|
+
|
|
265
|
+
| HTTP Error Code | Description | Recovery |
|
|
266
|
+
|-----------------|-------------|----------|
|
|
267
|
+
| `200` | Success | The request was successful. |
|
|
268
|
+
| `201` | Created | The resource was successfully created. |
|
|
269
|
+
| `204` | No Content | The request was successful. No response body is provided. |
|
|
270
|
+
| `400` | Bad Request | The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request. |
|
|
271
|
+
| `401` | Unauthorized | You are not authorized to make this request. The token is either missing or expired. Get a new valid token and try again. |
|
|
272
|
+
| `403` | Forbidden | The supplied authentication is not authorized to perform the operation. If this error persists, contact the account owner to check your permissions. |
|
|
273
|
+
| `404` | Not Found | The requested resource can't be found. |
|
|
274
|
+
| `409` | Conflict | The entity is already in the requested state. |
|
|
275
|
+
| `429` | Too Many Requests | Too many requests have been made within a time window. Wait before calling the API again. |
|
|
276
|
+
| `500` | Internal error | Error that is seen in an unexpected error situation. |
|
|
277
|
+
|
|
278
|
+
## Additional headers
|
|
279
|
+
|
|
280
|
+
Some additional headers might be required to make successful requests to the API.
|
|
281
|
+
Those additional headers are:
|
|
282
|
+
|
|
283
|
+
An optional transaction ID can be passed to your request, which can be useful for tracking calls through multiple services using one identifier. The header key must be set to `Transaction-Id` and the value is anything that you choose.
|
|
284
|
+
|
|
285
|
+
If there is not a transaction ID that is passed in, then one is generated randomly.
|
|
286
|
+
|
|
287
|
+
## API Parameters
|
|
288
|
+
Some API parameter have additional details that need to be considered while using it in a request.
|
|
289
|
+
Those API parameters are as follow:
|
|
290
|
+
|
|
291
|
+
### Filtering list results
|
|
292
|
+
|
|
293
|
+
When listing service IDs, trusted profiles or API keys you can filter the result set by providing an optional `filter` parameter. The exact syntax of this parameter is described below. Query syntax will follow the SCIM query syntax with reduced operator support. The value must be URL encoded. Only the following operators are supported.
|
|
294
|
+
* Supported attribute operators-
|
|
295
|
+
- `sw` - starts with
|
|
296
|
+
- `sw_ci` - starts with ingnore case - non SCIM standard
|
|
297
|
+
- `ew` - ends with
|
|
298
|
+
- `ew_ci` - ends with ingnore case - non SCIM standard
|
|
299
|
+
- `co` - contains
|
|
300
|
+
- `co_ci` - contains ingnore case - non SCIM standard
|
|
301
|
+
* Supported operators-
|
|
302
|
+
- `and`
|
|
303
|
+
- `or`
|
|
304
|
+
* Grouping operators-
|
|
305
|
+
- `()`
|
|
306
|
+
* Data Values
|
|
307
|
+
-`Text`
|
|
308
|
+
* Sample
|
|
309
|
+
- `name co \"Foo\" and description sw \"Bar\"`
|
|
6
310
|
|
|
7
311
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
8
312
|
|
|
9
313
|
- API version: 1.0.0
|
|
10
|
-
- Package version:
|
|
314
|
+
- Package version: 2.0.0
|
|
315
|
+
- Generator version: 7.23.0
|
|
11
316
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
12
317
|
|
|
13
318
|
## Installation
|
|
@@ -23,16 +328,16 @@ gem build ibm_cloud_iam.gemspec
|
|
|
23
328
|
Then either install the gem locally:
|
|
24
329
|
|
|
25
330
|
```shell
|
|
26
|
-
gem install ./ibm_cloud_iam-
|
|
331
|
+
gem install ./ibm_cloud_iam-2.0.0.gem
|
|
27
332
|
```
|
|
28
333
|
|
|
29
|
-
(for development, run `gem install --dev ./ibm_cloud_iam-
|
|
334
|
+
(for development, run `gem install --dev ./ibm_cloud_iam-2.0.0.gem` to install the development dependencies)
|
|
30
335
|
|
|
31
336
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
|
32
337
|
|
|
33
338
|
Finally add this to the Gemfile:
|
|
34
339
|
|
|
35
|
-
gem 'ibm_cloud_iam', '~>
|
|
340
|
+
gem 'ibm_cloud_iam', '~> 2.0.0'
|
|
36
341
|
|
|
37
342
|
### Install from Git
|
|
38
343
|
|
|
@@ -56,19 +361,20 @@ Please follow the [installation](#installation) procedure and then run the follo
|
|
|
56
361
|
# Load the gem
|
|
57
362
|
require 'ibm_cloud_iam'
|
|
58
363
|
|
|
59
|
-
api_instance = IbmCloudIam::
|
|
60
|
-
|
|
364
|
+
api_instance = IbmCloudIam::APIKeysApi.new
|
|
365
|
+
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.
|
|
366
|
+
create_api_key_request = IbmCloudIam::CreateApiKeyRequest.new({name: 'name_example', iam_id: 'iam_id_example'}) # CreateApiKeyRequest | Request to create an API key.
|
|
61
367
|
opts = {
|
|
62
|
-
|
|
63
|
-
|
|
368
|
+
entity_lock: 'entity_lock_example', # String | Indicates if the API key is locked for further write operations. False by default.
|
|
369
|
+
entity_disable: 'entity_disable_example' # String | Indicates if the API key is disabled. False by default.
|
|
64
370
|
}
|
|
65
371
|
|
|
66
372
|
begin
|
|
67
373
|
#Create an API key
|
|
68
|
-
result = api_instance.create_api_key(create_api_key_request, opts)
|
|
374
|
+
result = api_instance.create_api_key(authorization, create_api_key_request, opts)
|
|
69
375
|
p result
|
|
70
376
|
rescue IbmCloudIam::ApiError => e
|
|
71
|
-
puts "Exception when calling
|
|
377
|
+
puts "Exception when calling APIKeysApi->create_api_key: #{e}"
|
|
72
378
|
end
|
|
73
379
|
|
|
74
380
|
```
|
|
@@ -79,53 +385,259 @@ All URIs are relative to *https://iam.cloud.ibm.com*
|
|
|
79
385
|
|
|
80
386
|
Class | Method | HTTP request | Description
|
|
81
387
|
------------ | ------------- | ------------- | -------------
|
|
82
|
-
*IbmCloudIam::
|
|
83
|
-
*IbmCloudIam::
|
|
84
|
-
*IbmCloudIam::
|
|
85
|
-
*IbmCloudIam::
|
|
86
|
-
*IbmCloudIam::
|
|
87
|
-
*IbmCloudIam::
|
|
88
|
-
*IbmCloudIam::
|
|
89
|
-
*IbmCloudIam::
|
|
90
|
-
*IbmCloudIam::
|
|
91
|
-
*IbmCloudIam::
|
|
92
|
-
*IbmCloudIam::
|
|
93
|
-
*IbmCloudIam::
|
|
94
|
-
*IbmCloudIam::
|
|
95
|
-
*IbmCloudIam::
|
|
96
|
-
*IbmCloudIam::
|
|
97
|
-
*IbmCloudIam::
|
|
98
|
-
*IbmCloudIam::
|
|
99
|
-
*IbmCloudIam::
|
|
100
|
-
*IbmCloudIam::
|
|
388
|
+
*IbmCloudIam::APIKeysApi* | [**create_api_key**](docs/APIKeysApi.md#create_api_key) | **POST** /v1/apikeys | Create an API key
|
|
389
|
+
*IbmCloudIam::APIKeysApi* | [**delete_api_key**](docs/APIKeysApi.md#delete_api_key) | **DELETE** /v1/apikeys/{id} | Deletes an API key
|
|
390
|
+
*IbmCloudIam::APIKeysApi* | [**disable_api_key**](docs/APIKeysApi.md#disable_api_key) | **POST** /v1/apikeys/{id}/disable | Disable the API key
|
|
391
|
+
*IbmCloudIam::APIKeysApi* | [**enable_api_key**](docs/APIKeysApi.md#enable_api_key) | **DELETE** /v1/apikeys/{id}/disable | Enable the API key
|
|
392
|
+
*IbmCloudIam::APIKeysApi* | [**get_api_key**](docs/APIKeysApi.md#get_api_key) | **GET** /v1/apikeys/{id} | Get details of an API key
|
|
393
|
+
*IbmCloudIam::APIKeysApi* | [**get_api_keys_details**](docs/APIKeysApi.md#get_api_keys_details) | **GET** /v1/apikeys/details | Get details of an API key by its value.
|
|
394
|
+
*IbmCloudIam::APIKeysApi* | [**list_api_keys**](docs/APIKeysApi.md#list_api_keys) | **GET** /v1/apikeys | Get API keys for a given service or user IAM ID and account ID
|
|
395
|
+
*IbmCloudIam::APIKeysApi* | [**lock_api_key**](docs/APIKeysApi.md#lock_api_key) | **POST** /v1/apikeys/{id}/lock | Lock the API key
|
|
396
|
+
*IbmCloudIam::APIKeysApi* | [**unlock_api_key**](docs/APIKeysApi.md#unlock_api_key) | **DELETE** /v1/apikeys/{id}/lock | Unlock the API key
|
|
397
|
+
*IbmCloudIam::APIKeysApi* | [**update_api_key**](docs/APIKeysApi.md#update_api_key) | **PUT** /v1/apikeys/{id} | Updates an API key
|
|
398
|
+
*IbmCloudIam::AccountLimitsApi* | [**bulk_list_account_entity_consumption**](docs/AccountLimitsApi.md#bulk_list_account_entity_consumption) | **POST** /v1/accounts/{account_id}/limits/identity | Get account entity limits via POST request
|
|
399
|
+
*IbmCloudIam::AccountLimitsApi* | [**get_account_limits**](docs/AccountLimitsApi.md#get_account_limits) | **GET** /v1/accounts/{account_id}/limits/identity | Get account entity limits
|
|
400
|
+
*IbmCloudIam::AccountSettingsApi* | [**get_account_settings**](docs/AccountSettingsApi.md#get_account_settings) | **GET** /v1/accounts/{account_id}/settings/identity | Get account configurations
|
|
401
|
+
*IbmCloudIam::AccountSettingsApi* | [**get_effective_account_settings**](docs/AccountSettingsApi.md#get_effective_account_settings) | **GET** /v1/accounts/{account_id}/effective_settings/identity | Get effective account settings configuration
|
|
402
|
+
*IbmCloudIam::AccountSettingsApi* | [**update_account_settings**](docs/AccountSettingsApi.md#update_account_settings) | **PUT** /v1/accounts/{account_id}/settings/identity | Update account configurations
|
|
403
|
+
*IbmCloudIam::AccountSettingsForIdPApi* | [**add_id_p_setting**](docs/AccountSettingsForIdPApi.md#add_id_p_setting) | **POST** /v2/loginsettings/{account_id}/idps/{idp_id} | Add IdP Setting
|
|
404
|
+
*IbmCloudIam::AccountSettingsForIdPApi* | [**get_id_p_setting**](docs/AccountSettingsForIdPApi.md#get_id_p_setting) | **GET** /v2/loginsettings/{account_id}/idps/{idp_id} | Get IdP setting
|
|
405
|
+
*IbmCloudIam::AccountSettingsForIdPApi* | [**get_login_settings**](docs/AccountSettingsForIdPApi.md#get_login_settings) | **GET** /v2/loginsettings/{account_id} | Get account login settings
|
|
406
|
+
*IbmCloudIam::AccountSettingsForIdPApi* | [**list_id_p_settings**](docs/AccountSettingsForIdPApi.md#list_id_p_settings) | **GET** /v2/loginsettings/{account_id}/idps | List IdP Settings
|
|
407
|
+
*IbmCloudIam::AccountSettingsForIdPApi* | [**remove_id_p_setting**](docs/AccountSettingsForIdPApi.md#remove_id_p_setting) | **DELETE** /v2/loginsettings/{account_id}/idps/{idp_id} | Remove IdP Setting
|
|
408
|
+
*IbmCloudIam::AccountSettingsForIdPApi* | [**update_id_p_setting**](docs/AccountSettingsForIdPApi.md#update_id_p_setting) | **PUT** /v2/loginsettings/{account_id}/idps/{idp_id} | Update IdP Setting
|
|
409
|
+
*IbmCloudIam::AccountSettingsForIdPApi* | [**update_login_settings**](docs/AccountSettingsForIdPApi.md#update_login_settings) | **PUT** /v2/loginsettings/{account_id} | Update account login settings
|
|
410
|
+
*IbmCloudIam::AccountSettingsTemplateApi* | [**commit_account_settings_template**](docs/AccountSettingsTemplateApi.md#commit_account_settings_template) | **POST** /v1/account_settings_templates/{template_id}/versions/{version}/commit | Commit a template version
|
|
411
|
+
*IbmCloudIam::AccountSettingsTemplateApi* | [**create_account_settings_template**](docs/AccountSettingsTemplateApi.md#create_account_settings_template) | **POST** /v1/account_settings_templates | Create an account settings template
|
|
412
|
+
*IbmCloudIam::AccountSettingsTemplateApi* | [**create_account_settings_template_version**](docs/AccountSettingsTemplateApi.md#create_account_settings_template_version) | **POST** /v1/account_settings_templates/{template_id}/versions | Create a new version of an account settings template
|
|
413
|
+
*IbmCloudIam::AccountSettingsTemplateApi* | [**delete_account_settings_template_version**](docs/AccountSettingsTemplateApi.md#delete_account_settings_template_version) | **DELETE** /v1/account_settings_templates/{template_id}/versions/{version} | Delete version of an account settings template
|
|
414
|
+
*IbmCloudIam::AccountSettingsTemplateApi* | [**delete_all_versions_of_account_settings_template**](docs/AccountSettingsTemplateApi.md#delete_all_versions_of_account_settings_template) | **DELETE** /v1/account_settings_templates/{template_id} | Delete all versions of an account settings template
|
|
415
|
+
*IbmCloudIam::AccountSettingsTemplateApi* | [**get_account_settings_template_version**](docs/AccountSettingsTemplateApi.md#get_account_settings_template_version) | **GET** /v1/account_settings_templates/{template_id}/versions/{version} | Get version of an account settings template
|
|
416
|
+
*IbmCloudIam::AccountSettingsTemplateApi* | [**get_latest_account_settings_template_version**](docs/AccountSettingsTemplateApi.md#get_latest_account_settings_template_version) | **GET** /v1/account_settings_templates/{template_id} | Get latest version of an account settings template
|
|
417
|
+
*IbmCloudIam::AccountSettingsTemplateApi* | [**list_account_settings_templates**](docs/AccountSettingsTemplateApi.md#list_account_settings_templates) | **GET** /v1/account_settings_templates | List account settings templates
|
|
418
|
+
*IbmCloudIam::AccountSettingsTemplateApi* | [**list_versions_of_account_settings_template**](docs/AccountSettingsTemplateApi.md#list_versions_of_account_settings_template) | **GET** /v1/account_settings_templates/{template_id}/versions | List account settings template versions
|
|
419
|
+
*IbmCloudIam::AccountSettingsTemplateApi* | [**update_account_settings_template_version**](docs/AccountSettingsTemplateApi.md#update_account_settings_template_version) | **PUT** /v1/account_settings_templates/{template_id}/versions/{version} | Update version of an account settings template
|
|
420
|
+
*IbmCloudIam::AccountSettingsTemplateAssignmentsApi* | [**create_account_settings_assignment**](docs/AccountSettingsTemplateAssignmentsApi.md#create_account_settings_assignment) | **POST** /v1/account_settings_assignments/ | Create assignment
|
|
421
|
+
*IbmCloudIam::AccountSettingsTemplateAssignmentsApi* | [**delete_account_settings_assignment**](docs/AccountSettingsTemplateAssignmentsApi.md#delete_account_settings_assignment) | **DELETE** /v1/account_settings_assignments/{assignment_id} | Delete assignment
|
|
422
|
+
*IbmCloudIam::AccountSettingsTemplateAssignmentsApi* | [**get_account_settings_assignment**](docs/AccountSettingsTemplateAssignmentsApi.md#get_account_settings_assignment) | **GET** /v1/account_settings_assignments/{assignment_id} | Get assignment
|
|
423
|
+
*IbmCloudIam::AccountSettingsTemplateAssignmentsApi* | [**list_account_settings_assignments**](docs/AccountSettingsTemplateAssignmentsApi.md#list_account_settings_assignments) | **GET** /v1/account_settings_assignments/ | List assignments
|
|
424
|
+
*IbmCloudIam::AccountSettingsTemplateAssignmentsApi* | [**update_account_settings_assignment**](docs/AccountSettingsTemplateAssignmentsApi.md#update_account_settings_assignment) | **PATCH** /v1/account_settings_assignments/{assignment_id} | Update assignment
|
|
425
|
+
*IbmCloudIam::ActivitiesApi* | [**create_report**](docs/ActivitiesApi.md#create_report) | **POST** /v1/activity/accounts/{account_id}/report | Trigger activity report for the account
|
|
426
|
+
*IbmCloudIam::ActivitiesApi* | [**get_report**](docs/ActivitiesApi.md#get_report) | **GET** /v1/activity/accounts/{account_id}/report/{reference} | Get activity report for the account
|
|
427
|
+
*IbmCloudIam::IDPManagementApi* | [**create_idp**](docs/IDPManagementApi.md#create_idp) | **POST** /v1/idps/ | Create IdP
|
|
428
|
+
*IbmCloudIam::IDPManagementApi* | [**delete_idp**](docs/IDPManagementApi.md#delete_idp) | **DELETE** /v1/idps/{idp_id} | Delete IdP
|
|
429
|
+
*IbmCloudIam::IDPManagementApi* | [**export_saml_metadata**](docs/IDPManagementApi.md#export_saml_metadata) | **GET** /v1/idps/{idp_id}/saml/metadata | Export SAML IdP metadata
|
|
430
|
+
*IbmCloudIam::IDPManagementApi* | [**get_idp**](docs/IDPManagementApi.md#get_idp) | **GET** /v1/idps/{idp_id} | Get IdP
|
|
431
|
+
*IbmCloudIam::IDPManagementApi* | [**get_idp_test_result**](docs/IDPManagementApi.md#get_idp_test_result) | **GET** /v1/idps/{idp_id}/test | Get IdP test results
|
|
432
|
+
*IbmCloudIam::IDPManagementApi* | [**import_saml_idp_metadata**](docs/IDPManagementApi.md#import_saml_idp_metadata) | **PUT** /v1/idps/{idp_id}/saml/metadata | Import SAML IdP metadata
|
|
433
|
+
*IbmCloudIam::IDPManagementApi* | [**list_consumer_accounts**](docs/IDPManagementApi.md#list_consumer_accounts) | **GET** /v1/idps/{idp_id}/consumers | Get consumers of IdP
|
|
434
|
+
*IbmCloudIam::IDPManagementApi* | [**list_idps**](docs/IDPManagementApi.md#list_idps) | **GET** /v1/idps/ | List IdPs
|
|
435
|
+
*IbmCloudIam::IDPManagementApi* | [**test_idp**](docs/IDPManagementApi.md#test_idp) | **POST** /v1/idps/{idp_id}/test | Trigger IdP configuration test
|
|
436
|
+
*IbmCloudIam::IDPManagementApi* | [**update_idp**](docs/IDPManagementApi.md#update_idp) | **PUT** /v1/idps/{idp_id} | Update IdP
|
|
437
|
+
*IbmCloudIam::IdentityPreferencesApi* | [**delete_preferences_on_scope_account**](docs/IdentityPreferencesApi.md#delete_preferences_on_scope_account) | **DELETE** /v1/preferences/accounts/{account_id}/identities/{iam_id}/{service}/{preference_id} | Delete Identity Preference on scope account
|
|
438
|
+
*IbmCloudIam::IdentityPreferencesApi* | [**get_all_preferences_on_scope_account**](docs/IdentityPreferencesApi.md#get_all_preferences_on_scope_account) | **GET** /v1/preferences/accounts/{account_id}/identities/{iam_id} | Get all Identity Preferences on scope account
|
|
439
|
+
*IbmCloudIam::IdentityPreferencesApi* | [**get_preferences_on_scope_account**](docs/IdentityPreferencesApi.md#get_preferences_on_scope_account) | **GET** /v1/preferences/accounts/{account_id}/identities/{iam_id}/{service}/{preference_id} | Get Identity Preference on scope account
|
|
440
|
+
*IbmCloudIam::IdentityPreferencesApi* | [**update_preference_on_scope_account**](docs/IdentityPreferencesApi.md#update_preference_on_scope_account) | **PUT** /v1/preferences/accounts/{account_id}/identities/{iam_id}/{service}/{preference_id} | Update Identity Preference on scope account
|
|
441
|
+
*IbmCloudIam::MFAEnrollmentStatusApi* | [**create_mfa_report**](docs/MFAEnrollmentStatusApi.md#create_mfa_report) | **POST** /v1/mfa/accounts/{account_id}/report | Trigger MFA enrollment status report for the account
|
|
442
|
+
*IbmCloudIam::MFAEnrollmentStatusApi* | [**get_mfa_report**](docs/MFAEnrollmentStatusApi.md#get_mfa_report) | **GET** /v1/mfa/accounts/{account_id}/report/{reference} | Get MFA enrollment status report for the account
|
|
443
|
+
*IbmCloudIam::MFAEnrollmentStatusApi* | [**get_mfa_status**](docs/MFAEnrollmentStatusApi.md#get_mfa_status) | **GET** /v1/mfa/accounts/{account_id}/status | Get MFA enrollment status for a single user in the account.
|
|
444
|
+
*IbmCloudIam::ServiceIDGroupsApi* | [**create_service_id_group**](docs/ServiceIDGroupsApi.md#create_service_id_group) | **POST** /v1/serviceid_groups | Create a service ID group
|
|
445
|
+
*IbmCloudIam::ServiceIDGroupsApi* | [**delete_service_id_group**](docs/ServiceIDGroupsApi.md#delete_service_id_group) | **DELETE** /v1/serviceid_groups/{id} | Delete a service ID group
|
|
446
|
+
*IbmCloudIam::ServiceIDGroupsApi* | [**get_service_id_group**](docs/ServiceIDGroupsApi.md#get_service_id_group) | **GET** /v1/serviceid_groups/{id} | Get details of a service ID group
|
|
447
|
+
*IbmCloudIam::ServiceIDGroupsApi* | [**list_service_id_group**](docs/ServiceIDGroupsApi.md#list_service_id_group) | **GET** /v1/serviceid_groups | List service ID groups
|
|
448
|
+
*IbmCloudIam::ServiceIDGroupsApi* | [**update_service_id_group**](docs/ServiceIDGroupsApi.md#update_service_id_group) | **PUT** /v1/serviceid_groups/{id} | Update a service ID group
|
|
449
|
+
*IbmCloudIam::ServiceIDsApi* | [**create_service_id**](docs/ServiceIDsApi.md#create_service_id) | **POST** /v1/serviceids/ | Create a service ID
|
|
450
|
+
*IbmCloudIam::ServiceIDsApi* | [**delete_service_id**](docs/ServiceIDsApi.md#delete_service_id) | **DELETE** /v1/serviceids/{id} | Deletes a service ID and associated API keys
|
|
451
|
+
*IbmCloudIam::ServiceIDsApi* | [**get_service_id**](docs/ServiceIDsApi.md#get_service_id) | **GET** /v1/serviceids/{id} | Get details of a service ID
|
|
452
|
+
*IbmCloudIam::ServiceIDsApi* | [**list_service_ids**](docs/ServiceIDsApi.md#list_service_ids) | **GET** /v1/serviceids/ | List service IDs
|
|
453
|
+
*IbmCloudIam::ServiceIDsApi* | [**lock_service_id**](docs/ServiceIDsApi.md#lock_service_id) | **POST** /v1/serviceids/{id}/lock | Lock the service ID
|
|
454
|
+
*IbmCloudIam::ServiceIDsApi* | [**unlock_service_id**](docs/ServiceIDsApi.md#unlock_service_id) | **DELETE** /v1/serviceids/{id}/lock | Unlock the service ID
|
|
455
|
+
*IbmCloudIam::ServiceIDsApi* | [**update_service_id**](docs/ServiceIDsApi.md#update_service_id) | **PUT** /v1/serviceids/{id} | Update service ID
|
|
456
|
+
*IbmCloudIam::TokenRetrievalApi* | [**get_token_api_key**](docs/TokenRetrievalApi.md#get_token_api_key) | **POST** /identity/token#apikey | Create an IAM access token for a user or service ID using an API key
|
|
457
|
+
*IbmCloudIam::TokenRetrievalApi* | [**get_token_api_key_delegated_refresh_token**](docs/TokenRetrievalApi.md#get_token_api_key_delegated_refresh_token) | **POST** /identity/token#apikey-delegated-refresh-token | Create an IAM access token and delegated refresh token for a user or service ID
|
|
458
|
+
*IbmCloudIam::TokenRetrievalApi* | [**get_token_assume**](docs/TokenRetrievalApi.md#get_token_assume) | **POST** /identity/token#assume | Create an IAM access token for a Trusted Profile based on the provided entity. Provided entity can be a identity based token which can be a user token, service id token or a cookie.
|
|
459
|
+
*IbmCloudIam::TokenRetrievalApi* | [**get_token_cr_token**](docs/TokenRetrievalApi.md#get_token_cr_token) | **POST** /identity/token#cr-token | Create an IAM access token for a Trusted Profile based on the provided Compute Resource token
|
|
460
|
+
*IbmCloudIam::TokenRetrievalApi* | [**get_token_iam_authz**](docs/TokenRetrievalApi.md#get_token_iam_authz) | **POST** /identity/token#iam-authz | Create an IAM access token based on an authorization policy
|
|
461
|
+
*IbmCloudIam::TokenRetrievalApi* | [**get_token_password**](docs/TokenRetrievalApi.md#get_token_password) | **POST** /identity/token#password | Create an IAM access token for a user using username / password credentials and an optional account identifier
|
|
462
|
+
*IbmCloudIam::TrustedProfileTemplateApi* | [**commit_profile_template**](docs/TrustedProfileTemplateApi.md#commit_profile_template) | **POST** /v1/profile_templates/{template_id}/versions/{version}/commit | Commit a template version
|
|
463
|
+
*IbmCloudIam::TrustedProfileTemplateApi* | [**create_profile_template**](docs/TrustedProfileTemplateApi.md#create_profile_template) | **POST** /v1/profile_templates | Create a trusted profile template
|
|
464
|
+
*IbmCloudIam::TrustedProfileTemplateApi* | [**create_profile_template_version**](docs/TrustedProfileTemplateApi.md#create_profile_template_version) | **POST** /v1/profile_templates/{template_id}/versions | Create new version of a trusted profile template
|
|
465
|
+
*IbmCloudIam::TrustedProfileTemplateApi* | [**delete_all_versions_of_profile_template**](docs/TrustedProfileTemplateApi.md#delete_all_versions_of_profile_template) | **DELETE** /v1/profile_templates/{template_id} | Delete all versions of a trusted profile template
|
|
466
|
+
*IbmCloudIam::TrustedProfileTemplateApi* | [**delete_profile_template_version**](docs/TrustedProfileTemplateApi.md#delete_profile_template_version) | **DELETE** /v1/profile_templates/{template_id}/versions/{version} | Delete version of trusted profile template
|
|
467
|
+
*IbmCloudIam::TrustedProfileTemplateApi* | [**get_latest_profile_template_version**](docs/TrustedProfileTemplateApi.md#get_latest_profile_template_version) | **GET** /v1/profile_templates/{template_id} | Get latest version of a trusted profile template
|
|
468
|
+
*IbmCloudIam::TrustedProfileTemplateApi* | [**get_profile_template_version**](docs/TrustedProfileTemplateApi.md#get_profile_template_version) | **GET** /v1/profile_templates/{template_id}/versions/{version} | Get version of trusted profile template
|
|
469
|
+
*IbmCloudIam::TrustedProfileTemplateApi* | [**list_profile_templates**](docs/TrustedProfileTemplateApi.md#list_profile_templates) | **GET** /v1/profile_templates | List trusted profile templates
|
|
470
|
+
*IbmCloudIam::TrustedProfileTemplateApi* | [**list_versions_of_profile_template**](docs/TrustedProfileTemplateApi.md#list_versions_of_profile_template) | **GET** /v1/profile_templates/{template_id}/versions | List trusted profile template versions
|
|
471
|
+
*IbmCloudIam::TrustedProfileTemplateApi* | [**update_profile_template_version**](docs/TrustedProfileTemplateApi.md#update_profile_template_version) | **PUT** /v1/profile_templates/{template_id}/versions/{version} | Update version of trusted profile template
|
|
472
|
+
*IbmCloudIam::TrustedProfileTemplateAssignmentsApi* | [**create_trusted_profile_assignment**](docs/TrustedProfileTemplateAssignmentsApi.md#create_trusted_profile_assignment) | **POST** /v1/profile_assignments/ | Create assignment
|
|
473
|
+
*IbmCloudIam::TrustedProfileTemplateAssignmentsApi* | [**delete_trusted_profile_assignment**](docs/TrustedProfileTemplateAssignmentsApi.md#delete_trusted_profile_assignment) | **DELETE** /v1/profile_assignments/{assignment_id} | Delete assignment
|
|
474
|
+
*IbmCloudIam::TrustedProfileTemplateAssignmentsApi* | [**get_trusted_profile_assignment**](docs/TrustedProfileTemplateAssignmentsApi.md#get_trusted_profile_assignment) | **GET** /v1/profile_assignments/{assignment_id} | Get assignment
|
|
475
|
+
*IbmCloudIam::TrustedProfileTemplateAssignmentsApi* | [**list_trusted_profile_assignments**](docs/TrustedProfileTemplateAssignmentsApi.md#list_trusted_profile_assignments) | **GET** /v1/profile_assignments/ | List assignments
|
|
476
|
+
*IbmCloudIam::TrustedProfileTemplateAssignmentsApi* | [**update_trusted_profile_assignment**](docs/TrustedProfileTemplateAssignmentsApi.md#update_trusted_profile_assignment) | **PATCH** /v1/profile_assignments/{assignment_id} | Update assignment
|
|
477
|
+
*IbmCloudIam::TrustedProfilesApi* | [**create_claim_rule**](docs/TrustedProfilesApi.md#create_claim_rule) | **POST** /v1/profiles/{profile-id}/rules | Create claim rule for a trusted profile
|
|
478
|
+
*IbmCloudIam::TrustedProfilesApi* | [**create_link**](docs/TrustedProfilesApi.md#create_link) | **POST** /v1/profiles/{profile-id}/links | Create link to a trusted profile
|
|
479
|
+
*IbmCloudIam::TrustedProfilesApi* | [**create_profile**](docs/TrustedProfilesApi.md#create_profile) | **POST** /v1/profiles | Create a trusted profile
|
|
480
|
+
*IbmCloudIam::TrustedProfilesApi* | [**delete_claim_rule**](docs/TrustedProfilesApi.md#delete_claim_rule) | **DELETE** /v1/profiles/{profile-id}/rules/{rule-id} | Delete a claim rule
|
|
481
|
+
*IbmCloudIam::TrustedProfilesApi* | [**delete_link**](docs/TrustedProfilesApi.md#delete_link) | **DELETE** /v1/profiles/{profile-id}/links/{link-id} | Delete link to a trusted profile
|
|
482
|
+
*IbmCloudIam::TrustedProfilesApi* | [**delete_link_by_parameters**](docs/TrustedProfilesApi.md#delete_link_by_parameters) | **DELETE** /v1/profiles/{profile-id}/links | Delete compute resource link to profile by given parameters.
|
|
483
|
+
*IbmCloudIam::TrustedProfilesApi* | [**delete_profile**](docs/TrustedProfilesApi.md#delete_profile) | **DELETE** /v1/profiles/{profile-id} | Delete a trusted profile
|
|
484
|
+
*IbmCloudIam::TrustedProfilesApi* | [**delete_profile_identity**](docs/TrustedProfilesApi.md#delete_profile_identity) | **DELETE** /v1/profiles/{profile-id}/identities/{identity-type}/{identifier-id} | Delete the identity that can assume the trusted profile
|
|
485
|
+
*IbmCloudIam::TrustedProfilesApi* | [**get_claim_rule**](docs/TrustedProfilesApi.md#get_claim_rule) | **GET** /v1/profiles/{profile-id}/rules/{rule-id} | Get a claim rule for a trusted profile
|
|
486
|
+
*IbmCloudIam::TrustedProfilesApi* | [**get_link**](docs/TrustedProfilesApi.md#get_link) | **GET** /v1/profiles/{profile-id}/links/{link-id} | Get link to a trusted profile
|
|
487
|
+
*IbmCloudIam::TrustedProfilesApi* | [**get_profile**](docs/TrustedProfilesApi.md#get_profile) | **GET** /v1/profiles/{profile-id} | Get a trusted profile
|
|
488
|
+
*IbmCloudIam::TrustedProfilesApi* | [**get_profile_identities**](docs/TrustedProfilesApi.md#get_profile_identities) | **GET** /v1/profiles/{profile-id}/identities | Get a list of identities that can assume the trusted profile
|
|
489
|
+
*IbmCloudIam::TrustedProfilesApi* | [**get_profile_identity**](docs/TrustedProfilesApi.md#get_profile_identity) | **GET** /v1/profiles/{profile-id}/identities/{identity-type}/{identifier-id} | Get the identity that can assume the trusted profile
|
|
490
|
+
*IbmCloudIam::TrustedProfilesApi* | [**list_claim_rules**](docs/TrustedProfilesApi.md#list_claim_rules) | **GET** /v1/profiles/{profile-id}/rules | List claim rules for a trusted profile
|
|
491
|
+
*IbmCloudIam::TrustedProfilesApi* | [**list_links**](docs/TrustedProfilesApi.md#list_links) | **GET** /v1/profiles/{profile-id}/links | List links to a trusted profile
|
|
492
|
+
*IbmCloudIam::TrustedProfilesApi* | [**list_profiles**](docs/TrustedProfilesApi.md#list_profiles) | **GET** /v1/profiles | List trusted profiles
|
|
493
|
+
*IbmCloudIam::TrustedProfilesApi* | [**set_profile_identities**](docs/TrustedProfilesApi.md#set_profile_identities) | **PUT** /v1/profiles/{profile-id}/identities | Update the list of identities that can assume the trusted profile
|
|
494
|
+
*IbmCloudIam::TrustedProfilesApi* | [**set_profile_identity**](docs/TrustedProfilesApi.md#set_profile_identity) | **POST** /v1/profiles/{profile-id}/identities/{identity-type} | Add a specific identity that can assume the trusted profile
|
|
495
|
+
*IbmCloudIam::TrustedProfilesApi* | [**update_claim_rule**](docs/TrustedProfilesApi.md#update_claim_rule) | **PUT** /v1/profiles/{profile-id}/rules/{rule-id} | Update claim rule for a trusted profile
|
|
496
|
+
*IbmCloudIam::TrustedProfilesApi* | [**update_profile**](docs/TrustedProfilesApi.md#update_profile) | **PUT** /v1/profiles/{profile-id} | Update a trusted profile
|
|
101
497
|
|
|
102
498
|
|
|
103
499
|
## Documentation for Models
|
|
104
500
|
|
|
501
|
+
- [IbmCloudIam::AccessGroupCount](docs/AccessGroupCount.md)
|
|
502
|
+
- [IbmCloudIam::AccountBasedMfaEnrollment](docs/AccountBasedMfaEnrollment.md)
|
|
503
|
+
- [IbmCloudIam::AccountIdpSettings](docs/AccountIdpSettings.md)
|
|
504
|
+
- [IbmCloudIam::AccountLoginSettings](docs/AccountLoginSettings.md)
|
|
505
|
+
- [IbmCloudIam::AccountSettingsAssignedTemplatesSection](docs/AccountSettingsAssignedTemplatesSection.md)
|
|
506
|
+
- [IbmCloudIam::AccountSettingsEffectiveSection](docs/AccountSettingsEffectiveSection.md)
|
|
507
|
+
- [IbmCloudIam::AccountSettingsMeta](docs/AccountSettingsMeta.md)
|
|
508
|
+
- [IbmCloudIam::AccountSettingsRequest](docs/AccountSettingsRequest.md)
|
|
509
|
+
- [IbmCloudIam::AccountSettingsResponse](docs/AccountSettingsResponse.md)
|
|
510
|
+
- [IbmCloudIam::AccountSettingsTemplateList](docs/AccountSettingsTemplateList.md)
|
|
511
|
+
- [IbmCloudIam::AccountSettingsTemplateRequest](docs/AccountSettingsTemplateRequest.md)
|
|
512
|
+
- [IbmCloudIam::AccountSettingsTemplateResponse](docs/AccountSettingsTemplateResponse.md)
|
|
513
|
+
- [IbmCloudIam::AccountSettingsUserDomainRestriction](docs/AccountSettingsUserDomainRestriction.md)
|
|
514
|
+
- [IbmCloudIam::AccountSettingsUserMFAResponse](docs/AccountSettingsUserMFAResponse.md)
|
|
515
|
+
- [IbmCloudIam::ActionControls](docs/ActionControls.md)
|
|
516
|
+
- [IbmCloudIam::ActionControlsIdentities](docs/ActionControlsIdentities.md)
|
|
517
|
+
- [IbmCloudIam::Activity](docs/Activity.md)
|
|
518
|
+
- [IbmCloudIam::AddAccountIdpSettingRequest](docs/AddAccountIdpSettingRequest.md)
|
|
105
519
|
- [IbmCloudIam::ApiKey](docs/ApiKey.md)
|
|
106
520
|
- [IbmCloudIam::ApiKeyInsideCreateServiceIdRequest](docs/ApiKeyInsideCreateServiceIdRequest.md)
|
|
107
521
|
- [IbmCloudIam::ApiKeyList](docs/ApiKeyList.md)
|
|
522
|
+
- [IbmCloudIam::ApikeyActivity](docs/ApikeyActivity.md)
|
|
523
|
+
- [IbmCloudIam::ApikeyActivityServiceid](docs/ApikeyActivityServiceid.md)
|
|
524
|
+
- [IbmCloudIam::ApikeyActivityUser](docs/ApikeyActivityUser.md)
|
|
525
|
+
- [IbmCloudIam::AssignedTemplatesAccountSettings](docs/AssignedTemplatesAccountSettings.md)
|
|
526
|
+
- [IbmCloudIam::CommonAccountSettingsRequest](docs/CommonAccountSettingsRequest.md)
|
|
527
|
+
- [IbmCloudIam::CommonAccountSettingsResponse](docs/CommonAccountSettingsResponse.md)
|
|
528
|
+
- [IbmCloudIam::ConsumersResponse](docs/ConsumersResponse.md)
|
|
529
|
+
- [IbmCloudIam::ConsumersResponseConsumersInner](docs/ConsumersResponseConsumersInner.md)
|
|
108
530
|
- [IbmCloudIam::CreateApiKeyRequest](docs/CreateApiKeyRequest.md)
|
|
531
|
+
- [IbmCloudIam::CreateIdpRequest](docs/CreateIdpRequest.md)
|
|
532
|
+
- [IbmCloudIam::CreateIdpRequestProperties](docs/CreateIdpRequestProperties.md)
|
|
533
|
+
- [IbmCloudIam::CreateIdpRequestPropertiesIdp](docs/CreateIdpRequestPropertiesIdp.md)
|
|
534
|
+
- [IbmCloudIam::CreateIdpRequestPropertiesSp](docs/CreateIdpRequestPropertiesSp.md)
|
|
535
|
+
- [IbmCloudIam::CreateIdpRequestPropertiesSpAuthnContext](docs/CreateIdpRequestPropertiesSpAuthnContext.md)
|
|
536
|
+
- [IbmCloudIam::CreateIdpRequestSecrets](docs/CreateIdpRequestSecrets.md)
|
|
537
|
+
- [IbmCloudIam::CreateIdpRequestSecretsIdp](docs/CreateIdpRequestSecretsIdp.md)
|
|
538
|
+
- [IbmCloudIam::CreateIdpRequestSecretsIdpSigningInner](docs/CreateIdpRequestSecretsIdpSigningInner.md)
|
|
539
|
+
- [IbmCloudIam::CreateIdpRequestSecretsSp](docs/CreateIdpRequestSecretsSp.md)
|
|
540
|
+
- [IbmCloudIam::CreateIdpRequestSecretsSpSigningInner](docs/CreateIdpRequestSecretsSpSigningInner.md)
|
|
541
|
+
- [IbmCloudIam::CreateProfileLinkRequest](docs/CreateProfileLinkRequest.md)
|
|
542
|
+
- [IbmCloudIam::CreateProfileLinkRequestLink](docs/CreateProfileLinkRequestLink.md)
|
|
543
|
+
- [IbmCloudIam::CreateServiceIdGroupRequest](docs/CreateServiceIdGroupRequest.md)
|
|
109
544
|
- [IbmCloudIam::CreateServiceIdRequest](docs/CreateServiceIdRequest.md)
|
|
545
|
+
- [IbmCloudIam::CreateTemplateAssignmentRequest](docs/CreateTemplateAssignmentRequest.md)
|
|
546
|
+
- [IbmCloudIam::CreateTrustedProfileRequest](docs/CreateTrustedProfileRequest.md)
|
|
547
|
+
- [IbmCloudIam::EffectiveAccountSettingsResponse](docs/EffectiveAccountSettingsResponse.md)
|
|
110
548
|
- [IbmCloudIam::EnityHistoryRecord](docs/EnityHistoryRecord.md)
|
|
549
|
+
- [IbmCloudIam::EntityActivity](docs/EntityActivity.md)
|
|
111
550
|
- [IbmCloudIam::Error](docs/Error.md)
|
|
112
551
|
- [IbmCloudIam::ExceptionResponse](docs/ExceptionResponse.md)
|
|
113
552
|
- [IbmCloudIam::ExceptionResponseContext](docs/ExceptionResponseContext.md)
|
|
114
|
-
- [IbmCloudIam::
|
|
115
|
-
- [IbmCloudIam::
|
|
116
|
-
- [IbmCloudIam::
|
|
117
|
-
- [IbmCloudIam::
|
|
553
|
+
- [IbmCloudIam::IdBasedMfaEnrollment](docs/IdBasedMfaEnrollment.md)
|
|
554
|
+
- [IbmCloudIam::IdentityCount](docs/IdentityCount.md)
|
|
555
|
+
- [IbmCloudIam::IdentityLimitsUsageRequest](docs/IdentityLimitsUsageRequest.md)
|
|
556
|
+
- [IbmCloudIam::IdentityLimitsUsageResponse](docs/IdentityLimitsUsageResponse.md)
|
|
557
|
+
- [IbmCloudIam::IdentityLimitsUsageResponseApikeysPerIdentity](docs/IdentityLimitsUsageResponseApikeysPerIdentity.md)
|
|
558
|
+
- [IbmCloudIam::IdentityLimitsUsageResponseClaimRulesPerGroup](docs/IdentityLimitsUsageResponseClaimRulesPerGroup.md)
|
|
559
|
+
- [IbmCloudIam::IdentityLimitsUsageResponseClaimRulesPerProfile](docs/IdentityLimitsUsageResponseClaimRulesPerProfile.md)
|
|
560
|
+
- [IbmCloudIam::IdentityLimitsUsageResponseServiceidsPerGroup](docs/IdentityLimitsUsageResponseServiceidsPerGroup.md)
|
|
561
|
+
- [IbmCloudIam::IdentityLimitsUsageResponseTemplateVersionsPerTemplate](docs/IdentityLimitsUsageResponseTemplateVersionsPerTemplate.md)
|
|
562
|
+
- [IbmCloudIam::IdentityPreferenceResponse](docs/IdentityPreferenceResponse.md)
|
|
563
|
+
- [IbmCloudIam::IdentityPreferencesResponse](docs/IdentityPreferencesResponse.md)
|
|
564
|
+
- [IbmCloudIam::Idp](docs/Idp.md)
|
|
565
|
+
- [IbmCloudIam::LimitCount](docs/LimitCount.md)
|
|
566
|
+
- [IbmCloudIam::ListIdPSettings200Response](docs/ListIdPSettings200Response.md)
|
|
567
|
+
- [IbmCloudIam::ListIdps200Response](docs/ListIdps200Response.md)
|
|
118
568
|
- [IbmCloudIam::MFARequirementsResponse](docs/MFARequirementsResponse.md)
|
|
569
|
+
- [IbmCloudIam::MfaEnrollmentTypeStatus](docs/MfaEnrollmentTypeStatus.md)
|
|
570
|
+
- [IbmCloudIam::MfaOptions](docs/MfaOptions.md)
|
|
119
571
|
- [IbmCloudIam::OidcExceptionResponse](docs/OidcExceptionResponse.md)
|
|
572
|
+
- [IbmCloudIam::PolicyTemplateReference](docs/PolicyTemplateReference.md)
|
|
573
|
+
- [IbmCloudIam::ProfileClaimRule](docs/ProfileClaimRule.md)
|
|
574
|
+
- [IbmCloudIam::ProfileClaimRuleConditions](docs/ProfileClaimRuleConditions.md)
|
|
575
|
+
- [IbmCloudIam::ProfileClaimRuleList](docs/ProfileClaimRuleList.md)
|
|
576
|
+
- [IbmCloudIam::ProfileClaimRuleRequest](docs/ProfileClaimRuleRequest.md)
|
|
577
|
+
- [IbmCloudIam::ProfileCount](docs/ProfileCount.md)
|
|
578
|
+
- [IbmCloudIam::ProfileIdentitiesResponse](docs/ProfileIdentitiesResponse.md)
|
|
579
|
+
- [IbmCloudIam::ProfileIdentitiesUpdateRequest](docs/ProfileIdentitiesUpdateRequest.md)
|
|
580
|
+
- [IbmCloudIam::ProfileIdentityRequest](docs/ProfileIdentityRequest.md)
|
|
581
|
+
- [IbmCloudIam::ProfileIdentityResponse](docs/ProfileIdentityResponse.md)
|
|
582
|
+
- [IbmCloudIam::ProfileLink](docs/ProfileLink.md)
|
|
583
|
+
- [IbmCloudIam::ProfileLinkLink](docs/ProfileLinkLink.md)
|
|
584
|
+
- [IbmCloudIam::ProfileLinkList](docs/ProfileLinkList.md)
|
|
585
|
+
- [IbmCloudIam::Report](docs/Report.md)
|
|
586
|
+
- [IbmCloudIam::ReportMfaEnrollmentStatus](docs/ReportMfaEnrollmentStatus.md)
|
|
587
|
+
- [IbmCloudIam::ReportReference](docs/ReportReference.md)
|
|
120
588
|
- [IbmCloudIam::ResponseContext](docs/ResponseContext.md)
|
|
589
|
+
- [IbmCloudIam::RetrictActions](docs/RetrictActions.md)
|
|
590
|
+
- [IbmCloudIam::SamlMetadataImportResponse](docs/SamlMetadataImportResponse.md)
|
|
121
591
|
- [IbmCloudIam::ServiceId](docs/ServiceId.md)
|
|
592
|
+
- [IbmCloudIam::ServiceIdGroup](docs/ServiceIdGroup.md)
|
|
593
|
+
- [IbmCloudIam::ServiceIdGroupCount](docs/ServiceIdGroupCount.md)
|
|
594
|
+
- [IbmCloudIam::ServiceIdGroupList](docs/ServiceIdGroupList.md)
|
|
122
595
|
- [IbmCloudIam::ServiceIdList](docs/ServiceIdList.md)
|
|
596
|
+
- [IbmCloudIam::ShareScope](docs/ShareScope.md)
|
|
597
|
+
- [IbmCloudIam::TemplateAccountSettings](docs/TemplateAccountSettings.md)
|
|
598
|
+
- [IbmCloudIam::TemplateAccountSettingsAllOfRestrictUserDomains](docs/TemplateAccountSettingsAllOfRestrictUserDomains.md)
|
|
599
|
+
- [IbmCloudIam::TemplateAssignmentListResponse](docs/TemplateAssignmentListResponse.md)
|
|
600
|
+
- [IbmCloudIam::TemplateAssignmentResource](docs/TemplateAssignmentResource.md)
|
|
601
|
+
- [IbmCloudIam::TemplateAssignmentResourceError](docs/TemplateAssignmentResourceError.md)
|
|
602
|
+
- [IbmCloudIam::TemplateAssignmentResponse](docs/TemplateAssignmentResponse.md)
|
|
603
|
+
- [IbmCloudIam::TemplateAssignmentResponseResource](docs/TemplateAssignmentResponseResource.md)
|
|
604
|
+
- [IbmCloudIam::TemplateAssignmentResponseResourceDetail](docs/TemplateAssignmentResponseResourceDetail.md)
|
|
605
|
+
- [IbmCloudIam::TemplateCount](docs/TemplateCount.md)
|
|
606
|
+
- [IbmCloudIam::TemplateProfileComponentRequest](docs/TemplateProfileComponentRequest.md)
|
|
607
|
+
- [IbmCloudIam::TemplateProfileComponentResponse](docs/TemplateProfileComponentResponse.md)
|
|
608
|
+
- [IbmCloudIam::TestResult](docs/TestResult.md)
|
|
609
|
+
- [IbmCloudIam::TestResultStepsInner](docs/TestResultStepsInner.md)
|
|
610
|
+
- [IbmCloudIam::TestTriggerResponse](docs/TestTriggerResponse.md)
|
|
123
611
|
- [IbmCloudIam::TokenResponse](docs/TokenResponse.md)
|
|
612
|
+
- [IbmCloudIam::TrustedProfile](docs/TrustedProfile.md)
|
|
613
|
+
- [IbmCloudIam::TrustedProfileTemplateClaimRule](docs/TrustedProfileTemplateClaimRule.md)
|
|
614
|
+
- [IbmCloudIam::TrustedProfileTemplateList](docs/TrustedProfileTemplateList.md)
|
|
615
|
+
- [IbmCloudIam::TrustedProfileTemplateRequest](docs/TrustedProfileTemplateRequest.md)
|
|
616
|
+
- [IbmCloudIam::TrustedProfileTemplateResponse](docs/TrustedProfileTemplateResponse.md)
|
|
617
|
+
- [IbmCloudIam::TrustedProfilesList](docs/TrustedProfilesList.md)
|
|
618
|
+
- [IbmCloudIam::UpdateAccountIdpSettingRequest](docs/UpdateAccountIdpSettingRequest.md)
|
|
619
|
+
- [IbmCloudIam::UpdateAccountLoginSettings](docs/UpdateAccountLoginSettings.md)
|
|
124
620
|
- [IbmCloudIam::UpdateApiKeyRequest](docs/UpdateApiKeyRequest.md)
|
|
621
|
+
- [IbmCloudIam::UpdateIdPRequest](docs/UpdateIdPRequest.md)
|
|
622
|
+
- [IbmCloudIam::UpdateIdPRequestProperties](docs/UpdateIdPRequestProperties.md)
|
|
623
|
+
- [IbmCloudIam::UpdateIdPRequestPropertiesIdp](docs/UpdateIdPRequestPropertiesIdp.md)
|
|
624
|
+
- [IbmCloudIam::UpdateIdPRequestSecrets](docs/UpdateIdPRequestSecrets.md)
|
|
625
|
+
- [IbmCloudIam::UpdateIdPRequestSecretsIdp](docs/UpdateIdPRequestSecretsIdp.md)
|
|
626
|
+
- [IbmCloudIam::UpdatePreferenceRequest](docs/UpdatePreferenceRequest.md)
|
|
627
|
+
- [IbmCloudIam::UpdateServiceIdGroupRequest](docs/UpdateServiceIdGroupRequest.md)
|
|
125
628
|
- [IbmCloudIam::UpdateServiceIdRequest](docs/UpdateServiceIdRequest.md)
|
|
629
|
+
- [IbmCloudIam::UpdateTemplateAssignmentRequest](docs/UpdateTemplateAssignmentRequest.md)
|
|
630
|
+
- [IbmCloudIam::UpdateTrustedProfileRequest](docs/UpdateTrustedProfileRequest.md)
|
|
631
|
+
- [IbmCloudIam::UserActivity](docs/UserActivity.md)
|
|
632
|
+
- [IbmCloudIam::UserMFAResolved](docs/UserMFAResolved.md)
|
|
633
|
+
- [IbmCloudIam::UserMfa](docs/UserMfa.md)
|
|
634
|
+
- [IbmCloudIam::UserMfaEnrollments](docs/UserMfaEnrollments.md)
|
|
635
|
+
- [IbmCloudIam::UserReportMfaEnrollmentStatus](docs/UserReportMfaEnrollmentStatus.md)
|
|
636
|
+
- [IbmCloudIam::UserVisbilityRetrictActions](docs/UserVisbilityRetrictActions.md)
|
|
637
|
+
- [IbmCloudIam::UserVisbilityRetrictActionsForTemplate](docs/UserVisbilityRetrictActionsForTemplate.md)
|
|
126
638
|
|
|
127
639
|
|
|
128
640
|
## Documentation for Authorization
|
|
129
641
|
|
|
130
|
-
|
|
642
|
+
Endpoints do not require authorization.
|
|
131
643
|
|