SocialProviderHandlerNode
Realm Operations
Resource path:
/realm-config/authentication/authenticationtrees/nodes/SocialProviderHandlerNode
Resource version: 1.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" : { "usernameAttribute" : { "title" : "Username Attribute", "description" : "The attribute in IDM that contains the username for this object.", "propertyOrder" : 300, "type" : "string", "exampleValue" : "" }, "clientType" : { "title" : "Client Type", "description" : "Select the client type you are using to authenticate to the provider. Select \"Native\" if you are using the ForgeRock Android or iOS SDK.", "propertyOrder" : 400, "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" : "" } }, "required" : [ "script", "clientType", "usernameAttribute" ] }
delete
Usage
am> delete SocialProviderHandlerNode --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 SocialProviderHandlerNode --realm Realm --actionName getAllTypes
getCreatableTypes
Obtain the collection of secondary configuration types that have yet to be added to the resource.
Usage
am> action SocialProviderHandlerNode --realm Realm --actionName getCreatableTypes
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:
{ "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 SocialProviderHandlerNode --realm Realm --actionName nextdescendents
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" : { "usernameAttribute" : { "title" : "Username Attribute", "description" : "The attribute in IDM that contains the username for this object.", "propertyOrder" : 300, "type" : "string", "exampleValue" : "" }, "clientType" : { "title" : "Client Type", "description" : "Select the client type you are using to authenticate to the provider. Select \"Native\" if you are using the ForgeRock Android or iOS SDK.", "propertyOrder" : 400, "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" : "" } }, "required" : [ "script", "clientType", "usernameAttribute" ] }