Introduction
The IAM Identity Service API is used to manage service IDs, API key identities, trusted profiles, account security settings and to create IAM access tokens for a user or service ID.
With trusted profile templates and assignments you can centrally manage access for child accounts in your organization from the root enterprise account. Similarly with settings templates and assignments, you can centrally administer account security settings. For more information, see Working with template versions and Best practices for assigning access in an enterprise.
SDKs for Java, Node, Python, and Go are available to make it easier to programmatically access the API from your code. The client libraries that are provided by the SDKs implement best practices for using the API and reduce the amount of code that you need to write. The tab for each language includes code examples that demonstrate how to use the client libraries. For more information about using the SDKs, see the IBM Cloud SDK Common project on GitHub.
The examples that are provided on this page demonstrate how to use IAM Identity Service For more information and detailed examples, check out the IBM Cloud SDK Common project on GitHub.
The examples that are provided on this page demonstrate how to use IAM Identity Service For more information and detailed examples, check out the IBM Cloud SDK Common project on GitHub.
The examples that are provided on this page demonstrate how to use IAM Identity Service For more information and detailed examples, check out the IBM Cloud SDK Common project on GitHub.
The examples that are provided on this page demonstrate how to use IAM Identity Service For more information and detailed examples, check out the IBM Cloud SDK Common project on GitHub.
Installing the Java SDK
Maven
<dependency>
<groupId>com.ibm.cloud</groupId>
<artifactId>iam-identity</artifactId>
<version>{version}</version>
</dependency>
Gradle
compile 'com.ibm.cloud:iam-identity:{version}'
Replace {version}
in these examples with the release version.
View on GitHub
Installing the Go SDK
Go modules (recommended): Add the following import in your code, and then run go build
or go mod tidy
import (
"github.com/IBM/platform-services-go-sdk/iamidentityv1"
)
go get -u github.com/IBM/platform-services-go-sdk/iamidentityv1
View on GitHub
Installing the Node SDK
npm install @ibm-cloud/platform-services
View on GitHub
Installing the Python SDK
pip install --upgrade "ibm-platform-services"
View on GitHub
Endpoint URLs
The IAM Identity Services API uses the following public global endpoint URL. When you call the API, add the path for each method to form the complete API endpoint for your requests.
https://iam.cloud.ibm.com
Virtual private cloud (VPC) based access requires a virtual private endpoint gateway (VPE gateway). For more information , see Creating an endpoint gateway.
- Private endpoint URL for VPC infrastructure:
https://private.iam.cloud.ibm.com
. VPE gateway creation is supported in following datacenters:- Dallas
- Washington
- Frankfurt
If you enabled service endpoints in your account, you can send API requests over the IBM Cloud® private network at the following base endpoint URLs. For more information, see Enabling VRF and service endpoints.
- Private endpoint URLs for classic infrastructure. Supported datacenters and urls:
- Dallas:
https://private.us-south.iam.cloud.ibm.com
- Washington DC:
https://private.us-east.iam.cloud.ibm.com
- Frankfurt DC:
https://private.eu-de.iam.cloud.ibm.com
- Dallas:
Example API request
curl -u "apikey:{apikey}" -X {request_method} "https://iam.cloud.ibm.com/{method_endpoint}"
Replace {apikey}
, {request_method}
, and {method_endpoint}
in this example with the values for your particular API call.
Authentication
Authorization to the Identity Services REST API is enforced by using an IBM Cloud Identity and Access Management (IAM) access token. The token is used to determine the actions that a user or service ID has access to when they use the API.
You can generate an access token by first creating an API key and then exchanging your API key for an IBM Cloud IAM token.
Don't have an API key? Try running ibmcloud oauth-tokens
in the IBM Cloud Shell to quickly generate a personal access token.
When you use the SDK, configure an IAM authenticator with the IAM API key. The authenticator automatically obtains the IAM access token for the API key and includes it with each request. You can construct an authenticator in either of two ways:
- Programmatically by constructing an IAM authenticator instance and supplying your IAM API key
- By defining the API key in external configuration properties and then using the SDK authenticator factory to construct an IAM authenticator that uses the configured IAM API key
In this example of using external configuration properties, an IAM authenticator instance is created with the configured API key, and then the service client is constructed with this authenticator instance and the configured service URL.
For more information, see the Authentication section of the IBM Cloud SDK Common documentation.
To call each method, you'll need to be assigned a role that includes the required IAM actions. Each method lists the associated action. For more information about IAM actions and how they map to roles, see IAM Identity service.
You authenticate to the API by using Cloud Identity and Access Management (IAM). You can pass either a bearer token in an authorization header or an API key.
The SDK provides initialization methods for each form of authentication.
- Use the API key to have the SDK manage the lifecycle of the access token. The SDK requests an access token, ensures that the access token is valid, includes the access token in each outgoing request, and refreshes it when it expires.
- Use the access token to manage the lifecycle yourself. Keep in mind that access tokens are valid for 1 hour, so you must refresh them regularly to maintain access.
For more information, see IAM authentication with the SDK.
For more information, see IAM authentication with the SDK.
For more information, see IAM authentication with the SDK.
For more information, see IAM authentication with the SDK.
To retrieve your access token:
curl -X POST "https://iam.cloud.ibm.com/identity/token" --header 'Content-Type: application/x-www-form-urlencoded' --header 'Accept: application/json' --data-urlencode 'grant_type=urn:ibm:params:oauth:grant-type:apikey' --data-urlencode 'apikey=<API_KEY>'
Replace <API_KEY>
with your IAM API key.
Setting client options through external configuration
Example environment variables, where <SERVICE_URL>
is the endpoint URL and <API_KEY>
is your IAM API key
export IAM_IDENTITY_URL=<SERVICE_URL>
export IAM_IDENTITY_AUTHTYPE=iam
export IAM_IDENTITY_APIKEY=<API_KEY>
Example of constructing the service client
import {
"github.com/IBM/platform-services-go-sdk/iamidentityv1"
}
...
serviceClientOptions := &iamidentityv1.IamIdentityV1Options{}
serviceClient, err := iamidentityv1.NewIamIdentityV1UsingExternalConfig(serviceClientOptions)
Setting client options through external configuration
Example environment variables, where <SERVICE_URL>
is the endpoint URL and <API_KEY>
is your IAM API key
export IAM_IDENTITY_URL=<SERVICE_URL>
export IAM_IDENTITY_AUTHTYPE=iam
export IAM_IDENTITY_APIKEY=<API_KEY>
Example of constructing the service client
import com.ibm.cloud.platform_services.iam_identity.v1.IamIdentity;
...
IamIdentity serviceClient = IamIdentity.newInstance();
Setting client options through external configuration
Example environment variables, where <SERVICE_URL>
is the endpoint URL and <API_KEY>
is your IAM API key
export IAM_IDENTITY_URL=<SERVICE_URL>
export IAM_IDENTITY_AUTHTYPE=iam
export IAM_IDENTITY_APIKEY=<API_KEY>
Example of constructing the service client
const IamIdentityV1 = require('@ibm-cloud/platform-services/iam-identity/v1');
...
const serviceClient = IamIdentityV1.newInstance({});
Setting client options through external configuration
Example environment variables, where <SERVICE_URL>
is the endpoint URL and <API_KEY>
is your IAM API key
export IAM_IDENTITY_URL=<SERVICE_URL>
export IAM_IDENTITY_AUTHTYPE=iam
export IAM_IDENTITY_APIKEY=<API_KEY>
Example of constructing the service client
from ibm_platform_services import IamIdentityV1
...
service_client = IamIdentityV1.new_instance()
Auditing
You can monitor API activity within your account by using the IBM Cloud® Activity Tracker service. You can track when specific API methods are called by reviewing generated events in Activity Tracker.
If an event is tracked for a method, you can find it listed with the method. For more information about how to track IAM activity, see Auditing events for IAM.
Error handling
The IAM Token Service uses standard HTTP response codes to indicate whether a method completed successfully. A 200
response always indicates success. A 400
type response indicates that a parameter validation failed and can occur if required parameters are missing or if any parameter values are invalid. A 401
or 403
response indicates that the incoming request did not contain valid authentication information. A 500
type response indicates an internal server error that is seen in an unexpected error situation.
The Identity Services REST APIs return standard HTTP status codes to indicate the success or failure of a request. The format of the response is represented in JSON as follows:
{
"trace": "9daee671-916a-4678-850b-10b911f0236d",
"errors": [
{
"code": "invalid_access_token",
"message": "The provided access token provided is invalid."
}
]
"status_code": 401
}
If an operation cannot be fulfilled, an appropriate 400 or 500 series HTTP response is returned from the server. The operations that are defined in the Reference
section describe example errors that might be returned from a failed request. All responses from the Identity Services REST API are in JSON format.
The following table show the potential error codes the API might return.
HTTP Error Code | Description | Recovery |
---|---|---|
200 |
Success | The request was successful. |
201 |
Created | The resource was successfully created. |
204 |
No Content | The request was successful. No response body is provided. |
400 |
Bad Request | The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request. |
401 |
Unauthorized | You are not authorized to make this request. The token is either missing or expired. Get a new valid token and try again. |
403 |
Forbidden | The supplied authentication is not authorized to perform the operation. If this error persists, contact the account owner to check your permissions. |
404 |
Not Found | The requested resource can't be found. |
409 |
Conflict | The entity is already in the requested state. |
429 |
Too Many Requests | Too many requests have been made within a time window. Wait before calling the API again. |
500 |
Internal error | Error that is seen in an unexpected error situation. |
Additional headers
Some additional headers might be required to make successful requests to the API. Those additional headers are:
An optional transaction ID can be passed to your request, which can be useful for tracking calls through multiple services using one identifier. The header key must be set to Transaction-Id
and the value is anything that you choose.
If there is not a transaction ID that is passed in, then one is generated randomly.
Methods
Get API keys for a given service or user IAM ID and account ID
Returns the list of API key details for a given service or user IAM ID and account ID. Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to. In case of service IDs and their API keys, a user must be either an account owner, a IBM Cloud org manager or IBM Cloud space developer in order to manage service IDs of the entity.
Returns the list of API key details for a given service or user IAM ID and account ID. Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to. In case of service IDs and their API keys, a user must be either an account owner, a IBM Cloud org manager or IBM Cloud space developer in order to manage service IDs of the entity.
Returns the list of API key details for a given service or user IAM ID and account ID. Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to. In case of service IDs and their API keys, a user must be either an account owner, a IBM Cloud org manager or IBM Cloud space developer in order to manage service IDs of the entity.
Returns the list of API key details for a given service or user IAM ID and account ID. Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to. In case of service IDs and their API keys, a user must be either an account owner, a IBM Cloud org manager or IBM Cloud space developer in order to manage service IDs of the entity.
Returns the list of API key details for a given service or user IAM ID and account ID. Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to. In case of service IDs and their API keys, a user must be either an account owner, a IBM Cloud org manager or IBM Cloud space developer in order to manage service IDs of the entity.
GET /v1/apikeys
(iamIdentity *IamIdentityV1) ListAPIKeys(listAPIKeysOptions *ListAPIKeysOptions) (result *APIKeyList, response *core.DetailedResponse, err error)
(iamIdentity *IamIdentityV1) ListAPIKeysWithContext(ctx context.Context, listAPIKeysOptions *ListAPIKeysOptions) (result *APIKeyList, response *core.DetailedResponse, err error)
ServiceCall<ApiKeyList> listApiKeys(ListApiKeysOptions listApiKeysOptions)
listApiKeys(params)
list_api_keys(
self,
*,
account_id: str = None,
iam_id: str = None,
pagesize: int = None,
pagetoken: str = None,
scope: str = None,
type: str = None,
sort: str = None,
order: str = None,
include_history: bool = None,
**kwargs,
) -> DetailedResponse
Request
Instantiate the ListAPIKeysOptions
struct and set the fields to provide parameter values for the ListAPIKeys
method.
Use the ListApiKeysOptions.Builder
to create a ListApiKeysOptions
object that contains the parameter values for the listApiKeys
method.
Custom Headers
Authorization Token used for the request. The supported token type is a Cloud IAM Access Token. If the token is omitted the request will fail with BXNIM0308E: 'No authorization header found'. Make sure that the provided token has the required authority for the request.
Query Parameters
Account ID of the API keys(s) to query. If a service IAM ID is specified in iam_id then account_id must match the account of the IAM ID. If a user IAM ID is specified in iam_id then then account_id must match the account of the Authorization token.
IAM ID of the API key(s) to be queried. The IAM ID may be that of a user or a service. For a user IAM ID iam_id must match the Authorization token.
Optional size of a single page. Default is 20 items per page. Valid range is 1 to 100.
Optional Prev or Next page token returned from a previous query execution. Default is start with first page.
Optional parameter to define the scope of the queried API Keys. Can be 'entity' (default) or 'account'.
Allowable values: [
entity
,account
]Default:
entity
Optional parameter to filter the type of the queried API Keys. Can be 'user' or 'serviceid'.
Allowable values: [
user
,serviceid
]Optional sort property, valid values are name, description, created_at and created_by. If specified, the items are sorted by the value of this property.
Optional sort order, valid values are asc and desc. Default: asc.
Allowable values: [
asc
,desc
]Default:
asc
Defines if the entity history is included in the response.
Default:
false
WithContext method only
A context.Context instance that you can use to specify a timeout for the operation or to cancel an in-flight request.
The ListAPIKeys options.
Account ID of the API keys(s) to query. If a service IAM ID is specified in iam_id then account_id must match the account of the IAM ID. If a user IAM ID is specified in iam_id then then account_id must match the account of the Authorization token.
IAM ID of the API key(s) to be queried. The IAM ID may be that of a user or a service. For a user IAM ID iam_id must match the Authorization token.
Optional size of a single page. Default is 20 items per page. Valid range is 1 to 100.
Optional Prev or Next page token returned from a previous query execution. Default is start with first page.
Optional parameter to define the scope of the queried API Keys. Can be 'entity' (default) or 'account'.
Allowable values: [
entity
,account
]Default:
entity
Optional parameter to filter the type of the queried API Keys. Can be 'user' or 'serviceid'.
Allowable values: [
user
,serviceid
]Optional sort property, valid values are name, description, created_at and created_by. If specified, the items are sorted by the value of this property.
Optional sort order, valid values are asc and desc. Default: asc.
Allowable values: [
asc
,desc
]Default:
asc
Defines if the entity history is included in the response.
Default:
false
The listApiKeys options.
Account ID of the API keys(s) to query. If a service IAM ID is specified in iam_id then account_id must match the account of the IAM ID. If a user IAM ID is specified in iam_id then then account_id must match the account of the Authorization token.
IAM ID of the API key(s) to be queried. The IAM ID may be that of a user or a service. For a user IAM ID iam_id must match the Authorization token.
Optional size of a single page. Default is 20 items per page. Valid range is 1 to 100.
Optional Prev or Next page token returned from a previous query execution. Default is start with first page.
Optional parameter to define the scope of the queried API Keys. Can be 'entity' (default) or 'account'.
Allowable values: [
entity
,account
]Default:
entity
Optional parameter to filter the type of the queried API Keys. Can be 'user' or 'serviceid'.
Allowable values: [
user
,serviceid
]Optional sort property, valid values are name, description, created_at and created_by. If specified, the items are sorted by the value of this property.
Optional sort order, valid values are asc and desc. Default: asc.
Allowable values: [
asc
,desc
]Default:
asc
Defines if the entity history is included in the response.
Default:
false
parameters
Account ID of the API keys(s) to query. If a service IAM ID is specified in iam_id then account_id must match the account of the IAM ID. If a user IAM ID is specified in iam_id then then account_id must match the account of the Authorization token.
IAM ID of the API key(s) to be queried. The IAM ID may be that of a user or a service. For a user IAM ID iam_id must match the Authorization token.
Optional size of a single page. Default is 20 items per page. Valid range is 1 to 100.
Optional Prev or Next page token returned from a previous query execution. Default is start with first page.
Optional parameter to define the scope of the queried API Keys. Can be 'entity' (default) or 'account'.
Allowable values: [
entity
,account
]Default:
entity
Optional parameter to filter the type of the queried API Keys. Can be 'user' or 'serviceid'.
Allowable values: [
user
,serviceid
]Optional sort property, valid values are name, description, created_at and created_by. If specified, the items are sorted by the value of this property.
Optional sort order, valid values are asc and desc. Default: asc.
Allowable values: [
asc
,desc
]Default:
asc
Defines if the entity history is included in the response.
Default:
false
parameters
Account ID of the API keys(s) to query. If a service IAM ID is specified in iam_id then account_id must match the account of the IAM ID. If a user IAM ID is specified in iam_id then then account_id must match the account of the Authorization token.
IAM ID of the API key(s) to be queried. The IAM ID may be that of a user or a service. For a user IAM ID iam_id must match the Authorization token.
Optional size of a single page. Default is 20 items per page. Valid range is 1 to 100.
Optional Prev or Next page token returned from a previous query execution. Default is start with first page.
Optional parameter to define the scope of the queried API Keys. Can be 'entity' (default) or 'account'.
Allowable values: [
entity
,account
]Default:
entity
Optional parameter to filter the type of the queried API Keys. Can be 'user' or 'serviceid'.
Allowable values: [
user
,serviceid
]Optional sort property, valid values are name, description, created_at and created_by. If specified, the items are sorted by the value of this property.
Optional sort order, valid values are asc and desc. Default: asc.
Allowable values: [
asc
,desc
]Default:
asc
Defines if the entity history is included in the response.
Default:
false
curl -X GET 'https://iam.cloud.ibm.com/v1/apikeys?account_id=ACCOUNT_ID&iam_id=IBMid-123WEREW' -H 'Authorization: Bearer TOKEN' -H 'Content-Type: application/json'
listAPIKeysOptions := iamIdentityService.NewListAPIKeysOptions() listAPIKeysOptions.SetAccountID(accountID) listAPIKeysOptions.SetIamID(iamID) listAPIKeysOptions.SetIncludeHistory(true) apiKeyList, response, err := iamIdentityService.ListAPIKeys(listAPIKeysOptions) if err != nil { panic(err) } b, _ := json.MarshalIndent(apiKeyList, "", " ") fmt.Println(string(b))
ListApiKeysOptions listApiKeysOptions = new ListApiKeysOptions.Builder() .accountId(accountId) .iamId(iamId) .includeHistory(true) .build(); Response<ApiKeyList> response = service.listApiKeys(listApiKeysOptions).execute(); ApiKeyList apiKeyList = response.getResult(); System.out.println(apiKeyList);
const params = { accountId: accountId, iamId: iamId, includeHistory: true, }; try { const res = await iamIdentityService.listApiKeys(params); console.log(JSON.stringify(res.result, null, 2)); } catch (err) { console.warn(err); }
api_key_list = iam_identity_service.list_api_keys( account_id=account_id, iam_id=iam_id, include_history=True ).get_result() print(json.dumps(api_key_list, indent=2))
Response
Response body format for the List API keys V1 REST request.
List of API keys based on the query paramters and the page size. The apikeys array is always part of the response but might be empty depending on the query parameters values provided.
Context with key properties for problem determination.
The offset of the current page.
Optional size of a single page. Default is 20 items per page. Valid range is 1 to 100
Link to the first page.
Link to the previous available page. If 'previous' property is not part of the response no previous page is available.
Link to the next available page. If 'next' property is not part of the response no next page is available.
Response body format for the List API keys V1 REST request.
Context with key properties for problem determination.
The transaction ID of the inbound REST request.
The operation of the inbound REST request.
The user agent of the inbound REST request.
The URL of that cluster.
The instance ID of the server instance processing the request.
The thread ID of the server instance processing the request.
The host of the server instance processing the request.
The start time of the request.
The finish time of the request.
The elapsed time in msec.
The cluster name.
Context
The offset of the current page.
Optional size of a single page. Default is 20 items per page. Valid range is 1 to 100.
Link to the first page.
Link to the previous available page. If 'previous' property is not part of the response no previous page is available.
Link to the next available page. If 'next' property is not part of the response no next page is available.
List of API keys based on the query paramters and the page size. The apikeys array is always part of the response but might be empty depending on the query parameters values provided.
Context with key properties for problem determination.
The transaction ID of the inbound REST request.
The operation of the inbound REST request.
The user agent of the inbound REST request.
The URL of that cluster.
The instance ID of the server instance processing the request.
The thread ID of the server instance processing the request.
The host of the server instance processing the request.
The start time of the request.
The finish time of the request.
The elapsed time in msec.
The cluster name.
Context
Unique identifier of this API Key.
Version of the API Key details object. You need to specify this value when updating the API key to avoid stale updates.
Cloud Resource Name of the item. Example Cloud Resource Name: 'crn:v1:bluemix:public:iam-identity:us-south:a/myaccount::apikey:1234-9012-5678'.
The API key cannot be changed if set to true.
If set contains a date time string of the creation date in ISO format.
IAM ID of the user or service which created the API key.
If set contains a date time string of the last modification date in ISO format.
Name of the API key. The name is not checked for uniqueness. Therefore multiple names with the same value can exist. Access is done via the UUID of the API key.
The optional description of the API key. The 'description' property is only available if a description was provided during a create of an API key.
The iam_id that this API key authenticates.
ID of the account that this API key authenticates for.
The API key value. This property only contains the API key value for the following cases: create an API key, update a service ID API key that stores the API key value as retrievable, or get a service ID API key that stores the API key value as retrievable. All other operations don't return the API key value, for example all user API key related operations, except for create, don't contain the API key value.
History of the API key.
Timestamp when the action was triggered.
IAM ID of the identity which triggered the action.
Account of the identity which triggered the action.
Action of the history entry.
Params of the history entry.
Message which summarizes the executed action.
History
Time when the entity was last authenticated.
Authentication count, number of times the entity was authenticated.
Activity
Apikeys
Response body format for the List API keys V1 REST request.
Context with key properties for problem determination.
The transaction ID of the inbound REST request.
The operation of the inbound REST request.
The user agent of the inbound REST request.
The URL of that cluster.
The instance ID of the server instance processing the request.
The thread ID of the server instance processing the request.
The host of the server instance processing the request.
The start time of the request.
The finish time of the request.
The elapsed time in msec.
The cluster name.
context
The offset of the current page.
Optional size of a single page. Default is 20 items per page. Valid range is 1 to 100.
Link to the first page.
Link to the previous available page. If 'previous' property is not part of the response no previous page is available.
Link to the next available page. If 'next' property is not part of the response no next page is available.
List of API keys based on the query paramters and the page size. The apikeys array is always part of the response but might be empty depending on the query parameters values provided.
Context with key properties for problem determination.
The transaction ID of the inbound REST request.
The operation of the inbound REST request.
The user agent of the inbound REST request.
The URL of that cluster.
The instance ID of the server instance processing the request.
The thread ID of the server instance processing the request.
The host of the server instance processing the request.
The start time of the request.
The finish time of the request.
The elapsed time in msec.
The cluster name.
context
Unique identifier of this API Key.
Version of the API Key details object. You need to specify this value when updating the API key to avoid stale updates.
Cloud Resource Name of the item. Example Cloud Resource Name: 'crn:v1:bluemix:public:iam-identity:us-south:a/myaccount::apikey:1234-9012-5678'.
The API key cannot be changed if set to true.
If set contains a date time string of the creation date in ISO format.
IAM ID of the user or service which created the API key.
If set contains a date time string of the last modification date in ISO format.
Name of the API key. The name is not checked for uniqueness. Therefore multiple names with the same value can exist. Access is done via the UUID of the API key.
The optional description of the API key. The 'description' property is only available if a description was provided during a create of an API key.
The iam_id that this API key authenticates.
ID of the account that this API key authenticates for.
The API key value. This property only contains the API key value for the following cases: create an API key, update a service ID API key that stores the API key value as retrievable, or get a service ID API key that stores the API key value as retrievable. All other operations don't return the API key value, for example all user API key related operations, except for create, don't contain the API key value.
History of the API key.
Timestamp when the action was triggered.
IAM ID of the identity which triggered the action.
Account of the identity which triggered the action.
Action of the history entry.
Params of the history entry.
Message which summarizes the executed action.
history
Time when the entity was last authenticated.
Authentication count, number of times the entity was authenticated.
activity
apikeys
Response body format for the List API keys V1 REST request.
Context with key properties for problem determination.
The transaction ID of the inbound REST request.
The operation of the inbound REST request.
The user agent of the inbound REST request.
The URL of that cluster.
The instance ID of the server instance processing the request.
The thread ID of the server instance processing the request.
The host of the server instance processing the request.
The start time of the request.
The finish time of the request.
The elapsed time in msec.
The cluster name.
context
The offset of the current page.
Optional size of a single page. Default is 20 items per page. Valid range is 1 to 100.
Link to the first page.
Link to the previous available page. If 'previous' property is not part of the response no previous page is available.
Link to the next available page. If 'next' property is not part of the response no next page is available.
List of API keys based on the query paramters and the page size. The apikeys array is always part of the response but might be empty depending on the query parameters values provided.
Context with key properties for problem determination.
The transaction ID of the inbound REST request.
The operation of the inbound REST request.
The user agent of the inbound REST request.
The URL of that cluster.
The instance ID of the server instance processing the request.
The thread ID of the server instance processing the request.
The host of the server instance processing the request.
The start time of the request.
The finish time of the request.
The elapsed time in msec.
The cluster name.
context
Unique identifier of this API Key.
Version of the API Key details object. You need to specify this value when updating the API key to avoid stale updates.
Cloud Resource Name of the item. Example Cloud Resource Name: 'crn:v1:bluemix:public:iam-identity:us-south:a/myaccount::apikey:1234-9012-5678'.
The API key cannot be changed if set to true.
If set contains a date time string of the creation date in ISO format.
IAM ID of the user or service which created the API key.
If set contains a date time string of the last modification date in ISO format.
Name of the API key. The name is not checked for uniqueness. Therefore multiple names with the same value can exist. Access is done via the UUID of the API key.
The optional description of the API key. The 'description' property is only available if a description was provided during a create of an API key.
The iam_id that this API key authenticates.
ID of the account that this API key authenticates for.
The API key value. This property only contains the API key value for the following cases: create an API key, update a service ID API key that stores the API key value as retrievable, or get a service ID API key that stores the API key value as retrievable. All other operations don't return the API key value, for example all user API key related operations, except for create, don't contain the API key value.
History of the API key.
Timestamp when the action was triggered.
IAM ID of the identity which triggered the action.
Account of the identity which triggered the action.
Action of the history entry.
Params of the history entry.
Message which summarizes the executed action.
history
Time when the entity was last authenticated.
Authentication count, number of times the entity was authenticated.
activity
apikeys
Response body format for the List API keys V1 REST request.
Context with key properties for problem determination.
The transaction ID of the inbound REST request.
The operation of the inbound REST request.
The user agent of the inbound REST request.
The URL of that cluster.
The instance ID of the server instance processing the request.
The thread ID of the server instance processing the request.
The host of the server instance processing the request.
The start time of the request.
The finish time of the request.
The elapsed time in msec.
The cluster name.
context
The offset of the current page.
Optional size of a single page. Default is 20 items per page. Valid range is 1 to 100.
Link to the first page.
Link to the previous available page. If 'previous' property is not part of the response no previous page is available.
Link to the next available page. If 'next' property is not part of the response no next page is available.
List of API keys based on the query paramters and the page size. The apikeys array is always part of the response but might be empty depending on the query parameters values provided.
Context with key properties for problem determination.
The transaction ID of the inbound REST request.
The operation of the inbound REST request.
The user agent of the inbound REST request.
The URL of that cluster.
The instance ID of the server instance processing the request.
The thread ID of the server instance processing the request.
The host of the server instance processing the request.
The start time of the request.
The finish time of the request.
The elapsed time in msec.
The cluster name.
context
Unique identifier of this API Key.
Version of the API Key details object. You need to specify this value when updating the API key to avoid stale updates.
Cloud Resource Name of the item. Example Cloud Resource Name: 'crn:v1:bluemix:public:iam-identity:us-south:a/myaccount::apikey:1234-9012-5678'.
The API key cannot be changed if set to true.
If set contains a date time string of the creation date in ISO format.
IAM ID of the user or service which created the API key.
If set contains a date time string of the last modification date in ISO format.
Name of the API key. The name is not checked for uniqueness. Therefore multiple names with the same value can exist. Access is done via the UUID of the API key.
The optional description of the API key. The 'description' property is only available if a description was provided during a create of an API key.
The iam_id that this API key authenticates.
ID of the account that this API key authenticates for.
The API key value. This property only contains the API key value for the following cases: create an API key, update a service ID API key that stores the API key value as retrievable, or get a service ID API key that stores the API key value as retrievable. All other operations don't return the API key value, for example all user API key related operations, except for create, don't contain the API key value.
History of the API key.
Timestamp when the action was triggered.
IAM ID of the identity which triggered the action.
Account of the identity which triggered the action.
Action of the history entry.
Params of the history entry.
Message which summarizes the executed action.
history
Time when the entity was last authenticated.
Authentication count, number of times the entity was authenticated.
activity
apikeys
Status Code
Successful operation.
Parameter validation failed.
The incoming request did not contain a valid authentication information.
The incoming request is valid but the user is not allowed to perform the requested action.
User iam_id or account_id does not match Authorization token, service ID of the IAM ID not found.
Internal Server error.
{ "limit": 1, "first": { "href": "https://iam.cloud.ibm.com/v1/apikeys?pagetoken=PageToken" }, "next": { "href": "https://iam.cloud.ibm.com/v1/apikeys?pagetoken=PageToken" }, "apikeys": { "id": "ApiKey-fffc06c0-f3fd-49e5-82b5-b9dec9a3c47c", "entity_tag": "3-5c26819c7a9df67ac5d51c5761e1ac8a", "crn": "crn:v1:bluemix:public:iam-identity::a/100abcde100a41abc100aza678abc0zz::apikey:ApiKey-fffc06c0-f3fd-49e5-82b5-b9dec9a3c47c", "locked": false, "created_at": "2020-09-28T17:49+0000", "created_by": "IBMid-110000AB1Z", "modified_at": "2020-09-28T17:49+0000", "name": "apikeyNew", "description": "test", "iam_id": "IBMid-110000AB1Z", "account_id": "100abcde100a41abc100aza678abc0zz" } }
{ "limit": 1, "first": { "href": "https://iam.cloud.ibm.com/v1/apikeys?pagetoken=PageToken" }, "next": { "href": "https://iam.cloud.ibm.com/v1/apikeys?pagetoken=PageToken" }, "apikeys": { "id": "ApiKey-fffc06c0-f3fd-49e5-82b5-b9dec9a3c47c", "entity_tag": "3-5c26819c7a9df67ac5d51c5761e1ac8a", "crn": "crn:v1:bluemix:public:iam-identity::a/100abcde100a41abc100aza678abc0zz::apikey:ApiKey-fffc06c0-f3fd-49e5-82b5-b9dec9a3c47c", "locked": false, "created_at": "2020-09-28T17:49+0000", "created_by": "IBMid-110000AB1Z", "modified_at": "2020-09-28T17:49+0000", "name": "apikeyNew", "description": "test", "iam_id": "IBMid-110000AB1Z", "account_id": "100abcde100a41abc100aza678abc0zz" } }
Create an API key
Creates an API key for a UserID or service ID. Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to.
Creates an API key for a UserID or service ID. Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to.
Creates an API key for a UserID or service ID. Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to.
Creates an API key for a UserID or service ID. Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to.
Creates an API key for a UserID or service ID. Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to.
POST /v1/apikeys
(iamIdentity *IamIdentityV1) CreateAPIKey(createAPIKeyOptions *CreateAPIKeyOptions) (result *APIKey, response *core.DetailedResponse, err error)
(iamIdentity *IamIdentityV1) CreateAPIKeyWithContext(ctx context.Context, createAPIKeyOptions *CreateAPIKeyOptions) (result *APIKey, response *core.DetailedResponse, err error)
ServiceCall<ApiKey> createApiKey(CreateApiKeyOptions createApiKeyOptions)
createApiKey(params)
create_api_key(
self,
name: str,
iam_id: str,
*,
description: str = None,
account_id: str = None,
apikey: str = None,
store_value: bool = None,
entity_lock: str = None,
**kwargs,
) -> DetailedResponse
Request
Instantiate the CreateAPIKeyOptions
struct and set the fields to provide parameter values for the CreateAPIKey
method.
Use the CreateApiKeyOptions.Builder
to create a CreateApiKeyOptions
object that contains the parameter values for the createApiKey
method.
Custom Headers
Authorization Token used for the request. The supported token type is a Cloud IAM Access Token. If the token is omitted the request will fail with BXNIM0308E: 'No authorization header found'. Make sure that the provided token has the required authority for the request.
Indicates if the API key is locked for further write operations. False by default.
Default:
false
Request to create an API key.
Name of the API key. The name is not checked for uniqueness. Therefore multiple names with the same value can exist. Access is done via the UUID of the API key.
The iam_id that this API key authenticates.
The optional description of the API key. The 'description' property is only available if a description was provided during a create of an API key.
The account ID of the API key.
You can optionally passthrough the API key value for this API key. If passed, NO validation of that apiKey value is done, i.e. the value can be non-URL safe. If omitted, the API key management will create an URL safe opaque API key value. The value of the API key is checked for uniqueness. Ensure enough variations when passing in this value.
Send 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. We don't allow storing of API keys for users.
WithContext method only
A context.Context instance that you can use to specify a timeout for the operation or to cancel an in-flight request.
The CreateAPIKey options.
Name of the API key. The name is not checked for uniqueness. Therefore multiple names with the same value can exist. Access is done via the UUID of the API key.
The iam_id that this API key authenticates.
The optional description of the API key. The 'description' property is only available if a description was provided during a create of an API key.
The account ID of the API key.
You can optionally passthrough the API key value for this API key. If passed, NO validation of that apiKey value is done, i.e. the value can be non-URL safe. If omitted, the API key management will create an URL safe opaque API key value. The value of the API key is checked for uniqueness. Ensure enough variations when passing in this value.
Send 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. We don't allow storing of API keys for users.Indicates if the API key is locked for further write operations. False by default.
Default:
false
The createApiKey options.
Name of the API key. The name is not checked for uniqueness. Therefore multiple names with the same value can exist. Access is done via the UUID of the API key.
The iam_id that this API key authenticates.
The optional description of the API key. The 'description' property is only available if a description was provided during a create of an API key.
The account ID of the API key.
You can optionally passthrough the API key value for this API key. If passed, NO validation of that apiKey value is done, i.e. the value can be non-URL safe. If omitted, the API key management will create an URL safe opaque API key value. The value of the API key is checked for uniqueness. Ensure enough variations when passing in this value.
Send 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. We don't allow storing of API keys for users.Indicates if the API key is locked for further write operations. False by default.
Default:
false
parameters
Name of the API key. The name is not checked for uniqueness. Therefore multiple names with the same value can exist. Access is done via the UUID of the API key.
The iam_id that this API key authenticates.
The optional description of the API key. The 'description' property is only available if a description was provided during a create of an API key.
The account ID of the API key.
You can optionally passthrough the API key value for this API key. If passed, NO validation of that apiKey value is done, i.e. the value can be non-URL safe. If omitted, the API key management will create an URL safe opaque API key value. The value of the API key is checked for uniqueness. Ensure enough variations when passing in this value.
Send 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. We don't allow storing of API keys for users.Indicates if the API key is locked for further write operations. False by default.
Default:
false
parameters
Name of the API key. The name is not checked for uniqueness. Therefore multiple names with the same value can exist. Access is done via the UUID of the API key.
The iam_id that this API key authenticates.
The optional description of the API key. The 'description' property is only available if a description was provided during a create of an API key.
The account ID of the API key.
You can optionally passthrough the API key value for this API key. If passed, NO validation of that apiKey value is done, i.e. the value can be non-URL safe. If omitted, the API key management will create an URL safe opaque API key value. The value of the API key is checked for uniqueness. Ensure enough variations when passing in this value.
Send 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. We don't allow storing of API keys for users.Indicates if the API key is locked for further write operations. False by default.
Default:
false
curl -X POST 'https://iam.cloud.ibm.com/v1/apikeys' -H 'Authorization: Bearer TOKEN' -H 'Content-Type: application/json' -d '{ "name": "My-apikey", "description": "my personal key", "iam_id": "IBMid-123WEREW", "account_id": "ACCOUNT_ID" "store_value": false }'
createAPIKeyOptions := iamIdentityService.NewCreateAPIKeyOptions(apikeyName, iamID) createAPIKeyOptions.SetDescription("Example ApiKey") apiKey, response, err := iamIdentityService.CreateAPIKey(createAPIKeyOptions) if err != nil { panic(err) } b, _ := json.MarshalIndent(apiKey, "", " ") fmt.Println(string(b)) apikeyID = *apiKey.ID
CreateApiKeyOptions createApiKeyOptions = new CreateApiKeyOptions.Builder() .name(apiKeyName) .iamId(iamId) .description("Example ApiKey") .build(); Response<ApiKey> response = service.createApiKey(createApiKeyOptions).execute(); ApiKey apiKey = response.getResult(); apikeyId = apiKey.getId(); System.out.println(apiKey);
const params = { name: apikeyName, iamId: iamId, description: 'Example ApiKey', }; try { const res = await iamIdentityService.createApiKey(params); apikeyId = res.result.id console.log(JSON.stringify(res.result, null, 2)); } catch (err) { console.warn(err); }
api_key = iam_identity_service.create_api_key(name=apikey_name, iam_id=iam_id).get_result() apikey_id = api_key['id'] print(json.dumps(api_key, indent=2))
Response
Response body format for API key V1 REST requests.
Unique identifier of this API Key.
Cloud Resource Name of the item. Example Cloud Resource Name: 'crn:v1:bluemix:public:iam-identity:us-south:a/myaccount::apikey:1234-9012-5678'
The API key cannot be changed if set to true.
IAM ID of the user or service which created the API key.
Name of the API key. The name is not checked for uniqueness. Therefore multiple names with the same value can exist. Access is done via the UUID of the API key.
The iam_id that this API key authenticates.
ID of the account that this API key authenticates for.
The API key value. This property only contains the API key value for the following cases: create an API key, update a service ID API key that stores the API key value as retrievable, or get a service ID API key that stores the API key value as retrievable. All other operations don't return the API key value, for example all user API key related operations, except for create, don't contain the API key value.
Context with key properties for problem determination.
Version of the API Key details object. You need to specify this value when updating the API key to avoid stale updates.
If set contains a date time string of the creation date in ISO format.
If set contains a date time string of the last modification date in ISO format.
The optional description of the API key. The 'description' property is only available if a description was provided during a create of an API key.
History of the API key.
Response body format for API key V1 REST requests.
Context with key properties for problem determination.
The transaction ID of the inbound REST request.
The operation of the inbound REST request.
The user agent of the inbound REST request.
The URL of that cluster.
The instance ID of the server instance processing the request.
The thread ID of the server instance processing the request.
The host of the server instance processing the request.
The start time of the request.
The finish time of the request.
The elapsed time in msec.
The cluster name.
Context
Unique identifier of this API Key.
Version of the API Key details object. You need to specify this value when updating the API key to avoid stale updates.
Cloud Resource Name of the item. Example Cloud Resource Name: 'crn:v1:bluemix:public:iam-identity:us-south:a/myaccount::apikey:1234-9012-5678'.
The API key cannot be changed if set to true.
If set contains a date time string of the creation date in ISO format.
IAM ID of the user or service which created the API key.
If set contains a date time string of the last modification date in ISO format.
Name of the API key. The name is not checked for uniqueness. Therefore multiple names with the same value can exist. Access is done via the UUID of the API key.
The optional description of the API key. The 'description' property is only available if a description was provided during a create of an API key.
The iam_id that this API key authenticates.
ID of the account that this API key authenticates for.
The API key value. This property only contains the API key value for the following cases: create an API key, update a service ID API key that stores the API key value as retrievable, or get a service ID API key that stores the API key value as retrievable. All other operations don't return the API key value, for example all user API key related operations, except for create, don't contain the API key value.
History of the API key.
Timestamp when the action was triggered.
IAM ID of the identity which triggered the action.
Account of the identity which triggered the action.
Action of the history entry.
Params of the history entry.
Message which summarizes the executed action.
History
Time when the entity was last authenticated.
Authentication count, number of times the entity was authenticated.
Activity
Response body format for API key V1 REST requests.
Context with key properties for problem determination.
The transaction ID of the inbound REST request.
The operation of the inbound REST request.
The user agent of the inbound REST request.
The URL of that cluster.
The instance ID of the server instance processing the request.
The thread ID of the server instance processing the request.
The host of the server instance processing the request.
The start time of the request.
The finish time of the request.
The elapsed time in msec.
The cluster name.
context
Unique identifier of this API Key.
Version of the API Key details object. You need to specify this value when updating the API key to avoid stale updates.
Cloud Resource Name of the item. Example Cloud Resource Name: 'crn:v1:bluemix:public:iam-identity:us-south:a/myaccount::apikey:1234-9012-5678'.
The API key cannot be changed if set to true.
If set contains a date time string of the creation date in ISO format.
IAM ID of the user or service which created the API key.
If set contains a date time string of the last modification date in ISO format.
Name of the API key. The name is not checked for uniqueness. Therefore multiple names with the same value can exist. Access is done via the UUID of the API key.
The optional description of the API key. The 'description' property is only available if a description was provided during a create of an API key.
The iam_id that this API key authenticates.
ID of the account that this API key authenticates for.
The API key value. This property only contains the API key value for the following cases: create an API key, update a service ID API key that stores the API key value as retrievable, or get a service ID API key that stores the API key value as retrievable. All other operations don't return the API key value, for example all user API key related operations, except for create, don't contain the API key value.
History of the API key.
Timestamp when the action was triggered.
IAM ID of the identity which triggered the action.
Account of the identity which triggered the action.
Action of the history entry.
Params of the history entry.
Message which summarizes the executed action.
history
Time when the entity was last authenticated.
Authentication count, number of times the entity was authenticated.
activity
Response body format for API key V1 REST requests.
Context with key properties for problem determination.
The transaction ID of the inbound REST request.
The operation of the inbound REST request.
The user agent of the inbound REST request.
The URL of that cluster.
The instance ID of the server instance processing the request.
The thread ID of the server instance processing the request.
The host of the server instance processing the request.
The start time of the request.
The finish time of the request.
The elapsed time in msec.
The cluster name.
context
Unique identifier of this API Key.
Version of the API Key details object. You need to specify this value when updating the API key to avoid stale updates.
Cloud Resource Name of the item. Example Cloud Resource Name: 'crn:v1:bluemix:public:iam-identity:us-south:a/myaccount::apikey:1234-9012-5678'.
The API key cannot be changed if set to true.
If set contains a date time string of the creation date in ISO format.
IAM ID of the user or service which created the API key.
If set contains a date time string of the last modification date in ISO format.
Name of the API key. The name is not checked for uniqueness. Therefore multiple names with the same value can exist. Access is done via the UUID of the API key.
The optional description of the API key. The 'description' property is only available if a description was provided during a create of an API key.
The iam_id that this API key authenticates.
ID of the account that this API key authenticates for.
The API key value. This property only contains the API key value for the following cases: create an API key, update a service ID API key that stores the API key value as retrievable, or get a service ID API key that stores the API key value as retrievable. All other operations don't return the API key value, for example all user API key related operations, except for create, don't contain the API key value.
History of the API key.
Timestamp when the action was triggered.
IAM ID of the identity which triggered the action.
Account of the identity which triggered the action.
Action of the history entry.
Params of the history entry.
Message which summarizes the executed action.
history
Time when the entity was last authenticated.
Authentication count, number of times the entity was authenticated.
activity
Response body format for API key V1 REST requests.
Context with key properties for problem determination.
The transaction ID of the inbound REST request.
The operation of the inbound REST request.
The user agent of the inbound REST request.
The URL of that cluster.
The instance ID of the server instance processing the request.
The thread ID of the server instance processing the request.
The host of the server instance processing the request.
The start time of the request.
The finish time of the request.
The elapsed time in msec.
The cluster name.
context
Unique identifier of this API Key.
Version of the API Key details object. You need to specify this value when updating the API key to avoid stale updates.
Cloud Resource Name of the item. Example Cloud Resource Name: 'crn:v1:bluemix:public:iam-identity:us-south:a/myaccount::apikey:1234-9012-5678'.
The API key cannot be changed if set to true.
If set contains a date time string of the creation date in ISO format.
IAM ID of the user or service which created the API key.
If set contains a date time string of the last modification date in ISO format.
Name of the API key. The name is not checked for uniqueness. Therefore multiple names with the same value can exist. Access is done via the UUID of the API key.
The optional description of the API key. The 'description' property is only available if a description was provided during a create of an API key.
The iam_id that this API key authenticates.
ID of the account that this API key authenticates for.
The API key value. This property only contains the API key value for the following cases: create an API key, update a service ID API key that stores the API key value as retrievable, or get a service ID API key that stores the API key value as retrievable. All other operations don't return the API key value, for example all user API key related operations, except for create, don't contain the API key value.
History of the API key.
Timestamp when the action was triggered.
IAM ID of the identity which triggered the action.
Account of the identity which triggered the action.
Action of the history entry.
Params of the history entry.
Message which summarizes the executed action.
history
Time when the entity was last authenticated.
Authentication count, number of times the entity was authenticated.
activity
Status Code
API key successfully created. Response if the Object could be created in the persistence layer.
Parameter validation failed. Response if required parameters are missing or if parameter values are invalid.
The incoming request did not contain a valid authentication information.
The incoming request is valid but the user is not allowed to perform the requested action.
Create Conflict - API key could not be created. Response if the Object could not be created in the persistence layer.
Internal Server error. Response if unexpected error situation. happened.
{ "id": "ApiKey-5ccff000-9ff1-4481-a760-29c22a7603e7", "entity_tag": "1-b4053b5d441613fdad4ff3c28db3e7cc", "crn": "crn:v1:bluemix:public:iam-identity::a/100abcde100a41abc100aza678abc0zz::apikey:ApiKey-5ccff000-9ff1-4481-a760-29c22a7603e7", "locked": false, "created_at": "2020-11-10T12:28+0000", "created_by": "IBMid-110000AB1Z", "modified_at": "2020-11-10T12:28+0000", "name": "apikey-test", "description": "apikey-test", "iam_id": "IBMid-110000AB1Z", "account_id": "100abcde100a41abc100aza678abc0zz", "apikey": "created_apikey" }
{ "id": "ApiKey-5ccff000-9ff1-4481-a760-29c22a7603e7", "entity_tag": "1-b4053b5d441613fdad4ff3c28db3e7cc", "crn": "crn:v1:bluemix:public:iam-identity::a/100abcde100a41abc100aza678abc0zz::apikey:ApiKey-5ccff000-9ff1-4481-a760-29c22a7603e7", "locked": false, "created_at": "2020-11-10T12:28+0000", "created_by": "IBMid-110000AB1Z", "modified_at": "2020-11-10T12:28+0000", "name": "apikey-test", "description": "apikey-test", "iam_id": "IBMid-110000AB1Z", "account_id": "100abcde100a41abc100aza678abc0zz", "apikey": "created_apikey" }
Get details of an API key by its value
Returns the details of an API key by its value. Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to.
Returns the details of an API key by its value. Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to.
Returns the details of an API key by its value. Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to.
Returns the details of an API key by its value. Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to.
Returns the details of an API key by its value. Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to.
GET /v1/apikeys/details
(iamIdentity *IamIdentityV1) GetAPIKeysDetails(getAPIKeysDetailsOptions *GetAPIKeysDetailsOptions) (result *APIKey, response *core.DetailedResponse, err error)
(iamIdentity *IamIdentityV1) GetAPIKeysDetailsWithContext(ctx context.Context, getAPIKeysDetailsOptions *GetAPIKeysDetailsOptions) (result *APIKey, response *core.DetailedResponse, err error)
ServiceCall<ApiKey> getApiKeysDetails(GetApiKeysDetailsOptions getApiKeysDetailsOptions)
getApiKeysDetails(params)
get_api_keys_details(
self,
*,
iam_api_key: str = None,
include_history: bool = None,
**kwargs,
) -> DetailedResponse
Request
Instantiate the GetAPIKeysDetailsOptions
struct and set the fields to provide parameter values for the GetAPIKeysDetails
method.
Use the GetApiKeysDetailsOptions.Builder
to create a GetApiKeysDetailsOptions
object that contains the parameter values for the getApiKeysDetails
method.
Custom Headers
Authorization Token used for the request. The supported token type is a Cloud IAM Access Token. If the token is omitted the request will fail with BXNIM0308E: 'No authorization header found'. Make sure that the provided token has the required authority for the request.
API key value.
Query Parameters
Defines if the entity history is included in the response.
Default:
false
WithContext method only
A context.Context instance that you can use to specify a timeout for the operation or to cancel an in-flight request.
The GetAPIKeysDetails options.
API key value.
Defines if the entity history is included in the response.
Default:
false
The getApiKeysDetails options.
API key value.
Defines if the entity history is included in the response.
Default:
false
parameters
API key value.
Defines if the entity history is included in the response.
Default:
false
parameters
API key value.
Defines if the entity history is included in the response.
Default:
false
curl -X GET 'https://iam.cloud.ibm.com/v1/apikeys/details' -H 'Authorization: Bearer TOKEN' -H 'IAM-Apikey: APIKEY_VALUE' -H 'Content-Type: application/json'
getAPIKeysDetailsOptions := iamIdentityService.NewGetAPIKeysDetailsOptions() getAPIKeysDetailsOptions.SetIamAPIKey(iamAPIKey) getAPIKeysDetailsOptions.SetIncludeHistory(false) apiKey, response, err := iamIdentityService.GetAPIKeysDetails(getAPIKeysDetailsOptions) if err != nil { panic(err) } b, _ := json.MarshalIndent(apiKey, "", " ") fmt.Println(string(b))
GetApiKeysDetailsOptions getApiKeysDetailsOptions = new GetApiKeysDetailsOptions.Builder() .iamApiKey(iamApiKey) .includeHistory(false) .build(); Response<ApiKey> response = service.getApiKeysDetails(getApiKeysDetailsOptions).execute(); ApiKey apiKey = response.getResult(); System.out.println(apiKey);
const params = { iamApiKey: iamApikey, includeHistory: false, }; try { const res = await iamIdentityService.getApiKeysDetails(params); console.log(JSON.stringify(res.result, null, 2)); } catch (err) { console.warn(err); }
api_key = iam_identity_service.get_api_keys_details(iam_api_key=apikey).get_result() print(json.dumps(api_key, indent=2))
Response
Response body format for API key V1 REST requests.
Unique identifier of this API Key.
Cloud Resource Name of the item. Example Cloud Resource Name: 'crn:v1:bluemix:public:iam-identity:us-south:a/myaccount::apikey:1234-9012-5678'
The API key cannot be changed if set to true.
IAM ID of the user or service which created the API key.
Name of the API key. The name is not checked for uniqueness. Therefore multiple names with the same value can exist. Access is done via the UUID of the API key.
The iam_id that this API key authenticates.
ID of the account that this API key authenticates for.
The API key value. This property only contains the API key value for the following cases: create an API key, update a service ID API key that stores the API key value as retrievable, or get a service ID API key that stores the API key value as retrievable. All other operations don't return the API key value, for example all user API key related operations, except for create, don't contain the API key value.
Context with key properties for problem determination.
Version of the API Key details object. You need to specify this value when updating the API key to avoid stale updates.
If set contains a date time string of the creation date in ISO format.
If set contains a date time string of the last modification date in ISO format.
The optional description of the API key. The 'description' property is only available if a description was provided during a create of an API key.
History of the API key.
Response body format for API key V1 REST requests.
Context with key properties for problem determination.
The transaction ID of the inbound REST request.
The operation of the inbound REST request.
The user agent of the inbound REST request.
The URL of that cluster.
The instance ID of the server instance processing the request.
The thread ID of the server instance processing the request.
The host of the server instance processing the request.
The start time of the request.
The finish time of the request.
The elapsed time in msec.
The cluster name.
Context
Unique identifier of this API Key.
Version of the API Key details object. You need to specify this value when updating the API key to avoid stale updates.
Cloud Resource Name of the item. Example Cloud Resource Name: 'crn:v1:bluemix:public:iam-identity:us-south:a/myaccount::apikey:1234-9012-5678'.
The API key cannot be changed if set to true.
If set contains a date time string of the creation date in ISO format.
IAM ID of the user or service which created the API key.
If set contains a date time string of the last modification date in ISO format.
Name of the API key. The name is not checked for uniqueness. Therefore multiple names with the same value can exist. Access is done via the UUID of the API key.
The optional description of the API key. The 'description' property is only available if a description was provided during a create of an API key.
The iam_id that this API key authenticates.
ID of the account that this API key authenticates for.
The API key value. This property only contains the API key value for the following cases: create an API key, update a service ID API key that stores the API key value as retrievable, or get a service ID API key that stores the API key value as retrievable. All other operations don't return the API key value, for example all user API key related operations, except for create, don't contain the API key value.
History of the API key.
Timestamp when the action was triggered.
IAM ID of the identity which triggered the action.
Account of the identity which triggered the action.
Action of the history entry.
Params of the history entry.
Message which summarizes the executed action.
History
Time when the entity was last authenticated.
Authentication count, number of times the entity was authenticated.
Activity
Response body format for API key V1 REST requests.
Context with key properties for problem determination.
The transaction ID of the inbound REST request.
The operation of the inbound REST request.
The user agent of the inbound REST request.
The URL of that cluster.
The instance ID of the server instance processing the request.
The thread ID of the server instance processing the request.
The host of the server instance processing the request.
The start time of the request.
The finish time of the request.
The elapsed time in msec.
The cluster name.
context
Unique identifier of this API Key.
Version of the API Key details object. You need to specify this value when updating the API key to avoid stale updates.
Cloud Resource Name of the item. Example Cloud Resource Name: 'crn:v1:bluemix:public:iam-identity:us-south:a/myaccount::apikey:1234-9012-5678'.
The API key cannot be changed if set to true.
If set contains a date time string of the creation date in ISO format.
IAM ID of the user or service which created the API key.
If set contains a date time string of the last modification date in ISO format.
Name of the API key. The name is not checked for uniqueness. Therefore multiple names with the same value can exist. Access is done via the UUID of the API key.
The optional description of the API key. The 'description' property is only available if a description was provided during a create of an API key.
The iam_id that this API key authenticates.
ID of the account that this API key authenticates for.
The API key value. This property only contains the API key value for the following cases: create an API key, update a service ID API key that stores the API key value as retrievable, or get a service ID API key that stores the API key value as retrievable. All other operations don't return the API key value, for example all user API key related operations, except for create, don't contain the API key value.
History of the API key.
Timestamp when the action was triggered.
IAM ID of the identity which triggered the action.
Account of the identity which triggered the action.
Action of the history entry.
Params of the history entry.
Message which summarizes the executed action.
history
Time when the entity was last authenticated.
Authentication count, number of times the entity was authenticated.
activity
Response body format for API key V1 REST requests.
Context with key properties for problem determination.
The transaction ID of the inbound REST request.
The operation of the inbound REST request.
The user agent of the inbound REST request.
The URL of that cluster.
The instance ID of the server instance processing the request.
The thread ID of the server instance processing the request.
The host of the server instance processing the request.
The start time of the request.
The finish time of the request.
The elapsed time in msec.
The cluster name.
context
Unique identifier of this API Key.
Version of the API Key details object. You need to specify this value when updating the API key to avoid stale updates.
Cloud Resource Name of the item. Example Cloud Resource Name: 'crn:v1:bluemix:public:iam-identity:us-south:a/myaccount::apikey:1234-9012-5678'.
The API key cannot be changed if set to true.
If set contains a date time string of the creation date in ISO format.
IAM ID of the user or service which created the API key.
If set contains a date time string of the last modification date in ISO format.
Name of the API key. The name is not checked for uniqueness. Therefore multiple names with the same value can exist. Access is done via the UUID of the API key.
The optional description of the API key. The 'description' property is only available if a description was provided during a create of an API key.
The iam_id that this API key authenticates.
ID of the account that this API key authenticates for.
The API key value. This property only contains the API key value for the following cases: create an API key, update a service ID API key that stores the API key value as retrievable, or get a service ID API key that stores the API key value as retrievable. All other operations don't return the API key value, for example all user API key related operations, except for create, don't contain the API key value.
History of the API key.
Timestamp when the action was triggered.
IAM ID of the identity which triggered the action.
Account of the identity which triggered the action.
Action of the history entry.
Params of the history entry.
Message which summarizes the executed action.
history
Time when the entity was last authenticated.
Authentication count, number of times the entity was authenticated.
activity
Response body format for API key V1 REST requests.
Context with key properties for problem determination.
The transaction ID of the inbound REST request.
The operation of the inbound REST request.
The user agent of the inbound REST request.
The URL of that cluster.
The instance ID of the server instance processing the request.
The thread ID of the server instance processing the request.
The host of the server instance processing the request.
The start time of the request.
The finish time of the request.
The elapsed time in msec.
The cluster name.
context
Unique identifier of this API Key.
Version of the API Key details object. You need to specify this value when updating the API key to avoid stale updates.
Cloud Resource Name of the item. Example Cloud Resource Name: 'crn:v1:bluemix:public:iam-identity:us-south:a/myaccount::apikey:1234-9012-5678'.
The API key cannot be changed if set to true.
If set contains a date time string of the creation date in ISO format.
IAM ID of the user or service which created the API key.
If set contains a date time string of the last modification date in ISO format.
Name of the API key. The name is not checked for uniqueness. Therefore multiple names with the same value can exist. Access is done via the UUID of the API key.
The optional description of the API key. The 'description' property is only available if a description was provided during a create of an API key.
The iam_id that this API key authenticates.
ID of the account that this API key authenticates for.
The API key value. This property only contains the API key value for the following cases: create an API key, update a service ID API key that stores the API key value as retrievable, or get a service ID API key that stores the API key value as retrievable. All other operations don't return the API key value, for example all user API key related operations, except for create, don't contain the API key value.
History of the API key.
Timestamp when the action was triggered.
IAM ID of the identity which triggered the action.
Account of the identity which triggered the action.
Action of the history entry.
Params of the history entry.
Message which summarizes the executed action.
history
Time when the entity was last authenticated.
Authentication count, number of times the entity was authenticated.
activity
Status Code
Successful Get of API key details.
Parameter validation failed.
The incoming request did not contain a valid authentication information.
The incoming request is valid but the user is not allowed to perform the requested action.
API key not found.
Internal Server error.
{ "id": "ApiKey-5ccff000-9ff1-4481-a760-29c22a7603e7", "entity_tag": "1-b4053b5d441613fdad4ff3c28db3e7cc", "crn": "crn:v1:bluemix:public:iam-identity::a/100abcde100a41abc100aza678abc0zz::apikey:ApiKey-5ccff000-9ff1-4481-a760-29c22a7603e7", "locked": false, "created_at": "2020-11-10T12:28+0000", "created_by": "IBMid-110000AB1Z", "modified_at": "2020-11-10T12:28+0000", "name": "apikey-test", "description": "apikey-test", "iam_id": "IBMid-110000AB1Z", "account_id": "100abcde100a41abc100aza678abc0zz" }
{ "id": "ApiKey-5ccff000-9ff1-4481-a760-29c22a7603e7", "entity_tag": "1-b4053b5d441613fdad4ff3c28db3e7cc", "crn": "crn:v1:bluemix:public:iam-identity::a/100abcde100a41abc100aza678abc0zz::apikey:ApiKey-5ccff000-9ff1-4481-a760-29c22a7603e7", "locked": false, "created_at": "2020-11-10T12:28+0000", "created_by": "IBMid-110000AB1Z", "modified_at": "2020-11-10T12:28+0000", "name": "apikey-test", "description": "apikey-test", "iam_id": "IBMid-110000AB1Z", "account_id": "100abcde100a41abc100aza678abc0zz" }
Get details of an API key
Returns the details of an API key. Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to. In case of service IDs and their API keys, a user must be either an account owner, a IBM Cloud org manager or IBM Cloud space developer in order to manage service IDs of the entity.
Returns the details of an API key. Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to. In case of service IDs and their API keys, a user must be either an account owner, a IBM Cloud org manager or IBM Cloud space developer in order to manage service IDs of the entity.
Returns the details of an API key. Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to. In case of service IDs and their API keys, a user must be either an account owner, a IBM Cloud org manager or IBM Cloud space developer in order to manage service IDs of the entity.
Returns the details of an API key. Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to. In case of service IDs and their API keys, a user must be either an account owner, a IBM Cloud org manager or IBM Cloud space developer in order to manage service IDs of the entity.
Returns the details of an API key. Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to. In case of service IDs and their API keys, a user must be either an account owner, a IBM Cloud org manager or IBM Cloud space developer in order to manage service IDs of the entity.
GET /v1/apikeys/{id}
(iamIdentity *IamIdentityV1) GetAPIKey(getAPIKeyOptions *GetAPIKeyOptions) (result *APIKey, response *core.DetailedResponse, err error)
(iamIdentity *IamIdentityV1) GetAPIKeyWithContext(ctx context.Context, getAPIKeyOptions *GetAPIKeyOptions) (result *APIKey, response *core.DetailedResponse, err error)
ServiceCall<ApiKey> getApiKey(GetApiKeyOptions getApiKeyOptions)
getApiKey(params)
get_api_key(
self,
id: str,
*,
include_history: bool = None,
include_activity: bool = None,
**kwargs,
) -> DetailedResponse
Request
Instantiate the GetAPIKeyOptions
struct and set the fields to provide parameter values for the GetAPIKey
method.
Use the GetApiKeyOptions.Builder
to create a GetApiKeyOptions
object that contains the parameter values for the getApiKey
method.
Custom Headers
Authorization Token used for the request. The supported token type is a Cloud IAM Access Token. If the token is omitted the request will fail with BXNIM0308E: 'No authorization header found'. Make sure that the provided token has the required authority for the request.
Path Parameters
Unique ID of the API key.
Query Parameters
Defines if the entity history is included in the response.
Default:
false
Defines if the entity's activity is included in the response. Retrieving activity data is an expensive operation, so only request this when needed.
Default:
false
WithContext method only
A context.Context instance that you can use to specify a timeout for the operation or to cancel an in-flight request.
The GetAPIKey options.
Unique ID of the API key.
Defines if the entity history is included in the response.
Default:
false
Defines if the entity's activity is included in the response. Retrieving activity data is an expensive operation, so only request this when needed.
Default:
false
The getApiKey options.
Unique ID of the API key.
Defines if the entity history is included in the response.
Default:
false
Defines if the entity's activity is included in the response. Retrieving activity data is an expensive operation, so only request this when needed.
Default:
false
parameters
Unique ID of the API key.
Defines if the entity history is included in the response.
Default:
false
Defines if the entity's activity is included in the response. Retrieving activity data is an expensive operation, so only request this when needed.
Default:
false
parameters
Unique ID of the API key.
Defines if the entity history is included in the response.
Default:
false
Defines if the entity's activity is included in the response. Retrieving activity data is an expensive operation, so only request this when needed.
Default:
false
curl -X GET 'https://iam.cloud.ibm.com/v1/apikeys/APIKEY_UNIQUE_ID' -H 'Authorization: Bearer TOKEN' -H 'Content-Type: application/json'
getAPIKeyOptions := iamIdentityService.NewGetAPIKeyOptions(apikeyID) getAPIKeyOptions.SetIncludeHistory(false) getAPIKeyOptions.SetIncludeActivity(false) apiKey, response, err := iamIdentityService.GetAPIKey(getAPIKeyOptions) if err != nil { panic(err) } apikeyEtag = response.GetHeaders().Get("Etag") b, _ := json.MarshalIndent(apiKey, "", " ") fmt.Println(string(b))
GetApiKeyOptions getApiKeyOptions = new GetApiKeyOptions.Builder() .id(apikeyId) .includeHistory(true) .includeActivity(true) .build(); Response<ApiKey> response = service.getApiKey(getApiKeyOptions).execute(); ApiKey apiKey = response.getResult(); apikeyEtag = response.getHeaders().values("Etag").get(0); System.out.println(apiKey);
const params = { id: apikeyId, includeActivity: true, }; try { const res = await iamIdentityService.getApiKey(params); apikeyEtag = res.headers['etag']; console.log(JSON.stringify(res.result, null, 2)); } catch (err) { console.warn(err); }
response = iam_identity_service.get_api_key( id=apikey_id, include_activity=True, ) apikey_etag = response.get_headers()['Etag'] api_key = response.get_result() print(json.dumps(api_key, indent=2))
Response
Response body format for API key V1 REST requests.
Unique identifier of this API Key.
Cloud Resource Name of the item. Example Cloud Resource Name: 'crn:v1:bluemix:public:iam-identity:us-south:a/myaccount::apikey:1234-9012-5678'
The API key cannot be changed if set to true.
IAM ID of the user or service which created the API key.
Name of the API key. The name is not checked for uniqueness. Therefore multiple names with the same value can exist. Access is done via the UUID of the API key.
The iam_id that this API key authenticates.
ID of the account that this API key authenticates for.
The API key value. This property only contains the API key value for the following cases: create an API key, update a service ID API key that stores the API key value as retrievable, or get a service ID API key that stores the API key value as retrievable. All other operations don't return the API key value, for example all user API key related operations, except for create, don't contain the API key value.
Context with key properties for problem determination.
Version of the API Key details object. You need to specify this value when updating the API key to avoid stale updates.
If set contains a date time string of the creation date in ISO format.
If set contains a date time string of the last modification date in ISO format.
The optional description of the API key. The 'description' property is only available if a description was provided during a create of an API key.
History of the API key.
Response body format for API key V1 REST requests.
Context with key properties for problem determination.
The transaction ID of the inbound REST request.
The operation of the inbound REST request.
The user agent of the inbound REST request.
The URL of that cluster.
The instance ID of the server instance processing the request.
The thread ID of the server instance processing the request.
The host of the server instance processing the request.
The start time of the request.
The finish time of the request.
The elapsed time in msec.
The cluster name.
Context
Unique identifier of this API Key.
Version of the API Key details object. You need to specify this value when updating the API key to avoid stale updates.
Cloud Resource Name of the item. Example Cloud Resource Name: 'crn:v1:bluemix:public:iam-identity:us-south:a/myaccount::apikey:1234-9012-5678'.
The API key cannot be changed if set to true.
If set contains a date time string of the creation date in ISO format.
IAM ID of the user or service which created the API key.
If set contains a date time string of the last modification date in ISO format.
Name of the API key. The name is not checked for uniqueness. Therefore multiple names with the same value can exist. Access is done via the UUID of the API key.
The optional description of the API key. The 'description' property is only available if a description was provided during a create of an API key.
The iam_id that this API key authenticates.
ID of the account that this API key authenticates for.
The API key value. This property only contains the API key value for the following cases: create an API key, update a service ID API key that stores the API key value as retrievable, or get a service ID API key that stores the API key value as retrievable. All other operations don't return the API key value, for example all user API key related operations, except for create, don't contain the API key value.
History of the API key.
Timestamp when the action was triggered.
IAM ID of the identity which triggered the action.
Account of the identity which triggered the action.
Action of the history entry.
Params of the history entry.
Message which summarizes the executed action.
History
Time when the entity was last authenticated.
Authentication count, number of times the entity was authenticated.
Activity
Response body format for API key V1 REST requests.
Context with key properties for problem determination.
The transaction ID of the inbound REST request.
The operation of the inbound REST request.
The user agent of the inbound REST request.
The URL of that cluster.
The instance ID of the server instance processing the request.
The thread ID of the server instance processing the request.
The host of the server instance processing the request.
The start time of the request.
The finish time of the request.
The elapsed time in msec.
The cluster name.
context
Unique identifier of this API Key.
Version of the API Key details object. You need to specify this value when updating the API key to avoid stale updates.
Cloud Resource Name of the item. Example Cloud Resource Name: 'crn:v1:bluemix:public:iam-identity:us-south:a/myaccount::apikey:1234-9012-5678'.
The API key cannot be changed if set to true.
If set contains a date time string of the creation date in ISO format.
IAM ID of the user or service which created the API key.
If set contains a date time string of the last modification date in ISO format.
Name of the API key. The name is not checked for uniqueness. Therefore multiple names with the same value can exist. Access is done via the UUID of the API key.
The optional description of the API key. The 'description' property is only available if a description was provided during a create of an API key.
The iam_id that this API key authenticates.
ID of the account that this API key authenticates for.
The API key value. This property only contains the API key value for the following cases: create an API key, update a service ID API key that stores the API key value as retrievable, or get a service ID API key that stores the API key value as retrievable. All other operations don't return the API key value, for example all user API key related operations, except for create, don't contain the API key value.
History of the API key.
Timestamp when the action was triggered.
IAM ID of the identity which triggered the action.
Account of the identity which triggered the action.
Action of the history entry.
Params of the history entry.
Message which summarizes the executed action.
history
Time when the entity was last authenticated.
Authentication count, number of times the entity was authenticated.
activity
Response body format for API key V1 REST requests.
Context with key properties for problem determination.
The transaction ID of the inbound REST request.
The operation of the inbound REST request.
The user agent of the inbound REST request.
The URL of that cluster.
The instance ID of the server instance processing the request.
The thread ID of the server instance processing the request.
The host of the server instance processing the request.
The start time of the request.
The finish time of the request.
The elapsed time in msec.
The cluster name.
context
Unique identifier of this API Key.
Version of the API Key details object. You need to specify this value when updating the API key to avoid stale updates.
Cloud Resource Name of the item. Example Cloud Resource Name: 'crn:v1:bluemix:public:iam-identity:us-south:a/myaccount::apikey:1234-9012-5678'.
The API key cannot be changed if set to true.
If set contains a date time string of the creation date in ISO format.
IAM ID of the user or service which created the API key.
If set contains a date time string of the last modification date in ISO format.
Name of the API key. The name is not checked for uniqueness. Therefore multiple names with the same value can exist. Access is done via the UUID of the API key.
The optional description of the API key. The 'description' property is only available if a description was provided during a create of an API key.
The iam_id that this API key authenticates.
ID of the account that this API key authenticates for.
The API key value. This property only contains the API key value for the following cases: create an API key, update a service ID API key that stores the API key value as retrievable, or get a service ID API key that stores the API key value as retrievable. All other operations don't return the API key value, for example all user API key related operations, except for create, don't contain the API key value.
History of the API key.
Timestamp when the action was triggered.
IAM ID of the identity which triggered the action.
Account of the identity which triggered the action.
Action of the history entry.
Params of the history entry.
Message which summarizes the executed action.
history
Time when the entity was last authenticated.
Authentication count, number of times the entity was authenticated.
activity
Response body format for API key V1 REST requests.
Context with key properties for problem determination.
The transaction ID of the inbound REST request.
The operation of the inbound REST request.
The user agent of the inbound REST request.
The URL of that cluster.
The instance ID of the server instance processing the request.
The thread ID of the server instance processing the request.
The host of the server instance processing the request.
The start time of the request.
The finish time of the request.
The elapsed time in msec.
The cluster name.
context
Unique identifier of this API Key.
Version of the API Key details object. You need to specify this value when updating the API key to avoid stale updates.
Cloud Resource Name of the item. Example Cloud Resource Name: 'crn:v1:bluemix:public:iam-identity:us-south:a/myaccount::apikey:1234-9012-5678'.
The API key cannot be changed if set to true.
If set contains a date time string of the creation date in ISO format.
IAM ID of the user or service which created the API key.
If set contains a date time string of the last modification date in ISO format.
Name of the API key. The name is not checked for uniqueness. Therefore multiple names with the same value can exist. Access is done via the UUID of the API key.
The optional description of the API key. The 'description' property is only available if a description was provided during a create of an API key.
The iam_id that this API key authenticates.
ID of the account that this API key authenticates for.
The API key value. This property only contains the API key value for the following cases: create an API key, update a service ID API key that stores the API key value as retrievable, or get a service ID API key that stores the API key value as retrievable. All other operations don't return the API key value, for example all user API key related operations, except for create, don't contain the API key value.
History of the API key.
Timestamp when the action was triggered.
IAM ID of the identity which triggered the action.
Account of the identity which triggered the action.
Action of the history entry.
Params of the history entry.
Message which summarizes the executed action.
history
Time when the entity was last authenticated.
Authentication count, number of times the entity was authenticated.
activity
Status Code
Successful Get of API key.
Parameter validation failed.
The incoming request did not contain a valid authentication information.
The incoming request is valid but the user is not allowed to perform the requested action.
API key with provided ID not found.
Internal Server error.
{ "id": "ApiKey-5ccff000-9ff1-4481-a760-29c22a7603e7", "entity_tag": "1-b4053b5d441613fdad4ff3c28db3e7cc", "crn": "crn:v1:bluemix:public:iam-identity::a/100abcde100a41abc100aza678abc0zz::apikey:ApiKey-5ccff000-9ff1-4481-a760-29c22a7603e7", "locked": false, "created_at": "2020-11-10T12:28+0000", "created_by": "IBMid-110000AB1Z", "modified_at": "2020-11-10T12:28+0000", "name": "apikey-test", "description": "apikey-test", "iam_id": "IBMid-110000AB1Z", "account_id": "100abcde100a41abc100aza678abc0zz" }
{ "id": "ApiKey-5ccff000-9ff1-4481-a760-29c22a7603e7", "entity_tag": "1-b4053b5d441613fdad4ff3c28db3e7cc", "crn": "crn:v1:bluemix:public:iam-identity::a/100abcde100a41abc100aza678abc0zz::apikey:ApiKey-5ccff000-9ff1-4481-a760-29c22a7603e7", "locked": false, "created_at": "2020-11-10T12:28+0000", "created_by": "IBMid-110000AB1Z", "modified_at": "2020-11-10T12:28+0000", "name": "apikey-test", "description": "apikey-test", "iam_id": "IBMid-110000AB1Z", "account_id": "100abcde100a41abc100aza678abc0zz" }
Updates an API key
Updates properties of an API key. This does NOT affect existing access tokens. Their token content will stay unchanged until the access token is refreshed. To update an API key, pass the property to be modified. To delete one property's value, pass the property with an empty value "".Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to.
Updates properties of an API key. This does NOT affect existing access tokens. Their token content will stay unchanged until the access token is refreshed. To update an API key, pass the property to be modified. To delete one property's value, pass the property with an empty value "".Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to.
Updates properties of an API key. This does NOT affect existing access tokens. Their token content will stay unchanged until the access token is refreshed. To update an API key, pass the property to be modified. To delete one property's value, pass the property with an empty value "".Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to.
Updates properties of an API key. This does NOT affect existing access tokens. Their token content will stay unchanged until the access token is refreshed. To update an API key, pass the property to be modified. To delete one property's value, pass the property with an empty value "".Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to.
Updates properties of an API key. This does NOT affect existing access tokens. Their token content will stay unchanged until the access token is refreshed. To update an API key, pass the property to be modified. To delete one property's value, pass the property with an empty value "".Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to.
PUT /v1/apikeys/{id}
(iamIdentity *IamIdentityV1) UpdateAPIKey(updateAPIKeyOptions *UpdateAPIKeyOptions) (result *APIKey, response *core.DetailedResponse, err error)
(iamIdentity *IamIdentityV1) UpdateAPIKeyWithContext(ctx context.Context, updateAPIKeyOptions *UpdateAPIKeyOptions) (result *APIKey, response *core.DetailedResponse, err error)
ServiceCall<ApiKey> updateApiKey(UpdateApiKeyOptions updateApiKeyOptions)
updateApiKey(params)
update_api_key(
self,
id: str,
if_match: str,
*,
name: str = None,
description: str = None,
**kwargs,
) -> DetailedResponse
Request
Instantiate the UpdateAPIKeyOptions
struct and set the fields to provide parameter values for the UpdateAPIKey
method.
Use the UpdateApiKeyOptions.Builder
to create a UpdateApiKeyOptions
object that contains the parameter values for the updateApiKey
method.
Custom Headers
Version of the API key to be updated. Specify the version that you retrieved when reading the API key. This value helps identifying parallel usage of this API. Pass * to indicate to update any version available. This might result in stale updates.
Authorization Token used for the request. The supported token type is a Cloud IAM Access Token. If the token is omitted the request will fail with BXNIM0308E: 'No authorization header found'. Make sure that the provided token has the required authority for the request.
Path Parameters
Unique ID of the API key to be updated.
Request to update an API key.
The name of the API key to update. If specified in the request the parameter must not be empty. The name is not checked for uniqueness. Failure to this will result in an Error condition.
The description of the API key to update. If specified an empty description will clear the description of the API key. If a non empty value is provided the API key will be updated.
WithContext method only
A context.Context instance that you can use to specify a timeout for the operation or to cancel an in-flight request.
The UpdateAPIKey options.
Unique ID of the API key to be updated.
Version of the API key to be updated. Specify the version that you retrieved when reading the API key. This value helps identifying parallel usage of this API. Pass * to indicate to update any version available. This might result in stale updates.
The name of the API key to update. If specified in the request the parameter must not be empty. The name is not checked for uniqueness. Failure to this will result in an Error condition.
The description of the API key to update. If specified an empty description will clear the description of the API key. If a non empty value is provided the API key will be updated.
The updateApiKey options.
Unique ID of the API key to be updated.
Version of the API key to be updated. Specify the version that you retrieved when reading the API key. This value helps identifying parallel usage of this API. Pass * to indicate to update any version available. This might result in stale updates.
The name of the API key to update. If specified in the request the parameter must not be empty. The name is not checked for uniqueness. Failure to this will result in an Error condition.
The description of the API key to update. If specified an empty description will clear the description of the API key. If a non empty value is provided the API key will be updated.
parameters
Unique ID of the API key to be updated.
Version of the API key to be updated. Specify the version that you retrieved when reading the API key. This value helps identifying parallel usage of this API. Pass * to indicate to update any version available. This might result in stale updates.
The name of the API key to update. If specified in the request the parameter must not be empty. The name is not checked for uniqueness. Failure to this will result in an Error condition.
The description of the API key to update. If specified an empty description will clear the description of the API key. If a non empty value is provided the API key will be updated.
parameters
Unique ID of the API key to be updated.
Version of the API key to be updated. Specify the version that you retrieved when reading the API key. This value helps identifying parallel usage of this API. Pass * to indicate to update any version available. This might result in stale updates.
The name of the API key to update. If specified in the request the parameter must not be empty. The name is not checked for uniqueness. Failure to this will result in an Error condition.
The description of the API key to update. If specified an empty description will clear the description of the API key. If a non empty value is provided the API key will be updated.
curl -X PUT 'https://iam.cloud.ibm.com/v1/apikeys/APIKEY_UNIQUE_ID' -H 'Authorization: Bearer TOKEN' -H 'If-Match: <value of etag header from GET request>' -H 'Content-Type: application/json' -d '{ "name": "My-apikey", "description": "my personal key" }'
updateAPIKeyOptions := iamIdentityService.NewUpdateAPIKeyOptions(apikeyID, apikeyEtag) updateAPIKeyOptions.SetDescription("This is an updated description") apiKey, response, err := iamIdentityService.UpdateAPIKey(updateAPIKeyOptions) if err != nil { panic(err) } b, _ := json.MarshalIndent(apiKey, "", " ") fmt.Println(string(b))
UpdateApiKeyOptions updateApiKeyOptions = new UpdateApiKeyOptions.Builder() .id(apikeyId) .ifMatch(apikeyEtag) .description("This is an updated description") .build(); Response<ApiKey> response = service.updateApiKey(updateApiKeyOptions).execute(); ApiKey apiKey = response.getResult(); System.out.println(apiKey);
const params = { id: apikeyId, ifMatch: apikeyEtag, description: 'This is an updated description', }; try { const res = await iamIdentityService.updateApiKey(params); console.log(JSON.stringify(res.result, null, 2)); } catch (err) { console.warn(err); }
api_key = iam_identity_service.update_api_key( id=apikey_id, if_match=apikey_etag, description='This is an updated description' ).get_result() print(json.dumps(api_key, indent=2))
Response
Response body format for API key V1 REST requests.
Unique identifier of this API Key.
Cloud Resource Name of the item. Example Cloud Resource Name: 'crn:v1:bluemix:public:iam-identity:us-south:a/myaccount::apikey:1234-9012-5678'
The API key cannot be changed if set to true.
IAM ID of the user or service which created the API key.
Name of the API key. The name is not checked for uniqueness. Therefore multiple names with the same value can exist. Access is done via the UUID of the API key.
The iam_id that this API key authenticates.
ID of the account that this API key authenticates for.
The API key value. This property only contains the API key value for the following cases: create an API key, update a service ID API key that stores the API key value as retrievable, or get a service ID API key that stores the API key value as retrievable. All other operations don't return the API key value, for example all user API key related operations, except for create, don't contain the API key value.
Context with key properties for problem determination.
Version of the API Key details object. You need to specify this value when updating the API key to avoid stale updates.
If set contains a date time string of the creation date in ISO format.
If set contains a date time string of the last modification date in ISO format.
The optional description of the API key. The 'description' property is only available if a description was provided during a create of an API key.
History of the API key.
Response body format for API key V1 REST requests.
Context with key properties for problem determination.
The transaction ID of the inbound REST request.
The operation of the inbound REST request.
The user agent of the inbound REST request.
The URL of that cluster.
The instance ID of the server instance processing the request.
The thread ID of the server instance processing the request.
The host of the server instance processing the request.
The start time of the request.
The finish time of the request.
The elapsed time in msec.
The cluster name.
Context
Unique identifier of this API Key.
Version of the API Key details object. You need to specify this value when updating the API key to avoid stale updates.
Cloud Resource Name of the item. Example Cloud Resource Name: 'crn:v1:bluemix:public:iam-identity:us-south:a/myaccount::apikey:1234-9012-5678'.
The API key cannot be changed if set to true.
If set contains a date time string of the creation date in ISO format.
IAM ID of the user or service which created the API key.
If set contains a date time string of the last modification date in ISO format.
Name of the API key. The name is not checked for uniqueness. Therefore multiple names with the same value can exist. Access is done via the UUID of the API key.
The optional description of the API key. The 'description' property is only available if a description was provided during a create of an API key.
The iam_id that this API key authenticates.
ID of the account that this API key authenticates for.
The API key value. This property only contains the API key value for the following cases: create an API key, update a service ID API key that stores the API key value as retrievable, or get a service ID API key that stores the API key value as retrievable. All other operations don't return the API key value, for example all user API key related operations, except for create, don't contain the API key value.
History of the API key.
Timestamp when the action was triggered.
IAM ID of the identity which triggered the action.
Account of the identity which triggered the action.
Action of the history entry.
Params of the history entry.
Message which summarizes the executed action.
History
Time when the entity was last authenticated.
Authentication count, number of times the entity was authenticated.
Activity
Response body format for API key V1 REST requests.
Context with key properties for problem determination.
The transaction ID of the inbound REST request.
The operation of the inbound REST request.
The user agent of the inbound REST request.
The URL of that cluster.
The instance ID of the server instance processing the request.
The thread ID of the server instance processing the request.
The host of the server instance processing the request.
The start time of the request.
The finish time of the request.
The elapsed time in msec.
The cluster name.
context
Unique identifier of this API Key.
Version of the API Key details object. You need to specify this value when updating the API key to avoid stale updates.
Cloud Resource Name of the item. Example Cloud Resource Name: 'crn:v1:bluemix:public:iam-identity:us-south:a/myaccount::apikey:1234-9012-5678'.
The API key cannot be changed if set to true.
If set contains a date time string of the creation date in ISO format.
IAM ID of the user or service which created the API key.
If set contains a date time string of the last modification date in ISO format.
Name of the API key. The name is not checked for uniqueness. Therefore multiple names with the same value can exist. Access is done via the UUID of the API key.
The optional description of the API key. The 'description' property is only available if a description was provided during a create of an API key.
The iam_id that this API key authenticates.
ID of the account that this API key authenticates for.
The API key value. This property only contains the API key value for the following cases: create an API key, update a service ID API key that stores the API key value as retrievable, or get a service ID API key that stores the API key value as retrievable. All other operations don't return the API key value, for example all user API key related operations, except for create, don't contain the API key value.
History of the API key.
Timestamp when the action was triggered.
IAM ID of the identity which triggered the action.
Account of the identity which triggered the action.
Action of the history entry.
Params of the history entry.
Message which summarizes the executed action.
history
Time when the entity was last authenticated.
Authentication count, number of times the entity was authenticated.
activity
Response body format for API key V1 REST requests.
Context with key properties for problem determination.
The transaction ID of the inbound REST request.
The operation of the inbound REST request.
The user agent of the inbound REST request.
The URL of that cluster.
The instance ID of the server instance processing the request.
The thread ID of the server instance processing the request.
The host of the server instance processing the request.
The start time of the request.
The finish time of the request.
The elapsed time in msec.
The cluster name.
context
Unique identifier of this API Key.
Version of the API Key details object. You need to specify this value when updating the API key to avoid stale updates.
Cloud Resource Name of the item. Example Cloud Resource Name: 'crn:v1:bluemix:public:iam-identity:us-south:a/myaccount::apikey:1234-9012-5678'.
The API key cannot be changed if set to true.
If set contains a date time string of the creation date in ISO format.
IAM ID of the user or service which created the API key.
If set contains a date time string of the last modification date in ISO format.
Name of the API key. The name is not checked for uniqueness. Therefore multiple names with the same value can exist. Access is done via the UUID of the API key.
The optional description of the API key. The 'description' property is only available if a description was provided during a create of an API key.
The iam_id that this API key authenticates.
ID of the account that this API key authenticates for.
The API key value. This property only contains the API key value for the following cases: create an API key, update a service ID API key that stores the API key value as retrievable, or get a service ID API key that stores the API key value as retrievable. All other operations don't return the API key value, for example all user API key related operations, except for create, don't contain the API key value.
History of the API key.
Timestamp when the action was triggered.
IAM ID of the identity which triggered the action.
Account of the identity which triggered the action.
Action of the history entry.
Params of the history entry.
Message which summarizes the executed action.
history
Time when the entity was last authenticated.
Authentication count, number of times the entity was authenticated.
activity
Response body format for API key V1 REST requests.
Context with key properties for problem determination.
The transaction ID of the inbound REST request.
The operation of the inbound REST request.
The user agent of the inbound REST request.
The URL of that cluster.
The instance ID of the server instance processing the request.
The thread ID of the server instance processing the request.
The host of the server instance processing the request.
The start time of the request.
The finish time of the request.
The elapsed time in msec.
The cluster name.
context
Unique identifier of this API Key.
Version of the API Key details object. You need to specify this value when updating the API key to avoid stale updates.
Cloud Resource Name of the item. Example Cloud Resource Name: 'crn:v1:bluemix:public:iam-identity:us-south:a/myaccount::apikey:1234-9012-5678'.
The API key cannot be changed if set to true.
If set contains a date time string of the creation date in ISO format.
IAM ID of the user or service which created the API key.
If set contains a date time string of the last modification date in ISO format.
Name of the API key. The name is not checked for uniqueness. Therefore multiple names with the same value can exist. Access is done via the UUID of the API key.
The optional description of the API key. The 'description' property is only available if a description was provided during a create of an API key.
The iam_id that this API key authenticates.
ID of the account that this API key authenticates for.
The API key value. This property only contains the API key value for the following cases: create an API key, update a service ID API key that stores the API key value as retrievable, or get a service ID API key that stores the API key value as retrievable. All other operations don't return the API key value, for example all user API key related operations, except for create, don't contain the API key value.
History of the API key.
Timestamp when the action was triggered.
IAM ID of the identity which triggered the action.
Account of the identity which triggered the action.
Action of the history entry.
Params of the history entry.
Message which summarizes the executed action.
history
Time when the entity was last authenticated.
Authentication count, number of times the entity was authenticated.
activity
Status Code
Successful - API key updated.
Parameter validation failed.
The incoming request did not contain a valid authentication information.
The incoming request is valid but the user is not allowed to perform the requested action.
API key with provided parameters not found.
Conflict - there must have been an update in parallel, the specified If-Match header does not match the current API key record. Retrieve the current API key again and apply the changes to that version.
Internal Server error.
{ "id": "ApiKey-5ccff000-9ff1-4481-a760-29c22a7603e7", "entity_tag": "2-cc66d399c705d12b439f1992a465fd5b", "crn": "crn:v1:bluemix:public:iam-identity::a/100abcde100a41abc100aza678abc0zz::apikey:ApiKey-5ccff000-9ff1-4481-a760-29c22a7603e7", "locked": false, "created_at": "2020-11-10T12:28+0000", "created_by": "IBMid-110000AB1Z", "modified_at": "2020-11-10T13:45+0000", "name": "Apikey-test1", "description": "Apikey-test1", "iam_id": "IBMid-110000AB1Z", "account_id": "100abcde100a41abc100aza678abc0zz" }
{ "id": "ApiKey-5ccff000-9ff1-4481-a760-29c22a7603e7", "entity_tag": "2-cc66d399c705d12b439f1992a465fd5b", "crn": "crn:v1:bluemix:public:iam-identity::a/100abcde100a41abc100aza678abc0zz::apikey:ApiKey-5ccff000-9ff1-4481-a760-29c22a7603e7", "locked": false, "created_at": "2020-11-10T12:28+0000", "created_by": "IBMid-110000AB1Z", "modified_at": "2020-11-10T13:45+0000", "name": "Apikey-test1", "description": "Apikey-test1", "iam_id": "IBMid-110000AB1Z", "account_id": "100abcde100a41abc100aza678abc0zz" }
Deletes an API key
Deletes an API key. Existing tokens will remain valid until expired. Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to.
Deletes an API key. Existing tokens will remain valid until expired. Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to.
Deletes an API key. Existing tokens will remain valid until expired. Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to.
Deletes an API key. Existing tokens will remain valid until expired. Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to.
Deletes an API key. Existing tokens will remain valid until expired. Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to.
DELETE /v1/apikeys/{id}
(iamIdentity *IamIdentityV1) DeleteAPIKey(deleteAPIKeyOptions *DeleteAPIKeyOptions) (response *core.DetailedResponse, err error)
(iamIdentity *IamIdentityV1) DeleteAPIKeyWithContext(ctx context.Context, deleteAPIKeyOptions *DeleteAPIKeyOptions) (response *core.DetailedResponse, err error)
ServiceCall<Void> deleteApiKey(DeleteApiKeyOptions deleteApiKeyOptions)
deleteApiKey(params)
delete_api_key(
self,
id: str,
**kwargs,
) -> DetailedResponse
Request
Instantiate the DeleteAPIKeyOptions
struct and set the fields to provide parameter values for the DeleteAPIKey
method.
Use the DeleteApiKeyOptions.Builder
to create a DeleteApiKeyOptions
object that contains the parameter values for the deleteApiKey
method.
Custom Headers
Authorization Token used for the request. The supported token type is a Cloud IAM Access Token. If the token is omitted the request will fail with BXNIM0308E: 'No authorization header found'. Make sure that the provided token has the required authority for the request.
Path Parameters
Unique ID of the API key.
WithContext method only
A context.Context instance that you can use to specify a timeout for the operation or to cancel an in-flight request.
The DeleteAPIKey options.
Unique ID of the API key.
The deleteApiKey options.
Unique ID of the API key.
parameters
Unique ID of the API key.
parameters
Unique ID of the API key.
curl -X DELETE 'https://iam.cloud.ibm.com/v1/apikeys/APIKEY_UNIQUE_ID' -H 'Authorization: Bearer TOKEN' -H 'Content-Type: application/json'
deleteAPIKeyOptions := iamIdentityService.NewDeleteAPIKeyOptions(apikeyID) response, err := iamIdentityService.DeleteAPIKey(deleteAPIKeyOptions) if err != nil { panic(err) }
DeleteApiKeyOptions deleteApiKeyOptions = new DeleteApiKeyOptions.Builder() .id(apikeyId) .build(); Response<Void> response = service.deleteApiKey(deleteApiKeyOptions).execute();
const params = { id: apikeyId, }; try { await iamIdentityService.deleteApiKey(params); } catch (err) { console.warn(err); }
response = iam_identity_service.delete_api_key(id=apikey_id)
Response
Status Code
Deleted Successful - no further details.
The incoming request did not contain a valid authentication information.
The incoming request is valid but the user is not allowed to perform the requested action.
API key with given ID not found.
Conflict - ApiKey could not be deleted.
Internal Server error.
No Sample Response
Lock the API key
Locks an API key by ID. Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to. In case of service IDs and their API keys, a user must be either an account owner, a IBM Cloud org manager or IBM Cloud space developer in order to manage service IDs of the entity.
Locks an API key by ID. Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to. In case of service IDs and their API keys, a user must be either an account owner, a IBM Cloud org manager or IBM Cloud space developer in order to manage service IDs of the entity.
Locks an API key by ID. Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to. In case of service IDs and their API keys, a user must be either an account owner, a IBM Cloud org manager or IBM Cloud space developer in order to manage service IDs of the entity.
Locks an API key by ID. Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to. In case of service IDs and their API keys, a user must be either an account owner, a IBM Cloud org manager or IBM Cloud space developer in order to manage service IDs of the entity.
Locks an API key by ID. Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to. In case of service IDs and their API keys, a user must be either an account owner, a IBM Cloud org manager or IBM Cloud space developer in order to manage service IDs of the entity.
POST /v1/apikeys/{id}/lock
(iamIdentity *IamIdentityV1) LockAPIKey(lockAPIKeyOptions *LockAPIKeyOptions) (response *core.DetailedResponse, err error)
(iamIdentity *IamIdentityV1) LockAPIKeyWithContext(ctx context.Context, lockAPIKeyOptions *LockAPIKeyOptions) (response *core.DetailedResponse, err error)
ServiceCall<Void> lockApiKey(LockApiKeyOptions lockApiKeyOptions)
lockApiKey(params)
lock_api_key(
self,
id: str,
**kwargs,
) -> DetailedResponse
Request
Instantiate the LockAPIKeyOptions
struct and set the fields to provide parameter values for the LockAPIKey
method.
Use the LockApiKeyOptions.Builder
to create a LockApiKeyOptions
object that contains the parameter values for the lockApiKey
method.
Custom Headers
Authorization Token used for the request. The supported token type is a Cloud IAM Access Token. If the token is omitted the request will fail with BXNIM0308E: 'No authorization header found'. Make sure that the provided token has the required authority for the request.
Path Parameters
Unique ID of the API key.
WithContext method only
A context.Context instance that you can use to specify a timeout for the operation or to cancel an in-flight request.
The LockAPIKey options.
Unique ID of the API key.
The lockApiKey options.
Unique ID of the API key.
parameters
Unique ID of the API key.
parameters
Unique ID of the API key.
curl -X POST 'https://iam.cloud.ibm.com/v1/apikeys/APIKEY_UNIQUE_ID/lock' -H 'Authorization: Bearer TOKEN' -H 'Content-Type: application/json'
lockAPIKeyOptions := iamIdentityService.NewLockAPIKeyOptions(apikeyID) response, err := iamIdentityService.LockAPIKey(lockAPIKeyOptions) if err != nil { panic(err) }
LockApiKeyOptions lockApiKeyOptions = new LockApiKeyOptions.Builder() .id(apikeyId) .build(); Response<Void> response = service.lockApiKey(lockApiKeyOptions).execute();
const params = { id: apikeyId, }; try { await iamIdentityService.lockApiKey(params); } catch (err) { console.warn(err); }
response = iam_identity_service.lock_api_key(id=apikey_id)
Response
Status Code
Successful locked.
Parameter validation failed.
The incoming request did not contain a valid authentication information.
The incoming request is valid but the user is not allowed to perform the requested action.
API key with provided ID not found.
Internal Server error.
No Sample Response
Unlock the API key
Unlocks an API key by ID. Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to. In case of service IDs and their API keys, a user must be either an account owner, a IBM Cloud org manager or IBM Cloud space developer in order to manage service IDs of the entity.
Unlocks an API key by ID. Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to. In case of service IDs and their API keys, a user must be either an account owner, a IBM Cloud org manager or IBM Cloud space developer in order to manage service IDs of the entity.
Unlocks an API key by ID. Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to. In case of service IDs and their API keys, a user must be either an account owner, a IBM Cloud org manager or IBM Cloud space developer in order to manage service IDs of the entity.
Unlocks an API key by ID. Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to. In case of service IDs and their API keys, a user must be either an account owner, a IBM Cloud org manager or IBM Cloud space developer in order to manage service IDs of the entity.
Unlocks an API key by ID. Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to. In case of service IDs and their API keys, a user must be either an account owner, a IBM Cloud org manager or IBM Cloud space developer in order to manage service IDs of the entity.
DELETE /v1/apikeys/{id}/lock
(iamIdentity *IamIdentityV1) UnlockAPIKey(unlockAPIKeyOptions *UnlockAPIKeyOptions) (response *core.DetailedResponse, err error)
(iamIdentity *IamIdentityV1) UnlockAPIKeyWithContext(ctx context.Context, unlockAPIKeyOptions *UnlockAPIKeyOptions) (response *core.DetailedResponse, err error)
ServiceCall<Void> unlockApiKey(UnlockApiKeyOptions unlockApiKeyOptions)
unlockApiKey(params)
unlock_api_key(
self,
id: str,
**kwargs,
) -> DetailedResponse
Request
Instantiate the UnlockAPIKeyOptions
struct and set the fields to provide parameter values for the UnlockAPIKey
method.
Use the UnlockApiKeyOptions.Builder
to create a UnlockApiKeyOptions
object that contains the parameter values for the unlockApiKey
method.
Custom Headers
Authorization Token used for the request. The supported token type is a Cloud IAM Access Token. If the token is omitted the request will fail with BXNIM0308E: 'No authorization header found'. Make sure that the provided token has the required authority for the request.
Path Parameters
Unique ID of the API key.
WithContext method only
A context.Context instance that you can use to specify a timeout for the operation or to cancel an in-flight request.
The UnlockAPIKey options.
Unique ID of the API key.
The unlockApiKey options.
Unique ID of the API key.
parameters
Unique ID of the API key.
parameters
Unique ID of the API key.
curl -X DELETE 'https://iam.cloud.ibm.com/v1/apikeys/APIKEY_UNIQUE_ID/lock' -H 'Authorization: Bearer TOKEN' -H 'Content-Type: application/json'
unlockAPIKeyOptions := iamIdentityService.NewUnlockAPIKeyOptions(apikeyID) response, err := iamIdentityService.UnlockAPIKey(unlockAPIKeyOptions) if err != nil { panic(err) }
UnlockApiKeyOptions unlockApiKeyOptions = new UnlockApiKeyOptions.Builder() .id(apikeyId) .build(); Response<Void> response = service.unlockApiKey(unlockApiKeyOptions).execute();
const params = { id: apikeyId, }; try { await iamIdentityService.unlockApiKey(params); } catch (err) { console.warn(err); }
response = iam_identity_service.unlock_api_key(id=apikey_id)
Response
Status Code
Successful unlocked.
Parameter validation failed.
The incoming request did not contain a valid authentication information.
The incoming request is valid but the user is not allowed to perform the requested action.
API key with provided ID not found.
Internal Server error.
No Sample Response
List service IDs
Returns a list of service IDs. Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to. Note: apikey details are only included in the response when creating a Service ID with an apikey.
Returns a list of service IDs. Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to. Note: apikey details are only included in the response when creating a Service ID with an apikey.
Returns a list of service IDs. Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to. Note: apikey details are only included in the response when creating a Service ID with an apikey.
Returns a list of service IDs. Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to. Note: apikey details are only included in the response when creating a Service ID with an apikey.
Returns a list of service IDs. Users can manage user API keys for themself, or service ID API keys for service IDs that are bound to an entity they have access to. Note: apikey details are only included in the response when creating a Service ID with an apikey.
GET /v1/serviceids/
(iamIdentity *IamIdentityV1) ListServiceIds(listServiceIdsOptions *ListServiceIdsOptions) (result *ServiceIDList, response *core.DetailedResponse, err error)
(iamIdentity *IamIdentityV1) ListServiceIdsWithContext(ctx context.Context, listServiceIdsOptions *ListServiceIdsOptions) (result *ServiceIDList, response *core.DetailedResponse, err error)
ServiceCall<ServiceIdList> listServiceIds(ListServiceIdsOptions listServiceIdsOptions)
listServiceIds(params)
list_service_ids(
self,
*,
account_id: str = None,
name: str = None,
pagesize: int = None,
pagetoken: str = None,
sort: str = None,
order: str = None,
include_history: bool = None,
**kwargs,
) -> DetailedResponse
Request
Instantiate the ListServiceIdsOptions
struct and set the fields to provide parameter values for the ListServiceIds
method.
Use the ListServiceIdsOptions.Builder
to create a ListServiceIdsOptions
object that contains the parameter values for the listServiceIds
method.
Custom Headers
Authorization Token used for the request. The supported token type is a Cloud IAM Access Token. If the token is omitted the request will fail with BXNIM0308E: 'No authorization header found'. Make sure that the provided token has the required authority for the request.
Query Parameters
Account ID of the service ID(s) to query. This parameter is required (unless using a pagetoken).
Name of the service ID(s) to query. Optional.20 items per page. Valid range is 1 to 100.
Optional size of a single page. Default is 20 items per page. Valid range is 1 to 100.
Optional Prev or Next page token returned from a previous query execution. Default is start with first page.
Optional sort property, valid values are name, description, created_at and modified_at. If specified, the items are sorted by the value of this property.
Optional sort order, valid values are asc and desc. Default: asc.
Allowable values: [
asc
,desc
]Default:
asc
Defines if the entity history is included in the response.
Default:
false
WithContext method only
A context.Context instance that you can use to specify a timeout for the operation or to cancel an in-flight request.
The ListServiceIds options.
Account ID of the service ID(s) to query. This parameter is required (unless using a pagetoken).
Name of the service ID(s) to query. Optional.20 items per page. Valid range is 1 to 100.
Optional size of a single page. Default is 20 items per page. Valid range is 1 to 100.
Optional Prev or Next page token returned from a previous query execution. Default is start with first page.
Optional sort property, valid values are name, description, created_at and modified_at. If specified, the items are sorted by the value of this property.
Optional sort order, valid values are asc and desc. Default: asc.
Allowable values: [
asc
,desc
]Default:
asc
Defines if the entity history is included in the response.
Default:
false
The listServiceIds options.
Account ID of the service ID(s) to query. This parameter is required (unless using a pagetoken).
Name of the service ID(s) to query. Optional.20 items per page. Valid range is 1 to 100.
Optional size of a single page. Default is 20 items per page. Valid range is 1 to 100.
Optional Prev or Next page token returned from a previous query execution. Default is start with first page.
Optional sort property, valid values are name, description, created_at and modified_at. If specified, the items are sorted by the value of this property.
Optional sort order, valid values are asc and desc. Default: asc.
Allowable values: [
asc
,desc
]Default:
asc
Defines if the entity history is included in the response.
Default:
false
parameters
Account ID of the service ID(s) to query. This parameter is required (unless using a pagetoken).
Name of the service ID(s) to query. Optional.20 items per page. Valid range is 1 to 100.
Optional size of a single page. Default is 20 items per page. Valid range is 1 to 100.
Optional Prev or Next page token returned from a previous query execution. Default is start with first page.
Optional sort property, valid values are name, description, created_at and modified_at. If specified, the items are sorted by the value of this property.
Optional sort order, valid values are asc and desc. Default: asc.
Allowable values: [
asc
,desc
]Default:
asc
Defines if the entity history is included in the response.
Default:
false
parameters
Account ID of the service ID(s) to query. This parameter is required (unless using a pagetoken).
Name of the service ID(s) to query. Optional.20 items per page. Valid range is 1 to 100.
Optional size of a single page. Default is 20 items per page. Valid range is 1 to 100.
Optional Prev or Next page token returned from a previous query execution. Default is start with first page.
Optional sort property, valid values are name, description, created_at and modified_at. If specified, the items are sorted by the value of this property.
Optional sort order, valid values are asc and desc. Default: asc.
Allowable values: [
asc
,desc
]Default:
asc
Defines if the entity history is included in the response.
Default:
false
curl -X GET 'https://iam.cloud.ibm.com/v1/serviceids?account_id=ACCOUNT_ID&name=My-serviceID' -H 'Authorization: Bearer TOKEN' -H 'Content-Type: application/json'
listServiceIdsOptions := iamIdentityService.NewListServiceIdsOptions() listServiceIdsOptions.SetAccountID(accountID) listServiceIdsOptions.SetName(serviceIDName) serviceIDList, response, err := iamIdentityService.ListServiceIds(listServiceIdsOptions) if err != nil { panic(err) } b, _ := json.MarshalIndent(serviceIDList, "", " ") fmt.Println(string(b))
ListServiceIdsOptions listServiceIdsOptions = new ListServiceIdsOptions.Builder() .accountId(accountId) .name(serviceIdName) .build(); Response<ServiceIdList> response = service.listServiceIds(listServiceIdsOptions).execute(); ServiceIdList serviceIdList = response.getResult(); System.out.println(serviceIdList);
const params = { accountId: accountId, name: serviceIdName, }; try { const res = await iamIdentityService.listServiceIds(params) console.log(JSON.stringify(res.result, null, 2)); } catch (err) { console.warn(err); }
service_id_list = iam_identity_service.list_service_ids( account_id=account_id, name=serviceid_name ).get_result() print(json.dumps(service_id_list, indent=2))
Response
Response body format for the list service ID V1 REST request.
List of service IDs based on the query paramters and the page size. The service IDs array is always part of the response but might be empty depending on the query parameter values provided.
Context with key properties for problem determination.
The offset of the current page.
Optional size of a single page. Default is 20 items per page. Valid range is 1 to 100.
Link to the first page.
Link to the previous available page. If 'previous' property is not part of the response no previous page is available.
Link to the next available page. If 'next' property is not part of the response no next page is available.
Response body format for the list service ID V1 REST request.
Context with key properties for problem determination.
The transaction ID of the inbound REST request.
The operation of the inbound REST request.
The user agent of the inbound REST request.
The URL of that cluster.
The instance ID of the server instance processing the request.
The thread ID of the server instance processing the request.
The host of the server instance processing the request.
The start time of the request.
The finish time of the request.
The elapsed time in msec.
The cluster name.
Context
The offset of the current page.
Optional size of a single page. Default is 20 items per page. Valid range is 1 to 100.
Link to the first page.
Link to the previous available page. If 'previous' property is not part of the response no previous page is available.
Link to the next available page. If 'next' property is not part of the response no next page is available.
List of service IDs based on the query paramters and the page size. The service IDs array is always part of the response but might be empty depending on the query parameter values provided.
Context with key properties for problem determination.
The transaction ID of the inbound REST request.
The operation of the inbound REST request.
The user agent of the inbound REST request.
The URL of that cluster.
The instance ID of the server instance processing the request.
The thread ID of the server instance processing the request.
The host of the server instance processing the request.
The start time of the request.
The finish time of the request.
The elapsed time in msec.
The cluster name.
Context
Unique identifier of this Service Id.
Cloud wide identifier for identities of this service ID.
Version of the service ID details object. You need to specify this value when updating the service ID to avoid stale updates.
Cloud Resource Name of the item. Example Cloud Resource Name: 'crn:v1:bluemix:public:iam-identity:us-south:a/myaccount::serviceid:1234-5678-9012'.
The service ID cannot be changed if set to true.
If set contains a date time string of the creation date in ISO format.
If set contains a date time string of the last modification date in ISO format.
ID of the account the service ID belongs to.
Name of the Service Id. The name is not checked for uniqueness. Therefore multiple names with the same value can exist. Access is done via the UUID of the Service Id.
The optional description of the Service Id. The 'description' property is only available if a description was provided during a create of a Service Id.
Optional list of CRNs (string array) which point to the services connected to the service ID.
History of the Service ID.
Timestamp when the action was triggered.
IAM ID of the identity which triggered the action.
Account of the identity which triggered the action.
Action of the history entry.
Params of the history entry.
Message which summarizes the executed action.
History
Response body format for API key V1 REST requests.
Context with key properties for problem determination.
The transaction ID of the inbound REST request.
The operation of the inbound REST request.
The user agent of the inbound REST request.
The URL of that cluster.
The instance ID of the server instance processing the request.
The thread ID of the server instance processing the request.
The host of the server instance processing the request.
The start time of the request.
The finish time of the request.
The elapsed time in msec.
The cluster name.
Context
Unique identifier of this API Key.
Version of the API Key details object. You need to specify this value when updating the API key to avoid stale updates.
Cloud Resource Name of the item. Example Cloud Resource Name: 'crn:v1:bluemix:public:iam-identity:us-south:a/myaccount::apikey:1234-9012-5678'.
The API key cannot be changed if set to true.
If set contains a date time string of the creation date in ISO format.
IAM ID of the user or service which created the API key.
If set contains a date time string of the last modification date in ISO format.
Name of the API key. The name is not checked for uniqueness. Therefore multiple names with the same value can exist. Access is done via the UUID of the API key.
The optional description of the API key. The 'description' property is only available if a description was provided during a create of an API key.
The iam_id that this API key authenticates.
ID of the account that this API key authenticates for.
The API key value. This property only contains the API key value for the following cases: create an API key, update a service ID API key that stores the API key value as retrievable, or get a service ID API key that stores the API key value as retrievable. All other operations don't return the API key value, for example all user API key related operations, except for create, don't contain the API key value.
History of the API key.
Timestamp when the action was triggered.
IAM ID of the identity which triggered the action.
Account of the identity which triggered the action.
Action of the history entry.
Params of the history entry.
Message which summarizes the executed action.
History
Time when the entity was last authenticated.
Authentication count, number of times the entity was authenticated.
Activity
Apikey
Time when the entity was last authenticated.
Authentication count, number of times the entity was authenticated.
Activity
Serviceids
Response body format for the list service ID V1 REST request.
Context with key properties for problem determination.
The transaction ID of the inbound REST request.
The operation of the inbound REST request.
The user agent of the inbound REST request.
The URL of that cluster.
The instance ID of the server instance processing the request.
The thread ID of the server instance processing the request.
The host of the server instance processing the request.
The start time of the request.
The finish time of the request.
The elapsed time in msec.
The cluster name.
context
The offset of the current page.
Optional size of a single page. Default is 20 items per page. Valid range is 1 to 100.
Link to the first page.
Link to the previous available page. If 'previous' property is not part of the response no previous page is available.
Link to the next available page. If 'next' property is not part of the response no next page is available.
List of service IDs based on the query paramters and the page size. The service IDs array is always part of the response but might be empty depending on the query parameter values provided.
Context with key properties for problem determination.
The transaction ID of the inbound REST request.
The operation of the inbound REST request.
The user agent of the inbound REST request.
The URL of that cluster.
The instance ID of the server instance processing the request.
The thread ID of the server instance processing the request.
The host of the server instance processing the request.
The start time of the request.
The finish time of the request.
The elapsed time in msec.
The cluster name.
context
Unique identifier of this Service Id.
Cloud wide identifier for identities of this service ID.
Version of the service ID details object. You need to specify this value when updating the service ID to avoid stale updates.
Cloud Resource Name of the item. Example Cloud Resource Name: 'crn:v1:bluemix:public:iam-identity:us-south:a/myaccount::serviceid:1234-5678-9012'.
The service ID cannot be changed if set to true.
If set contains a date time string of the creation date in ISO format.
If set contains a date time string of the last modification date in ISO format.
ID of the account the service ID belongs to.
Name of the Service Id. The name is not checked for uniqueness. Therefore multiple names with the same value can exist. Access is done via the UUID of the Service Id.
The optional description of the Service Id. The 'description' property is only available if a description was provided during a create of a Service Id.
Optional list of CRNs (string array) which point to the services connected to the service ID.
History of the Service ID.
Timestamp when the action was triggered.
IAM ID of the identity which triggered the action.
Account of the identity which triggered the action.
Action of the history entry.
Params of the history entry.
Message which summarizes the executed action.
history
Response body format for API key V1 REST requests.
Context with key properties for problem determination.
The transaction ID of the inbound REST request.
The operation of the inbound REST request.
The user agent of the inbound REST request.
The URL of that cluster.
The instance ID of the server instance processing the request.
The thread ID of the server instance processing the request.
The host of the server instance processing the request.
The start time of the request.
The finish time of the request.
The elapsed time in msec.
The cluster name.
context
Unique identifier of this API Key.
Version of the API Key details object. You need to specify this value when updating the API key to avoid stale updates.
Cloud Resource Name of the item. Example Cloud Resource Name: 'crn:v1:bluemix:public:iam-identity:us-south:a/myaccount::apikey:1234-9012-5678'.
The API key cannot be changed if set to true.
If set contains a date time string of the creation date in ISO format.
IAM ID of the user or service which created the API key.
If set contains a date time string of the last modification date in ISO format.
Name of the API key. The name is not checked for uniqueness. Therefore multiple names with the same value can exist. Access is done via the UUID of the API key.
The optional description of the API key. The 'description' property is only available if a description was provided during a create of an API key.
The iam_id that this API key authenticates.
ID of the account that this API key authenticates for.
The API key value. This property only contains the API key value for the following cases: create an API key, update a service ID API key that stores the API key value as retrievable, or get a service ID API key that stores the API key value as retrievable. All other operations don't return the API key value, for example all user API key related operations, except for create, don't contain the API key value.
History of the API key.
Timestamp when the action was triggered.
IAM ID of the identity which triggered the action.
Account of the identity which triggered the action.
Action of the history entry.
Params of the history entry.
Message which summarizes the executed action.
history
Time when the entity was last authenticated.
Authentication count, number of times the entity was authenticated.
activity
apikey
Time when the entity was last authenticated.
Authentication count, number of times the entity was authenticated.
activity
serviceids
Response body format for the list service ID V1 REST request.
Context with key properties for problem determination.
The transaction ID of the inbound REST request.
The operation of the inbound REST request.
The user agent of the inbound REST request.
The URL of that cluster.
The instance ID of the server instance processing the request.
The thread ID of the server instance processing the request.
The host of the server instance processing the request.
The start time of the request.
The finish time of the request.
The elapsed time in msec.
The cluster name.
context
The offset of the current page.
Optional size of a single page. Default is 20 items per page. Valid range is 1 to 100.
Link to the first page.
Link to the previous available page. If 'previous' property is not part of the response no previous page is available.
Link to the next available page. If 'next' property is not part of the response no next page is available.
List of service IDs based on the query paramters and the page size. The service IDs array is always part of the response but might be empty depending on the query parameter values provided.
Context with key properties for problem determination.
The transaction ID of the inbound REST request.
The operation of the inbound REST request.
The user agent of the inbound REST request.
The URL of that cluster.
The instance ID of the server instance processing the request.
The thread ID of the server instance processing the request.
The host of the server instance processing the request.
The start time of the request.
The finish time of the request.
The elapsed time in msec.
The cluster name.
context
Unique identifier of this Service Id.
Cloud wide identifier for identities of this service ID.
Version of the service ID details object. You need to specify this value when updating the service ID to avoid stale updates.
Cloud Resource Name of the item. Example Cloud Resource Name: 'crn:v1:bluemix:public:iam-identity:us-south:a/myaccount::serviceid:1234-5678-9012'.
The service ID cannot be changed if set to true.
If set contains a date time string of the creation date in ISO format.
If set contains a date time string of the last modification date in ISO format.
ID of the account the service ID belongs to.
Name of the Service Id. The name is not checked for uniqueness. Therefore multiple names with the same value can exist. Access is done via the UUID of the Service Id.
The optional description of the Service Id. The 'description' property is only available if a description was provided during a create of a Service Id.
Optional list of CRNs (string array) which point to the services connected to the service ID.
History of the Service ID.
Timestamp when the action was triggered.
IAM ID of the identity which triggered the action.
Account of the identity which triggered the action.
Action of the history entry.
Params of the history entry.
Message which summarizes the executed action.
history
Response body format for API key V1 REST requests.
Context with key properties for problem determination.
The transaction ID of the inbound REST request.
The operation of the inbound REST request.
The user agent of the inbound REST request.
The URL of that cluster.
The instance ID of the server instance processing the request.
The thread ID of the server instance processing the request.
The host of the server instance processing the request.
The start time of the request.
The finish time of the request.
The elapsed time in msec.
The cluster name.
context
Unique identifier of this API Key.
Version of the API Key details object. You need to specify this value when updating the API key to avoid stale updates.
Cloud Resource Name of the item. Example Cloud Resource Name: 'crn:v1:bluemix:public:iam-identity:us-south:a/myaccount::apikey:1234-9012-5678'.
The API key cannot be changed if set to true.
If set contains a date time string of the creation date in ISO format.
IAM ID of the user or service which created the API key.
If set contains a date time string of the last modification date in ISO format.
Name of the API key. The name is not checked for uniqueness. Therefore multiple names with the same value can exist. Access is done via the UUID of the API key.
The optional description of the API key. The 'description' property is only available if a description was provided during a create of an API key.
The iam_id that this API key authenticates.
ID of the account that this API key authenticates for.
The API key value. This property only contains the API key value for the following cases: create an API key, update a service ID API key that stores the API key value as retrievable, or get a service ID API key that stores the API key value as retrievable. All other operations don't return the API key value, for example all user API key related operations, except for create, don't contain the API key value.
History of the API key.
Timestamp when the action was triggered.
IAM ID of the identity which triggered the action.
Account of the identity which triggered the action.
Action of the history entry.
Params of the history entry.
Message which summarizes the executed action.
history
Time when the entity was last authenticated.
Authentication count, number of times the entity was authenticated.
activity
apikey
Time when the entity was last authenticated.
Authentication count, number of times the entity was authenticated.
activity
serviceids
Response body format for the list service ID V1 REST request.
Context with key properties for problem determination.
The transaction ID of the inbound REST request.
The operation of the inbound REST request.
The user agent of the inbound REST request.
The URL of that cluster.
The instance ID of the server instance processing the request.
The thread ID of the server instance processing the request.
The host of the server instance processing the request.
The start time of the request.
The finish time of the request.
The elapsed time in msec.
The cluster name.
context
The offset of the current page.
Optional size of a single page. Default is 20 items per page. Valid range is 1 to 100.
Link to the first page.
Link to the previous available page. If 'previous' property is not part of the response no previous page is available.
Link to the next available page. If 'next' property is not part of the response no next page is available.
List of service IDs based on the query paramters and the page size. The service IDs array is always part of the response but might be empty depending on the query parameter values provided.
Context with key properties for problem determination.
The transaction ID of the inbound REST request.
The operation of the inbound REST request.
The user agent of the inbound REST request.
The URL of that cluster.
The instance ID of the server instance processing the request.
The thread ID of the server instance processing the request.
The host of the server instance processing the request.
The start time of the request.
The finish time of the request.
The elapsed time in msec.
The cluster name.
context
Unique identifier of this Service Id.
Cloud wide identifier for identities of this service ID.
Version of the service ID details object. You need to specify this value when updating the service ID to avoid stale updates.
Cloud Resource Name of the item. Example Cloud Resource Name: 'crn:v1:bluemix:public:iam-identity:us-south:a/myaccount::serviceid:1234-5678-9012'.
The service ID cannot be changed if set to true.
If set contains a date time string of the creation date in ISO format.
If set contains a date time string of the last modification date in ISO format.
ID of the account the service ID belongs to.
Name of the Service Id. The name is not checked for uniqueness. Therefore multiple names with the same value can exist. Access is done via the UUID of the Service Id.
The optional description of the Service Id. The 'description' property is only available if a description was provided during a create of a Service Id.
Optional list of CRNs (string array) which point to the services connected to the service ID.
History of the Service ID.
Timestamp when the action was triggered.
IAM ID of the identity which triggered the action.
Account of the identity which triggered the action.
Action of the history entry.
Params of the history entry.
Message which summarizes the executed action.
history
Response body format for API key V1 REST requests.
Context with key properties for problem determination.
The transaction ID of the inbound REST request.
The operation of the inbound REST request.
The user agent of the inbound REST request.
The URL of that cluster.
The instance ID of the server instance processing the request.
The thread ID of the server instance processing the request.
The host of the server instance processing the request.
The start time of the request.
The finish time of the request.
The elapsed time in msec.
The cluster name.
context
Unique identifier of this API Key.
Version of the API Key details object. You need to specify this value when updating the API key to avoid stale updates.
Cloud Resource Name of the item. Example Cloud Resource Name: 'crn:v1:bluemix:public:iam-identity:us-south:a/myaccount::apikey:1234-9012-5678'.
The API key cannot be changed if set to true.
If set contains a date time string of the creation date in ISO format.
IAM ID of the user or service which created the API key.
If set contains a date time string of the last modification date in ISO format.
Name of the API key. The name is not checked for uniqueness. Therefore multiple names with the same value can exist. Access is done via the UUID of the API key.
The optional description of the API key. The 'description' property is only available if a description was provided during a create of an API key.
The iam_id that this API key authenticates.
ID of the account that this API key authenticates for.
The API key value. This property only contains the API key value for the following cases: create an API key, update a service ID API key that stores the API key value as retrievable, or get a service ID API key that stores the API key value as retrievable. All other operations don't return the API key value, for example all user API key related operations, except for create, don't contain the API key value.
History of the API key.
Timestamp when the action was triggered.
IAM ID of the identity which triggered the action.
Account of the identity which triggered the action.
Action of the history entry.
Params of the history entry.
Message which summarizes the executed action.
history
Time when the entity was last authenticated.
Authentication count, number of times the entity was authenticated.
activity
apikey
Time when the entity was last authenticated.
Authentication count, number of times the entity was authenticated.
activity
serviceids
Status Code
Successful response. No further actions.
Parameter validation failed. Response if required parameters are missing or if parameter values are invalid.
The incoming request did not contain a valid authentication information.
The incoming request is valid but the user is not allowed to perform the requested action.
Internal Server error. Response if unexpected error situation happened.
{ "offset": 0, "limit": 1, "first": { "href":