All Products
Search

This Product

    Identity as a Service:GetCredential

    Document Center

    Identity as a Service:GetCredential

    Last Updated:Jul 06, 2026

    Queries the information about a credential resource.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    eiam:GetCredential

    get

    *Credential

    acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/credential/{#CredentialId}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    InstanceId

    string

    Yes

    The instance ID.

    idaas_ue2jvisn35ea5lmthk267xxxxx
    CredentialId

    string

    Yes

    The credential ID.

    cred_mkv7rgt4d7i4u7zqtzev2mxxxx

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    0441BD79-92F3-53AA-8657-F8CE4A2B912A
    Credential

    object

    The credential information.

    InstanceId

    string

    The instance ID.

    idaas_ue2jvisn35ea5lmthk267xxxxx
    CredentialId

    string

    The credential ID.

    cred_mkv7rgt4d7i4u7zqtzev2mxxxx
    Status

    string

    The credential status. Valid values:

    • enabled: Enabled.

    • disabled: Disabled.

    enabled
    CredentialIdentifier

    string

    The credential identifier.

    credential_identifier_test
    CredentialName

    string

    The credential name.

    credential_name
    CredentialSubjectType

    string

    The type of the subject to which the credential belongs. Valid values:

    • authentication_token_provider: Authentication token provider.

    authentication_token_provider
    CredentialSubjectId

    string

    The ID of the subject to which the credential belongs.

    apt_werthgfdsasffxxxxx
    CredentialScenarioLabel

    string

    The scenarios label of the credential. Valid values:

    • llm: Large language model.

    • saas: Third-party SaaS service.

    llm
    CredentialType

    string

    The credential type. Valid values:

    • api_key: API key credential.

    • oauth_client: OAuth client credential.

    api_key
    CredentialCreationType

    string

    The creation type of the credential. Valid values:

    • system_init: Created by the system.

    • user_custom: Created by the user.

    user_custom
    Description

    string

    The credential description.

    credential_description
    CreateTime

    integer

    The creation time, in UNIX timestamp format. Unit: milliseconds.

    1649830225000
    UpdateTime

    integer

    The update time, in UNIX timestamp format. Unit: milliseconds.

    1649830227000
    CredentialContent

    object

    The content of the credential.

    OAuthClientContent

    object

    The credential content for an OAuth client. This parameter is returned only when CredentialType is oauth_client.

    ClientId

    string

    The OAuth client ID.

    dmvncmxersdxxxxxx
    CredentialSharingScope

    string

    ExclusiveUserId

    string

    CredentialExternalId

    string

    Examples

    Success response

    JSON format

    {
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "Credential": {
    "InstanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
    "CredentialId": "cred_mkv7rgt4d7i4u7zqtzev2mxxxx",
    "Status": "enabled",
    "CredentialIdentifier": "credential_identifier_test",
    "CredentialName": "credential_name",
    "CredentialSubjectType": "authentication_token_provider",
    "CredentialSubjectId": "apt_werthgfdsasffxxxxx",
    "CredentialScenarioLabel": "llm",
    "CredentialType": "api_key",
    "CredentialCreationType": "user_custom",
    "Description": "credential_description",
    "CreateTime": 1649830225000,
    "UpdateTime": 1649830227000,
    "CredentialContent": {
      "OAuthClientContent": {
        "ClientId": "dmvncmxersdxxxxxx"
      }
    },
    "CredentialSharingScope": "",
    "ExclusiveUserId": "",
    "CredentialExternalId": ""
  }
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.