Skip to main content

 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
nameThe name of the client (informational)yesstring
app
The name of the app (informational)nostring
access-token-max-ageThe max age of the access tokens in secondsnolong1 hour
client-secretThe client secretnostring[random string]
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]
nostringauthorization_code
identifierThe OAuth 2.0 client ID (admin only)nostring[random string]
redirect-uriThe redirection URI specific to this clientnourl
refresh-token-max-ageThe max age of the refresh tokens in secondsnolong30 days
scopeA space separated list of scopes allow for this client e.g. openid
profile email
nostring

Permission

Permissions requirements to be updated.

Response

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

Error Handling

No specific errors expected for this service.

Created on , last edited on