Amster

Naming

Global Operations

Resource path:

/global-config/services/naming

Resource version: 1.0

getAllTypes

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

Usage

am> action Naming --global --actionName getAllTypes

getCreatableTypes

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

Usage

am> action Naming --global --actionName getCreatableTypes

nextdescendents

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

Usage

am> action Naming --global --actionName nextdescendents

read

Usage

am> read Naming --global

update

Usage

am> update Naming --global --body body

Parameters

--body

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

{
  "type" : "object",
  "properties" : {
    "federationConfig" : {
      "type" : "object",
      "title" : "Federation Configuration",
      "propertyOrder" : 1,
      "properties" : {
        "samlAssertionManagerUrl" : {
          "title" : "SAML Assertion Manager Service URL",
          "description" : "Specifies the SAML v1 assertion service endpoint.",
          "propertyOrder" : 900,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        },
        "jaxrpcUrl" : {
          "title" : "JAXRPC Endpoint URL",
          "description" : "Specifies the JAXRPC endpoint URL used by the remote IDM/SMS APIs.",
          "propertyOrder" : 1200,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        },
        "samlPostServletUrl" : {
          "title" : "SAML Web Profile/POST Service URL",
          "description" : "Specifies the SAML v1 Web Profile endpoint.",
          "propertyOrder" : 800,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        },
        "samlAwareServletUrl" : {
          "title" : "SAML Web Profile/Artifact Service URL",
          "description" : "Specifies the SAML v1 endpoint.",
          "propertyOrder" : 600,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        },
        "samlSoapReceiverUrl" : {
          "title" : "SAML SOAP Service URL",
          "description" : "Specifies the SAML v1 SOAP service endpoint.",
          "propertyOrder" : 700,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        }
      }
    },
    "generalConfig" : {
      "type" : "object",
      "title" : "General Configuration",
      "propertyOrder" : 0,
      "properties" : {
        "loggingUrl" : {
          "title" : "Logging Service URL",
          "description" : "Specifies the endpoint used by the logging service.",
          "propertyOrder" : 300,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        },
        "policyUrl" : {
          "title" : "Policy Service URL",
          "description" : "Specifies the endpoint used by the policy service.",
          "propertyOrder" : 400,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        },
        "sessionUrl" : {
          "title" : "Session Service URL",
          "description" : "Specifies the endpoint used by the session service.",
          "propertyOrder" : 200,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        },
        "profileUrl" : {
          "title" : "Profile Service URL",
          "description" : "Specifies the endpoint used by the profile service.<p><p>This attribute is deprecated.",
          "propertyOrder" : 100,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        },
        "authUrl" : {
          "title" : "Authentication Service URL",
          "description" : "Specifies the endpoint used by the authentication service.",
          "propertyOrder" : 500,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        }
      }
    },
    "endpointConfig" : {
      "type" : "object",
      "title" : "Endpoint Configuration",
      "propertyOrder" : 2,
      "properties" : {
        "jaxwsUrl" : {
          "title" : "Identity Web Services Endpoint URL",
          "description" : "Specifies the endpoint for the Identity WSDL services.",
          "propertyOrder" : 1300,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        },
        "stsUrl" : {
          "title" : "Security Token Service Endpoint URL",
          "description" : "Specifies the STS endpoint.",
          "propertyOrder" : 1500,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        },
        "stsMexUrl" : {
          "title" : "Security Token Service MEX Endpoint URL",
          "description" : "Specifies the STS MEX endpoint.",
          "propertyOrder" : 1600,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        }
      }
    }
  }
}
Copyright © 2010-2024 ForgeRock, all rights reserved.