01README
Google Cloud sasportal infrastructure models
02Models
@swamp/gcp/sasportal/customersv2026.04.23.1customers.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| displayName? | string | Required. Name of the organization that the customer entity represents. |
| name? | string | Output only. Resource name of the customer. |
| sasUserIds? | array | User IDs used by the devices belonging to this customer. |
fn get(identifier: string)
Get a customers
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the customers |
fn update()
Update customers attributes
fn sync()
Sync customers state from GCP
fn list_gcp_project_deployments()
list gcp project deployments
fn list_legacy_organizations()
list legacy organizations
fn migrate_organization(organizationId?: any)
migrate organization
| Argument | Type | Description |
|---|---|---|
| organizationId? | any |
fn provision_deployment(newDeploymentDisplayName?: any, newOrganizationDisplayName?: any, organizationId?: any)
provision deployment
| Argument | Type | Description |
|---|---|---|
| newDeploymentDisplayName? | any | |
| newOrganizationDisplayName? | any | |
| organizationId? | any |
fn setup_sas_analytics(userId?: any)
setup sas analytics
| Argument | Type | Description |
|---|---|---|
| userId? | any |
Resources
state(infinite)— Entity representing a SAS customer.
@swamp/gcp/sasportal/customers-deploymentsv2026.04.23.1customers_deployments.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| displayName? | string | The deployment's display name. |
| sasUserIds? | array | User ID used by the devices belonging to this deployment. Each deployment should be associated with one unique user ID. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn create()
Create a deployments
fn get(identifier: string)
Get a deployments
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the deployments |
fn update()
Update deployments attributes
fn delete(identifier: string)
Delete the deployments
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the deployments |
fn sync()
Sync deployments state from GCP
fn move(destination?: any)
move
| Argument | Type | Description |
|---|---|---|
| destination? | any |
Resources
state(infinite)— The Deployment.
@swamp/gcp/sasportal/customers-deployments-devicesv2026.04.23.1customers_deployments_devices.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| activeConfig? | object | Information about the device configuration. |
| deviceMetadata? | object | Device data overridable by both SAS Portal and registration requests. |
| displayName? | string | Device display name. |
| fccId? | string | The FCC identifier of the device. Refer to https://www.fcc.gov/oet/ea/fccid for FccID format. Accept underscores and periods because some test-SAS customers use them. |
| grantRangeAllowlists? | array | Only ranges that are within the allowlists are available for new grants. |
| preloadedConfig? | object | Information about the device configuration. |
| serialNumber? | string | A serial number assigned to the device by the device manufacturer. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn create()
Create a devices
fn get(identifier: string)
Get a devices
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the devices |
fn sync()
Sync devices state from GCP
fn create_signed(encodedDevice?: any, installerId?: any)
create signed
| Argument | Type | Description |
|---|---|---|
| encodedDevice? | any | |
| installerId? | any |
Resources
state(infinite)— Lists devices under a node or customer.
@swamp/gcp/sasportal/customers-devicesv2026.04.23.1customers_devices.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| activeConfig? | object | Information about the device configuration. |
| deviceMetadata? | object | Device data overridable by both SAS Portal and registration requests. |
| displayName? | string | Device display name. |
| fccId? | string | The FCC identifier of the device. Refer to https://www.fcc.gov/oet/ea/fccid for FccID format. Accept underscores and periods because some test-SAS customers use them. |
| grantRangeAllowlists? | array | Only ranges that are within the allowlists are available for new grants. |
| preloadedConfig? | object | Information about the device configuration. |
| serialNumber? | string | A serial number assigned to the device by the device manufacturer. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn create()
Create a devices
fn get(identifier: string)
Get a devices
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the devices |
fn update()
Update devices attributes
fn delete(identifier: string)
Delete the devices
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the devices |
fn sync()
Sync devices state from GCP
fn create_signed(encodedDevice?: any, installerId?: any)
create signed
| Argument | Type | Description |
|---|---|---|
| encodedDevice? | any | |
| installerId? | any |
fn move(destination?: any)
move
| Argument | Type | Description |
|---|---|---|
| destination? | any |
fn sign_device(device?: any)
sign device
| Argument | Type | Description |
|---|---|---|
| device? | any |
fn update_signed(encodedDevice?: any, installerId?: any)
update signed
| Argument | Type | Description |
|---|---|---|
| encodedDevice? | any | |
| installerId? | any |
Resources
state(infinite)— Gets details about a device.
@swamp/gcp/sasportal/customers-nodesv2026.04.23.1customers_nodes.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| displayName? | string | The node's display name. |
| sasUserIds? | array | User ids used by the devices belonging to this node. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn create()
Create a nodes
fn get(identifier: string)
Get a nodes
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the nodes |
fn update()
Update nodes attributes
fn delete(identifier: string)
Delete the nodes
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the nodes |
fn sync()
Sync nodes state from GCP
fn move(destination?: any)
move
| Argument | Type | Description |
|---|---|---|
| destination? | any |
Resources
state(infinite)— The Node.
@swamp/gcp/sasportal/customers-nodes-deploymentsv2026.04.23.1customers_nodes_deployments.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| displayName? | string | The deployment's display name. |
| sasUserIds? | array | User ID used by the devices belonging to this deployment. Each deployment should be associated with one unique user ID. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn create()
Create a deployments
fn get(identifier: string)
Get a deployments
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the deployments |
fn sync()
Sync deployments state from GCP
Resources
state(infinite)— The Deployment.
@swamp/gcp/sasportal/customers-nodes-devicesv2026.04.23.1customers_nodes_devices.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| activeConfig? | object | Information about the device configuration. |
| deviceMetadata? | object | Device data overridable by both SAS Portal and registration requests. |
| displayName? | string | Device display name. |
| fccId? | string | The FCC identifier of the device. Refer to https://www.fcc.gov/oet/ea/fccid for FccID format. Accept underscores and periods because some test-SAS customers use them. |
| grantRangeAllowlists? | array | Only ranges that are within the allowlists are available for new grants. |
| preloadedConfig? | object | Information about the device configuration. |
| serialNumber? | string | A serial number assigned to the device by the device manufacturer. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn create()
Create a devices
fn get(identifier: string)
Get a devices
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the devices |
fn sync()
Sync devices state from GCP
fn create_signed(encodedDevice?: any, installerId?: any)
create signed
| Argument | Type | Description |
|---|---|---|
| encodedDevice? | any | |
| installerId? | any |
Resources
state(infinite)— Lists devices under a node or customer.
@swamp/gcp/sasportal/customers-nodes-nodesv2026.04.23.1customers_nodes_nodes.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| displayName? | string | The node's display name. |
| sasUserIds? | array | User ids used by the devices belonging to this node. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn create()
Create a nodes
fn get(identifier: string)
Get a nodes
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the nodes |
fn sync()
Sync nodes state from GCP
Resources
state(infinite)— The Node.
@swamp/gcp/sasportal/deploymentsv2026.04.23.1deployments.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
fn get(identifier: string)
Get a deployments
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the deployments |
fn sync()
Sync deployments state from GCP
Resources
state(infinite)— The Deployment.
@swamp/gcp/sasportal/deployments-devicesv2026.04.23.1deployments_devices.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| activeConfig? | object | Information about the device configuration. |
| deviceMetadata? | object | Device data overridable by both SAS Portal and registration requests. |
| displayName? | string | Device display name. |
| fccId? | string | The FCC identifier of the device. Refer to https://www.fcc.gov/oet/ea/fccid for FccID format. Accept underscores and periods because some test-SAS customers use them. |
| grantRangeAllowlists? | array | Only ranges that are within the allowlists are available for new grants. |
| grants? | array | Output only. Grants held by the device. |
| name? | string | Output only. The resource path name. |
| preloadedConfig? | object | Information about the device configuration. |
| serialNumber? | string | A serial number assigned to the device by the device manufacturer. |
| state? | enum | Output only. Device state. |
fn get(identifier: string)
Get a devices
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the devices |
fn update()
Update devices attributes
fn delete(identifier: string)
Delete the devices
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the devices |
fn sync()
Sync devices state from GCP
fn move(destination?: any)
move
| Argument | Type | Description |
|---|---|---|
| destination? | any |
fn sign_device(device?: any)
sign device
| Argument | Type | Description |
|---|---|---|
| device? | any |
fn update_signed(encodedDevice?: any, installerId?: any)
update signed
| Argument | Type | Description |
|---|---|---|
| encodedDevice? | any | |
| installerId? | any |
Resources
state(infinite)— Gets details about a device.
@swamp/gcp/sasportal/nodesv2026.04.23.1nodes.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
fn get(identifier: string)
Get a nodes
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the nodes |
fn sync()
Sync nodes state from GCP
Resources
state(infinite)— The Node.
@swamp/gcp/sasportal/nodes-deploymentsv2026.04.23.1nodes_deployments.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| displayName? | string | The deployment's display name. |
| frns? | array | Output only. The FCC Registration Numbers (FRNs) copied from its direct parent. |
| name? | string | Output only. Resource name. |
| sasUserIds? | array | User ID used by the devices belonging to this deployment. Each deployment should be associated with one unique user ID. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn get(identifier: string)
Get a deployments
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the deployments |
fn update()
Update deployments attributes
fn delete(identifier: string)
Delete the deployments
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the deployments |
fn sync()
Sync deployments state from GCP
fn move(destination?: any)
move
| Argument | Type | Description |
|---|---|---|
| destination? | any |
Resources
state(infinite)— The Deployment.
@swamp/gcp/sasportal/nodes-deployments-devicesv2026.04.23.1nodes_deployments_devices.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| activeConfig? | object | Information about the device configuration. |
| deviceMetadata? | object | Device data overridable by both SAS Portal and registration requests. |
| displayName? | string | Device display name. |
| fccId? | string | The FCC identifier of the device. Refer to https://www.fcc.gov/oet/ea/fccid for FccID format. Accept underscores and periods because some test-SAS customers use them. |
| grantRangeAllowlists? | array | Only ranges that are within the allowlists are available for new grants. |
| preloadedConfig? | object | Information about the device configuration. |
| serialNumber? | string | A serial number assigned to the device by the device manufacturer. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn create()
Create a devices
fn get(identifier: string)
Get a devices
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the devices |
fn sync()
Sync devices state from GCP
fn create_signed(encodedDevice?: any, installerId?: any)
create signed
| Argument | Type | Description |
|---|---|---|
| encodedDevice? | any | |
| installerId? | any |
Resources
state(infinite)— Lists devices under a node or customer.
@swamp/gcp/sasportal/nodes-devicesv2026.04.23.1nodes_devices.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| activeConfig? | object | Information about the device configuration. |
| deviceMetadata? | object | Device data overridable by both SAS Portal and registration requests. |
| displayName? | string | Device display name. |
| fccId? | string | The FCC identifier of the device. Refer to https://www.fcc.gov/oet/ea/fccid for FccID format. Accept underscores and periods because some test-SAS customers use them. |
| grantRangeAllowlists? | array | Only ranges that are within the allowlists are available for new grants. |
| preloadedConfig? | object | Information about the device configuration. |
| serialNumber? | string | A serial number assigned to the device by the device manufacturer. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn create()
Create a devices
fn get(identifier: string)
Get a devices
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the devices |
fn update()
Update devices attributes
fn delete(identifier: string)
Delete the devices
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the devices |
fn sync()
Sync devices state from GCP
fn create_signed(encodedDevice?: any, installerId?: any)
create signed
| Argument | Type | Description |
|---|---|---|
| encodedDevice? | any | |
| installerId? | any |
fn move(destination?: any)
move
| Argument | Type | Description |
|---|---|---|
| destination? | any |
fn sign_device(device?: any)
sign device
| Argument | Type | Description |
|---|---|---|
| device? | any |
fn update_signed(encodedDevice?: any, installerId?: any)
update signed
| Argument | Type | Description |
|---|---|---|
| encodedDevice? | any | |
| installerId? | any |
Resources
state(infinite)— Gets details about a device.
@swamp/gcp/sasportal/nodes-nodesv2026.04.23.1nodes_nodes.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| displayName? | string | The node's display name. |
| sasUserIds? | array | User ids used by the devices belonging to this node. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn create()
Create a nodes
fn get(identifier: string)
Get a nodes
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the nodes |
fn update()
Update nodes attributes
fn delete(identifier: string)
Delete the nodes
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the nodes |
fn sync()
Sync nodes state from GCP
fn move(destination?: any)
move
| Argument | Type | Description |
|---|---|---|
| destination? | any |
Resources
state(infinite)— The Node.
@swamp/gcp/sasportal/nodes-nodes-deploymentsv2026.04.23.1nodes_nodes_deployments.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| displayName? | string | The deployment's display name. |
| sasUserIds? | array | User ID used by the devices belonging to this deployment. Each deployment should be associated with one unique user ID. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn create()
Create a deployments
fn get(identifier: string)
Get a deployments
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the deployments |
fn sync()
Sync deployments state from GCP
Resources
state(infinite)— The Deployment.
@swamp/gcp/sasportal/nodes-nodes-devicesv2026.04.23.1nodes_nodes_devices.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| activeConfig? | object | Information about the device configuration. |
| deviceMetadata? | object | Device data overridable by both SAS Portal and registration requests. |
| displayName? | string | Device display name. |
| fccId? | string | The FCC identifier of the device. Refer to https://www.fcc.gov/oet/ea/fccid for FccID format. Accept underscores and periods because some test-SAS customers use them. |
| grantRangeAllowlists? | array | Only ranges that are within the allowlists are available for new grants. |
| preloadedConfig? | object | Information about the device configuration. |
| serialNumber? | string | A serial number assigned to the device by the device manufacturer. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn create()
Create a devices
fn get(identifier: string)
Get a devices
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the devices |
fn sync()
Sync devices state from GCP
fn create_signed(encodedDevice?: any, installerId?: any)
create signed
| Argument | Type | Description |
|---|---|---|
| encodedDevice? | any | |
| installerId? | any |
Resources
state(infinite)— Lists devices under a node or customer.
@swamp/gcp/sasportal/nodes-nodes-nodesv2026.04.23.1nodes_nodes_nodes.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| displayName? | string | The node's display name. |
| sasUserIds? | array | User ids used by the devices belonging to this node. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn create()
Create a nodes
fn get(identifier: string)
Get a nodes
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the nodes |
fn sync()
Sync nodes state from GCP
Resources
state(infinite)— The Node.
@swamp/gcp/sasportal/policiesv2026.04.23.1policies.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
fn get(identifier: string)
Get a policies
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the policies |
fn sync()
Sync policies state from GCP
fn set(disableNotification?: any, policy?: any, resource?: any)
set
| Argument | Type | Description |
|---|---|---|
| disableNotification? | any | |
| policy? | any | |
| resource? | any |
fn test(permissions?: any, resource?: any)
test
| Argument | Type | Description |
|---|---|---|
| permissions? | any | |
| resource? | any |
Resources
state(infinite)— Defines an access control policy to the resources.
03Previous Versions
2026.04.04.1Apr 4, 2026
- Updated: customers_deployments_devices, customers_devices, customers_nodes_devices, deployments_devices, nodes_deployments_devices, nodes_devices, nodes_nodes_devices
2026.04.03.3Apr 3, 2026
- Updated: customers, customers_deployments, customers_deployments_devices, customers_devices, customers_nodes, customers_nodes_deployments, customers_nodes_devices, customers_nodes_nodes, deployments, deployments_devices, nodes, nodes_deployments, nodes_deployments_devices, nodes_devices, nodes_nodes, nodes_nodes_deployments, nodes_nodes_devices, nodes_nodes_nodes, policies
2026.04.03.1Apr 3, 2026
- Updated: customers, customers_deployments, customers_deployments_devices, customers_devices, customers_nodes, customers_nodes_deployments, customers_nodes_devices, customers_nodes_nodes, deployments, deployments_devices, nodes, nodes_deployments, nodes_deployments_devices, nodes_devices, nodes_nodes, nodes_nodes_deployments, nodes_nodes_devices, nodes_nodes_nodes, policies
2026.04.02.2Apr 2, 2026
2026.03.27.1Mar 27, 2026
- Added: customers, customers_deployments, customers_deployments_devices, customers_devices, customers_nodes, customers_nodes_deployments, customers_nodes_devices, customers_nodes_nodes, deployments, deployments_devices, nodes, nodes_deployments, nodes_deployments_devices, nodes_devices, nodes_nodes, nodes_nodes_deployments, nodes_nodes_devices, nodes_nodes_nodes, policies
04Stats
A
100 / 100
Downloads
0
Archive size
103.9 KB
Verified by Swamp
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types1/1earned
- Has description1/1earned
- At least one platform tag (or universal)1/1earned
- Two or more platform tags (or universal)1/1earned
- License declared1/1earned
- Verified public repository2/2earned
05Platforms
06Labels