Баримт бичиг / API лавлах

OAuth апп

OAuth-оор эрх олгосон интеграци.

GET/v1/oauth/userinfo

The user who installed the app and the workspace it acts in.

Шаардлагатай API түлхүүрийн хамрах хүрээ: user.read

Хариу: 200 Userinfo

GET/v1/workspaces/{workspaceId}/oauth-apps

List the workspace's OAuth apps.

Шаардлагатай API түлхүүрийн хамрах хүрээ: oauth_apps.manage

Параметр (1)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм

Хариу: 200 OauthAppDto[]

POST/v1/workspaces/{workspaceId}/oauth-apps

Шаардлагатай API түлхүүрийн хамрах хүрээ: oauth_apps.manage

Параметр (1)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм

Хүсэлтийн бие (NewOauthApp)

Нэр	Төрөл	Заавал	Тайлбар
`name`	string	тийм
`description`	string
`websiteUrl`	string
`redirectUris`	string[]	тийм	1-10 exact redirect URIs.
`confidential`	boolean		Server-side apps (default true) get a client secret; public apps use PKCE only.
`pkceRequired`	boolean		PKCE is on by default; a public app always requires it.

Хариу: 201 OauthAppCreated

GET/v1/workspaces/{workspaceId}/oauth-apps/{appId}

One OAuth app.

Шаардлагатай API түлхүүрийн хамрах хүрээ: oauth_apps.manage

Параметр (2)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`appId`	path	string	тийм

Хариу: 200 OauthAppDto

PATCH/v1/workspaces/{workspaceId}/oauth-apps/{appId}

Edit an OAuth app (the client id never changes).

Шаардлагатай API түлхүүрийн хамрах хүрээ: oauth_apps.manage

Параметр (2)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`appId`	path	string	тийм

Хүсэлтийн бие (UpdateOauthApp)

Нэр	Төрөл	Заавал	Тайлбар
`name`	string
`description`	string
`websiteUrl`	string
`redirectUris`	array

Хариу: 200 OauthAppDto

DELETE/v1/workspaces/{workspaceId}/oauth-apps/{appId}

Delete an app; every installation and token of it is removed.

Шаардлагатай API түлхүүрийн хамрах хүрээ: oauth_apps.manage

Параметр (2)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`appId`	path	string	тийм

Хариу: 204

POST/v1/workspaces/{workspaceId}/oauth-apps/{appId}/regenerate-secret

Replace the client secret of a confidential app.

Шаардлагатай API түлхүүрийн хамрах хүрээ: oauth_apps.manage

Параметр (2)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`appId`	path	string	тийм

Хариу: 200 RegeneratedSecret

GET/v1/workspaces/{workspaceId}/oauth-installations

Apps installed in this workspace.

Шаардлагатай API түлхүүрийн хамрах хүрээ: oauth_apps.manage

Параметр (1)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм

Хариу: 200 InstallationDto[]

DELETE/v1/workspaces/{workspaceId}/oauth-installations/{installationId}

Uninstall an app: its tokens stop working at once.

Шаардлагатай API түлхүүрийн хамрах хүрээ: oauth_apps.manage

Параметр (2)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`installationId`	path	string	тийм

Хариу: 204