Integration Runtimes - List Auth Keys

Service:

Purview

API Version:

2023-09-01

Retrieves the authentication keys for an integration runtime.

POST {endpoint}/scan/integrationruntimes/{integrationRuntimeName}:listAuthKeys?api-version=2023-09-01

URI Parameters

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

Responses

Name	Type	Description
200 OK	IntegrationRuntimeAuthKeys	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

IntegrationRuntimes_ListAuthKeys

Sample request

HTTP

POST {endpoint}/scan/integrationruntimes/myIntegrationRuntime:listAuthKeys?api-version=2023-09-01

Sample response

Status code:

200

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

{
  "authKey1": "authKey1",
  "authKey2": "authKey2"
}

Definitions

Name	Description
ErrorModel	The error model.
ErrorResponseModel	The error response model.
IntegrationRuntimeAuthKeys	The integration runtime authentication keys.

ErrorModel

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

The error response model.

Name	Type	Description
error	ErrorModel	The error model.

IntegrationRuntimeAuthKeys

The integration runtime authentication keys.

Name	Type	Description
authKey1	string	The primary integration runtime authentication key.
authKey2	string	The secondary integration runtime authentication key.