Vtn

Get VTN credentials

get

Required permissions: Organization.Organization.ReadWrite Required features: OpenADR

Query parameters
organizationIdinteger · int32Required

The organization identifier

Responses
200

The list of VTN credentials

application/json
get
GET /api/openadr/vtn/credential HTTP/1.1
Host: api.switchmarket.se
Accept: */*
[
  {
    "id": 1,
    "organizationId": 1,
    "clientId": "text",
    "clientSecret": "text",
    "clientName": "text",
    "hint": "text",
    "scopes": [
      "text"
    ]
  }
]

Create VTN credential

post

Required permissions: Organization.Organization.ReadWrite Required features: OpenADR

Body
all ofOptional
Responses
200

The organization client was created

application/json
post
POST /api/openadr/vtn/credential HTTP/1.1
Host: api.switchmarket.se
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "organizationId": 1,
  "name": "text",
  "scopes": [
    "text"
  ]
}
{
  "id": 1,
  "organizationId": 1,
  "clientId": "text",
  "clientSecret": "text",
  "clientName": "text",
  "hint": "text",
  "scopes": [
    "text"
  ]
}

Rotate VTN credential secret

put

Required permissions: Organization.Organization.ReadWrite Required features: OpenADR

Path parameters
credentialIdinteger · int32Required

The VTN credential identifier

Query parameters
organizationIdinteger · int32Required

The organization identifier

Responses
200

The VTN credential secret was rotated

application/json
put
PUT /api/openadr/vtn/credential/{credentialId}/secret HTTP/1.1
Host: api.switchmarket.se
Accept: */*
{
  "id": 1,
  "organizationId": 1,
  "clientId": "text",
  "clientSecret": "text",
  "clientName": "text",
  "hint": "text",
  "scopes": [
    "text"
  ]
}

Delete VTN credential

delete

Required permissions: Organization.Organization.ReadWrite Required features: OpenADR

Path parameters
credentialIdinteger · int32Required

The VTN credential identifier

Query parameters
organizationIdinteger · int32Required

The organization identifier

Responses
204

The VTN credential was deleted

No content

delete
DELETE /api/openadr/vtn/credential/{credentialId} HTTP/1.1
Host: api.switchmarket.se
Accept: */*

No content

Was this helpful?