Companywebcast API Wiki

SsoService Web Service

http://services.companywebcast.com/sso/1.0/SsoService.svc?wsdl

Description

This service provides a means to encrypt, decrypt and validate tokens 

See Also

Methods | Complex Types

Methods: SsoService

Methods
Name  Description 
AssembleUserToken  Assembles a user token 
AssembleVisitorToken  Assembles a visitor token 
DisassembleToken  Decrypts an encrypted token 
ValidateToken  Checks if a token is valid for a specific webcast 
Method: AssembleUserToken
Description

Assembles a user token 

Parameters
Name  Type  Direction  Description 
AssembleUserTokenIn  AssembleUserTokenIn  Input  Contains required information to build a user token
Returns

A AssembleUserTokenResult element having the structure defined by the following table.

Name  Type  Description 
Result  ResultCode  Result of the requested action
Errors  Errors  A list of errors that occurred during the request
Token  string  A security token
Method: AssembleVisitorToken
Description

Assembles a visitor token 

Parameters
Name  Type  Direction  Description 
AssembleVisitorTokenIn  AssembleVisitorTokenIn  Input  Contains required information to build a visitor token
Returns

A AssembleVisitorTokenResult element having the structure defined by the following table.

Name  Type  Description 
Result  ResultCode  Result of the requested action
Errors  Errors  A list of errors that occurred during the request
Token  string  A security token
Method: DisassembleToken
Description

Decrypts an encrypted token 

Parameters
Name  Type  Direction  Description 
DisassembleTokenIn  DisassembleTokenIn  Input  Contains the token to be decrypted
Returns

A DisassembleTokenResult element having the structure defined by the following table.

Name  Type  Description 
Result  ResultCode  Result of the requested action
Errors  Errors  A list of errors that occurred during the request
SsoToken  SsoToken  A dissasembled SsoToken
Method: ValidateToken
Description

Checks if a token is valid for a specific webcast 

Parameters
Name  Type  Direction  Description 
ValidateTokenIn  ValidateTokenIn  Input  Contains the token to be checked for validity
Returns

A ValidateTokenResult element having the structure defined by the following table.

Name  Type  Description 
Result  ResultCode  Result of the requested action
Errors  Errors  A list of errors that occurred during the request
IsValid  boolean  True if valid

Complex Types: SsoService

Complex Types
Name  Description 
AssembleTokenOut  Helper class Contains an assembled token or an error
AssembleUserTokenIn  Helper class Contains properties required to build a
AssembleVisitorTokenIn  Helper class Contains properties required to build a visitor token
DisassembleTokenIn  Helper class Contains properties used to disassemble a token
DisassembleTokenOut  Helper class contains a disassembled token or an error
Errors  A collection of errors
RequestBase   
ResponseBase   
SsoToken  proxy token class Replaces SsoUserToken or SsoVisitorToken
SsoUserToken  Token containing properties required to generate a user token
SsoVisitorToken  Token containing properties required to generate a visitor token
ValidateTokenIn  Helper class Contains properties that are required to validate a token
ValidateTokenOut  Helper class Used to check if a token has been succesfully validated
Complex Type: AssembleTokenOut
Description

Helper class Contains an assembled token or an error

Derived By

Extending ResponseBase

Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
  1..1   
Result  ResultCode  1..1  Result of the requested action
Errors  Errors  0..1  A list of errors that occurred during the request
Token  string  1..1  A security token
Complex Type: AssembleUserTokenIn
Description

Helper class Contains properties required to build a

Derived By

Extending RequestBase

Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
  1..1   
Password  string  1..1  The user's password
Username  string  1..1  The user's username
SsoUserToken  SsoUserToken  1..1  A SsoUserToken
Complex Type: AssembleVisitorTokenIn
Description

Helper class Contains properties required to build a visitor token

Derived By

Extending RequestBase

Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
  1..1   
Password  string  1..1  Password of the user who requests the token (not the visitor!)
Username  string  1..1  Username of the user who requests the token (not the visitor!)
SsoVisitorToken  SsoVisitorToken  1..1  A SsoVisitorToken
Complex Type: DisassembleTokenIn
Description

Helper class Contains properties used to disassemble a token

Derived By

Extending RequestBase

Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
  1..1   
Username  string  1..1  A username
Password  string  1..1  A password
Token  string  1..1  The token to be disassembled
Complex Type: DisassembleTokenOut
Description

Helper class contains a disassembled token or an error

Derived By

Extending ResponseBase

Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
  1..1   
Result  ResultCode  1..1  Result of the requested action
Errors  Errors  0..1  A list of errors that occurred during the request
SsoToken  SsoToken  1..1  A dissasembled SsoToken
Complex Type: Errors
Description

A collection of errors

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
  1..1   
string  string  0..*   
Complex Type: RequestBase
Derived By

Restricting anyType

Referenced By
Name  Type 
AssembleUserTokenIn  Complex Type 
AssembleVisitorTokenIn  Complex Type 
DisassembleTokenIn  Complex Type 
ValidateTokenIn  Complex Type 
Complex Type: ResponseBase
Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
  1..1   
Result  ResultCode  1..1  Result of the requested action
Errors  Errors  0..1  A list of errors that occurred during the request
Referenced By
Name  Type 
AssembleTokenOut  Complex Type 
DisassembleTokenOut  Complex Type 
ValidateTokenOut  Complex Type 
Complex Type: SsoToken
Description

proxy token class Replaces SsoUserToken or SsoVisitorToken

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
  1..1   
CustomerCode  string  1..1  Uniquely identifies a customer for which this token will be valid
Expires  dateTime  1..1  (UTC) datetime after which this token will become invalid
UserName  string  0..1  Uniquely identifies a user
VisitorEmail  string  0..1  Uniquely identifies a visitor
WebcastName  string  0..1  Indicates a webcast for which this token will be valid
Complex Type: SsoUserToken
Description

Token containing properties required to generate a user token

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
  1..1   
Expires  dateTime  1..1  (UTC) datetime after which this token will become invalid
Complex Type: SsoVisitorToken
Description

Token containing properties required to generate a visitor token

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
  1..1   
Expires  dateTime  1..1  (UTC) datetime after which this token will become invalid
VisitorEmail  string  0..1  Uniquely identifies a visitor
WebcastCode  string  1..1  Indicates a webcast for which this token will be valid
Complex Type: ValidateTokenIn
Description

Helper class Contains properties that are required to validate a token

Derived By

Extending RequestBase

Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
  1..1   
Token  string  1..1  Token to be validated
WebcastCode  string  1..1  Webcast to which this token belongs
Complex Type: ValidateTokenOut
Description

Helper class Used to check if a token has been succesfully validated

Derived By

Extending ResponseBase

Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
  1..1   
Result  ResultCode  1..1  Result of the requested action
Errors  Errors  0..1  A list of errors that occurred during the request
IsValid  boolean  0..1  True if valid