Provider panics when reading service api key with unretrievable apikey attribute

[lorepanichi]

Community Note

• Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
• Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request
• If you are interested in working on this issue or have submitted a pull request, please leave a comment

Terraform CLI and Terraform IBM Provider Version

1.53.0

Affected Resource(s)

• ibm_iam_service_api_key

Terraform Configuration Files

resource "ibm_iam_service_id" "service_id" {
  name        = "test-service-id"
  description = "some service id"
}

resource "ibm_iam_service_api_key" "api_key" {
  name           = "test-api-key"
  description = "some api key"
  iam_service_id = ibm_iam_service_id.service_id.iam_id
  store_value    = false
}

Panic Output

crash.log

Expected Behavior

Refreshing state read resource op should complete without making provider crash.

Actual Behavior

This ibm sdk function will return an apiKey struct with *string Apikey set to nil when the apikey is unretrievable (see store_value parameter in the apidocs for a way to hide that sensitive value from key details).
That zero pointer is then dereferenced here, making the provider panic as reported in the log.

Steps to Reproduce

1. Create a service api key with store_value set to false;
2. Import the key into state invoking terraform as such:

terraform import ibm_iam_service_api_key.api_key ApiKey-xyz

Important Factoids

It's probably uncommon to hit this bug, because this one prevents any ibm_iam_service_api_key with unretrievable apikey to be created by terraform at all.

References

• store_value argument ignored when creating a service api key