Manages Okta App Connection configurations for provisioning. This resource allows you to configure and manage provisioning connections for applications, including authentication schemes and connection activation/deactivation.
Example Usage
TOKEN Authentication
import * as pulumi from "@pulumi/pulumi";
import * as okta from "@pulumi/okta";
const tokenExample = new okta.app.Connection("token_example", {
idProperty: "0oa1234567890abcdef",
baseUrl: "https://api.example.com/scim/v2",
action: "activate",
profile: {
authScheme: "TOKEN",
token: "your-bearer-token-here",
},
});
import pulumi
import pulumi_okta as okta
token_example = okta.app.Connection("token_example",
id_property="0oa1234567890abcdef",
base_url="https://api.example.com/scim/v2",
action="activate",
profile={
"auth_scheme": "TOKEN",
"token": "your-bearer-token-here",
})
package main
import (
"github.com/pulumi/pulumi-okta/sdk/v6/go/okta/app"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := app.NewConnection(ctx, "token_example", &app.ConnectionArgs{
IdProperty: pulumi.String("0oa1234567890abcdef"),
BaseUrl: pulumi.String("https://api.example.com/scim/v2"),
Action: pulumi.String("activate"),
Profile: &app.ConnectionProfileArgs{
AuthScheme: pulumi.String("TOKEN"),
Token: pulumi.String("your-bearer-token-here"),
},
})
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 tokenExample = new Okta.App.Connection("token_example", new()
{
IdProperty = "0oa1234567890abcdef",
BaseUrl = "https://api.example.com/scim/v2",
Action = "activate",
Profile = new Okta.App.Inputs.ConnectionProfileArgs
{
AuthScheme = "TOKEN",
Token = "your-bearer-token-here",
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.okta.app.Connection;
import com.pulumi.okta.app.ConnectionArgs;
import com.pulumi.okta.app.inputs.ConnectionProfileArgs;
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 tokenExample = new Connection("tokenExample", ConnectionArgs.builder()
.idProperty("0oa1234567890abcdef")
.baseUrl("https://api.example.com/scim/v2")
.action("activate")
.profile(ConnectionProfileArgs.builder()
.authScheme("TOKEN")
.token("your-bearer-token-here")
.build())
.build());
}
}
resources:
tokenExample:
type: okta:app:Connection
name: token_example
properties:
idProperty: 0oa1234567890abcdef
baseUrl: https://api.example.com/scim/v2
action: activate
profile:
authScheme: TOKEN
token: your-bearer-token-here
OAUTH2 Authentication
import * as pulumi from "@pulumi/pulumi";
import * as okta from "@pulumi/okta";
const oauth2Example = new okta.app.Connection("oauth2_example", {
idProperty: "0oa1234567890abcdef",
action: "activate",
profile: {
authScheme: "OAUTH2",
clientId: "oauth2-client-id",
settings: {
adminUsername: "admin@example.com",
adminPassword: "secure-password",
},
signing: {
rotationMode: "MANUAL",
},
},
});
import pulumi
import pulumi_okta as okta
oauth2_example = okta.app.Connection("oauth2_example",
id_property="0oa1234567890abcdef",
action="activate",
profile={
"auth_scheme": "OAUTH2",
"client_id": "oauth2-client-id",
"settings": {
"admin_username": "admin@example.com",
"admin_password": "secure-password",
},
"signing": {
"rotation_mode": "MANUAL",
},
})
package main
import (
"github.com/pulumi/pulumi-okta/sdk/v6/go/okta/app"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := app.NewConnection(ctx, "oauth2_example", &app.ConnectionArgs{
IdProperty: pulumi.String("0oa1234567890abcdef"),
Action: pulumi.String("activate"),
Profile: &app.ConnectionProfileArgs{
AuthScheme: pulumi.String("OAUTH2"),
ClientId: pulumi.String("oauth2-client-id"),
Settings: &app.ConnectionProfileSettingsArgs{
AdminUsername: pulumi.String("admin@example.com"),
AdminPassword: pulumi.String("secure-password"),
},
Signing: &app.ConnectionProfileSigningArgs{
RotationMode: pulumi.String("MANUAL"),
},
},
})
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 oauth2Example = new Okta.App.Connection("oauth2_example", new()
{
IdProperty = "0oa1234567890abcdef",
Action = "activate",
Profile = new Okta.App.Inputs.ConnectionProfileArgs
{
AuthScheme = "OAUTH2",
ClientId = "oauth2-client-id",
Settings = new Okta.App.Inputs.ConnectionProfileSettingsArgs
{
AdminUsername = "admin@example.com",
AdminPassword = "secure-password",
},
Signing = new Okta.App.Inputs.ConnectionProfileSigningArgs
{
RotationMode = "MANUAL",
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.okta.app.Connection;
import com.pulumi.okta.app.ConnectionArgs;
import com.pulumi.okta.app.inputs.ConnectionProfileArgs;
import com.pulumi.okta.app.inputs.ConnectionProfileSettingsArgs;
import com.pulumi.okta.app.inputs.ConnectionProfileSigningArgs;
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 oauth2Example = new Connection("oauth2Example", ConnectionArgs.builder()
.idProperty("0oa1234567890abcdef")
.action("activate")
.profile(ConnectionProfileArgs.builder()
.authScheme("OAUTH2")
.clientId("oauth2-client-id")
.settings(ConnectionProfileSettingsArgs.builder()
.adminUsername("admin@example.com")
.adminPassword("secure-password")
.build())
.signing(ConnectionProfileSigningArgs.builder()
.rotationMode("MANUAL")
.build())
.build())
.build());
}
}
resources:
oauth2Example:
type: okta:app:Connection
name: oauth2_example
properties:
idProperty: 0oa1234567890abcdef
action: activate
profile:
authScheme: OAUTH2
clientId: oauth2-client-id
settings:
adminUsername: admin@example.com
adminPassword: secure-password
signing:
rotationMode: MANUAL
Deactivated Connection
import * as pulumi from "@pulumi/pulumi";
import * as okta from "@pulumi/okta";
const deactivatedExample = new okta.app.Connection("deactivated_example", {
idProperty: "0oa1234567890abcdef",
baseUrl: "https://api.example.com/scim/v2",
action: "deactivate",
profile: {
authScheme: "TOKEN",
token: "your-bearer-token-here",
},
});
import pulumi
import pulumi_okta as okta
deactivated_example = okta.app.Connection("deactivated_example",
id_property="0oa1234567890abcdef",
base_url="https://api.example.com/scim/v2",
action="deactivate",
profile={
"auth_scheme": "TOKEN",
"token": "your-bearer-token-here",
})
package main
import (
"github.com/pulumi/pulumi-okta/sdk/v6/go/okta/app"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := app.NewConnection(ctx, "deactivated_example", &app.ConnectionArgs{
IdProperty: pulumi.String("0oa1234567890abcdef"),
BaseUrl: pulumi.String("https://api.example.com/scim/v2"),
Action: pulumi.String("deactivate"),
Profile: &app.ConnectionProfileArgs{
AuthScheme: pulumi.String("TOKEN"),
Token: pulumi.String("your-bearer-token-here"),
},
})
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 deactivatedExample = new Okta.App.Connection("deactivated_example", new()
{
IdProperty = "0oa1234567890abcdef",
BaseUrl = "https://api.example.com/scim/v2",
Action = "deactivate",
Profile = new Okta.App.Inputs.ConnectionProfileArgs
{
AuthScheme = "TOKEN",
Token = "your-bearer-token-here",
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.okta.app.Connection;
import com.pulumi.okta.app.ConnectionArgs;
import com.pulumi.okta.app.inputs.ConnectionProfileArgs;
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 deactivatedExample = new Connection("deactivatedExample", ConnectionArgs.builder()
.idProperty("0oa1234567890abcdef")
.baseUrl("https://api.example.com/scim/v2")
.action("deactivate")
.profile(ConnectionProfileArgs.builder()
.authScheme("TOKEN")
.token("your-bearer-token-here")
.build())
.build());
}
}
resources:
deactivatedExample:
type: okta:app:Connection
name: deactivated_example
properties:
idProperty: 0oa1234567890abcdef
baseUrl: https://api.example.com/scim/v2
action: deactivate
profile:
authScheme: TOKEN
token: your-bearer-token-here
Create Connection Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Connection(name: string, args: ConnectionArgs, opts?: CustomResourceOptions);@overload
def Connection(resource_name: str,
args: ConnectionArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Connection(resource_name: str,
opts: Optional[ResourceOptions] = None,
action: Optional[str] = None,
base_url: Optional[str] = None,
id_property: Optional[str] = None,
profile: Optional[ConnectionProfileArgs] = None)func NewConnection(ctx *Context, name string, args ConnectionArgs, opts ...ResourceOption) (*Connection, error)public Connection(string name, ConnectionArgs args, CustomResourceOptions? opts = null)
public Connection(String name, ConnectionArgs args)
public Connection(String name, ConnectionArgs args, CustomResourceOptions options)
type: okta:app:Connection
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 ConnectionArgs
- 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 ConnectionArgs
- 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 ConnectionArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ConnectionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ConnectionArgs
- 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 connectionResource = new Okta.App.Connection("connectionResource", new()
{
Action = "string",
BaseUrl = "string",
IdProperty = "string",
Profile = new Okta.App.Inputs.ConnectionProfileArgs
{
AuthScheme = "string",
ClientId = "string",
Settings = new Okta.App.Inputs.ConnectionProfileSettingsArgs
{
AdminPassword = "string",
AdminUsername = "string",
},
Signing = new Okta.App.Inputs.ConnectionProfileSigningArgs
{
RotationMode = "string",
},
Token = "string",
},
});
example, err := app.NewConnection(ctx, "connectionResource", &app.ConnectionArgs{
Action: pulumi.String("string"),
BaseUrl: pulumi.String("string"),
IdProperty: pulumi.String("string"),
Profile: &app.ConnectionProfileArgs{
AuthScheme: pulumi.String("string"),
ClientId: pulumi.String("string"),
Settings: &app.ConnectionProfileSettingsArgs{
AdminPassword: pulumi.String("string"),
AdminUsername: pulumi.String("string"),
},
Signing: &app.ConnectionProfileSigningArgs{
RotationMode: pulumi.String("string"),
},
Token: pulumi.String("string"),
},
})
var connectionResource = new Connection("connectionResource", ConnectionArgs.builder()
.action("string")
.baseUrl("string")
.idProperty("string")
.profile(ConnectionProfileArgs.builder()
.authScheme("string")
.clientId("string")
.settings(ConnectionProfileSettingsArgs.builder()
.adminPassword("string")
.adminUsername("string")
.build())
.signing(ConnectionProfileSigningArgs.builder()
.rotationMode("string")
.build())
.token("string")
.build())
.build());
connection_resource = okta.app.Connection("connectionResource",
action="string",
base_url="string",
id_property="string",
profile={
"auth_scheme": "string",
"client_id": "string",
"settings": {
"admin_password": "string",
"admin_username": "string",
},
"signing": {
"rotation_mode": "string",
},
"token": "string",
})
const connectionResource = new okta.app.Connection("connectionResource", {
action: "string",
baseUrl: "string",
idProperty: "string",
profile: {
authScheme: "string",
clientId: "string",
settings: {
adminPassword: "string",
adminUsername: "string",
},
signing: {
rotationMode: "string",
},
token: "string",
},
});
type: okta:app:Connection
properties:
action: string
baseUrl: string
idProperty: string
profile:
authScheme: string
clientId: string
settings:
adminPassword: string
adminUsername: string
signing:
rotationMode: string
token: string
Connection 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 Connection resource accepts the following input properties:
- Action string
- The action to perform on the connection. Valid values are
activateordeactivate. - Base
Url string - The base URL for the provisioning connection.
- Id
Property string - The application ID.
- Profile
Connection
Profile - Profile configuration for the app connection.
- Action string
- The action to perform on the connection. Valid values are
activateordeactivate. - Base
Url string - The base URL for the provisioning connection.
- Id
Property string - The application ID.
- Profile
Connection
Profile Args - Profile configuration for the app connection.
- action String
- The action to perform on the connection. Valid values are
activateordeactivate. - base
Url String - The base URL for the provisioning connection.
- id
Property String - The application ID.
- profile
Connection
Profile - Profile configuration for the app connection.
- action string
- The action to perform on the connection. Valid values are
activateordeactivate. - base
Url string - The base URL for the provisioning connection.
- id
Property string - The application ID.
- profile
Connection
Profile - Profile configuration for the app connection.
- action str
- The action to perform on the connection. Valid values are
activateordeactivate. - base_
url str - The base URL for the provisioning connection.
- id_
property str - The application ID.
- profile
Connection
Profile Args - Profile configuration for the app connection.
- action String
- The action to perform on the connection. Valid values are
activateordeactivate. - base
Url String - The base URL for the provisioning connection.
- id
Property String - The application ID.
- profile Property Map
- Profile configuration for the app connection.
Outputs
All input properties are implicitly available as output properties. Additionally, the Connection resource produces the following output properties:
Look up Existing Connection Resource
Get an existing Connection 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?: ConnectionState, opts?: CustomResourceOptions): Connection@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
action: Optional[str] = None,
base_url: Optional[str] = None,
id_property: Optional[str] = None,
profile: Optional[ConnectionProfileArgs] = None,
status: Optional[str] = None) -> Connectionfunc GetConnection(ctx *Context, name string, id IDInput, state *ConnectionState, opts ...ResourceOption) (*Connection, error)public static Connection Get(string name, Input<string> id, ConnectionState? state, CustomResourceOptions? opts = null)public static Connection get(String name, Output<String> id, ConnectionState state, CustomResourceOptions options)resources: _: type: okta:app:Connection 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.
- Action string
- The action to perform on the connection. Valid values are
activateordeactivate. - Base
Url string - The base URL for the provisioning connection.
- Id
Property string - The application ID.
- Profile
Connection
Profile - Profile configuration for the app connection.
- Status string
- Provisioning connection status.
- Action string
- The action to perform on the connection. Valid values are
activateordeactivate. - Base
Url string - The base URL for the provisioning connection.
- Id
Property string - The application ID.
- Profile
Connection
Profile Args - Profile configuration for the app connection.
- Status string
- Provisioning connection status.
- action String
- The action to perform on the connection. Valid values are
activateordeactivate. - base
Url String - The base URL for the provisioning connection.
- id
Property String - The application ID.
- profile
Connection
Profile - Profile configuration for the app connection.
- status String
- Provisioning connection status.
- action string
- The action to perform on the connection. Valid values are
activateordeactivate. - base
Url string - The base URL for the provisioning connection.
- id
Property string - The application ID.
- profile
Connection
Profile - Profile configuration for the app connection.
- status string
- Provisioning connection status.
- action str
- The action to perform on the connection. Valid values are
activateordeactivate. - base_
url str - The base URL for the provisioning connection.
- id_
property str - The application ID.
- profile
Connection
Profile Args - Profile configuration for the app connection.
- status str
- Provisioning connection status.
- action String
- The action to perform on the connection. Valid values are
activateordeactivate. - base
Url String - The base URL for the provisioning connection.
- id
Property String - The application ID.
- profile Property Map
- Profile configuration for the app connection.
- status String
- Provisioning connection status.
Supporting Types
ConnectionProfile, ConnectionProfileArgs
- Auth
Scheme string - Authentication scheme. Valid values are TOKEN or OAUTH2.
- Client
Id string - OAuth2 client ID (required for OAUTH2 auth scheme).
- Settings
Connection
Profile Settings - Additional settings for OAuth2 authentication.
- Signing
Connection
Profile Signing - Signing configuration.
- Token string
- Authentication token (required for TOKEN auth scheme).
- Auth
Scheme string - Authentication scheme. Valid values are TOKEN or OAUTH2.
- Client
Id string - OAuth2 client ID (required for OAUTH2 auth scheme).
- Settings
Connection
Profile Settings - Additional settings for OAuth2 authentication.
- Signing
Connection
Profile Signing - Signing configuration.
- Token string
- Authentication token (required for TOKEN auth scheme).
- auth
Scheme String - Authentication scheme. Valid values are TOKEN or OAUTH2.
- client
Id String - OAuth2 client ID (required for OAUTH2 auth scheme).
- settings
Connection
Profile Settings - Additional settings for OAuth2 authentication.
- signing
Connection
Profile Signing - Signing configuration.
- token String
- Authentication token (required for TOKEN auth scheme).
- auth
Scheme string - Authentication scheme. Valid values are TOKEN or OAUTH2.
- client
Id string - OAuth2 client ID (required for OAUTH2 auth scheme).
- settings
Connection
Profile Settings - Additional settings for OAuth2 authentication.
- signing
Connection
Profile Signing - Signing configuration.
- token string
- Authentication token (required for TOKEN auth scheme).
- auth_
scheme str - Authentication scheme. Valid values are TOKEN or OAUTH2.
- client_
id str - OAuth2 client ID (required for OAUTH2 auth scheme).
- settings
Connection
Profile Settings - Additional settings for OAuth2 authentication.
- signing
Connection
Profile Signing - Signing configuration.
- token str
- Authentication token (required for TOKEN auth scheme).
- auth
Scheme String - Authentication scheme. Valid values are TOKEN or OAUTH2.
- client
Id String - OAuth2 client ID (required for OAUTH2 auth scheme).
- settings Property Map
- Additional settings for OAuth2 authentication.
- signing Property Map
- Signing configuration.
- token String
- Authentication token (required for TOKEN auth scheme).
ConnectionProfileSettings, ConnectionProfileSettingsArgs
- Admin
Password string - Admin password for OAuth2.
- Admin
Username string - Admin username for OAuth2.
- Admin
Password string - Admin password for OAuth2.
- Admin
Username string - Admin username for OAuth2.
- admin
Password String - Admin password for OAuth2.
- admin
Username String - Admin username for OAuth2.
- admin
Password string - Admin password for OAuth2.
- admin
Username string - Admin username for OAuth2.
- admin_
password str - Admin password for OAuth2.
- admin_
username str - Admin username for OAuth2.
- admin
Password String - Admin password for OAuth2.
- admin
Username String - Admin username for OAuth2.
ConnectionProfileSigning, ConnectionProfileSigningArgs
- Rotation
Mode string - Token rotation mode.
- Rotation
Mode string - Token rotation mode.
- rotation
Mode String - Token rotation mode.
- rotation
Mode string - Token rotation mode.
- rotation_
mode str - Token rotation mode.
- rotation
Mode String - Token rotation mode.
Import
App connections can be imported using the application ID:
$ pulumi import okta:app/connection:Connection example <application_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.
