overlane connector authorize

For a connector that signs in with OAuth (Slack, Linear, Jira, Notion, Sentry, Figma). Prints the address to open in a browser; after you approve there, the connection is stored in the team’s vault. The service needs its OAuth app set up first: if it is not, this names the service secret to set with overlane deploy env secret set. Storing a credential is in the secrets autonomy class.

Usage

overlane connector authorize provider [--service URL] [--team TENANT_ID] [--config KEY=VALUE...] [--project PROJECT_ID] [--dry-run]

Arguments

Argument	Required	Description
`provider`	yes	The connector, such as slack or linear (see `overlane connector list`)

Flags

Flag	Type	Required	Description
`--service`	string	no	The service address (default: OVERLANE_SERVICE_URL, then the project’s binding, then the hosted service)
`--team`	string	no	The team (tenant) to act on (default: the one your token belongs to)
`--config`	string (repeatable)	no	A setting such as cloudId or region; repeat for more
`--project`	string	no	Connect for one project instead of the whole team
`--dry-run`	boolean	no	Print the requests and file changes this command would make, then stop. Needs no credentials.

Examples

overlane connector authorize slack
overlane connector authorize linear --project prj_1

Behavior

Effect: write (changes local or hosted state).
Needs credentials: yes. Uses the network: yes.
Supports --dry-run: yes. Accepts --force: no.
Machine-readable description: overlane schema connector authorize.

Result

With --json (the default when stdout is not a terminal) the command prints this JSON Schema’s shape on stdout.

{
  "anyOf": [
    {
      "type": "object",
      "properties": {
        "tenantId": {
          "type": "string"
        },
        "provider": {
          "type": "string"
        },
        "authorizeUrl": {
          "type": "string"
        },
        "expiresAt": {
          "type": "string"
        },
        "next": {
          "type": "string"
        }
      },
      "required": [
        "tenantId",
        "provider",
        "authorizeUrl",
        "expiresAt",
        "next"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "dryRun": {
          "type": "boolean",
          "const": true
        },
        "service": {
          "type": "string"
        },
        "requests": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "method": {
                "type": "string"
              },
              "path": {
                "type": "string"
              },
              "body": {},
              "note": {
                "type": "string"
              }
            },
            "required": [
              "method",
              "path"
            ],
            "additionalProperties": false
          }
        },
        "commands": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "writes": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "path": {
                "type": "string"
              },
              "action": {
                "type": "string",
                "enum": [
                  "write",
                  "append",
                  "delete"
                ]
              },
              "description": {
                "type": "string"
              }
            },
            "required": [
              "path",
              "action",
              "description"
            ],
            "additionalProperties": false
          }
        },
        "notes": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "required": [
        "dryRun",
        "requests",
        "commands",
        "writes",
        "notes"
      ],
      "additionalProperties": false
    }
  ]
}

See exit codes for the status the process returns.