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 seconds.nolong
client-secretThe client secret.nostring
client-uriThe URL for the client application (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 client.nourl
refresh-token-max-ageThe max age of the refresh tokens in seconds.nolong
scopeA space separated list of scopes allow for this client e.g. openid profile email.nostring

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"
            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-modification>

Error Handling

No specific errors expected for this generator.

Created on , last edited on