1. Home >
2. API >
3. 2 >
4. Apps >
5. App Resource

App Resource

The app resource represents an app in OneLogin.

An app payload is broken into sections which group together common attributes such as parameters, sso settings and configuration. The attributes in each section change based on the type of app that has been returned. See below for samples of SAML and OpenId Connect apps.

Resource Elements

{
    "id": 775664,
    "name": "A Sample App",
    "visible": true,
    "description": "",
    "notes": "",
    "icon_url": "/images/missing_connector_icon/square/old_original.png",
    "auth_method": 8,
    "policy_id": null,
    "allow_assumed_signin": false,
    "tab_id": 196885,
    "connector_id": 108419,
    "created_at": "2018-04-12T21:50:42Z",
    "updated_at": "2019-05-16T19:20:34Z",
    "role_ids": [
        192513
    ],
    "provisioning": {},
    "sso": {},
    "configuration": {},
    "parameters": {},
    "enforcement_point": {}
}

Provisioning

{
  "provisioning": {
    "enabled": false
  },
}

SSO

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.

OpenId Connect

{
  "sso": {
    "client_id": "78d1d040-20c9-0136-5146-067351775fae92920"
  },
}

SAML

{
  "sso": {
    "metadata_url": "https://app.onelogin.com/saml/metadata/5772393d-2ad3-47d6-a64f-2339b1028291",
    "acs_url": "https://sharkbytes.onelogin.com/trust/saml2/http-post/sso/928532",
    "sls_url": "https://sharkbytes.onelogin.com/trust/saml2/http-redirect/slo/928532",
    "issuer": "https://app.onelogin.com/saml/metadata/5772393d-2ad3-47d6-a64f-2339b1028291",
    "certificate": {
      "value": "c6d814d032f000d9c03bc79727265",
      "id": 170216,
      "name": "My Companies SAML Certificate"
    }
  }
}

Configuration

The attributes included in the configuration section are determined by the type of app. This is not a complete list of possible configuration attributes. Custom configuration attributes may exist for different types of connectors.

OpenId Connect

{
    "configuration": {
        "redirect_uri": "https://localhost:3000/callback",
        "refresh_token_expiration_minutes": 1,
        "login_url": "",
        "oidc_application_type": 0,
        "token_endpoint_auth_method": 1,
        "access_token_expiration_minutes": 1
    }
}

SAML

{
    "configuration": {
        "provider_arn": null,
        "signature_algorithm": "SHA-1"
        "certificate_id": 123456
    }
}

Parameters

The parameters section contains parameterized attributes that have defined at the connector level as well as custom attributes that have been defined specifically for this app. Regardless of how they are defined, all parameters have the following attributes.

Each parameter is an object with the key for the object being set as the parameters short name.

{
    "parameters": {
        "the_short_name": {
            "values": null,
            "user_attribute_mappings": null,
            "provisioned_entitlements": false,
            "skip_if_blank": false,
            "id": 89806,
            "default_values": null,
            "attributes_transformations": null,
            "label": "RoleSessionName",
            "user_attribute_macros": null,
            "include_in_saml_assertion": true
        }
    }
}

Enforcement Points

For apps that connect to a OneLogin Access Enforcement Point the following enforcement_point object will be included with the app payload.

{
  "enforcement_point": {
    "require_sitewide_authentication": false,
    "conditions": "",
    "session_expiry_fixed": {
        "value": 30,
        "unit": "minutes"
    },
    "session_expiry_inactivity": {
        "value": 10,
        "unit": "minutes"
    },
    "permissions": "allow",
    "token": "b491c647f5e0cff854ad606722ac98342b4b0882",
    "target": "",
    "resources": [
        {
            "resource_id": 809,
            "conditions": null,
            "is_path_regex": null,
            "permissions": "allow",
            "require_auth": false,
            "path": "/"
        }
    ],
    "context_root": "",
    "use_target_host_header": false,
    "vhost": "",
    "landing_page": "",
    "case_sensitive": false
  }
}

{
  "type": "roles",
  "roles": [ "Admin", "User" ]
}

{
  "value": 20,
  "unit": 1
}

{
  "value": 20,
  "unit": 1
}

{
  "path": "/",
  "require_authentication": "no",
  "permission": "allow"
}

Postman Collection

Clicking Run in Postman button navigates to the page where you can fork the collection to your workspace. Forking the collection into your workspace will enable you to contribute to the source collection using pull requests. You can also view the collection in a public workspace if you like and even import a copy of the collection using the links present on the screen.

Have a Question?

Found a problem or a bug? Submit a support ticket.

Looking for walkthroughs or how-to guides on OneLogin's user and admin features? Check out the documentation in our Knowledge Base.

Have a product idea or request? Share it with us in our Ideas Portal.