Web service API

How to use PageSeeder's Web service API

oauth clients

/oauth/members/{member}/clients [POST]

com.pageseeder.oauth.CreateClient

Description

Create an OAuth client.

Parameters

NameDescriptionRequiredTypeDefault value
name the name of the client (informational) yes string
access-token-max-age the max age of the access tokens in seconds no long 1 hour
client-secret the client secret no string [random string]
client-uri the URL for the client application (informational) no string
description the description of this client (informational) no string
grant-type the grant type allowed for this client [authorization_code|implicit|password|client_credentials] no string authorization_code
identifier the OAuth 2.0 client ID (admin only) no string [random string]
redirect-uri the redirection URI specific to this client no url
refresh-token-max-age the max age of the refresh tokens in seconds no long 30 days
scope a space separated list of scopes allow for this client e.g. openid profile email no string

Permission

Undocumented permissions requirements.

Response

 <client-registration>
   <client id="1"
       identifier="2aa92c5a79baf3fe"
       requires-consent="false"
       confidential="false"
       name="My app"
       grant-type="authorization_code"
       description="My example app"
       client-uri="http://example.org"
       scope="openid profile email"
       access-token-max-age="7200"
       refresh-token-max-age="0">
     <member id="45" ...>
       <fullname>John Smith</fullname>
     </member>
   </client>
 </client-registration>
 

Error Handling

No specific errors expected for this generator.

Created on , last edited on