Integration Runtimes - List Auth Keys

Service:

Purview

API Version:

2022-07-01-preview

Gets integrationRuntimeAuthKeys

POST {Endpoint}/scan/integrationruntimes/{integrationRuntimeName}/:listAuthKeys?api-version=2022-07-01-preview

URI Parameters

Name	In	Required	Type	Description
Endpoint	path	True	string	The scanning endpoint of your purview account. Example: https://{accountName}.purview.azure.com
integrationRuntimeName	path	True	string	IntegrationRuntime 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

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=2022-07-01-preview

Sample Response

Status code:

200

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

Response Body

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

Definitions

Name	Description
Error
ErrorModel
ErrorResponseModel
IntegrationRuntimeAuthKeys

Error

Name	Type	Description
code	string
details	ErrorModel[]
message	string
target	string

ErrorModel

Name	Type	Description
code	string
details	ErrorModel[]
message	string
target	string

ErrorResponseModel

Name	Type	Description
error	Error

IntegrationRuntimeAuthKeys

Name	Type	Description
authKey1	string
authKey2	string