Versions Compared

Old Version 10

changes.mady.by.user Kevin Wu

Saved on

compared with

New Version Current

changes.mady.by.user Yeok Hong Ng

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Scopes can be added and removed using the /scope endpoint URI after the Management API base URI , as is set in the custom.conf file while setting up the Authorization Server.

Info

Example - Scope endpoint URI

http(s)://hostname:port/authserver/management-api-base-uri/scope

The following table lists all HTTP APIs available for provisioning scopes and the expected success return value.

...

Info

Example - Client endpoint URI

http(s)://hostname:port/management-api-base-uriauthserver/api/clients

Note

Note!

The client name MUST be unique.

...

URI

HTTP Method

Input Parameters

Input Format and ExampleInput Example

Return Value

Return Format Return and Example

/clients

GET

None

Format:
N/A

Example:
N/A

List of all clients registered

Format:
JSON

Example:
[{"client_name":"Some App","client_id":"YCuIPYVa0GryebpzniAZU5VGqye_dxBGdcXI","client_secret":"Ofy1-QfO3yrFYdk3dj1pmM30GKVre9Q6bMk6V7YIRmqGHwaijQ","scope":"normal_scope admin_scope"}]

/clients/<client_name>

GET

None

Format:
N/A

Example:
N/A

Client details for the <client_name> specified

Format:
JSON

Example:
{"client_name":"Some App","client_id":"YCuIPYVa0GryebpzniAZU5VGqye_dxBGdcXI","client_secret":"Ofy1-QfO3yrFYdk3dj1pmM30GKVre9Q6bMk6V7YIRmqGHwaijQ","scope":"normal_scope admin_scope"}

/clients

POST

client_name and scope of the client to be registered

Format:
JSON

Example:
{"client_name":"Some App","scope":"normal_scope admin_scope"}

Clients details for the <client_name> registered

Format:
JSON

Example:
{"client_name":"Some App","client_id":"YCuIPYVa0GryebpzniAZU5VGqye_dxBGdcXI","client_secret":"Ofy1-QfO3yrFYdk3dj1pmM30GKVre9Q6bMk6V7YIRmqGHwaijQ","scope":"normal_scope admin_scope"}

/clients/<client_name>

DELETE

N/A

Format:
N/A

Example:
N/A

Status for the removal of the client with <client_name>

Format:
JSON

Example:
{"status":"success"}

/clients/<client_name>

PUT

scope of client to be registered or modified if client exists

Format:
JSON

Example:
{"scope":"normal_scope admin_scope"}

Client details for the <client_name> that is registered or modified

Format:
JSON

Example:
{"client_name":"Some App","client_id":"YCuIPYVa0GryebpzniAZU5VGqye_dxBGdcXI","client_secret":"Ofy1-QfO3yrFYdk3dj1pmM30GKVre9Q6bMk6V7YIRmqGHwaijQ","scope":"normal_scope admin_scope"}

/clients/<client_name>

PATCH

N/A

Format:
N/A

Example:
N/A

Client details for the <client_name> that is specified and with new client_id and client_secret generated

Format:
JSON

Example:
{"client_name":"Some App","client_id":"YCuIPYVa0GryebpzniAZU5VGqye_dxBGdcXI","client_secret":"Ofy1-QfO3yrFYdk3dj1pmM30GKVre9Q6bMk6V7YIRmqGHwaijQ","scope":"normal_scope admin_scope"}

...

Info

Example - Access Token URI

if the access-token-uri parameter value was configured to /token. The access token endpoint would be:

http(s)://hostname:port/authserver/token

The client can request for the access token at the access token endpoint by following the steps below:

...