Not logged in : Login
(Sponging disallowed)

About: EntryPoint - user_authenticate_webid     Goto   Sponge   NotDistinct   Permalink

An Entity of Type : schema:EntryPoint, within Data Space : www.openlinksw.com associated with source document(s)
QRcode icon
http://www.openlinksw.com/describe/?url=http%3A%2F%2Fwww.openlinksw.com%2FDAV%2FVAD%2Fwa%2FAPI_user.ttl%23action_user.authenticate.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. WebID Storage 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. action The action to perform. See Authentication Action Types for details on the supported actions. confirm The confirmation mode. See Authentication Confirmation Mode for details on the supported modes. 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. user.authenticate(), user.authenticate.authenticationUrl() Example User Session: The user session object contains: The session ID sid The user with username uname, the internal numerical uid, and two flags: 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. 1de236f5da2f32d92e8c0cce5053a96e demo 127 0 0 Example Confirmation Session: webid invalid_username The login name contains invalid characters AuthenticationThis function will provide additional information if authentication via one of the supported methods as described in ODS Authentication is used.

AttributesValues
description
  • 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.

    WebID Storage

    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.

  • action

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

  • confirm

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

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.

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

Example User Session:

The user session object contains:

The session ID sid

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

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.

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

Example Confirmation Session:

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

Authentication

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

title
  • EntryPoint - user_authenticate_webid
url
type
isWebServiceOf
hasParameter
contentType
  • text/xml
httpMethod
  • GET
oplwebservices:endPointURL
schema:shortDescription
  • Authenticate with, register with, or connect a WebID.

is target of
Faceted Search & Find service v1.17_git122 as of Jan 03 2023


Alternative Linked Data Documents: iSPARQL | ODE     Content Formats:   [cxml] [csv]     RDF   [text] [turtle] [ld+json] [rdf+json] [rdf+xml]     ODATA   [atom+xml] [odata+json]     Microdata   [microdata+json] [html]    About   
This material is Open Knowledge   W3C Semantic Web Technology [RDF Data] Valid XHTML + RDFa
OpenLink Virtuoso version 08.03.3330 as of Apr 5 2024, on Linux (x86_64-generic-linux-glibc25), Single-Server Edition (30 GB total memory, 25 GB memory in use)
Data on this page belongs to its respective rights holders.
Virtuoso Faceted Browser Copyright © 2009-2024 OpenLink Software