Share via

Authorization Server - List Secrets

Service:
API Management
API Version:
2024-05-01

Gets the client secret details of the authorization server.

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

URI Parameters

Name In Required Type Description
authsid
 path True

string

minLength: 1
maxLength: 80
pattern: ^[^*#&+:<>?]+$

Identifier of the authorization server.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

The name of the resource group. The name is case insensitive.
serviceName
 path True

string

minLength: 1
maxLength: 50
pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

The name of the API Management service.
subscriptionId
 path True

string (uuid)

The ID of the target subscription. The value must be an UUID.
api-version
 query True

string

minLength: 1

The API version to use for this operation.

Responses

Name Type Description
200 OK

AuthorizationServerSecretsContract

Gets the secrets of the specified authorization server.

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

ApiManagementAuthorizationServerListSecrets

Sample request

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

Sample response

Status code:
200 
{
  "clientSecret": "2",
  "resourceOwnerUsername": "un",
  "resourceOwnerPassword": "pwd"
}

Definitions

Name Description
AuthorizationServerSecretsContract

OAuth Server Secrets Contract.
ErrorAdditionalInfo

The resource management error additional info.
ErrorDetail

The error detail.
ErrorResponse

Error response

AuthorizationServerSecretsContract

Object

OAuth Server Secrets Contract.

Name Type Description
clientSecret

string

oAuth Authorization Server Secrets.
resourceOwnerPassword

string

Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password.
resourceOwnerUsername

string

Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name Type Description
info

object

The additional info.
type

string

The additional info type.

ErrorDetail

Object

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

Object

Error response

Name Type Description
error

ErrorDetail

The error object.