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,720 @@
1
+ # IbmCloudIam::AccountSettingsTemplateApi
2
+
3
+ All URIs are relative to *https://iam.cloud.ibm.com*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**commit_account_settings_template**](AccountSettingsTemplateApi.md#commit_account_settings_template) | **POST** /v1/account_settings_templates/{template_id}/versions/{version}/commit | Commit a template version |
8
+ | [**create_account_settings_template**](AccountSettingsTemplateApi.md#create_account_settings_template) | **POST** /v1/account_settings_templates | Create an account settings template |
9
+ | [**create_account_settings_template_version**](AccountSettingsTemplateApi.md#create_account_settings_template_version) | **POST** /v1/account_settings_templates/{template_id}/versions | Create a new version of an account settings template |
10
+ | [**delete_account_settings_template_version**](AccountSettingsTemplateApi.md#delete_account_settings_template_version) | **DELETE** /v1/account_settings_templates/{template_id}/versions/{version} | Delete version of an account settings template |
11
+ | [**delete_all_versions_of_account_settings_template**](AccountSettingsTemplateApi.md#delete_all_versions_of_account_settings_template) | **DELETE** /v1/account_settings_templates/{template_id} | Delete all versions of an account settings template |
12
+ | [**get_account_settings_template_version**](AccountSettingsTemplateApi.md#get_account_settings_template_version) | **GET** /v1/account_settings_templates/{template_id}/versions/{version} | Get version of an account settings template |
13
+ | [**get_latest_account_settings_template_version**](AccountSettingsTemplateApi.md#get_latest_account_settings_template_version) | **GET** /v1/account_settings_templates/{template_id} | Get latest version of an account settings template |
14
+ | [**list_account_settings_templates**](AccountSettingsTemplateApi.md#list_account_settings_templates) | **GET** /v1/account_settings_templates | List account settings templates |
15
+ | [**list_versions_of_account_settings_template**](AccountSettingsTemplateApi.md#list_versions_of_account_settings_template) | **GET** /v1/account_settings_templates/{template_id}/versions | List account settings template versions |
16
+ | [**update_account_settings_template_version**](AccountSettingsTemplateApi.md#update_account_settings_template_version) | **PUT** /v1/account_settings_templates/{template_id}/versions/{version} | Update version of an account settings template |
17
+
18
+
19
+ ## commit_account_settings_template
20
+
21
+ > commit_account_settings_template(template_id, version, authorization)
22
+
23
+ Commit a template version
24
+
25
+ Commit a specific version of an account settings template in an Enterprise Account. A Template must be committed before being assigned, and once committed, can no longer be modified.
26
+
27
+ ### Examples
28
+
29
+ ```ruby
30
+ require 'time'
31
+ require 'ibm_cloud_iam'
32
+
33
+ api_instance = IbmCloudIam::AccountSettingsTemplateApi.new
34
+ template_id = 'template_id_example' # String | ID of the account settings template
35
+ version = 'version_example' # String | Version of the account settings template
36
+ authorization = 'authorization_example' # String | Authorization Token used for the request. The supported token type is a Cloud IAM Access Token. If the token is omitted the request will fail with BXNIM0308E: 'No authorization header found'. Make sure that the provided token has the required authority for the request.
37
+
38
+ begin
39
+ # Commit a template version
40
+ api_instance.commit_account_settings_template(template_id, version, authorization)
41
+ rescue IbmCloudIam::ApiError => e
42
+ puts "Error when calling AccountSettingsTemplateApi->commit_account_settings_template: #{e}"
43
+ end
44
+ ```
45
+
46
+ #### Using the commit_account_settings_template_with_http_info variant
47
+
48
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
49
+
50
+ > <Array(nil, Integer, Hash)> commit_account_settings_template_with_http_info(template_id, version, authorization)
51
+
52
+ ```ruby
53
+ begin
54
+ # Commit a template version
55
+ data, status_code, headers = api_instance.commit_account_settings_template_with_http_info(template_id, version, authorization)
56
+ p status_code # => 2xx
57
+ p headers # => { ... }
58
+ p data # => nil
59
+ rescue IbmCloudIam::ApiError => e
60
+ puts "Error when calling AccountSettingsTemplateApi->commit_account_settings_template_with_http_info: #{e}"
61
+ end
62
+ ```
63
+
64
+ ### Parameters
65
+
66
+ | Name | Type | Description | Notes |
67
+ | ---- | ---- | ----------- | ----- |
68
+ | **template_id** | **String** | ID of the account settings template | |
69
+ | **version** | **String** | Version of the account settings template | |
70
+ | **authorization** | **String** | Authorization Token used for the request. The supported token type is a Cloud IAM Access Token. If the token is omitted the request will fail with BXNIM0308E: &#39;No authorization header found&#39;. Make sure that the provided token has the required authority for the request. | |
71
+
72
+ ### Return type
73
+
74
+ nil (empty response body)
75
+
76
+ ### Authorization
77
+
78
+ No authorization required
79
+
80
+ ### HTTP request headers
81
+
82
+ - **Content-Type**: Not defined
83
+ - **Accept**: Not defined
84
+
85
+
86
+ ## create_account_settings_template
87
+
88
+ > <AccountSettingsTemplateResponse> create_account_settings_template(authorization, account_settings_template_request)
89
+
90
+ Create an account settings template
91
+
92
+ Create a new account settings template in an enterprise account.
93
+
94
+ ### Examples
95
+
96
+ ```ruby
97
+ require 'time'
98
+ require 'ibm_cloud_iam'
99
+
100
+ api_instance = IbmCloudIam::AccountSettingsTemplateApi.new
101
+ authorization = 'authorization_example' # String | Authorization Token used for the request. The supported token type is a Cloud IAM Access Token. If the token is omitted the request will fail with BXNIM0308E: 'No authorization header found'. Make sure that the provided token has the required authority for the request.
102
+ account_settings_template_request = IbmCloudIam::AccountSettingsTemplateRequest.new # AccountSettingsTemplateRequest | Request to create an account settings template.
103
+
104
+ begin
105
+ # Create an account settings template
106
+ result = api_instance.create_account_settings_template(authorization, account_settings_template_request)
107
+ p result
108
+ rescue IbmCloudIam::ApiError => e
109
+ puts "Error when calling AccountSettingsTemplateApi->create_account_settings_template: #{e}"
110
+ end
111
+ ```
112
+
113
+ #### Using the create_account_settings_template_with_http_info variant
114
+
115
+ This returns an Array which contains the response data, status code and headers.
116
+
117
+ > <Array(<AccountSettingsTemplateResponse>, Integer, Hash)> create_account_settings_template_with_http_info(authorization, account_settings_template_request)
118
+
119
+ ```ruby
120
+ begin
121
+ # Create an account settings template
122
+ data, status_code, headers = api_instance.create_account_settings_template_with_http_info(authorization, account_settings_template_request)
123
+ p status_code # => 2xx
124
+ p headers # => { ... }
125
+ p data # => <AccountSettingsTemplateResponse>
126
+ rescue IbmCloudIam::ApiError => e
127
+ puts "Error when calling AccountSettingsTemplateApi->create_account_settings_template_with_http_info: #{e}"
128
+ end
129
+ ```
130
+
131
+ ### Parameters
132
+
133
+ | Name | Type | Description | Notes |
134
+ | ---- | ---- | ----------- | ----- |
135
+ | **authorization** | **String** | Authorization Token used for the request. The supported token type is a Cloud IAM Access Token. If the token is omitted the request will fail with BXNIM0308E: &#39;No authorization header found&#39;. Make sure that the provided token has the required authority for the request. | |
136
+ | **account_settings_template_request** | [**AccountSettingsTemplateRequest**](AccountSettingsTemplateRequest.md) | Request to create an account settings template. | |
137
+
138
+ ### Return type
139
+
140
+ [**AccountSettingsTemplateResponse**](AccountSettingsTemplateResponse.md)
141
+
142
+ ### Authorization
143
+
144
+ No authorization required
145
+
146
+ ### HTTP request headers
147
+
148
+ - **Content-Type**: application/json
149
+ - **Accept**: application/json
150
+
151
+
152
+ ## create_account_settings_template_version
153
+
154
+ > <AccountSettingsTemplateResponse> create_account_settings_template_version(template_id, authorization, account_settings_template_request)
155
+
156
+ Create a new version of an account settings template
157
+
158
+ Create a new version of an account settings template in an Enterprise Account
159
+
160
+ ### Examples
161
+
162
+ ```ruby
163
+ require 'time'
164
+ require 'ibm_cloud_iam'
165
+
166
+ api_instance = IbmCloudIam::AccountSettingsTemplateApi.new
167
+ template_id = 'template_id_example' # String | ID of the account settings template
168
+ authorization = 'authorization_example' # String | Authorization Token used for the request. The supported token type is a Cloud IAM Access Token. If the token is omitted the request will fail with BXNIM0308E: 'No authorization header found'. Make sure that the provided token has the required authority for the request.
169
+ account_settings_template_request = IbmCloudIam::AccountSettingsTemplateRequest.new # AccountSettingsTemplateRequest | Request to create new version of an account settings template
170
+
171
+ begin
172
+ # Create a new version of an account settings template
173
+ result = api_instance.create_account_settings_template_version(template_id, authorization, account_settings_template_request)
174
+ p result
175
+ rescue IbmCloudIam::ApiError => e
176
+ puts "Error when calling AccountSettingsTemplateApi->create_account_settings_template_version: #{e}"
177
+ end
178
+ ```
179
+
180
+ #### Using the create_account_settings_template_version_with_http_info variant
181
+
182
+ This returns an Array which contains the response data, status code and headers.
183
+
184
+ > <Array(<AccountSettingsTemplateResponse>, Integer, Hash)> create_account_settings_template_version_with_http_info(template_id, authorization, account_settings_template_request)
185
+
186
+ ```ruby
187
+ begin
188
+ # Create a new version of an account settings template
189
+ data, status_code, headers = api_instance.create_account_settings_template_version_with_http_info(template_id, authorization, account_settings_template_request)
190
+ p status_code # => 2xx
191
+ p headers # => { ... }
192
+ p data # => <AccountSettingsTemplateResponse>
193
+ rescue IbmCloudIam::ApiError => e
194
+ puts "Error when calling AccountSettingsTemplateApi->create_account_settings_template_version_with_http_info: #{e}"
195
+ end
196
+ ```
197
+
198
+ ### Parameters
199
+
200
+ | Name | Type | Description | Notes |
201
+ | ---- | ---- | ----------- | ----- |
202
+ | **template_id** | **String** | ID of the account settings template | |
203
+ | **authorization** | **String** | Authorization Token used for the request. The supported token type is a Cloud IAM Access Token. If the token is omitted the request will fail with BXNIM0308E: &#39;No authorization header found&#39;. Make sure that the provided token has the required authority for the request. | |
204
+ | **account_settings_template_request** | [**AccountSettingsTemplateRequest**](AccountSettingsTemplateRequest.md) | Request to create new version of an account settings template | |
205
+
206
+ ### Return type
207
+
208
+ [**AccountSettingsTemplateResponse**](AccountSettingsTemplateResponse.md)
209
+
210
+ ### Authorization
211
+
212
+ No authorization required
213
+
214
+ ### HTTP request headers
215
+
216
+ - **Content-Type**: application/json
217
+ - **Accept**: application/json
218
+
219
+
220
+ ## delete_account_settings_template_version
221
+
222
+ > delete_account_settings_template_version(template_id, version, authorization)
223
+
224
+ Delete version of an account settings template
225
+
226
+ Delete a specific version of an account settings template in an Enterprise Account
227
+
228
+ ### Examples
229
+
230
+ ```ruby
231
+ require 'time'
232
+ require 'ibm_cloud_iam'
233
+
234
+ api_instance = IbmCloudIam::AccountSettingsTemplateApi.new
235
+ template_id = 'template_id_example' # String | ID of the account settings template
236
+ version = 'version_example' # String | Version of the account settings template
237
+ 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.
238
+
239
+ begin
240
+ # Delete version of an account settings template
241
+ api_instance.delete_account_settings_template_version(template_id, version, authorization)
242
+ rescue IbmCloudIam::ApiError => e
243
+ puts "Error when calling AccountSettingsTemplateApi->delete_account_settings_template_version: #{e}"
244
+ end
245
+ ```
246
+
247
+ #### Using the delete_account_settings_template_version_with_http_info variant
248
+
249
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
250
+
251
+ > <Array(nil, Integer, Hash)> delete_account_settings_template_version_with_http_info(template_id, version, authorization)
252
+
253
+ ```ruby
254
+ begin
255
+ # Delete version of an account settings template
256
+ data, status_code, headers = api_instance.delete_account_settings_template_version_with_http_info(template_id, version, authorization)
257
+ p status_code # => 2xx
258
+ p headers # => { ... }
259
+ p data # => nil
260
+ rescue IbmCloudIam::ApiError => e
261
+ puts "Error when calling AccountSettingsTemplateApi->delete_account_settings_template_version_with_http_info: #{e}"
262
+ end
263
+ ```
264
+
265
+ ### Parameters
266
+
267
+ | Name | Type | Description | Notes |
268
+ | ---- | ---- | ----------- | ----- |
269
+ | **template_id** | **String** | ID of the account settings template | |
270
+ | **version** | **String** | Version of the account settings template | |
271
+ | **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. | |
272
+
273
+ ### Return type
274
+
275
+ nil (empty response body)
276
+
277
+ ### Authorization
278
+
279
+ No authorization required
280
+
281
+ ### HTTP request headers
282
+
283
+ - **Content-Type**: Not defined
284
+ - **Accept**: Not defined
285
+
286
+
287
+ ## delete_all_versions_of_account_settings_template
288
+
289
+ > delete_all_versions_of_account_settings_template(template_id, authorization)
290
+
291
+ Delete all versions of an account settings template
292
+
293
+ Delete all versions of an account settings template in an enterprise account. If any version is assigned to child accounts, you must first delete the assignment.
294
+
295
+ ### Examples
296
+
297
+ ```ruby
298
+ require 'time'
299
+ require 'ibm_cloud_iam'
300
+
301
+ api_instance = IbmCloudIam::AccountSettingsTemplateApi.new
302
+ template_id = 'template_id_example' # String | ID of the account settings template
303
+ 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.
304
+
305
+ begin
306
+ # Delete all versions of an account settings template
307
+ api_instance.delete_all_versions_of_account_settings_template(template_id, authorization)
308
+ rescue IbmCloudIam::ApiError => e
309
+ puts "Error when calling AccountSettingsTemplateApi->delete_all_versions_of_account_settings_template: #{e}"
310
+ end
311
+ ```
312
+
313
+ #### Using the delete_all_versions_of_account_settings_template_with_http_info variant
314
+
315
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
316
+
317
+ > <Array(nil, Integer, Hash)> delete_all_versions_of_account_settings_template_with_http_info(template_id, authorization)
318
+
319
+ ```ruby
320
+ begin
321
+ # Delete all versions of an account settings template
322
+ data, status_code, headers = api_instance.delete_all_versions_of_account_settings_template_with_http_info(template_id, authorization)
323
+ p status_code # => 2xx
324
+ p headers # => { ... }
325
+ p data # => nil
326
+ rescue IbmCloudIam::ApiError => e
327
+ puts "Error when calling AccountSettingsTemplateApi->delete_all_versions_of_account_settings_template_with_http_info: #{e}"
328
+ end
329
+ ```
330
+
331
+ ### Parameters
332
+
333
+ | Name | Type | Description | Notes |
334
+ | ---- | ---- | ----------- | ----- |
335
+ | **template_id** | **String** | ID of the account settings template | |
336
+ | **authorization** | **String** | Authorization Token used for the request. The supported token type is a Cloud IAM Access Token. If the token is omitted the request will fail with BXNIM0308E: &#39;No authorization header found&#39;. Make sure that the provided token has the required authority for the request. | |
337
+
338
+ ### Return type
339
+
340
+ nil (empty response body)
341
+
342
+ ### Authorization
343
+
344
+ No authorization required
345
+
346
+ ### HTTP request headers
347
+
348
+ - **Content-Type**: Not defined
349
+ - **Accept**: Not defined
350
+
351
+
352
+ ## get_account_settings_template_version
353
+
354
+ > <AccountSettingsTemplateResponse> get_account_settings_template_version(template_id, version, authorization, opts)
355
+
356
+ Get version of an account settings template
357
+
358
+ Get a specific version of an account settings template in an Enterprise Account
359
+
360
+ ### Examples
361
+
362
+ ```ruby
363
+ require 'time'
364
+ require 'ibm_cloud_iam'
365
+
366
+ api_instance = IbmCloudIam::AccountSettingsTemplateApi.new
367
+ template_id = 'template_id_example' # String | ID of the account settings template
368
+ version = 'version_example' # String | Version of the account settings template
369
+ 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.
370
+ opts = {
371
+ include_history: true # Boolean | Defines if the entity history is included in the response
372
+ }
373
+
374
+ begin
375
+ # Get version of an account settings template
376
+ result = api_instance.get_account_settings_template_version(template_id, version, authorization, opts)
377
+ p result
378
+ rescue IbmCloudIam::ApiError => e
379
+ puts "Error when calling AccountSettingsTemplateApi->get_account_settings_template_version: #{e}"
380
+ end
381
+ ```
382
+
383
+ #### Using the get_account_settings_template_version_with_http_info variant
384
+
385
+ This returns an Array which contains the response data, status code and headers.
386
+
387
+ > <Array(<AccountSettingsTemplateResponse>, Integer, Hash)> get_account_settings_template_version_with_http_info(template_id, version, authorization, opts)
388
+
389
+ ```ruby
390
+ begin
391
+ # Get version of an account settings template
392
+ data, status_code, headers = api_instance.get_account_settings_template_version_with_http_info(template_id, version, authorization, opts)
393
+ p status_code # => 2xx
394
+ p headers # => { ... }
395
+ p data # => <AccountSettingsTemplateResponse>
396
+ rescue IbmCloudIam::ApiError => e
397
+ puts "Error when calling AccountSettingsTemplateApi->get_account_settings_template_version_with_http_info: #{e}"
398
+ end
399
+ ```
400
+
401
+ ### Parameters
402
+
403
+ | Name | Type | Description | Notes |
404
+ | ---- | ---- | ----------- | ----- |
405
+ | **template_id** | **String** | ID of the account settings template | |
406
+ | **version** | **String** | Version of the account settings template | |
407
+ | **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. | |
408
+ | **include_history** | **Boolean** | Defines if the entity history is included in the response | [optional][default to false] |
409
+
410
+ ### Return type
411
+
412
+ [**AccountSettingsTemplateResponse**](AccountSettingsTemplateResponse.md)
413
+
414
+ ### Authorization
415
+
416
+ No authorization required
417
+
418
+ ### HTTP request headers
419
+
420
+ - **Content-Type**: Not defined
421
+ - **Accept**: application/json
422
+
423
+
424
+ ## get_latest_account_settings_template_version
425
+
426
+ > <AccountSettingsTemplateResponse> get_latest_account_settings_template_version(template_id, authorization, opts)
427
+
428
+ Get latest version of an account settings template
429
+
430
+ Get the latest version of a specific account settings template in an enterprise account.
431
+
432
+ ### Examples
433
+
434
+ ```ruby
435
+ require 'time'
436
+ require 'ibm_cloud_iam'
437
+
438
+ api_instance = IbmCloudIam::AccountSettingsTemplateApi.new
439
+ template_id = 'template_id_example' # String | ID of the account settings template
440
+ 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.
441
+ opts = {
442
+ include_history: true # Boolean | Defines if the entity history is included in the response
443
+ }
444
+
445
+ begin
446
+ # Get latest version of an account settings template
447
+ result = api_instance.get_latest_account_settings_template_version(template_id, authorization, opts)
448
+ p result
449
+ rescue IbmCloudIam::ApiError => e
450
+ puts "Error when calling AccountSettingsTemplateApi->get_latest_account_settings_template_version: #{e}"
451
+ end
452
+ ```
453
+
454
+ #### Using the get_latest_account_settings_template_version_with_http_info variant
455
+
456
+ This returns an Array which contains the response data, status code and headers.
457
+
458
+ > <Array(<AccountSettingsTemplateResponse>, Integer, Hash)> get_latest_account_settings_template_version_with_http_info(template_id, authorization, opts)
459
+
460
+ ```ruby
461
+ begin
462
+ # Get latest version of an account settings template
463
+ data, status_code, headers = api_instance.get_latest_account_settings_template_version_with_http_info(template_id, authorization, opts)
464
+ p status_code # => 2xx
465
+ p headers # => { ... }
466
+ p data # => <AccountSettingsTemplateResponse>
467
+ rescue IbmCloudIam::ApiError => e
468
+ puts "Error when calling AccountSettingsTemplateApi->get_latest_account_settings_template_version_with_http_info: #{e}"
469
+ end
470
+ ```
471
+
472
+ ### Parameters
473
+
474
+ | Name | Type | Description | Notes |
475
+ | ---- | ---- | ----------- | ----- |
476
+ | **template_id** | **String** | ID of the account settings template | |
477
+ | **authorization** | **String** | Authorization Token used for the request. The supported token type is a Cloud IAM Access Token. If the token is omitted the request will fail with BXNIM0308E: &#39;No authorization header found&#39;. Make sure that the provided token has the required authority for the request. | |
478
+ | **include_history** | **Boolean** | Defines if the entity history is included in the response | [optional][default to false] |
479
+
480
+ ### Return type
481
+
482
+ [**AccountSettingsTemplateResponse**](AccountSettingsTemplateResponse.md)
483
+
484
+ ### Authorization
485
+
486
+ No authorization required
487
+
488
+ ### HTTP request headers
489
+
490
+ - **Content-Type**: Not defined
491
+ - **Accept**: application/json
492
+
493
+
494
+ ## list_account_settings_templates
495
+
496
+ > <AccountSettingsTemplateList> list_account_settings_templates(authorization, opts)
497
+
498
+ List account settings templates
499
+
500
+ List account settings templates in an enterprise account
501
+
502
+ ### Examples
503
+
504
+ ```ruby
505
+ require 'time'
506
+ require 'ibm_cloud_iam'
507
+
508
+ api_instance = IbmCloudIam::AccountSettingsTemplateApi.new
509
+ authorization = 'authorization_example' # String | Authorization Token used for the request. The supported token type is a Cloud IAM Access Token. If the token is omitted the request will fail with BXNIM0308E: 'No authorization header found'. Make sure that the provided token has the required authority for the request.
510
+ opts = {
511
+ account_id: 'account_id_example', # String | Account ID of the account settings templates to query. This parameter is required unless using a pagetoken.
512
+ limit: 'limit_example', # String | Optional size of a single page.
513
+ pagetoken: 'pagetoken_example', # String | Optional Prev or Next page token returned from a previous query execution. Default is start with first page.
514
+ sort: 'created_at', # String | Optional sort property. If specified, the returned templated are sorted according to this property
515
+ order: 'asc', # String | Optional sort order.
516
+ include_history: 'include_history_example' # String | Defines if the entity history is included in the response
517
+ }
518
+
519
+ begin
520
+ # List account settings templates
521
+ result = api_instance.list_account_settings_templates(authorization, opts)
522
+ p result
523
+ rescue IbmCloudIam::ApiError => e
524
+ puts "Error when calling AccountSettingsTemplateApi->list_account_settings_templates: #{e}"
525
+ end
526
+ ```
527
+
528
+ #### Using the list_account_settings_templates_with_http_info variant
529
+
530
+ This returns an Array which contains the response data, status code and headers.
531
+
532
+ > <Array(<AccountSettingsTemplateList>, Integer, Hash)> list_account_settings_templates_with_http_info(authorization, opts)
533
+
534
+ ```ruby
535
+ begin
536
+ # List account settings templates
537
+ data, status_code, headers = api_instance.list_account_settings_templates_with_http_info(authorization, opts)
538
+ p status_code # => 2xx
539
+ p headers # => { ... }
540
+ p data # => <AccountSettingsTemplateList>
541
+ rescue IbmCloudIam::ApiError => e
542
+ puts "Error when calling AccountSettingsTemplateApi->list_account_settings_templates_with_http_info: #{e}"
543
+ end
544
+ ```
545
+
546
+ ### Parameters
547
+
548
+ | Name | Type | Description | Notes |
549
+ | ---- | ---- | ----------- | ----- |
550
+ | **authorization** | **String** | Authorization Token used for the request. The supported token type is a Cloud IAM Access Token. If the token is omitted the request will fail with BXNIM0308E: &#39;No authorization header found&#39;. Make sure that the provided token has the required authority for the request. | |
551
+ | **account_id** | **String** | Account ID of the account settings templates to query. This parameter is required unless using a pagetoken. | [optional] |
552
+ | **limit** | **String** | Optional size of a single page. | [optional][default to &#39;20&#39;] |
553
+ | **pagetoken** | **String** | Optional Prev or Next page token returned from a previous query execution. Default is start with first page. | [optional] |
554
+ | **sort** | **String** | Optional sort property. If specified, the returned templated are sorted according to this property | [optional][default to &#39;created_at&#39;] |
555
+ | **order** | **String** | Optional sort order. | [optional][default to &#39;asc&#39;] |
556
+ | **include_history** | **String** | Defines if the entity history is included in the response | [optional][default to &#39;false&#39;] |
557
+
558
+ ### Return type
559
+
560
+ [**AccountSettingsTemplateList**](AccountSettingsTemplateList.md)
561
+
562
+ ### Authorization
563
+
564
+ No authorization required
565
+
566
+ ### HTTP request headers
567
+
568
+ - **Content-Type**: Not defined
569
+ - **Accept**: application/json
570
+
571
+
572
+ ## list_versions_of_account_settings_template
573
+
574
+ > <AccountSettingsTemplateList> list_versions_of_account_settings_template(template_id, authorization, opts)
575
+
576
+ List account settings template versions
577
+
578
+ List the versions of a specific account settings template in an enterprise account.
579
+
580
+ ### Examples
581
+
582
+ ```ruby
583
+ require 'time'
584
+ require 'ibm_cloud_iam'
585
+
586
+ api_instance = IbmCloudIam::AccountSettingsTemplateApi.new
587
+ template_id = 'template_id_example' # String | ID of the account settings template
588
+ authorization = 'authorization_example' # String | Authorization Token used for the request. The supported token type is a Cloud IAM Access Token. If the token is omitted the request will fail with BXNIM0308E: 'No authorization header found'. Make sure that the provided token has the required authority for the request.
589
+ opts = {
590
+ limit: 'limit_example', # String | Optional size of a single page.
591
+ pagetoken: 'pagetoken_example', # String | Optional Prev or Next page token returned from a previous query execution. Default is start with first page.
592
+ sort: 'created_at', # String | Optional sort property. If specified, the returned templated are sorted according to this property
593
+ order: 'asc', # String | Optional sort order.
594
+ include_history: 'include_history_example' # String | Defines if the entity history is included in the response
595
+ }
596
+
597
+ begin
598
+ # List account settings template versions
599
+ result = api_instance.list_versions_of_account_settings_template(template_id, authorization, opts)
600
+ p result
601
+ rescue IbmCloudIam::ApiError => e
602
+ puts "Error when calling AccountSettingsTemplateApi->list_versions_of_account_settings_template: #{e}"
603
+ end
604
+ ```
605
+
606
+ #### Using the list_versions_of_account_settings_template_with_http_info variant
607
+
608
+ This returns an Array which contains the response data, status code and headers.
609
+
610
+ > <Array(<AccountSettingsTemplateList>, Integer, Hash)> list_versions_of_account_settings_template_with_http_info(template_id, authorization, opts)
611
+
612
+ ```ruby
613
+ begin
614
+ # List account settings template versions
615
+ data, status_code, headers = api_instance.list_versions_of_account_settings_template_with_http_info(template_id, authorization, opts)
616
+ p status_code # => 2xx
617
+ p headers # => { ... }
618
+ p data # => <AccountSettingsTemplateList>
619
+ rescue IbmCloudIam::ApiError => e
620
+ puts "Error when calling AccountSettingsTemplateApi->list_versions_of_account_settings_template_with_http_info: #{e}"
621
+ end
622
+ ```
623
+
624
+ ### Parameters
625
+
626
+ | Name | Type | Description | Notes |
627
+ | ---- | ---- | ----------- | ----- |
628
+ | **template_id** | **String** | ID of the account settings template | |
629
+ | **authorization** | **String** | Authorization Token used for the request. The supported token type is a Cloud IAM Access Token. If the token is omitted the request will fail with BXNIM0308E: &#39;No authorization header found&#39;. Make sure that the provided token has the required authority for the request. | |
630
+ | **limit** | **String** | Optional size of a single page. | [optional][default to &#39;20&#39;] |
631
+ | **pagetoken** | **String** | Optional Prev or Next page token returned from a previous query execution. Default is start with first page. | [optional] |
632
+ | **sort** | **String** | Optional sort property. If specified, the returned templated are sorted according to this property | [optional][default to &#39;created_at&#39;] |
633
+ | **order** | **String** | Optional sort order. | [optional][default to &#39;asc&#39;] |
634
+ | **include_history** | **String** | Defines if the entity history is included in the response | [optional][default to &#39;false&#39;] |
635
+
636
+ ### Return type
637
+
638
+ [**AccountSettingsTemplateList**](AccountSettingsTemplateList.md)
639
+
640
+ ### Authorization
641
+
642
+ No authorization required
643
+
644
+ ### HTTP request headers
645
+
646
+ - **Content-Type**: Not defined
647
+ - **Accept**: application/json
648
+
649
+
650
+ ## update_account_settings_template_version
651
+
652
+ > <AccountSettingsTemplateResponse> update_account_settings_template_version(if_match, template_id, version, authorization, account_settings_template_request)
653
+
654
+ Update version of an account settings template
655
+
656
+ Update a specific version of an account settings template in an Enterprise Account
657
+
658
+ ### Examples
659
+
660
+ ```ruby
661
+ require 'time'
662
+ require 'ibm_cloud_iam'
663
+
664
+ api_instance = IbmCloudIam::AccountSettingsTemplateApi.new
665
+ if_match = 'if_match_example' # String | Entity tag of the Template to be updated. Specify the tag that you retrieved when reading the account settings template. This value helps identifying parallel usage of this API. Pass * to indicate to update any version available. This might result in stale updates.
666
+ template_id = 'template_id_example' # String | ID of the account settings template
667
+ version = 'version_example' # String | Version of the account settings template
668
+ authorization = 'authorization_example' # String | Authorization Token used for the request. The supported token type is a Cloud IAM Access Token. If the token is omitted the request will fail with BXNIM0308E: 'No authorization header found'. Make sure that the provided token has the required authority for the request.
669
+ account_settings_template_request = IbmCloudIam::AccountSettingsTemplateRequest.new # AccountSettingsTemplateRequest | Request to create an account settings template.
670
+
671
+ begin
672
+ # Update version of an account settings template
673
+ result = api_instance.update_account_settings_template_version(if_match, template_id, version, authorization, account_settings_template_request)
674
+ p result
675
+ rescue IbmCloudIam::ApiError => e
676
+ puts "Error when calling AccountSettingsTemplateApi->update_account_settings_template_version: #{e}"
677
+ end
678
+ ```
679
+
680
+ #### Using the update_account_settings_template_version_with_http_info variant
681
+
682
+ This returns an Array which contains the response data, status code and headers.
683
+
684
+ > <Array(<AccountSettingsTemplateResponse>, Integer, Hash)> update_account_settings_template_version_with_http_info(if_match, template_id, version, authorization, account_settings_template_request)
685
+
686
+ ```ruby
687
+ begin
688
+ # Update version of an account settings template
689
+ data, status_code, headers = api_instance.update_account_settings_template_version_with_http_info(if_match, template_id, version, authorization, account_settings_template_request)
690
+ p status_code # => 2xx
691
+ p headers # => { ... }
692
+ p data # => <AccountSettingsTemplateResponse>
693
+ rescue IbmCloudIam::ApiError => e
694
+ puts "Error when calling AccountSettingsTemplateApi->update_account_settings_template_version_with_http_info: #{e}"
695
+ end
696
+ ```
697
+
698
+ ### Parameters
699
+
700
+ | Name | Type | Description | Notes |
701
+ | ---- | ---- | ----------- | ----- |
702
+ | **if_match** | **String** | Entity tag of the Template to be updated. Specify the tag that you retrieved when reading the account settings template. This value helps identifying parallel usage of this API. Pass * to indicate to update any version available. This might result in stale updates. | |
703
+ | **template_id** | **String** | ID of the account settings template | |
704
+ | **version** | **String** | Version of the account settings template | |
705
+ | **authorization** | **String** | Authorization Token used for the request. The supported token type is a Cloud IAM Access Token. If the token is omitted the request will fail with BXNIM0308E: &#39;No authorization header found&#39;. Make sure that the provided token has the required authority for the request. | |
706
+ | **account_settings_template_request** | [**AccountSettingsTemplateRequest**](AccountSettingsTemplateRequest.md) | Request to create an account settings template. | |
707
+
708
+ ### Return type
709
+
710
+ [**AccountSettingsTemplateResponse**](AccountSettingsTemplateResponse.md)
711
+
712
+ ### Authorization
713
+
714
+ No authorization required
715
+
716
+ ### HTTP request headers
717
+
718
+ - **Content-Type**: application/json
719
+ - **Accept**: application/json
720
+