. "EntryPoint - user_authenticate_webid" . "

Authenticate with, register with, or connect a WebID.

" . . "

This method represents the ODS support for WebID authentiction. It can be used to connect an ODS account to a WebID, to register a new ODS account using a WebID, or to authenticate a user via their WebID. In addition ODS supports X.509 certificates without an embedded WebID.

Clients need to call this method through an SSL connection providing the X.509 client certifcate which should be used for authentication, registration, or to connect to an account. In the case of account connection the user need to authenticate themselves in addition to providing the certificate. Any of the supported ways can be used except for the certificate itself. Typically clients will use a session ID. See ODS Authentication for details.

VSP or PHP clients that do not have access to the client certifcate's private key can use user.authenticate.authenticationUrl() with a service values of webid.

\nWebID Storage\n

WedIDs will be stored like other 3rd party online accounts as handled by user.authenticate.authenticationUrl(). As such they are listed via user.onlineAccounts.list() with service type \"webid\" and a uri that is the actual WebID.

  • \n\naction\n\n\n

    The action to perform. See Authentication Action Types for details on the supported actions.

    \n
    • \n
  • \n\nconfirm\n\n\n

    The confirmation mode. See Authentication Confirmation Mode for details on the supported modes.

    \n
    • \n\n

    A valid ODS session or the confirmation session encoded as an XML stream. In case the client authenticated with a session ID for the connect action this session ID will be returned.

    \n

    user.authenticate(), user.authenticate.authenticationUrl()

    \n

    \n\nExample User Session:\n

    The user session object contains:\n

    The session ID sid

    The user with username uname, the internal numerical uid, and two flags:\n

    dba indicates if the user is the dba user, ie. has administrator privileges.

    new indicates if this user has been newly registered. This is useful for client to show some welcome message or the like.

    \n

    \n

    \n <userSession>\n   <sid>1de236f5da2f32d92e8c0cce5053a96e</sid>\n   <user>\n     <uname>demo</uname>\n     <uid>127</uid>\n     <new>0</new>\n     <dba>0</dba>\n   </user>\n </userSession>\n

    \n\nExample Confirmation Session:\n

    \n <confirmSession>\n   <cid></cid>\n   <user>\n     <name></name>\n     <email></email>\n   </user>\n   <onlineAccount>\n     <service>webid</service>\n     <uid></uid>\n   </onlineAccount>\n   <reason>\n     <code>invalid_username</code>\n     <msg>The login name contains invalid characters</msg>\n   </reason>\n </confirmSession>\n

    Authentication

    This function will provide additional information if authentication via one of the supported methods as described in ODS Authentication is used.

    \n

    " . . . . "GET" . "text/xml" . .