1. Packages
  2. Harness
  3. API Docs
  4. platform
  5. getApiKey
Harness v0.0.6 published on Saturday, Jul 1, 2023 by lbrlabs

harness.platform.getApiKey

Explore with Pulumi AI

harness logo
Harness v0.0.6 published on Saturday, Jul 1, 2023 by lbrlabs

    Using getApiKey

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getApiKey(args: GetApiKeyArgs, opts?: InvokeOptions): Promise<GetApiKeyResult>
    function getApiKeyOutput(args: GetApiKeyOutputArgs, opts?: InvokeOptions): Output<GetApiKeyResult>
    def get_api_key(account_id: Optional[str] = None,
                    apikey_type: Optional[str] = None,
                    default_time_to_expire_token: Optional[int] = None,
                    description: Optional[str] = None,
                    identifier: Optional[str] = None,
                    name: Optional[str] = None,
                    org_id: Optional[str] = None,
                    parent_id: Optional[str] = None,
                    project_id: Optional[str] = None,
                    tags: Optional[Mapping[str, str]] = None,
                    opts: Optional[InvokeOptions] = None) -> GetApiKeyResult
    def get_api_key_output(account_id: Optional[pulumi.Input[str]] = None,
                    apikey_type: Optional[pulumi.Input[str]] = None,
                    default_time_to_expire_token: Optional[pulumi.Input[int]] = None,
                    description: Optional[pulumi.Input[str]] = None,
                    identifier: Optional[pulumi.Input[str]] = None,
                    name: Optional[pulumi.Input[str]] = None,
                    org_id: Optional[pulumi.Input[str]] = None,
                    parent_id: Optional[pulumi.Input[str]] = None,
                    project_id: Optional[pulumi.Input[str]] = None,
                    tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetApiKeyResult]
    func GetApiKey(ctx *Context, args *GetApiKeyArgs, opts ...InvokeOption) (*GetApiKeyResult, error)
    func GetApiKeyOutput(ctx *Context, args *GetApiKeyOutputArgs, opts ...InvokeOption) GetApiKeyResultOutput

    > Note: This function is named GetApiKey in the Go SDK.

    public static class GetApiKey 
    {
        public static Task<GetApiKeyResult> InvokeAsync(GetApiKeyArgs args, InvokeOptions? opts = null)
        public static Output<GetApiKeyResult> Invoke(GetApiKeyInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetApiKeyResult> getApiKey(GetApiKeyArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: harness:platform/getApiKey:getApiKey
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AccountId string
    ApikeyType string
    Identifier string
    Name string
    ParentId string
    DefaultTimeToExpireToken int
    Description string
    OrgId string
    ProjectId string
    Tags Dictionary<string, string>
    AccountId string
    ApikeyType string
    Identifier string
    Name string
    ParentId string
    DefaultTimeToExpireToken int
    Description string
    OrgId string
    ProjectId string
    Tags map[string]string
    accountId String
    apikeyType String
    identifier String
    name String
    parentId String
    defaultTimeToExpireToken Integer
    description String
    orgId String
    projectId String
    tags Map<String,String>
    accountId string
    apikeyType string
    identifier string
    name string
    parentId string
    defaultTimeToExpireToken number
    description string
    orgId string
    projectId string
    tags {[key: string]: string}
    accountId String
    apikeyType String
    identifier String
    name String
    parentId String
    defaultTimeToExpireToken Number
    description String
    orgId String
    projectId String
    tags Map<String>

    getApiKey Result

    The following output properties are available:

    AccountId string
    ApikeyType string
    Id string
    The provider-assigned unique ID for this managed resource.
    Identifier string
    Name string
    ParentId string
    DefaultTimeToExpireToken int
    Description string
    OrgId string
    ProjectId string
    Tags Dictionary<string, string>
    AccountId string
    ApikeyType string
    Id string
    The provider-assigned unique ID for this managed resource.
    Identifier string
    Name string
    ParentId string
    DefaultTimeToExpireToken int
    Description string
    OrgId string
    ProjectId string
    Tags map[string]string
    accountId String
    apikeyType String
    id String
    The provider-assigned unique ID for this managed resource.
    identifier String
    name String
    parentId String
    defaultTimeToExpireToken Integer
    description String
    orgId String
    projectId String
    tags Map<String,String>
    accountId string
    apikeyType string
    id string
    The provider-assigned unique ID for this managed resource.
    identifier string
    name string
    parentId string
    defaultTimeToExpireToken number
    description string
    orgId string
    projectId string
    tags {[key: string]: string}
    account_id str
    apikey_type str
    id str
    The provider-assigned unique ID for this managed resource.
    identifier str
    name str
    parent_id str
    default_time_to_expire_token int
    description str
    org_id str
    project_id str
    tags Mapping[str, str]
    accountId String
    apikeyType String
    id String
    The provider-assigned unique ID for this managed resource.
    identifier String
    name String
    parentId String
    defaultTimeToExpireToken Number
    description String
    orgId String
    projectId String
    tags Map<String>

    Package Details

    Repository
    harness lbrlabs/pulumi-harness
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the harness Terraform Provider.
    harness logo
    Harness v0.0.6 published on Saturday, Jul 1, 2023 by lbrlabs