MongoDB Atlas v3.7.1, Mar 10 23

mongodbatlas.getApiKeys

Using getApiKeys

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 getApiKeys(args: GetApiKeysArgs, opts?: InvokeOptions): Promise<GetApiKeysResult>
function getApiKeysOutput(args: GetApiKeysOutputArgs, opts?: InvokeOptions): Output<GetApiKeysResult>

def get_api_keys(items_per_page: Optional[int] = None,
                 org_id: Optional[str] = None,
                 page_num: Optional[int] = None,
                 opts: Optional[InvokeOptions] = None) -> GetApiKeysResult
def get_api_keys_output(items_per_page: Optional[pulumi.Input[int]] = None,
                 org_id: Optional[pulumi.Input[str]] = None,
                 page_num: Optional[pulumi.Input[int]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetApiKeysResult]

func LookupApiKeys(ctx *Context, args *LookupApiKeysArgs, opts ...InvokeOption) (*LookupApiKeysResult, error)
func LookupApiKeysOutput(ctx *Context, args *LookupApiKeysOutputArgs, opts ...InvokeOption) LookupApiKeysResultOutput

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

public static class GetApiKeys 
{
    public static Task<GetApiKeysResult> InvokeAsync(GetApiKeysArgs args, InvokeOptions? opts = null)
    public static Output<GetApiKeysResult> Invoke(GetApiKeysInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetApiKeysResult> getApiKeys(GetApiKeysArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

The following arguments are supported:

OrgId string: Unique identifier for the organization whose API keys you want to retrieve. Use the /orgs endpoint to retrieve all organizations 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.

OrgId string: Unique identifier for the organization whose API keys you want to retrieve. Use the /orgs endpoint to retrieve all organizations 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.

orgId String: Unique identifier for the organization whose API keys you want to retrieve. Use the /orgs endpoint to retrieve all organizations 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.

orgId string: Unique identifier for the organization whose API keys you want to retrieve. Use the /orgs endpoint to retrieve all organizations 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.

org_id str: Unique identifier for the organization whose API keys you want to retrieve. Use the /orgs endpoint to retrieve all organizations 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.

orgId String: Unique identifier for the organization whose API keys you want to retrieve. Use the /orgs endpoint to retrieve all organizations 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.

getApiKeys Result

The following output properties are available:

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

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

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

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

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

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

Supporting Types

GetApiKeysResult

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 Organization API key.
PublicKey string
RoleNames List<string>: Name of the role. This resource returns all the roles the user has in Atlas.

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 Organization API key.
PublicKey string
RoleNames []string: Name of the role. This resource returns all the roles the user has in Atlas.

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 Organization API key.
publicKey String
roleNames List<String>: Name of the role. This resource returns all the roles the user has in Atlas.

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 Organization API key.
publicKey string
roleNames string[]: Name of the role. This resource returns all the roles the user has in Atlas.

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 Organization API key.
public_key str
role_names Sequence[str]: Name of the role. This resource returns all the roles the user has in Atlas.

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 Organization API key.
publicKey String
roleNames List<String>: Name of the role. This resource returns all the roles the user has in Atlas.

Package Details

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