How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Cognite Postgres Gateway Users API

A postgres gateway **user** (also a typical postgres user) owns the foreign tables (built in or custom).The created postgres user only has access to use foreign tables and cannot directly create tables users. To create foreign tables use the Postgres Gateway Tables APIs

Cognite Postgres Gateway Users API is one of 90 APIs that Cognite publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Postgres Gateway Users. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 6 operations across 5 paths, and defines 20 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://{cluster}.cognitedata.com/api/v1/projects/{project}.

6 operations 5 paths 20 schemas 1 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api.cognitedata.com
Authentication
HTTP Bearer, OAuth 2.0, OAuth 2.0, OAuth 2.0, OpenID Connect
Resource Areas
1

Authentication & Security 5

Cognite Postgres Gateway Users API declares 5 security schemes for authenticating requests. It accepts HTTP bearer tokens (OpenID Connect or OAuth2 token) (oidc-token). It supports OAuth 2.0 (oauth2-client-credentials) using the clientCredentials flow, exposing 1 scope. It supports OAuth 2.0 (oauth2-auth-code) using the authorizationCode flow, exposing 1 scope. It supports OAuth 2.0 (oauth2-open-industrial-data) using the clientCredentials flow, exposing 1 scope. It supports OpenID Connect (org-oidc-token) discovered at https://auth.cognite.com/.well-known/openid-configuration. By default, every request must be authenticated.

  • oidc-token — Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to acce…
  • oauth2-client-credentials — Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to acce…
  • oauth2-auth-code — Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to acce…
  • oauth2-open-industrial-data — Auth flow for Open Industrial Data. Get your client secret from https://hub.cognite.com/open-industrial-data-211.
  • org-oidc-token — Access token issued by the Cognite authorization server, and valid for the target organization. The token must be an OpenID Connect token, and it can be obtain…

Paths & Operations 6

Across 5 paths, the API surfaces 6 operations — 1 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.

Postgres Gateway Users 6

A postgres gateway user (also a typical postgres user) owns the foreign tables (built in or custom). The created postgres user only has access to use foreign tables and cannot dir…

GET
/postgresgateway
List users
list_users 2 params → 200400422
POST
/postgresgateway
Create users
create_users body → 200400422
POST
/postgresgateway/list
Filter users
filter_users body → 200400422
POST
/postgresgateway/byids
Retrieve users
retreive_users body → 200400422
POST
/postgresgateway/update
Update users
update_users body → 200400422
POST
/postgresgateway/delete
Delete users
delete_users body → 200400422

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are UserCreated (6 properties), FdwUser (4 properties), Error (4 properties), ValidationErrorContent_ (2 properties). Each schema is shown below with its type and property counts.

EpochTimestamp
integer
The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
CreateUser
object
1 property 1 required
ItemsWithIgnoreUnknown_Username_
object
2 properties 1 required
UpdateItem_SessionCredentials
object
Set a new set of session credentials for writing to CDF.
1 property 1 required
Items_UserUpdate_
object
1 property 1 required
SessionCredentials
object
Credentials for authenticating towards CDF using a CDF session.
1 property 1 required
ItemsWithIgnoreUnknown_Username_1_
object
2 properties 1 required
FdwUser
object
A user
4 properties 2 required
Username
string
Username to authenticate the user on the DB.
Items_CreateUser_
object
1 property 1 required
FilterUsers
object
2 properties
UserUpdateItem
object
2 properties 2 required
UpdateUser
object
1 property
UsernameWrapper
object
1 property 1 required
ItemsWithCursor_UserCreated_
object
1 property 1 required
Error
object
Cognite API error.
4 properties 2 required
ItemsWithoutCursor_User_
object
1 property 1 required
ItemsWithCursor_User_
object
2 properties 1 required
ValidationErrorContent_
object
Cognite API error.
2 properties 2 required
UserCreated
object
A user
6 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cognite-postgres-gateway-users-api-openapi.yml Raw ↑

Other APIs Cognite publishes across the network.

Cognite Data Fusion API
Cognite 3D Asset Mapping API
Cognite 3D Files API
Cognite 3D Jobs API
Cognite 3D Model Revisions API
Cognite 3D Models API
Cognite Annotations API
Cognite Assets API
Cognite Connections API
Cognite Containers API
Cognite Data models API
Cognite Data point subscriptions API
Where this information came from

This is an independent, third-party profile of Cognite Postgres Gateway Users API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.