afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/ConnectedApplication.json

{
  "sections": [
    "title",
    "description",
    "fields",
    "wsdl_segment",
    "field_reference"
  ],
  "title": "ConnectedApplication - Data API",
  "description": "Represents a connected app and its details; all fields are read-only.",
  "fields_columns": [
    "type",
    "properties",
    "description"
  ],
  "fields": {
    "MobileSessionTimeout": {
      "type": "picklist",
      "properties": "Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "Length of time after which the system logs out inactive mobile users."
    },
    "MobileStartUrl": {
      "type": "url",
      "properties": "Filter, Nillable, Sort",
      "description": "Users are directed to this URL after they’ve authenticated when the app is accessed from a mobile device."
    },
    "Name": {
      "type": "string",
      "properties": "Filter, Group, idLookup, Sort",
      "description": "The unique name for this object."
    },
    "NamedUserUvidTimeout": {
      "type": "picklist",
      "properties": "Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "The timeout value for a JSON Web Token (JWT)-based access token that's issued to a named user. This field defines the timeout only if the app is configured to have an app-specific timeout. If the app uses the user's session timeout, the timeout value is defined based on the user's profile or the org session settings. For more information about defining JWT-based access token timeout, see Configure a Connected App to Issue JWT-Based Access Tokens. These values are available in API version 59.0 and later. 1—1 Minute 5—5 Minutes 10—10 Minutes 15—15 Minutes 30—30 Minutes These values are available in API version 65.0 and later. 60—1 Hour 90—90 Minutes 120—2 Hours 240—4 Hours 480—8 Hours 720—12 Hours This field is available in API version 59.0 and later."
    },
    "OptionsAllowAdminApprovedUsersOnly": {
      "type": "boolean",
      "properties": "Filter",
      "description": "Indicates whether access is limited to users granted approval to use the connected app by an administrator. Manage profiles for the app by editing each profile’s Access list."
    },
    "OptionsCodeCredentialGuestEnabled": {
      "description": "Reserved for future use."
    },
    "OptionsFullContentPushNotifications": {
      "description": "For internal use only."
    },
    "OptionsHasSessionLevelPolicy": {
      "type": "boolean",
      "properties": "Filter",
      "description": "Specifies whether the connected app requires a High Assurance level session."
    },
    "OptionsIsInternal": {
      "description": "For internal use only."
    },
    "OptionsRefreshTokenValidityMetric": {
      "type": "boolean",
      "properties": "Filter",
      "description": "Specifies whether the refresh token validity is based on duration or inactivity. If true, the token validity is measured based on the last use of the token; otherwise, it’s based on the token duration."
    },
    "OptionsTokenExchangeManageBitEnabled": {
      "type": "boolean",
      "properties": "Filter",
      "description": "If true, the OAuth 2.0 token exchange flow is enabled."
    },
    "PinLength": {
      "type": "picklist",
      "properties": "Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "For mobile apps, this field is the PIN length requirement for users of the connected app. Valid values are 4, 5, 6, 7, or 8."
    },
    "RefreshTokenValidityPeriod": {
      "type": "int",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The duration of an authorization token until it expires in hours, months, or days as set in the connected app management page."
    },
    "StartUrl": {
      "type": "url",
      "properties": "Filter, Nillable, Sort",
      "description": "If the app isn’t accessed from a mobile device, users are directed to this URL after they’ve authenticated."
    },
    "UvidTimeout": {
      "type": "picklist",
      "properties": "Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "The timeout value for a JWT-based access token that's issued to an unknown user as a result of the guest user variation of the Authorization Code and Credentials Flow. JWT-based access tokens issued during this flow variation always contain a UVID. This field defines the timeout only if the app is configured to have an app-specific timeout. If the app uses the user's session timeout, the timeout value is defined based on the user's profile or the org session settings. For more information about defining JWT-based access token timeout, see Configure a Connected App to Issue JWT-Based Access Tokens. These values are available in API version 59.0 and later. 1—1 Minute 5—5 Minutes 10—10 Minutes 15—15 Minutes 30—30 Minutes These values are available in API version 65.0 and later. 60—1 Hour 90—90 Minutes 120—2 Hours 240—4 Hours 480—8 Hours 720—12 Hours This field is available in API version 59.0 and later."
    }
  },
  "wsdl_segment": "```xml\n<complexType name=\"ConnectedApplication\">\n  <complexContent>\n    <extension base=\"ens:sObject\">\n      <sequence>\n        <element name=\"CreatedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n        <element name=\"CreatedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"CreatedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"InstalledMobileApps\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"LastModifiedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n        <element name=\"LastModifiedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"LastModifiedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"MobileSessionTimeout\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"MobileStartUrl\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"Name\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"NamedUserUvidTimeout\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"OptionsAllowAdminApprovedUsersOnly\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"OptionsCodeCredentialGuestEnabled\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"OptionsFullContentPushNotifications\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"OptionsHasSessionLevelPolicy\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"OptionsIsInternal\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"OptionsRefreshTokenValidityMetric\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"OptionsTokenExchangeManageBitEnabled\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"PinLength\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"RefreshTokenValidityPeriod\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:int\"/>\n        <element name=\"SetupEntityAccessItems\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"StartUrl\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"SystemModstamp\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"UvidTimeout\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n      </sequence>\n    </extension>\n  </complexContent>\n</complexType>\n<simpleType name=\"ID\">\n  <restriction base=\"xsd:string\">\n    <length value=\"18\"/>\n    <pattern value=\"[a-zA-Z0-9]{18}\"/>\n  </restriction>\n</simpleType>\n<simpleType name=\"QueryLocator\">\n  <restriction base=\"xsd:string\"/>\n</simpleType>\n<complexType name=\"QueryResult\">\n  <sequence>\n    <element name=\"done\" type=\"xsd:boolean\"/>\n    <element name=\"queryLocator\" type=\"tns:QueryLocator\" nillable=\"true\"/>\n    <element name=\"records\" type=\"ens:sObject\" nillable=\"true\" minOccurs=\"0\" maxOccurs=\"unbounded\"/>\n    <element name=\"size\" type=\"xsd:int\"/>\n  </sequence>\n</complexType>\n```",
  "field_reference": {
    "CreatedById": {
      "field_label": "Created By ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedDate": {
      "field_label": "Created Date",
      "type": "datetime"
    },
    "Id": {
      "field_label": "Connected App ID",
      "type": "id",
      "length": "18"
    },
    "LastModifiedById": {
      "field_label": "Last Modified By ID",
      "type": "reference",
      "length": "18"
    },
    "LastModifiedDate": {
      "field_label": "Last Modified Date",
      "type": "datetime"
    },
    "MobileSessionTimeout": {
      "field_label": "Lock App After",
      "type": "picklist",
      "length": "40"
    },
    "MobileStartUrl": {
      "field_label": "Mobile Start URL",
      "type": "url",
      "length": "2400"
    },
    "Name": {
      "field_label": "Connected App Name",
      "type": "string",
      "length": "80"
    },
    "NamedUserUvidTimeout": {
      "field_label": "Named User Uvid Timeout",
      "type": "picklist",
      "length": "40"
    },
    "OptionsAllowAdminApprovedUsersOnly": {
      "field_label": "AllowAdminApprovedUsersOnly",
      "type": "boolean"
    },
    "OptionsCodeCredentialGuestEnabled": {
      "field_label": "CodeCredentialGuestEnabled",
      "type": "boolean"
    },
    "OptionsFullContentPushNotifications": {
      "field_label": "FullContentPushNotifications",
      "type": "boolean"
    },
    "OptionsHasSessionLevelPolicy": {
      "field_label": "HasSessionLevelPolicy",
      "type": "boolean"
    },
    "OptionsIsInternal": {
      "field_label": "isInternal",
      "type": "boolean"
    },
    "OptionsRefreshTokenValidityMetric": {
      "field_label": "RefreshTokenValidityMetric",
      "type": "boolean"
    },
    "OptionsTokenExchangeManageBitEnabled": {
      "field_label": "TokenExchangeManageBitEnabled",
      "type": "boolean"
    },
    "PinLength": {
      "field_label": "PIN Length",
      "type": "picklist",
      "length": "40"
    },
    "RefreshTokenValidityPeriod": {
      "field_label": "Refresh Token Policy:",
      "type": "int",
      "digits": "9"
    },
    "StartUrl": {
      "field_label": "Start URL",
      "type": "url",
      "length": "2400"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    },
    "UvidTimeout": {
      "field_label": "Uvid Timeout",
      "type": "picklist",
      "length": "40"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "length",
    "digits"
  ]
}