Credential - Get

Service:

Purview

API Version:

2023-09-01

Gets credential information.

GET {endpoint}/scan/credentials/{credentialName}?api-version=2023-09-01

URI Parameters

Name	In	Required	Type	Description
credentialName	path	True	string minLength: 3 maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$	The credential name.
endpoint	path	True	string (url)	The scanning endpoint of your purview account. Example: https://{accountName}.purview.azure.com.
api-version	query	True	string	The api version to use.

Responses

Name	Type	Description
200 OK	Credential: AccountKeyAuthAzureKeyVaultCredential BasicAuthAzureKeyVaultCredential RoleARNCredential ServicePrincipalAzureKeyVaultCredential SqlAuthAzureKeyVaultCredential ConsumerKeyAuthAzureKeyVaultCredential DelegatedAuthAzureKeyVaultCredential ManagedIdentityAzureKeyVaultCredential	Success.
Other Status Codes	ErrorResponseModel	An error response received from the Scanning Service. Headers x-ms-error-code: string

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Credential_Get

Sample request

HTTP

GET {endpoint}/scan/credentials/myCredential?api-version=2023-09-01

Sample response

Status code:

200

x-ms-request-id: d5496da4-9c52-402f-b067-83cc9ddea888

{
  "name": "myCredential",
  "kind": "BasicAuth",
  "properties": {
    "description": "test description"
  }
}

Definitions

Name	Description
AccountKeyAuthAzureKeyVaultCredential	Credential type that uses Account Key for authentication.
AccountKeyCredentialProperties	Properties of account key credential.
BasicAuthAzureKeyVaultCredential	Credential type that uses Basic authentication.
ConsumerKeyAuthAzureKeyVaultCredential	Credential type that uses consumer provided key and secret for authentication.
ConsumerKeyCredentialProperties	The properties of consumer key credential.
CredentialType	The type of the credential.
DelegatedAuthAzureKeyVaultCredential	Credential type that uses Client ID for authentication.
DelegatedAuthCredentialProperties	The properties of delegated auth credential.
ErrorModel	The error model.
ErrorResponseModel	The error response model.
KeyVaultSecret	The key vault secret.
KeyVaultSecretAccountKeyCredentialTypeProperties	Properties of key vault secret account key credential type.
KeyVaultSecretConsumerKeyCredentialTypeProperties	The type properties of key vault secret consumer key credential.
KeyVaultSecretDelegatedAuthCredentialTypeProperties	The type properties of key vault secret delegated auth credential.
KeyVaultSecretManagedIdentityAzureKeyVaultCredentialTypeProperties	The type properties of key vault secret managed identity Azure Key Vault credential.
KeyVaultSecretServicePrinipalCredentialTypeProperties	The type properties of key vault secret service principal credential.
KeyVaultSecretUserPassCredentialTypeProperties	Properties of key vault secret user pass credential type.
ManagedIdentityAzureKeyVaultCredential	Credential type that uses User assigned managed identities for authentication.
ManagedIdentityAzureKeyVaultCredentialProperties	The properties of managed identity Azure Key Vault credential.
RoleARNCredential	Credential type that uses Account ID, External ID and Role ARN for authentication.
RoleARNCredentialProperties	The properties of role ARN credential.
RoleARNCredentialTypeProperties	The type properties of role ARN credential.
ServicePrincipalAzureKeyVaultCredential	Credential type that uses Tenant ID and Service principal ID for authentication.
ServicePrincipalAzureKeyVaultCredentialProperties	The properties of service principal Azure Key Vault credential.
SqlAuthAzureKeyVaultCredential	Credential type that uses Sql for authentication.
Store	The store.
UserPassCredentialProperties	Properties of user pass credential.

AccountKeyAuthAzureKeyVaultCredential

Object

Credential type that uses Account Key for authentication.

Name	Type	Description
id	string	The resource identifier.
kind	string: AccountKey	The kind of credential.
name	string	The resource name.
properties	AccountKeyCredentialProperties	The properties of account key auth Azure Key Vault credential.

AccountKeyCredentialProperties

Object

Properties of account key credential.

Name	Type	Description
description	string
typeProperties	KeyVaultSecretAccountKeyCredentialTypeProperties	The type properties of account key credential.

BasicAuthAzureKeyVaultCredential

Object

Credential type that uses Basic authentication.

Name	Type	Description
id	string	The resource identifier.
kind	string: BasicAuth	The kind of credential.
name	string	The resource name.
properties	UserPassCredentialProperties	The properties of basic auth Azure Key Vault credential.

ConsumerKeyAuthAzureKeyVaultCredential

Object

Credential type that uses consumer provided key and secret for authentication.

Name	Type	Description
id	string	The resource identifier.
kind	string: ConsumerKeyAuth	The kind of credential.
name	string	The resource name.
properties	ConsumerKeyCredentialProperties	The properties of consumer key credential.

ConsumerKeyCredentialProperties

Object

The properties of consumer key credential.

Name	Type	Description
description	string	Description of credential properties.
typeProperties	KeyVaultSecretConsumerKeyCredentialTypeProperties	The type properties of key vault secret consumer key credential.

CredentialType

Enumeration

The type of the credential.

Value	Description
AccountKey	the credential type is account key
ServicePrincipal	the credential type is service principal
BasicAuth	the credential type is basic auth
SqlAuth	the credential type is sql auth
AmazonARN	the credential type is amazon ARN
ConsumerKeyAuth	the credential type is Consumer Key Auth
DelegatedAuth	the credential type is delegated auth
ManagedIdentity	the credential type is managed identity

DelegatedAuthAzureKeyVaultCredential

Object

Credential type that uses Client ID for authentication.

Name	Type	Description
id	string	The resource identifier.
kind	string: DelegatedAuth	The kind of credential.
name	string	The resource name.
properties	DelegatedAuthCredentialProperties	The properties of delegated auth Azure Key Vault credential.

DelegatedAuthCredentialProperties

Object

The properties of delegated auth credential.

Name	Type	Description
description	string
typeProperties	KeyVaultSecretDelegatedAuthCredentialTypeProperties	The type properties of key vault secret delegated auth credential.

ErrorModel

Object

The error model.

Name	Type	Description
code	string	A unique error code that identifies the specific error.
details	ErrorModel[]	An array of nested ErrorModel objects that provides additional error details.
message	string	A human-readable error message that provides more details about the error.
target	string	The specific component that the error is associated with.

ErrorResponseModel

Object

The error response model.

Name	Type	Description
error	ErrorModel	The error model.

KeyVaultSecret

Object

The key vault secret.

Name	Type	Description
secretName	string	The secret name of key vault secret.
secretVersion	string	The secret version of key vault secret.
store	Store	The store.
type	string	The type of key vault secret.

KeyVaultSecretAccountKeyCredentialTypeProperties

Object

Properties of key vault secret account key credential type.

Name	Type	Description
accountKey	KeyVaultSecret	The account key of key vault secret account key credential type.

KeyVaultSecretConsumerKeyCredentialTypeProperties

Object

The type properties of key vault secret consumer key credential.

Name	Type	Description
consumerKey	string	The consumer key of key vault secret consumer key credential type properties.
consumerSecret	KeyVaultSecret	The consumer secret of key vault secret consumer key credential type properties.
password	KeyVaultSecret	The password of key vault secret consumer key credential type properties.
user	string	User name.

KeyVaultSecretDelegatedAuthCredentialTypeProperties

Object

The type properties of key vault secret delegated auth credential.

Name	Type	Description
clientId	string	Credential type that uses Account ID, External ID and Role ARN for authentication.
password	KeyVaultSecret	Key vault secret.
user	string	User name.

KeyVaultSecretManagedIdentityAzureKeyVaultCredentialTypeProperties

Object

The type properties of key vault secret managed identity Azure Key Vault credential.

Name	Type	Description
principalId	string	The principal ID of key vault secret managed identity Azure Key Vault credential type properties.
resourceId	string	The resource ID of key vault secret managed identity Azure Key Vault credential type properties.
tenantId	string	The tenant ID of key vault secret managed identity Azure Key Vault credential type properties.

KeyVaultSecretServicePrinipalCredentialTypeProperties

Object

The type properties of key vault secret service principal credential.

Name	Type	Description
servicePrincipalId	string	The service principal ID of key vault secret service principal credential type properties.
servicePrincipalKey	KeyVaultSecret	The key vault secret.
tenant	string

KeyVaultSecretUserPassCredentialTypeProperties

Object

Properties of key vault secret user pass credential type.

Name	Type	Description
password	KeyVaultSecret	The password of key vault secret user pass credential type.
user	string	User name.

ManagedIdentityAzureKeyVaultCredential

Object

Credential type that uses User assigned managed identities for authentication.

Name	Type	Description
id	string	The resource identifier.
kind	string: ManagedIdentity	The kind of credential.
name	string	The resource name.
properties	ManagedIdentityAzureKeyVaultCredentialProperties	The properties of managed identity Azure Key Vault credential.

ManagedIdentityAzureKeyVaultCredentialProperties

Object

The properties of managed identity Azure Key Vault credential.

Name	Type	Description
description	string
typeProperties	KeyVaultSecretManagedIdentityAzureKeyVaultCredentialTypeProperties	The type properties of managed identity Azure Key Vault credential.

RoleARNCredential

Object

Credential type that uses Account ID, External ID and Role ARN for authentication.

Name	Type	Description
id	string	The resource identifier.
kind	string: AmazonARN	The kind of credential.
name	string	The resource name.
properties	RoleARNCredentialProperties	The properties of role ARN credential.

RoleARNCredentialProperties

Object

The properties of role ARN credential.

Name	Type	Description
description	string	The description of role ARN credential.
typeProperties	RoleARNCredentialTypeProperties	The type properties of role ARN credential.

RoleARNCredentialTypeProperties

Object

The type properties of role ARN credential.

Name	Type	Description
roleARN	string	The role ARN of role ARN credential type properties.

ServicePrincipalAzureKeyVaultCredential

Object

Credential type that uses Tenant ID and Service principal ID for authentication.

Name	Type	Description
id	string	The resource identifier.
kind	string: ServicePrincipal	The kind of credential.
name	string	The resource name.
properties	ServicePrincipalAzureKeyVaultCredentialProperties	The properties of service principal Azure Key Vault credential.

ServicePrincipalAzureKeyVaultCredentialProperties

Object

The properties of service principal Azure Key Vault credential.

Name	Type	Description
description	string
typeProperties	KeyVaultSecretServicePrinipalCredentialTypeProperties	The type properties of key vault secret service principal credential.

SqlAuthAzureKeyVaultCredential

Object

Credential type that uses Sql for authentication.

Name	Type	Description
id	string	The resource identifier.
kind	string: SqlAuth	The kind of credential.
name	string	The resource name.
properties	UserPassCredentialProperties	Properties of user pass credential.

Store

Object

The store.

Name	Type	Description
referenceName	string	The reference name of store.
type	string	The type of store.

UserPassCredentialProperties

Object

Properties of user pass credential.

Name	Type	Description
description	string
typeProperties	KeyVaultSecretUserPassCredentialTypeProperties	Properties of key vault secret user pass credential type.