com.iland.core.web.rest.api

Interface CompanySSOResource

@Path(value="/companies")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
public interface CompanySSOResource

Single Sign On Resource.

Author:

Nick Kasprzak

Method Summary

Modifier and Type	Method and Description
OIDCIdentityProviderResponse	createGoogleIdentityProvider(String companyId, GoogleIdentityProviderConfigRequest configCreateRequest) Create Google identity provider from config.
OIDCIdentityProviderResponse	createOIDCIdentityProvider(String companyId, OIDCIdentityProviderConfigRequest configCreateRequest) Create OIDC identity provider from config.
OIDCIdentityProviderResponse	createOIDCIdentityProviderFromURL(String companyId, OIDCIdentityProviderURLCreationRequest request) Create a OIDC identity provider from a URL.
SAMLIdentityProviderResponse	createOktaIdentityProvider(String companyId, OktaIdentityProviderCreateRequest configCreateRequest) Create Okta identity provider from config.
SAMLIdentityProviderResponse	createSamlIdentityProvider(String companyId, SAMLIdentityProviderConfigRequest configCreateRequest) Create SAML identity provider from config.
SAMLIdentityProviderResponse	createSAMLIdentityProviderFromFile(String companyId, byte[] config) Create SAML identity provider from file.
SAMLIdentityProviderResponse	createSAMLIdentityProviderFromUrl(String companyId, SAMLIdentityProviderUrlCreationRequest request) Create a SAML identity provider from a URL.
void	deleteIdentityProvider(String companyId) Delete the specified identity provider.
IdentityProviderResponse	getIdentityProvider(String companyId) Get the identity provider for the given company.
IdpAccountLinkErrorResponseSet	getIdentityProviderAccountLinkErrors(String companyId) Get account linking errors for a given company's identity provider.
IdentityProviderRedirectUriResponse	getIdentityProviderRedirectUri(String companyId, boolean isOkta) Get the IDP redirect URI for the given company.
OIDCIdentityProviderResponse	updateGoogleIdentityProvider(String companyId, GoogleIdentityProviderConfigRequest configCreateRequest) Update Google identity provider from config.
OIDCIdentityProviderResponse	updateOIDCIdentityProvider(String companyId, OIDCIdentityProviderConfigRequest oidcIdentityProviderConfigRequest) Update the OIDC identity provider.
SAMLIdentityProviderResponse	updateOktaIdentityProvider(String companyId, OktaIdentityProviderCreateRequest configRequest) Update Okta identity provider from config.
SAMLIdentityProviderResponse	updateSamlIdentityProvider(String companyId, SAMLIdentityProviderConfigRequest samlIdentityProviderConfigRequest) Update the SAML identity provider.

Method Detail

createSAMLIdentityProviderFromUrl

@POST
 @Path(value="/{companyId}/actions/create-saml-idp-url")
 @Consumes(value="application/json")
SAMLIdentityProviderResponse createSAMLIdentityProviderFromUrl(@PathParam(value="companyId")
                                                                                                                                                                   String companyId,
                                                                                                                                                                   SAMLIdentityProviderUrlCreationRequest request)

Create a SAML identity provider from a URL.

Parameters:

companyId - company id

request - url to import identity provider configuration from

Returns:

SAML identity provider response

createOIDCIdentityProviderFromURL

@POST
 @Path(value="/{companyId}/actions/create-oidc-idp-url")
 @Consumes(value="application/json")
OIDCIdentityProviderResponse createOIDCIdentityProviderFromURL(@PathParam(value="companyId")
                                                                                                                                                                   String companyId,
                                                                                                                                                                   OIDCIdentityProviderURLCreationRequest request)

Create a OIDC identity provider from a URL.

Parameters:

companyId - company id

request - url to import identity provider configuration from

Returns:

OIDC identity provider response

createSAMLIdentityProviderFromFile

@POST
 @Path(value="/{companyId}/actions/create-saml-idp-from-file")
 @Consumes(value="application/xml")
SAMLIdentityProviderResponse createSAMLIdentityProviderFromFile(@PathParam(value="companyId")
                                                                                                                                                                         String companyId,
                                                                                                                                                                         byte[] config)

Create SAML identity provider from file.

Parameters:

companyId - company id

config - file of identity provider config

Returns:

SAML identity provider response

createSamlIdentityProvider

@POST
 @Path(value="/{companyId}/actions/create-saml-idp")
 @Consumes(value="application/json")
SAMLIdentityProviderResponse createSamlIdentityProvider(@PathParam(value="companyId")
                                                                                                                                                        String companyId,
                                                                                                                                                        SAMLIdentityProviderConfigRequest configCreateRequest)

Create SAML identity provider from config.

Parameters:

companyId - company id

configCreateRequest - saml config

Returns:

SAML identity provider response

createOIDCIdentityProvider

@POST
 @Path(value="/{companyId}/actions/create-oidc-idp")
 @Consumes(value="application/json")
OIDCIdentityProviderResponse createOIDCIdentityProvider(@PathParam(value="companyId")
                                                                                                                                                        String companyId,
                                                                                                                                                        OIDCIdentityProviderConfigRequest configCreateRequest)

Create OIDC identity provider from config.

Parameters:

companyId - company id

configCreateRequest - oidc config

Returns:

OIDC identity provider response

createGoogleIdentityProvider

@POST
 @Path(value="/{companyId}/actions/create-google-idp")
 @Consumes(value="application/json")
OIDCIdentityProviderResponse createGoogleIdentityProvider(@PathParam(value="companyId")
                                                                                                                                                            String companyId,
                                                                                                                                                            GoogleIdentityProviderConfigRequest configCreateRequest)

Create Google identity provider from config.

Parameters:

companyId - company id

configCreateRequest - google config

Returns:

Google identity provider response

createOktaIdentityProvider

@POST
 @Path(value="/{companyId}/actions/create-okta-idp")
 @Consumes(value="application/json")
SAMLIdentityProviderResponse createOktaIdentityProvider(@PathParam(value="companyId")
                                                                                                                                                        String companyId,
                                                                                                                                                        OktaIdentityProviderCreateRequest configCreateRequest)

Create Okta identity provider from config.

Parameters:

companyId - company id

configCreateRequest - okta config

Returns:

Okta identity provider response

updateGoogleIdentityProvider

@PUT
 @Path(value="/{companyId}/actions/update-google-idp")
 @Consumes(value="application/json")
OIDCIdentityProviderResponse updateGoogleIdentityProvider(@PathParam(value="companyId")
                                                                                                                                                           String companyId,
                                                                                                                                                           GoogleIdentityProviderConfigRequest configCreateRequest)

Update Google identity provider from config.

Parameters:

companyId - company id

configCreateRequest - google config

updateOktaIdentityProvider

@PUT
 @Path(value="/{companyId}/actions/update-okta-idp")
 @Consumes(value="application/json")
SAMLIdentityProviderResponse updateOktaIdentityProvider(@PathParam(value="companyId")
                                                                                                                                                       String companyId,
                                                                                                                                                       OktaIdentityProviderCreateRequest configRequest)

Update Okta identity provider from config.

Parameters:

companyId - company id

configRequest - okta config

getIdentityProviderRedirectUri

@GET
 @Path(value="/{companyId}/idp-redirect-uri")
 @Consumes(value="application/json")
IdentityProviderRedirectUriResponse getIdentityProviderRedirectUri(@PathParam(value="companyId")
                                                                                                                                                           String companyId,
                                                                                                                                                           @QueryParam(value="isOkta")
                                                                                                                                                           boolean isOkta)

Get the IDP redirect URI for the given company.

Parameters:

companyId - company id

Returns:

identity provider redirect uri response

getIdentityProvider

@GET
 @Path(value="/{companyId}/idp")
IdentityProviderResponse getIdentityProvider(@PathParam(value="companyId")
                                                                                   String companyId)

Get the identity provider for the given company.

Parameters:

companyId - company id

Returns:

the identity provider

updateSamlIdentityProvider

@PUT
 @Path(value="/{companyId}/actions/update-saml-provider")
 @Consumes(value="application/json")
SAMLIdentityProviderResponse updateSamlIdentityProvider(@PathParam(value="companyId")
                                                                                                                                                            String companyId,
                                                                                                                                                            SAMLIdentityProviderConfigRequest samlIdentityProviderConfigRequest)

Update the SAML identity provider.

Parameters:

companyId - company id

samlIdentityProviderConfigRequest - saml identity provider config request

updateOIDCIdentityProvider

@PUT
 @Path(value="/{companyId}/actions/update-oidc-provider")
 @Consumes(value="application/json")
OIDCIdentityProviderResponse updateOIDCIdentityProvider(@PathParam(value="companyId")
                                                                                                                                                            String companyId,
                                                                                                                                                            OIDCIdentityProviderConfigRequest oidcIdentityProviderConfigRequest)

Update the OIDC identity provider.

Parameters:

companyId - company id

oidcIdentityProviderConfigRequest - oidc identity provider config request

deleteIdentityProvider

@DELETE
 @Path(value="/{companyId}/idp")
void deleteIdentityProvider(@PathParam(value="companyId")
                                                                     String companyId)

Delete the specified identity provider.

Parameters:

companyId - company id

getIdentityProviderAccountLinkErrors

@GET
 @Path(value="/{companyId}/idp-account-link-errors")
IdpAccountLinkErrorResponseSet getIdentityProviderAccountLinkErrors(@PathParam(value="companyId")
                                                                                                                              String companyId)

Get account linking errors for a given company's identity provider.

Parameters:

companyId - company id

Returns:

a list of identity provider account link errors