Nomadesk API

Controller: Account Management: GetSamlIdentityProvider

GetSamlIdentityProvider

Gets the Saml Identity Provider details used by the logged in account

Can be configured at brand level or by the group manager

Authentication Methods


  1. With a username and password
Input Parameter Type Description
Token String AMS security token
Output Parameter Type Description
SamlIdentityProvider SamlIdentityProvider True on success, False on failure
IdentityProvider IdentityProvider : Url where the user will be directed to for logging on
Enabled Enabled : Boolean indicating if the identity provider is enabled or not
Metadata Metadata : Saml metadata xml in base64 encoded format
AutoProvision AutoProvision : Boolean indicating if accounts are auto provisioned when they do not yet exist on the Nomadesk system

*required

CURL EXAMPLE
curl -v 'https://secure.nomadesk.com/ctrller/api.php?Task=GetSamlIdentityProvider&Token=fheenvtavr3bfonar94fqf2bn0'
RESPONSE

<Response>
    <Status>1</Status>
    <Message></Message>
    <SamlIdentityProvider>
            <IdentityProvider>https://example.com/saml/</IdentityProvider>
            <Enabled>true</Enabled>
            <Metadata>[base64 encoded XML]</Metadata>
            <LogonUrl>https://example.com/my/logon/saml/Gv30QOEX</LogonUrl>
            <FederationMetadataUrl>https://example.com/ctrller/simplesaml/module.php/saml/sp/metadata.php/b00ec193-ab66-f783-f7b2-d82cf526da37</FederationMetadataUrl>
            <AutoProvision>true</AutoProvision>
    </SamlIdentityProvider>
</Response>