This is the multi-page printable view of this section. Click here to print.
Create a saml provider
1 - 1.3
scpcli iam saml provider create
--saml_provider_name <value>
--federation_type <value>
[--description <value>]
[--file <value>]
[--tags <value>]
Description
Create a saml provider
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| saml_provider_name required | string | Credential Provider Name | IdpTest |
| federation_type required | string | Credential Provider Type | SAML |
| description optional | string | Credential Provider Description | SAML provider Description |
| file optional | string | Metadata File | keycloak-idp-saml.xml |
| tags optional | array | Tags | {'key': 'company', 'value': 'SDS'} |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | |
| acs_url | ACS URL | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator | |
| description | Credential Provider Description | |
| federation_type | Credential Provider Type | |
| idp_cert_end | Validity Period | |
| idp_file_name | Metadata File Name | |
| idp_file_size | Metadata File Size | |
| idp_issuer_url | Issuer URL | |
| idp_sso_url | SSO Service Location | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier | |
| saml_provider_name | Credential Provider Name |
2 - 1.2
scpcli iam saml provider create
--saml_provider_name <value>
--federation_type <value>
[--description <value>]
[--file <value>]
[--tags <value>]
Description
Create a saml provider
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| saml_provider_name required | string | Credential Provider Name | IdpTest |
| federation_type required | string | Credential Provider Type | SAML |
| description optional | string | Credential Provider Description | SAML provider Description |
| file optional | string | Metadata File | keycloak-idp-saml.xml |
| tags optional | array | Tags | {'key': 'company', 'value': 'SDS'} |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | |
| acs_url | ACS URL | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator | |
| description | Credential Provider Description | |
| federation_type | Credential Provider Type | |
| idp_cert_end | Validity Period | |
| idp_file_name | Metadata File Name | |
| idp_file_size | Metadata File Size | |
| idp_issuer_url | Issuer URL | |
| idp_sso_url | SSO Service Location | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier | |
| saml_provider_name | Credential Provider Name |
3 - 1.1
scpcli iam saml provider create
--saml_provider_name <value>
--federation_type <value>
[--description <value>]
[--file <value>]
[--tags <value>]
Description
Create a saml provider
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| saml_provider_name required | string | Credential Provider Name | IdpTest |
| federation_type required | string | Credential Provider Type | SAML |
| description optional | string | Credential Provider Description | SAML provider Description |
| file optional | string | Metadata File | keycloak-idp-saml.xml |
| tags optional | array | Tags | {'key': 'company', 'value': 'SDS'} |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | |
| acs_url | ACS URL | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator | |
| description | Credential Provider Description | |
| federation_type | Credential Provider Type | |
| idp_cert_end | Validity Period | |
| idp_file_name | Metadata File Name | |
| idp_file_size | Metadata File Size | |
| idp_issuer_url | Issuer URL | |
| idp_sso_url | SSO Service Location | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier | |
| saml_provider_name | Credential Provider Name |
4 - 1.0
scpcli iam saml provider create
--saml_provider_name <value>
--federation_type <value>
[--description <value>]
[--file <value>]
[--tags <value>]
Description
Create a saml provider
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| saml_provider_name required | string | Credential Provider Name | IdpTest |
| federation_type required | string | Credential Provider Type | SAML |
| description optional | string | Credential Provider Description | SAML provider Description |
| file optional | string | Metadata File | keycloak-idp-saml.xml |
| tags optional | array | Tags | {'key': 'company', 'value': 'SDS'} |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | |
| acs_url | ACS URL | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator | |
| description | Credential Provider Description | |
| federation_type | Credential Provider Type | |
| idp_cert_end | Validity Period | |
| idp_file_name | Metadata File Name | |
| idp_file_size | Metadata File Size | |
| idp_issuer_url | Issuer URL | |
| idp_sso_url | SSO Service Location | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier | |
| saml_provider_name | Credential Provider Name |