Get Credential Details by name

Select

SaaS

Customer Managed

Get details of the credential whose credential name is provided

Path Parameters

• credentialName string required

Responses

• 200
• 404

---

OK

application/json

• Schema
• Example (from schema)

---

Schema

oneOf

• CredentialInfo
• CloudCredentialInfo
• CloudCredentialInfoWithTokenId
• CloudCredentialInfoWithAPIKey
• SalesforceCredentialInfo
• AmazonCredentialInfo
• AmazonCredentialInfoWithRoleArn
• AzureCredentialInfo
• AzureCredentialInfoWithTenantId

---

accountType CredentialAccountType

Possible values: [WINDOWSACCOUNT, LINUXACCOUNT, STORAGE_ARRAY_ACCOUNT, CLOUD_ACCOUNT]

vendorType CloudVendorType

Possible values: [ALICLOUD_OSS, AMAZON_GLACIER, AMAZON, ATT_SYNAPTIC, REVERA_VAULT, CEPH_OBJECT_GATEWAY_S3, CMCC_ONEST, CLOUDIAN_HYPERSTORE, DELL_EMC_ECS_S3, EMC_ATMOS, FUJITSU_STORAGE_ETERNUS, GOOGLE_CLOUD, HDS_HCP, HITACHI_VANTARA_HCP_S3, HUAWEI_OSS, IBM_CLOUD, IBM_CLOUD_S3, INSPUR_CLOUD, IRON_MOUNTAIN_CLOUD, KINGSOFT_KS3, MICROSOFT_AZURE_TYPE, NETAPP_STORAGEGRID, NUTANIX_BUCKETS, OPENSTACK, AMPLIDATA, RACKSPACE_CLOUD_FILES, S3_COMPATIBLE, SALESFORCE_CONNECTED_APP, SCALITY_RING, TELEFONICA_OPEN_CLOUD_OBJECT_STORAGE, VERIZON_CLOUD, WASABI_HOT_CLOUD_STORAGE]

Cloud vendor types appilcable only for Cloud Account type

name string

Name of Credential

userAccount string

User account of Credential

password string

Password of Credential. Password must be in base64 encoded format.

description string

Description of Credential

security object

Security association of a list of users and user groups

owner object

Owner of a credential can be a user or user group

user object

id int32

name string

userGroup object

id int32

name string

associations object[]

user object

id int32

name string

userGroup object

id int32

name string

permissions object

List of permissions associated with the entity. Either categoryId and categoryName or permissionId and permissionName will be returned. If categoryId or categoryName is returned, all the corresponding permissions in the category are associated with the entity.

permissionId int32

permissionName string

categoryId int32

categoryName string

type string

Possible values: [ALL_CATEGORIES, CATEGORY_ENTITY, PERMISSION_ENTITY]

Returns the type of association.

exclude boolean

Flag to specify if this is included permission or excluded permission.

isCreatorAssociation boolean

To check if the user/user group associated is the owner.

accountType CredentialAccountType

Possible values: [WINDOWSACCOUNT, LINUXACCOUNT, STORAGE_ARRAY_ACCOUNT, CLOUD_ACCOUNT]

vendorType CloudVendorType

Possible values: [ALICLOUD_OSS, AMAZON_GLACIER, AMAZON, ATT_SYNAPTIC, REVERA_VAULT, CEPH_OBJECT_GATEWAY_S3, CMCC_ONEST, CLOUDIAN_HYPERSTORE, DELL_EMC_ECS_S3, EMC_ATMOS, FUJITSU_STORAGE_ETERNUS, GOOGLE_CLOUD, HDS_HCP, HITACHI_VANTARA_HCP_S3, HUAWEI_OSS, IBM_CLOUD, IBM_CLOUD_S3, INSPUR_CLOUD, IRON_MOUNTAIN_CLOUD, KINGSOFT_KS3, MICROSOFT_AZURE_TYPE, NETAPP_STORAGEGRID, NUTANIX_BUCKETS, OPENSTACK, AMPLIDATA, RACKSPACE_CLOUD_FILES, S3_COMPATIBLE, SALESFORCE_CONNECTED_APP, SCALITY_RING, TELEFONICA_OPEN_CLOUD_OBJECT_STORAGE, VERIZON_CLOUD, WASABI_HOT_CLOUD_STORAGE]

Cloud vendor types appilcable only for Cloud Account type

name string

Name of Credential

accessKeyId string

Access Key ID of Credential

secretAccessKey string

Secret Access Key of Credential and must be in base64 encoded format.

description string

Description of Credential

security object

Security association of a list of users and user groups

owner object

Owner of a credential can be a user or user group

user object

id int32

name string

userGroup object

id int32

name string

associations object[]

user object

id int32

name string

userGroup object

id int32

name string

permissions object

List of permissions associated with the entity. Either categoryId and categoryName or permissionId and permissionName will be returned. If categoryId or categoryName is returned, all the corresponding permissions in the category are associated with the entity.

permissionId int32

permissionName string

categoryId int32

categoryName string

type string

Possible values: [ALL_CATEGORIES, CATEGORY_ENTITY, PERMISSION_ENTITY]

Returns the type of association.

exclude boolean

Flag to specify if this is included permission or excluded permission.

isCreatorAssociation boolean

To check if the user/user group associated is the owner.

accountType CredentialAccountType

Possible values: [WINDOWSACCOUNT, LINUXACCOUNT, STORAGE_ARRAY_ACCOUNT, CLOUD_ACCOUNT]

vendorType CloudVendorType

Possible values: [ALICLOUD_OSS, AMAZON_GLACIER, AMAZON, ATT_SYNAPTIC, REVERA_VAULT, CEPH_OBJECT_GATEWAY_S3, CMCC_ONEST, CLOUDIAN_HYPERSTORE, DELL_EMC_ECS_S3, EMC_ATMOS, FUJITSU_STORAGE_ETERNUS, GOOGLE_CLOUD, HDS_HCP, HITACHI_VANTARA_HCP_S3, HUAWEI_OSS, IBM_CLOUD, IBM_CLOUD_S3, INSPUR_CLOUD, IRON_MOUNTAIN_CLOUD, KINGSOFT_KS3, MICROSOFT_AZURE_TYPE, NETAPP_STORAGEGRID, NUTANIX_BUCKETS, OPENSTACK, AMPLIDATA, RACKSPACE_CLOUD_FILES, S3_COMPATIBLE, SALESFORCE_CONNECTED_APP, SCALITY_RING, TELEFONICA_OPEN_CLOUD_OBJECT_STORAGE, VERIZON_CLOUD, WASABI_HOT_CLOUD_STORAGE]

Cloud vendor types appilcable only for Cloud Account type

name string

Name of Credential

tokenId string

Token ID of Credential

sharedSecret string

Shared secret of Credential and must be in base64 encoded format.

description string

Description of Credential

security object

Security association of a list of users and user groups

owner object

Owner of a credential can be a user or user group

user object

id int32

name string

userGroup object

id int32

name string

associations object[]

user object

id int32

name string

userGroup object

id int32

name string

permissions object

List of permissions associated with the entity. Either categoryId and categoryName or permissionId and permissionName will be returned. If categoryId or categoryName is returned, all the corresponding permissions in the category are associated with the entity.

permissionId int32

permissionName string

categoryId int32

categoryName string

type string

Possible values: [ALL_CATEGORIES, CATEGORY_ENTITY, PERMISSION_ENTITY]

Returns the type of association.

exclude boolean

Flag to specify if this is included permission or excluded permission.

isCreatorAssociation boolean

To check if the user/user group associated is the owner.

accountType CredentialAccountType

Possible values: [WINDOWSACCOUNT, LINUXACCOUNT, STORAGE_ARRAY_ACCOUNT, CLOUD_ACCOUNT]

vendorType CloudVendorType

Possible values: [ALICLOUD_OSS, AMAZON_GLACIER, AMAZON, ATT_SYNAPTIC, REVERA_VAULT, CEPH_OBJECT_GATEWAY_S3, CMCC_ONEST, CLOUDIAN_HYPERSTORE, DELL_EMC_ECS_S3, EMC_ATMOS, FUJITSU_STORAGE_ETERNUS, GOOGLE_CLOUD, HDS_HCP, HITACHI_VANTARA_HCP_S3, HUAWEI_OSS, IBM_CLOUD, IBM_CLOUD_S3, INSPUR_CLOUD, IRON_MOUNTAIN_CLOUD, KINGSOFT_KS3, MICROSOFT_AZURE_TYPE, NETAPP_STORAGEGRID, NUTANIX_BUCKETS, OPENSTACK, AMPLIDATA, RACKSPACE_CLOUD_FILES, S3_COMPATIBLE, SALESFORCE_CONNECTED_APP, SCALITY_RING, TELEFONICA_OPEN_CLOUD_OBJECT_STORAGE, VERIZON_CLOUD, WASABI_HOT_CLOUD_STORAGE]

Cloud vendor types appilcable only for Cloud Account type

name string

Name of Credential

userAccount string

User account of Credential

apiKey string

API Key of Credential and must be in base64 encoded format.

description string

Description of Credential

security object

Security association of a list of users and user groups

owner object

Owner of a credential can be a user or user group

user object

id int32

name string

userGroup object

id int32

name string

associations object[]

user object

id int32

name string

userGroup object

id int32

name string

permissions object

List of permissions associated with the entity. Either categoryId and categoryName or permissionId and permissionName will be returned. If categoryId or categoryName is returned, all the corresponding permissions in the category are associated with the entity.

permissionId int32

permissionName string

categoryId int32

categoryName string

type string

Possible values: [ALL_CATEGORIES, CATEGORY_ENTITY, PERMISSION_ENTITY]

Returns the type of association.

exclude boolean

Flag to specify if this is included permission or excluded permission.

isCreatorAssociation boolean

To check if the user/user group associated is the owner.

accountType CredentialAccountType

Possible values: [WINDOWSACCOUNT, LINUXACCOUNT, STORAGE_ARRAY_ACCOUNT, CLOUD_ACCOUNT]

vendorType CloudVendorType

Possible values: [ALICLOUD_OSS, AMAZON_GLACIER, AMAZON, ATT_SYNAPTIC, REVERA_VAULT, CEPH_OBJECT_GATEWAY_S3, CMCC_ONEST, CLOUDIAN_HYPERSTORE, DELL_EMC_ECS_S3, EMC_ATMOS, FUJITSU_STORAGE_ETERNUS, GOOGLE_CLOUD, HDS_HCP, HITACHI_VANTARA_HCP_S3, HUAWEI_OSS, IBM_CLOUD, IBM_CLOUD_S3, INSPUR_CLOUD, IRON_MOUNTAIN_CLOUD, KINGSOFT_KS3, MICROSOFT_AZURE_TYPE, NETAPP_STORAGEGRID, NUTANIX_BUCKETS, OPENSTACK, AMPLIDATA, RACKSPACE_CLOUD_FILES, S3_COMPATIBLE, SALESFORCE_CONNECTED_APP, SCALITY_RING, TELEFONICA_OPEN_CLOUD_OBJECT_STORAGE, VERIZON_CLOUD, WASABI_HOT_CLOUD_STORAGE]

Cloud vendor types appilcable only for Cloud Account type

name string

Name of Credential

consumerKey string

Consumer key of Credential

consumerSecret string

Consumer secret of Credential

description string

Description of Credential

security object

Security association of a list of users and user groups

owner object

Owner of a credential can be a user or user group

user object

id int32

name string

userGroup object

id int32

name string

associations object[]

user object

id int32

name string

userGroup object

id int32

name string

permissions object

List of permissions associated with the entity. Either categoryId and categoryName or permissionId and permissionName will be returned. If categoryId or categoryName is returned, all the corresponding permissions in the category are associated with the entity.

permissionId int32

permissionName string

categoryId int32

categoryName string

type string

Possible values: [ALL_CATEGORIES, CATEGORY_ENTITY, PERMISSION_ENTITY]

Returns the type of association.

exclude boolean

Flag to specify if this is included permission or excluded permission.

isCreatorAssociation boolean

To check if the user/user group associated is the owner.

accountType CredentialAccountType

Possible values: [WINDOWSACCOUNT, LINUXACCOUNT, STORAGE_ARRAY_ACCOUNT, CLOUD_ACCOUNT]

vendorType CloudVendorType

Possible values: [ALICLOUD_OSS, AMAZON_GLACIER, AMAZON, ATT_SYNAPTIC, REVERA_VAULT, CEPH_OBJECT_GATEWAY_S3, CMCC_ONEST, CLOUDIAN_HYPERSTORE, DELL_EMC_ECS_S3, EMC_ATMOS, FUJITSU_STORAGE_ETERNUS, GOOGLE_CLOUD, HDS_HCP, HITACHI_VANTARA_HCP_S3, HUAWEI_OSS, IBM_CLOUD, IBM_CLOUD_S3, INSPUR_CLOUD, IRON_MOUNTAIN_CLOUD, KINGSOFT_KS3, MICROSOFT_AZURE_TYPE, NETAPP_STORAGEGRID, NUTANIX_BUCKETS, OPENSTACK, AMPLIDATA, RACKSPACE_CLOUD_FILES, S3_COMPATIBLE, SALESFORCE_CONNECTED_APP, SCALITY_RING, TELEFONICA_OPEN_CLOUD_OBJECT_STORAGE, VERIZON_CLOUD, WASABI_HOT_CLOUD_STORAGE]

Cloud vendor types appilcable only for Cloud Account type

name string

Name of Credential

authType string

Possible values: [AMAZON_S3]

Aunthentication type

accessKeyId string

Access Key ID of Credential

secretAccessKey string

Secret Access Key of Credential and must be in base64 encoded format.

description string

Description of Credential

security object

Security association of a list of users and user groups

owner object

Owner of a credential can be a user or user group

user object

id int32

name string

userGroup object

id int32

name string

associations object[]

user object

id int32

name string

userGroup object

id int32

name string

permissions object

List of permissions associated with the entity. Either categoryId and categoryName or permissionId and permissionName will be returned. If categoryId or categoryName is returned, all the corresponding permissions in the category are associated with the entity.

permissionId int32

permissionName string

categoryId int32

categoryName string

type string

Possible values: [ALL_CATEGORIES, CATEGORY_ENTITY, PERMISSION_ENTITY]

Returns the type of association.

exclude boolean

Flag to specify if this is included permission or excluded permission.

isCreatorAssociation boolean

To check if the user/user group associated is the owner.

accountType CredentialAccountType

Possible values: [WINDOWSACCOUNT, LINUXACCOUNT, STORAGE_ARRAY_ACCOUNT, CLOUD_ACCOUNT]

vendorType CloudVendorType

Possible values: [ALICLOUD_OSS, AMAZON_GLACIER, AMAZON, ATT_SYNAPTIC, REVERA_VAULT, CEPH_OBJECT_GATEWAY_S3, CMCC_ONEST, CLOUDIAN_HYPERSTORE, DELL_EMC_ECS_S3, EMC_ATMOS, FUJITSU_STORAGE_ETERNUS, GOOGLE_CLOUD, HDS_HCP, HITACHI_VANTARA_HCP_S3, HUAWEI_OSS, IBM_CLOUD, IBM_CLOUD_S3, INSPUR_CLOUD, IRON_MOUNTAIN_CLOUD, KINGSOFT_KS3, MICROSOFT_AZURE_TYPE, NETAPP_STORAGEGRID, NUTANIX_BUCKETS, OPENSTACK, AMPLIDATA, RACKSPACE_CLOUD_FILES, S3_COMPATIBLE, SALESFORCE_CONNECTED_APP, SCALITY_RING, TELEFONICA_OPEN_CLOUD_OBJECT_STORAGE, VERIZON_CLOUD, WASABI_HOT_CLOUD_STORAGE]

Cloud vendor types appilcable only for Cloud Account type

name string

Name of Credential

authType string

Possible values: [AMAZON_STS_IAM_ROLE]

Aunthentication type.

roleArn string

Role ARN of credential

password string

Role ARN of credential

description string

Description of Credential

security object

Security association of a list of users and user groups

owner object

Owner of a credential can be a user or user group

user object

id int32

name string

userGroup object

id int32

name string

associations object[]

user object

id int32

name string

userGroup object

id int32

name string

permissions object

List of permissions associated with the entity. Either categoryId and categoryName or permissionId and permissionName will be returned. If categoryId or categoryName is returned, all the corresponding permissions in the category are associated with the entity.

permissionId int32

permissionName string

categoryId int32

categoryName string

type string

Possible values: [ALL_CATEGORIES, CATEGORY_ENTITY, PERMISSION_ENTITY]

Returns the type of association.

exclude boolean

Flag to specify if this is included permission or excluded permission.

isCreatorAssociation boolean

To check if the user/user group associated is the owner.

accountType CredentialAccountType

Possible values: [WINDOWSACCOUNT, LINUXACCOUNT, STORAGE_ARRAY_ACCOUNT, CLOUD_ACCOUNT]

vendorType CloudVendorType

Possible values: [ALICLOUD_OSS, AMAZON_GLACIER, AMAZON, ATT_SYNAPTIC, REVERA_VAULT, CEPH_OBJECT_GATEWAY_S3, CMCC_ONEST, CLOUDIAN_HYPERSTORE, DELL_EMC_ECS_S3, EMC_ATMOS, FUJITSU_STORAGE_ETERNUS, GOOGLE_CLOUD, HDS_HCP, HITACHI_VANTARA_HCP_S3, HUAWEI_OSS, IBM_CLOUD, IBM_CLOUD_S3, INSPUR_CLOUD, IRON_MOUNTAIN_CLOUD, KINGSOFT_KS3, MICROSOFT_AZURE_TYPE, NETAPP_STORAGEGRID, NUTANIX_BUCKETS, OPENSTACK, AMPLIDATA, RACKSPACE_CLOUD_FILES, S3_COMPATIBLE, SALESFORCE_CONNECTED_APP, SCALITY_RING, TELEFONICA_OPEN_CLOUD_OBJECT_STORAGE, VERIZON_CLOUD, WASABI_HOT_CLOUD_STORAGE]

Cloud vendor types appilcable only for Cloud Account type

name string

Name of Credential

authType string

Possible values: [MICROSOFT_AZURE]

Aunthentication type applicable only for Cloud Accounts with Microsoft Azure as vendor.

accountName string

Account name of Credential, applicable only if authType is Access Key

accessKeyId string

Access key ID of Credential, applicable only if authType is Access Secret Key and must be in base64 encoded format.

description string

Description of Credential

security object

Security association of a list of users and user groups

owner object

Owner of a credential can be a user or user group

user object

id int32

name string

userGroup object

id int32

name string

associations object[]

user object

id int32

name string

userGroup object

id int32

name string

permissions object

List of permissions associated with the entity. Either categoryId and categoryName or permissionId and permissionName will be returned. If categoryId or categoryName is returned, all the corresponding permissions in the category are associated with the entity.

permissionId int32

permissionName string

categoryId int32

categoryName string

type string

Possible values: [ALL_CATEGORIES, CATEGORY_ENTITY, PERMISSION_ENTITY]

Returns the type of association.

exclude boolean

Flag to specify if this is included permission or excluded permission.

isCreatorAssociation boolean

To check if the user/user group associated is the owner.

accountType CredentialAccountType

Possible values: [WINDOWSACCOUNT, LINUXACCOUNT, STORAGE_ARRAY_ACCOUNT, CLOUD_ACCOUNT]

vendorType CloudVendorType

Possible values: [ALICLOUD_OSS, AMAZON_GLACIER, AMAZON, ATT_SYNAPTIC, REVERA_VAULT, CEPH_OBJECT_GATEWAY_S3, CMCC_ONEST, CLOUDIAN_HYPERSTORE, DELL_EMC_ECS_S3, EMC_ATMOS, FUJITSU_STORAGE_ETERNUS, GOOGLE_CLOUD, HDS_HCP, HITACHI_VANTARA_HCP_S3, HUAWEI_OSS, IBM_CLOUD, IBM_CLOUD_S3, INSPUR_CLOUD, IRON_MOUNTAIN_CLOUD, KINGSOFT_KS3, MICROSOFT_AZURE_TYPE, NETAPP_STORAGEGRID, NUTANIX_BUCKETS, OPENSTACK, AMPLIDATA, RACKSPACE_CLOUD_FILES, S3_COMPATIBLE, SALESFORCE_CONNECTED_APP, SCALITY_RING, TELEFONICA_OPEN_CLOUD_OBJECT_STORAGE, VERIZON_CLOUD, WASABI_HOT_CLOUD_STORAGE]

Cloud vendor types appilcable only for Cloud Account type

name string

Name of Credential

authType string

Possible values: [AZUREACCOUNT]

Aunthentication type applicable only for Cloud Accounts with Microsoft Azure as vendor.

tenantId string

Unique Azure active directory ID

applicationId string

Unique Azure application ID

applicationSecret string

Application secret of Credential and must be in base64 encoded format.

environment string

Possible values: [AZURE_CLOUD, AZURE_USGOV, AZURE_GERMANCLOUD, AZURE_CHINACLOUD, AZURE_STACK]

Azure cloud deployed region

endpoints object

Endpoints for Aunthentication, Storage and Management

activeDirectory string

storage string

resourceManager string

description string

Description of Credential

security object

Security association of a list of users and user groups

owner object

Owner of a credential can be a user or user group

user object

id int32

name string

userGroup object

id int32

name string

associations object[]

user object

id int32

name string

userGroup object

id int32

name string

permissions object

List of permissions associated with the entity. Either categoryId and categoryName or permissionId and permissionName will be returned. If categoryId or categoryName is returned, all the corresponding permissions in the category are associated with the entity.

permissionId int32

permissionName string

categoryId int32

categoryName string

type string

Possible values: [ALL_CATEGORIES, CATEGORY_ENTITY, PERMISSION_ENTITY]

Returns the type of association.

exclude boolean

Flag to specify if this is included permission or excluded permission.

isCreatorAssociation boolean

To check if the user/user group associated is the owner.

{
  "accountType": "WINDOWSACCOUNT",
  "vendorType": "ALICLOUD_OSS",
  "name": "string",
  "userAccount": "string",
  "password": "string",
  "description": "string",
  "security": {
    "owner": {
      "user": {
        "id": 0,
        "name": "string"
      },
      "userGroup": {
        "id": 0,
        "name": "string"
      }
    },
    "associations": [
      {
        "user": {
          "id": 0,
          "name": "string"
        },
        "userGroup": {
          "id": 0,
          "name": "string"
        },
        "permissions": {
          "permissionId": 0,
          "permissionName": "string",
          "categoryId": 0,
          "categoryName": "string",
          "type": "ALL_CATEGORIES",
          "exclude": true
        },
        "isCreatorAssociation": true
      }
    ]
  }
}

Not Found

Loading...