Tenant Access - List Secrets

Get tenant access information details.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{accessName}/listSecrets?api-version=2021-08-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.

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

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

api-version
query True

string

Version of the API to be used with the client request.

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

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/access/listSecrets?api-version=2021-08-01

Sample response

{
  "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.

ErrorFieldContract

Error Field contract.

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.

ErrorFieldContract

Error Field contract.

Name Type Description
code

string

Property level error code.

message

string

Human-readable representation of property-level error.

target

string

Property name.

ErrorResponse

Error Response.

Name Type Description
error.code

string

Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.

error.details

ErrorFieldContract[]

The list of invalid fields send in request, in case of validation error.

error.message

string

Human-readable representation of the error.