SamlIdentityProvider

createSamlIdentityProvider

Create a new SAML Identity Provider

Arguments

Argument Name	Type	Description
samlIdentityProviderName	String	The name of the SAML Identity Provider (Required)
colorCode	String	Deprecated: The argument is no longer used Color code to be associate with the IDP
description	String	Comment text describing this object that is not interpreted at all by CloudBees CD/RO.
enabled	Boolean	If true, enables SAML Identity Provider
label	String	Deprecated: The argument is no longer used Label used by UI to display the text (e.g. label for UI button)
metadata	String	The metadata of the SAML identity provider
ssoProvider	String	Used to identify the SSO provider for displaying the branded SSO button on the login page

Argument Name

Type

Description

samlIdentityProviderName

String

The name of the SAML Identity Provider (Required)

colorCode

String

Deprecated: The argument is no longer used Color code to be associate with the IDP

description

String

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

enabled

Boolean

If true, enables SAML Identity Provider

label

String

Deprecated: The argument is no longer used Label used by UI to display the text (e.g. label for UI button)

metadata

String

The metadata of the SAML identity provider

ssoProvider

String

Used to identify the SSO provider for displaying the branded SSO button on the login page

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.createSamlIdentityProvider(
                samlIdentityProviderName: 'test-samlIdentityProviderName'
                /* optional arguments */)

deleteSamlIdentityProvider

Deletes a SAML Identity Provider

Arguments

Argument Name	Type	Description
samlIdentityProviderName	String	The name of the SAML Identity Provider (Required)

Argument Name

Type

Description

samlIdentityProviderName

String

The name of the SAML Identity Provider (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.deleteSamlIdentityProvider(
                samlIdentityProviderName: 'test-samlIdentityProviderName')

getSamlIdentityProvider

Retrieve a SAML Identity Provider by name

Arguments

Argument Name	Type	Description
samlIdentityProviderName	String	The name of the SAML Identity Provider (Required)

Argument Name

Type

Description

samlIdentityProviderName

String

The name of the SAML Identity Provider (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getSamlIdentityProvider(
                samlIdentityProviderName: 'test-samlIdentityProviderName')

getSamlIdentityProviders

Retrieve all SAML Identity Providers

Arguments

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getSamlIdentityProviders()

modifySamlIdentityProvider

Modify an existing SAML Identity Provider

Arguments

Argument Name	Type	Description
samlIdentityProviderName	String	The name of the SAML Identity Provider (Required)
colorCode	String	Deprecated: The argument is no longer used Color code to be associate with the IDP
description	String	Comment text describing this object that is not interpreted at all by CloudBees CD/RO.
enabled	Boolean	If true, enables SAML Identity Provider
label	String	Deprecated: The argument is no longer used Label used by UI to display the text (e.g. label for UI button)
metadata	String	The metadata of the SAML identity provider
newName	String	New name for an existing object that is being renamed.
ssoProvider	String	Used to identify the SSO provider for displaying the branded SSO button on the login page

Argument Name

Type

Description

samlIdentityProviderName

String

The name of the SAML Identity Provider (Required)

colorCode

String

Deprecated: The argument is no longer used Color code to be associate with the IDP

description

String

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

enabled

Boolean

If true, enables SAML Identity Provider

label

String

Deprecated: The argument is no longer used Label used by UI to display the text (e.g. label for UI button)

metadata

String

The metadata of the SAML identity provider

newName

String

New name for an existing object that is being renamed.

ssoProvider

String

Used to identify the SSO provider for displaying the branded SSO button on the login page

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.modifySamlIdentityProvider(
                samlIdentityProviderName: 'test-samlIdentityProviderName'
                /* optional arguments */)