Security Provider - Import/Export¶

Vinyl supports both importing and exporting security provider configurations.

Import¶

To import a security provider, start by signing into Vinyl as an Administrator:

Switch to the IDE
Click the Security Providers button
In the Configuration panel, expand the More menu and click Import Provider
Provide the serialized security provider. See Format below.
Click the Import button
Click the View button to view and modify the security provider

Vinyl will assign a unique identifier to the security provider on import.

The the new security provider will be disabled by default and will not appear on the login form.

Export¶

To export a security provider provider, start by signing into Vinyl as an administrator:

Switch to the IDE
Click the Security Providers button
Locate the security provider and click the Details icon (chevron)
Expand the More menu and click Export Provider

This will display the serialized security provider configuration.

Format¶

The security provider configuration format takes the form of a JSON document.

The root element is an object of type Provider.

Example¶

{
  "name": "MyIdP",
  "type": "saml_sp",
  "audience": "https://example/Vinyl",
  "recipient": "https://example/Vinyl/signin-MyIdP",
  "settings": {},
  "groups": [],
  "claimTypes": [],
  "endpoints": [
    {
      "type": "metadata",
      "url": "https://example/saml/metadata"
    }
  ],
  "credentials": [],
  "certificates": []
}

Types¶

Provider¶

Name	Type	Description
name	String	Security provider name.
type	ProviderType	Security provider type.
authenticationType	AuthenticationType	Authentication type.
oauthGrantType	OAuthGrantType	OAuth grant type.
oauthClientAuthenticationType	OAuthClientAuthenticationType	OAuth client authentication type.
oauthResourceAuthenticationType	OAuthResourceAuthenticationType	OAuth resource authentication types.
tokenOwner	TokenOwner	Token owner.
subject	String	Token subject.
issuer	String	Token issuer.
audience	String	Token audience.
recipient	String	Token Recipient.
entityId	String	Token entity identifier.
identityProviderUrl	String	Identity Provider (IdP) URL.
endpoints	Endpoint[]	Array of endpoints.
credentials	Credential[]	Array of credentials.
certificates	Certificate[]	Array of certificates and keys.
settings	Object	Collection of key/value pairs where each key corresponds to a well-known parameter name. See the specific security provider's documentation for a list of supported parameters.
claimTypes	ClaimType[]	Array of claim types.
groups	Group[]	Array of security groups.
registration	Registration	Security provider registration.

Endpoint¶

Name	Type	Description
type	EndpointType	Endpoint type.
url	String	Endpoint URL.

Credential¶

Name	Type	Description
type	CredentialType	Credential type.
userName	String	User name.
password	String	Plain-text password.

Certificate¶

Name	Type	Description
usage	CertificateUsage	Certificate usage.
type	CertificateType	Certificate type.
format	CertificateFormat	Certificate format.
content	String	Encoded certificate or key.
password	String	Plain-text password.
thumbprint*	String	Certificate thumbprint.

ClaimType¶

Name	Type	Description
identitier	String	Claim type identifier, typically a URL or JSON key.
usage	ClaimTypeUsage	Claim type usage.
priority	Number	Claim type priority.
ignore	Boolean	Indicates whether the claim type should be ignored.

Group¶

Name	Type	Description
name	String	Group name.
identifier	String	Group identifier.
groupId	Unique ID	Vinyl security group identifier.
grantOnIdentityCreate	Boolean	Indicates whether identities should be added to the group when provisioned.

Registration¶

Name	Type	Description
enabled	Boolean	Enables the security provider.
priority	Number	Security provider ordinal position.
sealed	Boolean	Seals the security provider. INTERNAL USE ONLY.
redirectOnChallenge	Boolean	Bypasses the login form and redirects the client to the user authentication provider when challenged.
showOnLoginForm	Boolean	Displays the user authentication provider on the login form.
userProvisioning	Boolean	Enables provisioning for the user authentication provider.
matchExistingUser	Boolean	Allows the user provisioning process to map identities to existing users.
suppliesGroupMembership	Boolean	Indicates that the user authentication provider maintains security group membership.
storeClaims	Boolean	Indicates that Vinyl should store any claims received from the user authentication provider.
defaultAuthenticationProvider	Boolean	Indicates that Vinyl should make the user authentication provider the system's default user authentication provider.

Values¶