MongoDB Atlas v3.7.2, Mar 31 23

mongodbatlas.getProjectApiKey

Explore with Pulumi AI

Using getProjectApiKey

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 getProjectApiKey(args: GetProjectApiKeyArgs, opts?: InvokeOptions): Promise<GetProjectApiKeyResult>
function getProjectApiKeyOutput(args: GetProjectApiKeyOutputArgs, opts?: InvokeOptions): Output<GetProjectApiKeyResult>

def get_project_api_key(api_key_id: Optional[str] = None,
                        project_id: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetProjectApiKeyResult
def get_project_api_key_output(api_key_id: Optional[pulumi.Input[str]] = None,
                        project_id: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetProjectApiKeyResult]

func LookupProjectApiKey(ctx *Context, args *LookupProjectApiKeyArgs, opts ...InvokeOption) (*LookupProjectApiKeyResult, error)
func LookupProjectApiKeyOutput(ctx *Context, args *LookupProjectApiKeyOutputArgs, opts ...InvokeOption) LookupProjectApiKeyResultOutput

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

public static class GetProjectApiKey 
{
    public static Task<GetProjectApiKeyResult> InvokeAsync(GetProjectApiKeyArgs args, InvokeOptions? opts = null)
    public static Output<GetProjectApiKeyResult> Invoke(GetProjectApiKeyInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetProjectApiKeyResult> getProjectApiKey(GetProjectApiKeyArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: mongodbatlas:index/getProjectApiKey:getProjectApiKey
  arguments:
    # arguments dictionary

The following arguments are supported:

ApiKeyId string
ProjectId string: The unique ID for the project.

ApiKeyId string
ProjectId string: The unique ID for the project.

apiKeyId String
projectId String: The unique ID for the project.

apiKeyId string
projectId string: The unique ID for the project.

api_key_id str
project_id str: The unique ID for the project.

apiKeyId String
projectId String: The unique ID for the project.

getProjectApiKey Result

The following output properties are available:

ApiKeyId string
Description string: Description of this Project API key.
Id string: The provider-assigned unique ID for this managed resource.
PrivateKey string: Private key for this Organization API key.
ProjectId string: Unique identifier for the project whose API keys you want to retrieve. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.
PublicKey string: Public key for this Organization API key.
RoleNames List<string>: Name of the role. This resource returns all the roles the user has in Atlas. The following are valid roles:

ApiKeyId string
Description string: Description of this Project API key.
Id string: The provider-assigned unique ID for this managed resource.
PrivateKey string: Private key for this Organization API key.
ProjectId string: Unique identifier for the project whose API keys you want to retrieve. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.
PublicKey string: Public key for this Organization API key.
RoleNames []string: Name of the role. This resource returns all the roles the user has in Atlas. The following are valid roles:

apiKeyId String
description String: Description of this Project API key.
id String: The provider-assigned unique ID for this managed resource.
privateKey String: Private key for this Organization API key.
projectId String: Unique identifier for the project whose API keys you want to retrieve. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.
publicKey String: Public key for this Organization API key.
roleNames List<String>: Name of the role. This resource returns all the roles the user has in Atlas. The following are valid roles:

apiKeyId string
description string: Description of this Project API key.
id string: The provider-assigned unique ID for this managed resource.
privateKey string: Private key for this Organization API key.
projectId string: Unique identifier for the project whose API keys you want to retrieve. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.
publicKey string: Public key for this Organization API key.
roleNames string[]: Name of the role. This resource returns all the roles the user has in Atlas. The following are valid roles:

api_key_id str
description str: Description of this Project API key.
id str: The provider-assigned unique ID for this managed resource.
private_key str: Private key for this Organization API key.
project_id str: Unique identifier for the project whose API keys you want to retrieve. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.
public_key str: Public key for this Organization API key.
role_names Sequence[str]: Name of the role. This resource returns all the roles the user has in Atlas. The following are valid roles:

apiKeyId String
description String: Description of this Project API key.
id String: The provider-assigned unique ID for this managed resource.
privateKey String: Private key for this Organization API key.
projectId String: Unique identifier for the project whose API keys you want to retrieve. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.
publicKey String: Public key for this Organization API key.
roleNames List<String>: Name of the role. This resource returns all the roles the user has in Atlas. The following are valid roles:

Package Details

Repository: MongoDB Atlas pulumi/pulumi-mongodbatlas
License: Apache-2.0
Notes: This Pulumi package is based on the mongodbatlas Terraform Provider.

mongodbatlas.getProjectApiKey

Using getProjectApiKey

getProjectApiKey Result

Package Details

On this page

On this page