Harthelm Docs

Get one of the organization's Git providers

Organization owners (`org.manage`). The active provider with this id; the secret is never returned.

Generated from openapi/harthelm.yaml at v1.6.1
GET
/orgs/{org}/git-providers/{id}

Authorization

cookie__Host-harthelm_session<token>

Browser session of the UI (12 h idle, 7 days absolute). State-changing requests also need the header Harthelm-CSRF: 1 and a matching Origin.

Path Parameters

org*string
Formatuuid
id*string

The provider's id in the organization (not its ref).

Match^[a-z][a-z0-9-]{0,21}$

Response Body

The provider.

application/json
  1. response
id*OrgGitProviderID

A provider's id within its organization; its ref is <id>-<ref suffix>.

Match^[a-z][a-z0-9-]{0,21}$
ref*string

The provider id everywhere else (/auth/git/{ref}, GET /git/providers, git access, the proxy path).

Match^[a-z][a-z0-9-]{0,30}$
org_id*string
Formatuuid
kind*"gitea"
Value in"gitea"
name*string
url*string

Web URL of the provider (https).

client_id*string
client_secret_set*boolean

The OAuth client secret is stored (it is never returned).

ca_set*boolean

A CA (PEM) for the provider's HTTPS is stored.

redirect_uri*string

Register this at the provider's OAuth2 application.

created_by?

A user as member lists show them.

created_at*string
Formatdate-time
updated_at*string
Formatdate-time
retired_at?string

Only with include_retired, on a retired provider.

Formatdate-time
curl -X GET 'https://console.example.com/api/v1/orgs/497f6eca-6276-4993-bfeb-53cbbbba6f08/git-providers/string'
{  "id": "string",  "ref": "string",  "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",  "kind": "gitea",  "name": "string",  "url": "string",  "client_id": "string",  "client_secret_set": true,  "ca_set": true,  "redirect_uri": "string",  "created_by": {    "id": 1,    "name": "string",    "email": "string",    "picture_url": "string"  },  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "retired_at": "2019-08-24T14:15:22Z"}