Create Application (WS-Federation Protocol)
POST {{apiPath}}/environments/{{envID}}/applications
The POST /environments/{{envID}}/applications operation adds a new application resource to the specified environment. Set the protocol attribute in the request body to WS-FED
.
Prerequisites
- See Application Operations for important overview information.
Base application data model (WS-Federation)
See Applications base data model for complete descriptions.
| Property | Required? | Type |
|---|---|---|
enabled | Optional | Boolean |
description | Optional | String |
homePageUrl | Optional | URL |
icon.id | Optional | UUID |
icon.href | Optional | URL |
loginPageUrl | Optional | URL |
name | Required | String |
protocol | Required | String |
type | Required | String |
Additional WS-Federation properties
See Applications WS-Federation settings data model for complete descriptions.
| Property | Required? | Type |
|---|---|---|
audienceRestriction | Optional | String |
domainName | Required | Domain |
idpSigning | Required | Object |
idpSigning.algorithm | Required | String |
idpSigning.key | Required | Object |
idpSigning.key.id | Required | String |
replyUrl | Required | URL |
sloEndpoint | Optional | URL |
subjectNameIdentifierFormat | Optional | String |
Request Body
{"enabled"=>true, "name"=>"WS_FED App-2", "description"=>"Incredible", "type"=>"WEB_APP", "protocol"=>"WS_FED", "homePageUrl"=>"https://www.microsoft.com/en-ca/microsoft-365", "loginPageUrl"=>"https://portal.office.com", "icon"=>{"id"=>"{{iconID}}", "href"=>"https://uploads.pingone.com/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/images/492cf828-14a8-4794-83c2-b9bf4fe796c6_843714e5-1590-4585-8aec-085e33141dbf_original.png"}, "domainName"=>"my.office365.domain", "replyUrl"=>"https://login.microsoftonline.com/login.srf", "sloEndpoint"=>"https://example.com/slo", "subjectNameIdentifierFormat"=>"urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified", "idpSigning"=>{"algorithm"=>"SHA256withRSA", "key"=>{"id"=>"{{keyID}}"}}}
RESPONSES
status: Created
{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/applications/64aa4b4e-ef57-45a4-a86c-cca658ba5213"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"attributes":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/applications/64aa4b4e-ef57-45a4-a86c-cca658ba5213/attributes"},"idpSigningKey":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/keys/a5dbf40e-c77d-463c-a681-32ecbfc444f5"}},"environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"id":"64aa4b4e-ef57-45a4-a86c-cca658ba5213","name":"WS_FED App-2","description":"Incredible","enabled":true,"hiddenFromAppPortal":false,"type":"WEB_APP","loginPageUrl":"https://portal.office.com","homePageUrl":"https://www.microsoft.com/en-ca/microsoft-365","icon":{"id":"58a03414-4a8c-4adf-8040-36f91a96723e","href":"https://uploads.pingone.com/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/images/492cf828-14a8-4794-83c2-b9bf4fe796c6_843714e5-1590-4585-8aec-085e33141dbf_original.png"},"protocol":"WS_FED","createdAt":"2024-03-25T17:11:27.363Z","updatedAt":"2024-03-25T17:11:27.363Z","replyUrl":"https://login.microsoftonline.com/login.srf","domainName":"my.office365.domain","sloEndpoint":"https://example.com/slo","idpSigning":{"key":{"id":"a5dbf40e-c77d-463c-a681-32ecbfc444f5"},"algorithm":"SHA256withRSA"},"audienceRestriction":"urn:federation:MicrosoftOnline"}