onelogin v0.6.0, Apr 25 23

onelogin.App

Explore with Pulumi AI

Create App Resource

new App(name: string, args: AppArgs, opts?: CustomResourceOptions);

@overload
def App(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        allow_assumed_signin: Optional[bool] = None,
        auth_method: Optional[int] = None,
        auth_method_description: Optional[str] = None,
        brand_id: Optional[int] = None,
        configuration: Optional[AppConfigurationArgs] = None,
        connector_id: Optional[int] = None,
        created_at: Optional[str] = None,
        description: Optional[str] = None,
        enforcement_point: Optional[AppEnforcementPointArgs] = None,
        icon_url: Optional[str] = None,
        login_config: Optional[int] = None,
        name: Optional[str] = None,
        notes: Optional[str] = None,
        parameters: Optional[AppParametersArgs] = None,
        policy_id: Optional[int] = None,
        provisioning: Optional[AppProvisioningArgs] = None,
        role_ids: Optional[Sequence[int]] = None,
        sso: Optional[AppSsoArgs] = None,
        tab_id: Optional[int] = None,
        updated_at: Optional[str] = None,
        visible: Optional[bool] = None)
@overload
def App(resource_name: str,
        args: AppArgs,
        opts: Optional[ResourceOptions] = None)

func NewApp(ctx *Context, name string, args AppArgs, opts ...ResourceOption) (*App, error)

public App(string name, AppArgs args, CustomResourceOptions? opts = null)

public App(String name, AppArgs args)
public App(String name, AppArgs args, CustomResourceOptions options)

type: onelogin:App
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args AppArgs: 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 AppArgs: 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 AppArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args AppArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args AppArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

App Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The App resource accepts the following input properties:

ConnectorId int: ID of the connector to base the app from.
AllowAssumedSignin bool: Indicates whether or not administrators can access the app as a user that they have assumed control over.
AuthMethod int: An ID indicating the type of app: - 0: Password - 1: OpenId - 2: SAML - 3: API - 4: Google - 6: Forms Based App - 7: WSFED - 8: OpenId Connect
AuthMethodDescription string
BrandId int
Configuration AppConfigurationArgs: Only apply configurations that are applicable to the type of app
CreatedAt string: the date the app was created
Description string: Freeform description of the app.
EnforcementPoint AppEnforcementPointArgs: For apps that connect to a OneLogin Access Enforcement Point the following enforcement_point object will be included with the app payload.
IconUrl string: A link to the apps icon url
LoginConfig int
Name string: The name of the app.
Notes string: Freeform notes about the app.
Parameters AppParametersArgs
PolicyId int: The security policy assigned to the app.
Provisioning AppProvisioningArgs: Indicates if provisioning is enabled for this app.
RoleIds List<int>: List of Role IDs that are assigned to the app. On App Create or Update the entire array is replaced with the values provided.
Sso AppSsoArgs: The attributes included in the sso section are determined by the type of app. All of the attributes of the sso object are read only.
TabId int: ID of the OneLogin portal tab that the app is assigned to.
UpdatedAt string: the date the app was last updated
Visible bool: Indicates if the app is visible in the OneLogin portal.

ConnectorId int: ID of the connector to base the app from.
AllowAssumedSignin bool: Indicates whether or not administrators can access the app as a user that they have assumed control over.
AuthMethod int: An ID indicating the type of app: - 0: Password - 1: OpenId - 2: SAML - 3: API - 4: Google - 6: Forms Based App - 7: WSFED - 8: OpenId Connect
AuthMethodDescription string
BrandId int
Configuration AppConfigurationArgs: Only apply configurations that are applicable to the type of app
CreatedAt string: the date the app was created
Description string: Freeform description of the app.
EnforcementPoint AppEnforcementPointArgs: For apps that connect to a OneLogin Access Enforcement Point the following enforcement_point object will be included with the app payload.
IconUrl string: A link to the apps icon url
LoginConfig int
Name string: The name of the app.
Notes string: Freeform notes about the app.
Parameters AppParametersArgs
PolicyId int: The security policy assigned to the app.
Provisioning AppProvisioningArgs: Indicates if provisioning is enabled for this app.
RoleIds []int: List of Role IDs that are assigned to the app. On App Create or Update the entire array is replaced with the values provided.
Sso AppSsoArgs: The attributes included in the sso section are determined by the type of app. All of the attributes of the sso object are read only.
TabId int: ID of the OneLogin portal tab that the app is assigned to.
UpdatedAt string: the date the app was last updated
Visible bool: Indicates if the app is visible in the OneLogin portal.

connectorId Integer: ID of the connector to base the app from.
allowAssumedSignin Boolean: Indicates whether or not administrators can access the app as a user that they have assumed control over.
authMethod Integer: An ID indicating the type of app: - 0: Password - 1: OpenId - 2: SAML - 3: API - 4: Google - 6: Forms Based App - 7: WSFED - 8: OpenId Connect
authMethodDescription String
brandId Integer
configuration AppConfigurationArgs: Only apply configurations that are applicable to the type of app
createdAt String: the date the app was created
description String: Freeform description of the app.
enforcementPoint AppEnforcementPointArgs: For apps that connect to a OneLogin Access Enforcement Point the following enforcement_point object will be included with the app payload.
iconUrl String: A link to the apps icon url
loginConfig Integer
name String: The name of the app.
notes String: Freeform notes about the app.
parameters AppParametersArgs
policyId Integer: The security policy assigned to the app.
provisioning AppProvisioningArgs: Indicates if provisioning is enabled for this app.
roleIds List<Integer>: List of Role IDs that are assigned to the app. On App Create or Update the entire array is replaced with the values provided.
sso AppSsoArgs: The attributes included in the sso section are determined by the type of app. All of the attributes of the sso object are read only.
tabId Integer: ID of the OneLogin portal tab that the app is assigned to.
updatedAt String: the date the app was last updated
visible Boolean: Indicates if the app is visible in the OneLogin portal.

connectorId number: ID of the connector to base the app from.
allowAssumedSignin boolean: Indicates whether or not administrators can access the app as a user that they have assumed control over.
authMethod number: An ID indicating the type of app: - 0: Password - 1: OpenId - 2: SAML - 3: API - 4: Google - 6: Forms Based App - 7: WSFED - 8: OpenId Connect
authMethodDescription string
brandId number
configuration AppConfigurationArgs: Only apply configurations that are applicable to the type of app
createdAt string: the date the app was created
description string: Freeform description of the app.
enforcementPoint AppEnforcementPointArgs: For apps that connect to a OneLogin Access Enforcement Point the following enforcement_point object will be included with the app payload.
iconUrl string: A link to the apps icon url
loginConfig number
name string: The name of the app.
notes string: Freeform notes about the app.
parameters AppParametersArgs
policyId number: The security policy assigned to the app.
provisioning AppProvisioningArgs: Indicates if provisioning is enabled for this app.
roleIds number[]: List of Role IDs that are assigned to the app. On App Create or Update the entire array is replaced with the values provided.
sso AppSsoArgs: The attributes included in the sso section are determined by the type of app. All of the attributes of the sso object are read only.
tabId number: ID of the OneLogin portal tab that the app is assigned to.
updatedAt string: the date the app was last updated
visible boolean: Indicates if the app is visible in the OneLogin portal.

connector_id int: ID of the connector to base the app from.
allow_assumed_signin bool: Indicates whether or not administrators can access the app as a user that they have assumed control over.
auth_method int: An ID indicating the type of app: - 0: Password - 1: OpenId - 2: SAML - 3: API - 4: Google - 6: Forms Based App - 7: WSFED - 8: OpenId Connect
auth_method_description str
brand_id int
configuration AppConfigurationArgs: Only apply configurations that are applicable to the type of app
created_at str: the date the app was created
description str: Freeform description of the app.
enforcement_point AppEnforcementPointArgs: For apps that connect to a OneLogin Access Enforcement Point the following enforcement_point object will be included with the app payload.
icon_url str: A link to the apps icon url
login_config int
name str: The name of the app.
notes str: Freeform notes about the app.
parameters AppParametersArgs
policy_id int: The security policy assigned to the app.
provisioning AppProvisioningArgs: Indicates if provisioning is enabled for this app.
role_ids Sequence[int]: List of Role IDs that are assigned to the app. On App Create or Update the entire array is replaced with the values provided.
sso AppSsoArgs: The attributes included in the sso section are determined by the type of app. All of the attributes of the sso object are read only.
tab_id int: ID of the OneLogin portal tab that the app is assigned to.
updated_at str: the date the app was last updated
visible bool: Indicates if the app is visible in the OneLogin portal.

connectorId Number: ID of the connector to base the app from.
allowAssumedSignin Boolean: Indicates whether or not administrators can access the app as a user that they have assumed control over.
authMethod Number: An ID indicating the type of app: - 0: Password - 1: OpenId - 2: SAML - 3: API - 4: Google - 6: Forms Based App - 7: WSFED - 8: OpenId Connect
authMethodDescription String
brandId Number
configuration Property Map: Only apply configurations that are applicable to the type of app
createdAt String: the date the app was created
description String: Freeform description of the app.
enforcementPoint Property Map: For apps that connect to a OneLogin Access Enforcement Point the following enforcement_point object will be included with the app payload.
iconUrl String: A link to the apps icon url
loginConfig Number
name String: The name of the app.
notes String: Freeform notes about the app.
parameters Property Map
policyId Number: The security policy assigned to the app.
provisioning Property Map: Indicates if provisioning is enabled for this app.
roleIds List<Number>: List of Role IDs that are assigned to the app. On App Create or Update the entire array is replaced with the values provided.
sso Property Map: The attributes included in the sso section are determined by the type of app. All of the attributes of the sso object are read only.
tabId Number: ID of the OneLogin portal tab that the app is assigned to.
updatedAt String: the date the app was last updated
visible Boolean: Indicates if the app is visible in the OneLogin portal.

Outputs

All input properties are implicitly available as output properties. Additionally, the App resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing App Resource

Get an existing App 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?: AppState, opts?: CustomResourceOptions): App

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allow_assumed_signin: Optional[bool] = None,
        auth_method: Optional[int] = None,
        auth_method_description: Optional[str] = None,
        brand_id: Optional[int] = None,
        configuration: Optional[AppConfigurationArgs] = None,
        connector_id: Optional[int] = None,
        created_at: Optional[str] = None,
        description: Optional[str] = None,
        enforcement_point: Optional[AppEnforcementPointArgs] = None,
        icon_url: Optional[str] = None,
        login_config: Optional[int] = None,
        name: Optional[str] = None,
        notes: Optional[str] = None,
        parameters: Optional[AppParametersArgs] = None,
        policy_id: Optional[int] = None,
        provisioning: Optional[AppProvisioningArgs] = None,
        role_ids: Optional[Sequence[int]] = None,
        sso: Optional[AppSsoArgs] = None,
        tab_id: Optional[int] = None,
        updated_at: Optional[str] = None,
        visible: Optional[bool] = None) -> App

func GetApp(ctx *Context, name string, id IDInput, state *AppState, opts ...ResourceOption) (*App, error)

public static App Get(string name, Input<string> id, AppState? state, CustomResourceOptions? opts = null)

public static App get(String name, Output<String> id, AppState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

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.

The following state arguments are supported:

AllowAssumedSignin bool: Indicates whether or not administrators can access the app as a user that they have assumed control over.
AuthMethod int: An ID indicating the type of app: - 0: Password - 1: OpenId - 2: SAML - 3: API - 4: Google - 6: Forms Based App - 7: WSFED - 8: OpenId Connect
AuthMethodDescription string
BrandId int
Configuration AppConfigurationArgs: Only apply configurations that are applicable to the type of app
ConnectorId int: ID of the connector to base the app from.
CreatedAt string: the date the app was created
Description string: Freeform description of the app.
EnforcementPoint AppEnforcementPointArgs: For apps that connect to a OneLogin Access Enforcement Point the following enforcement_point object will be included with the app payload.
IconUrl string: A link to the apps icon url
LoginConfig int
Name string: The name of the app.
Notes string: Freeform notes about the app.
Parameters AppParametersArgs
PolicyId int: The security policy assigned to the app.
Provisioning AppProvisioningArgs: Indicates if provisioning is enabled for this app.
RoleIds List<int>: List of Role IDs that are assigned to the app. On App Create or Update the entire array is replaced with the values provided.
Sso AppSsoArgs: The attributes included in the sso section are determined by the type of app. All of the attributes of the sso object are read only.
TabId int: ID of the OneLogin portal tab that the app is assigned to.
UpdatedAt string: the date the app was last updated
Visible bool: Indicates if the app is visible in the OneLogin portal.

AllowAssumedSignin bool: Indicates whether or not administrators can access the app as a user that they have assumed control over.
AuthMethod int: An ID indicating the type of app: - 0: Password - 1: OpenId - 2: SAML - 3: API - 4: Google - 6: Forms Based App - 7: WSFED - 8: OpenId Connect
AuthMethodDescription string
BrandId int
Configuration AppConfigurationArgs: Only apply configurations that are applicable to the type of app
ConnectorId int: ID of the connector to base the app from.
CreatedAt string: the date the app was created
Description string: Freeform description of the app.
EnforcementPoint AppEnforcementPointArgs: For apps that connect to a OneLogin Access Enforcement Point the following enforcement_point object will be included with the app payload.
IconUrl string: A link to the apps icon url
LoginConfig int
Name string: The name of the app.
Notes string: Freeform notes about the app.
Parameters AppParametersArgs
PolicyId int: The security policy assigned to the app.
Provisioning AppProvisioningArgs: Indicates if provisioning is enabled for this app.
RoleIds []int: List of Role IDs that are assigned to the app. On App Create or Update the entire array is replaced with the values provided.
Sso AppSsoArgs: The attributes included in the sso section are determined by the type of app. All of the attributes of the sso object are read only.
TabId int: ID of the OneLogin portal tab that the app is assigned to.
UpdatedAt string: the date the app was last updated
Visible bool: Indicates if the app is visible in the OneLogin portal.

allowAssumedSignin Boolean: Indicates whether or not administrators can access the app as a user that they have assumed control over.
authMethod Integer: An ID indicating the type of app: - 0: Password - 1: OpenId - 2: SAML - 3: API - 4: Google - 6: Forms Based App - 7: WSFED - 8: OpenId Connect
authMethodDescription String
brandId Integer
configuration AppConfigurationArgs: Only apply configurations that are applicable to the type of app
connectorId Integer: ID of the connector to base the app from.
createdAt String: the date the app was created
description String: Freeform description of the app.
enforcementPoint AppEnforcementPointArgs: For apps that connect to a OneLogin Access Enforcement Point the following enforcement_point object will be included with the app payload.
iconUrl String: A link to the apps icon url
loginConfig Integer
name String: The name of the app.
notes String: Freeform notes about the app.
parameters AppParametersArgs
policyId Integer: The security policy assigned to the app.
provisioning AppProvisioningArgs: Indicates if provisioning is enabled for this app.
roleIds List<Integer>: List of Role IDs that are assigned to the app. On App Create or Update the entire array is replaced with the values provided.
sso AppSsoArgs: The attributes included in the sso section are determined by the type of app. All of the attributes of the sso object are read only.
tabId Integer: ID of the OneLogin portal tab that the app is assigned to.
updatedAt String: the date the app was last updated
visible Boolean: Indicates if the app is visible in the OneLogin portal.

allowAssumedSignin boolean: Indicates whether or not administrators can access the app as a user that they have assumed control over.
authMethod number: An ID indicating the type of app: - 0: Password - 1: OpenId - 2: SAML - 3: API - 4: Google - 6: Forms Based App - 7: WSFED - 8: OpenId Connect
authMethodDescription string
brandId number
configuration AppConfigurationArgs: Only apply configurations that are applicable to the type of app
connectorId number: ID of the connector to base the app from.
createdAt string: the date the app was created
description string: Freeform description of the app.
enforcementPoint AppEnforcementPointArgs: For apps that connect to a OneLogin Access Enforcement Point the following enforcement_point object will be included with the app payload.
iconUrl string: A link to the apps icon url
loginConfig number
name string: The name of the app.
notes string: Freeform notes about the app.
parameters AppParametersArgs
policyId number: The security policy assigned to the app.
provisioning AppProvisioningArgs: Indicates if provisioning is enabled for this app.
roleIds number[]: List of Role IDs that are assigned to the app. On App Create or Update the entire array is replaced with the values provided.
sso AppSsoArgs: The attributes included in the sso section are determined by the type of app. All of the attributes of the sso object are read only.
tabId number: ID of the OneLogin portal tab that the app is assigned to.
updatedAt string: the date the app was last updated
visible boolean: Indicates if the app is visible in the OneLogin portal.

allow_assumed_signin bool: Indicates whether or not administrators can access the app as a user that they have assumed control over.
auth_method int: An ID indicating the type of app: - 0: Password - 1: OpenId - 2: SAML - 3: API - 4: Google - 6: Forms Based App - 7: WSFED - 8: OpenId Connect
auth_method_description str
brand_id int
configuration AppConfigurationArgs: Only apply configurations that are applicable to the type of app
connector_id int: ID of the connector to base the app from.
created_at str: the date the app was created
description str: Freeform description of the app.
enforcement_point AppEnforcementPointArgs: For apps that connect to a OneLogin Access Enforcement Point the following enforcement_point object will be included with the app payload.
icon_url str: A link to the apps icon url
login_config int
name str: The name of the app.
notes str: Freeform notes about the app.
parameters AppParametersArgs
policy_id int: The security policy assigned to the app.
provisioning AppProvisioningArgs: Indicates if provisioning is enabled for this app.
role_ids Sequence[int]: List of Role IDs that are assigned to the app. On App Create or Update the entire array is replaced with the values provided.
sso AppSsoArgs: The attributes included in the sso section are determined by the type of app. All of the attributes of the sso object are read only.
tab_id int: ID of the OneLogin portal tab that the app is assigned to.
updated_at str: the date the app was last updated
visible bool: Indicates if the app is visible in the OneLogin portal.

allowAssumedSignin Boolean: Indicates whether or not administrators can access the app as a user that they have assumed control over.
authMethod Number: An ID indicating the type of app: - 0: Password - 1: OpenId - 2: SAML - 3: API - 4: Google - 6: Forms Based App - 7: WSFED - 8: OpenId Connect
authMethodDescription String
brandId Number
configuration Property Map: Only apply configurations that are applicable to the type of app
connectorId Number: ID of the connector to base the app from.
createdAt String: the date the app was created
description String: Freeform description of the app.
enforcementPoint Property Map: For apps that connect to a OneLogin Access Enforcement Point the following enforcement_point object will be included with the app payload.
iconUrl String: A link to the apps icon url
loginConfig Number
name String: The name of the app.
notes String: Freeform notes about the app.
parameters Property Map
policyId Number: The security policy assigned to the app.
provisioning Property Map: Indicates if provisioning is enabled for this app.
roleIds List<Number>: List of Role IDs that are assigned to the app. On App Create or Update the entire array is replaced with the values provided.
sso Property Map: The attributes included in the sso section are determined by the type of app. All of the attributes of the sso object are read only.
tabId Number: ID of the OneLogin portal tab that the app is assigned to.
updatedAt String: the date the app was last updated
visible Boolean: Indicates if the app is visible in the OneLogin portal.