OpenId Connect Provider - Create Or Update

Creates or updates the OpenID Connect Provider.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/openidConnectProviders/{opid}?api-version=2021-08-01

URI Parameters

Name In Required Type Description
opid
path True

string

Identifier of the OpenID Connect Provider.

Regex pattern: ^[^*#&+:<>?]+$

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.

Request Header

Name Required Type Description
If-Match

string

ETag of the Entity. Not required when creating an entity, but required when updating an entity.

Request Body

Name Required Type Description
properties.clientId True

string

Client ID of developer console which is the client application.

properties.displayName True

string

User-friendly OpenID Connect Provider name.

properties.metadataEndpoint True

string

Metadata endpoint URI.

properties.clientSecret

string

Client Secret of developer console which is the client application.

properties.description

string

User-friendly description of OpenID Connect Provider.

Responses

Name Type Description
200 OK

OpenidConnectProviderContract

OpenIdConnect Provider was successfully updated.

Headers

ETag: string

201 Created

OpenidConnectProviderContract

OpenIdConnect Provider was successfully created.

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

ApiManagementCreateOpenIdConnectProvider

Sample request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/openidConnectProviders/templateOpenIdConnect3?api-version=2021-08-01

{
  "properties": {
    "displayName": "templateoidprovider3",
    "metadataEndpoint": "https://oidprovider-template3.net",
    "clientId": "oidprovidertemplate3",
    "clientSecret": "x"
  }
}

Sample response

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/openidConnectProviders/templateOpenIdConnect3",
  "type": "Microsoft.ApiManagement/service/openidconnectproviders",
  "name": "templateOpenIdConnect3",
  "properties": {
    "displayName": "templateoidprovider3",
    "metadataEndpoint": "https://oidprovider-template3.net",
    "clientId": "oidprovidertemplate3"
  }
}
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/openidConnectProviders/templateOpenIdConnect3",
  "type": "Microsoft.ApiManagement/service/openidconnectproviders",
  "name": "templateOpenIdConnect3",
  "properties": {
    "displayName": "templateoidprovider3",
    "metadataEndpoint": "https://oidprovider-template3.net",
    "clientId": "oidprovidertemplate3"
  }
}

Definitions

Name Description
ErrorFieldContract

Error Field contract.

ErrorResponse

Error Response.

OpenidConnectProviderContract

OpenId Connect Provider details.

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.

OpenidConnectProviderContract

OpenId Connect Provider details.

Name Type Description
id

string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

The name of the resource

properties.clientId

string

Client ID of developer console which is the client application.

properties.clientSecret

string

Client Secret of developer console which is the client application.

properties.description

string

User-friendly description of OpenID Connect Provider.

properties.displayName

string

User-friendly OpenID Connect Provider name.

properties.metadataEndpoint

string

Metadata endpoint URI.

type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"