Client Management

Manage registered clients.

Read client registration

get

/rest/auth/v1/rest/auth/v1/platform

/clients/{client_id}

Read the current client registration data stored by Collibra.

Path parameters

client_idstringRequired

Client identifier generated by Collibra when the client was registered.

Responses

200

Client data retrieved successfully

application/json

client_idstringOptional

Technical client identifier returned by the Authorization Server when the client is registered.

client_id_issued_atinteger · int64Optional

Time at which the client identifier was issued.

The time is represented as the number of seconds from 1970-01-01T00:00:00Z as measured in UTC until the date/time of issuance.

client_namestringOptional

Descriptive name of the client.

Two different clients cannot have the same name.

This should be a name that reveals the purpose of the client.

Example: Techlin Harvester (us-west-1)

grant_typesstring[]Optional

Authorization grants that the client is allowed to use.

redirect_urisstring · uri[]Optional

Redirection URI strings for use in the authorization code flow. Required when the client intends to use the authorization_code grant type.

401

This client doesn't exist on this server, or the provided access token is invalid

403

Not authorized to retrieve the requested client data.

get/clients/{client_id}

HTTPcURLJavaScriptPython

GET /rest/auth/v1/clients/{client_id} HTTP/1.1
Accept: */*

{
  "client_id": "text",
  "client_id_issued_at": 1,
  "client_name": "Techlin Harvester (us-west-1)",
  "grant_types": [
    "text"
  ],
  "redirect_uris": [
    "https://example.com"
  ]
}

Update client registration

put

/rest/auth/v1/rest/auth/v1/platform

/clients/{client_id}

Updates a registered client.

Path parameters

client_idstringRequired

Client identifier generated by Collibra when the client was registered.

Body

application/json

Request to update registered client data.

client_namestringRequired

Descriptive name of the client.

Two different clients cannot have the same name.

This should be a name that reveals the purpose of the client.

Example: Techlin Harvester (us-west-1)

grant_typesstring[]Optional

Authorization grants that the client is allowed to use.

redirect_urisstring · uri[]Optional

Redirection URI strings for use in the authorization code flow. Required when the client intends to use the authorization_code grant type.

Responses

200

Client updated successfully

application/json

Data associated to the registered client.

The client secret returned in this response cannot be read through any API call. Thus you should store the client secret returned in this response.

client_idstringOptional

Technical client identifier returned by the Authorization Server when the client is registered.

client_id_issued_atinteger · int64Optional

Time at which the client identifier was issued.

The time is represented as the number of seconds from 1970-01-01T00:00:00Z as measured in UTC until the date/time of issuance.

client_namestringOptional

Descriptive name of the client.

Two different clients cannot have the same name.

This should be a name that reveals the purpose of the client.

Example: Techlin Harvester (us-west-1)

grant_typesstring[]Optional

Authorization grants that the client is allowed to use.

redirect_urisstring · uri[]Optional

Redirection URI strings for use in the authorization code flow. Required when the client intends to use the authorization_code grant type.

client_secretstring · passwordOptional

Secret generated by Collibra for the registered client.

401

This client doesn't exist on this server, or the provided access token is invalid

403

The provided client is not allowed to update this record.

put/clients/{client_id}

HTTPcURLJavaScriptPython

PUT /rest/auth/v1/clients/{client_id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 110

{
  "client_name": "Techlin Harvester (us-west-1)",
  "grant_types": [
    "text"
  ],
  "redirect_uris": [
    "https://example.com"
  ]
}

{
  "client_secret": "password",
  "client_id": "text",
  "client_id_issued_at": 1,
  "client_name": "Techlin Harvester (us-west-1)",
  "grant_types": [
    "text"
  ],
  "redirect_uris": [
    "https://example.com"
  ]
}

Delete client registration

delete

/rest/auth/v1/rest/auth/v1/platform

/clients/{client_id}

Deletes a registered client.

A successful delete action will invalidate the client_id and client_secret for this client, meaning the client will no longer be able to authenticate with those credentials.

Path parameters

client_idstringRequired

Client identifier generated by Collibra when the client was registered.

Responses

204

Client registration deleted successfully.

No content

401

This client doesn't exist on this server, or the provided access token is invalid

403

The provided client is not allowed to delete this record.

delete/clients/{client_id}

HTTPcURLJavaScriptPython

DELETE /rest/auth/v1/clients/{client_id} HTTP/1.1
Accept: */*

No content