Web service API

How to use PageSeeder's Web service API

oauth client

/oauth/members/{member}/clients/{client} [PATCH]

com.pageseeder.oauth.UpdateClient

Description

Updates an OAuth client.

Parameters

NameDescriptionRequiredTypeDefault value
access-token-max-age the max age of the access tokens in seconds no long
client-secret the client secret no 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
identifier the OAuth 2.0 client ID (admin only) no string
member the member ID or username for this client (admin only) no string
name the name of the client (informational) no 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
scope a space separated list of scopes allow for this client e.g. openid profile email no string

Permission

Undocumented permissions requirements.

Response


 <client-update>
   <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-update>
 

Error handling

No specific errors expected for this generator.

Created on , last edited on