OAuth2 plugin
Public Member Functions | List of all members
QorusOAuth2RestApi::Oauth2ClientIdRestClass Class Reference
Inheritance diagram for QorusOAuth2RestApi::Oauth2ClientIdRestClass:

Public Member Functions

 constructor (hash< auto > c)
 
string name ()
 
hash< auto > get (hash< auto > cx, __7_ hash< auto > ah)
 
hash< auto > del (hash< auto > cx, __7_ hash< auto > ah)
 
hash< auto > put (hash< auto > cx, __7_ hash< auto > ah)
 

Detailed Description

/oauth2/v1/clients/{id}

This REST URI path provides actions and information for system functionality

Member Function Documentation

◆ del()

hash<auto> QorusOAuth2RestApi::Oauth2ClientIdRestClass::del ( hash< auto >  cx,
__7_ hash< auto >  ah 
)
inline

DELETE

Description
Deletes client info from DB
Return Value
This API returns a hash with the following keys:
  • rows_deleted: (int) number of rows deleted
Errors
  • 404 Not found: "404 Not Found: class \"oauth2\clients\" has no subclass <client_id>"

◆ get()

hash<auto> QorusOAuth2RestApi::Oauth2ClientIdRestClass::get ( hash< auto >  cx,
__7_ hash< auto >  ah 
)
inline

GET

Description
Returns a hash of client information
Return Value
This API returns a hash with the following keys:
  • client_id: (string) unique identifier of the client
  • username: (string) user associated with the client
  • created: (date) date of record creation
  • modified: (date) date of record last modification
  • permissions: (list of strings) client's permissions
Errors
  • 404 Not found: "404 Not Found: class \"oauth2\clients\" has no subclass <client_id>"

◆ put()

hash<auto> QorusOAuth2RestApi::Oauth2ClientIdRestClass::put ( hash< auto >  cx,
__7_ hash< auto >  ah 
)
inline

PUT

Description
Updates client info in DB
Arguments
This API takes the following hash arguments (either as URI arguments or in the message body):
  • client_id: (string) unique identifier of the client
  • client_secret: (string) secret associated with the client
  • username: (string) user associated with the client
  • permissions: (list) list of permissions
Return Value
This API returns a hash with the following keys:
  • inserted: json describing inserted data
Errors
  • 404 Not found: "404 Not Found: class \"oauth2\clients\" has no subclass <client_id>"
The documentation for this class was generated from the following file: