SocialProviderHandlerNode
Realm Operations
Resource path:
/realm-config/authentication/authenticationtrees/nodes/SocialProviderHandlerNodeV2/1.0
Resource version: 3.0
create
Usage
am> create SocialProviderHandlerNode --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" : { "clientType" : { "title" : "Client Type", "description" : "Select the client type you are using to authenticate to the provider. Select \"Native\" if you are using the Ping SDK for Android or iOS.", "propertyOrder" : 400, "type" : "string", "exampleValue" : "" }, "usernameAttribute" : { "title" : "Username Attribute", "description" : "The attribute in IDM that contains the username for this object.", "propertyOrder" : 300, "type" : "string", "exampleValue" : "" }, "script" : { "title" : "Transformation Script", "description" : "A script that can transform a normalized social profile to object data.", "propertyOrder" : 100, "type" : "string", "exampleValue" : "" }, "detectConnectionTimeOut" : { "title" : "Detect Connection Time Out", "description" : "If enabled, the node will detect connection timeouts and return the \"Time Out\" outcome.", "propertyOrder" : 600, "type" : "boolean", "exampleValue" : "" }, "storeTokens" : { "title" : "Store Tokens", "description" : "Store the access and refresh tokens in the transient state. Some social providers require these tokens to revoke user authorization.", "propertyOrder" : 500, "type" : "boolean", "exampleValue" : "" }, "subjectAttribute" : { "title" : "Subject Attribute", "description" : "The LDAP attribute from which the subject value can be retrieved. This is only used if IDM Provisioning is disabled.", "propertyOrder" : 700, "type" : "string", "exampleValue" : "" } }, "required" : [ "clientType", "usernameAttribute", "script", "detectConnectionTimeOut", "storeTokens", "subjectAttribute" ] }
delete
Usage
am> delete SocialProviderHandlerNode --realm Realm --id id
Parameters
- --id
-
The unique identifier for the resource.
getType
List information related to the node such as a name, description, tags and metadata.
Usage
am> action SocialProviderHandlerNode --realm Realm --actionName getType
getUpgradedConfig
Get the upgraded configuration for the node type.
Usage
am> action SocialProviderHandlerNode --realm Realm --body body --actionName getUpgradedConfig --targetVersion targetVersion
Parameters
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "type" : "object", "title" : "The current configuration of the node type." } - --targetVersion
-
=== listOutcomes
List the available outcomes for the node type.
Usage
am> action SocialProviderHandlerNode --realm Realm --body body --actionName listOutcomes
Parameters
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "description" : "Some configuration of the node. This does not need to be complete against the configuration schema.", "type" : "object", "title" : "Node configuration" }
query
Get the full list of instances of this collection. This query only supports _queryFilter=true filter.
Usage
am> query SocialProviderHandlerNode --realm Realm --filter filter
Parameters
- --filter
-
A CREST formatted query filter, where "true" will query all.
read
Usage
am> read SocialProviderHandlerNode --realm Realm --id id
Parameters
- --id
-
The unique identifier for the resource.
update
Usage
am> update SocialProviderHandlerNode --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" : { "clientType" : { "title" : "Client Type", "description" : "Select the client type you are using to authenticate to the provider. Select \"Native\" if you are using the Ping SDK for Android or iOS.", "propertyOrder" : 400, "type" : "string", "exampleValue" : "" }, "usernameAttribute" : { "title" : "Username Attribute", "description" : "The attribute in IDM that contains the username for this object.", "propertyOrder" : 300, "type" : "string", "exampleValue" : "" }, "script" : { "title" : "Transformation Script", "description" : "A script that can transform a normalized social profile to object data.", "propertyOrder" : 100, "type" : "string", "exampleValue" : "" }, "detectConnectionTimeOut" : { "title" : "Detect Connection Time Out", "description" : "If enabled, the node will detect connection timeouts and return the \"Time Out\" outcome.", "propertyOrder" : 600, "type" : "boolean", "exampleValue" : "" }, "storeTokens" : { "title" : "Store Tokens", "description" : "Store the access and refresh tokens in the transient state. Some social providers require these tokens to revoke user authorization.", "propertyOrder" : 500, "type" : "boolean", "exampleValue" : "" }, "subjectAttribute" : { "title" : "Subject Attribute", "description" : "The LDAP attribute from which the subject value can be retrieved. This is only used if IDM Provisioning is disabled.", "propertyOrder" : 700, "type" : "string", "exampleValue" : "" } }, "required" : [ "clientType", "usernameAttribute", "script", "detectConnectionTimeOut", "storeTokens", "subjectAttribute" ] }