Skip to main content

Configuring Organizations

The concept of an organization allows many Resource Servers (data sources) and Clients to be shown in an associated way to the user. If unsure, an organization can be created for each partner (service, data source) being configured.

An organization has a unique identifier, and simple displayable name and a main_operator flag which should only be true for the organization that is running the Wallet software.

Request Attributes​

ParameterDescriptionExample valueRequiredLocalizable
nameThe name of the organizationIDENTOSYesYes
mainOperatorWhether this organization is the main operator of this FPX deploymentfalseYesNo

Sample Requests​

Create a new Organization​

curl -X POST '{{WS_ADMIN_URI}}/organization' \
  --header 'Content-Type: application/vnd.api+json' \
  --header 'ApiVersion: v1.0' \
  --header 'Authorization: {{WS_ADMIN_STATIC_TOKEN}}' \
  --header 'Accept-Language: en' \
  --data-raw '{
  "data": {
    "type": "organization",
    "id": 1,
    "attributes": {
      "name": "IDENTOS",
      "mainOperator": false
    }
  }
}'

Get information about existing Organizations​

curl -X GET '{{WS_ADMIN_URI}}/organization' \
  --header 'Content-Type: application/vnd.api+json' \
  --header 'ApiVersion: v1.0' \
  --header 'Authorization: {{WS_ADMIN_STATIC_TOKEN}}' \
  --header 'Accept-Language: en'

Update an existing Organization​

curl -X PATCH '{{WS_ADMIN_URI}}/organization/1' \
  --header 'Content-Type: application/vnd.api+json' \
  --header 'ApiVersion: v1.0' \
  --header 'Authorization: {{WS_ADMIN_STATIC_TOKEN}}' \
  --header 'Accept-Language: en' \
  --data-raw '{
  "data": {
    "type": "organization",
    "id": 1,
    "attributes": {
      "name": "SOTNEDI",
      "mainOperator": true
    }
  }
}'

Verify using the Wallet application API: https://WALLET_API_SERVER/registry/organizations

note

For details on how to add localization options for an Organization, refer to the Localization for the Wallet Server API chapter.