Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

As with IdP naming, you MUST be prepared to commit to maintaining an SP entity ID essentially for the life of the service. Choose a name independently of the endpoint locations, so if the latter change in the future, the entity ID need not change.

Choosing a Name

Below are some tips and suggestions that might be useful when choosing an entity ID.

Info
titleNote

This The following section is primarily for site administrators registering new entities choosing a name for the first time.in InCommon.

Choosing a Name

An entity ID must be globally unique to avoid name collisions both within and across federations. To help ensure global uniquenessIn almost all casesan entity ID is almost always an absolute URL but it's important to note that an entity ID is a name, not a location. That is, an entity ID need not resolve to an actual web resource.

Note
titleRequirements for new entity IDs

InCommon will verify that all newly submitted entity IDs meet the following requirements:

  • An entity ID : 1) MUST be a URI , 2) SHOULD be an absolute URL, and 3) but SHOULD NOT be a URN
  • The entity ID MUST be globally unique to avoid name collisions both within the Federation and across federationsIf the entity ID is a URL (which is strongly RECOMMENDED), thenSHOULD be an absolute URL with the following properties:
    • the host part of the URL MUST be a name rooted in the organization's Primary DNS Domain
    • the URL MUST NOT contain a port number, a query string, or a fragment identifier

If a site administrator submits metadata with some other form of entity ID, a manual vetting process is triggered, which may delay the approval process.

...

Attempts to change an existing entity ID will trigger a potentially lengthy manual vetting process. Be prepared to explain why you think it is necessary to change your entity ID.

Below are some tips and suggestions that might be useful when choosing an entity ID.

Tips

  • include the substring "idp" or "identityprovider" in an IdP entity ID
  • include the substring "sp" or "serviceprovider" in an SP entity ID
  • do not include the substring "incommon" in an entity ID
  • do not include the name of your SAML software in an entity ID
  • an URL-based entity ID starting with "https://" is more flexible than one starting with "http://"
  • avoid using substring "www" in an URL-based entity ID
  • do not end an URL-based entity ID with a slash (/)
  • do not include a port number, a query string (?), or a fragment identifier (#) in an URL-based entity ID

...