@datafire/azure_apimanagement_apimopenidconnectproviders v5.0.0

@datafire/azure_apimanagement_apimopenidconnectproviders

Client library for ApiManagementClient

Installation and Usage

npm install --save @datafire/azure_apimanagement_apimopenidconnectproviders

let azure_apimanagement_apimopenidconnectproviders = require('@datafire/azure_apimanagement_apimopenidconnectproviders').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

Use these REST APIs for performing operations on OpenId Connect Provider entity associated with your Azure API Management deployment. API Management allows you to access APIs secured with token from OpenID Connect Provider to be accessed from the Developer Console.

Actions

OpenIdConnectProvider_ListByService

Lists of all the OpenId Connect Providers.

azure_apimanagement_apimopenidconnectproviders.OpenIdConnectProvider_ListByService({
  "resourceGroupName": "",
  "serviceName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group.
  • serviceName required string: The name of the API Management service.
  • $filter string: | Field | Usage | Supported operators | Supported functions ||-------------|-------------|-------------|-------------|| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
  • $top integer: Number of records to return.
  • $skip integer: Number of records to skip.
  • api-version required string: Version of the API to be used with the client request.
  • subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output object: Paged OpenIdProviders list representation.
  • nextLink string: Next page link if any.
  • value array: Page values.
    • items object: OpenId Connect Provider details.
      • properties object: OpenID Connect Providers Contract.
        • clientId required string: Client ID of developer console which is the client application.
        • clientSecret string: Client Secret of developer console which is the client application.
        • description string: User-friendly description of OpenID Connect Provider.
        • displayName required string: User-friendly OpenID Connect Provider name.
        • metadataEndpoint required string: Metadata endpoint URI.
      • id string: Resource ID.
      • name string: Resource name.
      • type string: Resource type for API Management resource.

OpenIdConnectProvider_Delete

Deletes specific OpenID Connect Provider of the API Management service instance.

azure_apimanagement_apimopenidconnectproviders.OpenIdConnectProvider_Delete({
  "resourceGroupName": "",
  "serviceName": "",
  "opid": "",
  "If-Match": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group.
  • serviceName required string: The name of the API Management service.
  • opid required string: Identifier of the OpenID Connect Provider.
  • If-Match required string: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
  • api-version required string: Version of the API to be used with the client request.
  • subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

OpenIdConnectProvider_Get

Gets specific OpenID Connect Provider.

azure_apimanagement_apimopenidconnectproviders.OpenIdConnectProvider_Get({
  "resourceGroupName": "",
  "serviceName": "",
  "opid": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group.
  • serviceName required string: The name of the API Management service.
  • opid required string: Identifier of the OpenID Connect Provider.
  • api-version required string: Version of the API to be used with the client request.
  • subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output object: OpenId Connect Provider details.
  • properties object: OpenID Connect Providers Contract.
    • clientId required string: Client ID of developer console which is the client application.
    • clientSecret string: Client Secret of developer console which is the client application.
    • description string: User-friendly description of OpenID Connect Provider.
    • displayName required string: User-friendly OpenID Connect Provider name.
    • metadataEndpoint required string: Metadata endpoint URI.
  • id string: Resource ID.
  • name string: Resource name.
  • type string: Resource type for API Management resource.

OpenIdConnectProvider_GetEntityTag

Gets the entity state (Etag) version of the openIdConnectProvider specified by its identifier.

azure_apimanagement_apimopenidconnectproviders.OpenIdConnectProvider_GetEntityTag({
  "resourceGroupName": "",
  "serviceName": "",
  "opid": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group.
  • serviceName required string: The name of the API Management service.
  • opid required string: Identifier of the OpenID Connect Provider.
  • api-version required string: Version of the API to be used with the client request.
  • subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

OpenIdConnectProvider_Update

Updates the specific OpenID Connect Provider.

azure_apimanagement_apimopenidconnectproviders.OpenIdConnectProvider_Update({
  "resourceGroupName": "",
  "serviceName": "",
  "opid": "",
  "parameters": null,
  "If-Match": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group.
  • serviceName required string: The name of the API Management service.
  • opid required string: Identifier of the OpenID Connect Provider.
  • parameters required object: Parameters supplied to the Update OpenID Connect Provider operation.
    • properties object: Parameters supplied to the Update OpenID Connect Provider operation.
      • clientId string: Client ID of developer console which is the client application.
      • clientSecret string: Client Secret of developer console which is the client application.
      • description string: User-friendly description of OpenID Connect Provider.
      • displayName string: User-friendly OpenID Connect Provider name.
      • metadataEndpoint string: Metadata endpoint URI.
  • If-Match required string: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
  • api-version required string: Version of the API to be used with the client request.
  • subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

OpenIdConnectProvider_CreateOrUpdate

Creates or updates the OpenID Connect Provider.

azure_apimanagement_apimopenidconnectproviders.OpenIdConnectProvider_CreateOrUpdate({
  "resourceGroupName": "",
  "serviceName": "",
  "opid": "",
  "parameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group.
  • serviceName required string: The name of the API Management service.
  • opid required string: Identifier of the OpenID Connect Provider.
  • parameters required object: OpenId Connect Provider details.
    • properties object: OpenID Connect Providers Contract.
      • clientId required string: Client ID of developer console which is the client application.
      • clientSecret string: Client Secret of developer console which is the client application.
      • description string: User-friendly description of OpenID Connect Provider.
      • displayName required string: User-friendly OpenID Connect Provider name.
      • metadataEndpoint required string: Metadata endpoint URI.
    • id string: Resource ID.
    • name string: Resource name.
    • type string: Resource type for API Management resource.
  • If-Match string: ETag of the Entity. Not required when creating an entity, but required when updating an entity.
  • api-version required string: Version of the API to be used with the client request.
  • subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output object: OpenId Connect Provider details.
  • properties object: OpenID Connect Providers Contract.
    • clientId required string: Client ID of developer console which is the client application.
    • clientSecret string: Client Secret of developer console which is the client application.
    • description string: User-friendly description of OpenID Connect Provider.
    • displayName required string: User-friendly OpenID Connect Provider name.
    • metadataEndpoint required string: Metadata endpoint URI.
  • id string: Resource ID.
  • name string: Resource name.
  • type string: Resource type for API Management resource.

OpenIdConnectProvider_ListSecrets

Gets the client secret details of the OpenID Connect Provider.

azure_apimanagement_apimopenidconnectproviders.OpenIdConnectProvider_ListSecrets({
  "resourceGroupName": "",
  "serviceName": "",
  "opid": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group.
  • serviceName required string: The name of the API Management service.
  • opid required string: Identifier of the OpenID Connect Provider.
  • api-version required string: Version of the API to be used with the client request.
  • subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output object: Client or app secret used in IdentityProviders, Aad, OpenID or OAuth.
  • clientSecret string: Client or app secret used in IdentityProviders, Aad, OpenID or OAuth.

Definitions

This integration has no definitions