REST /api/v1/vipps-orgs 6 endpoints
GET /api/v1/vipps-orgs/api/v1/vipps-orgs

List all active Vipps-enabled organizations

Public

Response Example

{
  "data": [
    {
      "org_id": "org_helseapp",
      "client_id": "vipps-client-abc123",
      "vipps_enabled": true,
      "environment": "production",
      "created_at": "2025-01-10T08:00:00Z"
    },
    {
      "org_id": "org_treningssenter",
      "client_id": "vipps-client-xyz789",
      "vipps_enabled": true,
      "environment": "production",
      "created_at": "2025-03-01T08:00:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 2
  }
}
GET /api/v1/vipps-orgs/api/v1/vipps-orgs/:org_id

Get Vipps configuration for a specific organization

Public

Response Example

{
  "org_id": "org_helseapp",
  "client_id": "vipps-client-abc123",
  "client_secret_ref": "vault://orgs/org_helseapp/vipps_secret",
  "redirect_uri": "myapp://vipps-callback",
  "scopes": [
    "openid",
    "phoneNumber",
    "name"
  ],
  "vipps_enabled": true,
  "environment": "production",
  "created_at": "2025-01-10T08:00:00Z",
  "updated_at": "2026-01-15T12:00:00Z"
}
POST /api/v1/vipps-orgs/api/v1/vipps-orgs

Create Vipps configuration for an organization

Public

Request Example

{
  "org_id": "org_ny_klinikk",
  "client_id": "vipps-client-new001",
  "client_secret_ref": "vault://orgs/org_ny_klinikk/vipps_secret",
  "redirect_uri": "myapp://vipps-callback",
  "scopes": [
    "openid",
    "phoneNumber"
  ],
  "environment": "production"
}

Response Example

{
  "org_id": "org_ny_klinikk",
  "client_id": "vipps-client-new001",
  "vipps_enabled": true,
  "environment": "production",
  "created_at": "2026-03-26T10:00:00Z"
}
PUT /api/v1/vipps-orgs/api/v1/vipps-orgs/:org_id

Update Vipps configuration for an organization

Public

Request Example

{
  "vipps_enabled": false,
  "environment": "test"
}

Response Example

{
  "org_id": "org_helseapp",
  "vipps_enabled": false,
  "environment": "test",
  "updated_at": "2026-03-26T10:05:00Z"
}
DELETE /api/v1/vipps-orgs/api/v1/vipps-orgs/:org_id

Remove Vipps configuration for an organization

Public

Response Example

{
  "org_id": "org_helseapp",
  "deleted": true,
  "deleted_at": "2026-03-26T10:10:00Z"
}
GET /api/v1/vipps-orgs/api/v1/vipps-orgs/:org_id/status

Check whether Vipps is enabled for an organization

Public

Response Example

{
  "org_id": "org_helseapp",
  "vipps_enabled": true,
  "client_id": "vipps-client-abc123",
  "environment": "production"
}

Additional Metadata

{
  "contract_summary": {
    "total_contracts": 410,
    "total_endpoints": 2416,
    "api_styles_used": [
      "rest"
    ]
  },
  "generated_at": "2026-03-26T06:55:53.316Z"
}