ibm_cloud_iam 1.0.1 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (493) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE.txt +202 -0
  3. data/README.md +548 -36
  4. data/docs/APIKeysApi.md +714 -0
  5. data/docs/AccessGroupCount.md +20 -0
  6. data/docs/AccountBasedMfaEnrollment.md +24 -0
  7. data/docs/AccountIdpSettings.md +32 -0
  8. data/docs/AccountLimitsApi.md +173 -0
  9. data/docs/AccountLoginSettings.md +18 -0
  10. data/docs/AccountSettingsApi.md +224 -0
  11. data/docs/AccountSettingsAssignedTemplatesSection.md +46 -0
  12. data/docs/AccountSettingsEffectiveSection.md +38 -0
  13. data/docs/AccountSettingsForIdPApi.md +489 -0
  14. data/docs/AccountSettingsMeta.md +24 -0
  15. data/docs/AccountSettingsRequest.md +40 -0
  16. data/docs/AccountSettingsResponse.md +48 -0
  17. data/docs/AccountSettingsTemplateApi.md +720 -0
  18. data/docs/AccountSettingsTemplateAssignmentsApi.md +376 -0
  19. data/docs/AccountSettingsTemplateList.md +30 -0
  20. data/docs/AccountSettingsTemplateRequest.md +24 -0
  21. data/docs/AccountSettingsTemplateResponse.md +44 -0
  22. data/docs/AccountSettingsUserDomainRestriction.md +22 -0
  23. data/docs/AccountSettingsUserMFAResponse.md +28 -0
  24. data/docs/ActionControls.md +22 -0
  25. data/docs/ActionControlsIdentities.md +20 -0
  26. data/docs/ActivitiesApi.md +149 -0
  27. data/docs/Activity.md +20 -0
  28. data/docs/AddAccountIdpSettingRequest.md +22 -0
  29. data/docs/ApiKey.md +44 -33
  30. data/docs/ApiKeyInsideCreateServiceIdRequest.md +18 -13
  31. data/docs/ApiKeyList.md +20 -19
  32. data/docs/ApikeyActivity.md +28 -0
  33. data/docs/ApikeyActivityServiceid.md +20 -0
  34. data/docs/ApikeyActivityUser.md +24 -0
  35. data/docs/AssignedTemplatesAccountSettings.md +40 -0
  36. data/docs/CommonAccountSettingsRequest.md +36 -0
  37. data/docs/CommonAccountSettingsResponse.md +34 -0
  38. data/docs/ConsumersResponse.md +20 -0
  39. data/docs/ConsumersResponseConsumersInner.md +20 -0
  40. data/docs/CreateApiKeyRequest.md +24 -17
  41. data/docs/CreateIdpRequest.md +30 -0
  42. data/docs/CreateIdpRequestProperties.md +20 -0
  43. data/docs/CreateIdpRequestPropertiesIdp.md +26 -0
  44. data/docs/CreateIdpRequestPropertiesSp.md +32 -0
  45. data/docs/CreateIdpRequestPropertiesSpAuthnContext.md +20 -0
  46. data/docs/CreateIdpRequestSecrets.md +20 -0
  47. data/docs/CreateIdpRequestSecretsIdp.md +22 -0
  48. data/docs/CreateIdpRequestSecretsIdpSigningInner.md +20 -0
  49. data/docs/CreateIdpRequestSecretsSp.md +18 -0
  50. data/docs/CreateIdpRequestSecretsSpSigningInner.md +24 -0
  51. data/docs/CreateProfileLinkRequest.md +24 -0
  52. data/docs/CreateProfileLinkRequestLink.md +26 -0
  53. data/docs/CreateServiceIdGroupRequest.md +22 -0
  54. data/docs/CreateServiceIdRequest.md +18 -15
  55. data/docs/CreateTemplateAssignmentRequest.md +24 -0
  56. data/docs/CreateTrustedProfileRequest.md +24 -0
  57. data/docs/EffectiveAccountSettingsResponse.md +26 -0
  58. data/docs/EnityHistoryRecord.md +18 -17
  59. data/docs/EntityActivity.md +22 -0
  60. data/docs/Error.md +14 -13
  61. data/docs/ExceptionResponse.md +14 -13
  62. data/docs/ExceptionResponseContext.md +30 -29
  63. data/docs/IDPManagementApi.md +692 -0
  64. data/docs/IdBasedMfaEnrollment.md +26 -0
  65. data/docs/IdentityCount.md +20 -0
  66. data/docs/IdentityLimitsUsageRequest.md +42 -0
  67. data/docs/IdentityLimitsUsageResponse.md +44 -0
  68. data/docs/IdentityLimitsUsageResponseApikeysPerIdentity.md +20 -0
  69. data/docs/IdentityLimitsUsageResponseClaimRulesPerGroup.md +20 -0
  70. data/docs/IdentityLimitsUsageResponseClaimRulesPerProfile.md +20 -0
  71. data/docs/IdentityLimitsUsageResponseServiceidsPerGroup.md +20 -0
  72. data/docs/IdentityLimitsUsageResponseTemplateVersionsPerTemplate.md +20 -0
  73. data/docs/IdentityPreferenceResponse.md +28 -0
  74. data/docs/IdentityPreferencesApi.md +304 -0
  75. data/docs/IdentityPreferencesResponse.md +18 -0
  76. data/docs/Idp.md +38 -0
  77. data/docs/LimitCount.md +20 -0
  78. data/docs/ListIdPSettings200Response.md +18 -0
  79. data/docs/ListIdps200Response.md +18 -0
  80. data/docs/MFAEnrollmentStatusApi.md +216 -0
  81. data/docs/MFARequirementsResponse.md +12 -11
  82. data/docs/MfaEnrollmentTypeStatus.md +20 -0
  83. data/docs/MfaOptions.md +15 -0
  84. data/docs/OidcExceptionResponse.md +16 -15
  85. data/docs/PolicyTemplateReference.md +20 -0
  86. data/docs/ProfileClaimRule.md +36 -0
  87. data/docs/ProfileClaimRuleConditions.md +22 -0
  88. data/docs/ProfileClaimRuleList.md +20 -0
  89. data/docs/ProfileClaimRuleRequest.md +30 -0
  90. data/docs/ProfileCount.md +20 -0
  91. data/docs/ProfileIdentitiesResponse.md +20 -0
  92. data/docs/ProfileIdentitiesUpdateRequest.md +18 -0
  93. data/docs/ProfileIdentityRequest.md +24 -0
  94. data/docs/ProfileIdentityResponse.md +26 -0
  95. data/docs/ProfileLink.md +32 -0
  96. data/docs/ProfileLinkLink.md +26 -0
  97. data/docs/ProfileLinkList.md +18 -0
  98. data/docs/Report.md +34 -0
  99. data/docs/ReportMfaEnrollmentStatus.md +28 -0
  100. data/docs/ReportReference.md +18 -0
  101. data/docs/ResponseContext.md +28 -27
  102. data/docs/RetrictActions.md +15 -0
  103. data/docs/SamlMetadataImportResponse.md +42 -0
  104. data/docs/ServiceIDGroupsApi.md +347 -0
  105. data/docs/ServiceIDsApi.md +515 -0
  106. data/docs/ServiceId.md +38 -33
  107. data/docs/ServiceIdGroup.md +34 -0
  108. data/docs/ServiceIdGroupCount.md +20 -0
  109. data/docs/ServiceIdGroupList.md +18 -0
  110. data/docs/ServiceIdList.md +20 -19
  111. data/docs/ShareScope.md +20 -0
  112. data/docs/TemplateAccountSettings.md +40 -0
  113. data/docs/TemplateAccountSettingsAllOfRestrictUserDomains.md +20 -0
  114. data/docs/TemplateAssignmentListResponse.md +30 -0
  115. data/docs/TemplateAssignmentResource.md +18 -0
  116. data/docs/TemplateAssignmentResourceError.md +24 -0
  117. data/docs/TemplateAssignmentResponse.md +48 -0
  118. data/docs/TemplateAssignmentResponseResource.md +24 -0
  119. data/docs/TemplateAssignmentResponseResourceDetail.md +26 -0
  120. data/docs/TemplateCount.md +20 -0
  121. data/docs/TemplateProfileComponentRequest.md +26 -0
  122. data/docs/TemplateProfileComponentResponse.md +26 -0
  123. data/docs/TestResult.md +28 -0
  124. data/docs/TestResultStepsInner.md +24 -0
  125. data/docs/TestTriggerResponse.md +20 -0
  126. data/docs/TokenResponse.md +18 -17
  127. data/docs/TokenRetrievalApi.md +461 -0
  128. data/docs/TrustedProfile.md +50 -0
  129. data/docs/TrustedProfileTemplateApi.md +720 -0
  130. data/docs/TrustedProfileTemplateAssignmentsApi.md +376 -0
  131. data/docs/TrustedProfileTemplateClaimRule.md +26 -0
  132. data/docs/TrustedProfileTemplateList.md +30 -0
  133. data/docs/TrustedProfileTemplateRequest.md +28 -0
  134. data/docs/TrustedProfileTemplateResponse.md +48 -0
  135. data/docs/TrustedProfilesApi.md +1414 -0
  136. data/docs/TrustedProfilesList.md +30 -0
  137. data/docs/UpdateAccountIdpSettingRequest.md +22 -0
  138. data/docs/UpdateAccountLoginSettings.md +18 -0
  139. data/docs/UpdateApiKeyRequest.md +16 -9
  140. data/docs/UpdateIdPRequest.md +28 -0
  141. data/docs/UpdateIdPRequestProperties.md +20 -0
  142. data/docs/UpdateIdPRequestPropertiesIdp.md +24 -0
  143. data/docs/UpdateIdPRequestSecrets.md +20 -0
  144. data/docs/UpdateIdPRequestSecretsIdp.md +20 -0
  145. data/docs/UpdatePreferenceRequest.md +20 -0
  146. data/docs/UpdateServiceIdGroupRequest.md +20 -0
  147. data/docs/UpdateServiceIdRequest.md +12 -11
  148. data/docs/UpdateTemplateAssignmentRequest.md +18 -0
  149. data/docs/UpdateTrustedProfileRequest.md +22 -0
  150. data/docs/UserActivity.md +26 -0
  151. data/docs/UserMFAResolved.md +24 -0
  152. data/docs/UserMfa.md +20 -0
  153. data/docs/UserMfaEnrollments.md +24 -0
  154. data/docs/UserReportMfaEnrollmentStatus.md +30 -0
  155. data/docs/UserVisbilityRetrictActions.md +15 -0
  156. data/docs/UserVisbilityRetrictActionsForTemplate.md +15 -0
  157. data/git_push.sh +3 -4
  158. data/ibm_cloud_iam.gemspec +6 -5
  159. data/lib/ibm_cloud_iam/api/account_limits_api.rb +208 -0
  160. data/lib/ibm_cloud_iam/api/account_settings_api.rb +262 -0
  161. data/lib/ibm_cloud_iam/api/account_settings_for_id_p_api.rb +571 -0
  162. data/lib/ibm_cloud_iam/api/account_settings_template_api.rb +823 -0
  163. data/lib/ibm_cloud_iam/api/account_settings_template_assignments_api.rb +422 -0
  164. data/lib/ibm_cloud_iam/api/activities_api.rb +174 -0
  165. data/lib/ibm_cloud_iam/api/api_keys_api.rb +786 -0
  166. data/lib/ibm_cloud_iam/api/identity_preferences_api.rb +357 -0
  167. data/lib/ibm_cloud_iam/api/idp_management_api.rb +744 -0
  168. data/lib/ibm_cloud_iam/api/mfa_enrollment_status_api.rb +248 -0
  169. data/lib/ibm_cloud_iam/api/service_id_groups_api.rb +392 -0
  170. data/lib/ibm_cloud_iam/api/service_ids_api.rb +575 -0
  171. data/lib/ibm_cloud_iam/api/token_retrieval_api.rb +557 -0
  172. data/lib/ibm_cloud_iam/api/trusted_profile_template_api.rb +823 -0
  173. data/lib/ibm_cloud_iam/api/trusted_profile_template_assignments_api.rb +422 -0
  174. data/lib/ibm_cloud_iam/api/trusted_profiles_api.rb +1630 -0
  175. data/lib/ibm_cloud_iam/api_client.rb +74 -65
  176. data/lib/ibm_cloud_iam/api_error.rb +4 -3
  177. data/lib/ibm_cloud_iam/api_model_base.rb +88 -0
  178. data/lib/ibm_cloud_iam/configuration.rb +75 -15
  179. data/lib/ibm_cloud_iam/models/access_group_count.rb +159 -0
  180. data/lib/ibm_cloud_iam/models/account_based_mfa_enrollment.rb +243 -0
  181. data/lib/ibm_cloud_iam/models/account_idp_settings.rb +244 -0
  182. data/lib/ibm_cloud_iam/models/account_login_settings.rb +147 -0
  183. data/lib/ibm_cloud_iam/models/account_settings_assigned_templates_section.rb +377 -0
  184. data/lib/ibm_cloud_iam/models/account_settings_effective_section.rb +282 -0
  185. data/lib/ibm_cloud_iam/models/account_settings_meta.rb +179 -0
  186. data/lib/ibm_cloud_iam/models/account_settings_request.rb +301 -0
  187. data/lib/ibm_cloud_iam/models/account_settings_response.rb +567 -0
  188. data/lib/ibm_cloud_iam/models/account_settings_template_list.rb +256 -0
  189. data/lib/ibm_cloud_iam/models/account_settings_template_request.rb +178 -0
  190. data/lib/ibm_cloud_iam/models/account_settings_template_response.rb +416 -0
  191. data/lib/ibm_cloud_iam/models/account_settings_user_domain_restriction.rb +188 -0
  192. data/lib/ibm_cloud_iam/models/account_settings_user_mfa_response.rb +261 -0
  193. data/lib/ibm_cloud_iam/models/action_controls.rb +199 -0
  194. data/lib/ibm_cloud_iam/models/action_controls_identities.rb +190 -0
  195. data/lib/ibm_cloud_iam/models/activity.rb +175 -0
  196. data/lib/ibm_cloud_iam/models/add_account_idp_setting_request.rb +243 -0
  197. data/lib/ibm_cloud_iam/models/api_key.rb +188 -104
  198. data/lib/ibm_cloud_iam/models/api_key_inside_create_service_id_request.rb +70 -99
  199. data/lib/ibm_cloud_iam/models/api_key_list.rb +46 -95
  200. data/lib/ibm_cloud_iam/models/apikey_activity.rb +231 -0
  201. data/lib/ibm_cloud_iam/models/apikey_activity_serviceid.rb +159 -0
  202. data/lib/ibm_cloud_iam/models/apikey_activity_user.rb +179 -0
  203. data/lib/ibm_cloud_iam/models/assigned_templates_account_settings.rb +296 -0
  204. data/lib/ibm_cloud_iam/models/common_account_settings_request.rb +272 -0
  205. data/lib/ibm_cloud_iam/models/common_account_settings_response.rb +260 -0
  206. data/lib/ibm_cloud_iam/models/consumers_response.rb +158 -0
  207. data/lib/ibm_cloud_iam/models/consumers_response_consumers_inner.rb +158 -0
  208. data/lib/ibm_cloud_iam/models/create_api_key_request.rb +92 -99
  209. data/lib/ibm_cloud_iam/models/create_idp_request.rb +283 -0
  210. data/lib/ibm_cloud_iam/models/create_idp_request_properties.rb +157 -0
  211. data/lib/ibm_cloud_iam/models/create_idp_request_properties_idp.rb +189 -0
  212. data/lib/ibm_cloud_iam/models/create_idp_request_properties_sp.rb +222 -0
  213. data/lib/ibm_cloud_iam/models/create_idp_request_properties_sp_authn_context.rb +163 -0
  214. data/lib/ibm_cloud_iam/models/create_idp_request_secrets.rb +157 -0
  215. data/lib/ibm_cloud_iam/models/create_idp_request_secrets_idp.rb +173 -0
  216. data/lib/ibm_cloud_iam/models/create_idp_request_secrets_idp_signing_inner.rb +192 -0
  217. data/lib/ibm_cloud_iam/models/create_idp_request_secrets_sp.rb +151 -0
  218. data/lib/ibm_cloud_iam/models/create_idp_request_secrets_sp_signing_inner.rb +212 -0
  219. data/lib/ibm_cloud_iam/models/create_profile_link_request.rb +211 -0
  220. data/lib/ibm_cloud_iam/models/create_profile_link_request_link.rb +206 -0
  221. data/lib/ibm_cloud_iam/models/create_service_id_group_request.rb +203 -0
  222. data/lib/ibm_cloud_iam/models/create_service_id_request.rb +68 -95
  223. data/lib/ibm_cloud_iam/models/create_template_assignment_request.rb +280 -0
  224. data/lib/ibm_cloud_iam/models/create_trusted_profile_request.rb +213 -0
  225. data/lib/ibm_cloud_iam/models/effective_account_settings_response.rb +239 -0
  226. data/lib/ibm_cloud_iam/models/enity_history_record.rb +112 -101
  227. data/lib/ibm_cloud_iam/models/entity_activity.rb +185 -0
  228. data/lib/ibm_cloud_iam/models/error.rb +69 -94
  229. data/lib/ibm_cloud_iam/models/exception_response.rb +57 -94
  230. data/lib/ibm_cloud_iam/models/exception_response_context.rb +33 -94
  231. data/lib/ibm_cloud_iam/models/id_based_mfa_enrollment.rb +270 -0
  232. data/lib/ibm_cloud_iam/models/identity_count.rb +159 -0
  233. data/lib/ibm_cloud_iam/models/identity_limits_usage_request.rb +283 -0
  234. data/lib/ibm_cloud_iam/models/identity_limits_usage_response.rb +265 -0
  235. data/lib/ibm_cloud_iam/models/identity_limits_usage_response_apikeys_per_identity.rb +178 -0
  236. data/lib/ibm_cloud_iam/models/identity_limits_usage_response_claim_rules_per_group.rb +178 -0
  237. data/lib/ibm_cloud_iam/models/identity_limits_usage_response_claim_rules_per_profile.rb +178 -0
  238. data/lib/ibm_cloud_iam/models/identity_limits_usage_response_serviceids_per_group.rb +178 -0
  239. data/lib/ibm_cloud_iam/models/identity_limits_usage_response_template_versions_per_template.rb +178 -0
  240. data/lib/ibm_cloud_iam/models/identity_preference_response.rb +200 -0
  241. data/lib/ibm_cloud_iam/models/identity_preferences_response.rb +167 -0
  242. data/lib/ibm_cloud_iam/models/idp.rb +239 -0
  243. data/lib/ibm_cloud_iam/models/limit_count.rb +176 -0
  244. data/lib/ibm_cloud_iam/models/list_id_p_settings200_response.rb +149 -0
  245. data/lib/ibm_cloud_iam/models/list_idps200_response.rb +149 -0
  246. data/lib/ibm_cloud_iam/models/mfa_enrollment_type_status.rb +192 -0
  247. data/lib/ibm_cloud_iam/models/mfa_options.rb +45 -0
  248. data/lib/ibm_cloud_iam/models/mfa_requirements_response.rb +69 -94
  249. data/lib/ibm_cloud_iam/models/oidc_exception_response.rb +57 -94
  250. data/lib/ibm_cloud_iam/models/policy_template_reference.rb +193 -0
  251. data/lib/ibm_cloud_iam/models/profile_claim_rule.rb +342 -0
  252. data/lib/ibm_cloud_iam/models/profile_claim_rule_conditions.rb +219 -0
  253. data/lib/ibm_cloud_iam/models/profile_claim_rule_list.rb +176 -0
  254. data/lib/ibm_cloud_iam/models/profile_claim_rule_request.rb +243 -0
  255. data/lib/ibm_cloud_iam/models/profile_count.rb +159 -0
  256. data/lib/ibm_cloud_iam/models/profile_identities_response.rb +160 -0
  257. data/lib/ibm_cloud_iam/models/profile_identities_update_request.rb +150 -0
  258. data/lib/ibm_cloud_iam/models/profile_identity_request.rb +238 -0
  259. data/lib/ibm_cloud_iam/models/profile_identity_response.rb +265 -0
  260. data/lib/ibm_cloud_iam/models/profile_link.rb +320 -0
  261. data/lib/ibm_cloud_iam/models/profile_link_link.rb +188 -0
  262. data/lib/ibm_cloud_iam/models/profile_link_list.rb +167 -0
  263. data/lib/ibm_cloud_iam/models/report.rb +321 -0
  264. data/lib/ibm_cloud_iam/models/report_mfa_enrollment_status.rb +268 -0
  265. data/lib/ibm_cloud_iam/models/report_reference.rb +165 -0
  266. data/lib/ibm_cloud_iam/models/response_context.rb +33 -94
  267. data/lib/ibm_cloud_iam/models/retrict_actions.rb +41 -0
  268. data/lib/ibm_cloud_iam/models/saml_metadata_import_response.rb +494 -0
  269. data/lib/ibm_cloud_iam/models/service_id.rb +184 -108
  270. data/lib/ibm_cloud_iam/models/service_id_group.rb +313 -0
  271. data/lib/ibm_cloud_iam/models/service_id_group_count.rb +159 -0
  272. data/lib/ibm_cloud_iam/models/service_id_group_list.rb +167 -0
  273. data/lib/ibm_cloud_iam/models/service_id_list.rb +47 -96
  274. data/lib/ibm_cloud_iam/models/share_scope.rb +190 -0
  275. data/lib/ibm_cloud_iam/models/template_account_settings.rb +296 -0
  276. data/lib/ibm_cloud_iam/models/template_account_settings_all_of_restrict_user_domains.rb +159 -0
  277. data/lib/ibm_cloud_iam/models/template_assignment_list_response.rb +227 -0
  278. data/lib/ibm_cloud_iam/models/template_assignment_resource.rb +149 -0
  279. data/lib/ibm_cloud_iam/models/template_assignment_resource_error.rb +179 -0
  280. data/lib/ibm_cloud_iam/models/template_assignment_response.rb +506 -0
  281. data/lib/ibm_cloud_iam/models/template_assignment_response_resource.rb +196 -0
  282. data/lib/ibm_cloud_iam/models/template_assignment_response_resource_detail.rb +203 -0
  283. data/lib/ibm_cloud_iam/models/template_count.rb +159 -0
  284. data/lib/ibm_cloud_iam/models/template_profile_component_request.rb +210 -0
  285. data/lib/ibm_cloud_iam/models/template_profile_component_response.rb +210 -0
  286. data/lib/ibm_cloud_iam/models/test_result.rb +194 -0
  287. data/lib/ibm_cloud_iam/models/test_result_steps_inner.rb +174 -0
  288. data/lib/ibm_cloud_iam/models/test_trigger_response.rb +156 -0
  289. data/lib/ibm_cloud_iam/models/token_response.rb +33 -94
  290. data/lib/ibm_cloud_iam/models/trusted_profile.rb +411 -0
  291. data/lib/ibm_cloud_iam/models/trusted_profile_template_claim_rule.rb +248 -0
  292. data/lib/ibm_cloud_iam/models/trusted_profile_template_list.rb +256 -0
  293. data/lib/ibm_cloud_iam/models/trusted_profile_template_request.rb +199 -0
  294. data/lib/ibm_cloud_iam/models/trusted_profile_template_response.rb +369 -0
  295. data/lib/ibm_cloud_iam/models/trusted_profiles_list.rb +227 -0
  296. data/lib/ibm_cloud_iam/models/update_account_idp_setting_request.rb +202 -0
  297. data/lib/ibm_cloud_iam/models/update_account_login_settings.rb +148 -0
  298. data/lib/ibm_cloud_iam/models/update_api_key_request.rb +68 -99
  299. data/lib/ibm_cloud_iam/models/update_id_p_request.rb +198 -0
  300. data/lib/ibm_cloud_iam/models/update_id_p_request_properties.rb +157 -0
  301. data/lib/ibm_cloud_iam/models/update_id_p_request_properties_idp.rb +179 -0
  302. data/lib/ibm_cloud_iam/models/update_id_p_request_secrets.rb +157 -0
  303. data/lib/ibm_cloud_iam/models/update_id_p_request_secrets_idp.rb +163 -0
  304. data/lib/ibm_cloud_iam/models/update_preference_request.rb +161 -0
  305. data/lib/ibm_cloud_iam/models/update_service_id_group_request.rb +176 -0
  306. data/lib/ibm_cloud_iam/models/update_service_id_request.rb +34 -95
  307. data/lib/ibm_cloud_iam/models/update_template_assignment_request.rb +175 -0
  308. data/lib/ibm_cloud_iam/models/update_trusted_profile_request.rb +169 -0
  309. data/lib/ibm_cloud_iam/models/user_activity.rb +222 -0
  310. data/lib/ibm_cloud_iam/models/user_mfa.rb +179 -0
  311. data/lib/ibm_cloud_iam/models/user_mfa_enrollments.rb +193 -0
  312. data/lib/ibm_cloud_iam/models/user_mfa_resolved.rb +178 -0
  313. data/lib/ibm_cloud_iam/models/user_report_mfa_enrollment_status.rb +291 -0
  314. data/lib/ibm_cloud_iam/models/user_visbility_retrict_actions.rb +40 -0
  315. data/lib/ibm_cloud_iam/models/user_visbility_retrict_actions_for_template.rb +41 -0
  316. data/lib/ibm_cloud_iam/version.rb +4 -4
  317. data/lib/ibm_cloud_iam.rb +140 -9
  318. data/spec/api/account_limits_api_spec.rb +75 -0
  319. data/spec/api/account_settings_api_spec.rb +80 -0
  320. data/spec/api/account_settings_for_id_p_api_spec.rb +132 -0
  321. data/spec/api/account_settings_template_api_spec.rb +184 -0
  322. data/spec/api/account_settings_template_assignments_api_spec.rb +112 -0
  323. data/spec/api/activities_api_spec.rb +64 -0
  324. data/spec/api/api_keys_api_spec.rb +182 -0
  325. data/spec/api/identity_preferences_api_spec.rb +98 -0
  326. data/spec/api/idp_management_api_spec.rb +166 -0
  327. data/spec/api/mfa_enrollment_status_api_spec.rb +77 -0
  328. data/spec/api/service_id_groups_api_spec.rb +102 -0
  329. data/spec/api/service_ids_api_spec.rb +143 -0
  330. data/spec/api/token_retrieval_api_spec.rb +134 -0
  331. data/spec/api/trusted_profile_template_api_spec.rb +184 -0
  332. data/spec/api/trusted_profile_template_assignments_api_spec.rb +112 -0
  333. data/spec/api/trusted_profiles_api_spec.rb +328 -0
  334. data/spec/models/access_group_count_spec.rb +42 -0
  335. data/spec/models/account_based_mfa_enrollment_spec.rb +54 -0
  336. data/spec/models/account_idp_settings_spec.rb +82 -0
  337. data/spec/models/account_login_settings_spec.rb +36 -0
  338. data/spec/models/account_settings_assigned_templates_section_spec.rb +120 -0
  339. data/spec/models/account_settings_effective_section_spec.rb +96 -0
  340. data/spec/models/account_settings_meta_spec.rb +54 -0
  341. data/spec/models/account_settings_request_spec.rb +102 -0
  342. data/spec/models/account_settings_response_spec.rb +126 -0
  343. data/spec/models/account_settings_template_list_spec.rb +72 -0
  344. data/spec/models/account_settings_template_request_spec.rb +54 -0
  345. data/spec/models/account_settings_template_response_spec.rb +114 -0
  346. data/spec/models/account_settings_user_domain_restriction_spec.rb +48 -0
  347. data/spec/models/account_settings_user_mfa_response_spec.rb +66 -0
  348. data/spec/models/action_controls_identities_spec.rb +42 -0
  349. data/spec/models/action_controls_spec.rb +48 -0
  350. data/spec/models/activity_spec.rb +42 -0
  351. data/spec/models/add_account_idp_setting_request_spec.rb +52 -0
  352. data/spec/models/api_key_inside_create_service_id_request_spec.rb +24 -17
  353. data/spec/models/api_key_list_spec.rb +15 -20
  354. data/spec/models/api_key_spec.rb +52 -27
  355. data/spec/models/apikey_activity_serviceid_spec.rb +42 -0
  356. data/spec/models/apikey_activity_spec.rb +66 -0
  357. data/spec/models/apikey_activity_user_spec.rb +54 -0
  358. data/spec/models/assigned_templates_account_settings_spec.rb +102 -0
  359. data/spec/models/common_account_settings_request_spec.rb +90 -0
  360. data/spec/models/common_account_settings_response_spec.rb +84 -0
  361. data/spec/models/consumers_response_consumers_inner_spec.rb +42 -0
  362. data/spec/models/consumers_response_spec.rb +42 -0
  363. data/spec/models/create_api_key_request_spec.rb +32 -19
  364. data/spec/models/create_idp_request_properties_idp_spec.rb +60 -0
  365. data/spec/models/create_idp_request_properties_sp_authn_context_spec.rb +42 -0
  366. data/spec/models/create_idp_request_properties_sp_spec.rb +78 -0
  367. data/spec/models/create_idp_request_properties_spec.rb +42 -0
  368. data/spec/models/create_idp_request_secrets_idp_signing_inner_spec.rb +46 -0
  369. data/spec/models/create_idp_request_secrets_idp_spec.rb +48 -0
  370. data/spec/models/create_idp_request_secrets_sp_signing_inner_spec.rb +58 -0
  371. data/spec/models/create_idp_request_secrets_sp_spec.rb +36 -0
  372. data/spec/models/create_idp_request_secrets_spec.rb +42 -0
  373. data/spec/models/create_idp_request_spec.rb +76 -0
  374. data/spec/models/create_profile_link_request_link_spec.rb +60 -0
  375. data/spec/models/create_profile_link_request_spec.rb +54 -0
  376. data/spec/models/create_service_id_group_request_spec.rb +48 -0
  377. data/spec/models/create_service_id_request_spec.rb +19 -18
  378. data/spec/models/create_template_assignment_request_spec.rb +58 -0
  379. data/spec/models/create_trusted_profile_request_spec.rb +54 -0
  380. data/spec/models/effective_account_settings_response_spec.rb +60 -0
  381. data/spec/models/enity_history_record_spec.rb +14 -19
  382. data/spec/models/entity_activity_spec.rb +48 -0
  383. data/spec/models/error_spec.rb +12 -17
  384. data/spec/models/exception_response_context_spec.rb +20 -25
  385. data/spec/models/exception_response_spec.rb +12 -17
  386. data/spec/models/id_based_mfa_enrollment_spec.rb +64 -0
  387. data/spec/models/identity_count_spec.rb +42 -0
  388. data/spec/models/identity_limits_usage_request_spec.rb +108 -0
  389. data/spec/models/identity_limits_usage_response_apikeys_per_identity_spec.rb +42 -0
  390. data/spec/models/identity_limits_usage_response_claim_rules_per_group_spec.rb +42 -0
  391. data/spec/models/identity_limits_usage_response_claim_rules_per_profile_spec.rb +42 -0
  392. data/spec/models/identity_limits_usage_response_serviceids_per_group_spec.rb +42 -0
  393. data/spec/models/identity_limits_usage_response_spec.rb +114 -0
  394. data/spec/models/identity_limits_usage_response_template_versions_per_template_spec.rb +42 -0
  395. data/spec/models/identity_preference_response_spec.rb +66 -0
  396. data/spec/models/identity_preferences_response_spec.rb +36 -0
  397. data/spec/models/idp_spec.rb +96 -0
  398. data/spec/models/limit_count_spec.rb +42 -0
  399. data/spec/models/list_id_p_settings200_response_spec.rb +36 -0
  400. data/spec/models/list_idps200_response_spec.rb +36 -0
  401. data/spec/models/mfa_enrollment_type_status_spec.rb +42 -0
  402. data/spec/models/mfa_options_spec.rb +30 -0
  403. data/spec/models/mfa_requirements_response_spec.rb +11 -16
  404. data/spec/models/oidc_exception_response_spec.rb +13 -18
  405. data/spec/models/policy_template_reference_spec.rb +42 -0
  406. data/spec/models/profile_claim_rule_conditions_spec.rb +48 -0
  407. data/spec/models/profile_claim_rule_list_spec.rb +42 -0
  408. data/spec/models/profile_claim_rule_request_spec.rb +72 -0
  409. data/spec/models/profile_claim_rule_spec.rb +90 -0
  410. data/spec/models/profile_count_spec.rb +42 -0
  411. data/spec/models/profile_identities_response_spec.rb +42 -0
  412. data/spec/models/profile_identities_update_request_spec.rb +36 -0
  413. data/spec/models/profile_identity_request_spec.rb +58 -0
  414. data/spec/models/profile_identity_response_spec.rb +64 -0
  415. data/spec/models/profile_link_link_spec.rb +60 -0
  416. data/spec/models/profile_link_list_spec.rb +36 -0
  417. data/spec/models/profile_link_spec.rb +78 -0
  418. data/spec/models/report_mfa_enrollment_status_spec.rb +66 -0
  419. data/spec/models/report_reference_spec.rb +36 -0
  420. data/spec/models/report_spec.rb +84 -0
  421. data/spec/models/response_context_spec.rb +19 -24
  422. data/spec/models/retrict_actions_spec.rb +30 -0
  423. data/spec/models/saml_metadata_import_response_spec.rb +112 -0
  424. data/spec/models/service_id_group_count_spec.rb +42 -0
  425. data/spec/models/service_id_group_list_spec.rb +36 -0
  426. data/spec/models/service_id_group_spec.rb +84 -0
  427. data/spec/models/service_id_list_spec.rb +15 -20
  428. data/spec/models/service_id_spec.rb +34 -27
  429. data/spec/models/share_scope_spec.rb +46 -0
  430. data/spec/models/template_account_settings_all_of_restrict_user_domains_spec.rb +42 -0
  431. data/spec/models/template_account_settings_spec.rb +102 -0
  432. data/spec/models/template_assignment_list_response_spec.rb +72 -0
  433. data/spec/models/template_assignment_resource_error_spec.rb +54 -0
  434. data/spec/models/template_assignment_resource_spec.rb +36 -0
  435. data/spec/models/template_assignment_response_resource_detail_spec.rb +60 -0
  436. data/spec/models/template_assignment_response_resource_spec.rb +54 -0
  437. data/spec/models/template_assignment_response_spec.rb +126 -0
  438. data/spec/models/template_count_spec.rb +42 -0
  439. data/spec/models/template_profile_component_request_spec.rb +60 -0
  440. data/spec/models/template_profile_component_response_spec.rb +60 -0
  441. data/spec/models/test_result_spec.rb +66 -0
  442. data/spec/models/test_result_steps_inner_spec.rb +54 -0
  443. data/spec/models/test_trigger_response_spec.rb +42 -0
  444. data/spec/models/token_response_spec.rb +14 -19
  445. data/spec/models/trusted_profile_spec.rb +132 -0
  446. data/spec/models/trusted_profile_template_claim_rule_spec.rb +64 -0
  447. data/spec/models/trusted_profile_template_list_spec.rb +72 -0
  448. data/spec/models/trusted_profile_template_request_spec.rb +66 -0
  449. data/spec/models/trusted_profile_template_response_spec.rb +126 -0
  450. data/spec/models/trusted_profiles_list_spec.rb +72 -0
  451. data/spec/models/update_account_idp_setting_request_spec.rb +52 -0
  452. data/spec/models/update_account_login_settings_spec.rb +36 -0
  453. data/spec/models/update_api_key_request_spec.rb +28 -15
  454. data/spec/models/update_id_p_request_properties_idp_spec.rb +54 -0
  455. data/spec/models/update_id_p_request_properties_spec.rb +42 -0
  456. data/spec/models/update_id_p_request_secrets_idp_spec.rb +42 -0
  457. data/spec/models/update_id_p_request_secrets_spec.rb +42 -0
  458. data/spec/models/update_id_p_request_spec.rb +66 -0
  459. data/spec/models/update_preference_request_spec.rb +42 -0
  460. data/spec/models/update_service_id_group_request_spec.rb +42 -0
  461. data/spec/models/update_service_id_request_spec.rb +11 -16
  462. data/spec/models/update_template_assignment_request_spec.rb +36 -0
  463. data/spec/models/update_trusted_profile_request_spec.rb +48 -0
  464. data/spec/models/user_activity_spec.rb +60 -0
  465. data/spec/models/user_mfa_enrollments_spec.rb +54 -0
  466. data/spec/models/user_mfa_resolved_spec.rb +54 -0
  467. data/spec/models/user_mfa_spec.rb +42 -0
  468. data/spec/models/user_report_mfa_enrollment_status_spec.rb +72 -0
  469. data/spec/models/user_visbility_retrict_actions_for_template_spec.rb +30 -0
  470. data/spec/models/user_visbility_retrict_actions_spec.rb +30 -0
  471. data/spec/spec_helper.rb +3 -3
  472. metadata +550 -36
  473. data/docs/IdentityOperationsApi.md +0 -828
  474. data/docs/InlineObject.md +0 -19
  475. data/docs/InlineObject1.md +0 -23
  476. data/docs/InlineObject2.md +0 -21
  477. data/docs/InlineObject3.md +0 -25
  478. data/docs/TokenOperationsApi.md +0 -226
  479. data/ibm_cloud_iam-1.0.0.gem +0 -0
  480. data/lib/ibm_cloud_iam/api/identity_operations_api.rb +0 -1083
  481. data/lib/ibm_cloud_iam/api/token_operations_api.rb +0 -351
  482. data/lib/ibm_cloud_iam/models/inline_object.rb +0 -229
  483. data/lib/ibm_cloud_iam/models/inline_object1.rb +0 -254
  484. data/lib/ibm_cloud_iam/models/inline_object2.rb +0 -244
  485. data/lib/ibm_cloud_iam/models/inline_object3.rb +0 -269
  486. data/spec/api/identity_operations_api_spec.rb +0 -253
  487. data/spec/api/token_operations_api_spec.rb +0 -94
  488. data/spec/api_client_spec.rb +0 -226
  489. data/spec/configuration_spec.rb +0 -42
  490. data/spec/models/inline_object1_spec.rb +0 -59
  491. data/spec/models/inline_object2_spec.rb +0 -53
  492. data/spec/models/inline_object3_spec.rb +0 -65
  493. data/spec/models/inline_object_spec.rb +0 -47
@@ -0,0 +1,18 @@
1
+ # IbmCloudIam::ListIdps200Response
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **idps** | [**Array<Idp>**](Idp.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'ibm_cloud_iam'
13
+
14
+ instance = IbmCloudIam::ListIdps200Response.new(
15
+ idps: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,216 @@
1
+ # IbmCloudIam::MFAEnrollmentStatusApi
2
+
3
+ All URIs are relative to *https://iam.cloud.ibm.com*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**create_mfa_report**](MFAEnrollmentStatusApi.md#create_mfa_report) | **POST** /v1/mfa/accounts/{account_id}/report | Trigger MFA enrollment status report for the account |
8
+ | [**get_mfa_report**](MFAEnrollmentStatusApi.md#get_mfa_report) | **GET** /v1/mfa/accounts/{account_id}/report/{reference} | Get MFA enrollment status report for the account |
9
+ | [**get_mfa_status**](MFAEnrollmentStatusApi.md#get_mfa_status) | **GET** /v1/mfa/accounts/{account_id}/status | Get MFA enrollment status for a single user in the account. |
10
+
11
+
12
+ ## create_mfa_report
13
+
14
+ > <ReportReference> create_mfa_report(account_id, authorization, opts)
15
+
16
+ Trigger MFA enrollment status report for the account
17
+
18
+ Trigger MFA enrollment status report for the account by specifying the account ID. It can take a few minutes to generate the report for retrieval.
19
+
20
+ ### Examples
21
+
22
+ ```ruby
23
+ require 'time'
24
+ require 'ibm_cloud_iam'
25
+
26
+ api_instance = IbmCloudIam::MFAEnrollmentStatusApi.new
27
+ account_id = 'account_id_example' # String | ID of the account
28
+ 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.
29
+ opts = {
30
+ type: 'type_example' # String | Optional report type. The supported value is 'mfa_status'. List MFA enrollment status for all the identities.
31
+ }
32
+
33
+ begin
34
+ # Trigger MFA enrollment status report for the account
35
+ result = api_instance.create_mfa_report(account_id, authorization, opts)
36
+ p result
37
+ rescue IbmCloudIam::ApiError => e
38
+ puts "Error when calling MFAEnrollmentStatusApi->create_mfa_report: #{e}"
39
+ end
40
+ ```
41
+
42
+ #### Using the create_mfa_report_with_http_info variant
43
+
44
+ This returns an Array which contains the response data, status code and headers.
45
+
46
+ > <Array(<ReportReference>, Integer, Hash)> create_mfa_report_with_http_info(account_id, authorization, opts)
47
+
48
+ ```ruby
49
+ begin
50
+ # Trigger MFA enrollment status report for the account
51
+ data, status_code, headers = api_instance.create_mfa_report_with_http_info(account_id, authorization, opts)
52
+ p status_code # => 2xx
53
+ p headers # => { ... }
54
+ p data # => <ReportReference>
55
+ rescue IbmCloudIam::ApiError => e
56
+ puts "Error when calling MFAEnrollmentStatusApi->create_mfa_report_with_http_info: #{e}"
57
+ end
58
+ ```
59
+
60
+ ### Parameters
61
+
62
+ | Name | Type | Description | Notes |
63
+ | ---- | ---- | ----------- | ----- |
64
+ | **account_id** | **String** | ID of the account | |
65
+ | **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: &#39;No authorization header found&#39;. Make sure that the provided token has the required authority for the request. | |
66
+ | **type** | **String** | Optional report type. The supported value is &#39;mfa_status&#39;. List MFA enrollment status for all the identities. | [optional] |
67
+
68
+ ### Return type
69
+
70
+ [**ReportReference**](ReportReference.md)
71
+
72
+ ### Authorization
73
+
74
+ No authorization required
75
+
76
+ ### HTTP request headers
77
+
78
+ - **Content-Type**: Not defined
79
+ - **Accept**: application/json
80
+
81
+
82
+ ## get_mfa_report
83
+
84
+ > <ReportMfaEnrollmentStatus> get_mfa_report(account_id, reference, authorization)
85
+
86
+ Get MFA enrollment status report for the account
87
+
88
+ Get MFA enrollment status report for the account by specifying the account ID and the reference that is generated by triggering the report. Reports older than a day are deleted when generating a new report.
89
+
90
+ ### Examples
91
+
92
+ ```ruby
93
+ require 'time'
94
+ require 'ibm_cloud_iam'
95
+
96
+ api_instance = IbmCloudIam::MFAEnrollmentStatusApi.new
97
+ account_id = 'account_id_example' # String | ID of the account
98
+ reference = 'reference_example' # String | Reference for the report to be generated, You can use 'latest' to get the latest report for the given account.
99
+ 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.
100
+
101
+ begin
102
+ # Get MFA enrollment status report for the account
103
+ result = api_instance.get_mfa_report(account_id, reference, authorization)
104
+ p result
105
+ rescue IbmCloudIam::ApiError => e
106
+ puts "Error when calling MFAEnrollmentStatusApi->get_mfa_report: #{e}"
107
+ end
108
+ ```
109
+
110
+ #### Using the get_mfa_report_with_http_info variant
111
+
112
+ This returns an Array which contains the response data, status code and headers.
113
+
114
+ > <Array(<ReportMfaEnrollmentStatus>, Integer, Hash)> get_mfa_report_with_http_info(account_id, reference, authorization)
115
+
116
+ ```ruby
117
+ begin
118
+ # Get MFA enrollment status report for the account
119
+ data, status_code, headers = api_instance.get_mfa_report_with_http_info(account_id, reference, authorization)
120
+ p status_code # => 2xx
121
+ p headers # => { ... }
122
+ p data # => <ReportMfaEnrollmentStatus>
123
+ rescue IbmCloudIam::ApiError => e
124
+ puts "Error when calling MFAEnrollmentStatusApi->get_mfa_report_with_http_info: #{e}"
125
+ end
126
+ ```
127
+
128
+ ### Parameters
129
+
130
+ | Name | Type | Description | Notes |
131
+ | ---- | ---- | ----------- | ----- |
132
+ | **account_id** | **String** | ID of the account | |
133
+ | **reference** | **String** | Reference for the report to be generated, You can use &#39;latest&#39; to get the latest report for the given account. | |
134
+ | **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: &#39;No authorization header found&#39;. Make sure that the provided token has the required authority for the request. | |
135
+
136
+ ### Return type
137
+
138
+ [**ReportMfaEnrollmentStatus**](ReportMfaEnrollmentStatus.md)
139
+
140
+ ### Authorization
141
+
142
+ No authorization required
143
+
144
+ ### HTTP request headers
145
+
146
+ - **Content-Type**: Not defined
147
+ - **Accept**: application/json
148
+
149
+
150
+ ## get_mfa_status
151
+
152
+ > <UserMfaEnrollments> get_mfa_status(account_id, iam_id, authorization)
153
+
154
+ Get MFA enrollment status for a single user in the account.
155
+
156
+ Get MFA enrollment status for a single user in the account.
157
+
158
+ ### Examples
159
+
160
+ ```ruby
161
+ require 'time'
162
+ require 'ibm_cloud_iam'
163
+
164
+ api_instance = IbmCloudIam::MFAEnrollmentStatusApi.new
165
+ account_id = 'account_id_example' # String | ID of the account
166
+ iam_id = 'iam_id_example' # String | iam_id of the user. This user must be the member of the account.
167
+ 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.
168
+
169
+ begin
170
+ # Get MFA enrollment status for a single user in the account.
171
+ result = api_instance.get_mfa_status(account_id, iam_id, authorization)
172
+ p result
173
+ rescue IbmCloudIam::ApiError => e
174
+ puts "Error when calling MFAEnrollmentStatusApi->get_mfa_status: #{e}"
175
+ end
176
+ ```
177
+
178
+ #### Using the get_mfa_status_with_http_info variant
179
+
180
+ This returns an Array which contains the response data, status code and headers.
181
+
182
+ > <Array(<UserMfaEnrollments>, Integer, Hash)> get_mfa_status_with_http_info(account_id, iam_id, authorization)
183
+
184
+ ```ruby
185
+ begin
186
+ # Get MFA enrollment status for a single user in the account.
187
+ data, status_code, headers = api_instance.get_mfa_status_with_http_info(account_id, iam_id, authorization)
188
+ p status_code # => 2xx
189
+ p headers # => { ... }
190
+ p data # => <UserMfaEnrollments>
191
+ rescue IbmCloudIam::ApiError => e
192
+ puts "Error when calling MFAEnrollmentStatusApi->get_mfa_status_with_http_info: #{e}"
193
+ end
194
+ ```
195
+
196
+ ### Parameters
197
+
198
+ | Name | Type | Description | Notes |
199
+ | ---- | ---- | ----------- | ----- |
200
+ | **account_id** | **String** | ID of the account | |
201
+ | **iam_id** | **String** | iam_id of the user. This user must be the member of the account. | |
202
+ | **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: &#39;No authorization header found&#39;. Make sure that the provided token has the required authority for the request. | |
203
+
204
+ ### Return type
205
+
206
+ [**UserMfaEnrollments**](UserMfaEnrollments.md)
207
+
208
+ ### Authorization
209
+
210
+ No authorization required
211
+
212
+ ### HTTP request headers
213
+
214
+ - **Content-Type**: Not defined
215
+ - **Accept**: application/json
216
+
@@ -2,20 +2,21 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **error** | **String** | MFA error. |
8
- **code** | **String** | MFA Code. |
9
- **authorization_token** | **String** | MFA AuthorizationToken. |
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **error** | **String** | MFA error. | |
8
+ | **code** | **String** | MFA Code. | |
9
+ | **authorization_token** | **String** | MFA AuthorizationToken. | |
10
10
 
11
- ## Code Sample
11
+ ## Example
12
12
 
13
13
  ```ruby
14
- require 'IbmCloudIam'
14
+ require 'ibm_cloud_iam'
15
15
 
16
- instance = IbmCloudIam::MFARequirementsResponse.new(error: null,
17
- code: null,
18
- authorization_token: null)
16
+ instance = IbmCloudIam::MFARequirementsResponse.new(
17
+ error: null,
18
+ code: null,
19
+ authorization_token: null
20
+ )
19
21
  ```
20
22
 
21
-
@@ -0,0 +1,20 @@
1
+ # IbmCloudIam::MfaEnrollmentTypeStatus
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **required** | **Boolean** | Describes whether the enrollment type is required. | |
8
+ | **enrolled** | **Boolean** | Describes whether the enrollment type is enrolled. | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'ibm_cloud_iam'
14
+
15
+ instance = IbmCloudIam::MfaEnrollmentTypeStatus.new(
16
+ required: null,
17
+ enrolled: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,15 @@
1
+ # IbmCloudIam::MfaOptions
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'ibm_cloud_iam'
12
+
13
+ instance = IbmCloudIam::MfaOptions.new()
14
+ ```
15
+
@@ -2,24 +2,25 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **context** | [**ExceptionResponseContext**](ExceptionResponseContext.md) | | [optional]
8
- **error_code** | **String** | Error message code of the REST Exception. |
9
- **error_message** | **String** | Error message of the REST Exception. Error messages are derived base on the input locale of the REST request and the available Message catalogs. Dynamic fallback to &#39;us-english&#39; is happening if no message catalog is available for the provided input locale. |
10
- **error_details** | **String** | Error details of the REST Exception. | [optional]
11
- **requirements** | [**MFARequirementsResponse**](MFARequirementsResponse.md) | | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **context** | [**ExceptionResponseContext**](ExceptionResponseContext.md) | | [optional] |
8
+ | **error_code** | **String** | Error message code of the REST Exception. | |
9
+ | **error_message** | **String** | Error message of the REST Exception. Error messages are derived base on the input locale of the REST request and the available Message catalogs. Dynamic fallback to &#39;us-english&#39; is happening if no message catalog is available for the provided input locale. | |
10
+ | **error_details** | **String** | Error details of the REST Exception. | [optional] |
11
+ | **requirements** | [**MFARequirementsResponse**](MFARequirementsResponse.md) | | [optional] |
12
12
 
13
- ## Code Sample
13
+ ## Example
14
14
 
15
15
  ```ruby
16
- require 'IbmCloudIam'
16
+ require 'ibm_cloud_iam'
17
17
 
18
- instance = IbmCloudIam::OidcExceptionResponse.new(context: null,
19
- error_code: null,
20
- error_message: null,
21
- error_details: null,
22
- requirements: null)
18
+ instance = IbmCloudIam::OidcExceptionResponse.new(
19
+ context: null,
20
+ error_code: null,
21
+ error_message: null,
22
+ error_details: null,
23
+ requirements: null
24
+ )
23
25
  ```
24
26
 
25
-
@@ -0,0 +1,20 @@
1
+ # IbmCloudIam::PolicyTemplateReference
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | ID of Access Policy Template | |
8
+ | **version** | **String** | Version of Access Policy Template | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'ibm_cloud_iam'
14
+
15
+ instance = IbmCloudIam::PolicyTemplateReference.new(
16
+ id: null,
17
+ version: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,36 @@
1
+ # IbmCloudIam::ProfileClaimRule
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | the unique identifier of the claim rule | |
8
+ | **entity_tag** | **String** | version of the claim rule | |
9
+ | **created_at** | **Time** | If set contains a date time string of the creation date in ISO format. | |
10
+ | **modified_at** | **Time** | If set contains a date time string of the last modification date in ISO format. | [optional] |
11
+ | **name** | **String** | The optional claim rule name | [optional] |
12
+ | **type** | **String** | Type of the claim rule, either &#39;Profile-SAML&#39; or &#39;Profile-CR&#39; | |
13
+ | **realm_name** | **String** | The realm name of the Idp this claim rule applies to | [optional] |
14
+ | **expiration** | **Integer** | Session expiration in seconds | |
15
+ | **cr_type** | **String** | The compute resource type. Not required if type is Profile-SAML. Valid values are VSI, PVS, BMS, IKS_SA, ROKS_SA, CE. | [optional] |
16
+ | **conditions** | [**Array&lt;ProfileClaimRuleConditions&gt;**](ProfileClaimRuleConditions.md) | Conditions of this claim rule. | |
17
+
18
+ ## Example
19
+
20
+ ```ruby
21
+ require 'ibm_cloud_iam'
22
+
23
+ instance = IbmCloudIam::ProfileClaimRule.new(
24
+ id: null,
25
+ entity_tag: null,
26
+ created_at: null,
27
+ modified_at: null,
28
+ name: null,
29
+ type: null,
30
+ realm_name: null,
31
+ expiration: null,
32
+ cr_type: null,
33
+ conditions: null
34
+ )
35
+ ```
36
+
@@ -0,0 +1,22 @@
1
+ # IbmCloudIam::ProfileClaimRuleConditions
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **claim** | **String** | The claim to evaluate against. [Learn more](/docs/account?topic&#x3D;account-iam-condition-properties&amp;interface&#x3D;ui#cr-attribute-names). | |
8
+ | **operator** | **String** | The operation to perform on the claim. valid values are EQUALS, NOT_EQUALS, EQUALS_IGNORE_CASE, NOT_EQUALS_IGNORE_CASE, CONTAINS, IN | |
9
+ | **value** | **String** | The stringified JSON value that the claim is compared to using the operator | |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'ibm_cloud_iam'
15
+
16
+ instance = IbmCloudIam::ProfileClaimRuleConditions.new(
17
+ claim: null,
18
+ operator: null,
19
+ value: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,20 @@
1
+ # IbmCloudIam::ProfileClaimRuleList
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **context** | [**ResponseContext**](ResponseContext.md) | | [optional] |
8
+ | **rules** | [**Array&lt;ProfileClaimRule&gt;**](ProfileClaimRule.md) | List of claim rules | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'ibm_cloud_iam'
14
+
15
+ instance = IbmCloudIam::ProfileClaimRuleList.new(
16
+ context: null,
17
+ rules: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,30 @@
1
+ # IbmCloudIam::ProfileClaimRuleRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **context** | [**ResponseContext**](ResponseContext.md) | | [optional] |
8
+ | **name** | **String** | Name of the claim rule to be created or updated | [optional] |
9
+ | **type** | **String** | Type of the claim rule, either &#39;Profile-SAML&#39; or &#39;Profile-CR&#39; | |
10
+ | **realm_name** | **String** | The realm name of the Idp this claim rule applies to. This field is required only if the type is specified as &#39;Profile-SAML&#39;. | [optional] |
11
+ | **cr_type** | **String** | The compute resource type the rule applies to, required only if type is specified as &#39;Profile-CR&#39;. Valid values are VSI, PVS, BMS, IKS_SA, ROKS_SA, CE. | [optional] |
12
+ | **expiration** | **Integer** | Session expiration in seconds, only required if type is &#39;Profile-SAML&#39;. | [optional] |
13
+ | **conditions** | [**Array&lt;ProfileClaimRuleConditions&gt;**](ProfileClaimRuleConditions.md) | Conditions of this claim rule. | |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'ibm_cloud_iam'
19
+
20
+ instance = IbmCloudIam::ProfileClaimRuleRequest.new(
21
+ context: null,
22
+ name: null,
23
+ type: null,
24
+ realm_name: null,
25
+ cr_type: null,
26
+ expiration: null,
27
+ conditions: null
28
+ )
29
+ ```
30
+
@@ -0,0 +1,20 @@
1
+ # IbmCloudIam::ProfileCount
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **profile_id** | **String** | Profile identifier | [optional] |
8
+ | **count** | **Integer** | Number of resources associated with the profile | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'ibm_cloud_iam'
14
+
15
+ instance = IbmCloudIam::ProfileCount.new(
16
+ profile_id: null,
17
+ count: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,20 @@
1
+ # IbmCloudIam::ProfileIdentitiesResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **entity_tag** | **String** | Entity tag of the profile identities response | [optional] |
8
+ | **identities** | [**Array&lt;ProfileIdentityResponse&gt;**](ProfileIdentityResponse.md) | List of identities | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'ibm_cloud_iam'
14
+
15
+ instance = IbmCloudIam::ProfileIdentitiesResponse.new(
16
+ entity_tag: null,
17
+ identities: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,18 @@
1
+ # IbmCloudIam::ProfileIdentitiesUpdateRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **identities** | [**Array&lt;ProfileIdentityRequest&gt;**](ProfileIdentityRequest.md) | List of identities that can assume the trusted profile | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'ibm_cloud_iam'
13
+
14
+ instance = IbmCloudIam::ProfileIdentitiesUpdateRequest.new(
15
+ identities: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,24 @@
1
+ # IbmCloudIam::ProfileIdentityRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **identifier** | **String** | Identifier of the identity that can assume the trusted profiles. This can be a user identifier (IAM id), serviceid or crn. Internally it uses account id of the service id for the identifier &#39;serviceid&#39; and for the identifier &#39;crn&#39; it uses account id contained in the CRN. | |
8
+ | **type** | **String** | Type of the identity | |
9
+ | **accounts** | **Array&lt;String&gt;** | Only valid for the type user. Accounts from which a user can assume the trusted profile. | [optional] |
10
+ | **description** | **String** | Description of the identity that can assume the trusted profile. This is optional field for all the types of identities. When this field is not set for the identity type &#39;serviceid&#39; then the description of the service id is used. Description is recommended for the identity type &#39;crn&#39; E.g. &#39;Instance 1234 of IBM Cloud Service project&#39; | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'ibm_cloud_iam'
16
+
17
+ instance = IbmCloudIam::ProfileIdentityRequest.new(
18
+ identifier: null,
19
+ type: null,
20
+ accounts: null,
21
+ description: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,26 @@
1
+ # IbmCloudIam::ProfileIdentityResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **iam_id** | **String** | IAM ID of the identity | |
8
+ | **identifier** | **String** | Identifier of the identity that can assume the trusted profiles. This can be a user identifier (IAM id), serviceid or crn. Internally it uses account id of the service id for the identifier &#39;serviceid&#39; and for the identifier &#39;crn&#39; it uses account id contained in the CRN. | |
9
+ | **type** | **String** | Type of the identity | |
10
+ | **accounts** | **Array&lt;String&gt;** | Only valid for the type user. Accounts from which a user can assume the trusted profile. | [optional] |
11
+ | **description** | **String** | Description of the identity that can assume the trusted profile. This is optional field for all the types of identities. When this field is not set for the identity type &#39;serviceid&#39; then the description of the service id is used. Description is recommended for the identity type &#39;crn&#39; E.g. &#39;Instance 1234 of IBM Cloud Service project&#39; | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'ibm_cloud_iam'
17
+
18
+ instance = IbmCloudIam::ProfileIdentityResponse.new(
19
+ iam_id: null,
20
+ identifier: null,
21
+ type: null,
22
+ accounts: null,
23
+ description: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,32 @@
1
+ # IbmCloudIam::ProfileLink
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | the unique identifier of the link | |
8
+ | **entity_tag** | **String** | version of the link | |
9
+ | **created_at** | **Time** | If set contains a date time string of the creation date in ISO format. | |
10
+ | **modified_at** | **Time** | If set contains a date time string of the last modification date in ISO format. | |
11
+ | **name** | **String** | Optional name of the Link | [optional] |
12
+ | **cr_type** | **String** | The compute resource type. Valid values are VSI, PVS, BMS, IKS_SA, ROKS_SA, CE | |
13
+ | **is_cross_account** | **Boolean** | Flag to indicate that the link provides cross account access. If not provided then the account scope of the CRN must match the Profile&#39;s account | [optional] |
14
+ | **link** | [**ProfileLinkLink**](ProfileLinkLink.md) | | |
15
+
16
+ ## Example
17
+
18
+ ```ruby
19
+ require 'ibm_cloud_iam'
20
+
21
+ instance = IbmCloudIam::ProfileLink.new(
22
+ id: null,
23
+ entity_tag: null,
24
+ created_at: null,
25
+ modified_at: null,
26
+ name: null,
27
+ cr_type: null,
28
+ is_cross_account: null,
29
+ link: null
30
+ )
31
+ ```
32
+
@@ -0,0 +1,26 @@
1
+ # IbmCloudIam::ProfileLinkLink
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **crn** | **String** | The CRN of the compute resource | [optional] |
8
+ | **namespace** | **String** | The compute resource namespace, only required if cr_type is IKS_SA or ROKS_SA | [optional] |
9
+ | **name** | **String** | Name of the compute resource, only required if cr_type is IKS_SA or ROKS_SA | [optional] |
10
+ | **component_type** | **String** | Component type of the compute resource, only required if cr_type is CE | [optional] |
11
+ | **component_name** | **String** | Component name of the compute resource, only required if cr_type is CE | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'ibm_cloud_iam'
17
+
18
+ instance = IbmCloudIam::ProfileLinkLink.new(
19
+ crn: null,
20
+ namespace: null,
21
+ name: null,
22
+ component_type: null,
23
+ component_name: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,18 @@
1
+ # IbmCloudIam::ProfileLinkList
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **links** | [**Array&lt;ProfileLink&gt;**](ProfileLink.md) | List of links to a trusted profile | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'ibm_cloud_iam'
13
+
14
+ instance = IbmCloudIam::ProfileLinkList.new(
15
+ links: null
16
+ )
17
+ ```
18
+