Перейти к основному содержимому

Federations API (v1.0.0)

Managing federations and certificates

Federations

Get all configured federations

Authorizations:
TokenAuth

Responses

Response samples

Content type
application/json
{}

Add new federation

Authorizations:
TokenAuth
Request Body schema: application/json
required
name
string
description
string
issuer
string
sso_url
string
sign_authn_requests
boolean
force_authn
boolean
session_max_age_hours
integer

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Check if federation exists

path Parameters
federation_id
required
string <uuid>

federation id in UUID v4 format

Responses

Get information about the specified federation

Authorizations:
TokenAuth
path Parameters
federation_id
required
string <uuid>

federation id in UUID v4 format

Responses

Response samples

Content type
application/json
{}

Update federation's info

Authorizations:
TokenAuth
path Parameters
federation_id
required
string <uuid>

federation id in UUID v4 format

Request Body schema: application/json
required
name
string
description
string
issuer
string
sso_url
string
sign_authn_requests
boolean
force_authn
boolean
session_max_age_hours
integer

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

Delete configured federation

Authorizations:
TokenAuth
path Parameters
federation_id
required
string <uuid>

federation id in UUID v4 format

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

Federation Certificates

Get all certificates which are used in the specified federation

Authorizations:
TokenAuth
path Parameters
federation_id
required
string <uuid>

federation id in UUID v4 format

Responses

Response samples

Content type
application/json
{
  • "certificates": [
    ]
}

Upload certificates for the specified federation

Authorizations:
TokenAuth
path Parameters
federation_id
required
string <uuid>

federation id in UUID v4 format

Request Body schema: application/json
required
name
required
string
description
string
data
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "certificate name",
  • "description": "certificate description",
  • "data": "-----BEGIN CERTIFICATE-----\nMIICmzCCAYMCBgGI6ANFczANBgkqhkiG9w0BAQsFADARMQ8wDQYDVQQDDAZtYXN0ZXIwHhcNMjMwNjIzMTEyNjQ4WhcNMzMwNjIzMTEyODI4WjARMQ8wDQYDVQQDDAZtYXN0ZXIwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC04rOaDpre/MucE3HXVCnAnpqIqQOeMn696AW2FATnI26x1BsxVAGjcrheAOIu+CxC28m48Ah4+SiTEk/u2X/WbGTd/1GZooz37cge0AWMQGyh8ysZRd6q06kg4QGD1iUtdQyHioMbSr9pPne2QQgSX5/gM9XDuA6dpG9Yv0PIPLFlk3BIUL1qEfUiYbDlrunkN/y4XromJaJPpgXKWraH194bqcgXGQLrCqicKwsRBoQJHg3ODWHjHFOwYODJ1XBsRcAue4J88PKiPV1tZNPVczMptrkqGBYTgOYGjKXGe5EH50RJE4/3Ynurz2s34DSDVJhJOYtGwpfeSuU3i3mVAgMBAAEwDQYJKoZIhvcNAQELBQADggEBAGAweCuWJmJXMUdRtgoFIiu6BGotDX5sA/VOm4CRsEXV7/qnBagrAPkRz86KGm4lOPL0X+I13JQh4/OB1gxnPN+BXhNtCWCoj1wA3/BWjs1ow/gaVXzwdy+1mbc/sUBudsLq2Yqs54GgeYsTBKMVpSLKiRg1NebEFlqFmG2hjPzYg1QHL4VBusMQgqt7TTnOfGtdT3Ss9TKGRQ+iwfNL0BtSAKaTRdhNVU4lDYUs788Kw5od/uJj0wTICKO5/PrkX7Uy42+fyU+4SvJynPOy+M+z+s08JC9+eYXixfeeFG1nNWR+DIKXcXaSwNQW+8RweGbOJxQ2BoUKtl0NCHrvxJw=\n-----END CERTIFICATE-----"
}

Response samples

Content type
application/json
{
  • "id": "bcceb50a-e4a3-404f-8391-f319e40c1fd5",
  • "account_id": "242137",
  • "federation_id": "f9a51b33-9194-4d44-a959-43740b6334a4",
  • "name": "certificate name",
  • "description": "certificate description",
  • "not_before": "2023-06-23T11:26:48Z",
  • "not_after": "2033-06-23T11:28:28Z",
  • "fingerprint": "6A822A2645D9A18D1CC40D5B5BDA444AA579AF3B399AF77309ABD5222CC23FC0",
  • "data": "-----BEGIN CERTIFICATE-----\nMIICmzCCAYMCBgGI6ANFczANBgkqhkiG9w0BAQsFADARMQ8wDQYDVQQDDAZtYXN0ZXIwHhcNMjMwNjIzMTEyNjQ4WhcNMzMwNjIzMTEyODI4WjARMQ8wDQYDVQQDDAZtYXN0ZXIwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC04rOaDpre/MucE3HXVCnAnpqIqQOeMn696AW2FATnI26x1BsxVAGjcrheAOIu+CxC28m48Ah4+SiTEk/u2X/WbGTd/1GZooz37cge0AWMQGyh8ysZRd6q06kg4QGD1iUtdQyHioMbSr9pPne2QQgSX5/gM9XDuA6dpG9Yv0PIPLFlk3BIUL1qEfUiYbDlrunkN/y4XromJaJPpgXKWraH194bqcgXGQLrCqicKwsRBoQJHg3ODWHjHFOwYODJ1XBsRcAue4J88PKiPV1tZNPVczMptrkqGBYTgOYGjKXGe5EH50RJE4/3Ynurz2s34DSDVJhJOYtGwpfeSuU3i3mVAgMBAAEwDQYJKoZIhvcNAQELBQADggEBAGAweCuWJmJXMUdRtgoFIiu6BGotDX5sA/VOm4CRsEXV7/qnBagrAPkRz86KGm4lOPL0X+I13JQh4/OB1gxnPN+BXhNtCWCoj1wA3/BWjs1ow/gaVXzwdy+1mbc/sUBudsLq2Yqs54GgeYsTBKMVpSLKiRg1NebEFlqFmG2hjPzYg1QHL4VBusMQgqt7TTnOfGtdT3Ss9TKGRQ+iwfNL0BtSAKaTRdhNVU4lDYUs788Kw5od/uJj0wTICKO5/PrkX7Uy42+fyU+4SvJynPOy+M+z+s08JC9+eYXixfeeFG1nNWR+DIKXcXaSwNQW+8RweGbOJxQ2BoUKtl0NCHrvxJw=\n-----END CERTIFICATE-----"
}

Get certificate info which is used by the specified federation

Authorizations:
TokenAuth
path Parameters
federation_id
required
string <uuid>

federation id in UUID v4 format

certificate_id
required
string

certificate id

Responses

Response samples

Content type
application/json
{
  • "id": "bcceb50a-e4a3-404f-8391-f319e40c1fd5",
  • "account_id": "242137",
  • "federation_id": "f9a51b33-9194-4d44-a959-43740b6334a4",
  • "name": "certificate name",
  • "description": "certificate description",
  • "not_before": "2023-06-23T11:26:48Z",
  • "not_after": "2033-06-23T11:28:28Z",
  • "fingerprint": "6A822A2645D9A18D1CC40D5B5BDA444AA579AF3B399AF77309ABD5222CC23FC0",
  • "data": "-----BEGIN CERTIFICATE-----\nMIICmzCCAYMCBgGI6ANFczANBgkqhkiG9w0BAQsFADARMQ8wDQYDVQQDDAZtYXN0ZXIwHhcNMjMwNjIzMTEyNjQ4WhcNMzMwNjIzMTEyODI4WjARMQ8wDQYDVQQDDAZtYXN0ZXIwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC04rOaDpre/MucE3HXVCnAnpqIqQOeMn696AW2FATnI26x1BsxVAGjcrheAOIu+CxC28m48Ah4+SiTEk/u2X/WbGTd/1GZooz37cge0AWMQGyh8ysZRd6q06kg4QGD1iUtdQyHioMbSr9pPne2QQgSX5/gM9XDuA6dpG9Yv0PIPLFlk3BIUL1qEfUiYbDlrunkN/y4XromJaJPpgXKWraH194bqcgXGQLrCqicKwsRBoQJHg3ODWHjHFOwYODJ1XBsRcAue4J88PKiPV1tZNPVczMptrkqGBYTgOYGjKXGe5EH50RJE4/3Ynurz2s34DSDVJhJOYtGwpfeSuU3i3mVAgMBAAEwDQYJKoZIhvcNAQELBQADggEBAGAweCuWJmJXMUdRtgoFIiu6BGotDX5sA/VOm4CRsEXV7/qnBagrAPkRz86KGm4lOPL0X+I13JQh4/OB1gxnPN+BXhNtCWCoj1wA3/BWjs1ow/gaVXzwdy+1mbc/sUBudsLq2Yqs54GgeYsTBKMVpSLKiRg1NebEFlqFmG2hjPzYg1QHL4VBusMQgqt7TTnOfGtdT3Ss9TKGRQ+iwfNL0BtSAKaTRdhNVU4lDYUs788Kw5od/uJj0wTICKO5/PrkX7Uy42+fyU+4SvJynPOy+M+z+s08JC9+eYXixfeeFG1nNWR+DIKXcXaSwNQW+8RweGbOJxQ2BoUKtl0NCHrvxJw=\n-----END CERTIFICATE-----"
}

Update certificate's data

Authorizations:
TokenAuth
path Parameters
federation_id
required
string <uuid>

federation id in UUID v4 format

certificate_id
required
string

certificate id

Request Body schema: application/json
required
name
string
description
string

Responses

Request samples

Content type
application/json
{
  • "name": "certificate name",
  • "description": "certificate description"
}

Response samples

Content type
application/json
{
  • "id": "bcceb50a-e4a3-404f-8391-f319e40c1fd5",
  • "account_id": "242137",
  • "federation_id": "f9a51b33-9194-4d44-a959-43740b6334a4",
  • "name": "certificate name",
  • "description": "certificate description",
  • "not_before": "2023-06-23T11:26:48Z",
  • "not_after": "2033-06-23T11:28:28Z",
  • "fingerprint": "6A822A2645D9A18D1CC40D5B5BDA444AA579AF3B399AF77309ABD5222CC23FC0",
  • "data": "-----BEGIN CERTIFICATE-----\nMIICmzCCAYMCBgGI6ANFczANBgkqhkiG9w0BAQsFADARMQ8wDQYDVQQDDAZtYXN0ZXIwHhcNMjMwNjIzMTEyNjQ4WhcNMzMwNjIzMTEyODI4WjARMQ8wDQYDVQQDDAZtYXN0ZXIwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC04rOaDpre/MucE3HXVCnAnpqIqQOeMn696AW2FATnI26x1BsxVAGjcrheAOIu+CxC28m48Ah4+SiTEk/u2X/WbGTd/1GZooz37cge0AWMQGyh8ysZRd6q06kg4QGD1iUtdQyHioMbSr9pPne2QQgSX5/gM9XDuA6dpG9Yv0PIPLFlk3BIUL1qEfUiYbDlrunkN/y4XromJaJPpgXKWraH194bqcgXGQLrCqicKwsRBoQJHg3ODWHjHFOwYODJ1XBsRcAue4J88PKiPV1tZNPVczMptrkqGBYTgOYGjKXGe5EH50RJE4/3Ynurz2s34DSDVJhJOYtGwpfeSuU3i3mVAgMBAAEwDQYJKoZIhvcNAQELBQADggEBAGAweCuWJmJXMUdRtgoFIiu6BGotDX5sA/VOm4CRsEXV7/qnBagrAPkRz86KGm4lOPL0X+I13JQh4/OB1gxnPN+BXhNtCWCoj1wA3/BWjs1ow/gaVXzwdy+1mbc/sUBudsLq2Yqs54GgeYsTBKMVpSLKiRg1NebEFlqFmG2hjPzYg1QHL4VBusMQgqt7TTnOfGtdT3Ss9TKGRQ+iwfNL0BtSAKaTRdhNVU4lDYUs788Kw5od/uJj0wTICKO5/PrkX7Uy42+fyU+4SvJynPOy+M+z+s08JC9+eYXixfeeFG1nNWR+DIKXcXaSwNQW+8RweGbOJxQ2BoUKtl0NCHrvxJw=\n-----END CERTIFICATE-----"
}

Delete certificate which is used by the specified federation

Authorizations:
TokenAuth
path Parameters
federation_id
required
string <uuid>

federation id in UUID v4 format

certificate_id
required
string

certificate id

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}