Connectors
...
Actions
Get Applications
5 min
description retrieves a paginated list of all applications within the organization, with optional filtering based on expressions or queries endpoint url /api/v1/apps method get inputs parameters (object) q (string) searches for apps with name or label properties that starts with the q value using the startswith operation after (string) specifies the pagination cursor for the next page of results treat this as an opaque value obtained through the next link relationship useoptimization (boolean) specifies whether to use query optimization if you specify useoptimization=true in the request query, the response contains a subset of app instance properties limit (number) it should be integer <= 200 specifies the number of results per page filter (string) filters apps by status, user id, group id, credentials signing kid or name expression that supports the eq operator filter for active apps filter=status eq "active" filter for apps with okta org2org name filter=name eq "okta org2org" filter for apps using a specific key filter=credentials signing kid eq "simccqny3uwxow3y0vf6vxibb5n9pf8l2fk8d f1bm4" expand (string) an optional parameter used for link expansion to embed more resources in the response only supports expand=user/ and must be used with the user id eq "" filter query for the same user returns the assigned application user in the embedded property includenondeleted (boolean) specifies whether to include non active, but not deleted apps in the results output example \[ { "status code" 200, "reason" "ok", "headers" { "content type" "application/json; charset=utf 8", "content length" "0", "connection" "close", "date" "tue, 10 mar 2020 15 00 00 gmt", "server" "nginx", "x request id" "a1b2c3d4e5f6g7h8i9j0", "x runtime" "0 000000", "x powered by" "phusion passenger 5 3 7", "x frame options" "sameorigin", "x xss protection" "1; mode=block", "x content type options" "nosniff", "x download options" "noopen", "x permitted cross domain policies" "none", "referrer policy" "strict origin when cross origin", "strict transport security" "max age=31536000; includesubdomains", "x content security policy" "default src 'self' https // googleapis com https // gstatic com https // google com https // google analytics com https // googleadservices com https // googletagmanager com https // googleusercontent com https // gvt1 com https // gvt2 com https // gvt3 com https // gvt4 com https // gvt5 com https // gvt6 com https // gvt7 com https // gvt8 com https // gvt9 com https // gvt10 com https // gvt11 com https // gvt12 com https // gvt13 com https // gvt14 com https // gvt15 com https // gvt16 com https // gvt17 com https // gvt18 com https // gvt19 com https // gvt20 com https // gvt21 com https // gvt22 com https // gvt23 com https // gvt24 com https // gvt25 com https // gvt26 com https // gvt27 com https // gvt28 com https // gvt29 com https // gvt30 com https // gvt31 com https // gvt32 com https // gvt33 com https // gvt" }, "response" \[ { "id" "0oa1gjh63g214q0hq0g4", "name" "testorgone customsaml20app 1", "label" "custom saml 2 0 app", "status" "active", "lastupdated" "2016 08 09t20 12 19 000z", "created" "2016 08 09t20 12 19 000z", "accessibility" { "selfservice" false, "errorredirecturl" null, "loginredirecturl" null }, "visibility" { "autosubmittoolbar" false, "hide" { "ios" false, "web" false }, "applinks" { "testorgone customsaml20app 1 link" true } }, "features" \[], "signonmode" "saml 2 0", "credentials" { "usernametemplate" { "template" "${fn\ substringbefore(source login, \\"@\\")}", "type" "built in" }, "signing" {} }, "settings" { "app" {}, "notifications" { "vpn" { "network" { "connection" "disabled" }, "message" null, "helpurl" null } }, "signon" { "defaultrelaystate" "", "ssoacsurl" "https //{youroktadomain}", "idpissuer" "http //www okta com/${org externalkey}", "audience" "https //example com/tenant/123", "recipient" "http //recipient okta com", "destination" "http //destination okta com", "subjectnameidtemplate" "${user username}", "subjectnameidformat" "urn\ oasis\ names\ tc\ saml 1 1\ nameid format\ emailaddress", "responsesigned" true, "assertionsigned" true, "signaturealgorithm" "rsa sha256", "digestalgorithm" "sha256", "honorforceauthn" true, "authncontextclassref" "urn\ oasis\ names\ tc\ saml 2 0\ ac\ classes\ passwordprotectedtransport", "slo" { "enabled" true, "spissuer" "https //testorgone okta com", "logouturl" "https //testorgone okta com/logout" }, "spcertificate" { "x5c" \[ "miifndcca4qccqdbslbion2t1zanbgkqhkig9w0baqsfadcbjzelmakga1uebhmcvvmxdjambgnv\r\nbagmbu1haw5lmrawdgydvqqhdaddyxjpym91mrcwfqydvqqkda5tbm93bwfrzxjzieluyzeumbig\r\na1uecwwlrw5naw5lzxjpbmcxdtalbgnvbammbfnub3cxidaebgkqhkig9w0bcqewewvtywlsqgv4\r\nyw1wbguuy29tmb4xdtiwmtiwmziyndy0m1oxdtmwmtiwmtiyndy0m1owgy8xczajbgnvbaytalvt\r\nmq4wdaydvqqidavnywluzteqma4ga1uebwwhq2fyawjvdtexmbuga1uecgwou25vd21ha2vycybj\r\nbmmxfdasbgnvbasmc0vuz2luzwvyaw5nmq0wcwydvqqddartbm93msawhgyjkozihvcnaqkbfhfl\r\nbwfpbeblegftcgxllmnvbtccaiiwdqyjkozihvcnaqebbqadggipadccagocggibanmmwdjxpdoa\r\npyzienqey9njlan2fqcbqpsestwuucb6nhdsjvgsq7xr+ozqa5tajzbp7cajuj8vccbqmzsgoqau\r\no/pzyyqekptlmrgvpn7xkj1a1xlkp2ny18cpdteupuejuoidz9ejweuyuziktzxnnu1pa1lgijiu\r\n2xnxs9d9jr/hm3tcu9im8qlvb4jtx80yua6qtlrjwr/h8a373aycoasdob3c57fipd8atdny2w/c\r\nfcvgiykdmfb+ga/wtszpop3iohrp8ltancsuzypcztb2ie+jijttsic9kua2abajqqpocjubnshi\r\nvff4822czpzis44mv2guc9wani8u3uyl5mksu95j01jzadkrp5s+2f0k+n8n4uov9fnqzfyugakd\r\ncji9k6nlsap+tgpe/jp9fosuxqohwjfmdlhdjd+evoki9e55sr5lrfk0xu1fj5ld7zjc0pxphtjf\r\nsgjezzd433ashnrzvrt1ksncpklyomznzo5n9rwygcq8hcytlqdtesmke+s05e/vswnth84xddrt\r\niexwfwhhfaabsu+wjzyxi9cxdfcsvxhsgufuck4fbyahl/ga/cjxzc52yfc7pcq0u9o2bscjypdq\r\ndahs9dht1rhwvlm8rmoazgxyyzau0gxnalgsbd9fmw6dxqihip8yaag9crxhyrtnagmbaaewdqyj\r\nkozihvcnaqelbqadggibadofec1svg8qa7pmkcjb/e9sxhk3mvuo9gq43xzwvb721ng3vyf4vgu3\r\nwluwjelt0wggnj26njwen5t3q9t8umxzhhswvtteu3+s1narrb0beti716hslocdx4wtmbu/d1mg\r\nt/kzyfjw+zuzvacbyct2pk69aqhd8xaibqvqadji7cck3yrry+awtppc58p81kyabulcffxfhj9e\r\np72ffn4jvhpx3lxxyh7fkadikby2fyzjsc7rdgki1r3iaazucgbtveznzaetgztujjl/g1tcvyij\r\nlth9zoqbplumi88lxuxqgrterppmajh00cacx4jfizrwelm1trzyy06wndqglrqhr3eoagbf/o2h\r\nhftehndvr6iq3yhkwbo4/+rl0rczhmh4u86vbddndn4y6hzluyiatbfoikokm6uhtoa0pqv2bbr5\r\nwbkrkvuxl9yjjw/hmtcdfnsm9dtojukzeglngf2184gg+qjdzb6fsf0eao1f6stqisswl+uhqziy\r\ndazzyu7gg5sekoz20ztrax3ihj9zij/ornrare7em/uskmecp+7syuwaukxdczkgiudskmohhbgl\r\njtbyk3f2uvojolsm3picvmak9kwmjstgjb47abup1+w+zgcnk0d5co3ij6qekilfwjyq+kkswlkt\r\nzoyqqatrnbagm7mi2/t4\r\n" ] }, "requestcompressed" false, "allowmultipleacsendpoints" false, "acsendpoints" \[], "attributestatements" \[], "inlinehooks" \[ { "id" "${inlinehookid}", " links" { "self" { "href" "https //{youroktadomain}/api/v1/inlinehooks/${inlinehookid}", "hints" { "allow" \[ "get", "put", "delete" ] } } } } ] } }, " links" { "logo" \[ { "name" "medium", "href" "http //testorgone okta com/assets/img/logos/default 6770228fb0dab49a1695ef440a5279bb png", "type" "image/png" } ], "applinks" \[ { "name" "testorgone customsaml20app 1 link", "href" "http //testorgone okta com/home/testorgone customsaml20app 1/0oa1gjh63g214q0hq0g4/aln1gofchjaerovfy0g4", "type" "text/html" } ], "help" { "href" "http //testorgone admin okta com/app/testorgone customsaml20app 1/0oa1gjh63g214q0hq0g4/setup/help/saml 2 0/instructions", "type" "text/html" }, "users" { "href" "http //testorgone okta com/api/v1/apps/0oa1gjh63g214q0hq0g4/users" }, "deactivate" { "href" "http //testorgone okta com/api/v1/apps/0oa1gjh63g214q0hq0g4/lifecycle/deactivate" }, "groups" { "href" "http //testorgone okta com/api/v1/apps/0oa1gjh63g214q0hq0g4/groups" }, "metadata" { "href" "http //testorgone okta com /api/v1/apps/0oa1gjh63g214q0hq0g4/sso/saml/metadata", "type" "application/xml" } } }, { "id" "0oabkvbldekcnxbgyuas", "name" "template swa", "label" "sample plugin app", "status" "active", "lastupdated" "2013 09 11t17 58 54 000z", "created" "2013 09 11t17 46 08 000z", "accessibility" { "selfservice" false, "errorredirecturl" null }, "visibility" { "autosubmittoolbar" false, "hide" { "ios" false, "web" false }, "applinks" { "login" true } }, "features" \[], "signonmode" "browser plugin", "credentials" { "scheme" "edit username and password", "usernametemplate" { "template" "${source login}", "type" "built in" } }, "settings" { "app" { "buttonfield" "btn login", "passwordfield" "txtbox password", "usernamefield" "txtbox username", "url" "https //example com/login html" } }, " links" { "logo" \[ { "href" "https /example okta com/img/logos/logo 1 png", "name" "medium", "type" "image/png" } ], "users" { "href" "https //{youroktadomain}/api/v1/apps/0oabkvbldekcnxbgyuas/users" }, "groups" { "href" "https //{youroktadomain}/api/v1/apps/0oabkvbldekcnxbgyuas/groups" }, "self" { "href" "https //{youroktadomain}/api/v1/apps/0oabkvbldekcnxbgyuas" }, "deactivate" { "href" "https //{youroktadomain}/api/v1/apps/0oabkvbldekcnxbgyuas/lifecycle/deactivate" } } } ] } ] output parameters status code (number) reason (string) headers (object) content type (string) content length (string) connection (string) date (string) server (string) x request id (string) x runtime (string) x powered by (string) x frame options (string) x xss protection (string) x content type options (string) x download options (string) x permitted cross domain policies (string) referrer policy (string) strict transport security (string) x content security policy (string) response (array) id (string) name (string) label (string) status (string) lastupdated (string) created (string) accessibility (object) selfservice (boolean) errorredirecturl (object) visibility (object) autosubmittoolbar (boolean) hide (object) ios (boolean) web (boolean) applinks (object) login (boolean) features (array) file name (string) – required file (string) – required signonmode (string) credentials (object) scheme (string) usernametemplate (object) template (string) type (string) settings (object) app (object) buttonfield (string) passwordfield (string) usernamefield (string) url (string) links (object) logo (array) href (string) name (string) type (string) users (object) href (string) groups (object) href (string) self (object) href (string) deactivate (object) href (string)