- URL:https://<portal-url>/idp/federation/register(POST only)
The register federation operation (POST only) allows organization administrator to configure enterprise login using a SAML-based federation of identity providers. An organization can be set up using either a single IDP or a federation, not both.
For a complete listing, see Common parameters.
The SAML federation name.
SAML federation discovery service URL.
SAML federation aggregate metadata service URL.
Base64-encoded certificate text used to validate metadata service, enclosed between -----BEGIN CERTIFICATE----- and -----END CERTIFICATE-----.
Entity ID used to identify the organization in SAML federation.
Enterprise members joining mode to the organization, automatically or through an invitation.
Supported values: Automatic | Invitation
If true, it indicates to SAML federation that encrypted SAML assertion responses are supported.
Default role members are assigned, used when signUpMode=Automatic.
If true, organization signs the SAML authentication request sent to the IDP federation.
If true, organization signs request using SHA-256 hash function, applicable when supportSignedRequest=true.
If true, signing out of the organization propagates logout of the IDP.
Default user license type members are assigned, used when signUpMode=Automatic.
An array of groups members are added upon joining the organization, used when signUpMode=Automatic.
If true, automatically sync user account information (full name and email address) stored in ArcGIS Online with the information received from the IDP.
Indicates if the operation was successful.
The ID of the organization identity federation.
URL for Register Federation
JSON Response Syntax
"federationId": "<organization identity federation ID>"
JSON Response Example
"message": "Unable to register Federation",
"details": ["'discoveryServiceUrl' must be specified.", "'metadataServiceUrl' must be specified."]