Quick Reference

Soracom Resource Name (SRN)

A Soracom Resource Name (SRN) is a unique identifier for resources within Soracom. For example, the SRN for uniquely identifying a WASM module uploaded to a Soralet follows this format:

SRN is read by separating with : delimiters. Each component has the following meaning:

• srn: SRN prefix (fixed).
• soracom: Fixed.
• <operator id>: Operator ID. Omitted for resources that are not operator-specific.
• <coverage type>: Coverage type (jp or g). Omitted for resources that are not coverage-specific.
• <resource type>: Resource type. One of the following:
• <id>: Identifier. Format varies by resource.

The SRN format for each resource type is as follows:

• Soralet WASM Module:

  SRN: srn:soracom:<operator id>:<coverage type>:Soralet:<soralet id>/<version>

  • <operator id>: Operator ID.
  • <coverage type>: Coverage type (jp or g).
  • <soralet id>/<version>: Soralet ID and WASM module version number.

  Usage: Used when associating a Soralet with a SIM group in Soracom Orbit as the Code SRN. For example, when applying a specific version of a WASM module for data transformation or filtering.

• Root User:

  SRN: srn:soracom:<operator id>::Operator:<operator id>

  • <operator id>: Operator ID.

  Usage: Used to identify the original user in switch user functionality and recorded in API audit logs when switching between users.

• SAM User:

  SRN: srn:soracom:<operator id>::User:<sam user name>

  • <operator id>: Operator ID.
  • <sam user name>: SAM user name.

  Usage: Used to identify source and target users in switch user functionality.

• Flux Action:

  SRN: srn:soracom:<operator id>:<coverage type>:FluxAction:<flux app id>/<soracom api action id>

  • <coverage type>: Coverage type (jp or g).
  • <flux app id>/<soracom api action id>: Flux app ID and action ID.

  Usage: Used when adding Soracom API actions created in Soracom Flux to SAM user authentication settings. This allows SAM users to execute Flux actions.

• Soracom Managed Role:

  SRN: srn:soracom:::Role:<role name>

  • <role name>: Soracom Managed Role ID.

  Usage: Used when attaching roles to SAM users via API or command-line tools. For example, when specifying Soracom Managed Roles such as SIMReadOnlyAccess or BillingFullAccess, this SRN format is used.