createSamlIdentityProvider
Creates a new SAML identity provider.
You must specify the samlIdentityProviderName
.
Arguments | Descriptions |
---|---|
samlIdentityProviderName | The name of the SAML identity provider. Argument Type: String |
colorCode | (Optional) Color code to be associated with the identity provider. Argument Type: String |
description | (Optional) Comment text describing this object that is not interpreted at all by CloudBees CD/RO . Argument Type: String |
enabled | (Optional) If true, enables SAML identity provider. Argument Type: Boolean |
label | (Optional) Label used by UI to display the text (such as a label for UI button). Argument Type: String |
metadata | (Optional) The metadata of the SAML identity provider. Argument Type: String |
createSamlServiceProvider
Creates a new SAML service provider.
You must specify the entityId
and serverUrl
.
Arguments | Descriptions |
---|---|
entityId | Service provider entity ID (usually URI). Argument Type: String |
serverUrl | URL for the service provider host. Argument Type: String |
authnRequestsSigned | (Optional) Metadata will have AuthnRequestsSigned="true/false" in descriptor. Argument Type: Boolean |
enabled | (Optional) If true, enables SAML service provider. Argument Type: Boolean |
mdSigningEnabled | (Optional) If true, sign service provider metadata. Argument Type: Boolean |
mdSigningPassphrase | (Optional) Passphrase use for service provider metadata signing private key. Argument Type: String |
mdSigningPrivateKey | (Optional) Service provider metadata signing private key (encoded in base64). Argument Type: String |
mdSigningPrivateKeyFile | (Optional) File containing the service provider metadata signing private key. Argument Type: String |
mdSigningPublicCertificate | (Optional) Service provider metadata signing public certificate (encoded in base64). Argument Type: String |
mdSigningPublicCertificateFile | (Optional) File containing the service provider metadata signing public certificate. Argument Type: String |
nameIdFormat | (Optional) NameID format like urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified. Argument Type: String |
passphrase | (Optional) Passphrase use for service provider private key. Argument Type: String |
privateKey | Service provider private key (encoded in base64). Argument Type: String |
privateKeyFile | File containing the service provider private key. Argument Type: String |
publicCertificate | Service provider’s public certificate (encoded in base64). Argument Type: String |
publicCertificateFile | File containing the service provider’s public certificate. Argument Type: String |
samlServiceProviderName | (Optional) The name of the SAML service provider. Argument Type: String |
wantAssertionsSigned | (Optional) Metadata will have WantAssertionsSigned="true/false" in descriptor. Argument Type: String |
deleteSamlIdentityProvider
Deletes a SAML identity provider.
You must specify the samlIdentityProviderName
.
Arguments | Descriptions |
---|---|
samlIdentityProviderName | The name of the SAML identity provider. Argument Type: String |
deleteSamlServiceProvider
Deletes a SAML service provider.
You must specify the samlServiceProviderName
.
Arguments | Descriptions |
---|---|
samlServiceProviderName | The name of the SAML service provider (usually URI). Argument Type: String |
getSamlIdentityProvider
Retrieves a SAML identity provider by name.
You must specify the samlIdentityProviderName
.
Arguments | Descriptions |
---|---|
samlIdentityProviderName | The name of the SAML identity provider. Argument Type: String |
getSamlServiceProvider
Retrieves a SAML service provider by name.
You must specify samlServiceProviderName
.
Arguments | Descriptions |
---|---|
samlServiceProviderName | The name of the SAML service provider. Argument Type: String |
modifySamlIdentityProvider
Modifies an existing SAML identity provider.
You must specify the samlIdentityProviderName
.
Arguments | Descriptions |
---|---|
samlIdentityProviderName | The name of the SAML identity provider. Argument Type: String |
colorCode | (Optional) Color code to be associated with the identity provider. Argument Type: String |
description | (Optional) Comment text describing this object that is not interpreted at all by CloudBees CD/RO . Argument Type: String |
enabled | (Optional) If true, enables SAML identity provider. Argument Type: Boolean |
label | (Optional) Label used by UI to display the text (e.g. label for UI button). Argument Type: String |
metadata | (Optional) The metadata of the SAML identity provider. Argument Type: String |
newName | (Optional) New name for an existing object that is being renamed. Argument Type: String |
modifySamlServiceProvider
Modifies an existing SAML service provider.
You must specify the entityId
and serverUrl
.
Arguments | Descriptions |
---|---|
entityId | Service provider entity ID (usually URI). Argument Type: String |
serverUrl | URL for the service provider host. Argument Type: String |
authnRequestsSigned | (Optional) Metadata will have AuthnRequestsSigned="true/false" in descriptor. Argument Type: Boolean |
enabled | (Optional) If true, enables SAML service provider. Argument Type: Boolean |
mdSigningPassphrase | (Optional) Passphrase use for service provider metadata signing private key. Argument Type: String |
mdSigningPrivateKey | (Optional) Service provider metadata signing private key (encoded in base64). Argument Type: String |
mdSigningPrivateKeyFile | (Optional) File containing the service provider metadata signing private key. Argument Type: String |
mdSigningPublicCertificate | (Optional) Service provider metadata signing public certificate (encoded in base64). Argument Type: String |
mdSigningPublicCertificateFile | (Optional) File containing the service provider metadata signing public certificate. Argument Type: String |
nameIdFormat | (Optional) NameID format like urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified. Argument Type: String |
passphrase | (Optional) Passphrase to use for service provider private key. Argument Type: String |
privateKey | Service provider private key (encoded in base64). Argument Type: String |
privateKeyFile | (Optional) File containing the service provider private key. Argument Type: String |
publicCertificate | Service provider’s public certificate (encoded in base64). Argument Type: String |
publicCertificateFile | (Optional) File containing the service provider’s public certificate. Argument Type: String |
samlServiceProviderName | (Optional) The name of the SAML service provider. Argument Type: String |
wantAssertionsSigned | (Optional) Metadata will have WantAssertionsSigned="true/false" in descriptor. Argument Type: Boolean |
setSsoConfiguration
Sets the SSO server configuration.
You must specify enableSsoKerberos
or enableSsoSaml
.
Arguments | Descriptions |
---|---|
enableSsoKerberos | (Optional) Enable or disable SSO Kerberos. Argument Type: Boolean |
enableSsoSaml | (Optional) Enable or disable SSO SAML. Argument Type: Boolean |