Tenant Access - List Secrets

Service:

API Management

API Version:

2024-05-01

Get tenant access information details.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{accessName}/listSecrets?api-version=2024-05-01

URI Parameters

Name	In	Required	Type	Description
accessName	path	True	AccessIdName	The identifier of the Access configuration.
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
serviceName	path	True	string	The name of the API Management service. Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string uuid	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	AccessInformationSecretsContract	Tenant Access information. Headers ETag: string
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

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

ApiManagementListSecretsTenantAccess

Sample request

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/access/listSecrets?api-version=2024-05-01

Sample response

Status code:

200

{
  "id": "5600b59375ff190048030003",
  "primaryKey": "<primaryKey>",
  "secondaryKey": "<secondaryKey>",
  "enabled": true
}

Definitions

Name	Description
AccessIdName	The identifier of the Access configuration.
AccessInformationSecretsContract	Tenant access information contract of the API Management service.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response

AccessIdName

The identifier of the Access configuration.

Name	Type	Description
access	string
gitAccess	string

AccessInformationSecretsContract

Tenant access information contract of the API Management service.

Name	Type	Description
enabled	boolean	Determines whether direct access is enabled.
id	string	Access Information type ('access' or 'gitAccess')
primaryKey	string	Primary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.
principalId	string	Principal (User) Identifier.
secondaryKey	string	Secondary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.