Retrieves information about an Okta Push Provider configuration. This data source allows you to fetch details about existing push providers for Apple Push Notification Service (APNS) and Firebase Cloud Messaging (FCM).
Example Usage
Retrieve an APNS Push Provider
import * as pulumi from "@pulumi/pulumi";
import * as okta from "@pulumi/okta";
const apnsExample = okta.getPushProvider({
id: "ppc1234567890abcdef",
});
export const apnsProviderName = apnsExample.then(apnsExample => apnsExample.name);
export const apnsKeyId = apnsExample.then(apnsExample => apnsExample.configuration?.apnsConfiguration?.keyId);
import pulumi
import pulumi_okta as okta
apns_example = okta.get_push_provider(id="ppc1234567890abcdef")
pulumi.export("apnsProviderName", apns_example.name)
pulumi.export("apnsKeyId", apns_example.configuration.apns_configuration.key_id)
package main
import (
"github.com/pulumi/pulumi-okta/sdk/v6/go/okta"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
apnsExample, err := okta.LookupPushProvider(ctx, &okta.LookupPushProviderArgs{
Id: "ppc1234567890abcdef",
}, nil)
if err != nil {
return err
}
ctx.Export("apnsProviderName", apnsExample.Name)
ctx.Export("apnsKeyId", apnsExample.Configuration.ApnsConfiguration.KeyId)
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Okta = Pulumi.Okta;
return await Deployment.RunAsync(() =>
{
var apnsExample = Okta.GetPushProvider.Invoke(new()
{
Id = "ppc1234567890abcdef",
});
return new Dictionary<string, object?>
{
["apnsProviderName"] = apnsExample.Apply(getPushProviderResult => getPushProviderResult.Name),
["apnsKeyId"] = apnsExample.Apply(getPushProviderResult => getPushProviderResult.Configuration?.ApnsConfiguration?.KeyId),
};
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.okta.OktaFunctions;
import com.pulumi.okta.inputs.GetPushProviderArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var apnsExample = OktaFunctions.getPushProvider(GetPushProviderArgs.builder()
.id("ppc1234567890abcdef")
.build());
ctx.export("apnsProviderName", apnsExample.name());
ctx.export("apnsKeyId", apnsExample.configuration().apnsConfiguration().keyId());
}
}
variables:
apnsExample:
fn::invoke:
function: okta:getPushProvider
arguments:
id: ppc1234567890abcdef
outputs:
# Use the retrieved data
apnsProviderName: ${apnsExample.name}
apnsKeyId: ${apnsExample.configuration.apnsConfiguration.keyId}
Retrieve an FCM Push Provider
import * as pulumi from "@pulumi/pulumi";
import * as okta from "@pulumi/okta";
const fcmExample = okta.getPushProvider({
id: "ppc0987654321fedcba",
});
export const fcmProviderName = fcmExample.then(fcmExample => fcmExample.name);
export const fcmProjectId = fcmExample.then(fcmExample => fcmExample.configuration?.fcmConfiguration?.serviceAccountJson?.projectId);
import pulumi
import pulumi_okta as okta
fcm_example = okta.get_push_provider(id="ppc0987654321fedcba")
pulumi.export("fcmProviderName", fcm_example.name)
pulumi.export("fcmProjectId", fcm_example.configuration.fcm_configuration.service_account_json.project_id)
package main
import (
"github.com/pulumi/pulumi-okta/sdk/v6/go/okta"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
fcmExample, err := okta.LookupPushProvider(ctx, &okta.LookupPushProviderArgs{
Id: "ppc0987654321fedcba",
}, nil)
if err != nil {
return err
}
ctx.Export("fcmProviderName", fcmExample.Name)
ctx.Export("fcmProjectId", fcmExample.Configuration.FcmConfiguration.ServiceAccountJson.ProjectId)
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Okta = Pulumi.Okta;
return await Deployment.RunAsync(() =>
{
var fcmExample = Okta.GetPushProvider.Invoke(new()
{
Id = "ppc0987654321fedcba",
});
return new Dictionary<string, object?>
{
["fcmProviderName"] = fcmExample.Apply(getPushProviderResult => getPushProviderResult.Name),
["fcmProjectId"] = fcmExample.Apply(getPushProviderResult => getPushProviderResult.Configuration?.FcmConfiguration?.ServiceAccountJson?.ProjectId),
};
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.okta.OktaFunctions;
import com.pulumi.okta.inputs.GetPushProviderArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var fcmExample = OktaFunctions.getPushProvider(GetPushProviderArgs.builder()
.id("ppc0987654321fedcba")
.build());
ctx.export("fcmProviderName", fcmExample.name());
ctx.export("fcmProjectId", fcmExample.configuration().fcmConfiguration().serviceAccountJson().projectId());
}
}
variables:
fcmExample:
fn::invoke:
function: okta:getPushProvider
arguments:
id: ppc0987654321fedcba
outputs:
# Use the retrieved data
fcmProviderName: ${fcmExample.name}
fcmProjectId: ${fcmExample.configuration.fcmConfiguration.serviceAccountJson.projectId}
Using getPushProvider
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getPushProvider(args: GetPushProviderArgs, opts?: InvokeOptions): Promise<GetPushProviderResult>
function getPushProviderOutput(args: GetPushProviderOutputArgs, opts?: InvokeOptions): Output<GetPushProviderResult>def get_push_provider(configuration: Optional[GetPushProviderConfiguration] = None,
id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetPushProviderResult
def get_push_provider_output(configuration: Optional[pulumi.Input[GetPushProviderConfigurationArgs]] = None,
id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetPushProviderResult]func LookupPushProvider(ctx *Context, args *LookupPushProviderArgs, opts ...InvokeOption) (*LookupPushProviderResult, error)
func LookupPushProviderOutput(ctx *Context, args *LookupPushProviderOutputArgs, opts ...InvokeOption) LookupPushProviderResultOutput> Note: This function is named LookupPushProvider in the Go SDK.
public static class GetPushProvider
{
public static Task<GetPushProviderResult> InvokeAsync(GetPushProviderArgs args, InvokeOptions? opts = null)
public static Output<GetPushProviderResult> Invoke(GetPushProviderInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetPushProviderResult> getPushProvider(GetPushProviderArgs args, InvokeOptions options)
public static Output<GetPushProviderResult> getPushProvider(GetPushProviderArgs args, InvokeOptions options)
fn::invoke:
function: okta:index/getPushProvider:getPushProvider
arguments:
# arguments dictionaryThe following arguments are supported:
- Id string
- The unique identifier of the push provider to retrieve.
- Configuration
Get
Push Provider Configuration - Configuration details for the push provider. The structure depends on the provider type.
- Id string
- The unique identifier of the push provider to retrieve.
- Configuration
Get
Push Provider Configuration - Configuration details for the push provider. The structure depends on the provider type.
- id String
- The unique identifier of the push provider to retrieve.
- configuration
Get
Push Provider Configuration - Configuration details for the push provider. The structure depends on the provider type.
- id string
- The unique identifier of the push provider to retrieve.
- configuration
Get
Push Provider Configuration - Configuration details for the push provider. The structure depends on the provider type.
- id str
- The unique identifier of the push provider to retrieve.
- configuration
Get
Push Provider Configuration - Configuration details for the push provider. The structure depends on the provider type.
- id String
- The unique identifier of the push provider to retrieve.
- configuration Property Map
- Configuration details for the push provider. The structure depends on the provider type.
getPushProvider Result
The following output properties are available:
- Id string
- The unique identifier of the push provider to retrieve.
- Last
Updated stringDate - Timestamp when the push provider was last modified.
- Name string
- The display name of the push provider.
- Provider
Type string - The type of push provider. Values are
APNS(Apple Push Notification Service) orFCM(Firebase Cloud Messaging). - Configuration
Get
Push Provider Configuration - Configuration details for the push provider. The structure depends on the provider type.
- Id string
- The unique identifier of the push provider to retrieve.
- Last
Updated stringDate - Timestamp when the push provider was last modified.
- Name string
- The display name of the push provider.
- Provider
Type string - The type of push provider. Values are
APNS(Apple Push Notification Service) orFCM(Firebase Cloud Messaging). - Configuration
Get
Push Provider Configuration - Configuration details for the push provider. The structure depends on the provider type.
- id String
- The unique identifier of the push provider to retrieve.
- last
Updated StringDate - Timestamp when the push provider was last modified.
- name String
- The display name of the push provider.
- provider
Type String - The type of push provider. Values are
APNS(Apple Push Notification Service) orFCM(Firebase Cloud Messaging). - configuration
Get
Push Provider Configuration - Configuration details for the push provider. The structure depends on the provider type.
- id string
- The unique identifier of the push provider to retrieve.
- last
Updated stringDate - Timestamp when the push provider was last modified.
- name string
- The display name of the push provider.
- provider
Type string - The type of push provider. Values are
APNS(Apple Push Notification Service) orFCM(Firebase Cloud Messaging). - configuration
Get
Push Provider Configuration - Configuration details for the push provider. The structure depends on the provider type.
- id str
- The unique identifier of the push provider to retrieve.
- last_
updated_ strdate - Timestamp when the push provider was last modified.
- name str
- The display name of the push provider.
- provider_
type str - The type of push provider. Values are
APNS(Apple Push Notification Service) orFCM(Firebase Cloud Messaging). - configuration
Get
Push Provider Configuration - Configuration details for the push provider. The structure depends on the provider type.
- id String
- The unique identifier of the push provider to retrieve.
- last
Updated StringDate - Timestamp when the push provider was last modified.
- name String
- The display name of the push provider.
- provider
Type String - The type of push provider. Values are
APNS(Apple Push Notification Service) orFCM(Firebase Cloud Messaging). - configuration Property Map
- Configuration details for the push provider. The structure depends on the provider type.
Supporting Types
GetPushProviderConfiguration
GetPushProviderConfigurationApnsConfiguration
GetPushProviderConfigurationFcmConfiguration
- Service
Account GetJson Push Provider Configuration Fcm Configuration Service Account Json - JSON containing the private service account key and service account details. Required for FCM provider type.
- Service
Account GetJson Push Provider Configuration Fcm Configuration Service Account Json - JSON containing the private service account key and service account details. Required for FCM provider type.
- service
Account GetJson Push Provider Configuration Fcm Configuration Service Account Json - JSON containing the private service account key and service account details. Required for FCM provider type.
- service
Account GetJson Push Provider Configuration Fcm Configuration Service Account Json - JSON containing the private service account key and service account details. Required for FCM provider type.
- service_
account_ Getjson Push Provider Configuration Fcm Configuration Service Account Json - JSON containing the private service account key and service account details. Required for FCM provider type.
- service
Account Property MapJson - JSON containing the private service account key and service account details. Required for FCM provider type.
GetPushProviderConfigurationFcmConfigurationServiceAccountJson
- file_
name str - File name for Admin Console display.
- project_
id str - The project ID.
Package Details
- Repository
- Okta pulumi/pulumi-okta
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oktaTerraform Provider.
