Skip to content

Latest commit

 

History

History
115 lines (93 loc) · 3.85 KB

cloud_admin_user.md

File metadata and controls

115 lines (93 loc) · 3.85 KB
page_title subcategory description
citrix_cloud_admin_user Resource - citrix
Citrix Cloud
Manages an administrator user for cloud environment.

citrix_cloud_admin_user (Resource)

Manages an administrator user for cloud environment.

Example Usage

resource "citrix_cloud_admin_user" "example-full-admin-user" {
  access_type   = "Full"
  email         = "example-full-admin@citrix.com"
  provider_type = "CitrixSts"
  type          = "AdministratorUser"
}

resource "citrix_cloud_admin_user" "example-custom-admin-user" {
  access_type   = "Custom"
  email         = "example-custom-admin@citrix.com"
  provider_type = "CitrixSts"
  type          = "AdministratorUser"
  policies = [
    {
      name         = "Example Policy 1"
      service_name = "XenDesktop"
      scopes       = ["Scope1", "Scope2"]
    },
    {
      name = "Example Policy 2"
    }
  ]
}

resource "citrix_cloud_admin_user" "example-custom-azure-ad-admin-group" {
  access_type          = "Custom"
  provider_type        = "AzureAd"
  display_name         = "Example Custom Azure Ad Admin Group"
  type                 = "AdministratorGroup"
  external_provider_id = "Example Azure Tenant Id"
  external_user_id     = "Example Azure Group Id"
  policies = [
    {
      name         = "Example Policy 1"
      scopes       = ["Scope1", "Scope2"]
    },
    {
      name = "Example Policy 2"
    }
  ]
}

resource "citrix_cloud_admin_user" "example-custom-ad-admin-group" {
  access_type          = "Custom"
  provider_type        = "Ad"
  display_name         = "Example Custom AD Admin Group"
  type                 = "AdministratorGroup"
  external_provider_id = "<DomainFQDN>"
  external_user_id     = "Example Group Id"
  policies = [
    {
      name         = "Example Policy 1"
    }
  ]
}

Schema

Required

  • access_type (String) Access Type of the user. Currently, this attribute can be set to Full or Custom.
  • provider_type (String) Identity provider for the administrator or group you want to add. Currently, this attribute can be set to CitrixSTS,AzureAd or Ad.
  • type (String) Type of administrator being added. Currently, this attribute can be set to AdministratorUser or AdministratorGroup. Note: AdministratorGroup is only supported for AzureAd and Ad provider type.

Optional

  • display_name (String) Display name for the user.
  • email (String) Email of the user where the invitation link will be sent.
  • external_provider_id (String) External provider Id for directory. For AzureAd, specify the external tenant ID. For Ad, specify the AD domain name in FQDN format (e.g., MyDomain.com).
  • external_user_id (String) External objectId for user or group from the directory.
  • first_name (String) First name of the user.
  • last_name (String) Last name of the user.
  • policies (Attributes List) Policies to be associated with the admin user. Only applicable when access_type is Custom. (see below for nested schema)

Read-Only

  • admin_id (String) Id of the administrator.

Nested Schema for policies

Required:

  • name (String) Name of the policy to be associated with the admin user.

Optional:

  • scopes (Set of String) Scope names to be associated with the admin user.
  • service_name (String) Name of the service to be associated with the admin user. Currently, this attribute can be set to XenDesktop, Platform, CAS, or WEM.

Import

Import is supported using the following syntax:

# Admin User can be imported by specifying their adminId which can be userId or ucOid. Note: Admin users must accept the invitation before they can be imported.
terraform import citrix_cloud_admin_user.example-admin-user f6197063-a7b3-49fc-a1df-42a042449bff