Identity and Access Management SAML API, gRPC: FederationService.Get
Returns the specified federation.
To get the list of available federations, make a List request.
gRPC request
rpc Get (GetFederationRequest) returns (Federation)
GetFederationRequest
{
"federationId": "string"
}
Field |
Description |
federationId |
string ID of the federation to return. |
Federation
{
"id": "string",
"folderId": "string",
"name": "string",
"description": "string",
"createdAt": "google.protobuf.Timestamp",
"cookieMaxAge": "google.protobuf.Duration",
"autoCreateAccountOnLogin": "bool",
"issuer": "string",
"ssoBinding": "BindingType",
"ssoUrl": "string",
"securitySettings": {
"encryptedAssertions": "bool"
},
"caseInsensitiveNameIds": "bool"
}
A federation.
For more information, see SAML-compatible identity federations.
Field |
Description |
id |
string Required field. ID of the federation. |
folderId |
string Required field. ID of the folder that the federation belongs to. |
name |
string Required field. Name of the federation. |
description |
string Description of the federation. |
createdAt |
Creation timestamp. |
cookieMaxAge |
Browser cookie lifetime in seconds. |
autoCreateAccountOnLogin |
bool Add new users automatically on successful authentication. If the value is |
issuer |
string Required field. ID of the IdP server to be used for authentication. |
ssoBinding |
enum BindingType Single sign-on endpoint binding type. Most Identity Providers support the SAML Binding is a mapping of a SAML protocol message onto standard messaging
|
ssoUrl |
string Required field. Single sign-on endpoint URL. |
securitySettings |
Federation security settings. |
caseInsensitiveNameIds |
bool Use case insensitive Name IDs. |
FederationSecuritySettings
Federation security settings.
Field |
Description |
encryptedAssertions |
bool Enable encrypted assertions. |