Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Googleworkspace Provider
  3. API Docs
  4. Provider
googleworkspace 0.7.0 published on Wednesday, Jan 15, 2025 by hashicorp
hashicorp/terraform-provider-googleworkspace

googleworkspace.Provider

Explore with Pulumi AI

googleworkspace logo
googleworkspace 0.7.0 published on Wednesday, Jan 15, 2025 by hashicorp
hashicorp/terraform-provider-googleworkspace

    The provider type for the googleworkspace package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

    Create Provider Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Provider(name: string, args?: ProviderArgs, opts?: CustomResourceOptions);
    @overload
def Provider(resource_name: str,
             args: Optional[ProviderArgs] = None,
             opts: Optional[ResourceOptions] = None)

@overload
def Provider(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             access_token: Optional[str] = None,
             credentials: Optional[str] = None,
             customer_id: Optional[str] = None,
             impersonated_user_email: Optional[str] = None,
             oauth_scopes: Optional[Sequence[str]] = None,
             service_account: Optional[str] = None)
    func NewProvider(ctx *Context, name string, args *ProviderArgs, opts ...ResourceOption) (*Provider, error)
    public Provider(string name, ProviderArgs? args = null, CustomResourceOptions? opts = null)
    public Provider(String name, ProviderArgs args)
public Provider(String name, ProviderArgs args, CustomResourceOptions options)

    type: pulumi:providers:googleworkspace
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Provider Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Provider resource accepts the following input properties:

    AccessToken string
    A temporary [OAuth 2.0 access token] obtained from the Google Authorization server, i.e. the Authorization: Bearer token used to authenticate HTTP requests to Google Admin SDK APIs. This is an alternative to credentials, and ignores the oauth_scopes field. If both are specified, access_token will be used over the credentials field.
    Credentials string
    Either the path to or the contents of a service account key file in JSON format you can manage key files using the Cloud Console). If not provided, the application default credentials will be used.
    CustomerId string
    The customer id provided with your Google Workspace subscription. It is found in the admin console under Account Settings.
    ImpersonatedUserEmail string
    The impersonated user's email with access to the Admin APIs can access the Admin SDK Directory API. impersonated_user_email is required for all services except group and user management.
    OauthScopes List<string>
    The list of the scopes required for your application (for a list of possible scopes, see Authorize requests)
    ServiceAccount string
    The service account used to create the provided access_token if authenticating using the access_token method and needing to impersonate a user. This service account will require the GCP role Service Account Token Creator if needing to impersonate a user.
    AccessToken string
    A temporary [OAuth 2.0 access token] obtained from the Google Authorization server, i.e. the Authorization: Bearer token used to authenticate HTTP requests to Google Admin SDK APIs. This is an alternative to credentials, and ignores the oauth_scopes field. If both are specified, access_token will be used over the credentials field.
    Credentials string
    Either the path to or the contents of a service account key file in JSON format you can manage key files using the Cloud Console). If not provided, the application default credentials will be used.
    CustomerId string
    The customer id provided with your Google Workspace subscription. It is found in the admin console under Account Settings.
    ImpersonatedUserEmail string
    The impersonated user's email with access to the Admin APIs can access the Admin SDK Directory API. impersonated_user_email is required for all services except group and user management.
    OauthScopes []string
    The list of the scopes required for your application (for a list of possible scopes, see Authorize requests)
    ServiceAccount string
    The service account used to create the provided access_token if authenticating using the access_token method and needing to impersonate a user. This service account will require the GCP role Service Account Token Creator if needing to impersonate a user.
    accessToken String
    A temporary [OAuth 2.0 access token] obtained from the Google Authorization server, i.e. the Authorization: Bearer token used to authenticate HTTP requests to Google Admin SDK APIs. This is an alternative to credentials, and ignores the oauth_scopes field. If both are specified, access_token will be used over the credentials field.
    credentials String
    Either the path to or the contents of a service account key file in JSON format you can manage key files using the Cloud Console). If not provided, the application default credentials will be used.
    customerId String
    The customer id provided with your Google Workspace subscription. It is found in the admin console under Account Settings.
    impersonatedUserEmail String
    The impersonated user's email with access to the Admin APIs can access the Admin SDK Directory API. impersonated_user_email is required for all services except group and user management.
    oauthScopes List<String>
    The list of the scopes required for your application (for a list of possible scopes, see Authorize requests)
    serviceAccount String
    The service account used to create the provided access_token if authenticating using the access_token method and needing to impersonate a user. This service account will require the GCP role Service Account Token Creator if needing to impersonate a user.
    accessToken string
    A temporary [OAuth 2.0 access token] obtained from the Google Authorization server, i.e. the Authorization: Bearer token used to authenticate HTTP requests to Google Admin SDK APIs. This is an alternative to credentials, and ignores the oauth_scopes field. If both are specified, access_token will be used over the credentials field.
    credentials string
    Either the path to or the contents of a service account key file in JSON format you can manage key files using the Cloud Console). If not provided, the application default credentials will be used.
    customerId string
    The customer id provided with your Google Workspace subscription. It is found in the admin console under Account Settings.
    impersonatedUserEmail string
    The impersonated user's email with access to the Admin APIs can access the Admin SDK Directory API. impersonated_user_email is required for all services except group and user management.
    oauthScopes string[]
    The list of the scopes required for your application (for a list of possible scopes, see Authorize requests)
    serviceAccount string
    The service account used to create the provided access_token if authenticating using the access_token method and needing to impersonate a user. This service account will require the GCP role Service Account Token Creator if needing to impersonate a user.
    access_token str
    A temporary [OAuth 2.0 access token] obtained from the Google Authorization server, i.e. the Authorization: Bearer token used to authenticate HTTP requests to Google Admin SDK APIs. This is an alternative to credentials, and ignores the oauth_scopes field. If both are specified, access_token will be used over the credentials field.
    credentials str
    Either the path to or the contents of a service account key file in JSON format you can manage key files using the Cloud Console). If not provided, the application default credentials will be used.
    customer_id str
    The customer id provided with your Google Workspace subscription. It is found in the admin console under Account Settings.
    impersonated_user_email str
    The impersonated user's email with access to the Admin APIs can access the Admin SDK Directory API. impersonated_user_email is required for all services except group and user management.
    oauth_scopes Sequence[str]
    The list of the scopes required for your application (for a list of possible scopes, see Authorize requests)
    service_account str
    The service account used to create the provided access_token if authenticating using the access_token method and needing to impersonate a user. This service account will require the GCP role Service Account Token Creator if needing to impersonate a user.
    accessToken String
    A temporary [OAuth 2.0 access token] obtained from the Google Authorization server, i.e. the Authorization: Bearer token used to authenticate HTTP requests to Google Admin SDK APIs. This is an alternative to credentials, and ignores the oauth_scopes field. If both are specified, access_token will be used over the credentials field.
    credentials String
    Either the path to or the contents of a service account key file in JSON format you can manage key files using the Cloud Console). If not provided, the application default credentials will be used.
    customerId String
    The customer id provided with your Google Workspace subscription. It is found in the admin console under Account Settings.
    impersonatedUserEmail String
    The impersonated user's email with access to the Admin APIs can access the Admin SDK Directory API. impersonated_user_email is required for all services except group and user management.
    oauthScopes List<String>
    The list of the scopes required for your application (for a list of possible scopes, see Authorize requests)
    serviceAccount String
    The service account used to create the provided access_token if authenticating using the access_token method and needing to impersonate a user. This service account will require the GCP role Service Account Token Creator if needing to impersonate a user.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Provider resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Package Details

    Repository
    googleworkspace hashicorp/terraform-provider-googleworkspace
    License
    Notes
    This Pulumi package is based on the googleworkspace Terraform Provider.
    googleworkspace logo
    googleworkspace 0.7.0 published on Wednesday, Jan 15, 2025 by hashicorp
    hashicorp/terraform-provider-googleworkspace