Administrative Area Components

• User
• Group
• Containered Asset
• Asset Factory
• Asset Factory Container
• Page Configuration Set
• Page Configuration Set Container
• Structured Data Definition
• Asset Factory Container
• Metadata Set
• Metadata Set Container
• Publish Set
• Publish Set Container
• Target
• Destination
• File System Transport
• FTP Transport
• Workflow Definition
• Workflow Definition Container

NEWS & TIPS

• Site Access Keys
• Top: Alt+t
  Previous: Alt+,
  Next: Alt+.
  Up: Alt+;
  (Note: use Ctrl on the Mac)

User

A User is defined in the following WSDL:

<complexType name="user"> <sequence> <!-- the username of the user REQUIRED --> <element maxOccurs="1" minOccurs="1" name="username" type="xsd:string"/> <!-- the full name of the user REQUIRED --> <element maxOccurs="1" minOccurs="1" name="fullName" type="xsd:string"/> <!-- the user's email REQUIRED --> <element maxOccurs="1" minOccurs="1" name="email" type="xsd:string"/> <!-- the way the user is authenticated REQUIRED --> <element maxOccurs="1" minOccurs="1" name="authType" type="impl:user-auth-types"/> <!-- The password for this user when authtype is custom, this is not used REQUIRED --> <element maxOccurs="1" minOccurs="1" name="password" type="xsd:string"/> <!-- Whether or not this user is enabled NOT REQUIRED default false --> <element maxOccurs="1" minOccurs="0" name="enabled" type="xsd:boolean"/> <!-- A semi-colon separated list of groups this user is a member of REQUIRED --> <element maxOccurs="1" minOccurs="1" name="groups" type="xsd:string"/> <!-- This user's default group NOT REQUIRED default: none --> <element maxOccurs="1" minOccurs="0" name="defaultGroup" type="xsd:string"/> <!-- This user's highest role REQUIRED --> <element maxOccurs="1" minOccurs="1" name="role" type="impl:roles"/> </sequence> </complexType>

The WSDL for the user complex type contains all the fields one is used to seeing in the web interface when creating or editing a user. The required fields are as follows: user name, full name, email, authentication type, password, groups, and role.

Some things to note: when specifying the authentication type, use one of "normal", "ldap", or "custom". This is defined by the following simple type restriction in the WSDL:

<simpleType name="user-auth-types"> <restriction base="xsd:string"> <!-- Normal authentication against information stored in Cascade Server itself --> <enumeration value="normal"/> <!-- Cascade server will delegate to an LDAP server for the authentication process --> <enumeration value="ldap"/> <!-- Custom module written to authenticate (SSO, for example) --> <enumeration value="custom"/> </restriction> </simpleType>

Also, when specifying the user's groups, list the groups as a semi-colon delimited list, i.e. "group1;group2;group3". When specifying the user's role, one only need specify the highest role for that user due to the fact that roles are cumulative. The roles are defined by the following simple type restriction in the WSDL:

<simpleType name="roles"> <restriction base="xsd:string"> <enumeration value="administrator"/> <enumeration value="manager"/> <enumeration value="publisher"/> <enumeration value="approver"/> <enumeration value="contributor"/> </restriction> </simpleType>

Comments

Wiki | Edit