modifySamlServiceProvider

Back to index

Summary

Modifies an existing SAML service provider.

samlServiceProviderName

Stringoptional

The name of the SAML service provider.

entityId

Stringrequired

Service provider entity ID (usually URI).

serverUrl

Stringrequired

URL for the service provider host. If using an IPv6 address, enclose the address in square brackets. Example: [<IPv6-ADDRESS>].

authnRequestsSigned

Booleanoptional

Metadata will have AuthnRequestsSigned=true/false in descriptor.

digestAlgorithm

Stringoptional

SAML digest algorithm.

Possible values: "SHA1", "SHA256"

enabled

Booleanoptional

If true, enables SAML service provider.

groupClaimAttribute

Stringoptional

Security group claim attribute in the SAML response that contains the user groups.

mdSigningEnabled

Booleanoptional

If true, sign service provider metadata.

mdSigningPassphrase

Stringoptional

Passphrase use for service provider metadata signing private key.

mdSigningPrivateKey

Stringoptional

Service provider metadata signing private key.

mdSigningPublicCertificate

Stringoptional

Service provider metadata signing public certificate.

nameIdFormat

Stringoptional

NameID format such as urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified.

passphrase

Stringoptional

Passphrase use for service provider private key.

privateKey

Stringoptional

Service provider private key.

publicCertificate

Stringoptional

Service provider's public certificate.

signatureAlgorithm

Stringoptional

SAML signature algorithm.

Possible values: "RSA_SHA1", "RSA_SHA256"

userEmailAttribute

Stringoptional

The mapping for the user email attribute in the SAML response.

userFullNameAttribute

Stringoptional

The mapping for the full user name attribute in the SAML response.

wantAssertionsSigned

Booleanoptional

Metadata will have WantAssertionsSigned=true/false in descriptor.

Usage

Groovy

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*

ElectricFlow ef = new ElectricFlow()

def result = ef.modifySamlServiceProvider(
  entityId: "test-entityId",
  serverUrl: "test-serverUrl"
  /* optional arguments */
)▼