mongodbatlas.getApiKey
Explore with Pulumi AI
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(api_key_id: Optional[str] = None,
org_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetApiKeyResult
def get_api_key_output(api_key_id: Optional[pulumi.Input[str]] = None,
org_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetApiKeyResult]
func LookupApiKey(ctx *Context, args *LookupApiKeyArgs, opts ...InvokeOption) (*LookupApiKeyResult, error)
func LookupApiKeyOutput(ctx *Context, args *LookupApiKeyOutputArgs, opts ...InvokeOption) LookupApiKeyResultOutput
> Note: This function is named LookupApiKey
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: mongodbatlas:index/getApiKey:getApiKey
arguments:
# arguments dictionary
The following arguments are supported:
- api_
key_ strid - org_
id str The unique ID for the project.
getApiKey Result
The following output properties are available:
- Api
Key stringId - Description string
Description of this Organization API key.
- Id string
The provider-assigned unique ID for this managed resource.
- 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.
- Public
Key string Public key for this Organization API key.
- 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 - Description string
Description of this Organization API key.
- Id string
The provider-assigned unique ID for this managed resource.
- 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.
- Public
Key string Public key for this Organization API key.
- 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 - description String
Description of this Organization API key.
- id String
The provider-assigned unique ID for this managed resource.
- 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.
- public
Key String Public key for this Organization API key.
- 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 - description string
Description of this Organization API key.
- id string
The provider-assigned unique ID for this managed resource.
- 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.
- public
Key string Public key for this Organization API key.
- 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 - description str
Description of this Organization API key.
- id str
The provider-assigned unique ID for this managed resource.
- 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.
- 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:
- api
Key StringId - description String
Description of this Organization API key.
- id String
The provider-assigned unique ID for this managed resource.
- 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.
- public
Key String Public key for this Organization API key.
- 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
mongodbatlas
Terraform Provider.