Skip to main content

 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-ageThe max age of the access tokens in secondsnolong
app
The name of the app (informational)nostring
client-secretThe client secretnostring
client-uriThe URL for the client app (informational)nostring
descriptionThe description of this client (informational)nostring
grant-typeThe grant type allowed for this client [authorization_code|implicit|password|client_credentials]nostring
identifierThe OAuth 2.0 client ID (admin only)nostring
memberThe member ID or username for this client (admin only)nostring
nameThe name of the client (informational)nostring
redirect-uriThe redirection URI specific to this clientnourl
refresh-token-max-ageThe max age of the refresh tokens in secondsnolong
scopeA space separated list of scopes allow for this client e.g. openid profile emailnostring

Permission

Permissions requirements to be updated.

Response

<client-modification>
  <client id="1"
          identifier="2aa92c5a79baf3fe"
          requires-consent="false"
          confidential="false"
          name="My app"
          grant-type="authorization_code"
          [created="2020-03-08T12:34:00+10:00"]
          [modified="2020-03-10T11:24:00+10:00"]
          [last-token="2020-05-10T10:28:00+10:00"]
          [app="Timesheet"]
          [webhook-secret="S0meP@ssw0d"]
          [redirect-uri="http://example.org/login"]
          [description="My example timesheet"]
          [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-modification>

Error Handling

No specific errors expected for this service.

Created on , last edited on