#%RAML 0.8
title: Internal API
baseUri: https://apistg.no.covapp.io/internal/v1
protocols:
- HTTPS
securitySchemes:
- basic:
    type: Basic Authentication
traits:
- secured:
    description: Basic authorization, using the client id and client secret issued
      to the login app.  To use the API console switch the Security Scheme to Basic
      Authentication and enter the client id in the Username field and client secret
      in the Password field.  This will set the Authorization header properly.
    headers:
      Authorization:
        description: Basic authorization, using the client id and client secret issued
          to the login app.  To use the API console switch the Security Scheme to
          Basic Authentication and enter the client id in the Username field and client
          secret in the Password field.  This will set the Authorization header properly.
        pattern: "^Basic .*$"
        example: Basic Y2xpZW50aWQ6Y2xpZW50c2VjcmV0
        required: true
    responses:
      401:
        description: |
          Authentication error. This is returned if the bearer token is not provided or is not valid.
        body:
          application/json:
            schema: oauthv2error
            example: |
              {
                "error": "invalid_client"
              }
      403:
        description: |
          Authorization error. This is returned if the requestor is not authorized to make the request.
        body:
          application/json:
            schema: oauthv2error
            example: |
              {
                "error": "unauthorized_client"
              }
"/scopes":
  is:
  - secured
  securedBy:
  - basic
  get:
    description: Return the scope descriptions for the given client.
    queryParameters:
      client_id:
        description: The client for which the scope descriptions needs to be retrieved.
        type: string
        example: AjghVkghe4GkhjsAjfgk
        required: true
      lang:
        description: |
          The language code for the version of the scope descriptions to retrieve.
          If not provided, the default scope description list will be returned.
        type: integer
        example: 1
        required: false
    responses:
      200:
        description: Successfully retrieved the scope descriptions list.
        body:
          application/json:
            example: |
              {
                "scopes": [
                  {
                    "Name": "email",
                    "Description": "Access to email."
                  },
                  {
                    "Name": "phone",
                    "Description": "Access to phone number."
                  },
                ]
              }
  post:
    description: Set the scope descriptions for the given client.
    queryParameters:
      client_id:
        description: The client for which the scope descriptions needs to be set.
        type: string
        example: AjghVkghe4GkhjsAjfgk
        required: true
      lang:
        description: |
          The language code for the version of the scope descriptions to set.
          If not provided, the default scope description list will be updated.
        type: integer
        example: 1
        required: false
    headers:
      Accept:
        description: Media type.
        example: application/json
        type: string
        required: true
      Content-Type:
        description: Media type.
        example: application/json
        type: string
        required: true
    body:
      application/json:
        example: |
          {
            "scopes": [
              {
                "Name": "email",
                "Description": "Access to email"
              },
              {
                "Name": "phone",
                "Description": "Access to phone numner."
              }
            ]
          }
    responses:
      200:
        description: Successfully set the scope descriptions list.
        body:
          application/json:
            example: |
              {
                "scopes": [
                  {
                    "Name": "email",
                    "Description": "Access to email."
                  },
                  {
                    "Name": "phone",
                    "Description": "Access to phone number."
                  },
                ]
              }
"/appinfo":
  is:
  - secured
  securedBy:
  - basic
  get:
    description: "Return information about the given client.  This includes the application name,\nthe image URL for the OAuth consent form, the list of allowed scopes and their \ndescriptions, as well as an optional default scope.\n"
    queryParameters:
      client_id:
        description: The client for which the information needs to be retrieved.
        type: string
        example: AjghVkghe4GkhjsAjfgk
        required: true
      lang:
        description: |
          The language code for the version of the scope descriptions to retrieve.
          If not provided, the default scope description list will be returned.
        type: integer
        example: 1
        required: false
    responses:
      200:
        description: Successfully retrieved the application information.
        body:
          application/json:
            example: |
              {
                "application_name": "MY-APPLICATION",
                "oauth_image_url": "/ImageServlet?iconId=0",
                "scope": "all",
                "default_scope": "all",
                "scope_descriptions": [
                  {
                    "Name": "email",
                    "Description": "Access to email"
                  },
                  {
                    "Name": "phone",
                    "Description": "Access to phone numner."
                  }
                ]
              }
"/realms/{realmId}":
  is:
  - secured
  securedBy:
  - basic
  uriParameters:
    realmId:
      description: ID of the realm to be purged from the cache.
      type: string
      required: true
      example: REALM-ID
  delete:
    description: |
      Delete a realm from the API gateway realm cache.
    responses:
      200:
        description: |
          Realm successfully deleted, or the realm was not found in the cache.
        body:
          application/json:
            example: |
              {
                "status": "Realm REALM-ID not found in cache"
              }