ionoscloud 5.1.1 → 6.0.0.beta.4
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +9 -19
- data/docs/CHANGELOG.md +1 -0
- data/docs/README.md +4 -4
- data/docs/api/BackupUnitsApi.md +594 -0
- data/docs/api/ContractResourcesApi.md +89 -0
- data/docs/api/DataCentersApi.md +516 -0
- data/docs/api/DefaultApi.md +8 -19
- data/docs/api/FirewallRulesApi.md +552 -0
- data/docs/api/FlowLogsApi.md +540 -0
- data/docs/api/IPBlocksApi.md +50 -51
- data/docs/api/ImagesApi.md +428 -0
- data/docs/api/KubernetesApi.md +131 -211
- data/docs/api/LabelsApi.md +2338 -0
- data/docs/api/LansApi.md +794 -0
- data/docs/api/LoadBalancersApi.md +877 -0
- data/docs/api/LocationsApi.md +259 -0
- data/docs/api/NATGatewaysApi.md +1574 -0
- data/docs/api/NetworkInterfacesApi.md +540 -0
- data/docs/api/NetworkLoadBalancersApi.md +1586 -0
- data/docs/api/PrivateCrossConnectsApi.md +426 -0
- data/docs/api/{RequestApi.md → RequestsApi.md} +36 -36
- data/docs/api/ServersApi.md +1908 -0
- data/docs/api/SnapshotsApi.md +428 -0
- data/docs/api/TemplatesApi.md +165 -0
- data/docs/api/UserManagementApi.md +173 -687
- data/docs/api/UserS3KeysApi.md +516 -0
- data/docs/api/VolumesApi.md +709 -0
- data/docs/models/AttachedVolumes.md +1 -1
- data/docs/models/Cdroms.md +1 -1
- data/docs/models/Contracts.md +24 -0
- data/docs/models/CpuArchitectureProperties.md +24 -0
- data/docs/models/DataCenterEntities.md +5 -1
- data/docs/models/DatacenterProperties.md +3 -1
- data/docs/models/FirewallruleProperties.md +3 -1
- data/docs/models/FlowLog.md +26 -0
- data/docs/models/FlowLogProperties.md +24 -0
- data/docs/models/FlowLogPut.md +24 -0
- data/docs/models/FlowLogs.md +30 -0
- data/docs/models/Group.md +1 -1
- data/docs/models/GroupMembers.md +1 -1
- data/docs/models/GroupProperties.md +7 -1
- data/docs/models/GroupShare.md +1 -1
- data/docs/models/GroupShares.md +1 -1
- data/docs/models/GroupUsers.md +1 -1
- data/docs/models/Groups.md +1 -1
- data/docs/models/KubernetesAutoScaling.md +2 -2
- data/docs/models/KubernetesClusterProperties.md +1 -1
- data/docs/models/KubernetesClusterPropertiesForPost.md +1 -1
- data/docs/models/KubernetesClusterPropertiesForPut.md +1 -1
- data/docs/models/KubernetesClusters.md +1 -1
- data/docs/models/KubernetesMaintenanceWindow.md +2 -2
- data/docs/models/KubernetesNodePoolLan.md +5 -1
- data/docs/models/KubernetesNodePoolLanRoutes.md +20 -0
- data/docs/models/KubernetesNodePools.md +1 -1
- data/docs/models/Lans.md +1 -1
- data/docs/models/LocationProperties.md +3 -1
- data/docs/models/NatGateway.md +28 -0
- data/docs/models/NatGatewayEntities.md +20 -0
- data/docs/models/NatGatewayLanProperties.md +20 -0
- data/docs/models/NatGatewayProperties.md +22 -0
- data/docs/models/NatGatewayPut.md +24 -0
- data/docs/models/NatGatewayRule.md +26 -0
- data/docs/models/NatGatewayRuleProperties.md +30 -0
- data/docs/models/NatGatewayRuleProtocol.md +15 -0
- data/docs/models/NatGatewayRulePut.md +24 -0
- data/docs/models/NatGatewayRuleType.md +15 -0
- data/docs/models/NatGatewayRules.md +24 -0
- data/docs/models/NatGateways.md +30 -0
- data/docs/models/NetworkLoadBalancer.md +28 -0
- data/docs/models/NetworkLoadBalancerEntities.md +20 -0
- data/docs/models/NetworkLoadBalancerForwardingRule.md +26 -0
- data/docs/models/NetworkLoadBalancerForwardingRuleHealthCheck.md +24 -0
- data/docs/models/NetworkLoadBalancerForwardingRuleProperties.md +30 -0
- data/docs/models/NetworkLoadBalancerForwardingRulePut.md +24 -0
- data/docs/models/NetworkLoadBalancerForwardingRuleTarget.md +24 -0
- data/docs/models/NetworkLoadBalancerForwardingRuleTargetHealthCheck.md +22 -0
- data/docs/models/NetworkLoadBalancerForwardingRules.md +30 -0
- data/docs/models/NetworkLoadBalancerProperties.md +26 -0
- data/docs/models/NetworkLoadBalancerPut.md +24 -0
- data/docs/models/NetworkLoadBalancers.md +30 -0
- data/docs/models/NicEntities.md +2 -0
- data/docs/models/NicProperties.md +6 -2
- data/docs/models/NicPut.md +24 -0
- data/docs/models/Nics.md +1 -1
- data/docs/models/PrivateCrossConnectProperties.md +1 -1
- data/docs/models/RemoteConsoleUrl.md +18 -0
- data/docs/models/Resource.md +1 -1
- data/docs/models/ResourceGroups.md +1 -1
- data/docs/models/ResourceLimits.md +11 -1
- data/docs/models/ResourceProperties.md +1 -1
- data/docs/models/Resources.md +1 -1
- data/docs/models/ResourcesUsers.md +1 -1
- data/docs/models/S3Bucket.md +1 -1
- data/docs/models/S3Key.md +1 -1
- data/docs/models/S3Keys.md +1 -1
- data/docs/models/ServerProperties.md +6 -2
- data/docs/models/TargetPortRange.md +20 -0
- data/docs/models/Template.md +26 -0
- data/docs/models/TemplateProperties.md +24 -0
- data/docs/models/Templates.md +24 -0
- data/docs/models/Token.md +18 -0
- data/docs/models/VolumeProperties.md +5 -3
- data/docs/summary.md +386 -159
- data/ionoscloud.gemspec +3 -3
- data/lib/ionoscloud/api/_api.rb +9 -9
- data/lib/ionoscloud/api/{backup_unit_api.rb → backup_units_api.rb} +101 -101
- data/lib/ionoscloud/api/contract_resources_api.rb +96 -0
- data/lib/ionoscloud/api/data_centers_api.rb +532 -0
- data/lib/ionoscloud/api/firewall_rules_api.rb +640 -0
- data/lib/ionoscloud/api/flow_logs_api.rb +622 -0
- data/lib/ionoscloud/api/{image_api.rb → images_api.rb} +71 -71
- data/lib/ionoscloud/api/ip_blocks_api.rb +55 -55
- data/lib/ionoscloud/api/kubernetes_api.rb +131 -194
- data/lib/ionoscloud/api/{label_api.rb → labels_api.rb} +416 -470
- data/lib/ionoscloud/api/{lan_api.rb → lans_api.rb} +178 -178
- data/lib/ionoscloud/api/{load_balancer_api.rb → load_balancers_api.rb} +198 -216
- data/lib/ionoscloud/api/{location_api.rb → locations_api.rb} +49 -49
- data/lib/ionoscloud/api/nat_gateways_api.rb +1672 -0
- data/lib/ionoscloud/api/network_interfaces_api.rb +604 -0
- data/lib/ionoscloud/api/network_load_balancers_api.rb +1690 -0
- data/lib/ionoscloud/api/{private_cross_connect_api.rb → private_cross_connects_api.rb} +76 -76
- data/lib/ionoscloud/api/{request_api.rb → requests_api.rb} +45 -45
- data/lib/ionoscloud/api/servers_api.rb +2023 -0
- data/lib/ionoscloud/api/{snapshot_api.rb → snapshots_api.rb} +77 -77
- data/lib/ionoscloud/api/templates_api.rb +164 -0
- data/lib/ionoscloud/api/user_management_api.rb +172 -667
- data/lib/ionoscloud/api/user_s3_keys_api.rb +517 -0
- data/lib/ionoscloud/api/{volume_api.rb → volumes_api.rb} +145 -145
- data/lib/ionoscloud/api_client.rb +5 -5
- data/lib/ionoscloud/api_error.rb +2 -2
- data/lib/ionoscloud/configuration.rb +4 -4
- data/lib/ionoscloud/models/attached_volumes.rb +2 -2
- data/lib/ionoscloud/models/backup_unit.rb +2 -2
- data/lib/ionoscloud/models/backup_unit_properties.rb +2 -2
- data/lib/ionoscloud/models/backup_unit_sso.rb +2 -2
- data/lib/ionoscloud/models/backup_units.rb +2 -2
- data/lib/ionoscloud/models/balanced_nics.rb +2 -2
- data/lib/ionoscloud/models/cdroms.rb +2 -2
- data/lib/ionoscloud/models/connectable_datacenter.rb +2 -2
- data/lib/ionoscloud/models/contract.rb +2 -2
- data/lib/ionoscloud/models/contract_properties.rb +2 -2
- data/lib/ionoscloud/models/contracts.rb +251 -0
- data/lib/ionoscloud/models/cpu_architecture_properties.rb +249 -0
- data/lib/ionoscloud/models/data_center_entities.rb +24 -6
- data/lib/ionoscloud/models/datacenter.rb +2 -2
- data/lib/ionoscloud/models/datacenter_element_metadata.rb +4 -4
- data/lib/ionoscloud/models/datacenter_properties.rb +18 -6
- data/lib/ionoscloud/models/datacenters.rb +2 -2
- data/lib/ionoscloud/models/error.rb +2 -2
- data/lib/ionoscloud/models/error_message.rb +2 -2
- data/lib/ionoscloud/models/firewall_rule.rb +2 -2
- data/lib/ionoscloud/models/firewall_rules.rb +2 -2
- data/lib/ionoscloud/models/firewallrule_properties.rb +28 -6
- data/lib/ionoscloud/models/flow_log.rb +262 -0
- data/lib/ionoscloud/models/flow_log_properties.rb +315 -0
- data/lib/ionoscloud/models/{kubernetes_config.rb → flow_log_put.rb} +9 -43
- data/lib/ionoscloud/models/flow_logs.rb +280 -0
- data/lib/ionoscloud/models/group.rb +2 -2
- data/lib/ionoscloud/models/group_entities.rb +2 -2
- data/lib/ionoscloud/models/group_members.rb +2 -2
- data/lib/ionoscloud/models/group_properties.rb +36 -6
- data/lib/ionoscloud/models/group_share.rb +2 -2
- data/lib/ionoscloud/models/group_share_properties.rb +2 -2
- data/lib/ionoscloud/models/group_shares.rb +2 -2
- data/lib/ionoscloud/models/group_users.rb +2 -2
- data/lib/ionoscloud/models/groups.rb +2 -2
- data/lib/ionoscloud/models/image.rb +2 -2
- data/lib/ionoscloud/models/image_properties.rb +2 -2
- data/lib/ionoscloud/models/images.rb +2 -2
- data/lib/ionoscloud/models/info.rb +2 -2
- data/lib/ionoscloud/models/ip_block.rb +2 -2
- data/lib/ionoscloud/models/ip_block_properties.rb +2 -2
- data/lib/ionoscloud/models/ip_blocks.rb +2 -2
- data/lib/ionoscloud/models/ip_consumer.rb +2 -2
- data/lib/ionoscloud/models/ip_failover.rb +2 -2
- data/lib/ionoscloud/models/kubernetes_auto_scaling.rb +12 -2
- data/lib/ionoscloud/models/kubernetes_cluster.rb +2 -2
- data/lib/ionoscloud/models/kubernetes_cluster_entities.rb +2 -2
- data/lib/ionoscloud/models/kubernetes_cluster_for_post.rb +2 -2
- data/lib/ionoscloud/models/kubernetes_cluster_for_put.rb +2 -2
- data/lib/ionoscloud/models/kubernetes_cluster_properties.rb +3 -3
- data/lib/ionoscloud/models/kubernetes_cluster_properties_for_post.rb +3 -3
- data/lib/ionoscloud/models/kubernetes_cluster_properties_for_put.rb +3 -3
- data/lib/ionoscloud/models/kubernetes_clusters.rb +3 -3
- data/lib/ionoscloud/models/kubernetes_maintenance_window.rb +12 -2
- data/lib/ionoscloud/models/kubernetes_node.rb +2 -2
- data/lib/ionoscloud/models/kubernetes_node_metadata.rb +4 -4
- data/lib/ionoscloud/models/kubernetes_node_pool.rb +2 -2
- data/lib/ionoscloud/models/kubernetes_node_pool_for_post.rb +2 -2
- data/lib/ionoscloud/models/kubernetes_node_pool_for_put.rb +2 -2
- data/lib/ionoscloud/models/kubernetes_node_pool_lan.rb +28 -6
- data/lib/ionoscloud/models/kubernetes_node_pool_lan_routes.rb +229 -0
- data/lib/ionoscloud/models/kubernetes_node_pool_properties.rb +2 -2
- data/lib/ionoscloud/models/kubernetes_node_pool_properties_for_post.rb +2 -2
- data/lib/ionoscloud/models/kubernetes_node_pool_properties_for_put.rb +2 -2
- data/lib/ionoscloud/models/kubernetes_node_pools.rb +3 -3
- data/lib/ionoscloud/models/kubernetes_node_properties.rb +2 -2
- data/lib/ionoscloud/models/kubernetes_nodes.rb +2 -2
- data/lib/ionoscloud/models/label.rb +2 -2
- data/lib/ionoscloud/models/label_properties.rb +2 -2
- data/lib/ionoscloud/models/label_resource.rb +2 -2
- data/lib/ionoscloud/models/label_resource_properties.rb +2 -2
- data/lib/ionoscloud/models/label_resources.rb +2 -2
- data/lib/ionoscloud/models/labels.rb +2 -2
- data/lib/ionoscloud/models/lan.rb +2 -2
- data/lib/ionoscloud/models/lan_entities.rb +2 -2
- data/lib/ionoscloud/models/lan_nics.rb +2 -2
- data/lib/ionoscloud/models/lan_post.rb +2 -2
- data/lib/ionoscloud/models/lan_properties.rb +2 -2
- data/lib/ionoscloud/models/lan_properties_post.rb +2 -2
- data/lib/ionoscloud/models/lans.rb +3 -3
- data/lib/ionoscloud/models/loadbalancer.rb +2 -2
- data/lib/ionoscloud/models/loadbalancer_entities.rb +2 -2
- data/lib/ionoscloud/models/loadbalancer_properties.rb +2 -2
- data/lib/ionoscloud/models/loadbalancers.rb +2 -2
- data/lib/ionoscloud/models/location.rb +2 -2
- data/lib/ionoscloud/models/location_properties.rb +18 -6
- data/lib/ionoscloud/models/locations.rb +2 -2
- data/lib/ionoscloud/models/nat_gateway.rb +271 -0
- data/lib/ionoscloud/models/nat_gateway_entities.rb +227 -0
- data/lib/ionoscloud/models/nat_gateway_lan_properties.rb +236 -0
- data/lib/ionoscloud/models/nat_gateway_properties.rb +253 -0
- data/lib/ionoscloud/models/nat_gateway_put.rb +253 -0
- data/lib/ionoscloud/models/nat_gateway_rule.rb +262 -0
- data/lib/ionoscloud/models/nat_gateway_rule_properties.rb +293 -0
- data/lib/ionoscloud/models/nat_gateway_rule_protocol.rb +39 -0
- data/lib/ionoscloud/models/nat_gateway_rule_put.rb +253 -0
- data/lib/ionoscloud/models/nat_gateway_rule_type.rb +36 -0
- data/lib/ionoscloud/models/nat_gateway_rules.rb +251 -0
- data/lib/ionoscloud/models/nat_gateways.rb +280 -0
- data/lib/ionoscloud/models/network_load_balancer.rb +271 -0
- data/lib/ionoscloud/models/network_load_balancer_entities.rb +227 -0
- data/lib/ionoscloud/models/network_load_balancer_forwarding_rule.rb +262 -0
- data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_health_check.rb +249 -0
- data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_properties.rb +356 -0
- data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_put.rb +253 -0
- data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_target.rb +263 -0
- data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_target_health_check.rb +239 -0
- data/lib/ionoscloud/models/network_load_balancer_forwarding_rules.rb +280 -0
- data/lib/ionoscloud/models/network_load_balancer_properties.rb +278 -0
- data/lib/ionoscloud/models/network_load_balancer_put.rb +253 -0
- data/lib/ionoscloud/models/network_load_balancers.rb +280 -0
- data/lib/ionoscloud/models/nic.rb +2 -2
- data/lib/ionoscloud/models/nic_entities.rb +12 -3
- data/lib/ionoscloud/models/nic_properties.rb +64 -10
- data/lib/ionoscloud/models/nic_put.rb +253 -0
- data/lib/ionoscloud/models/nics.rb +2 -2
- data/lib/ionoscloud/models/no_state_meta_data.rb +2 -2
- data/lib/ionoscloud/models/pagination_links.rb +2 -2
- data/lib/ionoscloud/models/peer.rb +2 -2
- data/lib/ionoscloud/models/private_cross_connect.rb +2 -2
- data/lib/ionoscloud/models/private_cross_connect_properties.rb +3 -3
- data/lib/ionoscloud/models/private_cross_connects.rb +2 -2
- data/lib/ionoscloud/models/{kubernetes_config_properties.rb → remote_console_url.rb} +13 -13
- data/lib/ionoscloud/models/request.rb +2 -2
- data/lib/ionoscloud/models/request_metadata.rb +2 -2
- data/lib/ionoscloud/models/request_properties.rb +2 -2
- data/lib/ionoscloud/models/request_status.rb +2 -2
- data/lib/ionoscloud/models/request_status_metadata.rb +2 -2
- data/lib/ionoscloud/models/request_target.rb +2 -2
- data/lib/ionoscloud/models/requests.rb +2 -2
- data/lib/ionoscloud/models/resource.rb +2 -2
- data/lib/ionoscloud/models/resource_entities.rb +2 -2
- data/lib/ionoscloud/models/resource_groups.rb +2 -2
- data/lib/ionoscloud/models/resource_limits.rb +81 -6
- data/lib/ionoscloud/models/resource_properties.rb +3 -3
- data/lib/ionoscloud/models/resource_reference.rb +2 -2
- data/lib/ionoscloud/models/resources.rb +2 -2
- data/lib/ionoscloud/models/resources_users.rb +2 -2
- data/lib/ionoscloud/models/s3_bucket.rb +3 -3
- data/lib/ionoscloud/models/s3_key.rb +2 -2
- data/lib/ionoscloud/models/s3_key_metadata.rb +2 -2
- data/lib/ionoscloud/models/s3_key_properties.rb +2 -2
- data/lib/ionoscloud/models/s3_keys.rb +2 -2
- data/lib/ionoscloud/models/s3_object_storage_sso.rb +2 -2
- data/lib/ionoscloud/models/server.rb +2 -2
- data/lib/ionoscloud/models/server_entities.rb +2 -2
- data/lib/ionoscloud/models/server_properties.rb +27 -7
- data/lib/ionoscloud/models/servers.rb +2 -2
- data/lib/ionoscloud/models/snapshot.rb +2 -2
- data/lib/ionoscloud/models/snapshot_properties.rb +2 -2
- data/lib/ionoscloud/models/snapshots.rb +2 -2
- data/lib/ionoscloud/models/target_port_range.rb +229 -0
- data/lib/ionoscloud/models/template.rb +262 -0
- data/lib/ionoscloud/models/template_properties.rb +269 -0
- data/lib/ionoscloud/models/templates.rb +251 -0
- data/lib/ionoscloud/models/token.rb +219 -0
- data/lib/ionoscloud/models/type.rb +10 -2
- data/lib/ionoscloud/models/user.rb +2 -2
- data/lib/ionoscloud/models/user_metadata.rb +2 -2
- data/lib/ionoscloud/models/user_post.rb +2 -2
- data/lib/ionoscloud/models/user_properties.rb +2 -2
- data/lib/ionoscloud/models/user_properties_post.rb +2 -2
- data/lib/ionoscloud/models/user_properties_put.rb +2 -2
- data/lib/ionoscloud/models/user_put.rb +2 -2
- data/lib/ionoscloud/models/users.rb +2 -2
- data/lib/ionoscloud/models/users_entities.rb +2 -2
- data/lib/ionoscloud/models/volume.rb +2 -2
- data/lib/ionoscloud/models/volume_properties.rb +16 -6
- data/lib/ionoscloud/models/volumes.rb +2 -2
- data/lib/ionoscloud/version.rb +3 -3
- data/lib/ionoscloud.rb +60 -18
- data/spec/api/_api_spec.rb +5 -5
- data/spec/api/backup_units_api_spec.rb +140 -0
- data/spec/api/contract_resources_api_spec.rb +49 -0
- data/spec/api/data_centers_api_spec.rb +128 -0
- data/spec/api/firewall_rules_api_spec.rb +146 -0
- data/spec/api/flow_logs_api_spec.rb +140 -0
- data/spec/api/images_api_spec.rb +111 -0
- data/spec/api/ip_blocks_api_spec.rb +27 -27
- data/spec/api/kubernetes_api_spec.rb +55 -67
- data/spec/api/labels_api_spec.rb +474 -0
- data/spec/api/lans_api_spec.rb +186 -0
- data/spec/api/load_balancers_api_spec.rb +201 -0
- data/spec/api/locations_api_spec.rb +80 -0
- data/spec/api/nat_gateways_api_spec.rb +334 -0
- data/spec/api/network_interfaces_api_spec.rb +140 -0
- data/spec/api/network_load_balancers_api_spec.rb +340 -0
- data/spec/api/private_cross_connects_api_spec.rb +110 -0
- data/spec/api/{request_api_spec.rb → requests_api_spec.rb} +19 -19
- data/spec/api/servers_api_spec.rb +401 -0
- data/spec/api/snapshots_api_spec.rb +111 -0
- data/spec/api/templates_api_spec.rb +60 -0
- data/spec/api/user_management_api_spec.rb +81 -174
- data/spec/api/user_s3_keys_api_spec.rb +128 -0
- data/spec/api/volumes_api_spec.rb +171 -0
- data/spec/api_client_spec.rb +2 -2
- data/spec/configuration_spec.rb +5 -5
- data/spec/models/attached_volumes_spec.rb +2 -2
- data/spec/models/backup_unit_properties_spec.rb +2 -2
- data/spec/models/backup_unit_spec.rb +2 -2
- data/spec/models/backup_unit_sso_spec.rb +2 -2
- data/spec/models/backup_units_spec.rb +2 -2
- data/spec/models/balanced_nics_spec.rb +2 -2
- data/spec/models/cdroms_spec.rb +2 -2
- data/spec/models/connectable_datacenter_spec.rb +2 -2
- data/spec/models/contract_properties_spec.rb +2 -2
- data/spec/models/contract_spec.rb +2 -2
- data/spec/models/contracts_spec.rb +52 -0
- data/spec/models/cpu_architecture_properties_spec.rb +52 -0
- data/spec/models/data_center_entities_spec.rb +14 -2
- data/spec/models/datacenter_element_metadata_spec.rb +3 -3
- data/spec/models/datacenter_properties_spec.rb +8 -2
- data/spec/models/datacenter_spec.rb +2 -2
- data/spec/models/datacenters_spec.rb +2 -2
- data/spec/models/error_message_spec.rb +2 -2
- data/spec/models/error_spec.rb +2 -2
- data/spec/models/firewall_rule_spec.rb +2 -2
- data/spec/models/firewall_rules_spec.rb +2 -2
- data/spec/models/firewallrule_properties_spec.rb +12 -2
- data/spec/models/flow_log_properties_spec.rb +60 -0
- data/spec/models/flow_log_put_spec.rb +52 -0
- data/spec/models/flow_log_spec.rb +58 -0
- data/spec/models/flow_logs_spec.rb +70 -0
- data/spec/models/group_entities_spec.rb +2 -2
- data/spec/models/group_members_spec.rb +2 -2
- data/spec/models/group_properties_spec.rb +20 -2
- data/spec/models/group_share_properties_spec.rb +2 -2
- data/spec/models/group_share_spec.rb +2 -2
- data/spec/models/group_shares_spec.rb +2 -2
- data/spec/models/group_spec.rb +2 -2
- data/spec/models/group_users_spec.rb +2 -2
- data/spec/models/groups_spec.rb +2 -2
- data/spec/models/image_properties_spec.rb +2 -2
- data/spec/models/image_spec.rb +2 -2
- data/spec/models/images_spec.rb +2 -2
- data/spec/models/info_spec.rb +2 -2
- data/spec/models/ip_block_properties_spec.rb +2 -2
- data/spec/models/ip_block_spec.rb +2 -2
- data/spec/models/ip_blocks_spec.rb +2 -2
- data/spec/models/ip_consumer_spec.rb +2 -2
- data/spec/models/ip_failover_spec.rb +2 -2
- data/spec/models/kubernetes_auto_scaling_spec.rb +2 -2
- data/spec/models/kubernetes_cluster_entities_spec.rb +2 -2
- data/spec/models/kubernetes_cluster_for_post_spec.rb +2 -2
- data/spec/models/kubernetes_cluster_for_put_spec.rb +2 -2
- data/spec/models/kubernetes_cluster_properties_for_post_spec.rb +2 -2
- data/spec/models/kubernetes_cluster_properties_for_put_spec.rb +2 -2
- data/spec/models/kubernetes_cluster_properties_spec.rb +2 -2
- data/spec/models/kubernetes_cluster_spec.rb +2 -2
- data/spec/models/kubernetes_clusters_spec.rb +2 -2
- data/spec/models/kubernetes_maintenance_window_spec.rb +2 -2
- data/spec/models/kubernetes_node_metadata_spec.rb +3 -3
- data/spec/models/kubernetes_node_pool_for_post_spec.rb +2 -2
- data/spec/models/kubernetes_node_pool_for_put_spec.rb +2 -2
- data/spec/models/kubernetes_node_pool_lan_routes_spec.rb +40 -0
- data/spec/models/kubernetes_node_pool_lan_spec.rb +14 -2
- data/spec/models/kubernetes_node_pool_properties_for_post_spec.rb +2 -2
- data/spec/models/kubernetes_node_pool_properties_for_put_spec.rb +2 -2
- data/spec/models/kubernetes_node_pool_properties_spec.rb +2 -2
- data/spec/models/kubernetes_node_pool_spec.rb +2 -2
- data/spec/models/kubernetes_node_pools_spec.rb +2 -2
- data/spec/models/kubernetes_node_properties_spec.rb +2 -2
- data/spec/models/kubernetes_node_spec.rb +2 -2
- data/spec/models/kubernetes_nodes_spec.rb +2 -2
- data/spec/models/label_properties_spec.rb +2 -2
- data/spec/models/label_resource_properties_spec.rb +2 -2
- data/spec/models/label_resource_spec.rb +2 -2
- data/spec/models/label_resources_spec.rb +2 -2
- data/spec/models/label_spec.rb +2 -2
- data/spec/models/labels_spec.rb +2 -2
- data/spec/models/lan_entities_spec.rb +2 -2
- data/spec/models/lan_nics_spec.rb +2 -2
- data/spec/models/lan_post_spec.rb +2 -2
- data/spec/models/lan_properties_post_spec.rb +2 -2
- data/spec/models/lan_properties_spec.rb +2 -2
- data/spec/models/lan_spec.rb +2 -2
- data/spec/models/lans_spec.rb +2 -2
- data/spec/models/loadbalancer_entities_spec.rb +2 -2
- data/spec/models/loadbalancer_properties_spec.rb +2 -2
- data/spec/models/loadbalancer_spec.rb +2 -2
- data/spec/models/loadbalancers_spec.rb +2 -2
- data/spec/models/location_properties_spec.rb +8 -2
- data/spec/models/location_spec.rb +2 -2
- data/spec/models/locations_spec.rb +2 -2
- data/spec/models/nat_gateway_entities_spec.rb +40 -0
- data/spec/models/nat_gateway_lan_properties_spec.rb +40 -0
- data/spec/models/nat_gateway_properties_spec.rb +46 -0
- data/spec/models/nat_gateway_put_spec.rb +52 -0
- data/spec/models/nat_gateway_rule_properties_spec.rb +70 -0
- data/spec/models/nat_gateway_rule_protocol_spec.rb +28 -0
- data/spec/models/nat_gateway_rule_put_spec.rb +52 -0
- data/spec/models/nat_gateway_rule_spec.rb +58 -0
- data/spec/models/nat_gateway_rule_type_spec.rb +28 -0
- data/spec/models/nat_gateway_rules_spec.rb +52 -0
- data/spec/models/nat_gateway_spec.rb +64 -0
- data/spec/models/nat_gateways_spec.rb +70 -0
- data/spec/models/network_load_balancer_entities_spec.rb +40 -0
- data/spec/models/network_load_balancer_forwarding_rule_health_check_spec.rb +52 -0
- data/spec/models/network_load_balancer_forwarding_rule_properties_spec.rb +78 -0
- data/spec/models/network_load_balancer_forwarding_rule_put_spec.rb +52 -0
- data/spec/models/network_load_balancer_forwarding_rule_spec.rb +58 -0
- data/spec/models/network_load_balancer_forwarding_rule_target_health_check_spec.rb +46 -0
- data/spec/models/network_load_balancer_forwarding_rule_target_spec.rb +52 -0
- data/spec/models/network_load_balancer_forwarding_rules_spec.rb +70 -0
- data/spec/models/network_load_balancer_properties_spec.rb +58 -0
- data/spec/models/network_load_balancer_put_spec.rb +52 -0
- data/spec/models/network_load_balancer_spec.rb +64 -0
- data/spec/models/network_load_balancers_spec.rb +70 -0
- data/spec/models/nic_entities_spec.rb +8 -2
- data/spec/models/nic_properties_spec.rb +19 -3
- data/spec/models/nic_put_spec.rb +52 -0
- data/spec/models/nic_spec.rb +2 -2
- data/spec/models/nics_spec.rb +2 -2
- data/spec/models/no_state_meta_data_spec.rb +2 -2
- data/spec/models/pagination_links_spec.rb +2 -2
- data/spec/models/peer_spec.rb +2 -2
- data/spec/models/private_cross_connect_properties_spec.rb +2 -2
- data/spec/models/private_cross_connect_spec.rb +2 -2
- data/spec/models/private_cross_connects_spec.rb +2 -2
- data/spec/models/remote_console_url_spec.rb +34 -0
- data/spec/models/request_metadata_spec.rb +2 -2
- data/spec/models/request_properties_spec.rb +2 -2
- data/spec/models/request_spec.rb +2 -2
- data/spec/models/request_status_metadata_spec.rb +2 -2
- data/spec/models/request_status_spec.rb +2 -2
- data/spec/models/request_target_spec.rb +2 -2
- data/spec/models/requests_spec.rb +2 -2
- data/spec/models/resource_entities_spec.rb +2 -2
- data/spec/models/resource_groups_spec.rb +2 -2
- data/spec/models/resource_limits_spec.rb +32 -2
- data/spec/models/resource_properties_spec.rb +2 -2
- data/spec/models/resource_reference_spec.rb +2 -2
- data/spec/models/resource_spec.rb +2 -2
- data/spec/models/resources_spec.rb +2 -2
- data/spec/models/resources_users_spec.rb +2 -2
- data/spec/models/s3_bucket_spec.rb +2 -2
- data/spec/models/s3_key_metadata_spec.rb +2 -2
- data/spec/models/s3_key_properties_spec.rb +2 -2
- data/spec/models/s3_key_spec.rb +2 -2
- data/spec/models/s3_keys_spec.rb +2 -2
- data/spec/models/s3_object_storage_sso_spec.rb +2 -2
- data/spec/models/server_entities_spec.rb +2 -2
- data/spec/models/server_properties_spec.rb +14 -2
- data/spec/models/server_spec.rb +2 -2
- data/spec/models/servers_spec.rb +2 -2
- data/spec/models/snapshot_properties_spec.rb +2 -2
- data/spec/models/snapshot_spec.rb +2 -2
- data/spec/models/snapshots_spec.rb +2 -2
- data/spec/models/target_port_range_spec.rb +40 -0
- data/spec/models/template_properties_spec.rb +52 -0
- data/spec/models/template_spec.rb +58 -0
- data/spec/models/templates_spec.rb +52 -0
- data/spec/models/token_spec.rb +34 -0
- data/spec/models/type_spec.rb +2 -2
- data/spec/models/user_metadata_spec.rb +2 -2
- data/spec/models/user_post_spec.rb +2 -2
- data/spec/models/user_properties_post_spec.rb +2 -2
- data/spec/models/user_properties_put_spec.rb +2 -2
- data/spec/models/user_properties_spec.rb +2 -2
- data/spec/models/user_put_spec.rb +2 -2
- data/spec/models/user_spec.rb +2 -2
- data/spec/models/users_entities_spec.rb +2 -2
- data/spec/models/users_spec.rb +2 -2
- data/spec/models/volume_properties_spec.rb +8 -2
- data/spec/models/volume_spec.rb +2 -2
- data/spec/models/volumes_spec.rb +2 -2
- data/spec/spec_helper.rb +2 -2
- metadata +246 -80
- data/Gemfile.lock +0 -68
- data/docs/api/BackupUnitApi.md +0 -595
- data/docs/api/ContractApi.md +0 -89
- data/docs/api/DataCenterApi.md +0 -517
- data/docs/api/ImageApi.md +0 -429
- data/docs/api/LabelApi.md +0 -2355
- data/docs/api/LanApi.md +0 -795
- data/docs/api/LoadBalancerApi.md +0 -883
- data/docs/api/LocationApi.md +0 -259
- data/docs/api/NicApi.md +0 -1087
- data/docs/api/PrivateCrossConnectApi.md +0 -427
- data/docs/api/ServerApi.md +0 -1573
- data/docs/api/SnapshotApi.md +0 -429
- data/docs/api/VolumeApi.md +0 -711
- data/docs/models/KubernetesConfig.md +0 -24
- data/docs/models/KubernetesConfigProperties.md +0 -18
- data/lib/ionoscloud/api/contract_api.rb +0 -96
- data/lib/ionoscloud/api/data_center_api.rb +0 -532
- data/lib/ionoscloud/api/nic_api.rb +0 -1222
- data/lib/ionoscloud/api/server_api.rb +0 -1679
- data/lib/test_driver.rb +0 -104
- data/spec/api/backup_unit_api_spec.rb +0 -140
- data/spec/api/contract_api_spec.rb +0 -49
- data/spec/api/data_center_api_spec.rb +0 -128
- data/spec/api/image_api_spec.rb +0 -111
- data/spec/api/label_api_spec.rb +0 -480
- data/spec/api/lan_api_spec.rb +0 -186
- data/spec/api/load_balancer_api_spec.rb +0 -203
- data/spec/api/location_api_spec.rb +0 -80
- data/spec/api/nic_api_spec.rb +0 -251
- data/spec/api/private_cross_connect_api_spec.rb +0 -110
- data/spec/api/server_api_spec.rb +0 -337
- data/spec/api/snapshot_api_spec.rb +0 -111
- data/spec/api/volume_api_spec.rb +0 -171
- data/spec/models/kubernetes_config_properties_spec.rb +0 -34
- data/spec/models/kubernetes_config_spec.rb +0 -56
@@ -1,6 +1,6 @@
|
|
1
1
|
# UserManagementApi
|
2
2
|
|
3
|
-
All URIs are relative to *https://api.ionos.com/cloudapi/
|
3
|
+
All URIs are relative to *https://api.ionos.com/cloudapi/v6*
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
@@ -28,17 +28,11 @@ All URIs are relative to *https://api.ionos.com/cloudapi/v5*
|
|
28
28
|
| [**um_users_owns_get**](UserManagementApi.md#um_users_owns_get) | **GET** /um/users/{userId}/owns | Retrieve a User's own resources |
|
29
29
|
| [**um_users_post**](UserManagementApi.md#um_users_post) | **POST** /um/users | Create a user |
|
30
30
|
| [**um_users_put**](UserManagementApi.md#um_users_put) | **PUT** /um/users/{userId} | Modify a user |
|
31
|
-
| [**um_users_s3keys_delete**](UserManagementApi.md#um_users_s3keys_delete) | **DELETE** /um/users/{userId}/s3keys/{keyId} | Delete a S3 key |
|
32
|
-
| [**um_users_s3keys_find_by_key_id**](UserManagementApi.md#um_users_s3keys_find_by_key_id) | **GET** /um/users/{userId}/s3keys/{keyId} | Retrieve given S3 key belonging to the given User |
|
33
|
-
| [**um_users_s3keys_get**](UserManagementApi.md#um_users_s3keys_get) | **GET** /um/users/{userId}/s3keys | Retrieve a User's S3 keys |
|
34
|
-
| [**um_users_s3keys_post**](UserManagementApi.md#um_users_s3keys_post) | **POST** /um/users/{userId}/s3keys | Create a S3 key for the given user |
|
35
|
-
| [**um_users_s3keys_put**](UserManagementApi.md#um_users_s3keys_put) | **PUT** /um/users/{userId}/s3keys/{keyId} | Modify a S3 key having the given key id |
|
36
|
-
| [**um_users_s3ssourl_get**](UserManagementApi.md#um_users_s3ssourl_get) | **GET** /um/users/{userId}/s3ssourl | Retrieve S3 object storage single signon URL for the given user |
|
37
31
|
|
38
32
|
|
39
33
|
## um_groups_delete
|
40
34
|
|
41
|
-
>
|
35
|
+
> um_groups_delete(group_id, opts)
|
42
36
|
|
43
37
|
Delete a Group
|
44
38
|
|
@@ -64,15 +58,14 @@ end
|
|
64
58
|
api_instance = Ionoscloud::UserManagementApi.new
|
65
59
|
group_id = 'group_id_example' # String | The unique ID of the group
|
66
60
|
opts = {
|
67
|
-
pretty: true, # Boolean | Controls whether response is pretty-printed (with
|
68
|
-
depth: 56, # Integer | Controls the
|
69
|
-
x_contract_number: 56 # Integer | Users
|
61
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
62
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
63
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
70
64
|
}
|
71
65
|
|
72
66
|
begin
|
73
67
|
# Delete a Group
|
74
|
-
|
75
|
-
p result
|
68
|
+
api_instance.um_groups_delete(group_id, opts)
|
76
69
|
rescue Ionoscloud::ApiError => e
|
77
70
|
puts "Error when calling UserManagementApi->um_groups_delete: #{e}"
|
78
71
|
end
|
@@ -80,9 +73,9 @@ end
|
|
80
73
|
|
81
74
|
#### Using the um_groups_delete_with_http_info variant
|
82
75
|
|
83
|
-
This returns an Array which contains the response data, status code and headers.
|
76
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
84
77
|
|
85
|
-
> <Array(
|
78
|
+
> <Array(nil, Integer, Hash)> um_groups_delete_with_http_info(group_id, opts)
|
86
79
|
|
87
80
|
```ruby
|
88
81
|
begin
|
@@ -90,7 +83,7 @@ begin
|
|
90
83
|
data, status_code, headers = api_instance.um_groups_delete_with_http_info(group_id, opts)
|
91
84
|
p status_code # => 2xx
|
92
85
|
p headers # => { ... }
|
93
|
-
p data # =>
|
86
|
+
p data # => nil
|
94
87
|
rescue Ionoscloud::ApiError => e
|
95
88
|
puts "Error when calling UserManagementApi->um_groups_delete_with_http_info: #{e}"
|
96
89
|
end
|
@@ -101,13 +94,13 @@ end
|
|
101
94
|
| Name | Type | Description | Notes |
|
102
95
|
| ---- | ---- | ----------- | ----- |
|
103
96
|
| **group_id** | **String** | The unique ID of the group | |
|
104
|
-
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with
|
105
|
-
| **depth** | **Integer** | Controls the
|
106
|
-
| **x_contract_number** | **Integer** | Users
|
97
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
98
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
99
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
107
100
|
|
108
101
|
### Return type
|
109
102
|
|
110
|
-
|
103
|
+
nil (empty response body)
|
111
104
|
|
112
105
|
### Authorization
|
113
106
|
|
@@ -147,9 +140,9 @@ end
|
|
147
140
|
api_instance = Ionoscloud::UserManagementApi.new
|
148
141
|
group_id = 'group_id_example' # String | The unique ID of the group
|
149
142
|
opts = {
|
150
|
-
pretty: true, # Boolean | Controls whether response is pretty-printed (with
|
151
|
-
depth: 56, # Integer | Controls the
|
152
|
-
x_contract_number: 56 # Integer | Users
|
143
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
144
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
145
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
153
146
|
}
|
154
147
|
|
155
148
|
begin
|
@@ -184,9 +177,9 @@ end
|
|
184
177
|
| Name | Type | Description | Notes |
|
185
178
|
| ---- | ---- | ----------- | ----- |
|
186
179
|
| **group_id** | **String** | The unique ID of the group | |
|
187
|
-
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with
|
188
|
-
| **depth** | **Integer** | Controls the
|
189
|
-
| **x_contract_number** | **Integer** | Users
|
180
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
181
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
182
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
190
183
|
|
191
184
|
### Return type
|
192
185
|
|
@@ -229,9 +222,9 @@ end
|
|
229
222
|
|
230
223
|
api_instance = Ionoscloud::UserManagementApi.new
|
231
224
|
opts = {
|
232
|
-
pretty: true, # Boolean | Controls whether response is pretty-printed (with
|
233
|
-
depth: 56, # Integer | Controls the
|
234
|
-
x_contract_number: 56 # Integer | Users
|
225
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
226
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
227
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
235
228
|
}
|
236
229
|
|
237
230
|
begin
|
@@ -265,9 +258,9 @@ end
|
|
265
258
|
|
266
259
|
| Name | Type | Description | Notes |
|
267
260
|
| ---- | ---- | ----------- | ----- |
|
268
|
-
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with
|
269
|
-
| **depth** | **Integer** | Controls the
|
270
|
-
| **x_contract_number** | **Integer** | Users
|
261
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
262
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
263
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
271
264
|
|
272
265
|
### Return type
|
273
266
|
|
@@ -311,9 +304,9 @@ end
|
|
311
304
|
api_instance = Ionoscloud::UserManagementApi.new
|
312
305
|
group = Ionoscloud::Group.new({properties: Ionoscloud::GroupProperties.new}) # Group | Group to be created
|
313
306
|
opts = {
|
314
|
-
pretty: true, # Boolean | Controls whether response is pretty-printed (with
|
315
|
-
depth: 56, # Integer | Controls the
|
316
|
-
x_contract_number: 56 # Integer | Users
|
307
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
308
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
309
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
317
310
|
}
|
318
311
|
|
319
312
|
begin
|
@@ -348,9 +341,9 @@ end
|
|
348
341
|
| Name | Type | Description | Notes |
|
349
342
|
| ---- | ---- | ----------- | ----- |
|
350
343
|
| **group** | [**Group**](Group.md) | Group to be created | |
|
351
|
-
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with
|
352
|
-
| **depth** | **Integer** | Controls the
|
353
|
-
| **x_contract_number** | **Integer** | Users
|
344
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
345
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
346
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
354
347
|
|
355
348
|
### Return type
|
356
349
|
|
@@ -395,9 +388,9 @@ api_instance = Ionoscloud::UserManagementApi.new
|
|
395
388
|
group_id = 'group_id_example' # String | The unique ID of the group
|
396
389
|
group = Ionoscloud::Group.new({properties: Ionoscloud::GroupProperties.new}) # Group | Modified properties of the Group
|
397
390
|
opts = {
|
398
|
-
pretty: true, # Boolean | Controls whether response is pretty-printed (with
|
399
|
-
depth: 56, # Integer | Controls the
|
400
|
-
x_contract_number: 56 # Integer | Users
|
391
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
392
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
393
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
401
394
|
}
|
402
395
|
|
403
396
|
begin
|
@@ -433,9 +426,9 @@ end
|
|
433
426
|
| ---- | ---- | ----------- | ----- |
|
434
427
|
| **group_id** | **String** | The unique ID of the group | |
|
435
428
|
| **group** | [**Group**](Group.md) | Modified properties of the Group | |
|
436
|
-
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with
|
437
|
-
| **depth** | **Integer** | Controls the
|
438
|
-
| **x_contract_number** | **Integer** | Users
|
429
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
430
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
431
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
439
432
|
|
440
433
|
### Return type
|
441
434
|
|
@@ -477,9 +470,9 @@ end
|
|
477
470
|
api_instance = Ionoscloud::UserManagementApi.new
|
478
471
|
group_id = 'group_id_example' # String | The unique ID of the group
|
479
472
|
opts = {
|
480
|
-
pretty: true, # Boolean | Controls whether response is pretty-printed (with
|
481
|
-
depth: 56, # Integer | Controls the
|
482
|
-
x_contract_number: 56 # Integer | Users
|
473
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
474
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
475
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
483
476
|
}
|
484
477
|
|
485
478
|
begin
|
@@ -514,9 +507,9 @@ end
|
|
514
507
|
| Name | Type | Description | Notes |
|
515
508
|
| ---- | ---- | ----------- | ----- |
|
516
509
|
| **group_id** | **String** | The unique ID of the group | |
|
517
|
-
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with
|
518
|
-
| **depth** | **Integer** | Controls the
|
519
|
-
| **x_contract_number** | **Integer** | Users
|
510
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
511
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
512
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
520
513
|
|
521
514
|
### Return type
|
522
515
|
|
@@ -534,7 +527,7 @@ Basic Authentication, Token Authentication
|
|
534
527
|
|
535
528
|
## um_groups_shares_delete
|
536
529
|
|
537
|
-
>
|
530
|
+
> um_groups_shares_delete(group_id, resource_id, opts)
|
538
531
|
|
539
532
|
Remove a resource from a group
|
540
533
|
|
@@ -561,15 +554,14 @@ api_instance = Ionoscloud::UserManagementApi.new
|
|
561
554
|
group_id = 'group_id_example' # String |
|
562
555
|
resource_id = 'resource_id_example' # String |
|
563
556
|
opts = {
|
564
|
-
pretty: true, # Boolean | Controls whether response is pretty-printed (with
|
565
|
-
depth: 56, # Integer | Controls the
|
566
|
-
x_contract_number: 56 # Integer | Users
|
557
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
558
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
559
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
567
560
|
}
|
568
561
|
|
569
562
|
begin
|
570
563
|
# Remove a resource from a group
|
571
|
-
|
572
|
-
p result
|
564
|
+
api_instance.um_groups_shares_delete(group_id, resource_id, opts)
|
573
565
|
rescue Ionoscloud::ApiError => e
|
574
566
|
puts "Error when calling UserManagementApi->um_groups_shares_delete: #{e}"
|
575
567
|
end
|
@@ -577,9 +569,9 @@ end
|
|
577
569
|
|
578
570
|
#### Using the um_groups_shares_delete_with_http_info variant
|
579
571
|
|
580
|
-
This returns an Array which contains the response data, status code and headers.
|
572
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
581
573
|
|
582
|
-
> <Array(
|
574
|
+
> <Array(nil, Integer, Hash)> um_groups_shares_delete_with_http_info(group_id, resource_id, opts)
|
583
575
|
|
584
576
|
```ruby
|
585
577
|
begin
|
@@ -587,7 +579,7 @@ begin
|
|
587
579
|
data, status_code, headers = api_instance.um_groups_shares_delete_with_http_info(group_id, resource_id, opts)
|
588
580
|
p status_code # => 2xx
|
589
581
|
p headers # => { ... }
|
590
|
-
p data # =>
|
582
|
+
p data # => nil
|
591
583
|
rescue Ionoscloud::ApiError => e
|
592
584
|
puts "Error when calling UserManagementApi->um_groups_shares_delete_with_http_info: #{e}"
|
593
585
|
end
|
@@ -599,13 +591,13 @@ end
|
|
599
591
|
| ---- | ---- | ----------- | ----- |
|
600
592
|
| **group_id** | **String** | | |
|
601
593
|
| **resource_id** | **String** | | |
|
602
|
-
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with
|
603
|
-
| **depth** | **Integer** | Controls the
|
604
|
-
| **x_contract_number** | **Integer** | Users
|
594
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
595
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
596
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
605
597
|
|
606
598
|
### Return type
|
607
599
|
|
608
|
-
|
600
|
+
nil (empty response body)
|
609
601
|
|
610
602
|
### Authorization
|
611
603
|
|
@@ -646,9 +638,9 @@ api_instance = Ionoscloud::UserManagementApi.new
|
|
646
638
|
group_id = 'group_id_example' # String |
|
647
639
|
resource_id = 'resource_id_example' # String |
|
648
640
|
opts = {
|
649
|
-
pretty: true, # Boolean | Controls whether response is pretty-printed (with
|
650
|
-
depth: 56, # Integer | Controls the
|
651
|
-
x_contract_number: 56 # Integer | Users
|
641
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
642
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
643
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
652
644
|
}
|
653
645
|
|
654
646
|
begin
|
@@ -684,9 +676,9 @@ end
|
|
684
676
|
| ---- | ---- | ----------- | ----- |
|
685
677
|
| **group_id** | **String** | | |
|
686
678
|
| **resource_id** | **String** | | |
|
687
|
-
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with
|
688
|
-
| **depth** | **Integer** | Controls the
|
689
|
-
| **x_contract_number** | **Integer** | Users
|
679
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
680
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
681
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
690
682
|
|
691
683
|
### Return type
|
692
684
|
|
@@ -730,9 +722,9 @@ end
|
|
730
722
|
api_instance = Ionoscloud::UserManagementApi.new
|
731
723
|
group_id = 'group_id_example' # String |
|
732
724
|
opts = {
|
733
|
-
pretty: true, # Boolean | Controls whether response is pretty-printed (with
|
734
|
-
depth: 56, # Integer | Controls the
|
735
|
-
x_contract_number: 56 # Integer | Users
|
725
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
726
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
727
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
736
728
|
}
|
737
729
|
|
738
730
|
begin
|
@@ -767,9 +759,9 @@ end
|
|
767
759
|
| Name | Type | Description | Notes |
|
768
760
|
| ---- | ---- | ----------- | ----- |
|
769
761
|
| **group_id** | **String** | | |
|
770
|
-
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with
|
771
|
-
| **depth** | **Integer** | Controls the
|
772
|
-
| **x_contract_number** | **Integer** | Users
|
762
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
763
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
764
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
773
765
|
|
774
766
|
### Return type
|
775
767
|
|
@@ -815,9 +807,9 @@ group_id = 'group_id_example' # String |
|
|
815
807
|
resource_id = 'resource_id_example' # String |
|
816
808
|
resource = Ionoscloud::GroupShare.new({properties: Ionoscloud::GroupShareProperties.new}) # GroupShare | Resource to be added
|
817
809
|
opts = {
|
818
|
-
pretty: true, # Boolean | Controls whether response is pretty-printed (with
|
819
|
-
depth: 56, # Integer | Controls the
|
820
|
-
x_contract_number: 56 # Integer | Users
|
810
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
811
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
812
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
821
813
|
}
|
822
814
|
|
823
815
|
begin
|
@@ -854,9 +846,9 @@ end
|
|
854
846
|
| **group_id** | **String** | | |
|
855
847
|
| **resource_id** | **String** | | |
|
856
848
|
| **resource** | [**GroupShare**](GroupShare.md) | Resource to be added | |
|
857
|
-
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with
|
858
|
-
| **depth** | **Integer** | Controls the
|
859
|
-
| **x_contract_number** | **Integer** | Users
|
849
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
850
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
851
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
860
852
|
|
861
853
|
### Return type
|
862
854
|
|
@@ -902,9 +894,9 @@ group_id = 'group_id_example' # String |
|
|
902
894
|
resource_id = 'resource_id_example' # String |
|
903
895
|
resource = Ionoscloud::GroupShare.new({properties: Ionoscloud::GroupShareProperties.new}) # GroupShare | Modified Resource
|
904
896
|
opts = {
|
905
|
-
pretty: true, # Boolean | Controls whether response is pretty-printed (with
|
906
|
-
depth: 56, # Integer | Controls the
|
907
|
-
x_contract_number: 56 # Integer | Users
|
897
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
898
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
899
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
908
900
|
}
|
909
901
|
|
910
902
|
begin
|
@@ -941,9 +933,9 @@ end
|
|
941
933
|
| **group_id** | **String** | | |
|
942
934
|
| **resource_id** | **String** | | |
|
943
935
|
| **resource** | [**GroupShare**](GroupShare.md) | Modified Resource | |
|
944
|
-
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with
|
945
|
-
| **depth** | **Integer** | Controls the
|
946
|
-
| **x_contract_number** | **Integer** | Users
|
936
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
937
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
938
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
947
939
|
|
948
940
|
### Return type
|
949
941
|
|
@@ -961,11 +953,11 @@ Basic Authentication, Token Authentication
|
|
961
953
|
|
962
954
|
## um_groups_users_delete
|
963
955
|
|
964
|
-
>
|
956
|
+
> um_groups_users_delete(group_id, user_id, opts)
|
965
957
|
|
966
958
|
Remove a user from a group
|
967
959
|
|
968
|
-
This will remove a user from a group
|
960
|
+
This will remove a user from a group.
|
969
961
|
|
970
962
|
### Examples
|
971
963
|
|
@@ -988,15 +980,14 @@ api_instance = Ionoscloud::UserManagementApi.new
|
|
988
980
|
group_id = 'group_id_example' # String |
|
989
981
|
user_id = 'user_id_example' # String |
|
990
982
|
opts = {
|
991
|
-
pretty: true, # Boolean | Controls whether response is pretty-printed (with
|
992
|
-
depth: 56, # Integer | Controls the
|
993
|
-
x_contract_number: 56 # Integer | Users
|
983
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
984
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
985
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
994
986
|
}
|
995
987
|
|
996
988
|
begin
|
997
989
|
# Remove a user from a group
|
998
|
-
|
999
|
-
p result
|
990
|
+
api_instance.um_groups_users_delete(group_id, user_id, opts)
|
1000
991
|
rescue Ionoscloud::ApiError => e
|
1001
992
|
puts "Error when calling UserManagementApi->um_groups_users_delete: #{e}"
|
1002
993
|
end
|
@@ -1004,9 +995,9 @@ end
|
|
1004
995
|
|
1005
996
|
#### Using the um_groups_users_delete_with_http_info variant
|
1006
997
|
|
1007
|
-
This returns an Array which contains the response data, status code and headers.
|
998
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
1008
999
|
|
1009
|
-
> <Array(
|
1000
|
+
> <Array(nil, Integer, Hash)> um_groups_users_delete_with_http_info(group_id, user_id, opts)
|
1010
1001
|
|
1011
1002
|
```ruby
|
1012
1003
|
begin
|
@@ -1014,7 +1005,7 @@ begin
|
|
1014
1005
|
data, status_code, headers = api_instance.um_groups_users_delete_with_http_info(group_id, user_id, opts)
|
1015
1006
|
p status_code # => 2xx
|
1016
1007
|
p headers # => { ... }
|
1017
|
-
p data # =>
|
1008
|
+
p data # => nil
|
1018
1009
|
rescue Ionoscloud::ApiError => e
|
1019
1010
|
puts "Error when calling UserManagementApi->um_groups_users_delete_with_http_info: #{e}"
|
1020
1011
|
end
|
@@ -1026,13 +1017,13 @@ end
|
|
1026
1017
|
| ---- | ---- | ----------- | ----- |
|
1027
1018
|
| **group_id** | **String** | | |
|
1028
1019
|
| **user_id** | **String** | | |
|
1029
|
-
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with
|
1030
|
-
| **depth** | **Integer** | Controls the
|
1031
|
-
| **x_contract_number** | **Integer** | Users
|
1020
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
1021
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
1022
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
1032
1023
|
|
1033
1024
|
### Return type
|
1034
1025
|
|
1035
|
-
|
1026
|
+
nil (empty response body)
|
1036
1027
|
|
1037
1028
|
### Authorization
|
1038
1029
|
|
@@ -1072,9 +1063,9 @@ end
|
|
1072
1063
|
api_instance = Ionoscloud::UserManagementApi.new
|
1073
1064
|
group_id = 'group_id_example' # String |
|
1074
1065
|
opts = {
|
1075
|
-
pretty: true, # Boolean | Controls whether response is pretty-printed (with
|
1076
|
-
depth: 56, # Integer | Controls the
|
1077
|
-
x_contract_number: 56 # Integer | Users
|
1066
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
1067
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
1068
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
1078
1069
|
}
|
1079
1070
|
|
1080
1071
|
begin
|
@@ -1109,9 +1100,9 @@ end
|
|
1109
1100
|
| Name | Type | Description | Notes |
|
1110
1101
|
| ---- | ---- | ----------- | ----- |
|
1111
1102
|
| **group_id** | **String** | | |
|
1112
|
-
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with
|
1113
|
-
| **depth** | **Integer** | Controls the
|
1114
|
-
| **x_contract_number** | **Integer** | Users
|
1103
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
1104
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
1105
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
1115
1106
|
|
1116
1107
|
### Return type
|
1117
1108
|
|
@@ -1156,9 +1147,9 @@ api_instance = Ionoscloud::UserManagementApi.new
|
|
1156
1147
|
group_id = 'group_id_example' # String |
|
1157
1148
|
user = Ionoscloud::User.new({properties: Ionoscloud::UserProperties.new}) # User | User to be added
|
1158
1149
|
opts = {
|
1159
|
-
pretty: true, # Boolean | Controls whether response is pretty-printed (with
|
1160
|
-
depth: 56, # Integer | Controls the
|
1161
|
-
x_contract_number: 56 # Integer | Users
|
1150
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
1151
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
1152
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
1162
1153
|
}
|
1163
1154
|
|
1164
1155
|
begin
|
@@ -1194,9 +1185,9 @@ end
|
|
1194
1185
|
| ---- | ---- | ----------- | ----- |
|
1195
1186
|
| **group_id** | **String** | | |
|
1196
1187
|
| **user** | [**User**](User.md) | User to be added | |
|
1197
|
-
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with
|
1198
|
-
| **depth** | **Integer** | Controls the
|
1199
|
-
| **x_contract_number** | **Integer** | Users
|
1188
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
1189
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
1190
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
1200
1191
|
|
1201
1192
|
### Return type
|
1202
1193
|
|
@@ -1240,9 +1231,9 @@ end
|
|
1240
1231
|
api_instance = Ionoscloud::UserManagementApi.new
|
1241
1232
|
resource_type = 'resource_type_example' # String | The resource Type
|
1242
1233
|
opts = {
|
1243
|
-
pretty: true, # Boolean | Controls whether response is pretty-printed (with
|
1244
|
-
depth: 56, # Integer | Controls the
|
1245
|
-
x_contract_number: 56 # Integer | Users
|
1234
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
1235
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
1236
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
1246
1237
|
}
|
1247
1238
|
|
1248
1239
|
begin
|
@@ -1277,9 +1268,9 @@ end
|
|
1277
1268
|
| Name | Type | Description | Notes |
|
1278
1269
|
| ---- | ---- | ----------- | ----- |
|
1279
1270
|
| **resource_type** | **String** | The resource Type | |
|
1280
|
-
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with
|
1281
|
-
| **depth** | **Integer** | Controls the
|
1282
|
-
| **x_contract_number** | **Integer** | Users
|
1271
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
1272
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
1273
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
1283
1274
|
|
1284
1275
|
### Return type
|
1285
1276
|
|
@@ -1324,9 +1315,9 @@ api_instance = Ionoscloud::UserManagementApi.new
|
|
1324
1315
|
resource_type = 'resource_type_example' # String | The resource Type
|
1325
1316
|
resource_id = 'resource_id_example' # String | The resource Uuid
|
1326
1317
|
opts = {
|
1327
|
-
pretty: true, # Boolean | Controls whether response is pretty-printed (with
|
1328
|
-
depth: 56, # Integer | Controls the
|
1329
|
-
x_contract_number: 56 # Integer | Users
|
1318
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
1319
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
1320
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
1330
1321
|
}
|
1331
1322
|
|
1332
1323
|
begin
|
@@ -1362,9 +1353,9 @@ end
|
|
1362
1353
|
| ---- | ---- | ----------- | ----- |
|
1363
1354
|
| **resource_type** | **String** | The resource Type | |
|
1364
1355
|
| **resource_id** | **String** | The resource Uuid | |
|
1365
|
-
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with
|
1366
|
-
| **depth** | **Integer** | Controls the
|
1367
|
-
| **x_contract_number** | **Integer** | Users
|
1356
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
1357
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
1358
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
1368
1359
|
|
1369
1360
|
### Return type
|
1370
1361
|
|
@@ -1386,7 +1377,7 @@ Basic Authentication, Token Authentication
|
|
1386
1377
|
|
1387
1378
|
List All Resources.
|
1388
1379
|
|
1389
|
-
You can retrieve a complete list of all resources that you have access to
|
1380
|
+
You can retrieve a complete list of all resources that you have access to.
|
1390
1381
|
|
1391
1382
|
### Examples
|
1392
1383
|
|
@@ -1407,9 +1398,9 @@ end
|
|
1407
1398
|
|
1408
1399
|
api_instance = Ionoscloud::UserManagementApi.new
|
1409
1400
|
opts = {
|
1410
|
-
pretty: true, # Boolean | Controls whether response is pretty-printed (with
|
1411
|
-
depth: 56, # Integer | Controls the
|
1412
|
-
x_contract_number: 56 # Integer | Users
|
1401
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
1402
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
1403
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
1413
1404
|
}
|
1414
1405
|
|
1415
1406
|
begin
|
@@ -1443,9 +1434,9 @@ end
|
|
1443
1434
|
|
1444
1435
|
| Name | Type | Description | Notes |
|
1445
1436
|
| ---- | ---- | ----------- | ----- |
|
1446
|
-
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with
|
1447
|
-
| **depth** | **Integer** | Controls the
|
1448
|
-
| **x_contract_number** | **Integer** | Users
|
1437
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
1438
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
1439
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
1449
1440
|
|
1450
1441
|
### Return type
|
1451
1442
|
|
@@ -1463,7 +1454,7 @@ Basic Authentication, Token Authentication
|
|
1463
1454
|
|
1464
1455
|
## um_users_delete
|
1465
1456
|
|
1466
|
-
>
|
1457
|
+
> um_users_delete(user_id, opts)
|
1467
1458
|
|
1468
1459
|
Delete a User
|
1469
1460
|
|
@@ -1489,15 +1480,14 @@ end
|
|
1489
1480
|
api_instance = Ionoscloud::UserManagementApi.new
|
1490
1481
|
user_id = 'user_id_example' # String | The unique ID of the user
|
1491
1482
|
opts = {
|
1492
|
-
pretty: true, # Boolean | Controls whether response is pretty-printed (with
|
1493
|
-
depth: 56, # Integer | Controls the
|
1494
|
-
x_contract_number: 56 # Integer | Users
|
1483
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
1484
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
1485
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
1495
1486
|
}
|
1496
1487
|
|
1497
1488
|
begin
|
1498
1489
|
# Delete a User
|
1499
|
-
|
1500
|
-
p result
|
1490
|
+
api_instance.um_users_delete(user_id, opts)
|
1501
1491
|
rescue Ionoscloud::ApiError => e
|
1502
1492
|
puts "Error when calling UserManagementApi->um_users_delete: #{e}"
|
1503
1493
|
end
|
@@ -1505,9 +1495,9 @@ end
|
|
1505
1495
|
|
1506
1496
|
#### Using the um_users_delete_with_http_info variant
|
1507
1497
|
|
1508
|
-
This returns an Array which contains the response data, status code and headers.
|
1498
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
1509
1499
|
|
1510
|
-
> <Array(
|
1500
|
+
> <Array(nil, Integer, Hash)> um_users_delete_with_http_info(user_id, opts)
|
1511
1501
|
|
1512
1502
|
```ruby
|
1513
1503
|
begin
|
@@ -1515,7 +1505,7 @@ begin
|
|
1515
1505
|
data, status_code, headers = api_instance.um_users_delete_with_http_info(user_id, opts)
|
1516
1506
|
p status_code # => 2xx
|
1517
1507
|
p headers # => { ... }
|
1518
|
-
p data # =>
|
1508
|
+
p data # => nil
|
1519
1509
|
rescue Ionoscloud::ApiError => e
|
1520
1510
|
puts "Error when calling UserManagementApi->um_users_delete_with_http_info: #{e}"
|
1521
1511
|
end
|
@@ -1526,13 +1516,13 @@ end
|
|
1526
1516
|
| Name | Type | Description | Notes |
|
1527
1517
|
| ---- | ---- | ----------- | ----- |
|
1528
1518
|
| **user_id** | **String** | The unique ID of the user | |
|
1529
|
-
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with
|
1530
|
-
| **depth** | **Integer** | Controls the
|
1531
|
-
| **x_contract_number** | **Integer** | Users
|
1519
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
1520
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
1521
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
1532
1522
|
|
1533
1523
|
### Return type
|
1534
1524
|
|
1535
|
-
|
1525
|
+
nil (empty response body)
|
1536
1526
|
|
1537
1527
|
### Authorization
|
1538
1528
|
|
@@ -1572,9 +1562,9 @@ end
|
|
1572
1562
|
api_instance = Ionoscloud::UserManagementApi.new
|
1573
1563
|
user_id = 'user_id_example' # String | The unique ID of the user
|
1574
1564
|
opts = {
|
1575
|
-
pretty: true, # Boolean | Controls whether response is pretty-printed (with
|
1576
|
-
depth: 56, # Integer | Controls the
|
1577
|
-
x_contract_number: 56 # Integer | Users
|
1565
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
1566
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
1567
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
1578
1568
|
}
|
1579
1569
|
|
1580
1570
|
begin
|
@@ -1609,9 +1599,9 @@ end
|
|
1609
1599
|
| Name | Type | Description | Notes |
|
1610
1600
|
| ---- | ---- | ----------- | ----- |
|
1611
1601
|
| **user_id** | **String** | The unique ID of the user | |
|
1612
|
-
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with
|
1613
|
-
| **depth** | **Integer** | Controls the
|
1614
|
-
| **x_contract_number** | **Integer** | Users
|
1602
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
1603
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
1604
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
1615
1605
|
|
1616
1606
|
### Return type
|
1617
1607
|
|
@@ -1654,10 +1644,10 @@ end
|
|
1654
1644
|
|
1655
1645
|
api_instance = Ionoscloud::UserManagementApi.new
|
1656
1646
|
opts = {
|
1657
|
-
pretty: true, # Boolean | Controls whether response is pretty-printed (with
|
1658
|
-
depth: 56, # Integer | Controls the
|
1659
|
-
x_contract_number: 56, # Integer | Users
|
1660
|
-
offset: 56, # Integer |
|
1647
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
1648
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
1649
|
+
x_contract_number: 56, # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
1650
|
+
offset: 56, # Integer | The first element (from the complete list of the elements) to include in the response (use together with limit for pagination).
|
1661
1651
|
limit: 56 # Integer | the maximum number of elements to return (use together with <code>offset</code> for pagination)
|
1662
1652
|
}
|
1663
1653
|
|
@@ -1692,10 +1682,10 @@ end
|
|
1692
1682
|
|
1693
1683
|
| Name | Type | Description | Notes |
|
1694
1684
|
| ---- | ---- | ----------- | ----- |
|
1695
|
-
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with
|
1696
|
-
| **depth** | **Integer** | Controls the
|
1697
|
-
| **x_contract_number** | **Integer** | Users
|
1698
|
-
| **offset** | **Integer** |
|
1685
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
1686
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
1687
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
1688
|
+
| **offset** | **Integer** | The first element (from the complete list of the elements) to include in the response (use together with limit for pagination). | [optional][default to 0] |
|
1699
1689
|
| **limit** | **Integer** | the maximum number of elements to return (use together with <code>offset</code> for pagination) | [optional][default to 100] |
|
1700
1690
|
|
1701
1691
|
### Return type
|
@@ -1740,9 +1730,9 @@ end
|
|
1740
1730
|
api_instance = Ionoscloud::UserManagementApi.new
|
1741
1731
|
user_id = 'user_id_example' # String | The unique ID of the user
|
1742
1732
|
opts = {
|
1743
|
-
pretty: true, # Boolean | Controls whether response is pretty-printed (with
|
1744
|
-
depth: 56, # Integer | Controls the
|
1745
|
-
x_contract_number: 56 # Integer | Users
|
1733
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
1734
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
1735
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
1746
1736
|
}
|
1747
1737
|
|
1748
1738
|
begin
|
@@ -1777,9 +1767,9 @@ end
|
|
1777
1767
|
| Name | Type | Description | Notes |
|
1778
1768
|
| ---- | ---- | ----------- | ----- |
|
1779
1769
|
| **user_id** | **String** | The unique ID of the user | |
|
1780
|
-
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with
|
1781
|
-
| **depth** | **Integer** | Controls the
|
1782
|
-
| **x_contract_number** | **Integer** | Users
|
1770
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
1771
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
1772
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
1783
1773
|
|
1784
1774
|
### Return type
|
1785
1775
|
|
@@ -1823,9 +1813,9 @@ end
|
|
1823
1813
|
api_instance = Ionoscloud::UserManagementApi.new
|
1824
1814
|
user_id = 'user_id_example' # String | The unique ID of the user
|
1825
1815
|
opts = {
|
1826
|
-
pretty: true, # Boolean | Controls whether response is pretty-printed (with
|
1827
|
-
depth: 56, # Integer | Controls the
|
1828
|
-
x_contract_number: 56 # Integer | Users
|
1816
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
1817
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
1818
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
1829
1819
|
}
|
1830
1820
|
|
1831
1821
|
begin
|
@@ -1860,9 +1850,9 @@ end
|
|
1860
1850
|
| Name | Type | Description | Notes |
|
1861
1851
|
| ---- | ---- | ----------- | ----- |
|
1862
1852
|
| **user_id** | **String** | The unique ID of the user | |
|
1863
|
-
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with
|
1864
|
-
| **depth** | **Integer** | Controls the
|
1865
|
-
| **x_contract_number** | **Integer** | Users
|
1853
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
1854
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
1855
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
1866
1856
|
|
1867
1857
|
### Return type
|
1868
1858
|
|
@@ -1906,9 +1896,9 @@ end
|
|
1906
1896
|
api_instance = Ionoscloud::UserManagementApi.new
|
1907
1897
|
user = Ionoscloud::UserPost.new({properties: Ionoscloud::UserPropertiesPost.new}) # UserPost | User to be created
|
1908
1898
|
opts = {
|
1909
|
-
pretty: true, # Boolean | Controls whether response is pretty-printed (with
|
1910
|
-
depth: 56, # Integer | Controls the
|
1911
|
-
x_contract_number: 56 # Integer | Users
|
1899
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
1900
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
1901
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
1912
1902
|
}
|
1913
1903
|
|
1914
1904
|
begin
|
@@ -1943,9 +1933,9 @@ end
|
|
1943
1933
|
| Name | Type | Description | Notes |
|
1944
1934
|
| ---- | ---- | ----------- | ----- |
|
1945
1935
|
| **user** | [**UserPost**](UserPost.md) | User to be created | |
|
1946
|
-
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with
|
1947
|
-
| **depth** | **Integer** | Controls the
|
1948
|
-
| **x_contract_number** | **Integer** | Users
|
1936
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
1937
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
1938
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
1949
1939
|
|
1950
1940
|
### Return type
|
1951
1941
|
|
@@ -1990,9 +1980,9 @@ api_instance = Ionoscloud::UserManagementApi.new
|
|
1990
1980
|
user_id = 'user_id_example' # String |
|
1991
1981
|
user = Ionoscloud::UserPut.new({properties: Ionoscloud::UserPropertiesPut.new}) # UserPut | Modified user
|
1992
1982
|
opts = {
|
1993
|
-
pretty: true, # Boolean | Controls whether response is pretty-printed (with
|
1994
|
-
depth: 56, # Integer | Controls the
|
1995
|
-
x_contract_number: 56 # Integer | Users
|
1983
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
1984
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
1985
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
1996
1986
|
}
|
1997
1987
|
|
1998
1988
|
begin
|
@@ -2028,9 +2018,9 @@ end
|
|
2028
2018
|
| ---- | ---- | ----------- | ----- |
|
2029
2019
|
| **user_id** | **String** | | |
|
2030
2020
|
| **user** | [**UserPut**](UserPut.md) | Modified user | |
|
2031
|
-
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with
|
2032
|
-
| **depth** | **Integer** | Controls the
|
2033
|
-
| **x_contract_number** | **Integer** | Users
|
2021
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
2022
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
2023
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
2034
2024
|
|
2035
2025
|
### Return type
|
2036
2026
|
|
@@ -2045,507 +2035,3 @@ Basic Authentication, Token Authentication
|
|
2045
2035
|
- **Content-Type**: application/json
|
2046
2036
|
- **Accept**: application/json
|
2047
2037
|
|
2048
|
-
|
2049
|
-
## um_users_s3keys_delete
|
2050
|
-
|
2051
|
-
> Object um_users_s3keys_delete(user_id, key_id, opts)
|
2052
|
-
|
2053
|
-
Delete a S3 key
|
2054
|
-
|
2055
|
-
Delete a S3 key
|
2056
|
-
|
2057
|
-
### Examples
|
2058
|
-
|
2059
|
-
```ruby
|
2060
|
-
require 'time'
|
2061
|
-
require 'ionoscloud'
|
2062
|
-
# setup authorization
|
2063
|
-
Ionoscloud.configure do |config|
|
2064
|
-
# Configure HTTP basic authorization: Basic Authentication
|
2065
|
-
config.username = 'YOUR USERNAME'
|
2066
|
-
config.password = 'YOUR PASSWORD'
|
2067
|
-
|
2068
|
-
# Configure API key authorization: Token Authentication
|
2069
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
2070
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2071
|
-
# config.api_key_prefix['Authorization'] = 'Bearer'
|
2072
|
-
end
|
2073
|
-
|
2074
|
-
api_instance = Ionoscloud::UserManagementApi.new
|
2075
|
-
user_id = 'user_id_example' # String | The unique ID of the user
|
2076
|
-
key_id = 'key_id_example' # String | The unique access key ID of the S3 key
|
2077
|
-
opts = {
|
2078
|
-
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
2079
|
-
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
|
2080
|
-
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
2081
|
-
}
|
2082
|
-
|
2083
|
-
begin
|
2084
|
-
# Delete a S3 key
|
2085
|
-
result = api_instance.um_users_s3keys_delete(user_id, key_id, opts)
|
2086
|
-
p result
|
2087
|
-
rescue Ionoscloud::ApiError => e
|
2088
|
-
puts "Error when calling UserManagementApi->um_users_s3keys_delete: #{e}"
|
2089
|
-
end
|
2090
|
-
```
|
2091
|
-
|
2092
|
-
#### Using the um_users_s3keys_delete_with_http_info variant
|
2093
|
-
|
2094
|
-
This returns an Array which contains the response data, status code and headers.
|
2095
|
-
|
2096
|
-
> <Array(Object, Integer, Hash)> um_users_s3keys_delete_with_http_info(user_id, key_id, opts)
|
2097
|
-
|
2098
|
-
```ruby
|
2099
|
-
begin
|
2100
|
-
# Delete a S3 key
|
2101
|
-
data, status_code, headers = api_instance.um_users_s3keys_delete_with_http_info(user_id, key_id, opts)
|
2102
|
-
p status_code # => 2xx
|
2103
|
-
p headers # => { ... }
|
2104
|
-
p data # => Object
|
2105
|
-
rescue Ionoscloud::ApiError => e
|
2106
|
-
puts "Error when calling UserManagementApi->um_users_s3keys_delete_with_http_info: #{e}"
|
2107
|
-
end
|
2108
|
-
```
|
2109
|
-
|
2110
|
-
### Parameters
|
2111
|
-
|
2112
|
-
| Name | Type | Description | Notes |
|
2113
|
-
| ---- | ---- | ----------- | ----- |
|
2114
|
-
| **user_id** | **String** | The unique ID of the user | |
|
2115
|
-
| **key_id** | **String** | The unique access key ID of the S3 key | |
|
2116
|
-
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
2117
|
-
| **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on | [optional][default to 0] |
|
2118
|
-
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
2119
|
-
|
2120
|
-
### Return type
|
2121
|
-
|
2122
|
-
**Object**
|
2123
|
-
|
2124
|
-
### Authorization
|
2125
|
-
|
2126
|
-
Basic Authentication, Token Authentication
|
2127
|
-
|
2128
|
-
### HTTP request headers
|
2129
|
-
|
2130
|
-
- **Content-Type**: Not defined
|
2131
|
-
- **Accept**: application/json
|
2132
|
-
|
2133
|
-
|
2134
|
-
## um_users_s3keys_find_by_key_id
|
2135
|
-
|
2136
|
-
> <S3Key> um_users_s3keys_find_by_key_id(user_id, key_id, opts)
|
2137
|
-
|
2138
|
-
Retrieve given S3 key belonging to the given User
|
2139
|
-
|
2140
|
-
You can retrieve S3 key belonging to the given User. This user Id can be found in the response body when a user is created or when you GET a list of users. The key Id can be found in the response body when a S3 key is created or when you GET a list of all S3 keys of a user
|
2141
|
-
|
2142
|
-
### Examples
|
2143
|
-
|
2144
|
-
```ruby
|
2145
|
-
require 'time'
|
2146
|
-
require 'ionoscloud'
|
2147
|
-
# setup authorization
|
2148
|
-
Ionoscloud.configure do |config|
|
2149
|
-
# Configure HTTP basic authorization: Basic Authentication
|
2150
|
-
config.username = 'YOUR USERNAME'
|
2151
|
-
config.password = 'YOUR PASSWORD'
|
2152
|
-
|
2153
|
-
# Configure API key authorization: Token Authentication
|
2154
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
2155
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2156
|
-
# config.api_key_prefix['Authorization'] = 'Bearer'
|
2157
|
-
end
|
2158
|
-
|
2159
|
-
api_instance = Ionoscloud::UserManagementApi.new
|
2160
|
-
user_id = 'user_id_example' # String | The unique ID of the user
|
2161
|
-
key_id = 'key_id_example' # String | The unique access key ID of the S3 key
|
2162
|
-
opts = {
|
2163
|
-
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
2164
|
-
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
|
2165
|
-
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
2166
|
-
}
|
2167
|
-
|
2168
|
-
begin
|
2169
|
-
# Retrieve given S3 key belonging to the given User
|
2170
|
-
result = api_instance.um_users_s3keys_find_by_key_id(user_id, key_id, opts)
|
2171
|
-
p result
|
2172
|
-
rescue Ionoscloud::ApiError => e
|
2173
|
-
puts "Error when calling UserManagementApi->um_users_s3keys_find_by_key_id: #{e}"
|
2174
|
-
end
|
2175
|
-
```
|
2176
|
-
|
2177
|
-
#### Using the um_users_s3keys_find_by_key_id_with_http_info variant
|
2178
|
-
|
2179
|
-
This returns an Array which contains the response data, status code and headers.
|
2180
|
-
|
2181
|
-
> <Array(<S3Key>, Integer, Hash)> um_users_s3keys_find_by_key_id_with_http_info(user_id, key_id, opts)
|
2182
|
-
|
2183
|
-
```ruby
|
2184
|
-
begin
|
2185
|
-
# Retrieve given S3 key belonging to the given User
|
2186
|
-
data, status_code, headers = api_instance.um_users_s3keys_find_by_key_id_with_http_info(user_id, key_id, opts)
|
2187
|
-
p status_code # => 2xx
|
2188
|
-
p headers # => { ... }
|
2189
|
-
p data # => <S3Key>
|
2190
|
-
rescue Ionoscloud::ApiError => e
|
2191
|
-
puts "Error when calling UserManagementApi->um_users_s3keys_find_by_key_id_with_http_info: #{e}"
|
2192
|
-
end
|
2193
|
-
```
|
2194
|
-
|
2195
|
-
### Parameters
|
2196
|
-
|
2197
|
-
| Name | Type | Description | Notes |
|
2198
|
-
| ---- | ---- | ----------- | ----- |
|
2199
|
-
| **user_id** | **String** | The unique ID of the user | |
|
2200
|
-
| **key_id** | **String** | The unique access key ID of the S3 key | |
|
2201
|
-
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
2202
|
-
| **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on | [optional][default to 0] |
|
2203
|
-
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
2204
|
-
|
2205
|
-
### Return type
|
2206
|
-
|
2207
|
-
[**S3Key**](S3Key.md)
|
2208
|
-
|
2209
|
-
### Authorization
|
2210
|
-
|
2211
|
-
Basic Authentication, Token Authentication
|
2212
|
-
|
2213
|
-
### HTTP request headers
|
2214
|
-
|
2215
|
-
- **Content-Type**: Not defined
|
2216
|
-
- **Accept**: application/json
|
2217
|
-
|
2218
|
-
|
2219
|
-
## um_users_s3keys_get
|
2220
|
-
|
2221
|
-
> <S3Keys> um_users_s3keys_get(user_id, opts)
|
2222
|
-
|
2223
|
-
Retrieve a User's S3 keys
|
2224
|
-
|
2225
|
-
You can retrieve S3 keys owned by a user by using the users ID. This user Id can be found in the response body when a user is created or when you GET a list of users.
|
2226
|
-
|
2227
|
-
### Examples
|
2228
|
-
|
2229
|
-
```ruby
|
2230
|
-
require 'time'
|
2231
|
-
require 'ionoscloud'
|
2232
|
-
# setup authorization
|
2233
|
-
Ionoscloud.configure do |config|
|
2234
|
-
# Configure HTTP basic authorization: Basic Authentication
|
2235
|
-
config.username = 'YOUR USERNAME'
|
2236
|
-
config.password = 'YOUR PASSWORD'
|
2237
|
-
|
2238
|
-
# Configure API key authorization: Token Authentication
|
2239
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
2240
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2241
|
-
# config.api_key_prefix['Authorization'] = 'Bearer'
|
2242
|
-
end
|
2243
|
-
|
2244
|
-
api_instance = Ionoscloud::UserManagementApi.new
|
2245
|
-
user_id = 'user_id_example' # String | The unique ID of the user
|
2246
|
-
opts = {
|
2247
|
-
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
2248
|
-
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
|
2249
|
-
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
2250
|
-
}
|
2251
|
-
|
2252
|
-
begin
|
2253
|
-
# Retrieve a User's S3 keys
|
2254
|
-
result = api_instance.um_users_s3keys_get(user_id, opts)
|
2255
|
-
p result
|
2256
|
-
rescue Ionoscloud::ApiError => e
|
2257
|
-
puts "Error when calling UserManagementApi->um_users_s3keys_get: #{e}"
|
2258
|
-
end
|
2259
|
-
```
|
2260
|
-
|
2261
|
-
#### Using the um_users_s3keys_get_with_http_info variant
|
2262
|
-
|
2263
|
-
This returns an Array which contains the response data, status code and headers.
|
2264
|
-
|
2265
|
-
> <Array(<S3Keys>, Integer, Hash)> um_users_s3keys_get_with_http_info(user_id, opts)
|
2266
|
-
|
2267
|
-
```ruby
|
2268
|
-
begin
|
2269
|
-
# Retrieve a User's S3 keys
|
2270
|
-
data, status_code, headers = api_instance.um_users_s3keys_get_with_http_info(user_id, opts)
|
2271
|
-
p status_code # => 2xx
|
2272
|
-
p headers # => { ... }
|
2273
|
-
p data # => <S3Keys>
|
2274
|
-
rescue Ionoscloud::ApiError => e
|
2275
|
-
puts "Error when calling UserManagementApi->um_users_s3keys_get_with_http_info: #{e}"
|
2276
|
-
end
|
2277
|
-
```
|
2278
|
-
|
2279
|
-
### Parameters
|
2280
|
-
|
2281
|
-
| Name | Type | Description | Notes |
|
2282
|
-
| ---- | ---- | ----------- | ----- |
|
2283
|
-
| **user_id** | **String** | The unique ID of the user | |
|
2284
|
-
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
2285
|
-
| **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on | [optional][default to 0] |
|
2286
|
-
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
2287
|
-
|
2288
|
-
### Return type
|
2289
|
-
|
2290
|
-
[**S3Keys**](S3Keys.md)
|
2291
|
-
|
2292
|
-
### Authorization
|
2293
|
-
|
2294
|
-
Basic Authentication, Token Authentication
|
2295
|
-
|
2296
|
-
### HTTP request headers
|
2297
|
-
|
2298
|
-
- **Content-Type**: Not defined
|
2299
|
-
- **Accept**: application/json
|
2300
|
-
|
2301
|
-
|
2302
|
-
## um_users_s3keys_post
|
2303
|
-
|
2304
|
-
> <S3Key> um_users_s3keys_post(user_id, opts)
|
2305
|
-
|
2306
|
-
Create a S3 key for the given user
|
2307
|
-
|
2308
|
-
Creates a S3 key for the given user. This user Id can be found in the response body when a user is created or when you GET a list of users. Maximum of 5 keys can be generated for a given user
|
2309
|
-
|
2310
|
-
### Examples
|
2311
|
-
|
2312
|
-
```ruby
|
2313
|
-
require 'time'
|
2314
|
-
require 'ionoscloud'
|
2315
|
-
# setup authorization
|
2316
|
-
Ionoscloud.configure do |config|
|
2317
|
-
# Configure HTTP basic authorization: Basic Authentication
|
2318
|
-
config.username = 'YOUR USERNAME'
|
2319
|
-
config.password = 'YOUR PASSWORD'
|
2320
|
-
|
2321
|
-
# Configure API key authorization: Token Authentication
|
2322
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
2323
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2324
|
-
# config.api_key_prefix['Authorization'] = 'Bearer'
|
2325
|
-
end
|
2326
|
-
|
2327
|
-
api_instance = Ionoscloud::UserManagementApi.new
|
2328
|
-
user_id = 'user_id_example' # String | The unique ID of the user
|
2329
|
-
opts = {
|
2330
|
-
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
2331
|
-
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
|
2332
|
-
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
2333
|
-
}
|
2334
|
-
|
2335
|
-
begin
|
2336
|
-
# Create a S3 key for the given user
|
2337
|
-
result = api_instance.um_users_s3keys_post(user_id, opts)
|
2338
|
-
p result
|
2339
|
-
rescue Ionoscloud::ApiError => e
|
2340
|
-
puts "Error when calling UserManagementApi->um_users_s3keys_post: #{e}"
|
2341
|
-
end
|
2342
|
-
```
|
2343
|
-
|
2344
|
-
#### Using the um_users_s3keys_post_with_http_info variant
|
2345
|
-
|
2346
|
-
This returns an Array which contains the response data, status code and headers.
|
2347
|
-
|
2348
|
-
> <Array(<S3Key>, Integer, Hash)> um_users_s3keys_post_with_http_info(user_id, opts)
|
2349
|
-
|
2350
|
-
```ruby
|
2351
|
-
begin
|
2352
|
-
# Create a S3 key for the given user
|
2353
|
-
data, status_code, headers = api_instance.um_users_s3keys_post_with_http_info(user_id, opts)
|
2354
|
-
p status_code # => 2xx
|
2355
|
-
p headers # => { ... }
|
2356
|
-
p data # => <S3Key>
|
2357
|
-
rescue Ionoscloud::ApiError => e
|
2358
|
-
puts "Error when calling UserManagementApi->um_users_s3keys_post_with_http_info: #{e}"
|
2359
|
-
end
|
2360
|
-
```
|
2361
|
-
|
2362
|
-
### Parameters
|
2363
|
-
|
2364
|
-
| Name | Type | Description | Notes |
|
2365
|
-
| ---- | ---- | ----------- | ----- |
|
2366
|
-
| **user_id** | **String** | The unique ID of the user | |
|
2367
|
-
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
2368
|
-
| **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on | [optional][default to 0] |
|
2369
|
-
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
2370
|
-
|
2371
|
-
### Return type
|
2372
|
-
|
2373
|
-
[**S3Key**](S3Key.md)
|
2374
|
-
|
2375
|
-
### Authorization
|
2376
|
-
|
2377
|
-
Basic Authentication, Token Authentication
|
2378
|
-
|
2379
|
-
### HTTP request headers
|
2380
|
-
|
2381
|
-
- **Content-Type**: Not defined
|
2382
|
-
- **Accept**: application/json
|
2383
|
-
|
2384
|
-
|
2385
|
-
## um_users_s3keys_put
|
2386
|
-
|
2387
|
-
> <S3Key> um_users_s3keys_put(user_id, key_id, s3_key, opts)
|
2388
|
-
|
2389
|
-
Modify a S3 key having the given key id
|
2390
|
-
|
2391
|
-
You can enable or disable a given S3 key.
|
2392
|
-
|
2393
|
-
### Examples
|
2394
|
-
|
2395
|
-
```ruby
|
2396
|
-
require 'time'
|
2397
|
-
require 'ionoscloud'
|
2398
|
-
# setup authorization
|
2399
|
-
Ionoscloud.configure do |config|
|
2400
|
-
# Configure HTTP basic authorization: Basic Authentication
|
2401
|
-
config.username = 'YOUR USERNAME'
|
2402
|
-
config.password = 'YOUR PASSWORD'
|
2403
|
-
|
2404
|
-
# Configure API key authorization: Token Authentication
|
2405
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
2406
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2407
|
-
# config.api_key_prefix['Authorization'] = 'Bearer'
|
2408
|
-
end
|
2409
|
-
|
2410
|
-
api_instance = Ionoscloud::UserManagementApi.new
|
2411
|
-
user_id = 'user_id_example' # String |
|
2412
|
-
key_id = 'key_id_example' # String | The unique access key ID of the S3 key
|
2413
|
-
s3_key = Ionoscloud::S3Key.new({properties: Ionoscloud::S3KeyProperties.new}) # S3Key | Modified S3 key
|
2414
|
-
opts = {
|
2415
|
-
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
2416
|
-
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
|
2417
|
-
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
2418
|
-
}
|
2419
|
-
|
2420
|
-
begin
|
2421
|
-
# Modify a S3 key having the given key id
|
2422
|
-
result = api_instance.um_users_s3keys_put(user_id, key_id, s3_key, opts)
|
2423
|
-
p result
|
2424
|
-
rescue Ionoscloud::ApiError => e
|
2425
|
-
puts "Error when calling UserManagementApi->um_users_s3keys_put: #{e}"
|
2426
|
-
end
|
2427
|
-
```
|
2428
|
-
|
2429
|
-
#### Using the um_users_s3keys_put_with_http_info variant
|
2430
|
-
|
2431
|
-
This returns an Array which contains the response data, status code and headers.
|
2432
|
-
|
2433
|
-
> <Array(<S3Key>, Integer, Hash)> um_users_s3keys_put_with_http_info(user_id, key_id, s3_key, opts)
|
2434
|
-
|
2435
|
-
```ruby
|
2436
|
-
begin
|
2437
|
-
# Modify a S3 key having the given key id
|
2438
|
-
data, status_code, headers = api_instance.um_users_s3keys_put_with_http_info(user_id, key_id, s3_key, opts)
|
2439
|
-
p status_code # => 2xx
|
2440
|
-
p headers # => { ... }
|
2441
|
-
p data # => <S3Key>
|
2442
|
-
rescue Ionoscloud::ApiError => e
|
2443
|
-
puts "Error when calling UserManagementApi->um_users_s3keys_put_with_http_info: #{e}"
|
2444
|
-
end
|
2445
|
-
```
|
2446
|
-
|
2447
|
-
### Parameters
|
2448
|
-
|
2449
|
-
| Name | Type | Description | Notes |
|
2450
|
-
| ---- | ---- | ----------- | ----- |
|
2451
|
-
| **user_id** | **String** | | |
|
2452
|
-
| **key_id** | **String** | The unique access key ID of the S3 key | |
|
2453
|
-
| **s3_key** | [**S3Key**](S3Key.md) | Modified S3 key | |
|
2454
|
-
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
2455
|
-
| **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on | [optional][default to 0] |
|
2456
|
-
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
2457
|
-
|
2458
|
-
### Return type
|
2459
|
-
|
2460
|
-
[**S3Key**](S3Key.md)
|
2461
|
-
|
2462
|
-
### Authorization
|
2463
|
-
|
2464
|
-
Basic Authentication, Token Authentication
|
2465
|
-
|
2466
|
-
### HTTP request headers
|
2467
|
-
|
2468
|
-
- **Content-Type**: application/json
|
2469
|
-
- **Accept**: application/json
|
2470
|
-
|
2471
|
-
|
2472
|
-
## um_users_s3ssourl_get
|
2473
|
-
|
2474
|
-
> <S3ObjectStorageSSO> um_users_s3ssourl_get(user_id, opts)
|
2475
|
-
|
2476
|
-
Retrieve S3 object storage single signon URL for the given user
|
2477
|
-
|
2478
|
-
You can retrieve S3 object storage single signon URL for the given user. This user Id can be found in the response body when a user is created or when you GET a list of users.
|
2479
|
-
|
2480
|
-
### Examples
|
2481
|
-
|
2482
|
-
```ruby
|
2483
|
-
require 'time'
|
2484
|
-
require 'ionoscloud'
|
2485
|
-
# setup authorization
|
2486
|
-
Ionoscloud.configure do |config|
|
2487
|
-
# Configure HTTP basic authorization: Basic Authentication
|
2488
|
-
config.username = 'YOUR USERNAME'
|
2489
|
-
config.password = 'YOUR PASSWORD'
|
2490
|
-
|
2491
|
-
# Configure API key authorization: Token Authentication
|
2492
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
2493
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2494
|
-
# config.api_key_prefix['Authorization'] = 'Bearer'
|
2495
|
-
end
|
2496
|
-
|
2497
|
-
api_instance = Ionoscloud::UserManagementApi.new
|
2498
|
-
user_id = 'user_id_example' # String | The unique ID of the user
|
2499
|
-
opts = {
|
2500
|
-
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
2501
|
-
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
2502
|
-
}
|
2503
|
-
|
2504
|
-
begin
|
2505
|
-
# Retrieve S3 object storage single signon URL for the given user
|
2506
|
-
result = api_instance.um_users_s3ssourl_get(user_id, opts)
|
2507
|
-
p result
|
2508
|
-
rescue Ionoscloud::ApiError => e
|
2509
|
-
puts "Error when calling UserManagementApi->um_users_s3ssourl_get: #{e}"
|
2510
|
-
end
|
2511
|
-
```
|
2512
|
-
|
2513
|
-
#### Using the um_users_s3ssourl_get_with_http_info variant
|
2514
|
-
|
2515
|
-
This returns an Array which contains the response data, status code and headers.
|
2516
|
-
|
2517
|
-
> <Array(<S3ObjectStorageSSO>, Integer, Hash)> um_users_s3ssourl_get_with_http_info(user_id, opts)
|
2518
|
-
|
2519
|
-
```ruby
|
2520
|
-
begin
|
2521
|
-
# Retrieve S3 object storage single signon URL for the given user
|
2522
|
-
data, status_code, headers = api_instance.um_users_s3ssourl_get_with_http_info(user_id, opts)
|
2523
|
-
p status_code # => 2xx
|
2524
|
-
p headers # => { ... }
|
2525
|
-
p data # => <S3ObjectStorageSSO>
|
2526
|
-
rescue Ionoscloud::ApiError => e
|
2527
|
-
puts "Error when calling UserManagementApi->um_users_s3ssourl_get_with_http_info: #{e}"
|
2528
|
-
end
|
2529
|
-
```
|
2530
|
-
|
2531
|
-
### Parameters
|
2532
|
-
|
2533
|
-
| Name | Type | Description | Notes |
|
2534
|
-
| ---- | ---- | ----------- | ----- |
|
2535
|
-
| **user_id** | **String** | The unique ID of the user | |
|
2536
|
-
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
2537
|
-
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
2538
|
-
|
2539
|
-
### Return type
|
2540
|
-
|
2541
|
-
[**S3ObjectStorageSSO**](S3ObjectStorageSSO.md)
|
2542
|
-
|
2543
|
-
### Authorization
|
2544
|
-
|
2545
|
-
Basic Authentication, Token Authentication
|
2546
|
-
|
2547
|
-
### HTTP request headers
|
2548
|
-
|
2549
|
-
- **Content-Type**: Not defined
|
2550
|
-
- **Accept**: application/json
|
2551
|
-
|