Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cyral Provider
  3. API Docs
  4. ServiceAccount
cyral 4.16.3 published on Monday, Apr 14, 2025 by cyralinc
cyralinc/terraform-provider-cyral

cyral.ServiceAccount

Explore with Pulumi AI

cyral logo
cyral 4.16.3 published on Monday, Apr 14, 2025 by cyralinc
cyralinc/terraform-provider-cyral

    # cyral.ServiceAccount (Resource)

    Manages a Cyral Service Account (A.k.a: Cyral API Access Key). See also data source cyral.getPermission.

    Note This resource does not support importing, since the client secret cannot be read after the resource creation.

    Create ServiceAccount Resource

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

    Constructor syntax

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

@overload
def ServiceAccount(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   display_name: Optional[str] = None,
                   permission_ids: Optional[Sequence[str]] = None)
    func NewServiceAccount(ctx *Context, name string, args ServiceAccountArgs, opts ...ResourceOption) (*ServiceAccount, error)
    public ServiceAccount(string name, ServiceAccountArgs args, CustomResourceOptions? opts = null)
    public ServiceAccount(String name, ServiceAccountArgs args)
public ServiceAccount(String name, ServiceAccountArgs args, CustomResourceOptions options)

    type: cyral:ServiceAccount
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 ServiceAccountArgs
    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 ServiceAccountArgs
    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 ServiceAccountArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ServiceAccountArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ServiceAccountArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var serviceAccountResource = new Cyral.ServiceAccount("serviceAccountResource", new()
{
    DisplayName = "string",
    PermissionIds = new[]
    {
        "string",
    },
});

    example, err := cyral.NewServiceAccount(ctx, "serviceAccountResource", &cyral.ServiceAccountArgs{
	DisplayName: pulumi.String("string"),
	PermissionIds: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var serviceAccountResource = new ServiceAccount("serviceAccountResource", ServiceAccountArgs.builder()
    .displayName("string")
    .permissionIds("string")
    .build());

    service_account_resource = cyral.ServiceAccount("serviceAccountResource",
    display_name="string",
    permission_ids=["string"])

    const serviceAccountResource = new cyral.ServiceAccount("serviceAccountResource", {
    displayName: "string",
    permissionIds: ["string"],
});

    type: cyral:ServiceAccount
properties:
    displayName: string
    permissionIds:
        - string

    ServiceAccount 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 ServiceAccount resource accepts the following input properties:

    DisplayName string
    The service account display name.
    PermissionIds List<string>
    A list of permission IDs that will be assigned to this service account. See also data source cyral.getPermission.
    DisplayName string
    The service account display name.
    PermissionIds []string
    A list of permission IDs that will be assigned to this service account. See also data source cyral.getPermission.
    displayName String
    The service account display name.
    permissionIds List<String>
    A list of permission IDs that will be assigned to this service account. See also data source cyral.getPermission.
    displayName string
    The service account display name.
    permissionIds string[]
    A list of permission IDs that will be assigned to this service account. See also data source cyral.getPermission.
    display_name str
    The service account display name.
    permission_ids Sequence[str]
    A list of permission IDs that will be assigned to this service account. See also data source cyral.getPermission.
    displayName String
    The service account display name.
    permissionIds List<String>
    A list of permission IDs that will be assigned to this service account. See also data source cyral.getPermission.

    Outputs

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

    ClientId string
    The service account client ID.
    ClientSecret string
    Id string
    The provider-assigned unique ID for this managed resource.
    ClientId string
    The service account client ID.
    ClientSecret string
    Id string
    The provider-assigned unique ID for this managed resource.
    clientId String
    The service account client ID.
    clientSecret String
    id String
    The provider-assigned unique ID for this managed resource.
    clientId string
    The service account client ID.
    clientSecret string
    id string
    The provider-assigned unique ID for this managed resource.
    client_id str
    The service account client ID.
    client_secret str
    id str
    The provider-assigned unique ID for this managed resource.
    clientId String
    The service account client ID.
    clientSecret String
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ServiceAccount Resource

    Get an existing ServiceAccount resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ServiceAccountState, opts?: CustomResourceOptions): ServiceAccount
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        client_id: Optional[str] = None,
        client_secret: Optional[str] = None,
        display_name: Optional[str] = None,
        permission_ids: Optional[Sequence[str]] = None) -> ServiceAccount
    func GetServiceAccount(ctx *Context, name string, id IDInput, state *ServiceAccountState, opts ...ResourceOption) (*ServiceAccount, error)
    public static ServiceAccount Get(string name, Input<string> id, ServiceAccountState? state, CustomResourceOptions? opts = null)
    public static ServiceAccount get(String name, Output<String> id, ServiceAccountState state, CustomResourceOptions options)
    resources:  _:    type: cyral:ServiceAccount    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ClientId string
    The service account client ID.
    ClientSecret string
    DisplayName string
    The service account display name.
    PermissionIds List<string>
    A list of permission IDs that will be assigned to this service account. See also data source cyral.getPermission.
    ClientId string
    The service account client ID.
    ClientSecret string
    DisplayName string
    The service account display name.
    PermissionIds []string
    A list of permission IDs that will be assigned to this service account. See also data source cyral.getPermission.
    clientId String
    The service account client ID.
    clientSecret String
    displayName String
    The service account display name.
    permissionIds List<String>
    A list of permission IDs that will be assigned to this service account. See also data source cyral.getPermission.
    clientId string
    The service account client ID.
    clientSecret string
    displayName string
    The service account display name.
    permissionIds string[]
    A list of permission IDs that will be assigned to this service account. See also data source cyral.getPermission.
    client_id str
    The service account client ID.
    client_secret str
    display_name str
    The service account display name.
    permission_ids Sequence[str]
    A list of permission IDs that will be assigned to this service account. See also data source cyral.getPermission.
    clientId String
    The service account client ID.
    clientSecret String
    displayName String
    The service account display name.
    permissionIds List<String>
    A list of permission IDs that will be assigned to this service account. See also data source cyral.getPermission.

    Package Details

    Repository
    cyral cyralinc/terraform-provider-cyral
    License
    Notes
    This Pulumi package is based on the cyral Terraform Provider.
    cyral logo
    cyral 4.16.3 published on Monday, Apr 14, 2025 by cyralinc
    cyralinc/terraform-provider-cyral