Web service API

How to use PageSeeder's Web service API

<client>

Summary

The XML representation of an OAuth client

Usage context

Attributes

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

Examples

Schema

XML Schema

<xs:element name="client" type="client"/>

<xs:complexType name="client">
  <xs:sequence>
    <xs:element name="member" type="member-core"/>
  </xs:sequence>
  <xs:attribute name="id"               type="id"/>
  <xs:attribute name="identifier"       type="client-identifier" use="required"/>
  <xs:attribute name="requires-consent" type="xs:boolean"        use="required"/>
  <xs:attribute name="confidential"     type="xs:boolean"        use="required"/>
  <xs:attribute name="name"             type="client-name"       use="required"/>
  <xs:attribute name="grant-type"       type="client-granttype"  use="required"/>
  <xs:attribute name="description"      type="xs:string"/>
  <xs:attribute name="client-uri"       type="xs:anyURI"/>
  <xs:attribute name="redirect-uri"     type="xs:anyURI"/>
  <xs:attribute name="scope"            type="xs:string"/>
  <xs:attribute name="access-token-max-age"  type="positive-long" use="required"/>
  <xs:attribute name="refresh-token-max-age" type="positive-long" use="required"/>
</xs:complexType>

Compatibility

See also

Created on , last edited on