SAML SSO

This functionality is available in the Enterprise version only for users with Administrator rights.

---

Description of the JSON object structure describing a SAML connection

Field	Type	Description
uuid	String	UUID of the SAML connection
name	String	Display name of the SAML connection
idpMetadataUrl	String	URL to obtain SAML XML metadata from the identity provider (IDP metadata)
idpIssuer	String	Unique, immutable issuerId of the identity provider (IDP issuerId)
cert	String	x509 certificate of the identity provider (IDP certificate)
idpInitiatedSsoUrl	String	URL for login via the identity provider from the GitFlic authorization page

---

Method to get SAML connections

GET /admin/saml

The request returns a list of SAML connections. You can configure the number of displayed objects per page.

Responses

STATUS 200 example JSON:

Example response

    
{
    "_embedded": {
        "samlAdminApiModelList": [
            {
                "uuid": "ebe95df1-aaaa-aaaa-aaaa-1419e9eae965",
                "name": "Keycloack",
                "idpMetadataUrl": "https://example.com",
                "idpIssuer": "login-app",
                "cert": "MIICoTCCAYkCaaaaaaaaaaaa7xCT82pTe6g=",
                "idpInitiatedSsoUrl": "https://example.com"
            },
            {
                "uuid": "136d6402-aaaa-aaaa-aaaa-5afacc9ced10",
                "name": "Gitflic",
                "idpMetadataUrl": "https://example.com",
                "idpIssuer": "Gitflic",
                "cert": "MIIFdzCCA14gaaaaaaaaaaaa1PgmIrUvdp7o",
                "idpInitiatedSsoUrl": "https://example.com"
            }
        ]
    },
    "page": {
        "size": 10,
        "totalElements": 2,
        "totalPages": 1,
        "number": 0
    }
}
    
  

STATUS 403 - No access rights.

STATUS 404 - No data found for the request.

---

Method to create a SAML connection

POST /admin/saml

The request creates a SAML connection and returns its information.

Request

Supported JSON format

POST request body structure:

JSON Variable	Type	Description
name	String	Display name of the SAML connection
idpMetadataUrl	String	URL to obtain SAML XML metadata from the identity provider (IDP metadata)
idpIssuer	String	Unique, immutable issuerId of the identity provider (IDP issuerId)
idpInitiatedSsoUrl	String	URL for login via the identity provider from the GitFlic authorization page
cert	String	x509 certificate of the identity provider (IDP certificate)

Example JSON object

{
    "name":"SAML connection",
    "idpMetadataUrl":"https://example.com",
    "idpIssuer":"Gitflic",
    "idpInitiatedSsoUrl": "https://example.com",
    "cert": "MIIFdzCCA14gaaaaaaaaaaaa1PgmIrUvdp7o"
}

Responses

STATUS 200 example JSON:

Example response

    
{
    "uuid": "136d6402-aaaa-aaaa-aaaa-5afacc9ced10",
    "name": "SAML connection",
    "idpMetadataUrl": "https://example.com",
    "idpIssuer": "Gitflic",
    "cert": "MIIFdzCCA14gaaaaaaaaaaaa1PgmIrUvdp7o",
    "idpInitiatedSsoUrl": "https://example.com"
}
    
  

STATUS 403 - No access rights.

STATUS 404 - No data found for the request.

---

Method to edit an existing SAML connection

PUT /admin/saml/{samlUuid}

The request edits an existing SAML connection and returns its information.

Path Variable	Type	Description
samlUuid	String	UUID of the SAML connection

Request

Supported JSON format

PUT request body structure:

JSON Variable	Type	Description
name	String	Display name of the SAML connection
idpMetadataUrl	String	URL to obtain SAML XML metadata from the identity provider (IDP metadata)
idpIssuer	String	Unique, immutable issuerId of the identity provider (IDP issuerId)
idpInitiatedSsoUrl	String	URL for login via the identity provider from the GitFlic authorization page
cert	String	x509 certificate of the identity provider (IDP certificate)

Example JSON object

{
    "name":"SAML connection",
    "idpMetadataUrl":"https://example.com",
    "idpIssuer":"Gitflic",
    "idpInitiatedSsoUrl": "https://example.com",
    "cert": "MIIFdzCCA14gaaaaaaaaaaaa1PgmIrUvdp7o"
}

Responses

STATUS 200 example JSON:

Example response

    
{
    "uuid": "136d6402-aaaa-aaaa-aaaa-5afacc9ced10",
    "name": "SAML connection",
    "idpMetadataUrl": "https://example.com",
    "idpIssuer": "Gitflic",
    "cert": "MIIFdzCCA14gaaaaaaaaaaaa1PgmIrUvdp7o",
    "idpInitiatedSsoUrl": "https://example.com"
}
    
  

STATUS 403 - No access rights.

STATUS 404 - No data found for the request.

---

Method to enable or disable a SAML connection

PUT /admin/saml/{samlUuid}change-status/?isEnabled={samlStatus}

The request enables or disables a SAML connection

Path Variable	Type	Description
samlUuid	String	UUID of the SAML connection
samlStatus	Boolean	SAML connection enabled true or disabled false

Responses

STATUS 200 - SAML connection status successfully changed.

STATUS 403 - No access rights.

STATUS 404 - No data found for the request.

---

Automated translation!

This page was translated using automatic translation tools. The text may contain inaccuracies.