{
  "opencollection": "1.0.0",
  "info": {
    "name": "ALTR Sidecar/Agent Configuration Service Users API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "Service Users",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List all Service Users in given Repo.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{orgID}.sc-control.live.altr.com/v1/repos/:repo_name/serviceusers",
            "params": [
              {
                "name": "repo_name",
                "value": "",
                "type": "path",
                "description": "The name of the repo to list service users for."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of items to return."
              },
              {
                "name": "contiguous_id",
                "value": "",
                "type": "query",
                "description": "The Contiguous ID for pagination"
              },
              {
                "name": "username_starts_with",
                "value": "",
                "type": "query",
                "description": "Filter by Service User username in a `starts with fashion`."
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "List all Service Users in given Repo."
        },
        {
          "info": {
            "name": "Create a new Service User.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{orgID}.sc-control.live.altr.com/v1/repos/:repo_name/serviceusers",
            "params": [
              {
                "name": "repo_name",
                "value": "",
                "type": "path",
                "description": "Name of repo."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Create a new Service User with the provided details. Exactly one credential provider must be specified:\n\n- **aws_secrets_manager** — reference a secret in AWS Secrets Manager (fields: secrets_path, optional iam_role).\n- **azure_key_vault** — reference a secret in Azure Key Vault (fields: key_vault_uri, secret_name).\n- **environment_variable** — read the credential from an OS environment variable (field: variable_name).\n- **secret_file** — read the credential from a file under /altr/secrets/ (fie"
        },
        {
          "info": {
            "name": "Get a Service User.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{orgID}.sc-control.live.altr.com/v1/repos/:repo_name/serviceusers/:username",
            "params": [
              {
                "name": "repo_name",
                "value": "",
                "type": "path",
                "description": "Name of repo."
              },
              {
                "name": "username",
                "value": "",
                "type": "path",
                "description": "Name of user."
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Get the Service User for a given Service User ID."
        },
        {
          "info": {
            "name": "Update a Service User.",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://{orgID}.sc-control.live.altr.com/v1/repos/:repo_name/serviceusers/:username",
            "params": [
              {
                "name": "repo_name",
                "value": "",
                "type": "path",
                "description": "Name of repo."
              },
              {
                "name": "username",
                "value": "",
                "type": "path",
                "description": "Name of user."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Update a Service User. When changing the credential provider, supply exactly one of:\n\n- **aws_secrets_manager** — reference a secret in AWS Secrets Manager (fields: secrets_path, optional iam_role).\n- **azure_key_vault** — reference a secret in Azure Key Vault (fields: key_vault_uri, secret_name).\n- **environment_variable** — read the credential from an OS environment variable (field: variable_name).\n- **secret_file** — read the credential from a file under /altr/secrets/ (field: path). The path"
        },
        {
          "info": {
            "name": "Delete a Service User.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{orgID}.sc-control.live.altr.com/v1/repos/:repo_name/serviceusers/:username",
            "params": [
              {
                "name": "repo_name",
                "value": "",
                "type": "path",
                "description": "Name of Repo."
              },
              {
                "name": "username",
                "value": "",
                "type": "path",
                "description": "Name of Service User."
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Delete a Service User from a Repo."
        },
        {
          "info": {
            "name": "List all Service Users for your organization.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{orgID}.sc-control.live.altr.com/v1/serviceusers",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of items to return."
              },
              {
                "name": "contiguous_id",
                "value": "",
                "type": "query",
                "description": "The Contiguous ID for pagination"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "List all Service Users for your organization."
        }
      ]
    }
  ],
  "bundled": true
}