API Resources via Swagger

VidiControl’s API resources are listed and depicted in SWAGGER.

Accessing Resources

You can reach you instance by reach the following address:

https://your-host/vidicontrol/schedulercore/swagger/index.html

Getting Your Tokens

Please view the following article for explaining authentication: https://kb.vidinet.net/central/latest/authentication-c-ig .

If you want to access VidiControl’s API, make sure that the roles are created in Auth Service, not only in Keycloak.

A correct API client definition should contain VidiControl’s roles:

JSON

{
    "id": "xxxxxxxx-xxxxxxxx-xxxxxxxx",
    "clientId": "xxxxxxxxclient",
    "clientName": "xxxxxxxxclient",
    "enabled": true,
    "protocolType": "openid-connect",
    "description": "Client to create bookings with xxxxxxxx",
    "accessTokenType": 0,
    "requireClientSecret": false,
    "requireConsent": false,
    "requirePkce": false,
    "allowPlainTextPkce": false,
    "allowAccessTokensViaBrowser": true,
    "alwaysSendClientClaims": true,
    "alwaysIncludeUserClaimsInIdToken": true,
    "allowOfflineAccess": true,
    "frontChannelLogoutSessionRequired": false,
    "backChannelLogoutSessionRequired": true,
    "clientSecrets": [
      {
        "description": "",
        "value": "xxxxxxxx",
        "type": "secret"
      }
    ],
    "redirectUris": [],
    "postLogoutRedirectUris": [],
    "allowedCorsOrigins": [
      "https://xxxxxxxx"
    ],
    "allowedGrantTypes": [
      "client_credentials"
    ],
    "allowedScopes": [
      "vidispine",
      "web-origins",
      "acr",
      "vidicontrol",
      "openid",
      "roles",
      "profile",
      "api1",
      "email",
      "vidicontrolscope"
    ],
    "claims": [
      {
        "type": "sub",
        "value": "admin",
        "valueType": "http://www.w3.org/2001/XMLSchema#string"
      },
      {
        "type": "role",
        "value": "VIDICONTROL_BOOKING_DELETE",
        "valueType": "http://www.w3.org/2001/XMLSchema#string"
      },
      
      {
        "type": "role",
        "value": "VIDICONTROL_BOOKING_EDIT",
        "valueType": "http://www.w3.org/2001/XMLSchema#string"
      },
      {
        "type": "role",
        "value": "VIDICONTROL_BOOKING_VIEW",
        "valueType": "http://www.w3.org/2001/XMLSchema#string"
      },
      {
        "type": "vidispine_user",
        "value": "admin",
        "valueType": "http://www.w3.org/2001/XMLSchema#string"
      },
      {
        "type": "vidicontrol_user",
        "value": "admin",
        "valueType": "http://www.w3.org/2001/XMLSchema#string"
      },
      {
        "type": "client_role",
        "value": "CP_API_CONSUMER",
        "valueType": "http://www.w3.org/2001/XMLSchema#string"
      }
    ],
    "properties": {
      "display.on.consent.screen": false,
      "exclude.session.state.from.auth.response": false,
      "id.token.as.detached.signature": false,
      "oidc.ciba.grant.enabled": false,
      "require.pushed.authorization.requests": false,
      "saml.artifact.binding": false,
      "saml.assertion.signature": false,
      "saml.authnstatement": false,
      "saml.client.signature": false,
      "saml.encrypt": false,
      "saml_force_name_id_format": false,
      "saml.force.post.binding": false,
      "saml.multivalued.roles": false,
      "saml.onetimeuse.condition": false,
      "saml.server.signature": false,
      "saml.server.signature.keyinfo.ext": false,
      "tls.client.certificate.bound.access.tokens": false,
      "use.refresh.tokens": true
    }
  }

When Viewing the Resources

Please be aware of the fact the using resource calls will be done directed at one’s own system. This implies that using the API can affect one’s productive system.