PHP-CRUD-API

HTTP RESTful CRUD API for OAuthSD
More information: https://oa.dnc.global
Version: 1.0.0
BasePath:/http.api/api.php
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

Methods

[ Jump to Models ]

Table of Contents

OauthClients

OauthOidcLogs

OauthPublicKeys

OauthScopes

OauthUsers

OauthClients

Up
delete /records/oauth_clients/{client_id}
(recordsOauthClientsClientIdDelete)
delete oauth_clients

Path parameters

id (required)
Path Parameter — primary key value

Return type

Long

Example data

Content-Type: application/json
0

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

number of rows affected (integer) Long

Up
get /records/oauth_clients/{client_id}
(recordsOauthClientsClientIdGet)
read oauth_clients

Path parameters

id (required)
Path Parameter — primary key value

Query parameters

include (optional)
Query Parameter — Columns you want to include in the output (comma separated). Example: posts.*,categories.name
exclude (optional)
Query Parameter — Columns you want to exclude from the output (comma separated). Example: posts.content
join (optional)
Query Parameter — Paths (comma separated) to related entities that you want to include. Example: comments,users

Return type

read-oauth_clients

Example data

Content-Type: application/json
{
  "grant_types" : "grant_types",
  "user_id" : "user_id",
  "id_client" : 0,
  "scope" : "scope",
  "redirect_uri" : "redirect_uri",
  "client_id" : "client_id"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

single oauth_clients record read-oauth_clients

Up
patch /records/oauth_clients/{client_id}
(recordsOauthClientsClientIdPatch)
increment oauth_clients

Path parameters

id (required)
Path Parameter — primary key value

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body increment-oauth_clients (optional)
Body Parameter — single oauth_clients record

Return type

Long

Example data

Content-Type: application/json
0

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

number of rows affected (integer) Long

Up
put /records/oauth_clients/{client_id}
(recordsOauthClientsClientIdPut)
update oauth_clients

Path parameters

id (required)
Path Parameter — primary key value

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body update-oauth_clients (optional)
Body Parameter — single oauth_clients record

Return type

Long

Example data

Content-Type: application/json
0

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

number of rows affected (integer) Long

Up
get /records/oauth_clients
(recordsOauthClientsGet)
list oauth_clients

Query parameters

filter (optional)
Query Parameter — Filters to be applied. Each filter consists of a column, an operator and a value (comma separated). Example: id,eq,1
include (optional)
Query Parameter — Columns you want to include in the output (comma separated). Example: posts.*,categories.name
exclude (optional)
Query Parameter — Columns you want to exclude from the output (comma separated). Example: posts.content
order (optional)
Query Parameter — Column you want to sort on and the sort direction (comma separated). Example: id,desc
size (optional)
Query Parameter — Maximum number of results (for top lists). Example: 10
page (optional)
Query Parameter — Page number and page size (comma separated). Example: 1,10
join (optional)
Query Parameter — Paths (comma separated) to related entities that you want to include. Example: comments,users

Return type

list-oauth_clients

Example data

Content-Type: application/json
{
  "records" : [ {
    "grant_types" : "grant_types",
    "user_id" : "user_id",
    "id_client" : 6,
    "scope" : "scope",
    "redirect_uri" : "redirect_uri",
    "client_id" : "client_id"
  }, {
    "grant_types" : "grant_types",
    "user_id" : "user_id",
    "id_client" : 6,
    "scope" : "scope",
    "redirect_uri" : "redirect_uri",
    "client_id" : "client_id"
  } ],
  "results" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

list of oauth_clients records list-oauth_clients

Up
post /records/oauth_clients
(recordsOauthClientsPost)
create oauth_clients

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body create-oauth_clients (optional)
Body Parameter — single oauth_clients record

Return type

UUID

Example data

Content-Type: application/json
"046b6c7f-0b8a-43b9-b35d-6489e6daee91"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

inserted primary key value (string) UUID

OauthOidcLogs

Up
get /records/oauth_oidc_logs
(recordsOauthOidcLogsGet)
list oauth_oidc_logs

Query parameters

filter (optional)
Query Parameter — Filters to be applied. Each filter consists of a column, an operator and a value (comma separated). Example: id,eq,1
include (optional)
Query Parameter — Columns you want to include in the output (comma separated). Example: posts.*,categories.name
exclude (optional)
Query Parameter — Columns you want to exclude from the output (comma separated). Example: posts.content
order (optional)
Query Parameter — Column you want to sort on and the sort direction (comma separated). Example: id,desc
size (optional)
Query Parameter — Maximum number of results (for top lists). Example: 10
page (optional)
Query Parameter — Page number and page size (comma separated). Example: 1,10
join (optional)
Query Parameter — Paths (comma separated) to related entities that you want to include. Example: comments,users

Return type

list-oauth_oidc_logs

Example data

Content-Type: application/json
{
  "records" : [ {
    "remote_addr" : "remote_addr",
    "datetime" : "2000-01-23",
    "id_oidc_log" : 6,
    "user_id" : "user_id",
    "level" : true,
    "origin" : "origin",
    "state" : "state",
    "message" : "message",
    "client_id" : "client_id"
  }, {
    "remote_addr" : "remote_addr",
    "datetime" : "2000-01-23",
    "id_oidc_log" : 6,
    "user_id" : "user_id",
    "level" : true,
    "origin" : "origin",
    "state" : "state",
    "message" : "message",
    "client_id" : "client_id"
  } ],
  "results" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

list of oauth_oidc_logs records list-oauth_oidc_logs

OauthPublicKeys

Up
get /records/oauth_public_keys
(recordsOauthPublicKeysGet)
list oauth_public_keys

Query parameters

filter (optional)
Query Parameter — Filters to be applied. Each filter consists of a column, an operator and a value (comma separated). Example: id,eq,1
include (optional)
Query Parameter — Columns you want to include in the output (comma separated). Example: posts.*,categories.name
exclude (optional)
Query Parameter — Columns you want to exclude from the output (comma separated). Example: posts.content
order (optional)
Query Parameter — Column you want to sort on and the sort direction (comma separated). Example: id,desc
size (optional)
Query Parameter — Maximum number of results (for top lists). Example: 10
page (optional)
Query Parameter — Page number and page size (comma separated). Example: 1,10
join (optional)
Query Parameter — Paths (comma separated) to related entities that you want to include. Example: comments,users

Return type

list-oauth_public_keys

Example data

Content-Type: application/json
{
  "records" : [ {
    "public_key" : "public_key"
  }, {
    "public_key" : "public_key"
  } ],
  "results" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

list of oauth_public_keys records list-oauth_public_keys

OauthScopes

Up
get /records/oauth_scopes
(recordsOauthScopesGet)
list oauth_scopes

Query parameters

filter (optional)
Query Parameter — Filters to be applied. Each filter consists of a column, an operator and a value (comma separated). Example: id,eq,1
include (optional)
Query Parameter — Columns you want to include in the output (comma separated). Example: posts.*,categories.name
exclude (optional)
Query Parameter — Columns you want to exclude from the output (comma separated). Example: posts.content
order (optional)
Query Parameter — Column you want to sort on and the sort direction (comma separated). Example: id,desc
size (optional)
Query Parameter — Maximum number of results (for top lists). Example: 10
page (optional)
Query Parameter — Page number and page size (comma separated). Example: 1,10
join (optional)
Query Parameter — Paths (comma separated) to related entities that you want to include. Example: comments,users

Return type

list-oauth_scopes

Example data

Content-Type: application/json
{
  "records" : [ {
    "scope" : "scope",
    "scope_description" : "scope_description",
    "is_default" : true
  }, {
    "scope" : "scope",
    "scope_description" : "scope_description",
    "is_default" : true
  } ],
  "results" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

list of oauth_scopes records list-oauth_scopes

Up
post /records/oauth_scopes
(recordsOauthScopesPost)
create oauth_scopes

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body create-oauth_scopes (optional)
Body Parameter — single oauth_scopes record

Return type

UUID

Example data

Content-Type: application/json
"046b6c7f-0b8a-43b9-b35d-6489e6daee91"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

inserted primary key value (string) UUID

Up
delete /records/oauth_scopes/{scope}
(recordsOauthScopesScopeDelete)
delete oauth_scopes

Path parameters

id (required)
Path Parameter — primary key value

Return type

Long

Example data

Content-Type: application/json
0

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

number of rows affected (integer) Long

Up
get /records/oauth_scopes/{scope}
(recordsOauthScopesScopeGet)
read oauth_scopes

Path parameters

id (required)
Path Parameter — primary key value

Query parameters

include (optional)
Query Parameter — Columns you want to include in the output (comma separated). Example: posts.*,categories.name
exclude (optional)
Query Parameter — Columns you want to exclude from the output (comma separated). Example: posts.content
join (optional)
Query Parameter — Paths (comma separated) to related entities that you want to include. Example: comments,users

Return type

read-oauth_scopes

Example data

Content-Type: application/json
{
  "scope" : "scope",
  "scope_description" : "scope_description",
  "is_default" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

single oauth_scopes record read-oauth_scopes

Up
patch /records/oauth_scopes/{scope}
(recordsOauthScopesScopePatch)
increment oauth_scopes

Path parameters

id (required)
Path Parameter — primary key value

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body increment-oauth_scopes (optional)
Body Parameter — single oauth_scopes record

Return type

Long

Example data

Content-Type: application/json
0

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

number of rows affected (integer) Long

Up
put /records/oauth_scopes/{scope}
(recordsOauthScopesScopePut)
update oauth_scopes

Path parameters

id (required)
Path Parameter — primary key value

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body update-oauth_scopes (optional)
Body Parameter — single oauth_scopes record

Return type

Long

Example data

Content-Type: application/json
0

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

number of rows affected (integer) Long

OauthUsers

Up
get /records/oauth_users
(recordsOauthUsersGet)
list oauth_users

Query parameters

filter (optional)
Query Parameter — Filters to be applied. Each filter consists of a column, an operator and a value (comma separated). Example: id,eq,1
include (optional)
Query Parameter — Columns you want to include in the output (comma separated). Example: posts.*,categories.name
exclude (optional)
Query Parameter — Columns you want to exclude from the output (comma separated). Example: posts.content
order (optional)
Query Parameter — Column you want to sort on and the sort direction (comma separated). Example: id,desc
size (optional)
Query Parameter — Maximum number of results (for top lists). Example: 10
page (optional)
Query Parameter — Page number and page size (comma separated). Example: 1,10
join (optional)
Query Parameter — Paths (comma separated) to related entities that you want to include. Example: comments,users

Return type

list-oauth_users

Example data

Content-Type: application/json
{
  "records" : [ {
    "birthday" : "birthday",
    "street_address" : "street_address",
    "country" : "country",
    "updated_time" : "2000-01-23",
    "zoneinfo" : "zoneinfo",
    "gender" : "gender",
    "locale" : "locale",
    "maj" : "2000-01-23T04:56:07.000+00:00",
    "scope" : "scope",
    "nickname" : "nickname",
    "email" : "email",
    "created_time" : "2000-01-23",
    "website" : "website",
    "profil" : "profil",
    "profile" : "profile",
    "verified" : true,
    "locality" : "locality",
    "id_user" : 6,
    "given_name" : "given_name",
    "middle_name" : "middle_name",
    "picture" : "picture",
    "phone_number" : "phone_number",
    "comment" : "comment",
    "region" : "region",
    "postal_code" : "postal_code",
    "family_name" : "family_name",
    "statut" : "statut",
    "username" : "username"
  }, {
    "birthday" : "birthday",
    "street_address" : "street_address",
    "country" : "country",
    "updated_time" : "2000-01-23",
    "zoneinfo" : "zoneinfo",
    "gender" : "gender",
    "locale" : "locale",
    "maj" : "2000-01-23T04:56:07.000+00:00",
    "scope" : "scope",
    "nickname" : "nickname",
    "email" : "email",
    "created_time" : "2000-01-23",
    "website" : "website",
    "profil" : "profil",
    "profile" : "profile",
    "verified" : true,
    "locality" : "locality",
    "id_user" : 6,
    "given_name" : "given_name",
    "middle_name" : "middle_name",
    "picture" : "picture",
    "phone_number" : "phone_number",
    "comment" : "comment",
    "region" : "region",
    "postal_code" : "postal_code",
    "family_name" : "family_name",
    "statut" : "statut",
    "username" : "username"
  } ],
  "results" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

list of oauth_users records list-oauth_users

Up
delete /records/oauth_users/{id_user}
(recordsOauthUsersIdUserDelete)
delete oauth_users

Path parameters

id (required)
Path Parameter — primary key value

Return type

Long

Example data

Content-Type: application/json
0

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

number of rows affected (integer) Long

Up
get /records/oauth_users/{id_user}
(recordsOauthUsersIdUserGet)
read oauth_users

Path parameters

id (required)
Path Parameter — primary key value

Query parameters

include (optional)
Query Parameter — Columns you want to include in the output (comma separated). Example: posts.*,categories.name
exclude (optional)
Query Parameter — Columns you want to exclude from the output (comma separated). Example: posts.content
join (optional)
Query Parameter — Paths (comma separated) to related entities that you want to include. Example: comments,users

Return type

read-oauth_users

Example data

Content-Type: application/json
{
  "birthday" : "birthday",
  "street_address" : "street_address",
  "country" : "country",
  "updated_time" : "2000-01-23",
  "zoneinfo" : "zoneinfo",
  "gender" : "gender",
  "locale" : "locale",
  "maj" : "2000-01-23T04:56:07.000+00:00",
  "scope" : "scope",
  "nickname" : "nickname",
  "email" : "email",
  "created_time" : "2000-01-23",
  "website" : "website",
  "profil" : "profil",
  "profile" : "profile",
  "verified" : true,
  "locality" : "locality",
  "id_user" : 0,
  "given_name" : "given_name",
  "middle_name" : "middle_name",
  "picture" : "picture",
  "phone_number" : "phone_number",
  "comment" : "comment",
  "region" : "region",
  "postal_code" : "postal_code",
  "family_name" : "family_name",
  "statut" : "statut",
  "username" : "username"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

single oauth_users record read-oauth_users

Up
patch /records/oauth_users/{id_user}
(recordsOauthUsersIdUserPatch)
increment oauth_users

Path parameters

id (required)
Path Parameter — primary key value

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body increment-oauth_users (optional)
Body Parameter — single oauth_users record

Return type

Long

Example data

Content-Type: application/json
0

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

number of rows affected (integer) Long

Up
put /records/oauth_users/{id_user}
(recordsOauthUsersIdUserPut)
update oauth_users

Path parameters

id (required)
Path Parameter — primary key value

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body update-oauth_users (optional)
Body Parameter — single oauth_users record

Return type

Long

Example data

Content-Type: application/json
0

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

number of rows affected (integer) Long

Up
post /records/oauth_users
(recordsOauthUsersPost)
create oauth_users

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body create-oauth_users (optional)
Body Parameter — single oauth_users record

Return type

Long

Example data

Content-Type: application/json
0

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

inserted primary key value (integer) Long

Models

[ Jump to Methods ]

Table of Contents

  1. create-oauth_clients
  2. create-oauth_scopes
  3. create-oauth_users
  4. increment-oauth_clients
  5. increment-oauth_scopes
  6. increment-oauth_users
  7. list-oauth_clients
  8. list-oauth_oidc_logs
  9. list-oauth_public_keys
  10. list-oauth_scopes
  11. list-oauth_users
  12. listoauth_clients_records
  13. listoauth_oidc_logs_records
  14. listoauth_public_keys_records
  15. listoauth_scopes_records
  16. listoauth_users_records
  17. read-oauth_clients
  18. read-oauth_scopes
  19. read-oauth_users
  20. update-oauth_clients
  21. update-oauth_scopes
  22. update-oauth_users

create-oauth_clients Up

id_client (optional)
Integer format: int32
client_id (optional)
redirect_uri (optional)
grant_types (optional)
scope (optional)
user_id (optional)

create-oauth_scopes Up

scope (optional)
is_default (optional)
scope_description (optional)

create-oauth_users Up

id_user (optional)
Integer format: int32
username (optional)
given_name (optional)
middle_name (optional)
family_name (optional)
nickname (optional)
profil (optional)
picture (optional)
website (optional)
email (optional)
verified (optional)
gender (optional)
birthday (optional)
zoneinfo (optional)
locale (optional)
phone_number (optional)
street_address (optional)
locality (optional)
region (optional)
postal_code (optional)
country (optional)
updated_time (optional)
date format: date
created_time (optional)
date format: date
statut (optional)
maj (optional)
Date format: date-time
profile (optional)
comment (optional)
scope (optional)

increment-oauth_clients Up

id_client (optional)
Integer format: int32
client_id (optional)
redirect_uri (optional)
grant_types (optional)
scope (optional)
user_id (optional)

increment-oauth_scopes Up

scope (optional)
is_default (optional)
scope_description (optional)

increment-oauth_users Up

id_user (optional)
Integer format: int32
username (optional)
given_name (optional)
middle_name (optional)
family_name (optional)
nickname (optional)
profil (optional)
picture (optional)
website (optional)
email (optional)
verified (optional)
gender (optional)
birthday (optional)
zoneinfo (optional)
locale (optional)
phone_number (optional)
street_address (optional)
locality (optional)
region (optional)
postal_code (optional)
country (optional)
updated_time (optional)
date format: date
created_time (optional)
date format: date
statut (optional)
maj (optional)
Date format: date-time
profile (optional)
comment (optional)
scope (optional)

list-oauth_clients Up

results (optional)
Long format: int64
records (optional)

list-oauth_oidc_logs Up

results (optional)
Long format: int64
records (optional)

list-oauth_public_keys Up

results (optional)
Long format: int64
records (optional)

list-oauth_scopes Up

results (optional)
Long format: int64
records (optional)

list-oauth_users Up

results (optional)
Long format: int64
records (optional)

listoauth_clients_records Up

id_client (optional)
Integer format: int32
client_id (optional)
redirect_uri (optional)
grant_types (optional)
scope (optional)
user_id (optional)

listoauth_oidc_logs_records Up

id_oidc_log (optional)
Integer format: int32
remote_addr (optional)
state (optional)
client_id (optional)
user_id (optional)
datetime (optional)
date format: date
origin (optional)
message (optional)
level (optional)

listoauth_public_keys_records Up

public_key (optional)

listoauth_scopes_records Up

scope (optional)
is_default (optional)
scope_description (optional)

listoauth_users_records Up

id_user (optional)
Integer format: int32
username (optional)
given_name (optional)
middle_name (optional)
family_name (optional)
nickname (optional)
profil (optional)
picture (optional)
website (optional)
email (optional)
verified (optional)
gender (optional)
birthday (optional)
zoneinfo (optional)
locale (optional)
phone_number (optional)
street_address (optional)
locality (optional)
region (optional)
postal_code (optional)
country (optional)
updated_time (optional)
date format: date
created_time (optional)
date format: date
statut (optional)
maj (optional)
Date format: date-time
profile (optional)
comment (optional)
scope (optional)

read-oauth_clients Up

id_client (optional)
Integer format: int32
client_id (optional)
redirect_uri (optional)
grant_types (optional)
scope (optional)
user_id (optional)

read-oauth_scopes Up

scope (optional)
is_default (optional)
scope_description (optional)

read-oauth_users Up

id_user (optional)
Integer format: int32
username (optional)
given_name (optional)
middle_name (optional)
family_name (optional)
nickname (optional)
profil (optional)
picture (optional)
website (optional)
email (optional)
verified (optional)
gender (optional)
birthday (optional)
zoneinfo (optional)
locale (optional)
phone_number (optional)
street_address (optional)
locality (optional)
region (optional)
postal_code (optional)
country (optional)
updated_time (optional)
date format: date
created_time (optional)
date format: date
statut (optional)
maj (optional)
Date format: date-time
profile (optional)
comment (optional)
scope (optional)

update-oauth_clients Up

id_client (optional)
Integer format: int32
client_id (optional)
redirect_uri (optional)
grant_types (optional)
scope (optional)
user_id (optional)

update-oauth_scopes Up

scope (optional)
is_default (optional)
scope_description (optional)

update-oauth_users Up

id_user (optional)
Integer format: int32
username (optional)
given_name (optional)
middle_name (optional)
family_name (optional)
nickname (optional)
profil (optional)
picture (optional)
website (optional)
email (optional)
verified (optional)
gender (optional)
birthday (optional)
zoneinfo (optional)
locale (optional)
phone_number (optional)
street_address (optional)
locality (optional)
region (optional)
postal_code (optional)
country (optional)
updated_time (optional)
date format: date
created_time (optional)
date format: date
statut (optional)
maj (optional)
Date format: date-time
profile (optional)
comment (optional)
scope (optional)