iam

Creates, updates, deletes, gets or lists an iam resource.

Overview

Name	iam
Type	Resource
Id	ovh.dedicated_cloud.iam

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
identity_provider_id	integer	Identity Provider ID (wire: identityProviderId)
state	string	State of the option (disabled, disabling, enabled, enabling, error, migrating, unknown)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	service_name		Get the IAM option
add_role	exec	serviceName, name		Create an IAM role. Creates a role with the given name for the OVHcloud IAM option. Returns a task to track progress.
disable	exec	serviceName		Disable IAM
enable	exec	serviceName		Enable IAM

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
api_host	string	The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
serviceName	string	Domain of the service
service_name	string	Domain of the service (wire: serviceName)

SELECT examples

get

Get the IAM option

SELECT
identity_provider_id,
state
FROM ovh.dedicated_cloud.iam
WHERE service_name = '{{ service_name }}' -- required
;

Lifecycle Methods

EXEC variables use wire (API) names.

add_role

Create an IAM role. Creates a role with the given name for the OVHcloud IAM option. Returns a task to track progress.

EXEC ovh.dedicated_cloud.iam.add_role 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"name": "{{ name }}"
}'
;

disable

Disable IAM

EXEC ovh.dedicated_cloud.iam.disable 
@serviceName='{{ serviceName }}' --required
;

enable

Enable IAM

EXEC ovh.dedicated_cloud.iam.enable 
@serviceName='{{ serviceName }}' --required
;