List authorized desktop applications

Summary

• Source repository: jef-systems/jef-desktop-store-backend

• Source SHA: 677bee5aec55a92eea33efdcc4d8a5ee1b83e2c6

• Source run id: 32513999072

• Module: Desktop-store

• Lambda function: jef-desktop-store-get-allowed-desktop-apps-by-entity-number

• HTTP method: GET

• Invocation mode: sync

• Package mode: no-package

• API category: Desktop-store Complex Sync No Package GET APIs

• API path: /desktop-store/complex-sync-no-packages/jef-desktop-store-get-allowed-desktop-apps-by-entity-number

• Endpoint URL: https://api.jefoffice.com/desktop-store/complex-sync-no-packages/jef-desktop-store-get-allowed-desktop-apps-by-entity-number

• Documentation scope: lambda-complex-sync-no-packages

Synchronous Lambda Complex Rule

This API is documented as a synchronous Lambda complex no-package API. API Gateway waits for the Lambda result and returns the final Lambda response.

Description

Validates the session and returns a minimal active application list.

Payload Example

{
  "session_id": "00000000-0000-4000-8000-000000000000",
  "include_inactive": false,
  "limit": 100
}

Payload Schema

{
  "root": {
    "type": "M",
    "required": true,
    "attributes": {
      "session_id": {
        "type": "S",
        "required": true,
        "regex": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89aAbB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
      },
      "include_inactive": {
        "type": "BOOL",
        "required": false
      },
      "limit": {
        "type": "N",
        "required": false
      }
    }
  }
}

Response Schema

{
  "root": {
    "type": "M",
    "required": true,
    "additional_properties": false,
    "attributes": {
      "is_accepted": {
        "type": "BOOL",
        "required": true
      },
      "is_valid": {
        "type": "BOOL",
        "required": true
      },
      "can_continue": {
        "type": "BOOL",
        "required": true
      },
      "message_type": {
        "type": "S",
        "required": true
      },
      "message": {
        "type": "S",
        "required": true
      },
      "next_action": {
        "type": "S",
        "required": true
      },
      "operation": {
        "type": "S",
        "required": true
      },
      "status_code": {
        "type": "N",
        "required": true
      },
      "domain_found": {
        "type": "BOOL",
        "required": true
      },
      "domain_active": {
        "type": "BOOL",
        "required": true
      },
      "entity_found": {
        "type": "BOOL",
        "required": true
      },
      "entity_active": {
        "type": "BOOL",
        "required": true
      },
      "domain_name": {
        "type": "S",
        "required": true
      },
      "jsin": {
        "type": "S",
        "required": true,
        "regex": "^[0-9]{4}$"
      },
      "role_type": {
        "type": "S",
        "required": true,
        "regex": "^(user|admin)$"
      },
      "include_inactive": {
        "type": "BOOL",
        "required": true
      },
      "limit": {
        "type": "N",
        "required": true
      },
      "entity": {
        "type": "M",
        "required": true,
        "additional_properties": false,
        "attributes": {
          "jsin": {
            "type": "S",
            "required": true,
            "regex": "^[0-9]{4}$"
          },
          "entity_name": {
            "type": "S",
            "required": true
          },
          "is_active": {
            "type": "BOOL",
            "required": true
          },
          "created": {
            "type": "S",
            "required": true
          },
          "updated": {
            "type": "S",
            "required": true
          }
        }
      },
      "allowed_applications": {
        "type": "L",
        "required": true,
        "items": {
          "type": "M",
          "required": true,
          "additional_properties": false,
          "attributes": {
            "jsin": {
              "type": "S",
              "required": true,
              "regex": "^[0-9]{4}$"
            },
            "application_name": {
              "type": "S",
              "required": true
            },
            "is_active": {
              "type": "BOOL",
              "required": true
            },
            "created": {
              "type": "S",
              "required": true
            },
            "updated": {
              "type": "S",
              "required": true
            },
            "is_allowed": {
              "type": "BOOL",
              "required": true
            },
            "is_downloadable": {
              "type": "BOOL",
              "required": true
            },
            "application_found": {
              "type": "BOOL",
              "required": true
            },
            "application_active": {
              "type": "BOOL",
              "required": true
            },
            "release_contract_valid": {
              "type": "BOOL",
              "required": true
            },
            "release_status": {
              "type": "S",
              "required": true
            },
            "release_failure_code": {
              "type": "S",
              "required": true
            },
            "application": {
              "type": "M",
              "required": true,
              "additional_properties": false,
              "attributes": {
                "application_name": {
                  "type": "S",
                  "required": true
                },
                "version": {
                  "type": "S",
                  "required": true,
                  "regex": "^[0-9]+\\.[0-9]+\\.[0-9]+$"
                },
                "s3_key": {
                  "type": "S",
                  "required": true
                },
                "is_active": {
                  "type": "BOOL",
                  "required": true
                },
                "created": {
                  "type": "S",
                  "required": true
                },
                "updated": {
                  "type": "S",
                  "required": true
                },
                "release_contract_valid": {
                  "type": "BOOL",
                  "required": true
                },
                "release_status": {
                  "type": "S",
                  "required": true
                },
                "release_failure_code": {
                  "type": "S",
                  "required": true
                },
                "installer_file_name": {
                  "type": "S",
                  "required": true
                },
                "s3_bucket": {
                  "type": "S",
                  "required": true
                },
                "is_downloadable": {
                  "type": "BOOL",
                  "required": true
                }
              }
            }
          }
        }
      },
      "allowed_application_count": {
        "type": "N",
        "required": true
      },
      "skipped_allowed_applications": {
        "type": "L",
        "required": true,
        "items": {
          "type": "M",
          "required": true,
          "additional_properties": false,
          "attributes": {
            "jsin": {
              "type": "S",
              "required": true,
              "regex": "^[0-9]{4}$"
            },
            "application_name": {
              "type": "S",
              "required": true
            },
            "is_active": {
              "type": "BOOL",
              "required": true
            },
            "created": {
              "type": "S",
              "required": true
            },
            "updated": {
              "type": "S",
              "required": true
            },
            "reason": {
              "type": "S",
              "required": true
            },
            "application": {
              "type": "M",
              "required": false,
              "additional_properties": false,
              "attributes": {
                "application_name": {
                  "type": "S",
                  "required": true
                },
                "version": {
                  "type": "S",
                  "required": true,
                  "regex": "^[0-9]+\\.[0-9]+\\.[0-9]+$"
                },
                "s3_key": {
                  "type": "S",
                  "required": true
                },
                "is_active": {
                  "type": "BOOL",
                  "required": true
                },
                "created": {
                  "type": "S",
                  "required": true
                },
                "updated": {
                  "type": "S",
                  "required": true
                },
                "release_contract_valid": {
                  "type": "BOOL",
                  "required": true
                },
                "release_status": {
                  "type": "S",
                  "required": true
                },
                "release_failure_code": {
                  "type": "S",
                  "required": true
                },
                "installer_file_name": {
                  "type": "S",
                  "required": true
                },
                "s3_bucket": {
                  "type": "S",
                  "required": true
                },
                "is_downloadable": {
                  "type": "BOOL",
                  "required": true
                }
              }
            }
          }
        }
      },
      "skipped_allowed_application_count": {
        "type": "N",
        "required": true
      }
    }
  }
}

CMD curl

curl.exe -X GET "https://api.jefoffice.com/desktop-store/complex-sync-no-packages/jef-desktop-store-get-allowed-desktop-apps-by-entity-number"

PowerShell curl

curl.exe -X GET "https://api.jefoffice.com/desktop-store/complex-sync-no-packages/jef-desktop-store-get-allowed-desktop-apps-by-entity-number"