Jump to

• Request
• Response

View This Webservice Token Handler Collection

get

/management/weblogic/{version}/edit/webserviceSecurities/{name}/webserviceTokenHandlers

View this webservice token handler collection.

Request

Path Parameters

• name: string
  The name property of the instance in the collection.
• version: string
  The version of the WebLogic REST interface.

Query Parameters

• excludeFields(optional): string
  The 'excludeFields' query parameter is used to restrict which fields are returned in the response. It is a comma separated list of field names. If present, only fields whose name is not on the list will be returned. If not present, all fields are returned (unless the 'fields' query parameter is specified). Note: 'fields' must not be specified if 'excludeFields' is specified.
• excludeLinks(optional): string
  The 'excludeLinks' query parameter is used to restrict which links are returned in the response. It is a comma separated list of link relationship names. If present, only links whose relationship name is not on the list will be returned. If not present, all links are returned (unless the 'links' query parameter is specified). Note: 'links' must not be specified if 'excludeLinks' is specified.
• fields(optional): string
  The 'fields' query parameter is used to restrict which fields are returned in the response. It is a comma separated list of field names. If present, only fields with matching names are returned. If not present, all fields are returned (unless the 'excludeFields' query parameter is specified). Note: 'excludeFields' must not be specified if 'fields' is specified.
• links(optional): string
  The 'links' query parameter is used to restrict which links are returned in the response. It is a comma separated list of link relationship names. If present, only links with matching relationship names are returned. If not present, all links are returned (unless the 'excludeLinks' query parameter is specified). Note: 'excludeLinks' must not be specified if 'links' is specified.

Security

• Admin: basic
  Type: basic

  Description: A user in the Admin security role.
• Deployer: basic
  Type: basic

  Description: A user in the Deployer security role.
• Monitor: basic
  Type: basic

  Description: A user in the Monitor security role.
• Operator: basic
  Type: basic

  Description: A user in the Operator security role.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returns a list of webservice token handler entities.

This method can return the following links:

• rel=create-form uri=/management/weblogic/{version}/edit/webserviceSecurities/{name}/webserviceTokenHandlerCreateForm

  The create form resource for this collection resource.

Body ()

Root Schema : Items

Type: array

Title: Items

Show Source

• Array of: object Webservice Token Handler

{
    "title":"Items",
    "type":"array",
    "items":{
        "$ref":"#/definitions/Webservice Token Handler"
    },
    "description":""
}

Nested Schema : Webservice Token Handler

Type: object

Show Source

• className(optional): string

  The fully qualified name of the class that implements a particular credential provider or token handler.

• dynamicallyCreated(optional): boolean
  Read Only: true

  Default Value: false

  Return whether the MBean was created dynamically or is persisted to config.xml

• handlingOrder(optional): integer(int32)

  Specifies the order in which the token handlers execute on a given token.

  If you do not specify an order, it is determined by the order in which you added the token handlers.

• id(optional): integer(int64)
  Read Only: true

  Return the unique id of this MBean instance

• name(optional): string
  Read Only: true

  The user-specified name of this MBean instance.

  This name is included as one of the key properties in the MBean's javax.management.ObjectName

  Name=user-specified-name

  Constraints

  • legal null
• notes(optional): string

  Optional information that you can include to describe this configuration.

  WebLogic Server saves this note in the domain's configuration file (config.xml) as XML PCDATA. All left angle brackets (<) are converted to the xml entity <. Carriage returns/line feeds are preserved.

  Note: If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.

• tags(optional): array Items
  Title: Items

  Return all tags on this Configuration MBean

• tokenType(optional): string

  Specifies the type of token used for the particular credential provider or token handler.

  WebLogic Server supports, by default, three types of tokens: X.509, UsernameToken, and SAML, as specified by the following WS-Security specifications:

  • Web Services Security: Username Token Profile

  • Web Services Security: X.509 Token Profile

  • Web Services Security: SAML Token Profile

  To specify one of these out-of-the-box types, use these values respectively: "ut", "x509", or "saml".

• type(optional): string
  Read Only: true

  Returns the type of the MBean.

  Constraints

  • unharvestable

{
    "type":"object",
    "properties":{
        "className":{
            "type":"string",
            "description":"<p>The fully qualified name of the class that implements a particular credential provider or token handler.</p>"
        },
        "dynamicallyCreated":{
            "readOnly":true,
            "default":false,
            "type":"boolean",
            "description":"<p>Return whether the MBean was created dynamically or is persisted to config.xml</p>"
        },
        "handlingOrder":{
            "type":"integer",
            "format":"int32",
            "description":"<p>Specifies the order in which the token handlers execute on a given token. </p><p>If you do not specify an order, it is determined by the order in which you added the token handlers. </p>"
        },
        "id":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Return the unique id of this MBean instance</p>"
        },
        "name":{
            "readOnly":true,
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>The user-specified name of this MBean instance.</p><p>This name is included as one of the key properties in the MBean's <code>javax.management.ObjectName</code></p><p><code>Name=<i>user-specified-name</i></code></p><p><h5>Constraints</h5></p><ul><li>legal null</li></ul>"
        },
        "notes":{
            "type":"string",
            "description":"<p>Optional information that you can include to describe this configuration.</p><p>WebLogic Server saves this note in the domain's configuration file (<code>config.xml</code>) as XML PCDATA. All left angle brackets (<) are converted to the XML entity <code>&lt;</code>. Carriage returns/line feeds are preserved.</p><p>Note: If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.</p>"
        },
        "tags":{
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>Return all tags on this Configuration MBean</p>"
        },
        "tokenType":{
            "type":"string",
            "description":"<p>Specifies the type of token used for the particular credential provider or token handler.</p><p>WebLogic Server supports, by default, three types of tokens: X.509, UsernameToken, and SAML, as specified by the following WS-Security specifications:</p><ul><li><p>Web Services Security: Username Token Profile</p></li><li><p>Web Services Security: X.509 Token Profile</p></li><li><p>Web Services Security: SAML Token Profile</p></li></ul><p>To specify one of these out-of-the-box types, use these values respectively: \"ut\", \"x509\", or \"saml\". </p>"
        },
        "type":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>Returns the type of the MBean.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        }
    },
    "description":""
}

Nested Schema : Items

Type: array

Title: Items

Return all tags on this Configuration MBean

Show Source

• Array of: string

{
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>Return all tags on this Configuration MBean</p>"
}

Back to Top