Docs
Packagesmongodbatlas.getApiKeys
Explore with Pulumi AI
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 dictionaryThe following arguments are supported:
- Org
Id 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.
- Items
Per intPage 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.
- Org
Id 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.
- Items
Per intPage 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.
- org
Id 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.
- items
Per IntegerPage Number of items to return per page, up to a maximum of 500. Defaults to
100.- page
Num Integer The page to return. Defaults to
1.
- org
Id 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.
- items
Per numberPage Number of items to return per page, up to a maximum of 500. Defaults to
100.- page
Num 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_ intpage 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.
- org
Id 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.
- items
Per NumberPage Number of items to return per page, up to a maximum of 500. Defaults to
100.- page
Num 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.
- Org
Id string - Results
List<Get
Api Keys Result> - Items
Per intPage - Page
Num int
- Id string
The provider-assigned unique ID for this managed resource.
- Org
Id string - Results
[]Get
Api Keys Result - Items
Per intPage - Page
Num int
- id String
The provider-assigned unique ID for this managed resource.
- org
Id String - results
List<Get
Api Keys Result> - items
Per IntegerPage - page
Num Integer
- id string
The provider-assigned unique ID for this managed resource.
- org
Id string - results
Get
Api Keys Result[] - items
Per numberPage - page
Num number
- id str
The provider-assigned unique ID for this managed resource.
- org_
id str - results
Sequence[Get
Api Keys Result] - items_
per_ intpage - page_
num int
- id String
The provider-assigned unique ID for this managed resource.
- org
Id String - results List<Property Map>
- items
Per NumberPage - page
Num Number
Supporting Types
GetApiKeysResult
- Api
Key stringId 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.
- Public
Key string - Role
Names List<string> Name of the role. This resource returns all the roles the user has in Atlas.
The following are valid roles:
- Api
Key stringId 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.
- Public
Key string - Role
Names []string Name of the role. This resource returns all the roles the user has in Atlas.
The following are valid roles:
- api
Key StringId 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.
- public
Key String - role
Names List<String> Name of the role. This resource returns all the roles the user has in Atlas.
The following are valid roles:
- api
Key stringId 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.
- public
Key string - role
Names string[] Name of the role. This resource returns all the roles the user has in Atlas.
The following are valid roles:
- api_
key_ strid 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.
The following are valid roles:
- api
Key StringId 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.
- public
Key String - role
Names 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
mongodbatlasTerraform Provider.