MongoDB Atlas v3.7.2, Mar 31 23

mongodbatlas.getProjectApiKeys

Explore with Pulumi AI

Using getProjectApiKeys

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 getProjectApiKeys(args: GetProjectApiKeysArgs, opts?: InvokeOptions): Promise<GetProjectApiKeysResult>
function getProjectApiKeysOutput(args: GetProjectApiKeysOutputArgs, opts?: InvokeOptions): Output<GetProjectApiKeysResult>

def get_project_api_keys(items_per_page: Optional[int] = None,
                         page_num: Optional[int] = None,
                         project_id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetProjectApiKeysResult
def get_project_api_keys_output(items_per_page: Optional[pulumi.Input[int]] = None,
                         page_num: Optional[pulumi.Input[int]] = None,
                         project_id: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetProjectApiKeysResult]

func LookupProjectApiKeys(ctx *Context, args *LookupProjectApiKeysArgs, opts ...InvokeOption) (*LookupProjectApiKeysResult, error)
func LookupProjectApiKeysOutput(ctx *Context, args *LookupProjectApiKeysOutputArgs, opts ...InvokeOption) LookupProjectApiKeysResultOutput

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

public static class GetProjectApiKeys 
{
    public static Task<GetProjectApiKeysResult> InvokeAsync(GetProjectApiKeysArgs args, InvokeOptions? opts = null)
    public static Output<GetProjectApiKeysResult> Invoke(GetProjectApiKeysInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetProjectApiKeysResult> getProjectApiKeys(GetProjectApiKeysArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

The following arguments are supported:

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.
ItemsPerPage int: Number of items to return per page, up to a maximum of 500. Defaults to 100.
PageNum int: The page to return. Defaults to 1.

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.
ItemsPerPage int: Number of items to return per page, up to a maximum of 500. Defaults to 100.
PageNum int: The page to return. Defaults to 1.

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.
itemsPerPage Integer: Number of items to return per page, up to a maximum of 500. Defaults to 100.
pageNum Integer: The page to return. Defaults to 1.

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.
itemsPerPage number: Number of items to return per page, up to a maximum of 500. Defaults to 100.
pageNum number: The page to return. Defaults to 1.

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.
items_per_page int: Number of items to return per page, up to a maximum of 500. Defaults to 100.
page_num int: The page to return. Defaults to 1.

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.
itemsPerPage Number: Number of items to return per page, up to a maximum of 500. Defaults to 100.
pageNum Number: The page to return. Defaults to 1.

getProjectApiKeys Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
ProjectId string
Results List<GetProjectApiKeysResult>
ItemsPerPage int
PageNum int

Id string: The provider-assigned unique ID for this managed resource.
ProjectId string
Results []GetProjectApiKeysResult
ItemsPerPage int
PageNum int

id String: The provider-assigned unique ID for this managed resource.
projectId String
results List<GetProjectApiKeysResult>
itemsPerPage Integer
pageNum Integer

id string: The provider-assigned unique ID for this managed resource.
projectId string
results GetProjectApiKeysResult[]
itemsPerPage number
pageNum number

id str: The provider-assigned unique ID for this managed resource.
project_id str
results Sequence[GetProjectApiKeysResult]
items_per_page int
page_num int

id String: The provider-assigned unique ID for this managed resource.
projectId String
results List<Property Map>
itemsPerPage Number
pageNum Number

Supporting Types

GetProjectApiKeysResult

ApiKeyId string: Unique identifier for the API key you want to update. Use the /orgs/{ORG-ID}/apiKeys endpoint to retrieve all API keys to which the authenticated user has access for the specified organization.
Description string: Description of this Project API key.
PrivateKey string
PublicKey string
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: Unique identifier for the API key you want to update. Use the /orgs/{ORG-ID}/apiKeys endpoint to retrieve all API keys to which the authenticated user has access for the specified organization.
Description string: Description of this Project API key.
PrivateKey string
PublicKey string
RoleNames []string: Name of the role. This resource returns all the roles the user has in Atlas. The following are valid roles:

apiKeyId String: Unique identifier for the API key you want to update. Use the /orgs/{ORG-ID}/apiKeys endpoint to retrieve all API keys to which the authenticated user has access for the specified organization.
description String: Description of this Project API key.
privateKey String
publicKey String
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: Unique identifier for the API key you want to update. Use the /orgs/{ORG-ID}/apiKeys endpoint to retrieve all API keys to which the authenticated user has access for the specified organization.
description string: Description of this Project API key.
privateKey string
publicKey string
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: Unique identifier for the API key you want to update. Use the /orgs/{ORG-ID}/apiKeys endpoint to retrieve all API keys to which the authenticated user has access for the specified organization.
description str: Description of this Project API key.
private_key str
public_key str
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: Unique identifier for the API key you want to update. Use the /orgs/{ORG-ID}/apiKeys endpoint to retrieve all API keys to which the authenticated user has access for the specified organization.
description String: Description of this Project API key.
privateKey String
publicKey String
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.