SelectIdentityProvider

Realm Operations

Resource path:

/realm-config/authentication/authenticationtrees/nodes/SelectIdPNode

Resource version: 1.0

create

Usage

am> create SelectIdentityProvider --realm Realm --id id --body body

Parameters

--id

The unique identifier for the resource.

--body

The resource in JSON format, described by the following JSON schema:

{
  "type" : "object",
  "properties" : {
    "identityAttribute" : {
      "title" : "Identity Attribute",
      "description" : "The attribute used to retrieve an existing user. Required to support the offer of only existing providers. Requires Platform deployment with IDM present.",
      "propertyOrder" : 500,
      "type" : "string",
      "exampleValue" : ""
    },
    "filteredProviders" : {
      "title" : "Filter Enabled Providers",
      "description" : "Add the names of enabled identity providers to use. If not specified, the node uses all providers enabled in the \"Social Identity Provider Service\".",
      "propertyOrder" : 600,
      "items" : {
        "type" : "string"
      },
      "type" : "array",
      "exampleValue" : ""
    },
    "passwordAttribute" : {
      "title" : "Password attribute",
      "description" : "The attribute in the user object that verifies that user during local authentication. Requires Platform deployment with IDM present.",
      "propertyOrder" : 300,
      "type" : "string",
      "exampleValue" : ""
    },
    "offerOnlyExisting" : {
      "title" : "Offer only existing providers",
      "description" : "Choices offered should be limited to those already associated with a user object. Requires Platform deployment with IDM present.",
      "propertyOrder" : 200,
      "type" : "boolean",
      "exampleValue" : ""
    },
    "includeLocalAuthentication" : {
      "title" : "Include local authentication",
      "description" : "Whether local authentication will be included as an available identity provider.",
      "propertyOrder" : 100,
      "type" : "boolean",
      "exampleValue" : ""
    }
  },
  "required" : [ "identityAttribute", "passwordAttribute", "offerOnlyExisting", "filteredProviders", "includeLocalAuthentication" ]
}

delete

Usage

am> delete SelectIdentityProvider --realm Realm --id id

Parameters

--id

The unique identifier for the resource.

getAllTypes

Obtain the collection of all secondary configuration types related to the resource.

Usage

am> action SelectIdentityProvider --realm Realm --actionName getAllTypes

getCreatableTypes

Obtain the collection of secondary configuration types that have yet to be added to the resource.

Usage

am> action SelectIdentityProvider --realm Realm --actionName getCreatableTypes

listOutcomes

List the available outcomes for the node type.

Usage

am> action SelectIdentityProvider --realm Realm --body body --actionName listOutcomes

Parameters

--body

The resource in JSON format, described by the following JSON schema:

{
  "type" : "object",
  "title" : "Some configuration of the node. This does not need to be complete against the configuration schema."
}

nextdescendents

Obtain the collection of secondary configuration instances that have been added to the resource.

Usage

am> action SelectIdentityProvider --realm Realm --actionName nextdescendents

query

Get the full list of instances of this collection. This query only supports _queryFilter=true filter.

Usage

am> query SelectIdentityProvider --realm Realm --filter filter

Parameters

--filter

A CREST formatted query filter, where "true" will query all.

read

Usage

am> read SelectIdentityProvider --realm Realm --id id

Parameters

--id

The unique identifier for the resource.

update

Usage

am> update SelectIdentityProvider --realm Realm --id id --body body

Parameters

--id

The unique identifier for the resource.

--body

The resource in JSON format, described by the following JSON schema:

{
  "type" : "object",
  "properties" : {
    "identityAttribute" : {
      "title" : "Identity Attribute",
      "description" : "The attribute used to retrieve an existing user. Required to support the offer of only existing providers. Requires Platform deployment with IDM present.",
      "propertyOrder" : 500,
      "type" : "string",
      "exampleValue" : ""
    },
    "filteredProviders" : {
      "title" : "Filter Enabled Providers",
      "description" : "Add the names of enabled identity providers to use. If not specified, the node uses all providers enabled in the \"Social Identity Provider Service\".",
      "propertyOrder" : 600,
      "items" : {
        "type" : "string"
      },
      "type" : "array",
      "exampleValue" : ""
    },
    "passwordAttribute" : {
      "title" : "Password attribute",
      "description" : "The attribute in the user object that verifies that user during local authentication. Requires Platform deployment with IDM present.",
      "propertyOrder" : 300,
      "type" : "string",
      "exampleValue" : ""
    },
    "offerOnlyExisting" : {
      "title" : "Offer only existing providers",
      "description" : "Choices offered should be limited to those already associated with a user object. Requires Platform deployment with IDM present.",
      "propertyOrder" : 200,
      "type" : "boolean",
      "exampleValue" : ""
    },
    "includeLocalAuthentication" : {
      "title" : "Include local authentication",
      "description" : "Whether local authentication will be included as an available identity provider.",
      "propertyOrder" : 100,
      "type" : "boolean",
      "exampleValue" : ""
    }
  },
  "required" : [ "identityAttribute", "passwordAttribute", "offerOnlyExisting", "filteredProviders", "includeLocalAuthentication" ]
}