Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. IamApiKey
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.IamApiKey

Explore with Pulumi AI

ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

Create, modify, or delete an IAM API key resources. For more information, about IAM API Key, see managing user API keys.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";

const iamApiKey = new ibm.IamApiKey("iamApiKey", {});
Copy
import pulumi
import pulumi_ibm as ibm

iam_api_key = ibm.IamApiKey("iamApiKey")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.NewIamApiKey(ctx, "iamApiKey", nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var iamApiKey = new Ibm.IamApiKey("iamApiKey");

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IamApiKey;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var iamApiKey = new IamApiKey("iamApiKey");

    }
}
Copy
resources:
  iamApiKey:
    type: ibm:IamApiKey
Copy

Create IamApiKey Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new IamApiKey(name: string, args?: IamApiKeyArgs, opts?: CustomResourceOptions);
@overload
def IamApiKey(resource_name: str,
              args: Optional[IamApiKeyArgs] = None,
              opts: Optional[ResourceOptions] = None)

@overload
def IamApiKey(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              apikey: Optional[str] = None,
              description: Optional[str] = None,
              entity_lock: Optional[str] = None,
              file: Optional[str] = None,
              iam_api_key_id: Optional[str] = None,
              name: Optional[str] = None,
              store_value: Optional[bool] = None)
func NewIamApiKey(ctx *Context, name string, args *IamApiKeyArgs, opts ...ResourceOption) (*IamApiKey, error)
public IamApiKey(string name, IamApiKeyArgs? args = null, CustomResourceOptions? opts = null)
public IamApiKey(String name, IamApiKeyArgs args)
public IamApiKey(String name, IamApiKeyArgs args, CustomResourceOptions options)

type: ibm:IamApiKey
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args IamApiKeyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args IamApiKeyArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args IamApiKeyArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args IamApiKeyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. IamApiKeyArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var iamApiKeyResource = new Ibm.IamApiKey("iamApiKeyResource", new()
{
    Apikey = "string",
    Description = "string",
    EntityLock = "string",
    File = "string",
    IamApiKeyId = "string",
    Name = "string",
    StoreValue = false,
});
Copy
example, err := ibm.NewIamApiKey(ctx, "iamApiKeyResource", &ibm.IamApiKeyArgs{
Apikey: pulumi.String("string"),
Description: pulumi.String("string"),
EntityLock: pulumi.String("string"),
File: pulumi.String("string"),
IamApiKeyId: pulumi.String("string"),
Name: pulumi.String("string"),
StoreValue: pulumi.Bool(false),
})
Copy
var iamApiKeyResource = new IamApiKey("iamApiKeyResource", IamApiKeyArgs.builder()
    .apikey("string")
    .description("string")
    .entityLock("string")
    .file("string")
    .iamApiKeyId("string")
    .name("string")
    .storeValue(false)
    .build());
Copy
iam_api_key_resource = ibm.IamApiKey("iamApiKeyResource",
    apikey="string",
    description="string",
    entity_lock="string",
    file="string",
    iam_api_key_id="string",
    name="string",
    store_value=False)
Copy
const iamApiKeyResource = new ibm.IamApiKey("iamApiKeyResource", {
    apikey: "string",
    description: "string",
    entityLock: "string",
    file: "string",
    iamApiKeyId: "string",
    name: "string",
    storeValue: false,
});
Copy
type: ibm:IamApiKey
properties:
    apikey: string
    description: string
    entityLock: string
    file: string
    iamApiKeyId: string
    name: string
    storeValue: false
Copy

IamApiKey Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The IamApiKey resource accepts the following input properties:

Apikey string
You can passthrough an API key value for this API key. If passed, that API key value is not validated, means, the value can be non URL safe. If omitted, the API key management creates an URL safe opaque API key value. The value of the API key is checked for uniqueness. Please ensure enough variations when passing the value.
Description string
The description of the API key. The description property is only available if a description was provided during API key creation.
EntityLock string
Indicates the API key is locked for further write operations. Default value is false.
File string
The file name where API key is to be stored.
IamApiKeyId string
Name string
The name of the API key. The name is not checked for uniqueness. Therefore, multiple names with the same value can exist. Access is done through the UUID of the API key.
StoreValue bool
Use true or false to set whether the API key value is retrievable in the future by using the Get details of an API key request. If you create an API key for a user, you must specify false or omit the value. Users cannot store the API key.
Apikey string
You can passthrough an API key value for this API key. If passed, that API key value is not validated, means, the value can be non URL safe. If omitted, the API key management creates an URL safe opaque API key value. The value of the API key is checked for uniqueness. Please ensure enough variations when passing the value.
Description string
The description of the API key. The description property is only available if a description was provided during API key creation.
EntityLock string
Indicates the API key is locked for further write operations. Default value is false.
File string
The file name where API key is to be stored.
IamApiKeyId string
Name string
The name of the API key. The name is not checked for uniqueness. Therefore, multiple names with the same value can exist. Access is done through the UUID of the API key.
StoreValue bool
Use true or false to set whether the API key value is retrievable in the future by using the Get details of an API key request. If you create an API key for a user, you must specify false or omit the value. Users cannot store the API key.
apikey String
You can passthrough an API key value for this API key. If passed, that API key value is not validated, means, the value can be non URL safe. If omitted, the API key management creates an URL safe opaque API key value. The value of the API key is checked for uniqueness. Please ensure enough variations when passing the value.
description String
The description of the API key. The description property is only available if a description was provided during API key creation.
entityLock String
Indicates the API key is locked for further write operations. Default value is false.
file String
The file name where API key is to be stored.
iamApiKeyId String
name String
The name of the API key. The name is not checked for uniqueness. Therefore, multiple names with the same value can exist. Access is done through the UUID of the API key.
storeValue Boolean
Use true or false to set whether the API key value is retrievable in the future by using the Get details of an API key request. If you create an API key for a user, you must specify false or omit the value. Users cannot store the API key.
apikey string
You can passthrough an API key value for this API key. If passed, that API key value is not validated, means, the value can be non URL safe. If omitted, the API key management creates an URL safe opaque API key value. The value of the API key is checked for uniqueness. Please ensure enough variations when passing the value.
description string
The description of the API key. The description property is only available if a description was provided during API key creation.
entityLock string
Indicates the API key is locked for further write operations. Default value is false.
file string
The file name where API key is to be stored.
iamApiKeyId string
name string
The name of the API key. The name is not checked for uniqueness. Therefore, multiple names with the same value can exist. Access is done through the UUID of the API key.
storeValue boolean
Use true or false to set whether the API key value is retrievable in the future by using the Get details of an API key request. If you create an API key for a user, you must specify false or omit the value. Users cannot store the API key.
apikey str
You can passthrough an API key value for this API key. If passed, that API key value is not validated, means, the value can be non URL safe. If omitted, the API key management creates an URL safe opaque API key value. The value of the API key is checked for uniqueness. Please ensure enough variations when passing the value.
description str
The description of the API key. The description property is only available if a description was provided during API key creation.
entity_lock str
Indicates the API key is locked for further write operations. Default value is false.
file str
The file name where API key is to be stored.
iam_api_key_id str
name str
The name of the API key. The name is not checked for uniqueness. Therefore, multiple names with the same value can exist. Access is done through the UUID of the API key.
store_value bool
Use true or false to set whether the API key value is retrievable in the future by using the Get details of an API key request. If you create an API key for a user, you must specify false or omit the value. Users cannot store the API key.
apikey String
You can passthrough an API key value for this API key. If passed, that API key value is not validated, means, the value can be non URL safe. If omitted, the API key management creates an URL safe opaque API key value. The value of the API key is checked for uniqueness. Please ensure enough variations when passing the value.
description String
The description of the API key. The description property is only available if a description was provided during API key creation.
entityLock String
Indicates the API key is locked for further write operations. Default value is false.
file String
The file name where API key is to be stored.
iamApiKeyId String
name String
The name of the API key. The name is not checked for uniqueness. Therefore, multiple names with the same value can exist. Access is done through the UUID of the API key.
storeValue Boolean
Use true or false to set whether the API key value is retrievable in the future by using the Get details of an API key request. If you create an API key for a user, you must specify false or omit the value. Users cannot store the API key.

Outputs

All input properties are implicitly available as output properties. Additionally, the IamApiKey resource produces the following output properties:

AccountId string
The account ID of the API key.
ApikeyId string
(String) The unique identifier of the ibm.IamApiKey.
CreatedAt string
(Timestamp) If set contains the creation date time string in an ISO format.
CreatedBy string
(String) The IAM ID of the user or service that creates the API key.
Crn string
(String) The Cloud Resource Name (CRN) of an item. For example, CRN = crn:v1:bluemix:public:iam-identity:us-south:a/myaccount::apikey:1234-9012-1111.
EntityTag string
(String) The version of the API Key details object. You need to specify this value when updating the API key to avoid stale updates.
IamId string
The iam_id that this API key authenticates.
Id string
The provider-assigned unique ID for this managed resource.
Locked bool
(String) The API key cannot be changed if set to true.
ModifiedAt string
(Timestamp) If set contains the last modification date in an ISO format.
AccountId string
The account ID of the API key.
ApikeyId string
(String) The unique identifier of the ibm.IamApiKey.
CreatedAt string
(Timestamp) If set contains the creation date time string in an ISO format.
CreatedBy string
(String) The IAM ID of the user or service that creates the API key.
Crn string
(String) The Cloud Resource Name (CRN) of an item. For example, CRN = crn:v1:bluemix:public:iam-identity:us-south:a/myaccount::apikey:1234-9012-1111.
EntityTag string
(String) The version of the API Key details object. You need to specify this value when updating the API key to avoid stale updates.
IamId string
The iam_id that this API key authenticates.
Id string
The provider-assigned unique ID for this managed resource.
Locked bool
(String) The API key cannot be changed if set to true.
ModifiedAt string
(Timestamp) If set contains the last modification date in an ISO format.
accountId String
The account ID of the API key.
apikeyId String
(String) The unique identifier of the ibm.IamApiKey.
createdAt String
(Timestamp) If set contains the creation date time string in an ISO format.
createdBy String
(String) The IAM ID of the user or service that creates the API key.
crn String
(String) The Cloud Resource Name (CRN) of an item. For example, CRN = crn:v1:bluemix:public:iam-identity:us-south:a/myaccount::apikey:1234-9012-1111.
entityTag String
(String) The version of the API Key details object. You need to specify this value when updating the API key to avoid stale updates.
iamId String
The iam_id that this API key authenticates.
id String
The provider-assigned unique ID for this managed resource.
locked Boolean
(String) The API key cannot be changed if set to true.
modifiedAt String
(Timestamp) If set contains the last modification date in an ISO format.
accountId string
The account ID of the API key.
apikeyId string
(String) The unique identifier of the ibm.IamApiKey.
createdAt string
(Timestamp) If set contains the creation date time string in an ISO format.
createdBy string
(String) The IAM ID of the user or service that creates the API key.
crn string
(String) The Cloud Resource Name (CRN) of an item. For example, CRN = crn:v1:bluemix:public:iam-identity:us-south:a/myaccount::apikey:1234-9012-1111.
entityTag string
(String) The version of the API Key details object. You need to specify this value when updating the API key to avoid stale updates.
iamId string
The iam_id that this API key authenticates.
id string
The provider-assigned unique ID for this managed resource.
locked boolean
(String) The API key cannot be changed if set to true.
modifiedAt string
(Timestamp) If set contains the last modification date in an ISO format.
account_id str
The account ID of the API key.
apikey_id str
(String) The unique identifier of the ibm.IamApiKey.
created_at str
(Timestamp) If set contains the creation date time string in an ISO format.
created_by str
(String) The IAM ID of the user or service that creates the API key.
crn str
(String) The Cloud Resource Name (CRN) of an item. For example, CRN = crn:v1:bluemix:public:iam-identity:us-south:a/myaccount::apikey:1234-9012-1111.
entity_tag str
(String) The version of the API Key details object. You need to specify this value when updating the API key to avoid stale updates.
iam_id str
The iam_id that this API key authenticates.
id str
The provider-assigned unique ID for this managed resource.
locked bool
(String) The API key cannot be changed if set to true.
modified_at str
(Timestamp) If set contains the last modification date in an ISO format.
accountId String
The account ID of the API key.
apikeyId String
(String) The unique identifier of the ibm.IamApiKey.
createdAt String
(Timestamp) If set contains the creation date time string in an ISO format.
createdBy String
(String) The IAM ID of the user or service that creates the API key.
crn String
(String) The Cloud Resource Name (CRN) of an item. For example, CRN = crn:v1:bluemix:public:iam-identity:us-south:a/myaccount::apikey:1234-9012-1111.
entityTag String
(String) The version of the API Key details object. You need to specify this value when updating the API key to avoid stale updates.
iamId String
The iam_id that this API key authenticates.
id String
The provider-assigned unique ID for this managed resource.
locked Boolean
(String) The API key cannot be changed if set to true.
modifiedAt String
(Timestamp) If set contains the last modification date in an ISO format.

Look up Existing IamApiKey Resource

Get an existing IamApiKey resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: IamApiKeyState, opts?: CustomResourceOptions): IamApiKey
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        apikey: Optional[str] = None,
        apikey_id: Optional[str] = None,
        created_at: Optional[str] = None,
        created_by: Optional[str] = None,
        crn: Optional[str] = None,
        description: Optional[str] = None,
        entity_lock: Optional[str] = None,
        entity_tag: Optional[str] = None,
        file: Optional[str] = None,
        iam_api_key_id: Optional[str] = None,
        iam_id: Optional[str] = None,
        locked: Optional[bool] = None,
        modified_at: Optional[str] = None,
        name: Optional[str] = None,
        store_value: Optional[bool] = None) -> IamApiKey
func GetIamApiKey(ctx *Context, name string, id IDInput, state *IamApiKeyState, opts ...ResourceOption) (*IamApiKey, error)
public static IamApiKey Get(string name, Input<string> id, IamApiKeyState? state, CustomResourceOptions? opts = null)
public static IamApiKey get(String name, Output<String> id, IamApiKeyState state, CustomResourceOptions options)
resources:  _:    type: ibm:IamApiKey    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AccountId string
The account ID of the API key.
Apikey string
You can passthrough an API key value for this API key. If passed, that API key value is not validated, means, the value can be non URL safe. If omitted, the API key management creates an URL safe opaque API key value. The value of the API key is checked for uniqueness. Please ensure enough variations when passing the value.
ApikeyId string
(String) The unique identifier of the ibm.IamApiKey.
CreatedAt string
(Timestamp) If set contains the creation date time string in an ISO format.
CreatedBy string
(String) The IAM ID of the user or service that creates the API key.
Crn string
(String) The Cloud Resource Name (CRN) of an item. For example, CRN = crn:v1:bluemix:public:iam-identity:us-south:a/myaccount::apikey:1234-9012-1111.
Description string
The description of the API key. The description property is only available if a description was provided during API key creation.
EntityLock string
Indicates the API key is locked for further write operations. Default value is false.
EntityTag string
(String) The version of the API Key details object. You need to specify this value when updating the API key to avoid stale updates.
File string
The file name where API key is to be stored.
IamApiKeyId string
IamId string
The iam_id that this API key authenticates.
Locked bool
(String) The API key cannot be changed if set to true.
ModifiedAt string
(Timestamp) If set contains the last modification date in an ISO format.
Name string
The name of the API key. The name is not checked for uniqueness. Therefore, multiple names with the same value can exist. Access is done through the UUID of the API key.
StoreValue bool
Use true or false to set whether the API key value is retrievable in the future by using the Get details of an API key request. If you create an API key for a user, you must specify false or omit the value. Users cannot store the API key.
AccountId string
The account ID of the API key.
Apikey string
You can passthrough an API key value for this API key. If passed, that API key value is not validated, means, the value can be non URL safe. If omitted, the API key management creates an URL safe opaque API key value. The value of the API key is checked for uniqueness. Please ensure enough variations when passing the value.
ApikeyId string
(String) The unique identifier of the ibm.IamApiKey.
CreatedAt string
(Timestamp) If set contains the creation date time string in an ISO format.
CreatedBy string
(String) The IAM ID of the user or service that creates the API key.
Crn string
(String) The Cloud Resource Name (CRN) of an item. For example, CRN = crn:v1:bluemix:public:iam-identity:us-south:a/myaccount::apikey:1234-9012-1111.
Description string
The description of the API key. The description property is only available if a description was provided during API key creation.
EntityLock string
Indicates the API key is locked for further write operations. Default value is false.
EntityTag string
(String) The version of the API Key details object. You need to specify this value when updating the API key to avoid stale updates.
File string
The file name where API key is to be stored.
IamApiKeyId string
IamId string
The iam_id that this API key authenticates.
Locked bool
(String) The API key cannot be changed if set to true.
ModifiedAt string
(Timestamp) If set contains the last modification date in an ISO format.
Name string
The name of the API key. The name is not checked for uniqueness. Therefore, multiple names with the same value can exist. Access is done through the UUID of the API key.
StoreValue bool
Use true or false to set whether the API key value is retrievable in the future by using the Get details of an API key request. If you create an API key for a user, you must specify false or omit the value. Users cannot store the API key.
accountId String
The account ID of the API key.
apikey String
You can passthrough an API key value for this API key. If passed, that API key value is not validated, means, the value can be non URL safe. If omitted, the API key management creates an URL safe opaque API key value. The value of the API key is checked for uniqueness. Please ensure enough variations when passing the value.
apikeyId String
(String) The unique identifier of the ibm.IamApiKey.
createdAt String
(Timestamp) If set contains the creation date time string in an ISO format.
createdBy String
(String) The IAM ID of the user or service that creates the API key.
crn String
(String) The Cloud Resource Name (CRN) of an item. For example, CRN = crn:v1:bluemix:public:iam-identity:us-south:a/myaccount::apikey:1234-9012-1111.
description String
The description of the API key. The description property is only available if a description was provided during API key creation.
entityLock String
Indicates the API key is locked for further write operations. Default value is false.
entityTag String
(String) The version of the API Key details object. You need to specify this value when updating the API key to avoid stale updates.
file String
The file name where API key is to be stored.
iamApiKeyId String
iamId String
The iam_id that this API key authenticates.
locked Boolean
(String) The API key cannot be changed if set to true.
modifiedAt String
(Timestamp) If set contains the last modification date in an ISO format.
name String
The name of the API key. The name is not checked for uniqueness. Therefore, multiple names with the same value can exist. Access is done through the UUID of the API key.
storeValue Boolean
Use true or false to set whether the API key value is retrievable in the future by using the Get details of an API key request. If you create an API key for a user, you must specify false or omit the value. Users cannot store the API key.
accountId string
The account ID of the API key.
apikey string
You can passthrough an API key value for this API key. If passed, that API key value is not validated, means, the value can be non URL safe. If omitted, the API key management creates an URL safe opaque API key value. The value of the API key is checked for uniqueness. Please ensure enough variations when passing the value.
apikeyId string
(String) The unique identifier of the ibm.IamApiKey.
createdAt string
(Timestamp) If set contains the creation date time string in an ISO format.
createdBy string
(String) The IAM ID of the user or service that creates the API key.
crn string
(String) The Cloud Resource Name (CRN) of an item. For example, CRN = crn:v1:bluemix:public:iam-identity:us-south:a/myaccount::apikey:1234-9012-1111.
description string
The description of the API key. The description property is only available if a description was provided during API key creation.
entityLock string
Indicates the API key is locked for further write operations. Default value is false.
entityTag string
(String) The version of the API Key details object. You need to specify this value when updating the API key to avoid stale updates.
file string
The file name where API key is to be stored.
iamApiKeyId string
iamId string
The iam_id that this API key authenticates.
locked boolean
(String) The API key cannot be changed if set to true.
modifiedAt string
(Timestamp) If set contains the last modification date in an ISO format.
name string
The name of the API key. The name is not checked for uniqueness. Therefore, multiple names with the same value can exist. Access is done through the UUID of the API key.
storeValue boolean
Use true or false to set whether the API key value is retrievable in the future by using the Get details of an API key request. If you create an API key for a user, you must specify false or omit the value. Users cannot store the API key.
account_id str
The account ID of the API key.
apikey str
You can passthrough an API key value for this API key. If passed, that API key value is not validated, means, the value can be non URL safe. If omitted, the API key management creates an URL safe opaque API key value. The value of the API key is checked for uniqueness. Please ensure enough variations when passing the value.
apikey_id str
(String) The unique identifier of the ibm.IamApiKey.
created_at str
(Timestamp) If set contains the creation date time string in an ISO format.
created_by str
(String) The IAM ID of the user or service that creates the API key.
crn str
(String) The Cloud Resource Name (CRN) of an item. For example, CRN = crn:v1:bluemix:public:iam-identity:us-south:a/myaccount::apikey:1234-9012-1111.
description str
The description of the API key. The description property is only available if a description was provided during API key creation.
entity_lock str
Indicates the API key is locked for further write operations. Default value is false.
entity_tag str
(String) The version of the API Key details object. You need to specify this value when updating the API key to avoid stale updates.
file str
The file name where API key is to be stored.
iam_api_key_id str
iam_id str
The iam_id that this API key authenticates.
locked bool
(String) The API key cannot be changed if set to true.
modified_at str
(Timestamp) If set contains the last modification date in an ISO format.
name str
The name of the API key. The name is not checked for uniqueness. Therefore, multiple names with the same value can exist. Access is done through the UUID of the API key.
store_value bool
Use true or false to set whether the API key value is retrievable in the future by using the Get details of an API key request. If you create an API key for a user, you must specify false or omit the value. Users cannot store the API key.
accountId String
The account ID of the API key.
apikey String
You can passthrough an API key value for this API key. If passed, that API key value is not validated, means, the value can be non URL safe. If omitted, the API key management creates an URL safe opaque API key value. The value of the API key is checked for uniqueness. Please ensure enough variations when passing the value.
apikeyId String
(String) The unique identifier of the ibm.IamApiKey.
createdAt String
(Timestamp) If set contains the creation date time string in an ISO format.
createdBy String
(String) The IAM ID of the user or service that creates the API key.
crn String
(String) The Cloud Resource Name (CRN) of an item. For example, CRN = crn:v1:bluemix:public:iam-identity:us-south:a/myaccount::apikey:1234-9012-1111.
description String
The description of the API key. The description property is only available if a description was provided during API key creation.
entityLock String
Indicates the API key is locked for further write operations. Default value is false.
entityTag String
(String) The version of the API Key details object. You need to specify this value when updating the API key to avoid stale updates.
file String
The file name where API key is to be stored.
iamApiKeyId String
iamId String
The iam_id that this API key authenticates.
locked Boolean
(String) The API key cannot be changed if set to true.
modifiedAt String
(Timestamp) If set contains the last modification date in an ISO format.
name String
The name of the API key. The name is not checked for uniqueness. Therefore, multiple names with the same value can exist. Access is done through the UUID of the API key.
storeValue Boolean
Use true or false to set whether the API key value is retrievable in the future by using the Get details of an API key request. If you create an API key for a user, you must specify false or omit the value. Users cannot store the API key.

Import

The ibm_iam_api_key resource that can be imported by using user API Key.

Syntax

$ pulumi import ibm:index/iamApiKey:IamApiKey iam_api_key <ApiKey-UniqueId>
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
ibm ibm-cloud/terraform-provider-ibm
License
Notes
This Pulumi package is based on the ibm Terraform Provider.
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm