Okta v4.11.1 published on Monday, Oct 7, 2024 by Pulumi
okta.idp.getSocial
Explore with Pulumi AI
Get a social IdP from Okta.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as okta from "@pulumi/okta";
const example = okta.idp.getSocial({
name: "My Facebook IdP",
});
import pulumi
import pulumi_okta as okta
example = okta.idp.get_social(name="My Facebook IdP")
package main
import (
"github.com/pulumi/pulumi-okta/sdk/v4/go/okta/idp"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := idp.LookupSocial(ctx, &idp.LookupSocialArgs{
Name: pulumi.StringRef("My Facebook IdP"),
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Okta = Pulumi.Okta;
return await Deployment.RunAsync(() =>
{
var example = Okta.Idp.GetSocial.Invoke(new()
{
Name = "My Facebook IdP",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.okta.idp.IdpFunctions;
import com.pulumi.okta.idp.inputs.GetSocialArgs;
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 example = IdpFunctions.getSocial(GetSocialArgs.builder()
.name("My Facebook IdP")
.build());
}
}
variables:
example:
fn::invoke:
Function: okta:idp:getSocial
Arguments:
name: My Facebook IdP
Using getSocial
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 getSocial(args: GetSocialArgs, opts?: InvokeOptions): Promise<GetSocialResult>
function getSocialOutput(args: GetSocialOutputArgs, opts?: InvokeOptions): Output<GetSocialResult>
def get_social(id: Optional[str] = None,
name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetSocialResult
def get_social_output(id: Optional[pulumi.Input[str]] = None,
name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetSocialResult]
func LookupSocial(ctx *Context, args *LookupSocialArgs, opts ...InvokeOption) (*LookupSocialResult, error)
func LookupSocialOutput(ctx *Context, args *LookupSocialOutputArgs, opts ...InvokeOption) LookupSocialResultOutput
> Note: This function is named LookupSocial
in the Go SDK.
public static class GetSocial
{
public static Task<GetSocialResult> InvokeAsync(GetSocialArgs args, InvokeOptions? opts = null)
public static Output<GetSocialResult> Invoke(GetSocialInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetSocialResult> getSocial(GetSocialArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: okta:idp/getSocial:getSocial
arguments:
# arguments dictionary
The following arguments are supported:
getSocial Result
The following output properties are available:
- Account
Link stringAction - Specifies the account linking action for an IdP user.
- Account
Link List<string>Group Includes - Group memberships to determine link candidates.
- string
- The method of making an authorization request.
- string
- IdP Authorization Server (AS) endpoint to request consent from the user and obtain an authorization code grant.
- Client
Id string - Unique identifier issued by AS for the Okta IdP instance.
- Client
Secret string - Client secret issued by AS for the Okta IdP instance.
- Deprovisioned
Action string - Action for a previously deprovisioned IdP user during authentication.
- Groups
Action string - Provisioning action for IdP user's group memberships.
- Groups
Assignments List<string> - List of Okta Group IDs.
- Groups
Attribute string - IdP user profile attribute name for an array value that contains group memberships.
- Groups
Filters List<string> - Whitelist of Okta Group identifiers.
- Issuer
Mode string - Indicates whether Okta uses the original Okta org domain URL, or a custom domain URL.
- Max
Clock intSkew - Maximum allowable clock-skew when processing messages from the IdP.
- Profile
Master bool - Determines if the IdP should act as a source of truth for user profile attributes.
- Protocol
Type string - The type of protocol to use.
- Provisioning
Action string - Provisioning action for an IdP user during authentication.
- Scopes List<string>
- The scopes of the IdP.
- Status string
- Status of the IdP.
- Subject
Match stringAttribute - Okta user profile attribute for matching transformed IdP username.
- Subject
Match stringType - Determines the Okta user profile attribute match conditions for account linking and authentication of the transformed IdP username.
- Suspended
Action string - Action for a previously suspended IdP user during authentication.
- Token
Binding string - The method of making a token request.
- Token
Url string - IdP Authorization Server (AS) endpoint to exchange the authorization code grant for an access token.
- Type string
- The type of Social IdP. See API docs Identity Provider Type
- Username
Template string - Okta EL Expression to generate or transform a unique username for the IdP user.
- Id string
- The id of the social idp to retrieve, conflicts with
name
. - Name string
- The name of the social idp to retrieve, conflicts with
id
.
- Account
Link stringAction - Specifies the account linking action for an IdP user.
- Account
Link []stringGroup Includes - Group memberships to determine link candidates.
- string
- The method of making an authorization request.
- string
- IdP Authorization Server (AS) endpoint to request consent from the user and obtain an authorization code grant.
- Client
Id string - Unique identifier issued by AS for the Okta IdP instance.
- Client
Secret string - Client secret issued by AS for the Okta IdP instance.
- Deprovisioned
Action string - Action for a previously deprovisioned IdP user during authentication.
- Groups
Action string - Provisioning action for IdP user's group memberships.
- Groups
Assignments []string - List of Okta Group IDs.
- Groups
Attribute string - IdP user profile attribute name for an array value that contains group memberships.
- Groups
Filters []string - Whitelist of Okta Group identifiers.
- Issuer
Mode string - Indicates whether Okta uses the original Okta org domain URL, or a custom domain URL.
- Max
Clock intSkew - Maximum allowable clock-skew when processing messages from the IdP.
- Profile
Master bool - Determines if the IdP should act as a source of truth for user profile attributes.
- Protocol
Type string - The type of protocol to use.
- Provisioning
Action string - Provisioning action for an IdP user during authentication.
- Scopes []string
- The scopes of the IdP.
- Status string
- Status of the IdP.
- Subject
Match stringAttribute - Okta user profile attribute for matching transformed IdP username.
- Subject
Match stringType - Determines the Okta user profile attribute match conditions for account linking and authentication of the transformed IdP username.
- Suspended
Action string - Action for a previously suspended IdP user during authentication.
- Token
Binding string - The method of making a token request.
- Token
Url string - IdP Authorization Server (AS) endpoint to exchange the authorization code grant for an access token.
- Type string
- The type of Social IdP. See API docs Identity Provider Type
- Username
Template string - Okta EL Expression to generate or transform a unique username for the IdP user.
- Id string
- The id of the social idp to retrieve, conflicts with
name
. - Name string
- The name of the social idp to retrieve, conflicts with
id
.
- account
Link StringAction - Specifies the account linking action for an IdP user.
- account
Link List<String>Group Includes - Group memberships to determine link candidates.
- String
- The method of making an authorization request.
- String
- IdP Authorization Server (AS) endpoint to request consent from the user and obtain an authorization code grant.
- client
Id String - Unique identifier issued by AS for the Okta IdP instance.
- client
Secret String - Client secret issued by AS for the Okta IdP instance.
- deprovisioned
Action String - Action for a previously deprovisioned IdP user during authentication.
- groups
Action String - Provisioning action for IdP user's group memberships.
- groups
Assignments List<String> - List of Okta Group IDs.
- groups
Attribute String - IdP user profile attribute name for an array value that contains group memberships.
- groups
Filters List<String> - Whitelist of Okta Group identifiers.
- issuer
Mode String - Indicates whether Okta uses the original Okta org domain URL, or a custom domain URL.
- max
Clock IntegerSkew - Maximum allowable clock-skew when processing messages from the IdP.
- profile
Master Boolean - Determines if the IdP should act as a source of truth for user profile attributes.
- protocol
Type String - The type of protocol to use.
- provisioning
Action String - Provisioning action for an IdP user during authentication.
- scopes List<String>
- The scopes of the IdP.
- status String
- Status of the IdP.
- subject
Match StringAttribute - Okta user profile attribute for matching transformed IdP username.
- subject
Match StringType - Determines the Okta user profile attribute match conditions for account linking and authentication of the transformed IdP username.
- suspended
Action String - Action for a previously suspended IdP user during authentication.
- token
Binding String - The method of making a token request.
- token
Url String - IdP Authorization Server (AS) endpoint to exchange the authorization code grant for an access token.
- type String
- The type of Social IdP. See API docs Identity Provider Type
- username
Template String - Okta EL Expression to generate or transform a unique username for the IdP user.
- id String
- The id of the social idp to retrieve, conflicts with
name
. - name String
- The name of the social idp to retrieve, conflicts with
id
.
- account
Link stringAction - Specifies the account linking action for an IdP user.
- account
Link string[]Group Includes - Group memberships to determine link candidates.
- string
- The method of making an authorization request.
- string
- IdP Authorization Server (AS) endpoint to request consent from the user and obtain an authorization code grant.
- client
Id string - Unique identifier issued by AS for the Okta IdP instance.
- client
Secret string - Client secret issued by AS for the Okta IdP instance.
- deprovisioned
Action string - Action for a previously deprovisioned IdP user during authentication.
- groups
Action string - Provisioning action for IdP user's group memberships.
- groups
Assignments string[] - List of Okta Group IDs.
- groups
Attribute string - IdP user profile attribute name for an array value that contains group memberships.
- groups
Filters string[] - Whitelist of Okta Group identifiers.
- issuer
Mode string - Indicates whether Okta uses the original Okta org domain URL, or a custom domain URL.
- max
Clock numberSkew - Maximum allowable clock-skew when processing messages from the IdP.
- profile
Master boolean - Determines if the IdP should act as a source of truth for user profile attributes.
- protocol
Type string - The type of protocol to use.
- provisioning
Action string - Provisioning action for an IdP user during authentication.
- scopes string[]
- The scopes of the IdP.
- status string
- Status of the IdP.
- subject
Match stringAttribute - Okta user profile attribute for matching transformed IdP username.
- subject
Match stringType - Determines the Okta user profile attribute match conditions for account linking and authentication of the transformed IdP username.
- suspended
Action string - Action for a previously suspended IdP user during authentication.
- token
Binding string - The method of making a token request.
- token
Url string - IdP Authorization Server (AS) endpoint to exchange the authorization code grant for an access token.
- type string
- The type of Social IdP. See API docs Identity Provider Type
- username
Template string - Okta EL Expression to generate or transform a unique username for the IdP user.
- id string
- The id of the social idp to retrieve, conflicts with
name
. - name string
- The name of the social idp to retrieve, conflicts with
id
.
- account_
link_ straction - Specifies the account linking action for an IdP user.
- account_
link_ Sequence[str]group_ includes - Group memberships to determine link candidates.
- str
- The method of making an authorization request.
- str
- IdP Authorization Server (AS) endpoint to request consent from the user and obtain an authorization code grant.
- client_
id str - Unique identifier issued by AS for the Okta IdP instance.
- client_
secret str - Client secret issued by AS for the Okta IdP instance.
- deprovisioned_
action str - Action for a previously deprovisioned IdP user during authentication.
- groups_
action str - Provisioning action for IdP user's group memberships.
- groups_
assignments Sequence[str] - List of Okta Group IDs.
- groups_
attribute str - IdP user profile attribute name for an array value that contains group memberships.
- groups_
filters Sequence[str] - Whitelist of Okta Group identifiers.
- issuer_
mode str - Indicates whether Okta uses the original Okta org domain URL, or a custom domain URL.
- max_
clock_ intskew - Maximum allowable clock-skew when processing messages from the IdP.
- profile_
master bool - Determines if the IdP should act as a source of truth for user profile attributes.
- protocol_
type str - The type of protocol to use.
- provisioning_
action str - Provisioning action for an IdP user during authentication.
- scopes Sequence[str]
- The scopes of the IdP.
- status str
- Status of the IdP.
- subject_
match_ strattribute - Okta user profile attribute for matching transformed IdP username.
- subject_
match_ strtype - Determines the Okta user profile attribute match conditions for account linking and authentication of the transformed IdP username.
- suspended_
action str - Action for a previously suspended IdP user during authentication.
- token_
binding str - The method of making a token request.
- token_
url str - IdP Authorization Server (AS) endpoint to exchange the authorization code grant for an access token.
- type str
- The type of Social IdP. See API docs Identity Provider Type
- username_
template str - Okta EL Expression to generate or transform a unique username for the IdP user.
- id str
- The id of the social idp to retrieve, conflicts with
name
. - name str
- The name of the social idp to retrieve, conflicts with
id
.
- account
Link StringAction - Specifies the account linking action for an IdP user.
- account
Link List<String>Group Includes - Group memberships to determine link candidates.
- String
- The method of making an authorization request.
- String
- IdP Authorization Server (AS) endpoint to request consent from the user and obtain an authorization code grant.
- client
Id String - Unique identifier issued by AS for the Okta IdP instance.
- client
Secret String - Client secret issued by AS for the Okta IdP instance.
- deprovisioned
Action String - Action for a previously deprovisioned IdP user during authentication.
- groups
Action String - Provisioning action for IdP user's group memberships.
- groups
Assignments List<String> - List of Okta Group IDs.
- groups
Attribute String - IdP user profile attribute name for an array value that contains group memberships.
- groups
Filters List<String> - Whitelist of Okta Group identifiers.
- issuer
Mode String - Indicates whether Okta uses the original Okta org domain URL, or a custom domain URL.
- max
Clock NumberSkew - Maximum allowable clock-skew when processing messages from the IdP.
- profile
Master Boolean - Determines if the IdP should act as a source of truth for user profile attributes.
- protocol
Type String - The type of protocol to use.
- provisioning
Action String - Provisioning action for an IdP user during authentication.
- scopes List<String>
- The scopes of the IdP.
- status String
- Status of the IdP.
- subject
Match StringAttribute - Okta user profile attribute for matching transformed IdP username.
- subject
Match StringType - Determines the Okta user profile attribute match conditions for account linking and authentication of the transformed IdP username.
- suspended
Action String - Action for a previously suspended IdP user during authentication.
- token
Binding String - The method of making a token request.
- token
Url String - IdP Authorization Server (AS) endpoint to exchange the authorization code grant for an access token.
- type String
- The type of Social IdP. See API docs Identity Provider Type
- username
Template String - Okta EL Expression to generate or transform a unique username for the IdP user.
- id String
- The id of the social idp to retrieve, conflicts with
name
. - name String
- The name of the social idp to retrieve, conflicts with
id
.
Package Details
- Repository
- Okta pulumi/pulumi-okta
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
okta
Terraform Provider.