SamlServiceProvider

createSamlServiceProvider

Create a new SAML Service Provider

Arguments

Argument Name	Type	Description
entityId	String	Service Provider entity id (usually URI) (Required)
serverUrl	String	URL for the service provider host (Required)
authnRequestsSigned	Boolean	Metadata will have AuthnRequestsSigned="true/false" in descriptor
digestAlgorithm	String	SAML digest algorithm.
enabled	Boolean	If true, enables SAML Service Provider
groupClaimAttribute	String	Security group claim attribute in the SAML response that contains the user groups.
mdSigningEnabled	Boolean	If true, sign service provider metadata
mdSigningPassphrase	String	Passphrase use for SP metadata signing private key
mdSigningPrivateKey	String	SP metadata signing private key
mdSigningPublicCertificate	String	SP metadata signing public certificate
nameIdFormat	String	NameID format like urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified
passphrase	String	Passphrase use for SP private key
privateKey	String	SP private key
publicCertificate	String	SP’s public certificate
samlServiceProviderName	String	The name of the SAML Service Provider
signatureAlgorithm	String	SAML signature algorithm.
userEmailAttribute	String	The mapping for the user email attribute in the SAML response.
userFullNameAttribute	String	The mapping for the full user name attribute in the SAML response.
wantAssertionsSigned	Boolean	Metadata will have WantAssertionsSigned="true/false" in descriptor

Argument Name

Type

Description

entityId

String

Service Provider entity id (usually URI) (Required)

serverUrl

String

URL for the service provider host (Required)

authnRequestsSigned

Boolean

Metadata will have AuthnRequestsSigned="true/false" in descriptor

digestAlgorithm

String

SAML digest algorithm.

enabled

Boolean

If true, enables SAML Service Provider

groupClaimAttribute

String

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

mdSigningEnabled

Boolean

If true, sign service provider metadata

mdSigningPassphrase

String

Passphrase use for SP metadata signing private key

mdSigningPrivateKey

String

SP metadata signing private key

mdSigningPublicCertificate

String

SP metadata signing public certificate

nameIdFormat

String

NameID format like urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified

passphrase

String

Passphrase use for SP private key

privateKey

String

SP private key

publicCertificate

String

SP’s public certificate

samlServiceProviderName

String

The name of the SAML Service Provider

signatureAlgorithm

String

SAML signature algorithm.

userEmailAttribute

String

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

userFullNameAttribute

String

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

wantAssertionsSigned

Boolean

Metadata will have WantAssertionsSigned="true/false" in descriptor

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.createSamlServiceProvider(
                entityId: 'test-entityId',
                serverUrl: 'test-serverUrl'
                /* optional arguments */)

deleteSamlServiceProvider

Deletes a SAML Service Provider.

Arguments

Argument Name	Type	Description
samlServiceProviderName	String	The name of the SAML Service Provider

Argument Name

Type

Description

samlServiceProviderName

String

The name of the SAML Service Provider

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.deleteSamlServiceProvider()

getSamlServiceProvider

Retrieve a SAML Service Provider by name

Arguments

Argument Name	Type	Description
samlServiceProviderName	String	The name of the SAML Service Provider

Argument Name

Type

Description

samlServiceProviderName

String

The name of the SAML Service Provider

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getSamlServiceProvider()

getSamlServiceProviderMetadata

Retrieve SAML Identity Providers Metadata

Arguments

Argument Name	Type	Description
downloadCertificateOnly	Boolean	Service Provider Certificate file will be available to downloaded

Argument Name

Type

Description

downloadCertificateOnly

Boolean

Service Provider Certificate file will be available to downloaded

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getSamlServiceProviderMetadata(
                /* optional arguments */)

getSamlServiceProviders

Retrieve all SAML Service Providers

Arguments

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getSamlServiceProviders()

modifySamlServiceProvider

Modify an existing SAML Service Provider

Arguments

Argument Name	Type	Description
entityId	String	Service Provider entity id (usually URI) (Required)
serverUrl	String	URL for the service provider host (Required)
samlServiceProviderName	String	The name of the SAML Service Provider
authnRequestsSigned	Boolean	Metadata will have AuthnRequestsSigned="true/false" in descriptor
digestAlgorithm	String	SAML digest algorithm.
enabled	Boolean	If true, enables SAML Service Provider
groupClaimAttribute	String	Security group claim attribute in the SAML response that contains the user groups.
mdSigningEnabled	Boolean	If true, sign service provider metadata
mdSigningPassphrase	String	Passphrase use for SP metadata signing private key
mdSigningPrivateKey	String	SP metadata signing private key
mdSigningPublicCertificate	String	SP metadata signing public certificate
nameIdFormat	String	NameID format like urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified
passphrase	String	Passphrase use for SP private key
privateKey	String	SP private key
publicCertificate	String	SP’s public certificate
signatureAlgorithm	String	SAML signature algorithm.
userEmailAttribute	String	The mapping for the user email attribute in the SAML response.
userFullNameAttribute	String	The mapping for the full user name attribute in the SAML response.
wantAssertionsSigned	Boolean	Metadata will have WantAssertionsSigned="true/false" in descriptor

Argument Name

Type

Description

entityId

String

Service Provider entity id (usually URI) (Required)

serverUrl

String

URL for the service provider host (Required)

samlServiceProviderName

String

The name of the SAML Service Provider

authnRequestsSigned

Boolean

Metadata will have AuthnRequestsSigned="true/false" in descriptor

digestAlgorithm

String

SAML digest algorithm.

enabled

Boolean

If true, enables SAML Service Provider

groupClaimAttribute

String

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

mdSigningEnabled

Boolean

If true, sign service provider metadata

mdSigningPassphrase

String

Passphrase use for SP metadata signing private key

mdSigningPrivateKey

String

SP metadata signing private key

mdSigningPublicCertificate

String

SP metadata signing public certificate

nameIdFormat

String

NameID format like urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified

passphrase

String

Passphrase use for SP private key

privateKey

String

SP private key

publicCertificate

String

SP’s public certificate

signatureAlgorithm

String

SAML signature algorithm.

userEmailAttribute

String

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

userFullNameAttribute

String

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

wantAssertionsSigned

Boolean

Metadata will have WantAssertionsSigned="true/false" in descriptor

Usage

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 */)