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.
Files changed (491) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +548 -36
  3. data/docs/APIKeysApi.md +714 -0
  4. data/docs/AccessGroupCount.md +20 -0
  5. data/docs/AccountBasedMfaEnrollment.md +24 -0
  6. data/docs/AccountIdpSettings.md +32 -0
  7. data/docs/AccountLimitsApi.md +173 -0
  8. data/docs/AccountLoginSettings.md +18 -0
  9. data/docs/AccountSettingsApi.md +224 -0
  10. data/docs/AccountSettingsAssignedTemplatesSection.md +46 -0
  11. data/docs/AccountSettingsEffectiveSection.md +38 -0
  12. data/docs/AccountSettingsForIdPApi.md +489 -0
  13. data/docs/AccountSettingsMeta.md +24 -0
  14. data/docs/AccountSettingsRequest.md +40 -0
  15. data/docs/AccountSettingsResponse.md +48 -0
  16. data/docs/AccountSettingsTemplateApi.md +720 -0
  17. data/docs/AccountSettingsTemplateAssignmentsApi.md +376 -0
  18. data/docs/AccountSettingsTemplateList.md +30 -0
  19. data/docs/AccountSettingsTemplateRequest.md +24 -0
  20. data/docs/AccountSettingsTemplateResponse.md +44 -0
  21. data/docs/AccountSettingsUserDomainRestriction.md +22 -0
  22. data/docs/AccountSettingsUserMFAResponse.md +28 -0
  23. data/docs/ActionControls.md +22 -0
  24. data/docs/ActionControlsIdentities.md +20 -0
  25. data/docs/ActivitiesApi.md +149 -0
  26. data/docs/Activity.md +20 -0
  27. data/docs/AddAccountIdpSettingRequest.md +22 -0
  28. data/docs/ApiKey.md +44 -33
  29. data/docs/ApiKeyInsideCreateServiceIdRequest.md +18 -13
  30. data/docs/ApiKeyList.md +20 -19
  31. data/docs/ApikeyActivity.md +28 -0
  32. data/docs/ApikeyActivityServiceid.md +20 -0
  33. data/docs/ApikeyActivityUser.md +24 -0
  34. data/docs/AssignedTemplatesAccountSettings.md +40 -0
  35. data/docs/CommonAccountSettingsRequest.md +36 -0
  36. data/docs/CommonAccountSettingsResponse.md +34 -0
  37. data/docs/ConsumersResponse.md +20 -0
  38. data/docs/ConsumersResponseConsumersInner.md +20 -0
  39. data/docs/CreateApiKeyRequest.md +24 -17
  40. data/docs/CreateIdpRequest.md +30 -0
  41. data/docs/CreateIdpRequestProperties.md +20 -0
  42. data/docs/CreateIdpRequestPropertiesIdp.md +26 -0
  43. data/docs/CreateIdpRequestPropertiesSp.md +32 -0
  44. data/docs/CreateIdpRequestPropertiesSpAuthnContext.md +20 -0
  45. data/docs/CreateIdpRequestSecrets.md +20 -0
  46. data/docs/CreateIdpRequestSecretsIdp.md +22 -0
  47. data/docs/CreateIdpRequestSecretsIdpSigningInner.md +20 -0
  48. data/docs/CreateIdpRequestSecretsSp.md +18 -0
  49. data/docs/CreateIdpRequestSecretsSpSigningInner.md +24 -0
  50. data/docs/CreateProfileLinkRequest.md +24 -0
  51. data/docs/CreateProfileLinkRequestLink.md +26 -0
  52. data/docs/CreateServiceIdGroupRequest.md +22 -0
  53. data/docs/CreateServiceIdRequest.md +18 -15
  54. data/docs/CreateTemplateAssignmentRequest.md +24 -0
  55. data/docs/CreateTrustedProfileRequest.md +24 -0
  56. data/docs/EffectiveAccountSettingsResponse.md +26 -0
  57. data/docs/EnityHistoryRecord.md +18 -17
  58. data/docs/EntityActivity.md +22 -0
  59. data/docs/Error.md +14 -13
  60. data/docs/ExceptionResponse.md +14 -13
  61. data/docs/ExceptionResponseContext.md +30 -29
  62. data/docs/IDPManagementApi.md +692 -0
  63. data/docs/IdBasedMfaEnrollment.md +26 -0
  64. data/docs/IdentityCount.md +20 -0
  65. data/docs/IdentityLimitsUsageRequest.md +42 -0
  66. data/docs/IdentityLimitsUsageResponse.md +44 -0
  67. data/docs/IdentityLimitsUsageResponseApikeysPerIdentity.md +20 -0
  68. data/docs/IdentityLimitsUsageResponseClaimRulesPerGroup.md +20 -0
  69. data/docs/IdentityLimitsUsageResponseClaimRulesPerProfile.md +20 -0
  70. data/docs/IdentityLimitsUsageResponseServiceidsPerGroup.md +20 -0
  71. data/docs/IdentityLimitsUsageResponseTemplateVersionsPerTemplate.md +20 -0
  72. data/docs/IdentityPreferenceResponse.md +28 -0
  73. data/docs/IdentityPreferencesApi.md +304 -0
  74. data/docs/IdentityPreferencesResponse.md +18 -0
  75. data/docs/Idp.md +38 -0
  76. data/docs/LimitCount.md +20 -0
  77. data/docs/ListIdPSettings200Response.md +18 -0
  78. data/docs/ListIdps200Response.md +18 -0
  79. data/docs/MFAEnrollmentStatusApi.md +216 -0
  80. data/docs/MFARequirementsResponse.md +12 -11
  81. data/docs/MfaEnrollmentTypeStatus.md +20 -0
  82. data/docs/MfaOptions.md +15 -0
  83. data/docs/OidcExceptionResponse.md +16 -15
  84. data/docs/PolicyTemplateReference.md +20 -0
  85. data/docs/ProfileClaimRule.md +36 -0
  86. data/docs/ProfileClaimRuleConditions.md +22 -0
  87. data/docs/ProfileClaimRuleList.md +20 -0
  88. data/docs/ProfileClaimRuleRequest.md +30 -0
  89. data/docs/ProfileCount.md +20 -0
  90. data/docs/ProfileIdentitiesResponse.md +20 -0
  91. data/docs/ProfileIdentitiesUpdateRequest.md +18 -0
  92. data/docs/ProfileIdentityRequest.md +24 -0
  93. data/docs/ProfileIdentityResponse.md +26 -0
  94. data/docs/ProfileLink.md +32 -0
  95. data/docs/ProfileLinkLink.md +26 -0
  96. data/docs/ProfileLinkList.md +18 -0
  97. data/docs/Report.md +34 -0
  98. data/docs/ReportMfaEnrollmentStatus.md +28 -0
  99. data/docs/ReportReference.md +18 -0
  100. data/docs/ResponseContext.md +28 -27
  101. data/docs/RetrictActions.md +15 -0
  102. data/docs/SamlMetadataImportResponse.md +42 -0
  103. data/docs/ServiceIDGroupsApi.md +347 -0
  104. data/docs/ServiceIDsApi.md +515 -0
  105. data/docs/ServiceId.md +38 -33
  106. data/docs/ServiceIdGroup.md +34 -0
  107. data/docs/ServiceIdGroupCount.md +20 -0
  108. data/docs/ServiceIdGroupList.md +18 -0
  109. data/docs/ServiceIdList.md +20 -19
  110. data/docs/ShareScope.md +20 -0
  111. data/docs/TemplateAccountSettings.md +40 -0
  112. data/docs/TemplateAccountSettingsAllOfRestrictUserDomains.md +20 -0
  113. data/docs/TemplateAssignmentListResponse.md +30 -0
  114. data/docs/TemplateAssignmentResource.md +18 -0
  115. data/docs/TemplateAssignmentResourceError.md +24 -0
  116. data/docs/TemplateAssignmentResponse.md +48 -0
  117. data/docs/TemplateAssignmentResponseResource.md +24 -0
  118. data/docs/TemplateAssignmentResponseResourceDetail.md +26 -0
  119. data/docs/TemplateCount.md +20 -0
  120. data/docs/TemplateProfileComponentRequest.md +26 -0
  121. data/docs/TemplateProfileComponentResponse.md +26 -0
  122. data/docs/TestResult.md +28 -0
  123. data/docs/TestResultStepsInner.md +24 -0
  124. data/docs/TestTriggerResponse.md +20 -0
  125. data/docs/TokenResponse.md +18 -17
  126. data/docs/TokenRetrievalApi.md +461 -0
  127. data/docs/TrustedProfile.md +50 -0
  128. data/docs/TrustedProfileTemplateApi.md +720 -0
  129. data/docs/TrustedProfileTemplateAssignmentsApi.md +376 -0
  130. data/docs/TrustedProfileTemplateClaimRule.md +26 -0
  131. data/docs/TrustedProfileTemplateList.md +30 -0
  132. data/docs/TrustedProfileTemplateRequest.md +28 -0
  133. data/docs/TrustedProfileTemplateResponse.md +48 -0
  134. data/docs/TrustedProfilesApi.md +1414 -0
  135. data/docs/TrustedProfilesList.md +30 -0
  136. data/docs/UpdateAccountIdpSettingRequest.md +22 -0
  137. data/docs/UpdateAccountLoginSettings.md +18 -0
  138. data/docs/UpdateApiKeyRequest.md +16 -9
  139. data/docs/UpdateIdPRequest.md +28 -0
  140. data/docs/UpdateIdPRequestProperties.md +20 -0
  141. data/docs/UpdateIdPRequestPropertiesIdp.md +24 -0
  142. data/docs/UpdateIdPRequestSecrets.md +20 -0
  143. data/docs/UpdateIdPRequestSecretsIdp.md +20 -0
  144. data/docs/UpdatePreferenceRequest.md +20 -0
  145. data/docs/UpdateServiceIdGroupRequest.md +20 -0
  146. data/docs/UpdateServiceIdRequest.md +12 -11
  147. data/docs/UpdateTemplateAssignmentRequest.md +18 -0
  148. data/docs/UpdateTrustedProfileRequest.md +22 -0
  149. data/docs/UserActivity.md +26 -0
  150. data/docs/UserMFAResolved.md +24 -0
  151. data/docs/UserMfa.md +20 -0
  152. data/docs/UserMfaEnrollments.md +24 -0
  153. data/docs/UserReportMfaEnrollmentStatus.md +30 -0
  154. data/docs/UserVisbilityRetrictActions.md +15 -0
  155. data/docs/UserVisbilityRetrictActionsForTemplate.md +15 -0
  156. data/git_push.sh +3 -4
  157. data/ibm_cloud_iam.gemspec +6 -6
  158. data/lib/ibm_cloud_iam/api/account_limits_api.rb +208 -0
  159. data/lib/ibm_cloud_iam/api/account_settings_api.rb +262 -0
  160. data/lib/ibm_cloud_iam/api/account_settings_for_id_p_api.rb +571 -0
  161. data/lib/ibm_cloud_iam/api/account_settings_template_api.rb +823 -0
  162. data/lib/ibm_cloud_iam/api/account_settings_template_assignments_api.rb +422 -0
  163. data/lib/ibm_cloud_iam/api/activities_api.rb +174 -0
  164. data/lib/ibm_cloud_iam/api/api_keys_api.rb +786 -0
  165. data/lib/ibm_cloud_iam/api/identity_preferences_api.rb +357 -0
  166. data/lib/ibm_cloud_iam/api/idp_management_api.rb +744 -0
  167. data/lib/ibm_cloud_iam/api/mfa_enrollment_status_api.rb +248 -0
  168. data/lib/ibm_cloud_iam/api/service_id_groups_api.rb +392 -0
  169. data/lib/ibm_cloud_iam/api/service_ids_api.rb +575 -0
  170. data/lib/ibm_cloud_iam/api/token_retrieval_api.rb +557 -0
  171. data/lib/ibm_cloud_iam/api/trusted_profile_template_api.rb +823 -0
  172. data/lib/ibm_cloud_iam/api/trusted_profile_template_assignments_api.rb +422 -0
  173. data/lib/ibm_cloud_iam/api/trusted_profiles_api.rb +1630 -0
  174. data/lib/ibm_cloud_iam/api_client.rb +74 -65
  175. data/lib/ibm_cloud_iam/api_error.rb +4 -3
  176. data/lib/ibm_cloud_iam/api_model_base.rb +88 -0
  177. data/lib/ibm_cloud_iam/configuration.rb +75 -15
  178. data/lib/ibm_cloud_iam/models/access_group_count.rb +159 -0
  179. data/lib/ibm_cloud_iam/models/account_based_mfa_enrollment.rb +243 -0
  180. data/lib/ibm_cloud_iam/models/account_idp_settings.rb +244 -0
  181. data/lib/ibm_cloud_iam/models/account_login_settings.rb +147 -0
  182. data/lib/ibm_cloud_iam/models/account_settings_assigned_templates_section.rb +377 -0
  183. data/lib/ibm_cloud_iam/models/account_settings_effective_section.rb +282 -0
  184. data/lib/ibm_cloud_iam/models/account_settings_meta.rb +179 -0
  185. data/lib/ibm_cloud_iam/models/account_settings_request.rb +301 -0
  186. data/lib/ibm_cloud_iam/models/account_settings_response.rb +567 -0
  187. data/lib/ibm_cloud_iam/models/account_settings_template_list.rb +256 -0
  188. data/lib/ibm_cloud_iam/models/account_settings_template_request.rb +178 -0
  189. data/lib/ibm_cloud_iam/models/account_settings_template_response.rb +416 -0
  190. data/lib/ibm_cloud_iam/models/account_settings_user_domain_restriction.rb +188 -0
  191. data/lib/ibm_cloud_iam/models/account_settings_user_mfa_response.rb +261 -0
  192. data/lib/ibm_cloud_iam/models/action_controls.rb +199 -0
  193. data/lib/ibm_cloud_iam/models/action_controls_identities.rb +190 -0
  194. data/lib/ibm_cloud_iam/models/activity.rb +175 -0
  195. data/lib/ibm_cloud_iam/models/add_account_idp_setting_request.rb +243 -0
  196. data/lib/ibm_cloud_iam/models/api_key.rb +188 -104
  197. data/lib/ibm_cloud_iam/models/api_key_inside_create_service_id_request.rb +70 -99
  198. data/lib/ibm_cloud_iam/models/api_key_list.rb +46 -95
  199. data/lib/ibm_cloud_iam/models/apikey_activity.rb +231 -0
  200. data/lib/ibm_cloud_iam/models/apikey_activity_serviceid.rb +159 -0
  201. data/lib/ibm_cloud_iam/models/apikey_activity_user.rb +179 -0
  202. data/lib/ibm_cloud_iam/models/assigned_templates_account_settings.rb +296 -0
  203. data/lib/ibm_cloud_iam/models/common_account_settings_request.rb +272 -0
  204. data/lib/ibm_cloud_iam/models/common_account_settings_response.rb +260 -0
  205. data/lib/ibm_cloud_iam/models/consumers_response.rb +158 -0
  206. data/lib/ibm_cloud_iam/models/consumers_response_consumers_inner.rb +158 -0
  207. data/lib/ibm_cloud_iam/models/create_api_key_request.rb +92 -99
  208. data/lib/ibm_cloud_iam/models/create_idp_request.rb +283 -0
  209. data/lib/ibm_cloud_iam/models/create_idp_request_properties.rb +157 -0
  210. data/lib/ibm_cloud_iam/models/create_idp_request_properties_idp.rb +189 -0
  211. data/lib/ibm_cloud_iam/models/create_idp_request_properties_sp.rb +222 -0
  212. data/lib/ibm_cloud_iam/models/create_idp_request_properties_sp_authn_context.rb +163 -0
  213. data/lib/ibm_cloud_iam/models/create_idp_request_secrets.rb +157 -0
  214. data/lib/ibm_cloud_iam/models/create_idp_request_secrets_idp.rb +173 -0
  215. data/lib/ibm_cloud_iam/models/create_idp_request_secrets_idp_signing_inner.rb +192 -0
  216. data/lib/ibm_cloud_iam/models/create_idp_request_secrets_sp.rb +151 -0
  217. data/lib/ibm_cloud_iam/models/create_idp_request_secrets_sp_signing_inner.rb +212 -0
  218. data/lib/ibm_cloud_iam/models/create_profile_link_request.rb +211 -0
  219. data/lib/ibm_cloud_iam/models/create_profile_link_request_link.rb +206 -0
  220. data/lib/ibm_cloud_iam/models/create_service_id_group_request.rb +203 -0
  221. data/lib/ibm_cloud_iam/models/create_service_id_request.rb +68 -95
  222. data/lib/ibm_cloud_iam/models/create_template_assignment_request.rb +280 -0
  223. data/lib/ibm_cloud_iam/models/create_trusted_profile_request.rb +213 -0
  224. data/lib/ibm_cloud_iam/models/effective_account_settings_response.rb +239 -0
  225. data/lib/ibm_cloud_iam/models/enity_history_record.rb +112 -101
  226. data/lib/ibm_cloud_iam/models/entity_activity.rb +185 -0
  227. data/lib/ibm_cloud_iam/models/error.rb +69 -94
  228. data/lib/ibm_cloud_iam/models/exception_response.rb +57 -94
  229. data/lib/ibm_cloud_iam/models/exception_response_context.rb +33 -94
  230. data/lib/ibm_cloud_iam/models/id_based_mfa_enrollment.rb +270 -0
  231. data/lib/ibm_cloud_iam/models/identity_count.rb +159 -0
  232. data/lib/ibm_cloud_iam/models/identity_limits_usage_request.rb +283 -0
  233. data/lib/ibm_cloud_iam/models/identity_limits_usage_response.rb +265 -0
  234. data/lib/ibm_cloud_iam/models/identity_limits_usage_response_apikeys_per_identity.rb +178 -0
  235. data/lib/ibm_cloud_iam/models/identity_limits_usage_response_claim_rules_per_group.rb +178 -0
  236. data/lib/ibm_cloud_iam/models/identity_limits_usage_response_claim_rules_per_profile.rb +178 -0
  237. data/lib/ibm_cloud_iam/models/identity_limits_usage_response_serviceids_per_group.rb +178 -0
  238. data/lib/ibm_cloud_iam/models/identity_limits_usage_response_template_versions_per_template.rb +178 -0
  239. data/lib/ibm_cloud_iam/models/identity_preference_response.rb +200 -0
  240. data/lib/ibm_cloud_iam/models/identity_preferences_response.rb +167 -0
  241. data/lib/ibm_cloud_iam/models/idp.rb +239 -0
  242. data/lib/ibm_cloud_iam/models/limit_count.rb +176 -0
  243. data/lib/ibm_cloud_iam/models/list_id_p_settings200_response.rb +149 -0
  244. data/lib/ibm_cloud_iam/models/list_idps200_response.rb +149 -0
  245. data/lib/ibm_cloud_iam/models/mfa_enrollment_type_status.rb +192 -0
  246. data/lib/ibm_cloud_iam/models/mfa_options.rb +45 -0
  247. data/lib/ibm_cloud_iam/models/mfa_requirements_response.rb +69 -94
  248. data/lib/ibm_cloud_iam/models/oidc_exception_response.rb +57 -94
  249. data/lib/ibm_cloud_iam/models/policy_template_reference.rb +193 -0
  250. data/lib/ibm_cloud_iam/models/profile_claim_rule.rb +342 -0
  251. data/lib/ibm_cloud_iam/models/profile_claim_rule_conditions.rb +219 -0
  252. data/lib/ibm_cloud_iam/models/profile_claim_rule_list.rb +176 -0
  253. data/lib/ibm_cloud_iam/models/profile_claim_rule_request.rb +243 -0
  254. data/lib/ibm_cloud_iam/models/profile_count.rb +159 -0
  255. data/lib/ibm_cloud_iam/models/profile_identities_response.rb +160 -0
  256. data/lib/ibm_cloud_iam/models/profile_identities_update_request.rb +150 -0
  257. data/lib/ibm_cloud_iam/models/profile_identity_request.rb +238 -0
  258. data/lib/ibm_cloud_iam/models/profile_identity_response.rb +265 -0
  259. data/lib/ibm_cloud_iam/models/profile_link.rb +320 -0
  260. data/lib/ibm_cloud_iam/models/profile_link_link.rb +188 -0
  261. data/lib/ibm_cloud_iam/models/profile_link_list.rb +167 -0
  262. data/lib/ibm_cloud_iam/models/report.rb +321 -0
  263. data/lib/ibm_cloud_iam/models/report_mfa_enrollment_status.rb +268 -0
  264. data/lib/ibm_cloud_iam/models/report_reference.rb +165 -0
  265. data/lib/ibm_cloud_iam/models/response_context.rb +33 -94
  266. data/lib/ibm_cloud_iam/models/retrict_actions.rb +41 -0
  267. data/lib/ibm_cloud_iam/models/saml_metadata_import_response.rb +494 -0
  268. data/lib/ibm_cloud_iam/models/service_id.rb +184 -108
  269. data/lib/ibm_cloud_iam/models/service_id_group.rb +313 -0
  270. data/lib/ibm_cloud_iam/models/service_id_group_count.rb +159 -0
  271. data/lib/ibm_cloud_iam/models/service_id_group_list.rb +167 -0
  272. data/lib/ibm_cloud_iam/models/service_id_list.rb +47 -96
  273. data/lib/ibm_cloud_iam/models/share_scope.rb +190 -0
  274. data/lib/ibm_cloud_iam/models/template_account_settings.rb +296 -0
  275. data/lib/ibm_cloud_iam/models/template_account_settings_all_of_restrict_user_domains.rb +159 -0
  276. data/lib/ibm_cloud_iam/models/template_assignment_list_response.rb +227 -0
  277. data/lib/ibm_cloud_iam/models/template_assignment_resource.rb +149 -0
  278. data/lib/ibm_cloud_iam/models/template_assignment_resource_error.rb +179 -0
  279. data/lib/ibm_cloud_iam/models/template_assignment_response.rb +506 -0
  280. data/lib/ibm_cloud_iam/models/template_assignment_response_resource.rb +196 -0
  281. data/lib/ibm_cloud_iam/models/template_assignment_response_resource_detail.rb +203 -0
  282. data/lib/ibm_cloud_iam/models/template_count.rb +159 -0
  283. data/lib/ibm_cloud_iam/models/template_profile_component_request.rb +210 -0
  284. data/lib/ibm_cloud_iam/models/template_profile_component_response.rb +210 -0
  285. data/lib/ibm_cloud_iam/models/test_result.rb +194 -0
  286. data/lib/ibm_cloud_iam/models/test_result_steps_inner.rb +174 -0
  287. data/lib/ibm_cloud_iam/models/test_trigger_response.rb +156 -0
  288. data/lib/ibm_cloud_iam/models/token_response.rb +34 -105
  289. data/lib/ibm_cloud_iam/models/trusted_profile.rb +411 -0
  290. data/lib/ibm_cloud_iam/models/trusted_profile_template_claim_rule.rb +248 -0
  291. data/lib/ibm_cloud_iam/models/trusted_profile_template_list.rb +256 -0
  292. data/lib/ibm_cloud_iam/models/trusted_profile_template_request.rb +199 -0
  293. data/lib/ibm_cloud_iam/models/trusted_profile_template_response.rb +369 -0
  294. data/lib/ibm_cloud_iam/models/trusted_profiles_list.rb +227 -0
  295. data/lib/ibm_cloud_iam/models/update_account_idp_setting_request.rb +202 -0
  296. data/lib/ibm_cloud_iam/models/update_account_login_settings.rb +148 -0
  297. data/lib/ibm_cloud_iam/models/update_api_key_request.rb +68 -99
  298. data/lib/ibm_cloud_iam/models/update_id_p_request.rb +198 -0
  299. data/lib/ibm_cloud_iam/models/update_id_p_request_properties.rb +157 -0
  300. data/lib/ibm_cloud_iam/models/update_id_p_request_properties_idp.rb +179 -0
  301. data/lib/ibm_cloud_iam/models/update_id_p_request_secrets.rb +157 -0
  302. data/lib/ibm_cloud_iam/models/update_id_p_request_secrets_idp.rb +163 -0
  303. data/lib/ibm_cloud_iam/models/update_preference_request.rb +161 -0
  304. data/lib/ibm_cloud_iam/models/update_service_id_group_request.rb +176 -0
  305. data/lib/ibm_cloud_iam/models/update_service_id_request.rb +34 -95
  306. data/lib/ibm_cloud_iam/models/update_template_assignment_request.rb +175 -0
  307. data/lib/ibm_cloud_iam/models/update_trusted_profile_request.rb +169 -0
  308. data/lib/ibm_cloud_iam/models/user_activity.rb +222 -0
  309. data/lib/ibm_cloud_iam/models/user_mfa.rb +179 -0
  310. data/lib/ibm_cloud_iam/models/user_mfa_enrollments.rb +193 -0
  311. data/lib/ibm_cloud_iam/models/user_mfa_resolved.rb +178 -0
  312. data/lib/ibm_cloud_iam/models/user_report_mfa_enrollment_status.rb +291 -0
  313. data/lib/ibm_cloud_iam/models/user_visbility_retrict_actions.rb +40 -0
  314. data/lib/ibm_cloud_iam/models/user_visbility_retrict_actions_for_template.rb +41 -0
  315. data/lib/ibm_cloud_iam/version.rb +4 -4
  316. data/lib/ibm_cloud_iam.rb +140 -9
  317. data/spec/api/account_limits_api_spec.rb +75 -0
  318. data/spec/api/account_settings_api_spec.rb +80 -0
  319. data/spec/api/account_settings_for_id_p_api_spec.rb +132 -0
  320. data/spec/api/account_settings_template_api_spec.rb +184 -0
  321. data/spec/api/account_settings_template_assignments_api_spec.rb +112 -0
  322. data/spec/api/activities_api_spec.rb +64 -0
  323. data/spec/api/api_keys_api_spec.rb +182 -0
  324. data/spec/api/identity_preferences_api_spec.rb +98 -0
  325. data/spec/api/idp_management_api_spec.rb +166 -0
  326. data/spec/api/mfa_enrollment_status_api_spec.rb +77 -0
  327. data/spec/api/service_id_groups_api_spec.rb +102 -0
  328. data/spec/api/service_ids_api_spec.rb +143 -0
  329. data/spec/api/token_retrieval_api_spec.rb +134 -0
  330. data/spec/api/trusted_profile_template_api_spec.rb +184 -0
  331. data/spec/api/trusted_profile_template_assignments_api_spec.rb +112 -0
  332. data/spec/api/trusted_profiles_api_spec.rb +328 -0
  333. data/spec/models/access_group_count_spec.rb +42 -0
  334. data/spec/models/account_based_mfa_enrollment_spec.rb +54 -0
  335. data/spec/models/account_idp_settings_spec.rb +82 -0
  336. data/spec/models/account_login_settings_spec.rb +36 -0
  337. data/spec/models/account_settings_assigned_templates_section_spec.rb +120 -0
  338. data/spec/models/account_settings_effective_section_spec.rb +96 -0
  339. data/spec/models/account_settings_meta_spec.rb +54 -0
  340. data/spec/models/account_settings_request_spec.rb +102 -0
  341. data/spec/models/account_settings_response_spec.rb +126 -0
  342. data/spec/models/account_settings_template_list_spec.rb +72 -0
  343. data/spec/models/account_settings_template_request_spec.rb +54 -0
  344. data/spec/models/account_settings_template_response_spec.rb +114 -0
  345. data/spec/models/account_settings_user_domain_restriction_spec.rb +48 -0
  346. data/spec/models/account_settings_user_mfa_response_spec.rb +66 -0
  347. data/spec/models/action_controls_identities_spec.rb +42 -0
  348. data/spec/models/action_controls_spec.rb +48 -0
  349. data/spec/models/activity_spec.rb +42 -0
  350. data/spec/models/add_account_idp_setting_request_spec.rb +52 -0
  351. data/spec/models/api_key_inside_create_service_id_request_spec.rb +24 -17
  352. data/spec/models/api_key_list_spec.rb +15 -20
  353. data/spec/models/api_key_spec.rb +52 -27
  354. data/spec/models/apikey_activity_serviceid_spec.rb +42 -0
  355. data/spec/models/apikey_activity_spec.rb +66 -0
  356. data/spec/models/apikey_activity_user_spec.rb +54 -0
  357. data/spec/models/assigned_templates_account_settings_spec.rb +102 -0
  358. data/spec/models/common_account_settings_request_spec.rb +90 -0
  359. data/spec/models/common_account_settings_response_spec.rb +84 -0
  360. data/spec/models/consumers_response_consumers_inner_spec.rb +42 -0
  361. data/spec/models/consumers_response_spec.rb +42 -0
  362. data/spec/models/create_api_key_request_spec.rb +32 -19
  363. data/spec/models/create_idp_request_properties_idp_spec.rb +60 -0
  364. data/spec/models/create_idp_request_properties_sp_authn_context_spec.rb +42 -0
  365. data/spec/models/create_idp_request_properties_sp_spec.rb +78 -0
  366. data/spec/models/create_idp_request_properties_spec.rb +42 -0
  367. data/spec/models/create_idp_request_secrets_idp_signing_inner_spec.rb +46 -0
  368. data/spec/models/create_idp_request_secrets_idp_spec.rb +48 -0
  369. data/spec/models/create_idp_request_secrets_sp_signing_inner_spec.rb +58 -0
  370. data/spec/models/create_idp_request_secrets_sp_spec.rb +36 -0
  371. data/spec/models/create_idp_request_secrets_spec.rb +42 -0
  372. data/spec/models/create_idp_request_spec.rb +76 -0
  373. data/spec/models/create_profile_link_request_link_spec.rb +60 -0
  374. data/spec/models/create_profile_link_request_spec.rb +54 -0
  375. data/spec/models/create_service_id_group_request_spec.rb +48 -0
  376. data/spec/models/create_service_id_request_spec.rb +19 -18
  377. data/spec/models/create_template_assignment_request_spec.rb +58 -0
  378. data/spec/models/create_trusted_profile_request_spec.rb +54 -0
  379. data/spec/models/effective_account_settings_response_spec.rb +60 -0
  380. data/spec/models/enity_history_record_spec.rb +14 -19
  381. data/spec/models/entity_activity_spec.rb +48 -0
  382. data/spec/models/error_spec.rb +12 -17
  383. data/spec/models/exception_response_context_spec.rb +20 -25
  384. data/spec/models/exception_response_spec.rb +12 -17
  385. data/spec/models/id_based_mfa_enrollment_spec.rb +64 -0
  386. data/spec/models/identity_count_spec.rb +42 -0
  387. data/spec/models/identity_limits_usage_request_spec.rb +108 -0
  388. data/spec/models/identity_limits_usage_response_apikeys_per_identity_spec.rb +42 -0
  389. data/spec/models/identity_limits_usage_response_claim_rules_per_group_spec.rb +42 -0
  390. data/spec/models/identity_limits_usage_response_claim_rules_per_profile_spec.rb +42 -0
  391. data/spec/models/identity_limits_usage_response_serviceids_per_group_spec.rb +42 -0
  392. data/spec/models/identity_limits_usage_response_spec.rb +114 -0
  393. data/spec/models/identity_limits_usage_response_template_versions_per_template_spec.rb +42 -0
  394. data/spec/models/identity_preference_response_spec.rb +66 -0
  395. data/spec/models/identity_preferences_response_spec.rb +36 -0
  396. data/spec/models/idp_spec.rb +96 -0
  397. data/spec/models/limit_count_spec.rb +42 -0
  398. data/spec/models/list_id_p_settings200_response_spec.rb +36 -0
  399. data/spec/models/list_idps200_response_spec.rb +36 -0
  400. data/spec/models/mfa_enrollment_type_status_spec.rb +42 -0
  401. data/spec/models/mfa_options_spec.rb +30 -0
  402. data/spec/models/mfa_requirements_response_spec.rb +11 -16
  403. data/spec/models/oidc_exception_response_spec.rb +13 -18
  404. data/spec/models/policy_template_reference_spec.rb +42 -0
  405. data/spec/models/profile_claim_rule_conditions_spec.rb +48 -0
  406. data/spec/models/profile_claim_rule_list_spec.rb +42 -0
  407. data/spec/models/profile_claim_rule_request_spec.rb +72 -0
  408. data/spec/models/profile_claim_rule_spec.rb +90 -0
  409. data/spec/models/profile_count_spec.rb +42 -0
  410. data/spec/models/profile_identities_response_spec.rb +42 -0
  411. data/spec/models/profile_identities_update_request_spec.rb +36 -0
  412. data/spec/models/profile_identity_request_spec.rb +58 -0
  413. data/spec/models/profile_identity_response_spec.rb +64 -0
  414. data/spec/models/profile_link_link_spec.rb +60 -0
  415. data/spec/models/profile_link_list_spec.rb +36 -0
  416. data/spec/models/profile_link_spec.rb +78 -0
  417. data/spec/models/report_mfa_enrollment_status_spec.rb +66 -0
  418. data/spec/models/report_reference_spec.rb +36 -0
  419. data/spec/models/report_spec.rb +84 -0
  420. data/spec/models/response_context_spec.rb +19 -24
  421. data/spec/models/retrict_actions_spec.rb +30 -0
  422. data/spec/models/saml_metadata_import_response_spec.rb +112 -0
  423. data/spec/models/service_id_group_count_spec.rb +42 -0
  424. data/spec/models/service_id_group_list_spec.rb +36 -0
  425. data/spec/models/service_id_group_spec.rb +84 -0
  426. data/spec/models/service_id_list_spec.rb +15 -20
  427. data/spec/models/service_id_spec.rb +34 -27
  428. data/spec/models/share_scope_spec.rb +46 -0
  429. data/spec/models/template_account_settings_all_of_restrict_user_domains_spec.rb +42 -0
  430. data/spec/models/template_account_settings_spec.rb +102 -0
  431. data/spec/models/template_assignment_list_response_spec.rb +72 -0
  432. data/spec/models/template_assignment_resource_error_spec.rb +54 -0
  433. data/spec/models/template_assignment_resource_spec.rb +36 -0
  434. data/spec/models/template_assignment_response_resource_detail_spec.rb +60 -0
  435. data/spec/models/template_assignment_response_resource_spec.rb +54 -0
  436. data/spec/models/template_assignment_response_spec.rb +126 -0
  437. data/spec/models/template_count_spec.rb +42 -0
  438. data/spec/models/template_profile_component_request_spec.rb +60 -0
  439. data/spec/models/template_profile_component_response_spec.rb +60 -0
  440. data/spec/models/test_result_spec.rb +66 -0
  441. data/spec/models/test_result_steps_inner_spec.rb +54 -0
  442. data/spec/models/test_trigger_response_spec.rb +42 -0
  443. data/spec/models/token_response_spec.rb +14 -19
  444. data/spec/models/trusted_profile_spec.rb +132 -0
  445. data/spec/models/trusted_profile_template_claim_rule_spec.rb +64 -0
  446. data/spec/models/trusted_profile_template_list_spec.rb +72 -0
  447. data/spec/models/trusted_profile_template_request_spec.rb +66 -0
  448. data/spec/models/trusted_profile_template_response_spec.rb +126 -0
  449. data/spec/models/trusted_profiles_list_spec.rb +72 -0
  450. data/spec/models/update_account_idp_setting_request_spec.rb +52 -0
  451. data/spec/models/update_account_login_settings_spec.rb +36 -0
  452. data/spec/models/update_api_key_request_spec.rb +28 -15
  453. data/spec/models/update_id_p_request_properties_idp_spec.rb +54 -0
  454. data/spec/models/update_id_p_request_properties_spec.rb +42 -0
  455. data/spec/models/update_id_p_request_secrets_idp_spec.rb +42 -0
  456. data/spec/models/update_id_p_request_secrets_spec.rb +42 -0
  457. data/spec/models/update_id_p_request_spec.rb +66 -0
  458. data/spec/models/update_preference_request_spec.rb +42 -0
  459. data/spec/models/update_service_id_group_request_spec.rb +42 -0
  460. data/spec/models/update_service_id_request_spec.rb +11 -16
  461. data/spec/models/update_template_assignment_request_spec.rb +36 -0
  462. data/spec/models/update_trusted_profile_request_spec.rb +48 -0
  463. data/spec/models/user_activity_spec.rb +60 -0
  464. data/spec/models/user_mfa_enrollments_spec.rb +54 -0
  465. data/spec/models/user_mfa_resolved_spec.rb +54 -0
  466. data/spec/models/user_mfa_spec.rb +42 -0
  467. data/spec/models/user_report_mfa_enrollment_status_spec.rb +72 -0
  468. data/spec/models/user_visbility_retrict_actions_for_template_spec.rb +30 -0
  469. data/spec/models/user_visbility_retrict_actions_spec.rb +30 -0
  470. data/spec/spec_helper.rb +3 -3
  471. metadata +549 -35
  472. data/docs/IdentityOperationsApi.md +0 -828
  473. data/docs/InlineObject.md +0 -19
  474. data/docs/InlineObject1.md +0 -23
  475. data/docs/InlineObject2.md +0 -21
  476. data/docs/InlineObject3.md +0 -25
  477. data/docs/TokenOperationsApi.md +0 -226
  478. data/lib/ibm_cloud_iam/api/identity_operations_api.rb +0 -1083
  479. data/lib/ibm_cloud_iam/api/token_operations_api.rb +0 -351
  480. data/lib/ibm_cloud_iam/models/inline_object.rb +0 -229
  481. data/lib/ibm_cloud_iam/models/inline_object1.rb +0 -254
  482. data/lib/ibm_cloud_iam/models/inline_object2.rb +0 -244
  483. data/lib/ibm_cloud_iam/models/inline_object3.rb +0 -269
  484. data/spec/api/identity_operations_api_spec.rb +0 -253
  485. data/spec/api/token_operations_api_spec.rb +0 -94
  486. data/spec/api_client_spec.rb +0 -226
  487. data/spec/configuration_spec.rb +0 -42
  488. data/spec/models/inline_object1_spec.rb +0 -59
  489. data/spec/models/inline_object2_spec.rb +0 -53
  490. data/spec/models/inline_object3_spec.rb +0 -65
  491. data/spec/models/inline_object_spec.rb +0 -47
@@ -0,0 +1,149 @@
1
+ # IbmCloudIam::ActivitiesApi
2
+
3
+ All URIs are relative to *https://iam.cloud.ibm.com*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**create_report**](ActivitiesApi.md#create_report) | **POST** /v1/activity/accounts/{account_id}/report | Trigger activity report for the account |
8
+ | [**get_report**](ActivitiesApi.md#get_report) | **GET** /v1/activity/accounts/{account_id}/report/{reference} | Get activity report for the account |
9
+
10
+
11
+ ## create_report
12
+
13
+ > <ReportReference> create_report(account_id, authorization, opts)
14
+
15
+ Trigger activity report for the account
16
+
17
+ Trigger activity report for the account by specifying the account ID. It can take a few minutes to generate the report for retrieval.
18
+
19
+ ### Examples
20
+
21
+ ```ruby
22
+ require 'time'
23
+ require 'ibm_cloud_iam'
24
+
25
+ api_instance = IbmCloudIam::ActivitiesApi.new
26
+ account_id = 'account_id_example' # String | ID of the account
27
+ 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.
28
+ opts = {
29
+ type: 'type_example', # String | Optional report type. The supported value is 'inactive'. List all identities that have not authenticated within the time indicated by duration.
30
+ duration: 'duration_example' # String | Optional duration of the report. The supported unit of duration is hours.
31
+ }
32
+
33
+ begin
34
+ # Trigger activity report for the account
35
+ result = api_instance.create_report(account_id, authorization, opts)
36
+ p result
37
+ rescue IbmCloudIam::ApiError => e
38
+ puts "Error when calling ActivitiesApi->create_report: #{e}"
39
+ end
40
+ ```
41
+
42
+ #### Using the create_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_report_with_http_info(account_id, authorization, opts)
47
+
48
+ ```ruby
49
+ begin
50
+ # Trigger activity report for the account
51
+ data, status_code, headers = api_instance.create_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 ActivitiesApi->create_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;inactive&#39;. List all identities that have not authenticated within the time indicated by duration. | [optional][default to &#39;inactive&#39;] |
67
+ | **duration** | **String** | Optional duration of the report. The supported unit of duration is hours. | [optional][default to &#39;720&#39;] |
68
+
69
+ ### Return type
70
+
71
+ [**ReportReference**](ReportReference.md)
72
+
73
+ ### Authorization
74
+
75
+ No authorization required
76
+
77
+ ### HTTP request headers
78
+
79
+ - **Content-Type**: Not defined
80
+ - **Accept**: application/json
81
+
82
+
83
+ ## get_report
84
+
85
+ > <Report> get_report(account_id, reference, authorization)
86
+
87
+ Get activity report for the account
88
+
89
+ Get activity 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.
90
+
91
+ ### Examples
92
+
93
+ ```ruby
94
+ require 'time'
95
+ require 'ibm_cloud_iam'
96
+
97
+ api_instance = IbmCloudIam::ActivitiesApi.new
98
+ account_id = 'account_id_example' # String | ID of the account
99
+ reference = 'reference_example' # String | Reference for the report to be generated, You can use 'latest' to get the latest report for the given account.
100
+ 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.
101
+
102
+ begin
103
+ # Get activity report for the account
104
+ result = api_instance.get_report(account_id, reference, authorization)
105
+ p result
106
+ rescue IbmCloudIam::ApiError => e
107
+ puts "Error when calling ActivitiesApi->get_report: #{e}"
108
+ end
109
+ ```
110
+
111
+ #### Using the get_report_with_http_info variant
112
+
113
+ This returns an Array which contains the response data, status code and headers.
114
+
115
+ > <Array(<Report>, Integer, Hash)> get_report_with_http_info(account_id, reference, authorization)
116
+
117
+ ```ruby
118
+ begin
119
+ # Get activity report for the account
120
+ data, status_code, headers = api_instance.get_report_with_http_info(account_id, reference, authorization)
121
+ p status_code # => 2xx
122
+ p headers # => { ... }
123
+ p data # => <Report>
124
+ rescue IbmCloudIam::ApiError => e
125
+ puts "Error when calling ActivitiesApi->get_report_with_http_info: #{e}"
126
+ end
127
+ ```
128
+
129
+ ### Parameters
130
+
131
+ | Name | Type | Description | Notes |
132
+ | ---- | ---- | ----------- | ----- |
133
+ | **account_id** | **String** | ID of the account | |
134
+ | **reference** | **String** | Reference for the report to be generated, You can use &#39;latest&#39; to get the latest report for the given account. | |
135
+ | **authorization** | **String** | Authorization Token used for the request. The supported token type is a Cloud IAM Access Token. If the token is omitted the request will fail with BXNIM0308E: &#39;No authorization header found&#39;. Make sure that the provided token has the required authority for the request. | |
136
+
137
+ ### Return type
138
+
139
+ [**Report**](Report.md)
140
+
141
+ ### Authorization
142
+
143
+ No authorization required
144
+
145
+ ### HTTP request headers
146
+
147
+ - **Content-Type**: Not defined
148
+ - **Accept**: application/json
149
+
data/docs/Activity.md ADDED
@@ -0,0 +1,20 @@
1
+ # IbmCloudIam::Activity
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **last_authn** | **String** | Time when the entity was last authenticated. | [optional] |
8
+ | **authn_count** | **Integer** | Authentication count, number of times the entity was authenticated. | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'ibm_cloud_iam'
14
+
15
+ instance = IbmCloudIam::Activity.new(
16
+ last_authn: null,
17
+ authn_count: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,22 @@
1
+ # IbmCloudIam::AddAccountIdpSettingRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **cloud_user_strategy** | **String** | Strategy how Cloud User representives for the IdP users are handled | |
8
+ | **active** | **Boolean** | Specifies if the IdP is enabled for usage in the given account context | |
9
+ | **ui_default** | **Boolean** | Specifies if the IdP is used as default in the given account context | |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'ibm_cloud_iam'
15
+
16
+ instance = IbmCloudIam::AddAccountIdpSettingRequest.new(
17
+ cloud_user_strategy: null,
18
+ active: null,
19
+ ui_default: null
20
+ )
21
+ ```
22
+
data/docs/ApiKey.md CHANGED
@@ -2,42 +2,53 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **context** | [**ResponseContext**](ResponseContext.md) | | [optional]
8
- **id** | **String** | Unique identifier of this API Key. |
9
- **entity_tag** | **String** | Version of the API Key details object. You need to specify this value when updating the API key to avoid stale updates. | [optional]
10
- **crn** | **String** | Cloud Resource Name of the item. Example Cloud Resource Name: &#39;crn:v1:bluemix:public:iam-identity:us-south:a/myaccount::apikey:1234-9012-5678&#39; |
11
- **locked** | **Boolean** | The API key cannot be changed if set to true. |
12
- **created_at** | **DateTime** | If set contains a date time string of the creation date in ISO format | [optional]
13
- **created_by** | **String** | IAM ID of the user or service which created the API key. |
14
- **modified_at** | **DateTime** | If set contains a date time string of the last modification date in ISO format | [optional]
15
- **name** | **String** | Name of the API key. The name is not checked for uniqueness. Therefore multiple names with the same value can exist. Access is done via the UUID of the API key. |
16
- **description** | **String** | The optional description of the API key. The &#39;description&#39; property is only available if a description was provided during a create of an API key. | [optional]
17
- **iam_id** | **String** | The iam_id that this API key authenticates. |
18
- **account_id** | **String** | ID of the account that this API key authenticates for. |
19
- **apikey** | **String** | The API key value. This property only contains the API key value for the following cases: create an API key, update a service ID API key that stores the API key value as retrievable, or get a service ID API key that stores the API key value as retrievable. All other operations don&#39;t return the API key value, for example all user API key related operations, except for create, don&#39;t contain the API key value. |
20
- **history** | [**Array&lt;EnityHistoryRecord&gt;**](EnityHistoryRecord.md) | History of the API key | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **context** | [**ResponseContext**](ResponseContext.md) | | [optional] |
8
+ | **id** | **String** | Unique identifier of this API Key. | |
9
+ | **entity_tag** | **String** | Version of the API Key details object. You need to specify this value when updating the API key to avoid stale updates. | [optional] |
10
+ | **crn** | **String** | Cloud Resource Name of the item. Example Cloud Resource Name: &#39;crn:v1:bluemix:public:iam-identity:us-south:a/myaccount::apikey:1234-9012-5678&#39; | |
11
+ | **locked** | **Boolean** | The API key cannot be changed if set to true. | |
12
+ | **disabled** | **Boolean** | Defines if API key is disabled, API key cannot be used if &#39;disabled&#39; is set to true. | [optional] |
13
+ | **created_at** | **Time** | If set contains a date time string of the creation date in ISO format. | [optional] |
14
+ | **created_by** | **String** | IAM ID of the user or service which created the API key. | |
15
+ | **modified_at** | **Time** | If set contains a date time string of the last modification date in ISO format. | [optional] |
16
+ | **name** | **String** | Name of the API key. The name is not checked for uniqueness. Therefore multiple names with the same value can exist. Access is done via the UUID of the API key. | |
17
+ | **support_sessions** | **Boolean** | Defines whether you can manage CLI login sessions for the API key. When &#x60;true&#x60;, sessions are created and can be reviewed or revoked. When &#x60;false&#x60;, no sessions are tracked. To block access, delete or rotate the API key. Available only for user API keys. | [optional] |
18
+ | **action_when_leaked** | **String** | Defines the action to take when API key is leaked, valid values are &#39;none&#39;, &#39;disable&#39; and &#39;delete&#39;. | [optional] |
19
+ | **expires_at** | **String** | Date and time when the API key becomes invalid, ISO 8601 datetime in the format &#39;yyyy-MM-ddTHH:mm+0000&#39;. **WARNING** An API key will be permanently and irrevocably deleted when both the expires_at and modified_at timestamps are more than ninety (90) days in the past, regardless of the key’s locked status or any other state. | [optional] |
20
+ | **description** | **String** | The optional description of the API key. The &#39;description&#39; property is only available if a description was provided during a create of an API key. | [optional] |
21
+ | **iam_id** | **String** | The iam_id that this API key authenticates. | |
22
+ | **account_id** | **String** | ID of the account that this API key authenticates for. | |
23
+ | **apikey** | **String** | The API key value. This property only contains the API key value for the following cases: create an API key, update a service ID API key that stores the API key value as retrievable, or get a service ID API key that stores the API key value as retrievable. All other operations don&#39;t return the API key value, for example all user API key related operations, except for create, don&#39;t contain the API key value. | |
24
+ | **history** | [**Array&lt;EnityHistoryRecord&gt;**](EnityHistoryRecord.md) | History of the API key. | [optional] |
25
+ | **activity** | [**Activity**](Activity.md) | | [optional] |
21
26
 
22
- ## Code Sample
27
+ ## Example
23
28
 
24
29
  ```ruby
25
- require 'IbmCloudIam'
30
+ require 'ibm_cloud_iam'
26
31
 
27
- instance = IbmCloudIam::ApiKey.new(context: null,
28
- id: null,
29
- entity_tag: null,
30
- crn: null,
31
- locked: null,
32
- created_at: null,
33
- created_by: null,
34
- modified_at: null,
35
- name: null,
36
- description: null,
37
- iam_id: null,
38
- account_id: null,
39
- apikey: null,
40
- history: null)
32
+ instance = IbmCloudIam::ApiKey.new(
33
+ context: null,
34
+ id: null,
35
+ entity_tag: null,
36
+ crn: null,
37
+ locked: null,
38
+ disabled: null,
39
+ created_at: null,
40
+ created_by: null,
41
+ modified_at: null,
42
+ name: null,
43
+ support_sessions: null,
44
+ action_when_leaked: null,
45
+ expires_at: null,
46
+ description: null,
47
+ iam_id: null,
48
+ account_id: null,
49
+ apikey: null,
50
+ history: null,
51
+ activity: null
52
+ )
41
53
  ```
42
54
 
43
-
@@ -2,22 +2,27 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **name** | **String** | Name of the API key. The name is not checked for uniqueness. Therefore multiple names with the same value can exist. Access is done via the UUID of the API key. |
8
- **description** | **String** | The optional description of the API key. The &#39;description&#39; property is only available if a description was provided during a create of an API key. | [optional]
9
- **apikey** | **String** | You can optionally passthrough the API key value for this API key. If passed, NO validation of that apiKey value is done, i.e. the value can be non-URL safe. If omitted, the API key management will create an URL safe opaque API key value. The value of the API key is checked for uniqueness. Please ensure enough variations when passing in this value. | [optional]
10
- **store_value** | **Boolean** | Send true or false to set whether the API key value is retrievable in the future by using the Get details of an API key request. If you create an API key for a user, you must specify &#x60;false&#x60; or omit the value. We don&#39;t allow storing of API keys for users. | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | Name of the API key. The name is not checked for uniqueness. Therefore multiple names with the same value can exist. Access is done via the UUID of the API key. | |
8
+ | **description** | **String** | The optional description of the API key. The &#39;description&#39; property is only available if a description was provided during a create of an API key. | [optional] |
9
+ | **apikey** | **String** | You can optionally passthrough the API key value for this API key. If passed, a minimum length validation of 32 characters for that apiKey value is done, i.e. the value can contain any characters and can even be non-URL safe, but the minimum length requirement must be met. If omitted, the API key management will create an URL safe opaque API key value. The value of the API key is checked for uniqueness. Ensure enough variations when passing in this value. | [optional] |
10
+ | **store_value** | **Boolean** | Send true or false to set whether the API key value is retrievable in the future by using the Get details of an API key request. If you create an API key for a user, you must specify &#x60;false&#x60; or omit the value. We don&#39;t allow storing of API keys for users. | [optional] |
11
+ | **action_when_leaked** | **String** | Defines the action to take when API key is leaked, valid values are &#39;none&#39;, &#39;disable&#39; and &#39;delete&#39;. | [optional] |
12
+ | **expires_at** | **String** | Date and time when the API key becomes invalid, ISO 8601 datetime in the format &#39;yyyy-MM-ddTHH:mm+0000&#39;. **WARNING** An API key will be permanently and irrevocably deleted when both the expires_at and modified_at timestamps are more than ninety (90) days in the past, regardless of the key’s locked status or any other state. | [optional] |
11
13
 
12
- ## Code Sample
14
+ ## Example
13
15
 
14
16
  ```ruby
15
- require 'IbmCloudIam'
17
+ require 'ibm_cloud_iam'
16
18
 
17
- instance = IbmCloudIam::ApiKeyInsideCreateServiceIdRequest.new(name: null,
18
- description: null,
19
- apikey: null,
20
- store_value: null)
19
+ instance = IbmCloudIam::ApiKeyInsideCreateServiceIdRequest.new(
20
+ name: null,
21
+ description: null,
22
+ apikey: null,
23
+ store_value: null,
24
+ action_when_leaked: null,
25
+ expires_at: null
26
+ )
21
27
  ```
22
28
 
23
-
data/docs/ApiKeyList.md CHANGED
@@ -2,28 +2,29 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **context** | [**ResponseContext**](ResponseContext.md) | | [optional]
8
- **offset** | **Integer** | The offset of the current page. | [optional]
9
- **limit** | **Integer** | Optional size of a single page. Default is 20 items per page. Valid range is 1 to 100 | [optional]
10
- **first** | **String** | Link to the first page. | [optional]
11
- **previous** | **String** | Link to the previous available page. If &#39;previous&#39; property is not part of the response no previous page is available. | [optional]
12
- **_next** | **String** | Link to the next available page. If &#39;next&#39; property is not part of the response no next page is available. | [optional]
13
- **apikeys** | [**Array&lt;ApiKey&gt;**](ApiKey.md) | List of API keys based on the query paramters and the page size. The apikeys array is always part of the response but might be empty depending on the query parameters values provided. |
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **context** | [**ResponseContext**](ResponseContext.md) | | [optional] |
8
+ | **offset** | **Integer** | The offset of the current page. | [optional] |
9
+ | **limit** | **Integer** | Optional size of a single page. Default is 20 items per page. Valid range is 1 to 100 | [optional] |
10
+ | **first** | **String** | Link to the first page. | [optional] |
11
+ | **previous** | **String** | Link to the previous available page. If &#39;previous&#39; property is not part of the response no previous page is available. | [optional] |
12
+ | **_next** | **String** | Link to the next available page. If &#39;next&#39; property is not part of the response no next page is available. | [optional] |
13
+ | **apikeys** | [**Array&lt;ApiKey&gt;**](ApiKey.md) | List of API keys based on the query paramters and the page size. The apikeys array is always part of the response but might be empty depending on the query parameters values provided. | |
14
14
 
15
- ## Code Sample
15
+ ## Example
16
16
 
17
17
  ```ruby
18
- require 'IbmCloudIam'
18
+ require 'ibm_cloud_iam'
19
19
 
20
- instance = IbmCloudIam::ApiKeyList.new(context: null,
21
- offset: null,
22
- limit: null,
23
- first: null,
24
- previous: null,
25
- _next: null,
26
- apikeys: null)
20
+ instance = IbmCloudIam::ApiKeyList.new(
21
+ context: null,
22
+ offset: null,
23
+ limit: null,
24
+ first: null,
25
+ previous: null,
26
+ _next: null,
27
+ apikeys: null
28
+ )
27
29
  ```
28
30
 
29
-
@@ -0,0 +1,28 @@
1
+ # IbmCloudIam::ApikeyActivity
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | Unique id of the apikey. | |
8
+ | **name** | **String** | Name provided during creation of the apikey. | [optional] |
9
+ | **type** | **String** | Type of the apikey. Supported values are &#x60;serviceid&#x60; and &#x60;user&#x60;. | |
10
+ | **serviceid** | [**ApikeyActivityServiceid**](ApikeyActivityServiceid.md) | | [optional] |
11
+ | **user** | [**ApikeyActivityUser**](ApikeyActivityUser.md) | | [optional] |
12
+ | **last_authn** | **String** | Time when the apikey was last authenticated. | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'ibm_cloud_iam'
18
+
19
+ instance = IbmCloudIam::ApikeyActivity.new(
20
+ id: null,
21
+ name: null,
22
+ type: null,
23
+ serviceid: null,
24
+ user: null,
25
+ last_authn: null
26
+ )
27
+ ```
28
+
@@ -0,0 +1,20 @@
1
+ # IbmCloudIam::ApikeyActivityServiceid
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | Unique identifier of this Service Id. | [optional] |
8
+ | **name** | **String** | Name provided during creation of the serviceid. | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'ibm_cloud_iam'
14
+
15
+ instance = IbmCloudIam::ApikeyActivityServiceid.new(
16
+ id: null,
17
+ name: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,24 @@
1
+ # IbmCloudIam::ApikeyActivityUser
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **iam_id** | **String** | IAMid of the user | [optional] |
8
+ | **name** | **String** | Name of the user | [optional] |
9
+ | **username** | **String** | Username of the user | [optional] |
10
+ | **email** | **String** | Email of the user | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'ibm_cloud_iam'
16
+
17
+ instance = IbmCloudIam::ApikeyActivityUser.new(
18
+ iam_id: null,
19
+ name: null,
20
+ username: null,
21
+ email: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,40 @@
1
+ # IbmCloudIam::AssignedTemplatesAccountSettings
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **restrict_create_service_id** | [**RetrictActions**](RetrictActions.md) | | [optional][default to &#39;NOT_SET&#39;] |
8
+ | **restrict_create_platform_apikey** | [**RetrictActions**](RetrictActions.md) | | [optional][default to &#39;NOT_SET&#39;] |
9
+ | **allowed_ip_addresses** | **String** | Defines the IP addresses and subnets from which IAM tokens can be created for the account. | [optional] |
10
+ | **mfa** | [**MfaOptions**](MfaOptions.md) | | [optional] |
11
+ | **session_expiration_in_seconds** | **String** | Defines the session expiration in seconds for the account. Valid values: * Any whole number between between &#39;900&#39; and &#39;86400&#39; * NOT_SET - To unset account setting and use service default | [optional][default to &#39;86400&#39;] |
12
+ | **session_invalidation_in_seconds** | **String** | Defines the period of time in seconds in which a session will be invalidated due to inactivity. Valid values: * Any whole number between &#39;900&#39; and &#39;7200&#39; * NOT_SET - To unset account setting and use service default | [optional][default to &#39;7200&#39;] |
13
+ | **max_sessions_per_identity** | **String** | Defines the max allowed sessions per identity required by the account. Valid values: * Any whole number greater than 0 * NOT_SET - To unset account setting and use service default | [optional] |
14
+ | **system_access_token_expiration_in_seconds** | **String** | Defines the access token expiration in seconds. Valid values: * Any whole number between &#39;900&#39; and &#39;3600&#39; * NOT_SET - To unset account setting and use service default | [optional][default to &#39;3600&#39;] |
15
+ | **system_refresh_token_expiration_in_seconds** | **String** | Defines the refresh token expiration in seconds. Valid values: * Any whole number between &#39;900&#39; and &#39;259200&#39; * NOT_SET - To unset account setting and use service default | [optional][default to &#39;259200&#39;] |
16
+ | **restrict_user_list_visibility** | [**UserVisbilityRetrictActionsForTemplate**](UserVisbilityRetrictActionsForTemplate.md) | | [optional] |
17
+ | **user_mfa** | [**Array&lt;AccountSettingsUserMFAResponse&gt;**](AccountSettingsUserMFAResponse.md) | List of users that are exempted from the MFA requirement of the account. | [optional] |
18
+ | **restrict_user_domains** | [**TemplateAccountSettingsAllOfRestrictUserDomains**](TemplateAccountSettingsAllOfRestrictUserDomains.md) | | [optional] |
19
+
20
+ ## Example
21
+
22
+ ```ruby
23
+ require 'ibm_cloud_iam'
24
+
25
+ instance = IbmCloudIam::AssignedTemplatesAccountSettings.new(
26
+ restrict_create_service_id: null,
27
+ restrict_create_platform_apikey: null,
28
+ allowed_ip_addresses: null,
29
+ mfa: null,
30
+ session_expiration_in_seconds: null,
31
+ session_invalidation_in_seconds: null,
32
+ max_sessions_per_identity: null,
33
+ system_access_token_expiration_in_seconds: null,
34
+ system_refresh_token_expiration_in_seconds: null,
35
+ restrict_user_list_visibility: null,
36
+ user_mfa: null,
37
+ restrict_user_domains: null
38
+ )
39
+ ```
40
+
@@ -0,0 +1,36 @@
1
+ # IbmCloudIam::CommonAccountSettingsRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **restrict_create_service_id** | [**RetrictActions**](RetrictActions.md) | | [optional][default to &#39;NOT_SET&#39;] |
8
+ | **restrict_create_platform_apikey** | [**RetrictActions**](RetrictActions.md) | | [optional][default to &#39;NOT_SET&#39;] |
9
+ | **allowed_ip_addresses** | **String** | Defines the IP addresses and subnets from which IAM tokens can be created for the account. | [optional] |
10
+ | **mfa** | [**MfaOptions**](MfaOptions.md) | | [optional] |
11
+ | **user_mfa** | [**Array&lt;UserMfa&gt;**](UserMfa.md) | List of users that are exempted from the MFA requirement of the account. | [optional] |
12
+ | **session_expiration_in_seconds** | **String** | Defines the session expiration in seconds for the account. Valid values: * Any whole number between between &#39;900&#39; and &#39;86400&#39; * NOT_SET - To unset account setting and use service default | [optional][default to &#39;86400&#39;] |
13
+ | **session_invalidation_in_seconds** | **String** | Defines the period of time in seconds in which a session will be invalidated due to inactivity. Valid values: * Any whole number between &#39;900&#39; and &#39;7200&#39; * NOT_SET - To unset account setting and use service default | [optional][default to &#39;7200&#39;] |
14
+ | **max_sessions_per_identity** | **String** | Defines the max allowed sessions per identity required by the account. Valid values: * Any whole number greater than 0 * NOT_SET - To unset account setting and use service default | [optional] |
15
+ | **system_access_token_expiration_in_seconds** | **String** | Defines the access token expiration in seconds. Valid values: * Any whole number between &#39;900&#39; and &#39;3600&#39; * NOT_SET - To unset account setting and use service default | [optional][default to &#39;3600&#39;] |
16
+ | **system_refresh_token_expiration_in_seconds** | **String** | Defines the refresh token expiration in seconds. Valid values: * Any whole number between &#39;900&#39; and &#39;259200&#39; * NOT_SET - To unset account setting and use service default | [optional][default to &#39;259200&#39;] |
17
+
18
+ ## Example
19
+
20
+ ```ruby
21
+ require 'ibm_cloud_iam'
22
+
23
+ instance = IbmCloudIam::CommonAccountSettingsRequest.new(
24
+ restrict_create_service_id: null,
25
+ restrict_create_platform_apikey: null,
26
+ allowed_ip_addresses: null,
27
+ mfa: null,
28
+ user_mfa: null,
29
+ session_expiration_in_seconds: null,
30
+ session_invalidation_in_seconds: null,
31
+ max_sessions_per_identity: null,
32
+ system_access_token_expiration_in_seconds: null,
33
+ system_refresh_token_expiration_in_seconds: null
34
+ )
35
+ ```
36
+
@@ -0,0 +1,34 @@
1
+ # IbmCloudIam::CommonAccountSettingsResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **restrict_create_service_id** | [**RetrictActions**](RetrictActions.md) | | [optional][default to &#39;NOT_SET&#39;] |
8
+ | **restrict_create_platform_apikey** | [**RetrictActions**](RetrictActions.md) | | [optional][default to &#39;NOT_SET&#39;] |
9
+ | **allowed_ip_addresses** | **String** | Defines the IP addresses and subnets from which IAM tokens can be created for the account. | [optional] |
10
+ | **mfa** | [**MfaOptions**](MfaOptions.md) | | [optional] |
11
+ | **session_expiration_in_seconds** | **String** | Defines the session expiration in seconds for the account. Valid values: * Any whole number between between &#39;900&#39; and &#39;86400&#39; * NOT_SET - To unset account setting and use service default | [optional][default to &#39;86400&#39;] |
12
+ | **session_invalidation_in_seconds** | **String** | Defines the period of time in seconds in which a session will be invalidated due to inactivity. Valid values: * Any whole number between &#39;900&#39; and &#39;7200&#39; * NOT_SET - To unset account setting and use service default | [optional][default to &#39;7200&#39;] |
13
+ | **max_sessions_per_identity** | **String** | Defines the max allowed sessions per identity required by the account. Valid values: * Any whole number greater than 0 * NOT_SET - To unset account setting and use service default | [optional] |
14
+ | **system_access_token_expiration_in_seconds** | **String** | Defines the access token expiration in seconds. Valid values: * Any whole number between &#39;900&#39; and &#39;3600&#39; * NOT_SET - To unset account setting and use service default | [optional][default to &#39;3600&#39;] |
15
+ | **system_refresh_token_expiration_in_seconds** | **String** | Defines the refresh token expiration in seconds. Valid values: * Any whole number between &#39;900&#39; and &#39;259200&#39; * NOT_SET - To unset account setting and use service default | [optional][default to &#39;259200&#39;] |
16
+
17
+ ## Example
18
+
19
+ ```ruby
20
+ require 'ibm_cloud_iam'
21
+
22
+ instance = IbmCloudIam::CommonAccountSettingsResponse.new(
23
+ restrict_create_service_id: null,
24
+ restrict_create_platform_apikey: null,
25
+ allowed_ip_addresses: null,
26
+ mfa: null,
27
+ session_expiration_in_seconds: null,
28
+ session_invalidation_in_seconds: null,
29
+ max_sessions_per_identity: null,
30
+ system_access_token_expiration_in_seconds: null,
31
+ system_refresh_token_expiration_in_seconds: null
32
+ )
33
+ ```
34
+
@@ -0,0 +1,20 @@
1
+ # IbmCloudIam::ConsumersResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **idp_id** | **String** | | [optional] |
8
+ | **consumers** | [**Array&lt;ConsumersResponseConsumersInner&gt;**](ConsumersResponseConsumersInner.md) | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'ibm_cloud_iam'
14
+
15
+ instance = IbmCloudIam::ConsumersResponse.new(
16
+ idp_id: null,
17
+ consumers: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,20 @@
1
+ # IbmCloudIam::ConsumersResponseConsumersInner
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **account_id** | **String** | | [optional] |
8
+ | **share_scope** | [**Array&lt;ShareScope&gt;**](ShareScope.md) | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'ibm_cloud_iam'
14
+
15
+ instance = IbmCloudIam::ConsumersResponseConsumersInner.new(
16
+ account_id: null,
17
+ share_scope: null
18
+ )
19
+ ```
20
+