okta.idp.Social
Explore with Pulumi AI
Creates a Social Identity Provider. This resource allows you to create and configure a Social Identity Provider.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as okta from "@pulumi/okta";
const example = new okta.idp.Social("example", {
    type: "FACEBOOK",
    protocolType: "OAUTH2",
    name: "testAcc_facebook_replace_with_uuid",
    scopes: [
        "public_profile",
        "email",
    ],
    clientId: "abcd123",
    clientSecret: "abcd123",
    usernameTemplate: "idpuser.email",
});
import pulumi
import pulumi_okta as okta
example = okta.idp.Social("example",
    type="FACEBOOK",
    protocol_type="OAUTH2",
    name="testAcc_facebook_replace_with_uuid",
    scopes=[
        "public_profile",
        "email",
    ],
    client_id="abcd123",
    client_secret="abcd123",
    username_template="idpuser.email")
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.NewSocial(ctx, "example", &idp.SocialArgs{
			Type:         pulumi.String("FACEBOOK"),
			ProtocolType: pulumi.String("OAUTH2"),
			Name:         pulumi.String("testAcc_facebook_replace_with_uuid"),
			Scopes: pulumi.StringArray{
				pulumi.String("public_profile"),
				pulumi.String("email"),
			},
			ClientId:         pulumi.String("abcd123"),
			ClientSecret:     pulumi.String("abcd123"),
			UsernameTemplate: pulumi.String("idpuser.email"),
		})
		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 = new Okta.Idp.Social("example", new()
    {
        Type = "FACEBOOK",
        ProtocolType = "OAUTH2",
        Name = "testAcc_facebook_replace_with_uuid",
        Scopes = new[]
        {
            "public_profile",
            "email",
        },
        ClientId = "abcd123",
        ClientSecret = "abcd123",
        UsernameTemplate = "idpuser.email",
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.okta.idp.Social;
import com.pulumi.okta.idp.SocialArgs;
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) {
        var example = new Social("example", SocialArgs.builder()
            .type("FACEBOOK")
            .protocolType("OAUTH2")
            .name("testAcc_facebook_replace_with_uuid")
            .scopes(            
                "public_profile",
                "email")
            .clientId("abcd123")
            .clientSecret("abcd123")
            .usernameTemplate("idpuser.email")
            .build());
    }
}
resources:
  example:
    type: okta:idp:Social
    properties:
      type: FACEBOOK
      protocolType: OAUTH2
      name: testAcc_facebook_replace_with_uuid
      scopes:
        - public_profile
        - email
      clientId: abcd123
      clientSecret: abcd123
      usernameTemplate: idpuser.email
Create Social Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Social(name: string, args: SocialArgs, opts?: CustomResourceOptions);@overload
def Social(resource_name: str,
           args: SocialArgs,
           opts: Optional[ResourceOptions] = None)
@overload
def Social(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           scopes: Optional[Sequence[str]] = None,
           type: Optional[str] = None,
           client_secret: Optional[str] = None,
           username_template: Optional[str] = None,
           issuer_mode: Optional[str] = None,
           client_id: Optional[str] = None,
           account_link_action: Optional[str] = None,
           deprovisioned_action: Optional[str] = None,
           groups_action: Optional[str] = None,
           groups_assignments: Optional[Sequence[str]] = None,
           groups_attribute: Optional[str] = None,
           name: Optional[str] = None,
           apple_team_id: Optional[str] = None,
           apple_private_key: Optional[str] = None,
           groups_filters: Optional[Sequence[str]] = None,
           profile_master: Optional[bool] = None,
           protocol_type: Optional[str] = None,
           provisioning_action: Optional[str] = None,
           apple_kid: Optional[str] = None,
           status: Optional[str] = None,
           subject_match_attribute: Optional[str] = None,
           subject_match_type: Optional[str] = None,
           suspended_action: Optional[str] = None,
           account_link_group_includes: Optional[Sequence[str]] = None,
           max_clock_skew: Optional[int] = None)func NewSocial(ctx *Context, name string, args SocialArgs, opts ...ResourceOption) (*Social, error)public Social(string name, SocialArgs args, CustomResourceOptions? opts = null)
public Social(String name, SocialArgs args)
public Social(String name, SocialArgs args, CustomResourceOptions options)
type: okta:idp:Social
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args SocialArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args SocialArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args SocialArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SocialArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args SocialArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var socialResource = new Okta.Idp.Social("socialResource", new()
{
    Scopes = new[]
    {
        "string",
    },
    Type = "string",
    ClientSecret = "string",
    UsernameTemplate = "string",
    IssuerMode = "string",
    ClientId = "string",
    AccountLinkAction = "string",
    DeprovisionedAction = "string",
    GroupsAction = "string",
    GroupsAssignments = new[]
    {
        "string",
    },
    GroupsAttribute = "string",
    Name = "string",
    AppleTeamId = "string",
    ApplePrivateKey = "string",
    GroupsFilters = new[]
    {
        "string",
    },
    ProfileMaster = false,
    ProtocolType = "string",
    ProvisioningAction = "string",
    AppleKid = "string",
    Status = "string",
    SubjectMatchAttribute = "string",
    SubjectMatchType = "string",
    SuspendedAction = "string",
    AccountLinkGroupIncludes = new[]
    {
        "string",
    },
    MaxClockSkew = 0,
});
example, err := idp.NewSocial(ctx, "socialResource", &idp.SocialArgs{
	Scopes: pulumi.StringArray{
		pulumi.String("string"),
	},
	Type:                pulumi.String("string"),
	ClientSecret:        pulumi.String("string"),
	UsernameTemplate:    pulumi.String("string"),
	IssuerMode:          pulumi.String("string"),
	ClientId:            pulumi.String("string"),
	AccountLinkAction:   pulumi.String("string"),
	DeprovisionedAction: pulumi.String("string"),
	GroupsAction:        pulumi.String("string"),
	GroupsAssignments: pulumi.StringArray{
		pulumi.String("string"),
	},
	GroupsAttribute: pulumi.String("string"),
	Name:            pulumi.String("string"),
	AppleTeamId:     pulumi.String("string"),
	ApplePrivateKey: pulumi.String("string"),
	GroupsFilters: pulumi.StringArray{
		pulumi.String("string"),
	},
	ProfileMaster:         pulumi.Bool(false),
	ProtocolType:          pulumi.String("string"),
	ProvisioningAction:    pulumi.String("string"),
	AppleKid:              pulumi.String("string"),
	Status:                pulumi.String("string"),
	SubjectMatchAttribute: pulumi.String("string"),
	SubjectMatchType:      pulumi.String("string"),
	SuspendedAction:       pulumi.String("string"),
	AccountLinkGroupIncludes: pulumi.StringArray{
		pulumi.String("string"),
	},
	MaxClockSkew: pulumi.Int(0),
})
var socialResource = new Social("socialResource", SocialArgs.builder()
    .scopes("string")
    .type("string")
    .clientSecret("string")
    .usernameTemplate("string")
    .issuerMode("string")
    .clientId("string")
    .accountLinkAction("string")
    .deprovisionedAction("string")
    .groupsAction("string")
    .groupsAssignments("string")
    .groupsAttribute("string")
    .name("string")
    .appleTeamId("string")
    .applePrivateKey("string")
    .groupsFilters("string")
    .profileMaster(false)
    .protocolType("string")
    .provisioningAction("string")
    .appleKid("string")
    .status("string")
    .subjectMatchAttribute("string")
    .subjectMatchType("string")
    .suspendedAction("string")
    .accountLinkGroupIncludes("string")
    .maxClockSkew(0)
    .build());
social_resource = okta.idp.Social("socialResource",
    scopes=["string"],
    type="string",
    client_secret="string",
    username_template="string",
    issuer_mode="string",
    client_id="string",
    account_link_action="string",
    deprovisioned_action="string",
    groups_action="string",
    groups_assignments=["string"],
    groups_attribute="string",
    name="string",
    apple_team_id="string",
    apple_private_key="string",
    groups_filters=["string"],
    profile_master=False,
    protocol_type="string",
    provisioning_action="string",
    apple_kid="string",
    status="string",
    subject_match_attribute="string",
    subject_match_type="string",
    suspended_action="string",
    account_link_group_includes=["string"],
    max_clock_skew=0)
const socialResource = new okta.idp.Social("socialResource", {
    scopes: ["string"],
    type: "string",
    clientSecret: "string",
    usernameTemplate: "string",
    issuerMode: "string",
    clientId: "string",
    accountLinkAction: "string",
    deprovisionedAction: "string",
    groupsAction: "string",
    groupsAssignments: ["string"],
    groupsAttribute: "string",
    name: "string",
    appleTeamId: "string",
    applePrivateKey: "string",
    groupsFilters: ["string"],
    profileMaster: false,
    protocolType: "string",
    provisioningAction: "string",
    appleKid: "string",
    status: "string",
    subjectMatchAttribute: "string",
    subjectMatchType: "string",
    suspendedAction: "string",
    accountLinkGroupIncludes: ["string"],
    maxClockSkew: 0,
});
type: okta:idp:Social
properties:
    accountLinkAction: string
    accountLinkGroupIncludes:
        - string
    appleKid: string
    applePrivateKey: string
    appleTeamId: string
    clientId: string
    clientSecret: string
    deprovisionedAction: string
    groupsAction: string
    groupsAssignments:
        - string
    groupsAttribute: string
    groupsFilters:
        - string
    issuerMode: string
    maxClockSkew: 0
    name: string
    profileMaster: false
    protocolType: string
    provisioningAction: string
    scopes:
        - string
    status: string
    subjectMatchAttribute: string
    subjectMatchType: string
    suspendedAction: string
    type: string
    usernameTemplate: string
Social Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Social resource accepts the following input properties:
- Scopes List<string>
- The scopes of the IdP.
- Type string
- Identity Provider Types: https://developer.okta.com/docs/reference/api/idps/#identity-provider-type
- AccountLink stringAction 
- Specifies the account linking action for an IdP user. Default: AUTO
- AccountLink List<string>Group Includes 
- Group memberships to determine link candidates.
- AppleKid string
- The Key ID that you obtained from Apple when you created the private key for the client
- ApplePrivate stringKey 
- The Key ID that you obtained from Apple when you created the private key for the client. PrivateKey is required when resource is first created. For all consecutive updates, it can be empty/omitted and keeps the existing value if it is empty/omitted. PrivateKey isn't returned when importing this resource.
- AppleTeam stringId 
- The Team ID associated with your Apple developer account
- ClientId string
- Unique identifier issued by AS for the Okta IdP instance.
- ClientSecret string
- Client secret issued by AS for the Okta IdP instance.
- DeprovisionedAction string
- Action for a previously deprovisioned IdP user during authentication. Can be NONEorREACTIVATE. Default:NONE
- GroupsAction string
- Provisioning action for IdP user's group memberships. It can be NONE,SYNC,APPEND, orASSIGN. Default:NONE
- GroupsAssignments List<string>
- List of Okta Group IDs to add an IdP user as a member with the ASSIGNgroups_action.
- GroupsAttribute string
- IdP user profile attribute name (case-insensitive) for an array value that contains group memberships.
- GroupsFilters List<string>
- Whitelist of Okta Group identifiers that are allowed for the APPENDorSYNCgroups_action.
- IssuerMode string
- Indicates whether Okta uses the original Okta org domain URL, or a custom domain URL. It can be ORG_URLorCUSTOM_URL. Default:ORG_URL
- MaxClock intSkew 
- Maximum allowable clock-skew when processing messages from the IdP.
- Name string
- Name of the IdP
- ProfileMaster bool
- Determines if the IdP should act as a source of truth for user profile attributes.
- ProtocolType string
- The type of protocol to use. It can be OIDCorOAUTH2. Default:OAUTH2
- ProvisioningAction string
- Provisioning action for an IdP user during authentication. Default: AUTO
- Status string
- Default to ACTIVE
- SubjectMatch stringAttribute 
- Okta user profile attribute for matching transformed IdP username. Only for matchType CUSTOM_ATTRIBUTE.
- SubjectMatch stringType 
- Determines the Okta user profile attribute match conditions for account linking and authentication of the transformed IdP username. By default, it is set to USERNAME. It can be set toUSERNAME,EMAIL,USERNAME_OR_EMAILorCUSTOM_ATTRIBUTE.
- SuspendedAction string
- Action for a previously suspended IdP user during authentication. Can be NONEorREACTIVATE. Default:NONE
- UsernameTemplate string
- Okta EL Expression to generate or transform a unique username for the IdP user. Default: idpuser.email
- Scopes []string
- The scopes of the IdP.
- Type string
- Identity Provider Types: https://developer.okta.com/docs/reference/api/idps/#identity-provider-type
- AccountLink stringAction 
- Specifies the account linking action for an IdP user. Default: AUTO
- AccountLink []stringGroup Includes 
- Group memberships to determine link candidates.
- AppleKid string
- The Key ID that you obtained from Apple when you created the private key for the client
- ApplePrivate stringKey 
- The Key ID that you obtained from Apple when you created the private key for the client. PrivateKey is required when resource is first created. For all consecutive updates, it can be empty/omitted and keeps the existing value if it is empty/omitted. PrivateKey isn't returned when importing this resource.
- AppleTeam stringId 
- The Team ID associated with your Apple developer account
- ClientId string
- Unique identifier issued by AS for the Okta IdP instance.
- ClientSecret string
- Client secret issued by AS for the Okta IdP instance.
- DeprovisionedAction string
- Action for a previously deprovisioned IdP user during authentication. Can be NONEorREACTIVATE. Default:NONE
- GroupsAction string
- Provisioning action for IdP user's group memberships. It can be NONE,SYNC,APPEND, orASSIGN. Default:NONE
- GroupsAssignments []string
- List of Okta Group IDs to add an IdP user as a member with the ASSIGNgroups_action.
- GroupsAttribute string
- IdP user profile attribute name (case-insensitive) for an array value that contains group memberships.
- GroupsFilters []string
- Whitelist of Okta Group identifiers that are allowed for the APPENDorSYNCgroups_action.
- IssuerMode string
- Indicates whether Okta uses the original Okta org domain URL, or a custom domain URL. It can be ORG_URLorCUSTOM_URL. Default:ORG_URL
- MaxClock intSkew 
- Maximum allowable clock-skew when processing messages from the IdP.
- Name string
- Name of the IdP
- ProfileMaster bool
- Determines if the IdP should act as a source of truth for user profile attributes.
- ProtocolType string
- The type of protocol to use. It can be OIDCorOAUTH2. Default:OAUTH2
- ProvisioningAction string
- Provisioning action for an IdP user during authentication. Default: AUTO
- Status string
- Default to ACTIVE
- SubjectMatch stringAttribute 
- Okta user profile attribute for matching transformed IdP username. Only for matchType CUSTOM_ATTRIBUTE.
- SubjectMatch stringType 
- Determines the Okta user profile attribute match conditions for account linking and authentication of the transformed IdP username. By default, it is set to USERNAME. It can be set toUSERNAME,EMAIL,USERNAME_OR_EMAILorCUSTOM_ATTRIBUTE.
- SuspendedAction string
- Action for a previously suspended IdP user during authentication. Can be NONEorREACTIVATE. Default:NONE
- UsernameTemplate string
- Okta EL Expression to generate or transform a unique username for the IdP user. Default: idpuser.email
- scopes List<String>
- The scopes of the IdP.
- type String
- Identity Provider Types: https://developer.okta.com/docs/reference/api/idps/#identity-provider-type
- accountLink StringAction 
- Specifies the account linking action for an IdP user. Default: AUTO
- accountLink List<String>Group Includes 
- Group memberships to determine link candidates.
- appleKid String
- The Key ID that you obtained from Apple when you created the private key for the client
- applePrivate StringKey 
- The Key ID that you obtained from Apple when you created the private key for the client. PrivateKey is required when resource is first created. For all consecutive updates, it can be empty/omitted and keeps the existing value if it is empty/omitted. PrivateKey isn't returned when importing this resource.
- appleTeam StringId 
- The Team ID associated with your Apple developer account
- clientId String
- Unique identifier issued by AS for the Okta IdP instance.
- clientSecret String
- Client secret issued by AS for the Okta IdP instance.
- deprovisionedAction String
- Action for a previously deprovisioned IdP user during authentication. Can be NONEorREACTIVATE. Default:NONE
- groupsAction String
- Provisioning action for IdP user's group memberships. It can be NONE,SYNC,APPEND, orASSIGN. Default:NONE
- groupsAssignments List<String>
- List of Okta Group IDs to add an IdP user as a member with the ASSIGNgroups_action.
- groupsAttribute String
- IdP user profile attribute name (case-insensitive) for an array value that contains group memberships.
- groupsFilters List<String>
- Whitelist of Okta Group identifiers that are allowed for the APPENDorSYNCgroups_action.
- issuerMode String
- Indicates whether Okta uses the original Okta org domain URL, or a custom domain URL. It can be ORG_URLorCUSTOM_URL. Default:ORG_URL
- maxClock IntegerSkew 
- Maximum allowable clock-skew when processing messages from the IdP.
- name String
- Name of the IdP
- profileMaster Boolean
- Determines if the IdP should act as a source of truth for user profile attributes.
- protocolType String
- The type of protocol to use. It can be OIDCorOAUTH2. Default:OAUTH2
- provisioningAction String
- Provisioning action for an IdP user during authentication. Default: AUTO
- status String
- Default to ACTIVE
- subjectMatch StringAttribute 
- Okta user profile attribute for matching transformed IdP username. Only for matchType CUSTOM_ATTRIBUTE.
- subjectMatch StringType 
- Determines the Okta user profile attribute match conditions for account linking and authentication of the transformed IdP username. By default, it is set to USERNAME. It can be set toUSERNAME,EMAIL,USERNAME_OR_EMAILorCUSTOM_ATTRIBUTE.
- suspendedAction String
- Action for a previously suspended IdP user during authentication. Can be NONEorREACTIVATE. Default:NONE
- usernameTemplate String
- Okta EL Expression to generate or transform a unique username for the IdP user. Default: idpuser.email
- scopes string[]
- The scopes of the IdP.
- type string
- Identity Provider Types: https://developer.okta.com/docs/reference/api/idps/#identity-provider-type
- accountLink stringAction 
- Specifies the account linking action for an IdP user. Default: AUTO
- accountLink string[]Group Includes 
- Group memberships to determine link candidates.
- appleKid string
- The Key ID that you obtained from Apple when you created the private key for the client
- applePrivate stringKey 
- The Key ID that you obtained from Apple when you created the private key for the client. PrivateKey is required when resource is first created. For all consecutive updates, it can be empty/omitted and keeps the existing value if it is empty/omitted. PrivateKey isn't returned when importing this resource.
- appleTeam stringId 
- The Team ID associated with your Apple developer account
- clientId string
- Unique identifier issued by AS for the Okta IdP instance.
- clientSecret string
- Client secret issued by AS for the Okta IdP instance.
- deprovisionedAction string
- Action for a previously deprovisioned IdP user during authentication. Can be NONEorREACTIVATE. Default:NONE
- groupsAction string
- Provisioning action for IdP user's group memberships. It can be NONE,SYNC,APPEND, orASSIGN. Default:NONE
- groupsAssignments string[]
- List of Okta Group IDs to add an IdP user as a member with the ASSIGNgroups_action.
- groupsAttribute string
- IdP user profile attribute name (case-insensitive) for an array value that contains group memberships.
- groupsFilters string[]
- Whitelist of Okta Group identifiers that are allowed for the APPENDorSYNCgroups_action.
- issuerMode string
- Indicates whether Okta uses the original Okta org domain URL, or a custom domain URL. It can be ORG_URLorCUSTOM_URL. Default:ORG_URL
- maxClock numberSkew 
- Maximum allowable clock-skew when processing messages from the IdP.
- name string
- Name of the IdP
- profileMaster boolean
- Determines if the IdP should act as a source of truth for user profile attributes.
- protocolType string
- The type of protocol to use. It can be OIDCorOAUTH2. Default:OAUTH2
- provisioningAction string
- Provisioning action for an IdP user during authentication. Default: AUTO
- status string
- Default to ACTIVE
- subjectMatch stringAttribute 
- Okta user profile attribute for matching transformed IdP username. Only for matchType CUSTOM_ATTRIBUTE.
- subjectMatch stringType 
- Determines the Okta user profile attribute match conditions for account linking and authentication of the transformed IdP username. By default, it is set to USERNAME. It can be set toUSERNAME,EMAIL,USERNAME_OR_EMAILorCUSTOM_ATTRIBUTE.
- suspendedAction string
- Action for a previously suspended IdP user during authentication. Can be NONEorREACTIVATE. Default:NONE
- usernameTemplate string
- Okta EL Expression to generate or transform a unique username for the IdP user. Default: idpuser.email
- scopes Sequence[str]
- The scopes of the IdP.
- type str
- Identity Provider Types: https://developer.okta.com/docs/reference/api/idps/#identity-provider-type
- account_link_ straction 
- Specifies the account linking action for an IdP user. Default: AUTO
- account_link_ Sequence[str]group_ includes 
- Group memberships to determine link candidates.
- apple_kid str
- The Key ID that you obtained from Apple when you created the private key for the client
- apple_private_ strkey 
- The Key ID that you obtained from Apple when you created the private key for the client. PrivateKey is required when resource is first created. For all consecutive updates, it can be empty/omitted and keeps the existing value if it is empty/omitted. PrivateKey isn't returned when importing this resource.
- apple_team_ strid 
- The Team ID associated with your Apple developer account
- 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. Can be NONEorREACTIVATE. Default:NONE
- groups_action str
- Provisioning action for IdP user's group memberships. It can be NONE,SYNC,APPEND, orASSIGN. Default:NONE
- groups_assignments Sequence[str]
- List of Okta Group IDs to add an IdP user as a member with the ASSIGNgroups_action.
- groups_attribute str
- IdP user profile attribute name (case-insensitive) for an array value that contains group memberships.
- groups_filters Sequence[str]
- Whitelist of Okta Group identifiers that are allowed for the APPENDorSYNCgroups_action.
- issuer_mode str
- Indicates whether Okta uses the original Okta org domain URL, or a custom domain URL. It can be ORG_URLorCUSTOM_URL. Default:ORG_URL
- max_clock_ intskew 
- Maximum allowable clock-skew when processing messages from the IdP.
- name str
- Name of 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. It can be OIDCorOAUTH2. Default:OAUTH2
- provisioning_action str
- Provisioning action for an IdP user during authentication. Default: AUTO
- status str
- Default to ACTIVE
- subject_match_ strattribute 
- Okta user profile attribute for matching transformed IdP username. Only for matchType CUSTOM_ATTRIBUTE.
- subject_match_ strtype 
- Determines the Okta user profile attribute match conditions for account linking and authentication of the transformed IdP username. By default, it is set to USERNAME. It can be set toUSERNAME,EMAIL,USERNAME_OR_EMAILorCUSTOM_ATTRIBUTE.
- suspended_action str
- Action for a previously suspended IdP user during authentication. Can be NONEorREACTIVATE. Default:NONE
- username_template str
- Okta EL Expression to generate or transform a unique username for the IdP user. Default: idpuser.email
- scopes List<String>
- The scopes of the IdP.
- type String
- Identity Provider Types: https://developer.okta.com/docs/reference/api/idps/#identity-provider-type
- accountLink StringAction 
- Specifies the account linking action for an IdP user. Default: AUTO
- accountLink List<String>Group Includes 
- Group memberships to determine link candidates.
- appleKid String
- The Key ID that you obtained from Apple when you created the private key for the client
- applePrivate StringKey 
- The Key ID that you obtained from Apple when you created the private key for the client. PrivateKey is required when resource is first created. For all consecutive updates, it can be empty/omitted and keeps the existing value if it is empty/omitted. PrivateKey isn't returned when importing this resource.
- appleTeam StringId 
- The Team ID associated with your Apple developer account
- clientId String
- Unique identifier issued by AS for the Okta IdP instance.
- clientSecret String
- Client secret issued by AS for the Okta IdP instance.
- deprovisionedAction String
- Action for a previously deprovisioned IdP user during authentication. Can be NONEorREACTIVATE. Default:NONE
- groupsAction String
- Provisioning action for IdP user's group memberships. It can be NONE,SYNC,APPEND, orASSIGN. Default:NONE
- groupsAssignments List<String>
- List of Okta Group IDs to add an IdP user as a member with the ASSIGNgroups_action.
- groupsAttribute String
- IdP user profile attribute name (case-insensitive) for an array value that contains group memberships.
- groupsFilters List<String>
- Whitelist of Okta Group identifiers that are allowed for the APPENDorSYNCgroups_action.
- issuerMode String
- Indicates whether Okta uses the original Okta org domain URL, or a custom domain URL. It can be ORG_URLorCUSTOM_URL. Default:ORG_URL
- maxClock NumberSkew 
- Maximum allowable clock-skew when processing messages from the IdP.
- name String
- Name of the IdP
- profileMaster Boolean
- Determines if the IdP should act as a source of truth for user profile attributes.
- protocolType String
- The type of protocol to use. It can be OIDCorOAUTH2. Default:OAUTH2
- provisioningAction String
- Provisioning action for an IdP user during authentication. Default: AUTO
- status String
- Default to ACTIVE
- subjectMatch StringAttribute 
- Okta user profile attribute for matching transformed IdP username. Only for matchType CUSTOM_ATTRIBUTE.
- subjectMatch StringType 
- Determines the Okta user profile attribute match conditions for account linking and authentication of the transformed IdP username. By default, it is set to USERNAME. It can be set toUSERNAME,EMAIL,USERNAME_OR_EMAILorCUSTOM_ATTRIBUTE.
- suspendedAction String
- Action for a previously suspended IdP user during authentication. Can be NONEorREACTIVATE. Default:NONE
- usernameTemplate String
- Okta EL Expression to generate or transform a unique username for the IdP user. Default: idpuser.email
Outputs
All input properties are implicitly available as output properties. Additionally, the Social resource produces the following output properties:
- string
- The method of making an authorization request. It can be set to HTTP-POSTorHTTP-REDIRECT.
- string
- IdP Authorization Server (AS) endpoint to request consent from the user and obtain an authorization code grant.
- Id string
- The provider-assigned unique ID for this managed resource.
- TokenBinding string
- The method of making a token request. It can be set to HTTP-POSTorHTTP-REDIRECT.
- TokenUrl string
- IdP Authorization Server (AS) endpoint to exchange the authorization code grant for an access token.
- TrustAudience string
- Trust audience for the Okta IdP instance.
- TrustIssuer string
- Trust issuer for the Okta IdP instance.
- TrustKid string
- Trust kid for the Okta IdP instance.
- TrustRevocation string
- Trust revocation for the Okta IdP instance.
- TrustRevocation intCache Lifetime 
- Trust revocation cache lifetime for the Okta IdP instance.
- string
- The method of making an authorization request. It can be set to HTTP-POSTorHTTP-REDIRECT.
- string
- IdP Authorization Server (AS) endpoint to request consent from the user and obtain an authorization code grant.
- Id string
- The provider-assigned unique ID for this managed resource.
- TokenBinding string
- The method of making a token request. It can be set to HTTP-POSTorHTTP-REDIRECT.
- TokenUrl string
- IdP Authorization Server (AS) endpoint to exchange the authorization code grant for an access token.
- TrustAudience string
- Trust audience for the Okta IdP instance.
- TrustIssuer string
- Trust issuer for the Okta IdP instance.
- TrustKid string
- Trust kid for the Okta IdP instance.
- TrustRevocation string
- Trust revocation for the Okta IdP instance.
- TrustRevocation intCache Lifetime 
- Trust revocation cache lifetime for the Okta IdP instance.
- String
- The method of making an authorization request. It can be set to HTTP-POSTorHTTP-REDIRECT.
- String
- IdP Authorization Server (AS) endpoint to request consent from the user and obtain an authorization code grant.
- id String
- The provider-assigned unique ID for this managed resource.
- tokenBinding String
- The method of making a token request. It can be set to HTTP-POSTorHTTP-REDIRECT.
- tokenUrl String
- IdP Authorization Server (AS) endpoint to exchange the authorization code grant for an access token.
- trustAudience String
- Trust audience for the Okta IdP instance.
- trustIssuer String
- Trust issuer for the Okta IdP instance.
- trustKid String
- Trust kid for the Okta IdP instance.
- trustRevocation String
- Trust revocation for the Okta IdP instance.
- trustRevocation IntegerCache Lifetime 
- Trust revocation cache lifetime for the Okta IdP instance.
- string
- The method of making an authorization request. It can be set to HTTP-POSTorHTTP-REDIRECT.
- string
- IdP Authorization Server (AS) endpoint to request consent from the user and obtain an authorization code grant.
- id string
- The provider-assigned unique ID for this managed resource.
- tokenBinding string
- The method of making a token request. It can be set to HTTP-POSTorHTTP-REDIRECT.
- tokenUrl string
- IdP Authorization Server (AS) endpoint to exchange the authorization code grant for an access token.
- trustAudience string
- Trust audience for the Okta IdP instance.
- trustIssuer string
- Trust issuer for the Okta IdP instance.
- trustKid string
- Trust kid for the Okta IdP instance.
- trustRevocation string
- Trust revocation for the Okta IdP instance.
- trustRevocation numberCache Lifetime 
- Trust revocation cache lifetime for the Okta IdP instance.
- str
- The method of making an authorization request. It can be set to HTTP-POSTorHTTP-REDIRECT.
- str
- IdP Authorization Server (AS) endpoint to request consent from the user and obtain an authorization code grant.
- id str
- The provider-assigned unique ID for this managed resource.
- token_binding str
- The method of making a token request. It can be set to HTTP-POSTorHTTP-REDIRECT.
- token_url str
- IdP Authorization Server (AS) endpoint to exchange the authorization code grant for an access token.
- trust_audience str
- Trust audience for the Okta IdP instance.
- trust_issuer str
- Trust issuer for the Okta IdP instance.
- trust_kid str
- Trust kid for the Okta IdP instance.
- trust_revocation str
- Trust revocation for the Okta IdP instance.
- trust_revocation_ intcache_ lifetime 
- Trust revocation cache lifetime for the Okta IdP instance.
- String
- The method of making an authorization request. It can be set to HTTP-POSTorHTTP-REDIRECT.
- String
- IdP Authorization Server (AS) endpoint to request consent from the user and obtain an authorization code grant.
- id String
- The provider-assigned unique ID for this managed resource.
- tokenBinding String
- The method of making a token request. It can be set to HTTP-POSTorHTTP-REDIRECT.
- tokenUrl String
- IdP Authorization Server (AS) endpoint to exchange the authorization code grant for an access token.
- trustAudience String
- Trust audience for the Okta IdP instance.
- trustIssuer String
- Trust issuer for the Okta IdP instance.
- trustKid String
- Trust kid for the Okta IdP instance.
- trustRevocation String
- Trust revocation for the Okta IdP instance.
- trustRevocation NumberCache Lifetime 
- Trust revocation cache lifetime for the Okta IdP instance.
Look up Existing Social Resource
Get an existing Social resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: SocialState, opts?: CustomResourceOptions): Social@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_link_action: Optional[str] = None,
        account_link_group_includes: Optional[Sequence[str]] = None,
        apple_kid: Optional[str] = None,
        apple_private_key: Optional[str] = None,
        apple_team_id: Optional[str] = None,
        authorization_binding: Optional[str] = None,
        authorization_url: Optional[str] = None,
        client_id: Optional[str] = None,
        client_secret: Optional[str] = None,
        deprovisioned_action: Optional[str] = None,
        groups_action: Optional[str] = None,
        groups_assignments: Optional[Sequence[str]] = None,
        groups_attribute: Optional[str] = None,
        groups_filters: Optional[Sequence[str]] = None,
        issuer_mode: Optional[str] = None,
        max_clock_skew: Optional[int] = None,
        name: Optional[str] = None,
        profile_master: Optional[bool] = None,
        protocol_type: Optional[str] = None,
        provisioning_action: Optional[str] = None,
        scopes: Optional[Sequence[str]] = None,
        status: Optional[str] = None,
        subject_match_attribute: Optional[str] = None,
        subject_match_type: Optional[str] = None,
        suspended_action: Optional[str] = None,
        token_binding: Optional[str] = None,
        token_url: Optional[str] = None,
        trust_audience: Optional[str] = None,
        trust_issuer: Optional[str] = None,
        trust_kid: Optional[str] = None,
        trust_revocation: Optional[str] = None,
        trust_revocation_cache_lifetime: Optional[int] = None,
        type: Optional[str] = None,
        username_template: Optional[str] = None) -> Socialfunc GetSocial(ctx *Context, name string, id IDInput, state *SocialState, opts ...ResourceOption) (*Social, error)public static Social Get(string name, Input<string> id, SocialState? state, CustomResourceOptions? opts = null)public static Social get(String name, Output<String> id, SocialState state, CustomResourceOptions options)resources:  _:    type: okta:idp:Social    get:      id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- AccountLink stringAction 
- Specifies the account linking action for an IdP user. Default: AUTO
- AccountLink List<string>Group Includes 
- Group memberships to determine link candidates.
- AppleKid string
- The Key ID that you obtained from Apple when you created the private key for the client
- ApplePrivate stringKey 
- The Key ID that you obtained from Apple when you created the private key for the client. PrivateKey is required when resource is first created. For all consecutive updates, it can be empty/omitted and keeps the existing value if it is empty/omitted. PrivateKey isn't returned when importing this resource.
- AppleTeam stringId 
- The Team ID associated with your Apple developer account
- string
- The method of making an authorization request. It can be set to HTTP-POSTorHTTP-REDIRECT.
- string
- IdP Authorization Server (AS) endpoint to request consent from the user and obtain an authorization code grant.
- ClientId string
- Unique identifier issued by AS for the Okta IdP instance.
- ClientSecret string
- Client secret issued by AS for the Okta IdP instance.
- DeprovisionedAction string
- Action for a previously deprovisioned IdP user during authentication. Can be NONEorREACTIVATE. Default:NONE
- GroupsAction string
- Provisioning action for IdP user's group memberships. It can be NONE,SYNC,APPEND, orASSIGN. Default:NONE
- GroupsAssignments List<string>
- List of Okta Group IDs to add an IdP user as a member with the ASSIGNgroups_action.
- GroupsAttribute string
- IdP user profile attribute name (case-insensitive) for an array value that contains group memberships.
- GroupsFilters List<string>
- Whitelist of Okta Group identifiers that are allowed for the APPENDorSYNCgroups_action.
- IssuerMode string
- Indicates whether Okta uses the original Okta org domain URL, or a custom domain URL. It can be ORG_URLorCUSTOM_URL. Default:ORG_URL
- MaxClock intSkew 
- Maximum allowable clock-skew when processing messages from the IdP.
- Name string
- Name of the IdP
- ProfileMaster bool
- Determines if the IdP should act as a source of truth for user profile attributes.
- ProtocolType string
- The type of protocol to use. It can be OIDCorOAUTH2. Default:OAUTH2
- ProvisioningAction string
- Provisioning action for an IdP user during authentication. Default: AUTO
- Scopes List<string>
- The scopes of the IdP.
- Status string
- Default to ACTIVE
- SubjectMatch stringAttribute 
- Okta user profile attribute for matching transformed IdP username. Only for matchType CUSTOM_ATTRIBUTE.
- SubjectMatch stringType 
- Determines the Okta user profile attribute match conditions for account linking and authentication of the transformed IdP username. By default, it is set to USERNAME. It can be set toUSERNAME,EMAIL,USERNAME_OR_EMAILorCUSTOM_ATTRIBUTE.
- SuspendedAction string
- Action for a previously suspended IdP user during authentication. Can be NONEorREACTIVATE. Default:NONE
- TokenBinding string
- The method of making a token request. It can be set to HTTP-POSTorHTTP-REDIRECT.
- TokenUrl string
- IdP Authorization Server (AS) endpoint to exchange the authorization code grant for an access token.
- TrustAudience string
- Trust audience for the Okta IdP instance.
- TrustIssuer string
- Trust issuer for the Okta IdP instance.
- TrustKid string
- Trust kid for the Okta IdP instance.
- TrustRevocation string
- Trust revocation for the Okta IdP instance.
- TrustRevocation intCache Lifetime 
- Trust revocation cache lifetime for the Okta IdP instance.
- Type string
- Identity Provider Types: https://developer.okta.com/docs/reference/api/idps/#identity-provider-type
- UsernameTemplate string
- Okta EL Expression to generate or transform a unique username for the IdP user. Default: idpuser.email
- AccountLink stringAction 
- Specifies the account linking action for an IdP user. Default: AUTO
- AccountLink []stringGroup Includes 
- Group memberships to determine link candidates.
- AppleKid string
- The Key ID that you obtained from Apple when you created the private key for the client
- ApplePrivate stringKey 
- The Key ID that you obtained from Apple when you created the private key for the client. PrivateKey is required when resource is first created. For all consecutive updates, it can be empty/omitted and keeps the existing value if it is empty/omitted. PrivateKey isn't returned when importing this resource.
- AppleTeam stringId 
- The Team ID associated with your Apple developer account
- string
- The method of making an authorization request. It can be set to HTTP-POSTorHTTP-REDIRECT.
- string
- IdP Authorization Server (AS) endpoint to request consent from the user and obtain an authorization code grant.
- ClientId string
- Unique identifier issued by AS for the Okta IdP instance.
- ClientSecret string
- Client secret issued by AS for the Okta IdP instance.
- DeprovisionedAction string
- Action for a previously deprovisioned IdP user during authentication. Can be NONEorREACTIVATE. Default:NONE
- GroupsAction string
- Provisioning action for IdP user's group memberships. It can be NONE,SYNC,APPEND, orASSIGN. Default:NONE
- GroupsAssignments []string
- List of Okta Group IDs to add an IdP user as a member with the ASSIGNgroups_action.
- GroupsAttribute string
- IdP user profile attribute name (case-insensitive) for an array value that contains group memberships.
- GroupsFilters []string
- Whitelist of Okta Group identifiers that are allowed for the APPENDorSYNCgroups_action.
- IssuerMode string
- Indicates whether Okta uses the original Okta org domain URL, or a custom domain URL. It can be ORG_URLorCUSTOM_URL. Default:ORG_URL
- MaxClock intSkew 
- Maximum allowable clock-skew when processing messages from the IdP.
- Name string
- Name of the IdP
- ProfileMaster bool
- Determines if the IdP should act as a source of truth for user profile attributes.
- ProtocolType string
- The type of protocol to use. It can be OIDCorOAUTH2. Default:OAUTH2
- ProvisioningAction string
- Provisioning action for an IdP user during authentication. Default: AUTO
- Scopes []string
- The scopes of the IdP.
- Status string
- Default to ACTIVE
- SubjectMatch stringAttribute 
- Okta user profile attribute for matching transformed IdP username. Only for matchType CUSTOM_ATTRIBUTE.
- SubjectMatch stringType 
- Determines the Okta user profile attribute match conditions for account linking and authentication of the transformed IdP username. By default, it is set to USERNAME. It can be set toUSERNAME,EMAIL,USERNAME_OR_EMAILorCUSTOM_ATTRIBUTE.
- SuspendedAction string
- Action for a previously suspended IdP user during authentication. Can be NONEorREACTIVATE. Default:NONE
- TokenBinding string
- The method of making a token request. It can be set to HTTP-POSTorHTTP-REDIRECT.
- TokenUrl string
- IdP Authorization Server (AS) endpoint to exchange the authorization code grant for an access token.
- TrustAudience string
- Trust audience for the Okta IdP instance.
- TrustIssuer string
- Trust issuer for the Okta IdP instance.
- TrustKid string
- Trust kid for the Okta IdP instance.
- TrustRevocation string
- Trust revocation for the Okta IdP instance.
- TrustRevocation intCache Lifetime 
- Trust revocation cache lifetime for the Okta IdP instance.
- Type string
- Identity Provider Types: https://developer.okta.com/docs/reference/api/idps/#identity-provider-type
- UsernameTemplate string
- Okta EL Expression to generate or transform a unique username for the IdP user. Default: idpuser.email
- accountLink StringAction 
- Specifies the account linking action for an IdP user. Default: AUTO
- accountLink List<String>Group Includes 
- Group memberships to determine link candidates.
- appleKid String
- The Key ID that you obtained from Apple when you created the private key for the client
- applePrivate StringKey 
- The Key ID that you obtained from Apple when you created the private key for the client. PrivateKey is required when resource is first created. For all consecutive updates, it can be empty/omitted and keeps the existing value if it is empty/omitted. PrivateKey isn't returned when importing this resource.
- appleTeam StringId 
- The Team ID associated with your Apple developer account
- String
- The method of making an authorization request. It can be set to HTTP-POSTorHTTP-REDIRECT.
- String
- IdP Authorization Server (AS) endpoint to request consent from the user and obtain an authorization code grant.
- clientId String
- Unique identifier issued by AS for the Okta IdP instance.
- clientSecret String
- Client secret issued by AS for the Okta IdP instance.
- deprovisionedAction String
- Action for a previously deprovisioned IdP user during authentication. Can be NONEorREACTIVATE. Default:NONE
- groupsAction String
- Provisioning action for IdP user's group memberships. It can be NONE,SYNC,APPEND, orASSIGN. Default:NONE
- groupsAssignments List<String>
- List of Okta Group IDs to add an IdP user as a member with the ASSIGNgroups_action.
- groupsAttribute String
- IdP user profile attribute name (case-insensitive) for an array value that contains group memberships.
- groupsFilters List<String>
- Whitelist of Okta Group identifiers that are allowed for the APPENDorSYNCgroups_action.
- issuerMode String
- Indicates whether Okta uses the original Okta org domain URL, or a custom domain URL. It can be ORG_URLorCUSTOM_URL. Default:ORG_URL
- maxClock IntegerSkew 
- Maximum allowable clock-skew when processing messages from the IdP.
- name String
- Name of the IdP
- profileMaster Boolean
- Determines if the IdP should act as a source of truth for user profile attributes.
- protocolType String
- The type of protocol to use. It can be OIDCorOAUTH2. Default:OAUTH2
- provisioningAction String
- Provisioning action for an IdP user during authentication. Default: AUTO
- scopes List<String>
- The scopes of the IdP.
- status String
- Default to ACTIVE
- subjectMatch StringAttribute 
- Okta user profile attribute for matching transformed IdP username. Only for matchType CUSTOM_ATTRIBUTE.
- subjectMatch StringType 
- Determines the Okta user profile attribute match conditions for account linking and authentication of the transformed IdP username. By default, it is set to USERNAME. It can be set toUSERNAME,EMAIL,USERNAME_OR_EMAILorCUSTOM_ATTRIBUTE.
- suspendedAction String
- Action for a previously suspended IdP user during authentication. Can be NONEorREACTIVATE. Default:NONE
- tokenBinding String
- The method of making a token request. It can be set to HTTP-POSTorHTTP-REDIRECT.
- tokenUrl String
- IdP Authorization Server (AS) endpoint to exchange the authorization code grant for an access token.
- trustAudience String
- Trust audience for the Okta IdP instance.
- trustIssuer String
- Trust issuer for the Okta IdP instance.
- trustKid String
- Trust kid for the Okta IdP instance.
- trustRevocation String
- Trust revocation for the Okta IdP instance.
- trustRevocation IntegerCache Lifetime 
- Trust revocation cache lifetime for the Okta IdP instance.
- type String
- Identity Provider Types: https://developer.okta.com/docs/reference/api/idps/#identity-provider-type
- usernameTemplate String
- Okta EL Expression to generate or transform a unique username for the IdP user. Default: idpuser.email
- accountLink stringAction 
- Specifies the account linking action for an IdP user. Default: AUTO
- accountLink string[]Group Includes 
- Group memberships to determine link candidates.
- appleKid string
- The Key ID that you obtained from Apple when you created the private key for the client
- applePrivate stringKey 
- The Key ID that you obtained from Apple when you created the private key for the client. PrivateKey is required when resource is first created. For all consecutive updates, it can be empty/omitted and keeps the existing value if it is empty/omitted. PrivateKey isn't returned when importing this resource.
- appleTeam stringId 
- The Team ID associated with your Apple developer account
- string
- The method of making an authorization request. It can be set to HTTP-POSTorHTTP-REDIRECT.
- string
- IdP Authorization Server (AS) endpoint to request consent from the user and obtain an authorization code grant.
- clientId string
- Unique identifier issued by AS for the Okta IdP instance.
- clientSecret string
- Client secret issued by AS for the Okta IdP instance.
- deprovisionedAction string
- Action for a previously deprovisioned IdP user during authentication. Can be NONEorREACTIVATE. Default:NONE
- groupsAction string
- Provisioning action for IdP user's group memberships. It can be NONE,SYNC,APPEND, orASSIGN. Default:NONE
- groupsAssignments string[]
- List of Okta Group IDs to add an IdP user as a member with the ASSIGNgroups_action.
- groupsAttribute string
- IdP user profile attribute name (case-insensitive) for an array value that contains group memberships.
- groupsFilters string[]
- Whitelist of Okta Group identifiers that are allowed for the APPENDorSYNCgroups_action.
- issuerMode string
- Indicates whether Okta uses the original Okta org domain URL, or a custom domain URL. It can be ORG_URLorCUSTOM_URL. Default:ORG_URL
- maxClock numberSkew 
- Maximum allowable clock-skew when processing messages from the IdP.
- name string
- Name of the IdP
- profileMaster boolean
- Determines if the IdP should act as a source of truth for user profile attributes.
- protocolType string
- The type of protocol to use. It can be OIDCorOAUTH2. Default:OAUTH2
- provisioningAction string
- Provisioning action for an IdP user during authentication. Default: AUTO
- scopes string[]
- The scopes of the IdP.
- status string
- Default to ACTIVE
- subjectMatch stringAttribute 
- Okta user profile attribute for matching transformed IdP username. Only for matchType CUSTOM_ATTRIBUTE.
- subjectMatch stringType 
- Determines the Okta user profile attribute match conditions for account linking and authentication of the transformed IdP username. By default, it is set to USERNAME. It can be set toUSERNAME,EMAIL,USERNAME_OR_EMAILorCUSTOM_ATTRIBUTE.
- suspendedAction string
- Action for a previously suspended IdP user during authentication. Can be NONEorREACTIVATE. Default:NONE
- tokenBinding string
- The method of making a token request. It can be set to HTTP-POSTorHTTP-REDIRECT.
- tokenUrl string
- IdP Authorization Server (AS) endpoint to exchange the authorization code grant for an access token.
- trustAudience string
- Trust audience for the Okta IdP instance.
- trustIssuer string
- Trust issuer for the Okta IdP instance.
- trustKid string
- Trust kid for the Okta IdP instance.
- trustRevocation string
- Trust revocation for the Okta IdP instance.
- trustRevocation numberCache Lifetime 
- Trust revocation cache lifetime for the Okta IdP instance.
- type string
- Identity Provider Types: https://developer.okta.com/docs/reference/api/idps/#identity-provider-type
- usernameTemplate string
- Okta EL Expression to generate or transform a unique username for the IdP user. Default: idpuser.email
- account_link_ straction 
- Specifies the account linking action for an IdP user. Default: AUTO
- account_link_ Sequence[str]group_ includes 
- Group memberships to determine link candidates.
- apple_kid str
- The Key ID that you obtained from Apple when you created the private key for the client
- apple_private_ strkey 
- The Key ID that you obtained from Apple when you created the private key for the client. PrivateKey is required when resource is first created. For all consecutive updates, it can be empty/omitted and keeps the existing value if it is empty/omitted. PrivateKey isn't returned when importing this resource.
- apple_team_ strid 
- The Team ID associated with your Apple developer account
- str
- The method of making an authorization request. It can be set to HTTP-POSTorHTTP-REDIRECT.
- 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. Can be NONEorREACTIVATE. Default:NONE
- groups_action str
- Provisioning action for IdP user's group memberships. It can be NONE,SYNC,APPEND, orASSIGN. Default:NONE
- groups_assignments Sequence[str]
- List of Okta Group IDs to add an IdP user as a member with the ASSIGNgroups_action.
- groups_attribute str
- IdP user profile attribute name (case-insensitive) for an array value that contains group memberships.
- groups_filters Sequence[str]
- Whitelist of Okta Group identifiers that are allowed for the APPENDorSYNCgroups_action.
- issuer_mode str
- Indicates whether Okta uses the original Okta org domain URL, or a custom domain URL. It can be ORG_URLorCUSTOM_URL. Default:ORG_URL
- max_clock_ intskew 
- Maximum allowable clock-skew when processing messages from the IdP.
- name str
- Name of 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. It can be OIDCorOAUTH2. Default:OAUTH2
- provisioning_action str
- Provisioning action for an IdP user during authentication. Default: AUTO
- scopes Sequence[str]
- The scopes of the IdP.
- status str
- Default to ACTIVE
- subject_match_ strattribute 
- Okta user profile attribute for matching transformed IdP username. Only for matchType CUSTOM_ATTRIBUTE.
- subject_match_ strtype 
- Determines the Okta user profile attribute match conditions for account linking and authentication of the transformed IdP username. By default, it is set to USERNAME. It can be set toUSERNAME,EMAIL,USERNAME_OR_EMAILorCUSTOM_ATTRIBUTE.
- suspended_action str
- Action for a previously suspended IdP user during authentication. Can be NONEorREACTIVATE. Default:NONE
- token_binding str
- The method of making a token request. It can be set to HTTP-POSTorHTTP-REDIRECT.
- token_url str
- IdP Authorization Server (AS) endpoint to exchange the authorization code grant for an access token.
- trust_audience str
- Trust audience for the Okta IdP instance.
- trust_issuer str
- Trust issuer for the Okta IdP instance.
- trust_kid str
- Trust kid for the Okta IdP instance.
- trust_revocation str
- Trust revocation for the Okta IdP instance.
- trust_revocation_ intcache_ lifetime 
- Trust revocation cache lifetime for the Okta IdP instance.
- type str
- Identity Provider Types: https://developer.okta.com/docs/reference/api/idps/#identity-provider-type
- username_template str
- Okta EL Expression to generate or transform a unique username for the IdP user. Default: idpuser.email
- accountLink StringAction 
- Specifies the account linking action for an IdP user. Default: AUTO
- accountLink List<String>Group Includes 
- Group memberships to determine link candidates.
- appleKid String
- The Key ID that you obtained from Apple when you created the private key for the client
- applePrivate StringKey 
- The Key ID that you obtained from Apple when you created the private key for the client. PrivateKey is required when resource is first created. For all consecutive updates, it can be empty/omitted and keeps the existing value if it is empty/omitted. PrivateKey isn't returned when importing this resource.
- appleTeam StringId 
- The Team ID associated with your Apple developer account
- String
- The method of making an authorization request. It can be set to HTTP-POSTorHTTP-REDIRECT.
- String
- IdP Authorization Server (AS) endpoint to request consent from the user and obtain an authorization code grant.
- clientId String
- Unique identifier issued by AS for the Okta IdP instance.
- clientSecret String
- Client secret issued by AS for the Okta IdP instance.
- deprovisionedAction String
- Action for a previously deprovisioned IdP user during authentication. Can be NONEorREACTIVATE. Default:NONE
- groupsAction String
- Provisioning action for IdP user's group memberships. It can be NONE,SYNC,APPEND, orASSIGN. Default:NONE
- groupsAssignments List<String>
- List of Okta Group IDs to add an IdP user as a member with the ASSIGNgroups_action.
- groupsAttribute String
- IdP user profile attribute name (case-insensitive) for an array value that contains group memberships.
- groupsFilters List<String>
- Whitelist of Okta Group identifiers that are allowed for the APPENDorSYNCgroups_action.
- issuerMode String
- Indicates whether Okta uses the original Okta org domain URL, or a custom domain URL. It can be ORG_URLorCUSTOM_URL. Default:ORG_URL
- maxClock NumberSkew 
- Maximum allowable clock-skew when processing messages from the IdP.
- name String
- Name of the IdP
- profileMaster Boolean
- Determines if the IdP should act as a source of truth for user profile attributes.
- protocolType String
- The type of protocol to use. It can be OIDCorOAUTH2. Default:OAUTH2
- provisioningAction String
- Provisioning action for an IdP user during authentication. Default: AUTO
- scopes List<String>
- The scopes of the IdP.
- status String
- Default to ACTIVE
- subjectMatch StringAttribute 
- Okta user profile attribute for matching transformed IdP username. Only for matchType CUSTOM_ATTRIBUTE.
- subjectMatch StringType 
- Determines the Okta user profile attribute match conditions for account linking and authentication of the transformed IdP username. By default, it is set to USERNAME. It can be set toUSERNAME,EMAIL,USERNAME_OR_EMAILorCUSTOM_ATTRIBUTE.
- suspendedAction String
- Action for a previously suspended IdP user during authentication. Can be NONEorREACTIVATE. Default:NONE
- tokenBinding String
- The method of making a token request. It can be set to HTTP-POSTorHTTP-REDIRECT.
- tokenUrl String
- IdP Authorization Server (AS) endpoint to exchange the authorization code grant for an access token.
- trustAudience String
- Trust audience for the Okta IdP instance.
- trustIssuer String
- Trust issuer for the Okta IdP instance.
- trustKid String
- Trust kid for the Okta IdP instance.
- trustRevocation String
- Trust revocation for the Okta IdP instance.
- trustRevocation NumberCache Lifetime 
- Trust revocation cache lifetime for the Okta IdP instance.
- type String
- Identity Provider Types: https://developer.okta.com/docs/reference/api/idps/#identity-provider-type
- usernameTemplate String
- Okta EL Expression to generate or transform a unique username for the IdP user. Default: idpuser.email
Import
$ pulumi import okta:idp/social:Social example <idp_id>
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Okta pulumi/pulumi-okta
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the oktaTerraform Provider.