Security Parameter Types
Attribute
Attribute is a name-value pair that can be used to specify any additional information about the Principal not covered by security tokens and roles.
| Attribute | Type | Description | Values/Example |
|---|
| name | String | Specify additional information as a string. | any string |
| value | Any | Specify any additional information. | any content |
InterceptorMessage
| Attribute Name | Type | Description | Values/Example |
|---|
| operation | String | Name of the intercepted operation. | any string |
| parameters | Parameter | An array of Parameter. |
|
| principal | Principal | An array of Principal. |
|
| transactionID | String | Specify here the ID of the message. | any string |
Parameter
| Attribute Name | Type | Description | Values/Example |
|---|
| name | String | Contains the name of the parameter to be manipulated. | any string |
| value | Any | Contains the value of the parameter to be manipulated. | any content |
Deprecated PostprocessorMessage
| Attribute Name | Type | Description | Values/Example |
|---|
| outputMessage | Any | Specify here the output message. | any content |
| operation | String | Holds the name of the operation which will be / was invoked by the request. | any string |
| principal | Principal | An array of Principal. |
|
Deprecated PreprocessorMessage
| Attribute Name | Type | Description | Values/Example |
|---|
| inputMessage | Any | Specify here the input message. | any content |
| operation | String | Holds the name of the operation which will be / was invoked by the request. | any string |
| principal | Principal | An array of Principal. |
|
Principal
| Attribute Name | Type | Description | Values/Example |
|---|
| userID | String | Unique identifier of the user. | any string |
| attributes | Attribute | Attributes is an array of Attribute objects. |
|
| securityTokens | SecurityToken | An array of SecurityToken objects describing the credentials used for authentication. |
|
| roles | Role | Roles is an array of Role objects. |
|
If authentication is not configured, the Principal will have the UserID anonymous with no security tokens, roles, and attributes assigned.
Role
| Attribute Name | Type | Description | Values/Example |
|---|
| name | String | Specifies the name of a role. | any string |
SecurityToken
| Attribute Name | Type | Description | Values/Example |
|---|
| type | String | Defines what mechanism of authentication was used and how the rest of the object is structured. | any string |
| isVerified | Boolean | The attribute IsVerified is set to true, if the given credentials were successfully verified. | true/false |
SecurityTokenBasic
| Attribute Name | Type | Description | Values/Example |
|---|
| userName | String | Contains the user name. | any string |
| password | String | Contains the users password. | any string |
