Service Role Reference Configuration
A Service Role Reference defines how Vidos services access resources by specifying which role to use. This configuration is essential for proper service authentication and authorization.
Configuration Schema
Section titled “Configuration Schema”Service Role References use the owner
field determining the type:
{ // Account-owned role reference "owner": "account", "resourceId": "string"}
// OR
{ // Managed role reference "owner": "managed", "resourceId": "string"}
Configuration Options
Section titled “Configuration Options”- Type:
string
(enum) - Required: Yes
- Values:
"account"
or"managed"
- Description: Specifies who owns and manages the role
"account"
: Role owned by a user account"managed"
: Role owned and managed by Vidos
resourceId
Section titled “resourceId”- Type:
string
- Required: Yes
- Description: The unique identifier for the role resource
- Format: String identifier that references the specific role
Role Types
Section titled “Role Types”Account Role
Section titled “Account Role”Account roles are owned by user accounts and are typically used for custom access patterns.
Example configuration:
{ "owner": "account", "resourceId": "role_abcd1234"}
Managed Role
Section titled “Managed Role”Managed roles are system-defined roles that are managed by Vidos for specific service functions.
Example configuration:
{ "owner": "managed", "resourceId": "verifier_all_actions"}
Usage in Service Instance Configuration
Section titled “Usage in Service Instance Configuration”Service Role References are most commonly used in Service Instance References to specify which role the service instance should use.
Example service instance configuration using a role reference:
{ "type": "instance", "resourceId": "resolver_instance_xyz789", "serviceRole": { "owner": "managed", "resourceId": "resolver_all_actions" }}