package services.provider.v1

Get desktop application:
View/edit binary Protocol Buffers messages

Access Management service provides methods to manage access to ecosystem resources such by assigning roles and permissions to wallet accounts

• rpc AddRoleAssignment (AddRoleAssignmentRequest, AddRoleAssignmentResponse)

  access-management.proto:77

  Adds a role assignment to an account

  message AddRoleAssignmentRequest

  access-management.proto:13

  Role management

  • string role = 1

    Role to assign

  • oneof account

    • string email = 2

      Email address of account to assign role. Mutually exclusive with `walletId` and `didUri`.

    • string wallet_id = 3

      Wallet ID of account to assign role to. Mutually exclusive with `email` and `didUri`.

    • string did_uri = 4

      DID URI of the account to assign role. Mutually exclusive with `email` and `walletId`.

  message AddRoleAssignmentResponse

  access-management.proto:28

  (message has no fields)

• rpc ListAvailableRoles (ListAvailableRolesRequest, ListAvailableRolesResponse)

  access-management.proto:92

  List the roles available in the ecosystem

  message ListAvailableRolesRequest

  access-management.proto:67

  Request to fetch the available roles in the current ecosystem

  (message has no fields)

  message ListAvailableRolesResponse

  access-management.proto:68

  • repeated string roles = 1

    List of roles

• rpc ListRoleAssignments (ListRoleAssignmentsRequest, ListRoleAssignmentsResponse)

  access-management.proto:87

  List the role assignments for the given account

  message ListRoleAssignmentsRequest

  access-management.proto:48

  Request to fetch the list of roles assigned to the current account

  • oneof account

    • string email = 2

      Email address of account to list roles. Mutually exclusive with `walletId` and `didUri`.

    • string wallet_id = 3

      Wallet ID of account to list roles. Mutually exclusive with `email` and `didUri`.

    • string did_uri = 4

      DID URI of the account to list roles. Mutually exclusive with `email` and `walletId`.

  message ListRoleAssignmentsResponse

  access-management.proto:61

  • repeated string roles = 1

    List of roles

• rpc RemoveRoleAssignment (RemoveRoleAssignmentRequest, RemoveRoleAssignmentResponse)

  access-management.proto:82

  Removes a role assignment from the account

  message RemoveRoleAssignmentRequest

  access-management.proto:30

  • string role = 1

    Role to unassign

  • oneof account

    • string email = 2

      Email address of account to unassign role. Mutually exclusive with `walletId` and `didUri`.

    • string wallet_id = 3

      Wallet ID of account to unassign role. Mutually exclusive with `email` and `didUri`.

    • string did_uri = 4

      DID URI of the account to unassign role. Mutually exclusive with `email` and `walletId`.

  message RemoveRoleAssignmentResponse

  access-management.proto:45

  (message has no fields)

• rpc CreateEcosystem (CreateEcosystemRequest, CreateEcosystemResponse)

  provider.proto:212

  Create new ecosystem and assign the authenticated user as owner

  message CreateEcosystemRequest

  provider.proto:32

  Request to create an ecosystem

  • string name = 1

    Globally unique name for the Ecosystem. This name will be part of the ecosystem-specific URLs and namespaces. Allowed characters are lowercase letters, numbers, underscore and hyphen. If not passed, ecosystem name will be auto-generated.

  • string description = 2

    Ecosystem description

  • optional account.v1.AccountDetails details = 4

    The account details of the owner of the ecosystem

  • string domain = 5

    New domain URL

  message CreateEcosystemResponse

  provider.proto:53

  Response to `CreateEcosystemRequest`

  • optional Ecosystem ecosystem = 1

    Details of the created ecosystem

  • optional account.v1.AccountProfile profile = 2

    Account profile for auth of the owner of the ecosystem

  • account.v1.ConfirmationMethod confirmation_method = 3

    Indicates if confirmation of account is required.

• rpc GetOberonKey (GetOberonKeyRequest, GetOberonKeyResponse)

  provider.proto:221

  Returns the public key being used to create/verify oberon tokens

  message GetOberonKeyRequest

  provider.proto:74

  Request to fetch the Trinsic public key used to verify authentication token validity

  (message has no fields)

  message GetOberonKeyResponse

  provider.proto:78

  Response to `GetOberonKeyRequest`

  • string key = 1

    Oberon Public Key as RAW base64-url encoded string

• rpc SearchWalletConfigurations (SearchWalletConfigurationsRequest, SearchWalletConfigurationResponse)

  provider.proto:239

  Search for issuers/providers/verifiers in the current ecosystem

  message SearchWalletConfigurationsRequest

  provider.proto:84

  Search for issuers/holders/verifiers

  • string query_filter = 1

    SQL filter to execute. `SELECT * FROM c WHERE [**queryFilter**]`

  • string continuation_token = 2

    Token provided by previous `SearchResponse` if more data is available for query

  message SearchWalletConfigurationResponse

  provider.proto:92

  • repeated WalletConfiguration results = 1

    Results matching the search query

  • bool has_more_results = 2

    Whether more results are available for this query via `continuation_token`

  • string continuation_token = 4

    Token to fetch next set of results via `SearchRequest`

• rpc UpgradeDID (UpgradeDidRequest, UpgradeDidResponse)

  provider.proto:231

  Upgrade a wallet's DID from `did:key` to another method

  message UpgradeDidRequest

  provider.proto:178

  Request to upgrade a wallet

  • oneof account

    • string email = 1

      Email address of account to upgrade. Mutually exclusive with `walletId` and `didUri`.

    • string wallet_id = 2

      Wallet ID of account to upgrade. Mutually exclusive with `email` and `didUri`.

    • string did_uri = 6

      DID URI of the account to upgrade. Mutually exclusive with `email` and `walletId`.

  • common.v1.SupportedDidMethod method = 3

    DID Method to which wallet should be upgraded

  • oneof options

    • IonOptions ion_options = 4

      Configuration for creation of DID on ION network

    • IndyOptions indy_options = 5

      Configuration for creation of DID on INDY network

  message UpgradeDidResponse

  provider.proto:205

  Response to `UpgradeDIDRequest`

  • string did = 1

    New DID of wallet

Details of an ecosystem

Used in: CreateEcosystemResponse, EcosystemInfoResponse

• string id = 1

  URN of the ecosystem

• string name = 2

  Globally unique name for the ecosystem

• string description = 3

  Ecosystem description

Request to fetch information about an ecosystem

(message has no fields)

Response to `InfoRequest`

• optional Ecosystem ecosystem = 1

  Ecosystem corresponding to current ecosystem in the account token

Used in: WalletExternalIdentity, universalwallet.v1.AddExternalIdentityInitRequest, universalwallet.v1.AuthenticateInitRequest, universalwallet.v1.CreateWalletRequest.ExternalIdentity

• Unknown = 0

  Identity provider is unknown

• Email = 1

  Identity provider is email

• Phone = 2

  Identity provider is phone

Options for creation of DID on the SOV network

Used in: UpgradeDidRequest

• IndyOptions.IndyNetwork network = 1

  SOV network on which DID should be published

Used in: IndyOptions

• Danube = 0

• SovrinBuilder = 1

• SovrinStaging = 2

• Sovrin = 3

• IdUnionTest = 4

• IdUnion = 5

• IndicioTest = 6

• IndicioDemo = 7

• Indicio = 8

Options for creation of DID on the ION network

Used in: UpgradeDidRequest

• IonOptions.IonNetwork network = 1

  ION network on which DID should be published

Used in: IonOptions

• TestNet = 0

• MainNet = 1

Strongly typed information about wallet configurations

Used in: SearchWalletConfigurationResponse, universalwallet.v1.CreateWalletResponse, universalwallet.v1.GetMyInfoResponse, universalwallet.v1.GetWalletFromExternalIdentityResponse, universalwallet.v1.GetWalletInfoResponse, universalwallet.v1.ListWalletsResponse

• string name = 1

  Name/description of the wallet

• string email = 2

  Deprecated and will be removed on August 1, 2023 -- use external_identities. This field is set to the first email address present in `external_identities`, if any.

• string sms = 3

  Deprecated -- use external_identities

• string wallet_id = 4

• string public_did = 5

  The DID of the wallet

• string config_type = 6

• repeated account.v1.WalletAuthToken auth_tokens = 7

  List of active authentication tokens for this wallet. This list does not contain the issued token, only metadata such as ID, description, and creation date.

• repeated string external_identity_ids = 8

  List of external identity IDs (email addresses, phone numbers, etc.) associated with this wallet. This is deprecated; use `external_identities` instead.

• string ecosystem_id = 9

  Ecosystem in which this wallet is contained.

• string description = 10

• repeated WalletExternalIdentity external_identities = 11

  List of external identities associated with this wallet.

An external identity (email address, phone number, etc.) associated with a wallet for authentication purposes.

Used in: WalletConfiguration, universalwallet.v1.GetWalletFromExternalIdentityRequest

• IdentityProvider provider = 1

  The type of this identity (whether this identity is an email address, phone number, etc.)

• string id = 2

  The actual email address/phone number/etc. for this identity