Jump to

• Request
• Response

GET A Create Form For This Authentication Provider Collection

get

/management/weblogic/{version}/edit/securityConfiguration/realms/{name}/authenticationProviderCreateForm

This resource returns a pre-populated authentication provider model that can be customized then posted (using the POST method) to the authenticationProviders collection resource to create a new authentication provider.

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 this authentication provider.

This method can return the following links:

• rel=create uri=/management/weblogic/{version}/edit/securityConfiguration/realms/{name}/authenticationProviders

  The collection resource for this create form resource.

Body ()

Root Schema : Authentication Provider

Type: object

Title: Authentication Provider

Show Source

• description(optional): string

  Returns a description of this security provider.

  Each security provider's MBean should set the default value of this read-only attribute to a string that describes the provider. In other words, each security provider's MBean hard-wires its description. There are no conventions governing the contents of the description. It should be a human readable string that gives a brief description of the security provider.

• name(optional): string

  The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

• realm(optional): array Realm Reference
  Title: Realm Reference

  Contains the realm reference.

  Returns the realm that contains this security provider. Returns null if this security provider is not contained by a realm.

• type(optional): string

  - The type of this Authentication provider, for example, weblogic.security.providers.authentication.DefaultAuthenticator Use getAuthenticationProviderTypes to find the list of types that may be specified.

• version(optional): string

  Returns this security provider's version.

  Each security provider's MBean should set the default value of this read-only attribute to a string that specifies the version of the provider (e.g. 7.3.04). In other words, each security provider's MBean hard-wires its version. There are no conventions governing the contents of the version string.

{
    "type":"object",
    "title":"Authentication Provider",
    "properties":{
        "description":{
            "type":"string",
            "description":"<p>Returns a description of this security provider. </p><p> Each security provider's MBean should set the default value of this read-only attribute to a string that describes the provider.  In other words, each security provider's MBean hard-wires its description.  There are no conventions governing the contents of the description.  It should be a human readable string that gives a brief description of the security provider. </p>"
        },
        "name":{
            "type":"string",
            "description":"<p>The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.</p>"
        },
        "realm":{
            "title":"Realm Reference",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"Contains the realm reference. <p>Returns the realm that contains this security provider. Returns null if this security provider is not contained by a realm.</p>"
        },
        "type":{
            "type":"string",
            "description":"<p>- The type of this Authentication provider, for example, <code>weblogic.security.providers.authentication.DefaultAuthenticator</code> Use <code>getAuthenticationProviderTypes</code> to find the list of types that may be specified.</p>"
        },
        "version":{
            "type":"string",
            "description":"<p>Returns this security provider's version. </p><p> Each security provider's MBean should set the default value of this read-only attribute to a string that specifies the version of the provider (e.g. 7.3.04).  In other words, each security provider's MBean hard-wires its version.  There are no conventions governing the contents of the version string. </p>"
        }
    },
    "description":""
}

Nested Schema : Realm Reference

Type: array

Title: Realm Reference

Contains the realm reference.

Returns the realm that contains this security provider. Returns null if this security provider is not contained by a realm.

Show Source

• Array of: string

{
    "title":"Realm Reference",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"Contains the realm reference. <p>Returns the realm that contains this security provider. Returns null if this security provider is not contained by a realm.</p>"
}

Back to Top