1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350 |
- <?xml version="1.0" encoding="UTF-8"?>
- <!--
- Licensed Materials - Property of IBM
- IBM Cognos Products: cclmcf
- (C) Copyright IBM Corp. 2009, 2013
- US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
- ===============================================================================================
- Configuration samples for AAA.
- ===============================================================================================
- -->
- <crn:parameters xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:crn="http://developer.cognos.com/schemas/crconfig/1/" xsi:schemaLocation="http://developer.cognos.com/schemas/crconfig/1/ cogstartup.xsd" version="175.0">
- <crn:parameter name="AAA" opaque="true">
- <crn:value>
- <!-- advancedProperties: Specifies a set of advanced properties. -->
- <!-- The user needs to provide the name and the value for each advanced property. -->
- <crn:parameter name="advancedProperties">
- <crn:value xsi:type="cfg:array">
- </crn:value>
- </crn:parameter>
- <crn:instances name="authProvider">
- <!--
- ===============================================================================
- (Begin of) ActiveDirectory template
- -->
- <crn:instance name="ActiveDirectory Name" class="ActiveDirectory">
- <!-- id: Specifies a unique identifier for the authentication namespace. -->
- <!-- Use the namespace identifier to distinguish between multiple namespaces. Each
- namespace must have a unique identifier. When you select a namespace to use for
- authentication in the run-time environment, the identifier is used by the IBM
- Cognos components. Changing the namespace ID after the service has been started
- may invalidate the object security policies and the Cognos group and role
- memberships. The use of the colon in the Namespace ID is not supported. -->
- <crn:parameter name="id">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- connection: Specifies the host name and port of the directory server. -->
- <!-- Use the following syntax to specify the host name and port for the directory
- server:host:port; for example, localhost:389. Ensure that if you use a fully
- qualified name for your computer that your DNS is set up to resolve it. If you
- specifically wish to use SSL for the connection to the Active Directory Server,
- the server name must match the name specified in the certificate and the server
- port must be the SSL port. -->
- <crn:parameter name="connection">
- <crn:value xsi:type="cfg:hostPort">
- </crn:value>
- </crn:parameter>
- <!-- timeOut: Specifies the number of seconds permitted to perform a search
- request. -->
- <!-- The product uses this value when it requests authentication from the namespace
- on your directory server. The value depends on your reporting environment. If
- the duration is exceeded, the search is timed out. The default value -1
- indicates that the value on the LDAP server will be used. -->
- <!-- Units: sec -->
- <crn:parameter name="timeOut">
- <crn:value xsi:type="xsd:int">-1</crn:value>
- </crn:parameter>
- <!-- sizeLimit: Specifies the maximum number of responses permitted for a search
- request. -->
- <!-- The value depends on your environment. As a general rule, the minimum value
- for this setting should be greater than the maximum number of groups or users
- plus 100. When the size limit is reached the directory server stops searching.
- The default value of -1 indicates that the value on the LDAP server will be
- used. -->
- <!-- Units: entries -->
- <crn:parameter name="sizeLimit">
- <crn:value xsi:type="xsd:int">-1</crn:value>
- </crn:parameter>
- <!-- bindCredentials: Specifies the credentials ( userID and password ) used to
- bind to the Active Directory Server to find out the detail authentication
- failure reason when the authentication failed. -->
- <!-- This value corresponds to an Active Directory Server user who has search and
- read privilege to the user of the Active Directory Server. -->
- <crn:parameter name="bindCredentials">
- <crn:value xsi:type="cfg:credential" encrypted="false">
- <credential>
- <username>joe</username>
- <password>paranoid</password>
- </credential>
- </crn:value>
- </crn:parameter>
- <!-- RS_SPNName: Specifies the sAMAccountName of the user running Application Tier
- Components. -->
- <!-- This value must be set if you are using Kerberos authentication with
- constrained delegation and IBM Cognos BI is installed on Microsoft Windows
- operating systems. -->
- <crn:parameter name="RS_SPNName">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- DQ_SPNName: Specifies the full DQM Service Principal Name, exactly as it is in
- the keytab file. -->
- <!-- This value must be set if you use Kerberos Authentication with Single Sign On
- (Active Directory) for Dynamic Query Mode, and you don't create explicit
- Kerberos Login Module configuration. DQM will create the configuration using
- this value, and a default name and location for the keytab file -
- configuration\ibmcognosba.keytab. -->
- <crn:parameter name="DQ_SPNName">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- tenantIdMapping: Specifies how namespace users are mapped to tenant IDs. -->
- <!-- Specifying a value for this parameter enables multitenancy. The tenant ID for
- a user can be determined using a pattern or a tenant provider class. The
- pattern is a AAA service search path to a property which defines a tenant ID.
- The search path must be relative to a user account. For example:
- '~/ancestors[2]/defaultName'. A tenant provider class is Java class which
- implements the the ITenantProvider interface. For more details please consult
- the installation and configuration guide. -->
- <crn:parameter name="tenantIdMapping">
- <crn:value xsi:type="cfg:tenancyInfo">pattern</crn:value>
- </crn:parameter>
- <!-- tenantBoundingSetMapping: Specifies how the tenant bounding set is determined
- for a user. -->
- <!-- This parameter is used when multitenancy is enabled. The tenant bounding set
- for a user can be determined using a pattern or a tenant bounding set provider
- class. The pattern is a AAA service search path to a property which defines a
- tenant bounding set. The search path must be relative to a user account. For
- example: '˜/parameters/boundingSet'. A tenant bounding set provider class is
- Java class which implements the the IBoundingSetProvider interface. For more
- details please consult the installation and configuration guide. -->
- <crn:parameter name="tenantBoundingSetMapping">
- <crn:value xsi:type="cfg:tenancyInfo">pattern</crn:value>
- </crn:parameter>
- <!-- selectableForAuth: Specifies whether the namespace is selectable for
- authentication. -->
- <!-- If this property is set to true, the namespace will be available for
- authentication in the logon page namespace selection prompt. Set this value to
- false if the namespace should not be available for selection on the logon page.
- -->
- <crn:parameter name="selectableForAuth">
- <crn:value xsi:type="xsd:boolean">true</crn:value>
- </crn:parameter>
- <!-- advancedProperties: Specifies a set of advanced properties. -->
- <!-- The user needs to provide the name and the value for each advanced property. -->
- <crn:parameter name="advancedProperties">
- <crn:value xsi:type="cfg:array">
- </crn:value>
- </crn:parameter>
- <!-- customProperties: Specifies a set of custom properties. -->
- <!-- Use this set of custom properties to define additional account information. -->
- <crn:parameter name="customProperties">
- <crn:value xsi:type="cfg:array">
- </crn:value>
- </crn:parameter>
- </crn:instance>
- <!--
- (End of) ActiveDirectory template
- ===============================================================================
- -->
- <!--
- ===============================================================================
- (Begin of) Cognos template
- -->
- <crn:instance name="Cognos Name" class="Cognos">
- <!-- allowAnon: Specifies whether anonymous access is allowed. -->
- <!-- By default, anonymous authentication process doesn't require the user to
- provide logon credentials. The anonymous authentication uses a pre-defined
- account under which all anonymous users are logged in. -->
- <crn:parameter name="allowAnon">
- <crn:value xsi:type="xsd:boolean">true</crn:value>
- </crn:parameter>
- <crn:parameter name="disableCM">
- <crn:value xsi:type="xsd:boolean">false</crn:value>
- </crn:parameter>
- </crn:instance>
- <!--
- (End of) Cognos template
- ===============================================================================
- -->
- <!--
- ===============================================================================
- (Begin of) CustomJava template
- -->
- <crn:instance name="CustomJava Name" class="CustomJava">
- <!-- id: Specifies a unique identifier for the authentication namespace. -->
- <!-- Use the namespace identifier to distinguish between multiple namespaces. Each
- namespace must have a unique identifier. When you select a namespace to use for
- authentication in the run-time environment, the identifier is used by the IBM
- Cognos components. Changing the namespace ID after the service has been started
- may invalidate the object security policies and the Cognos group and role
- memberships. The use of the colon in the Namespace ID is not supported. -->
- <crn:parameter name="id">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- authModule: Specifies the Java class name of the authentication provider to
- use for authentication. -->
- <!-- Set the value of this property to the name of your Java class name. This class
- and its dependents must be in the Java CLASSPATH. -->
- <crn:parameter name="authModule">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- selectableForAuth: Specifies whether the namespace is selectable for
- authentication. -->
- <!-- If this property is set to true, the namespace will be available for
- authentication in the logon page namespace selection prompt. Set this value to
- false if the namespace should not be available for selection on the logon page.
- -->
- <crn:parameter name="selectableForAuth">
- <crn:value xsi:type="xsd:boolean">true</crn:value>
- </crn:parameter>
- <!-- advancedProperties: Specifies a set of advanced properties. -->
- <!-- The user needs to provide the name and the value for each advanced property. -->
- <crn:parameter name="advancedProperties">
- <crn:value xsi:type="cfg:array">
- </crn:value>
- </crn:parameter>
- <!-- tenantIdMapping: Specifies how namespace users are mapped to tenant IDs. -->
- <!-- Specifying a value for this parameter enables multitenancy. The tenant ID for
- a user can be determined using a pattern or a tenant provider class. The
- pattern is a AAA service search path to a property which defines a tenant ID.
- The search path must be relative to a user account. For example:
- '~/ancestors[2]/defaultName'. A tenant provider class is Java class which
- implements the the ITenantProvider interface. For more details please consult
- the installation and configuration guide. -->
- <crn:parameter name="tenantIdMapping">
- <crn:value xsi:type="cfg:tenancyInfo">pattern</crn:value>
- </crn:parameter>
- <!-- tenantBoundingSetMapping: Specifies how the tenant bounding set is determined
- for a user. -->
- <!-- This parameter is used when multitenancy is enabled. The tenant bounding set
- for a user can be determined using a pattern or a tenant bounding set provider
- class. The pattern is a AAA service search path to a property which defines a
- tenant bounding set. The search path must be relative to a user account. For
- example: '˜/parameters/boundingSet'. A tenant bounding set provider class is
- Java class which implements the the IBoundingSetProvider interface. For more
- details please consult the installation and configuration guide. -->
- <crn:parameter name="tenantBoundingSetMapping">
- <crn:value xsi:type="cfg:tenancyInfo">pattern</crn:value>
- </crn:parameter>
- </crn:instance>
- <!--
- (End of) CustomJava template
- ===============================================================================
- -->
- <!--
- ===============================================================================
- (Begin of) LDAP template
- -->
- <crn:instance name="LDAP Name" class="LDAP">
- <!-- id: Specifies a unique identifier for the authentication namespace. -->
- <!-- Use the namespace identifier to distinguish between multiple namespaces. Each
- namespace must have a unique identifier. When you select a namespace to use for
- authentication in the run-time environment, the identifier is used by the IBM
- Cognos components. Changing the namespace ID after the service has been started
- may invalidate the object security policies and the Cognos group and role
- memberships. The use of the colon in the Namespace ID is not supported. -->
- <crn:parameter name="id">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- connection: Specifies the host name and port of the directory server. -->
- <!-- Use the following syntax to specify the host name and port for the directory
- server: host:port; for example, localhost:389. Ensure that if you use a fully
- qualified name for your computer that your DNS is set up to resolve it.
- Otherwise, you can also use the IP address. -->
- <crn:parameter name="connection">
- <crn:value xsi:type="cfg:hostPort">
- </crn:value>
- </crn:parameter>
- <!-- baseDN: Specifies the base distinguished name of the LDAP server. -->
- <!-- The product uses the base DN to identify the top level of your directory
- server structure. The root of the hierarchal directory structure is the
- starting place for all searches. You restrict searches by specifying a base DN.
- -->
- <crn:parameter name="baseDN">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- userLookup: Specifies the user lookup used for binding to the LDAP directory
- server. -->
- <!-- Use this property to specify the string that is used to construct the fully
- qualified DN for authentication. All instances of '${userID}' in this string
- are replaced by the value typed in by the user at the logon prompt. If the
- string does not begin with an open parenthesis, the result of the substitution
- is assumed to be a DN which can be used for authentication. For example,
- 'uid=${userID},ou=people, base DN', where base DN is the Base Distinguished
- Name parameter value. If the value begins with an open parenthesis '(', the
- result of the substitution is assumed to be a search filter. Before binding,
- the provider uses the filter to get the DN for authentication. For example,
- '(userPrincipalName=${userID})'. A filter should be used if you have a
- hierarchical directory structure. -->
- <crn:parameter name="userLookup">
- <crn:value xsi:type="xsd:string">${userID}</crn:value>
- </crn:parameter>
- <!-- useExternalIdentity: Specifies whether to use the identity from an external
- source for user authentication. -->
- <!-- If this property is set to true, the user is authenticated by an external
- source and the user's identity is provided to the product from the external
- source. For example, if SSL is configured to use client certificates, the Web
- server sets the REMOTE_USER environment variable to the user's identity. If you
- set this property to true, ensure that you set the "External Identity Mapping"
- property. -->
- <crn:parameter name="useExternalIdentity">
- <crn:value xsi:type="xsd:boolean">false</crn:value>
- </crn:parameter>
- <!-- externalIdentityMapping: Specifies the mapping used to locate a user in the
- LDAP directory server. -->
- <!-- This property is used only if you enable the "Use External identity" property.
- This mapping is used to construct a DN or a search filter to locate a user in
- the LDAP directory server. All instances of
- '${environment("ENVIRONMENT_VARIABLE_NAME")' in this string are replaced by the
- value of the environment variable provided by the Web server. If the string
- does not begin with an open parenthesis, the result of the substitution is
- assumed to be the user's DN. For example,
- 'uid=${environment("REMOTE_USER")},ou=people, base DN', where base DN is the
- Base Distinguished Name parameter value. If the value begins with an open
- parenthesis '(', the result of the substitution is assumed to be a search
- filter. For example, '(userPrincipalName=${environment("REMOTE_USER")})'. Note
- that you must either enable anonymous access to the LDAP directory server or
- set the 'Bind user DN and password' property. -->
- <crn:parameter name="externalIdentityMapping">
- <crn:value xsi:type="xsd:string">${environment("REMOTE_USER")}</crn:value>
- </crn:parameter>
- <!-- bindCredentials: Specifies the credentials used for binding to the LDAP server
- when performing a search using the user lookup property, or when performing all
- operations using the external identity mapping. -->
- <!-- This value corresponds to an LDAP user who has read and search access to the
- user branch of the LDAP directory server. -->
- <crn:parameter name="bindCredentials">
- <crn:value xsi:type="cfg:credential" encrypted="false">
- <credential>
- <username>joe</username>
- <password>paranoid</password>
- </credential>
- </crn:value>
- </crn:parameter>
- <!-- sizeLimit: Specifies the maximum number of responses permitted for a search
- request. -->
- <!-- The value depends on your environment. As a general rule, the minimum value
- for this setting should be greater than the maximum number of groups or users
- plus 100. When the size limit is reached the directory server stops searching.
- The default value of -1 indicates that the value on the LDAP server will be
- used. -->
- <!-- Units: entries -->
- <crn:parameter name="sizeLimit">
- <crn:value xsi:type="xsd:int">-1</crn:value>
- </crn:parameter>
- <!-- timeOut: Specifies the number of seconds permitted to perform a search
- request. -->
- <!-- The product uses this value when it requests authentication from the namespace
- on your directory server. The value depends on your reporting environment. If
- the duration is exceeded, the search is timed out. The default value -1
- indicates that the value on the LDAP server will be used. -->
- <!-- Units: sec -->
- <crn:parameter name="timeOut">
- <crn:value xsi:type="xsd:int">-1</crn:value>
- </crn:parameter>
- <!-- useBindCredentialsForSearch: Specifies whether to use the bind credentials to
- perform a search. -->
- <!-- This property only affects users who don't use the external identity mapping.
- If this property is set to true, the bind credentials provided in the namespace
- configuration will be used to perform a search in the LDAP directory server. If
- this flag is false or bind credentials are not presented, the authenticated
- user credentials will be used for searching. -->
- <crn:parameter name="useBindCredentialsForSearch">
- <crn:value xsi:type="xsd:boolean">false</crn:value>
- </crn:parameter>
- <!-- allowEmptyPswd: Specifies whether empty passwords are allowed for user
- authentication. -->
- <!-- Set this property to true only if you specifically wish to allow empty
- passwords. When a user is not required to specify a password, he is
- authenticated as an anonymous user on the LDAP namespace, but as a named user
- on the Cognos namespace. Requiring passwords for authentication increases
- security and makes it more difficult to forge identities. By default, this
- property is set to false. -->
- <crn:parameter name="allowEmptyPswd">
- <crn:value xsi:type="xsd:boolean">false</crn:value>
- </crn:parameter>
- <!-- camidAttribute: Specifies the value used to uniquely identify objects stored
- in the LDAP directory server. -->
- <!-- Specify either an attribute name or the value of 'dn' to use as the unique
- identifier. If an attribute is used, it must exist for all objects, such as
- users, groups, folders. If the 'dn' is used, more resources are used as you
- search deeper in the LDAP directory server hierarchy and policies may be
- affected if the 'dn' is renamed. -->
- <crn:parameter name="camidAttribute">
- <crn:value xsi:type="xsd:string">dn</crn:value>
- </crn:parameter>
- <!-- dataEncoding: Specifies the encoding of the data stored in the LDAP directory
- server. -->
- <!-- If this property is set to an encoding other than UTF-8, then the data is
- converted from UTF-8 to the encoding you specify. The encoding must follow IANA
- (RFC 1700) or MIME character set specifications. For example, use windows-1252,
- iso-8859-1, iso-8859-15, Shift_JIS, utf-16, or utf-8. -->
- <crn:parameter name="dataEncoding">
- <crn:value xsi:type="xsd:string">UTF-8</crn:value>
- </crn:parameter>
- <!-- sslCertificateDatabase: Specifies the location of the certificate database
- used by the directory server for SSL connections. -->
- <!-- Use this property to point to the location of the SSL certificate database for
- your LDAP server. -->
- <crn:parameter name="sslCertificateDatabase">
- <crn:value xsi:type="cfg:filePath">
- </crn:value>
- </crn:parameter>
- <!-- selectableForAuth: Specifies whether the namespace is selectable for
- authentication. -->
- <!-- If this property is set to true, the namespace will be available for
- authentication in the logon page namespace selection prompt. Set this value to
- false if the namespace should not be available for selection on the logon page.
- -->
- <crn:parameter name="selectableForAuth">
- <crn:value xsi:type="xsd:boolean">true</crn:value>
- </crn:parameter>
- <!-- advancedProperties: Specifies a set of advanced properties. -->
- <!-- The user needs to provide the name and the value for each advanced property. -->
- <crn:parameter name="advancedProperties">
- <crn:value xsi:type="cfg:array">
- </crn:value>
- </crn:parameter>
- <!-- tenantIdMapping: Specifies how namespace users are mapped to tenant IDs. -->
- <!-- Specifying a value for this parameter enables multitenancy. The tenant ID for
- a user can be determined using a pattern or a tenant provider class. The
- pattern is a AAA service search path to a property which defines a tenant ID.
- The search path must be relative to a user account. For example:
- '~/ancestors[2]/defaultName'. A tenant provider class is Java class which
- implements the the ITenantProvider interface. For more details please consult
- the installation and configuration guide. -->
- <crn:parameter name="tenantIdMapping">
- <crn:value xsi:type="cfg:tenancyInfo">pattern</crn:value>
- </crn:parameter>
- <!-- tenantBoundingSetMapping: Specifies how the tenant bounding set is determined
- for a user. -->
- <!-- This parameter is used when multitenancy is enabled. The tenant bounding set
- for a user can be determined using a pattern or a tenant bounding set provider
- class. The pattern is a AAA service search path to a property which defines a
- tenant bounding set. The search path must be relative to a user account. For
- example: '˜/parameters/boundingSet'. A tenant bounding set provider class is
- Java class which implements the the IBoundingSetProvider interface. For more
- details please consult the installation and configuration guide. -->
- <crn:parameter name="tenantBoundingSetMapping">
- <crn:value xsi:type="cfg:tenancyInfo">pattern</crn:value>
- </crn:parameter>
- <!-- folderObjectClass: Specifies the name of the LDAP object class used to
- identify a folder. -->
- <crn:parameter name="folderObjectClass">
- <crn:value xsi:type="xsd:string">organizationalunit</crn:value>
- </crn:parameter>
- <!-- folderDescription: Specifies the LDAP attribute used for the "description"
- property of a folder. -->
- <crn:parameter name="folderDescription">
- <crn:value xsi:type="xsd:string">description</crn:value>
- </crn:parameter>
- <!-- folderName: Specifies the LDAP attribute used for the "name" property of a
- folder. -->
- <crn:parameter name="folderName">
- <crn:value xsi:type="xsd:string">ou</crn:value>
- </crn:parameter>
- <!-- groupObjectClass: Specifies the name of the LDAP object class used to identify
- a group. -->
- <crn:parameter name="groupObjectClass">
- <crn:value xsi:type="xsd:string">groupofuniquenames</crn:value>
- </crn:parameter>
- <!-- groupDescription: Specifies the LDAP attribute used for the "description"
- property of a group. -->
- <crn:parameter name="groupDescription">
- <crn:value xsi:type="xsd:string">description</crn:value>
- </crn:parameter>
- <!-- groupMembers: Specifies the LDAP attribute used to identify the members of a
- group. -->
- <crn:parameter name="groupMembers">
- <crn:value xsi:type="xsd:string">uniquemember</crn:value>
- </crn:parameter>
- <!-- groupName: Specifies the LDAP attribute used for the "name" property of a
- group. -->
- <crn:parameter name="groupName">
- <crn:value xsi:type="xsd:string">cn</crn:value>
- </crn:parameter>
- <!-- accountObjectClass: Specifies the name of the LDAP object class used to
- identify an account. -->
- <crn:parameter name="accountObjectClass">
- <crn:value xsi:type="xsd:string">inetorgperson</crn:value>
- </crn:parameter>
- <!-- accountBusinessPhone: Specifies the LDAP attribute used for the
- "businessPhone" property for an account. -->
- <crn:parameter name="accountBusinessPhone">
- <crn:value xsi:type="xsd:string">telephonenumber</crn:value>
- </crn:parameter>
- <!-- accountContentLocale: Specifies the LDAP attribute used for the
- "contentLocale" property for an account. -->
- <crn:parameter name="accountContentLocale">
- <crn:value xsi:type="xsd:string">preferredlanguage</crn:value>
- </crn:parameter>
- <!-- accountDescription: Specifies the LDAP attribute used for the "description"
- property for an account. -->
- <crn:parameter name="accountDescription">
- <crn:value xsi:type="xsd:string">description</crn:value>
- </crn:parameter>
- <!-- accountEmail: Specifies the LDAP attribute used for the "email" address of the
- account. -->
- <crn:parameter name="accountEmail">
- <crn:value xsi:type="xsd:string">mail</crn:value>
- </crn:parameter>
- <!-- accountFaxPhone: Specifies the LDAP attribute used for the "faxPhone" property
- for an account. -->
- <crn:parameter name="accountFaxPhone">
- <crn:value xsi:type="xsd:string">facsimiletelephonenumber</crn:value>
- </crn:parameter>
- <!-- accountGivenName: Specifies the LDAP attribute used for the "givenName"
- property for an account. -->
- <crn:parameter name="accountGivenName">
- <crn:value xsi:type="xsd:string">givenname</crn:value>
- </crn:parameter>
- <!-- accountHomePhone: Specifies the LDAP attribute used for the "homePhone"
- property for an account. -->
- <crn:parameter name="accountHomePhone">
- <crn:value xsi:type="xsd:string">homephone</crn:value>
- </crn:parameter>
- <!-- accountMobilePhone: Specifies the LDAP attribute used for the "mobilePhone"
- property for an account. -->
- <crn:parameter name="accountMobilePhone">
- <crn:value xsi:type="xsd:string">mobile</crn:value>
- </crn:parameter>
- <!-- accountName: Specifies the LDAP attribute used for the "name" property for an
- account. -->
- <crn:parameter name="accountName">
- <crn:value xsi:type="xsd:string">cn</crn:value>
- </crn:parameter>
- <!-- accountPagerPhone: Specifies the LDAP attribute used for the "pagerPhone"
- property for an account. -->
- <crn:parameter name="accountPagerPhone">
- <crn:value xsi:type="xsd:string">pager</crn:value>
- </crn:parameter>
- <!-- accountPassword: Specifies the LDAP attribute used for the "password" property
- for an account. -->
- <crn:parameter name="accountPassword">
- <crn:value xsi:type="xsd:string">userPassword</crn:value>
- </crn:parameter>
- <!-- accountPostalAddress: Specifies the LDAP attribute used for the
- "postalAddress" property for an account. -->
- <crn:parameter name="accountPostalAddress">
- <crn:value xsi:type="xsd:string">postaladdress</crn:value>
- </crn:parameter>
- <!-- accountProductLocale: Specifies the LDAP attribute used for the
- "productLocale" property for an account. -->
- <crn:parameter name="accountProductLocale">
- <crn:value xsi:type="xsd:string">preferredlanguage</crn:value>
- </crn:parameter>
- <!-- accountSurname: Specifies the LDAP attribute used for the "surname" property
- for an account. -->
- <crn:parameter name="accountSurname">
- <crn:value xsi:type="xsd:string">sn</crn:value>
- </crn:parameter>
- <!-- accountUserName: Specifies the LDAP attribute used for the "userName" property
- for an account. -->
- <crn:parameter name="accountUserName">
- <crn:value xsi:type="xsd:string">uid</crn:value>
- </crn:parameter>
- <!-- customProperties: Specifies a set of custom properties. -->
- <!-- Use this set of custom properties to define additional account information. -->
- <crn:parameter name="customProperties">
- <crn:value xsi:type="cfg:array">
- </crn:value>
- </crn:parameter>
- </crn:instance>
- <!--
- (End of) LDAP template
- ===============================================================================
- -->
- <!--
- ===============================================================================
- (Begin of) LDAP_AD template
- -->
- <crn:instance name="LDAP_AD Name" class="LDAP_AD">
- <!-- id: Specifies a unique identifier for the authentication namespace. -->
- <!-- Use the namespace identifier to distinguish between multiple namespaces. Each
- namespace must have a unique identifier. When you select a namespace to use for
- authentication in the run-time environment, the identifier is used by the IBM
- Cognos components. Changing the namespace ID after the service has been started
- may invalidate the object security policies and the Cognos group and role
- memberships. The use of the colon in the Namespace ID is not supported. -->
- <crn:parameter name="id">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- connection: Specifies the host name and port of the directory server. -->
- <!-- Use the following syntax to specify the host name and port for the directory
- server: host:port; for example, localhost:389. Ensure that if you use a fully
- qualified name for your computer that your DNS is set up to resolve it.
- Otherwise, you can also use the IP address. -->
- <crn:parameter name="connection">
- <crn:value xsi:type="cfg:hostPort">
- </crn:value>
- </crn:parameter>
- <!-- baseDN: Specifies the base distinguished name of the LDAP server. -->
- <!-- The product uses the base DN to identify the top level of your directory
- server structure. The root of the hierarchal directory structure is the
- starting place for all searches. You restrict searches by specifying a base DN.
- -->
- <crn:parameter name="baseDN">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- userLookup: Specifies the user lookup used for binding to the LDAP directory
- server. -->
- <!-- Use this property to specify the string that is used to construct the fully
- qualified DN for authentication. All instances of '${userID}' in this string
- are replaced by the value typed in by the user at the logon prompt. If the
- string does not begin with an open parenthesis, the result of the substitution
- is assumed to be a DN which can be used for authentication. For example,
- 'uid=${userID},ou=people, base DN', where base DN is the Base Distinguished
- Name parameter value. If the value begins with an open parenthesis '(', the
- result of the substitution is assumed to be a search filter. Before binding,
- the provider uses the filter to get the DN for authentication. For example,
- '(userPrincipalName=${userID})'. A filter should be used if you have a
- hierarchical directory structure. -->
- <crn:parameter name="userLookup">
- <crn:value xsi:type="xsd:string">${userID}</crn:value>
- </crn:parameter>
- <!-- useExternalIdentity: Specifies whether to use the identity from an external
- source for user authentication. -->
- <!-- If this property is set to true, the user is authenticated by an external
- source and the user's identity is provided to the product from the external
- source. For example, if SSL is configured to use client certificates, the Web
- server sets the REMOTE_USER environment variable to the user's identity. If you
- set this property to true, ensure that you set the "External Identity Mapping"
- property. -->
- <crn:parameter name="useExternalIdentity">
- <crn:value xsi:type="xsd:boolean">false</crn:value>
- </crn:parameter>
- <!-- externalIdentityMapping: Specifies the mapping used to locate a user in the
- LDAP directory server. -->
- <!-- This property is used only if you enable the "Use External identity" property.
- This mapping is used to construct a DN or a search filter to locate a user in
- the LDAP directory server. All instances of
- '${environment("ENVIRONMENT_VARIABLE_NAME")' in this string are replaced by the
- value of the environment variable provided by the Web server. If the string
- does not begin with an open parenthesis, the result of the substitution is
- assumed to be the user's DN. For example,
- 'uid=${environment("REMOTE_USER")},ou=people, base DN', where base DN is the
- Base Distinguished Name parameter value. If the value begins with an open
- parenthesis '(', the result of the substitution is assumed to be a search
- filter. For example, '(userPrincipalName=${environment("REMOTE_USER")})'. Note
- that you must either enable anonymous access to the LDAP directory server or
- set the 'Bind user DN and password' property. -->
- <crn:parameter name="externalIdentityMapping">
- <crn:value xsi:type="xsd:string">${environment("REMOTE_USER")}</crn:value>
- </crn:parameter>
- <!-- bindCredentials: Specifies the credentials used for binding to the LDAP server
- when performing a search using the user lookup property, or when performing all
- operations using the external identity mapping. -->
- <!-- This value corresponds to an LDAP user who has read and search access to the
- user branch of the LDAP directory server. -->
- <crn:parameter name="bindCredentials">
- <crn:value xsi:type="cfg:credential" encrypted="false">
- <credential>
- <username>joe</username>
- <password>paranoid</password>
- </credential>
- </crn:value>
- </crn:parameter>
- <!-- sizeLimit: Specifies the maximum number of responses permitted for a search
- request. -->
- <!-- The value depends on your environment. As a general rule, the minimum value
- for this setting should be greater than the maximum number of groups or users
- plus 100. When the size limit is reached the directory server stops searching.
- The default value of -1 indicates that the value on the LDAP server will be
- used. -->
- <!-- Units: entries -->
- <crn:parameter name="sizeLimit">
- <crn:value xsi:type="xsd:int">-1</crn:value>
- </crn:parameter>
- <!-- timeOut: Specifies the number of seconds permitted to perform a search
- request. -->
- <!-- The product uses this value when it requests authentication from the namespace
- on your directory server. The value depends on your reporting environment. If
- the duration is exceeded, the search is timed out. The default value -1
- indicates that the value on the LDAP server will be used. -->
- <!-- Units: sec -->
- <crn:parameter name="timeOut">
- <crn:value xsi:type="xsd:int">-1</crn:value>
- </crn:parameter>
- <!-- useBindCredentialsForSearch: Specifies whether to use the bind credentials to
- perform a search. -->
- <!-- This property only affects users who don't use the external identity mapping.
- If this property is set to true, the bind credentials provided in the namespace
- configuration will be used to perform a search in the LDAP directory server. If
- this flag is false or bind credentials are not presented, the authenticated
- user credentials will be used for searching. -->
- <crn:parameter name="useBindCredentialsForSearch">
- <crn:value xsi:type="xsd:boolean">false</crn:value>
- </crn:parameter>
- <!-- allowEmptyPswd: Specifies whether empty passwords are allowed for user
- authentication. -->
- <!-- Set this property to true only if you specifically wish to allow empty
- passwords. When a user is not required to specify a password, he is
- authenticated as an anonymous user on the LDAP namespace, but as a named user
- on the Cognos namespace. Requiring passwords for authentication increases
- security and makes it more difficult to forge identities. By default, this
- property is set to false. -->
- <crn:parameter name="allowEmptyPswd">
- <crn:value xsi:type="xsd:boolean">false</crn:value>
- </crn:parameter>
- <!-- camidAttribute: Specifies the value used to uniquely identify objects stored
- in the LDAP directory server. -->
- <!-- Specify either an attribute name or the value of 'dn' to use as the unique
- identifier. If an attribute is used, it must exist for all objects, such as
- users, groups, folders. If the 'dn' is used, more resources are used as you
- search deeper in the LDAP directory server hierarchy and policies may be
- affected if the 'dn' is renamed. -->
- <crn:parameter name="camidAttribute">
- <crn:value xsi:type="xsd:string">objectGUID</crn:value>
- </crn:parameter>
- <!-- dataEncoding: Specifies the encoding of the data stored in the LDAP directory
- server. -->
- <!-- If this property is set to an encoding other than UTF-8, then the data is
- converted from UTF-8 to the encoding you specify. The encoding must follow IANA
- (RFC 1700) or MIME character set specifications. For example, use windows-1252,
- iso-8859-1, iso-8859-15, Shift_JIS, utf-16, or utf-8. -->
- <crn:parameter name="dataEncoding">
- <crn:value xsi:type="xsd:string">UTF-8</crn:value>
- </crn:parameter>
- <!-- sslCertificateDatabase: Specifies the location of the certificate database
- used by the directory server for SSL connections. -->
- <!-- Use this property to point to the location of the SSL certificate database for
- your LDAP server. -->
- <crn:parameter name="sslCertificateDatabase">
- <crn:value xsi:type="cfg:filePath">
- </crn:value>
- </crn:parameter>
- <!-- selectableForAuth: Specifies whether the namespace is selectable for
- authentication. -->
- <!-- If this property is set to true, the namespace will be available for
- authentication in the logon page namespace selection prompt. Set this value to
- false if the namespace should not be available for selection on the logon page.
- -->
- <crn:parameter name="selectableForAuth">
- <crn:value xsi:type="xsd:boolean">true</crn:value>
- </crn:parameter>
- <!-- advancedProperties: Specifies a set of advanced properties. -->
- <!-- The user needs to provide the name and the value for each advanced property. -->
- <crn:parameter name="advancedProperties">
- <crn:value xsi:type="cfg:array">
- </crn:value>
- </crn:parameter>
- <!-- tenantIdMapping: Specifies how namespace users are mapped to tenant IDs. -->
- <!-- Specifying a value for this parameter enables multitenancy. The tenant ID for
- a user can be determined using a pattern or a tenant provider class. The
- pattern is a AAA service search path to a property which defines a tenant ID.
- The search path must be relative to a user account. For example:
- '~/ancestors[2]/defaultName'. A tenant provider class is Java class which
- implements the the ITenantProvider interface. For more details please consult
- the installation and configuration guide. -->
- <crn:parameter name="tenantIdMapping">
- <crn:value xsi:type="cfg:tenancyInfo">pattern</crn:value>
- </crn:parameter>
- <!-- tenantBoundingSetMapping: Specifies how the tenant bounding set is determined
- for a user. -->
- <!-- This parameter is used when multitenancy is enabled. The tenant bounding set
- for a user can be determined using a pattern or a tenant bounding set provider
- class. The pattern is a AAA service search path to a property which defines a
- tenant bounding set. The search path must be relative to a user account. For
- example: '˜/parameters/boundingSet'. A tenant bounding set provider class is
- Java class which implements the the IBoundingSetProvider interface. For more
- details please consult the installation and configuration guide. -->
- <crn:parameter name="tenantBoundingSetMapping">
- <crn:value xsi:type="cfg:tenancyInfo">pattern</crn:value>
- </crn:parameter>
- <!-- folderObjectClass: Specifies the name of the LDAP object class used to
- identify a folder. -->
- <crn:parameter name="folderObjectClass">
- <crn:value xsi:type="xsd:string">organizationalUnit,organization,container</crn:value>
- </crn:parameter>
- <!-- folderDescription: Specifies the LDAP attribute used for the "description"
- property of a folder. -->
- <crn:parameter name="folderDescription">
- <crn:value xsi:type="xsd:string">description</crn:value>
- </crn:parameter>
- <!-- folderName: Specifies the LDAP attribute used for the "name" property of a
- folder. -->
- <crn:parameter name="folderName">
- <crn:value xsi:type="xsd:string">ou,o,cn</crn:value>
- </crn:parameter>
- <!-- groupObjectClass: Specifies the name of the LDAP object class used to identify
- a group. -->
- <crn:parameter name="groupObjectClass">
- <crn:value xsi:type="xsd:string">group</crn:value>
- </crn:parameter>
- <!-- groupDescription: Specifies the LDAP attribute used for the "description"
- property of a group. -->
- <crn:parameter name="groupDescription">
- <crn:value xsi:type="xsd:string">description</crn:value>
- </crn:parameter>
- <!-- groupMembers: Specifies the LDAP attribute used to identify the members of a
- group. -->
- <crn:parameter name="groupMembers">
- <crn:value xsi:type="xsd:string">member</crn:value>
- </crn:parameter>
- <!-- groupName: Specifies the LDAP attribute used for the "name" property of a
- group. -->
- <crn:parameter name="groupName">
- <crn:value xsi:type="xsd:string">cn</crn:value>
- </crn:parameter>
- <!-- accountObjectClass: Specifies the name of the LDAP object class used to
- identify an account. -->
- <crn:parameter name="accountObjectClass">
- <crn:value xsi:type="xsd:string">user</crn:value>
- </crn:parameter>
- <!-- accountBusinessPhone: Specifies the LDAP attribute used for the
- "businessPhone" property for an account. -->
- <crn:parameter name="accountBusinessPhone">
- <crn:value xsi:type="xsd:string">telephonenumber</crn:value>
- </crn:parameter>
- <!-- accountContentLocale: Specifies the LDAP attribute used for the
- "contentLocale" property for an account. -->
- <crn:parameter name="accountContentLocale">
- <crn:value xsi:type="xsd:string">preferredlanguage</crn:value>
- </crn:parameter>
- <!-- accountDescription: Specifies the LDAP attribute used for the "description"
- property for an account. -->
- <crn:parameter name="accountDescription">
- <crn:value xsi:type="xsd:string">description</crn:value>
- </crn:parameter>
- <!-- accountEmail: Specifies the LDAP attribute used for the "email" address of the
- account. -->
- <crn:parameter name="accountEmail">
- <crn:value xsi:type="xsd:string">mail</crn:value>
- </crn:parameter>
- <!-- accountFaxPhone: Specifies the LDAP attribute used for the "faxPhone" property
- for an account. -->
- <crn:parameter name="accountFaxPhone">
- <crn:value xsi:type="xsd:string">facsimiletelephonenumber</crn:value>
- </crn:parameter>
- <!-- accountGivenName: Specifies the LDAP attribute used for the "givenName"
- property for an account. -->
- <crn:parameter name="accountGivenName">
- <crn:value xsi:type="xsd:string">givenname</crn:value>
- </crn:parameter>
- <!-- accountHomePhone: Specifies the LDAP attribute used for the "homePhone"
- property for an account. -->
- <crn:parameter name="accountHomePhone">
- <crn:value xsi:type="xsd:string">homephone</crn:value>
- </crn:parameter>
- <!-- accountMobilePhone: Specifies the LDAP attribute used for the "mobilePhone"
- property for an account. -->
- <crn:parameter name="accountMobilePhone">
- <crn:value xsi:type="xsd:string">mobile</crn:value>
- </crn:parameter>
- <!-- accountName: Specifies the LDAP attribute used for the "name" property for an
- account. -->
- <crn:parameter name="accountName">
- <crn:value xsi:type="xsd:string">displayName</crn:value>
- </crn:parameter>
- <!-- accountPagerPhone: Specifies the LDAP attribute used for the "pagerPhone"
- property for an account. -->
- <crn:parameter name="accountPagerPhone">
- <crn:value xsi:type="xsd:string">pager</crn:value>
- </crn:parameter>
- <!-- accountPassword: Specifies the LDAP attribute used for the "password" property
- for an account. -->
- <crn:parameter name="accountPassword">
- <crn:value xsi:type="xsd:string">unicodePwd</crn:value>
- </crn:parameter>
- <!-- accountPostalAddress: Specifies the LDAP attribute used for the
- "postalAddress" property for an account. -->
- <crn:parameter name="accountPostalAddress">
- <crn:value xsi:type="xsd:string">postaladdress</crn:value>
- </crn:parameter>
- <!-- accountProductLocale: Specifies the LDAP attribute used for the
- "productLocale" property for an account. -->
- <crn:parameter name="accountProductLocale">
- <crn:value xsi:type="xsd:string">preferredlanguage</crn:value>
- </crn:parameter>
- <!-- accountSurname: Specifies the LDAP attribute used for the "surname" property
- for an account. -->
- <crn:parameter name="accountSurname">
- <crn:value xsi:type="xsd:string">sn</crn:value>
- </crn:parameter>
- <!-- accountUserName: Specifies the LDAP attribute used for the "userName" property
- for an account. -->
- <crn:parameter name="accountUserName">
- <crn:value xsi:type="xsd:string">sAMAccountName</crn:value>
- </crn:parameter>
- <!-- customProperties: Specifies a set of custom properties. -->
- <!-- Use this set of custom properties to define additional account information. -->
- <crn:parameter name="customProperties">
- <crn:value xsi:type="cfg:array">
- </crn:value>
- </crn:parameter>
- </crn:instance>
- <!--
- (End of) LDAP_AD template
- ===============================================================================
- -->
- <!--
- ===============================================================================
- (Begin of) LDAP_IBM template
- -->
- <crn:instance name="LDAP_IBM Name" class="LDAP_IBM">
- <!-- id: Specifies a unique identifier for the authentication namespace. -->
- <!-- Use the namespace identifier to distinguish between multiple namespaces. Each
- namespace must have a unique identifier. When you select a namespace to use for
- authentication in the run-time environment, the identifier is used by the IBM
- Cognos components. Changing the namespace ID after the service has been started
- may invalidate the object security policies and the Cognos group and role
- memberships. The use of the colon in the Namespace ID is not supported. -->
- <crn:parameter name="id">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- connection: Specifies the host name and port of the directory server. -->
- <!-- Use the following syntax to specify the host name and port for the directory
- server: host:port; for example, localhost:389. Ensure that if you use a fully
- qualified name for your computer that your DNS is set up to resolve it.
- Otherwise, you can also use the IP address. -->
- <crn:parameter name="connection">
- <crn:value xsi:type="cfg:hostPort">
- </crn:value>
- </crn:parameter>
- <!-- baseDN: Specifies the base distinguished name of the LDAP server. -->
- <!-- The product uses the base DN to identify the top level of your directory
- server structure. The root of the hierarchal directory structure is the
- starting place for all searches. You restrict searches by specifying a base DN.
- -->
- <crn:parameter name="baseDN">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- userLookup: Specifies the user lookup used for binding to the LDAP directory
- server. -->
- <!-- Use this property to specify the string that is used to construct the fully
- qualified DN for authentication. All instances of '${userID}' in this string
- are replaced by the value typed in by the user at the logon prompt. If the
- string does not begin with an open parenthesis, the result of the substitution
- is assumed to be a DN which can be used for authentication. For example,
- 'uid=${userID},ou=people, base DN', where base DN is the Base Distinguished
- Name parameter value. If the value begins with an open parenthesis '(', the
- result of the substitution is assumed to be a search filter. Before binding,
- the provider uses the filter to get the DN for authentication. For example,
- '(userPrincipalName=${userID})'. A filter should be used if you have a
- hierarchical directory structure. -->
- <crn:parameter name="userLookup">
- <crn:value xsi:type="xsd:string">${userID}</crn:value>
- </crn:parameter>
- <!-- useExternalIdentity: Specifies whether to use the identity from an external
- source for user authentication. -->
- <!-- If this property is set to true, the user is authenticated by an external
- source and the user's identity is provided to the product from the external
- source. For example, if SSL is configured to use client certificates, the Web
- server sets the REMOTE_USER environment variable to the user's identity. If you
- set this property to true, ensure that you set the "External Identity Mapping"
- property. -->
- <crn:parameter name="useExternalIdentity">
- <crn:value xsi:type="xsd:boolean">false</crn:value>
- </crn:parameter>
- <!-- externalIdentityMapping: Specifies the mapping used to locate a user in the
- LDAP directory server. -->
- <!-- This property is used only if you enable the "Use External identity" property.
- This mapping is used to construct a DN or a search filter to locate a user in
- the LDAP directory server. All instances of
- '${environment("ENVIRONMENT_VARIABLE_NAME")' in this string are replaced by the
- value of the environment variable provided by the Web server. If the string
- does not begin with an open parenthesis, the result of the substitution is
- assumed to be the user's DN. For example,
- 'uid=${environment("REMOTE_USER")},ou=people, base DN', where base DN is the
- Base Distinguished Name parameter value. If the value begins with an open
- parenthesis '(', the result of the substitution is assumed to be a search
- filter. For example, '(userPrincipalName=${environment("REMOTE_USER")})'. Note
- that you must either enable anonymous access to the LDAP directory server or
- set the 'Bind user DN and password' property. -->
- <crn:parameter name="externalIdentityMapping">
- <crn:value xsi:type="xsd:string">${environment("REMOTE_USER")}</crn:value>
- </crn:parameter>
- <!-- bindCredentials: Specifies the credentials used for binding to the LDAP server
- when performing a search using the user lookup property, or when performing all
- operations using the external identity mapping. -->
- <!-- This value corresponds to an LDAP user who has read and search access to the
- user branch of the LDAP directory server. -->
- <crn:parameter name="bindCredentials">
- <crn:value xsi:type="cfg:credential" encrypted="false">
- <credential>
- <username>joe</username>
- <password>paranoid</password>
- </credential>
- </crn:value>
- </crn:parameter>
- <!-- sizeLimit: Specifies the maximum number of responses permitted for a search
- request. -->
- <!-- The value depends on your environment. As a general rule, the minimum value
- for this setting should be greater than the maximum number of groups or users
- plus 100. When the size limit is reached the directory server stops searching.
- The default value of -1 indicates that the value on the LDAP server will be
- used. -->
- <!-- Units: entries -->
- <crn:parameter name="sizeLimit">
- <crn:value xsi:type="xsd:int">-1</crn:value>
- </crn:parameter>
- <!-- timeOut: Specifies the number of seconds permitted to perform a search
- request. -->
- <!-- The product uses this value when it requests authentication from the namespace
- on your directory server. The value depends on your reporting environment. If
- the duration is exceeded, the search is timed out. The default value -1
- indicates that the value on the LDAP server will be used. -->
- <!-- Units: sec -->
- <crn:parameter name="timeOut">
- <crn:value xsi:type="xsd:int">-1</crn:value>
- </crn:parameter>
- <!-- useBindCredentialsForSearch: Specifies whether to use the bind credentials to
- perform a search. -->
- <!-- This property only affects users who don't use the external identity mapping.
- If this property is set to true, the bind credentials provided in the namespace
- configuration will be used to perform a search in the LDAP directory server. If
- this flag is false or bind credentials are not presented, the authenticated
- user credentials will be used for searching. -->
- <crn:parameter name="useBindCredentialsForSearch">
- <crn:value xsi:type="xsd:boolean">false</crn:value>
- </crn:parameter>
- <!-- allowEmptyPswd: Specifies whether empty passwords are allowed for user
- authentication. -->
- <!-- Set this property to true only if you specifically wish to allow empty
- passwords. When a user is not required to specify a password, he is
- authenticated as an anonymous user on the LDAP namespace, but as a named user
- on the Cognos namespace. Requiring passwords for authentication increases
- security and makes it more difficult to forge identities. By default, this
- property is set to false. -->
- <crn:parameter name="allowEmptyPswd">
- <crn:value xsi:type="xsd:boolean">false</crn:value>
- </crn:parameter>
- <!-- camidAttribute: Specifies the value used to uniquely identify objects stored
- in the LDAP directory server. -->
- <!-- Specify either an attribute name or the value of 'dn' to use as the unique
- identifier. If an attribute is used, it must exist for all objects, such as
- users, groups, folders. If the 'dn' is used, more resources are used as you
- search deeper in the LDAP directory server hierarchy and policies may be
- affected if the 'dn' is renamed. -->
- <crn:parameter name="camidAttribute">
- <crn:value xsi:type="xsd:string">ibm-entryuuid</crn:value>
- </crn:parameter>
- <!-- dataEncoding: Specifies the encoding of the data stored in the LDAP directory
- server. -->
- <!-- If this property is set to an encoding other than UTF-8, then the data is
- converted from UTF-8 to the encoding you specify. The encoding must follow IANA
- (RFC 1700) or MIME character set specifications. For example, use windows-1252,
- iso-8859-1, iso-8859-15, Shift_JIS, utf-16, or utf-8. -->
- <crn:parameter name="dataEncoding">
- <crn:value xsi:type="xsd:string">UTF-8</crn:value>
- </crn:parameter>
- <!-- sslCertificateDatabase: Specifies the location of the certificate database
- used by the directory server for SSL connections. -->
- <!-- Use this property to point to the location of the SSL certificate database for
- your LDAP server. -->
- <crn:parameter name="sslCertificateDatabase">
- <crn:value xsi:type="cfg:filePath">
- </crn:value>
- </crn:parameter>
- <!-- selectableForAuth: Specifies whether the namespace is selectable for
- authentication. -->
- <!-- If this property is set to true, the namespace will be available for
- authentication in the logon page namespace selection prompt. Set this value to
- false if the namespace should not be available for selection on the logon page.
- -->
- <crn:parameter name="selectableForAuth">
- <crn:value xsi:type="xsd:boolean">true</crn:value>
- </crn:parameter>
- <!-- advancedProperties: Specifies a set of advanced properties. -->
- <!-- The user needs to provide the name and the value for each advanced property. -->
- <crn:parameter name="advancedProperties">
- <crn:value xsi:type="cfg:array">
- </crn:value>
- </crn:parameter>
- <!-- tenantIdMapping: Specifies how namespace users are mapped to tenant IDs. -->
- <!-- Specifying a value for this parameter enables multitenancy. The tenant ID for
- a user can be determined using a pattern or a tenant provider class. The
- pattern is a AAA service search path to a property which defines a tenant ID.
- The search path must be relative to a user account. For example:
- '~/ancestors[2]/defaultName'. A tenant provider class is Java class which
- implements the the ITenantProvider interface. For more details please consult
- the installation and configuration guide. -->
- <crn:parameter name="tenantIdMapping">
- <crn:value xsi:type="cfg:tenancyInfo">pattern</crn:value>
- </crn:parameter>
- <!-- tenantBoundingSetMapping: Specifies how the tenant bounding set is determined
- for a user. -->
- <!-- This parameter is used when multitenancy is enabled. The tenant bounding set
- for a user can be determined using a pattern or a tenant bounding set provider
- class. The pattern is a AAA service search path to a property which defines a
- tenant bounding set. The search path must be relative to a user account. For
- example: '˜/parameters/boundingSet'. A tenant bounding set provider class is
- Java class which implements the the IBoundingSetProvider interface. For more
- details please consult the installation and configuration guide. -->
- <crn:parameter name="tenantBoundingSetMapping">
- <crn:value xsi:type="cfg:tenancyInfo">pattern</crn:value>
- </crn:parameter>
- <!-- folderObjectClass: Specifies the name of the LDAP object class used to
- identify a folder. -->
- <crn:parameter name="folderObjectClass">
- <crn:value xsi:type="xsd:string">organizationalunit,organization,container</crn:value>
- </crn:parameter>
- <!-- folderDescription: Specifies the LDAP attribute used for the "description"
- property of a folder. -->
- <crn:parameter name="folderDescription">
- <crn:value xsi:type="xsd:string">description</crn:value>
- </crn:parameter>
- <!-- folderName: Specifies the LDAP attribute used for the "name" property of a
- folder. -->
- <crn:parameter name="folderName">
- <crn:value xsi:type="xsd:string">ou,o,cn</crn:value>
- </crn:parameter>
- <!-- groupObjectClass: Specifies the name of the LDAP object class used to identify
- a group. -->
- <crn:parameter name="groupObjectClass">
- <crn:value xsi:type="xsd:string">groupofnames</crn:value>
- </crn:parameter>
- <!-- groupDescription: Specifies the LDAP attribute used for the "description"
- property of a group. -->
- <crn:parameter name="groupDescription">
- <crn:value xsi:type="xsd:string">description</crn:value>
- </crn:parameter>
- <!-- groupMembers: Specifies the LDAP attribute used to identify the members of a
- group. -->
- <crn:parameter name="groupMembers">
- <crn:value xsi:type="xsd:string">member</crn:value>
- </crn:parameter>
- <!-- groupName: Specifies the LDAP attribute used for the "name" property of a
- group. -->
- <crn:parameter name="groupName">
- <crn:value xsi:type="xsd:string">cn</crn:value>
- </crn:parameter>
- <!-- accountObjectClass: Specifies the name of the LDAP object class used to
- identify an account. -->
- <crn:parameter name="accountObjectClass">
- <crn:value xsi:type="xsd:string">inetOrgPerson</crn:value>
- </crn:parameter>
- <!-- accountBusinessPhone: Specifies the LDAP attribute used for the
- "businessPhone" property for an account. -->
- <crn:parameter name="accountBusinessPhone">
- <crn:value xsi:type="xsd:string">telephonenumber</crn:value>
- </crn:parameter>
- <!-- accountContentLocale: Specifies the LDAP attribute used for the
- "contentLocale" property for an account. -->
- <crn:parameter name="accountContentLocale">
- <crn:value xsi:type="xsd:string">preferredlanguage</crn:value>
- </crn:parameter>
- <!-- accountDescription: Specifies the LDAP attribute used for the "description"
- property for an account. -->
- <crn:parameter name="accountDescription">
- <crn:value xsi:type="xsd:string">description</crn:value>
- </crn:parameter>
- <!-- accountEmail: Specifies the LDAP attribute used for the "email" address of the
- account. -->
- <crn:parameter name="accountEmail">
- <crn:value xsi:type="xsd:string">mail</crn:value>
- </crn:parameter>
- <!-- accountFaxPhone: Specifies the LDAP attribute used for the "faxPhone" property
- for an account. -->
- <crn:parameter name="accountFaxPhone">
- <crn:value xsi:type="xsd:string">facsimiletelephonenumber</crn:value>
- </crn:parameter>
- <!-- accountGivenName: Specifies the LDAP attribute used for the "givenName"
- property for an account. -->
- <crn:parameter name="accountGivenName">
- <crn:value xsi:type="xsd:string">givenname</crn:value>
- </crn:parameter>
- <!-- accountHomePhone: Specifies the LDAP attribute used for the "homePhone"
- property for an account. -->
- <crn:parameter name="accountHomePhone">
- <crn:value xsi:type="xsd:string">homephone</crn:value>
- </crn:parameter>
- <!-- accountMobilePhone: Specifies the LDAP attribute used for the "mobilePhone"
- property for an account. -->
- <crn:parameter name="accountMobilePhone">
- <crn:value xsi:type="xsd:string">mobile</crn:value>
- </crn:parameter>
- <!-- accountName: Specifies the LDAP attribute used for the "name" property for an
- account. -->
- <crn:parameter name="accountName">
- <crn:value xsi:type="xsd:string">cn</crn:value>
- </crn:parameter>
- <!-- accountPagerPhone: Specifies the LDAP attribute used for the "pagerPhone"
- property for an account. -->
- <crn:parameter name="accountPagerPhone">
- <crn:value xsi:type="xsd:string">pager</crn:value>
- </crn:parameter>
- <!-- accountPassword: Specifies the LDAP attribute used for the "password" property
- for an account. -->
- <crn:parameter name="accountPassword">
- <crn:value xsi:type="xsd:string">userPassword</crn:value>
- </crn:parameter>
- <!-- accountPostalAddress: Specifies the LDAP attribute used for the
- "postalAddress" property for an account. -->
- <crn:parameter name="accountPostalAddress">
- <crn:value xsi:type="xsd:string">postaladdress</crn:value>
- </crn:parameter>
- <!-- accountProductLocale: Specifies the LDAP attribute used for the
- "productLocale" property for an account. -->
- <crn:parameter name="accountProductLocale">
- <crn:value xsi:type="xsd:string">preferredlanguage</crn:value>
- </crn:parameter>
- <!-- accountSurname: Specifies the LDAP attribute used for the "surname" property
- for an account. -->
- <crn:parameter name="accountSurname">
- <crn:value xsi:type="xsd:string">sn</crn:value>
- </crn:parameter>
- <!-- accountUserName: Specifies the LDAP attribute used for the "userName" property
- for an account. -->
- <crn:parameter name="accountUserName">
- <crn:value xsi:type="xsd:string">uid</crn:value>
- </crn:parameter>
- <!-- customProperties: Specifies a set of custom properties. -->
- <!-- Use this set of custom properties to define additional account information. -->
- <crn:parameter name="customProperties">
- <crn:value xsi:type="cfg:array">
- </crn:value>
- </crn:parameter>
- </crn:instance>
- <!--
- (End of) LDAP_IBM template
- ===============================================================================
- -->
- <!--
- ===============================================================================
- (Begin of) LDAP_SUNONE template
- -->
- <crn:instance name="LDAP_SUNONE Name" class="LDAP_SUNONE">
- <!-- id: Specifies a unique identifier for the authentication namespace. -->
- <!-- Use the namespace identifier to distinguish between multiple namespaces. Each
- namespace must have a unique identifier. When you select a namespace to use for
- authentication in the run-time environment, the identifier is used by the IBM
- Cognos components. Changing the namespace ID after the service has been started
- may invalidate the object security policies and the Cognos group and role
- memberships. The use of the colon in the Namespace ID is not supported. -->
- <crn:parameter name="id">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- connection: Specifies the host name and port of the directory server. -->
- <!-- Use the following syntax to specify the host name and port for the directory
- server: host:port; for example, localhost:389. Ensure that if you use a fully
- qualified name for your computer that your DNS is set up to resolve it.
- Otherwise, you can also use the IP address. -->
- <crn:parameter name="connection">
- <crn:value xsi:type="cfg:hostPort">
- </crn:value>
- </crn:parameter>
- <!-- baseDN: Specifies the base distinguished name of the LDAP server. -->
- <!-- The product uses the base DN to identify the top level of your directory
- server structure. The root of the hierarchal directory structure is the
- starting place for all searches. You restrict searches by specifying a base DN.
- -->
- <crn:parameter name="baseDN">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- userLookup: Specifies the user lookup used for binding to the LDAP directory
- server. -->
- <!-- Use this property to specify the string that is used to construct the fully
- qualified DN for authentication. All instances of '${userID}' in this string
- are replaced by the value typed in by the user at the logon prompt. If the
- string does not begin with an open parenthesis, the result of the substitution
- is assumed to be a DN which can be used for authentication. For example,
- 'uid=${userID},ou=people, base DN', where base DN is the Base Distinguished
- Name parameter value. If the value begins with an open parenthesis '(', the
- result of the substitution is assumed to be a search filter. Before binding,
- the provider uses the filter to get the DN for authentication. For example,
- '(userPrincipalName=${userID})'. A filter should be used if you have a
- hierarchical directory structure. -->
- <crn:parameter name="userLookup">
- <crn:value xsi:type="xsd:string">${userID}</crn:value>
- </crn:parameter>
- <!-- useExternalIdentity: Specifies whether to use the identity from an external
- source for user authentication. -->
- <!-- If this property is set to true, the user is authenticated by an external
- source and the user's identity is provided to the product from the external
- source. For example, if SSL is configured to use client certificates, the Web
- server sets the REMOTE_USER environment variable to the user's identity. If you
- set this property to true, ensure that you set the "External Identity Mapping"
- property. -->
- <crn:parameter name="useExternalIdentity">
- <crn:value xsi:type="xsd:boolean">false</crn:value>
- </crn:parameter>
- <!-- externalIdentityMapping: Specifies the mapping used to locate a user in the
- LDAP directory server. -->
- <!-- This property is used only if you enable the "Use External identity" property.
- This mapping is used to construct a DN or a search filter to locate a user in
- the LDAP directory server. All instances of
- '${environment("ENVIRONMENT_VARIABLE_NAME")' in this string are replaced by the
- value of the environment variable provided by the Web server. If the string
- does not begin with an open parenthesis, the result of the substitution is
- assumed to be the user's DN. For example,
- 'uid=${environment("REMOTE_USER")},ou=people, base DN', where base DN is the
- Base Distinguished Name parameter value. If the value begins with an open
- parenthesis '(', the result of the substitution is assumed to be a search
- filter. For example, '(userPrincipalName=${environment("REMOTE_USER")})'. Note
- that you must either enable anonymous access to the LDAP directory server or
- set the 'Bind user DN and password' property. -->
- <crn:parameter name="externalIdentityMapping">
- <crn:value xsi:type="xsd:string">${environment("REMOTE_USER")}</crn:value>
- </crn:parameter>
- <!-- bindCredentials: Specifies the credentials used for binding to the LDAP server
- when performing a search using the user lookup property, or when performing all
- operations using the external identity mapping. -->
- <!-- This value corresponds to an LDAP user who has read and search access to the
- user branch of the LDAP directory server. -->
- <crn:parameter name="bindCredentials">
- <crn:value xsi:type="cfg:credential" encrypted="false">
- <credential>
- <username>joe</username>
- <password>paranoid</password>
- </credential>
- </crn:value>
- </crn:parameter>
- <!-- sizeLimit: Specifies the maximum number of responses permitted for a search
- request. -->
- <!-- The value depends on your environment. As a general rule, the minimum value
- for this setting should be greater than the maximum number of groups or users
- plus 100. When the size limit is reached the directory server stops searching.
- The default value of -1 indicates that the value on the LDAP server will be
- used. -->
- <!-- Units: entries -->
- <crn:parameter name="sizeLimit">
- <crn:value xsi:type="xsd:int">-1</crn:value>
- </crn:parameter>
- <!-- timeOut: Specifies the number of seconds permitted to perform a search
- request. -->
- <!-- The product uses this value when it requests authentication from the namespace
- on your directory server. The value depends on your reporting environment. If
- the duration is exceeded, the search is timed out. The default value -1
- indicates that the value on the LDAP server will be used. -->
- <!-- Units: sec -->
- <crn:parameter name="timeOut">
- <crn:value xsi:type="xsd:int">-1</crn:value>
- </crn:parameter>
- <!-- useBindCredentialsForSearch: Specifies whether to use the bind credentials to
- perform a search. -->
- <!-- This property only affects users who don't use the external identity mapping.
- If this property is set to true, the bind credentials provided in the namespace
- configuration will be used to perform a search in the LDAP directory server. If
- this flag is false or bind credentials are not presented, the authenticated
- user credentials will be used for searching. -->
- <crn:parameter name="useBindCredentialsForSearch">
- <crn:value xsi:type="xsd:boolean">false</crn:value>
- </crn:parameter>
- <!-- allowEmptyPswd: Specifies whether empty passwords are allowed for user
- authentication. -->
- <!-- Set this property to true only if you specifically wish to allow empty
- passwords. When a user is not required to specify a password, he is
- authenticated as an anonymous user on the LDAP namespace, but as a named user
- on the Cognos namespace. Requiring passwords for authentication increases
- security and makes it more difficult to forge identities. By default, this
- property is set to false. -->
- <crn:parameter name="allowEmptyPswd">
- <crn:value xsi:type="xsd:boolean">false</crn:value>
- </crn:parameter>
- <!-- camidAttribute: Specifies the value used to uniquely identify objects stored
- in the LDAP directory server. -->
- <!-- Specify either an attribute name or the value of 'dn' to use as the unique
- identifier. If an attribute is used, it must exist for all objects, such as
- users, groups, folders. If the 'dn' is used, more resources are used as you
- search deeper in the LDAP directory server hierarchy and policies may be
- affected if the 'dn' is renamed. -->
- <crn:parameter name="camidAttribute">
- <crn:value xsi:type="xsd:string">nsuniqueid</crn:value>
- </crn:parameter>
- <!-- dataEncoding: Specifies the encoding of the data stored in the LDAP directory
- server. -->
- <!-- If this property is set to an encoding other than UTF-8, then the data is
- converted from UTF-8 to the encoding you specify. The encoding must follow IANA
- (RFC 1700) or MIME character set specifications. For example, use windows-1252,
- iso-8859-1, iso-8859-15, Shift_JIS, utf-16, or utf-8. -->
- <crn:parameter name="dataEncoding">
- <crn:value xsi:type="xsd:string">UTF-8</crn:value>
- </crn:parameter>
- <!-- sslCertificateDatabase: Specifies the location of the certificate database
- used by the directory server for SSL connections. -->
- <!-- Use this property to point to the location of the SSL certificate database for
- your LDAP server. -->
- <crn:parameter name="sslCertificateDatabase">
- <crn:value xsi:type="cfg:filePath">
- </crn:value>
- </crn:parameter>
- <!-- selectableForAuth: Specifies whether the namespace is selectable for
- authentication. -->
- <!-- If this property is set to true, the namespace will be available for
- authentication in the logon page namespace selection prompt. Set this value to
- false if the namespace should not be available for selection on the logon page.
- -->
- <crn:parameter name="selectableForAuth">
- <crn:value xsi:type="xsd:boolean">true</crn:value>
- </crn:parameter>
- <!-- advancedProperties: Specifies a set of advanced properties. -->
- <!-- The user needs to provide the name and the value for each advanced property. -->
- <crn:parameter name="advancedProperties">
- <crn:value xsi:type="cfg:array">
- </crn:value>
- </crn:parameter>
- <!-- tenantIdMapping: Specifies how namespace users are mapped to tenant IDs. -->
- <!-- Specifying a value for this parameter enables multitenancy. The tenant ID for
- a user can be determined using a pattern or a tenant provider class. The
- pattern is a AAA service search path to a property which defines a tenant ID.
- The search path must be relative to a user account. For example:
- '~/ancestors[2]/defaultName'. A tenant provider class is Java class which
- implements the the ITenantProvider interface. For more details please consult
- the installation and configuration guide. -->
- <crn:parameter name="tenantIdMapping">
- <crn:value xsi:type="cfg:tenancyInfo">pattern</crn:value>
- </crn:parameter>
- <!-- tenantBoundingSetMapping: Specifies how the tenant bounding set is determined
- for a user. -->
- <!-- This parameter is used when multitenancy is enabled. The tenant bounding set
- for a user can be determined using a pattern or a tenant bounding set provider
- class. The pattern is a AAA service search path to a property which defines a
- tenant bounding set. The search path must be relative to a user account. For
- example: '˜/parameters/boundingSet'. A tenant bounding set provider class is
- Java class which implements the the IBoundingSetProvider interface. For more
- details please consult the installation and configuration guide. -->
- <crn:parameter name="tenantBoundingSetMapping">
- <crn:value xsi:type="cfg:tenancyInfo">pattern</crn:value>
- </crn:parameter>
- <!-- folderObjectClass: Specifies the name of the LDAP object class used to
- identify a folder. -->
- <crn:parameter name="folderObjectClass">
- <crn:value xsi:type="xsd:string">organizationalUnit,organization</crn:value>
- </crn:parameter>
- <!-- folderDescription: Specifies the LDAP attribute used for the "description"
- property of a folder. -->
- <crn:parameter name="folderDescription">
- <crn:value xsi:type="xsd:string">description</crn:value>
- </crn:parameter>
- <!-- folderName: Specifies the LDAP attribute used for the "name" property of a
- folder. -->
- <crn:parameter name="folderName">
- <crn:value xsi:type="xsd:string">ou,o</crn:value>
- </crn:parameter>
- <!-- groupObjectClass: Specifies the name of the LDAP object class used to identify
- a group. -->
- <crn:parameter name="groupObjectClass">
- <crn:value xsi:type="xsd:string">groupofuniquenames</crn:value>
- </crn:parameter>
- <!-- groupDescription: Specifies the LDAP attribute used for the "description"
- property of a group. -->
- <crn:parameter name="groupDescription">
- <crn:value xsi:type="xsd:string">description</crn:value>
- </crn:parameter>
- <!-- groupMembers: Specifies the LDAP attribute used to identify the members of a
- group. -->
- <crn:parameter name="groupMembers">
- <crn:value xsi:type="xsd:string">uniquemember</crn:value>
- </crn:parameter>
- <!-- groupName: Specifies the LDAP attribute used for the "name" property of a
- group. -->
- <crn:parameter name="groupName">
- <crn:value xsi:type="xsd:string">cn</crn:value>
- </crn:parameter>
- <!-- accountObjectClass: Specifies the name of the LDAP object class used to
- identify an account. -->
- <crn:parameter name="accountObjectClass">
- <crn:value xsi:type="xsd:string">inetorgperson</crn:value>
- </crn:parameter>
- <!-- accountBusinessPhone: Specifies the LDAP attribute used for the
- "businessPhone" property for an account. -->
- <crn:parameter name="accountBusinessPhone">
- <crn:value xsi:type="xsd:string">telephonenumber</crn:value>
- </crn:parameter>
- <!-- accountContentLocale: Specifies the LDAP attribute used for the
- "contentLocale" property for an account. -->
- <crn:parameter name="accountContentLocale">
- <crn:value xsi:type="xsd:string">preferredlanguage</crn:value>
- </crn:parameter>
- <!-- accountDescription: Specifies the LDAP attribute used for the "description"
- property for an account. -->
- <crn:parameter name="accountDescription">
- <crn:value xsi:type="xsd:string">description</crn:value>
- </crn:parameter>
- <!-- accountEmail: Specifies the LDAP attribute used for the "email" address of the
- account. -->
- <crn:parameter name="accountEmail">
- <crn:value xsi:type="xsd:string">mail</crn:value>
- </crn:parameter>
- <!-- accountFaxPhone: Specifies the LDAP attribute used for the "faxPhone" property
- for an account. -->
- <crn:parameter name="accountFaxPhone">
- <crn:value xsi:type="xsd:string">facsimiletelephonenumber</crn:value>
- </crn:parameter>
- <!-- accountGivenName: Specifies the LDAP attribute used for the "givenName"
- property for an account. -->
- <crn:parameter name="accountGivenName">
- <crn:value xsi:type="xsd:string">givenname</crn:value>
- </crn:parameter>
- <!-- accountHomePhone: Specifies the LDAP attribute used for the "homePhone"
- property for an account. -->
- <crn:parameter name="accountHomePhone">
- <crn:value xsi:type="xsd:string">homephone</crn:value>
- </crn:parameter>
- <!-- accountMobilePhone: Specifies the LDAP attribute used for the "mobilePhone"
- property for an account. -->
- <crn:parameter name="accountMobilePhone">
- <crn:value xsi:type="xsd:string">mobile</crn:value>
- </crn:parameter>
- <!-- accountName: Specifies the LDAP attribute used for the "name" property for an
- account. -->
- <crn:parameter name="accountName">
- <crn:value xsi:type="xsd:string">cn</crn:value>
- </crn:parameter>
- <!-- accountPagerPhone: Specifies the LDAP attribute used for the "pagerPhone"
- property for an account. -->
- <crn:parameter name="accountPagerPhone">
- <crn:value xsi:type="xsd:string">pager</crn:value>
- </crn:parameter>
- <!-- accountPassword: Specifies the LDAP attribute used for the "password" property
- for an account. -->
- <crn:parameter name="accountPassword">
- <crn:value xsi:type="xsd:string">userPassword</crn:value>
- </crn:parameter>
- <!-- accountPostalAddress: Specifies the LDAP attribute used for the
- "postalAddress" property for an account. -->
- <crn:parameter name="accountPostalAddress">
- <crn:value xsi:type="xsd:string">postaladdress</crn:value>
- </crn:parameter>
- <!-- accountProductLocale: Specifies the LDAP attribute used for the
- "productLocale" property for an account. -->
- <crn:parameter name="accountProductLocale">
- <crn:value xsi:type="xsd:string">preferredlanguage</crn:value>
- </crn:parameter>
- <!-- accountSurname: Specifies the LDAP attribute used for the "surname" property
- for an account. -->
- <crn:parameter name="accountSurname">
- <crn:value xsi:type="xsd:string">sn</crn:value>
- </crn:parameter>
- <!-- accountUserName: Specifies the LDAP attribute used for the "userName" property
- for an account. -->
- <crn:parameter name="accountUserName">
- <crn:value xsi:type="xsd:string">uid</crn:value>
- </crn:parameter>
- <!-- customProperties: Specifies a set of custom properties. -->
- <!-- Use this set of custom properties to define additional account information. -->
- <crn:parameter name="customProperties">
- <crn:value xsi:type="cfg:array">
- </crn:value>
- </crn:parameter>
- </crn:instance>
- <!--
- (End of) LDAP_SUNONE template
- ===============================================================================
- -->
- <!--
- ===============================================================================
- (Begin of) OIDC_ADFS template
- -->
- <crn:instance name="OIDC_ADFS Name" class="OIDC_ADFS">
- <!-- identityProviderType: Specifies the implementation of an OpenID Connect
- identity provider. -->
- <crn:parameter name="identityProviderType">
- <crn:value xsi:type="xsd:string">ADFS</crn:value>
- </crn:parameter>
- <!-- id: Specifies a unique identifier for the authentication namespace. -->
- <!-- Use the namespace identifier to distinguish between multiple namespaces. Each
- namespace must have a unique identifier. When you select a namespace to use for
- authentication in the run-time environment, the identifier is used by the IBM
- Cognos components. Changing the namespace ID after the service has been started
- may invalidate the object security policies and the Cognos group and role
- memberships. The use of the colon in the Namespace ID is not supported. -->
- <crn:parameter name="id">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- oidcDiscEndpoint: Specifies the OpenID Connect discovery endpoint -->
- <!-- The discovery endpoint is used to retrieve the OpenID Connect configuration
- that includes the authorization endpoint, token endpoint, jwks endpoint, and
- issuer. -->
- <crn:parameter name="oidcDiscEndpoint">
- <crn:value xsi:type="cfg:anyPathURI">https://{hostname}:443/adfs/.well-known/openid-configuration</crn:value>
- </crn:parameter>
- <!-- clientId: Specifies the OpenID Connect client identifier -->
- <!-- The client identity that is assigned to the application by the OpenID Connect
- identity provider. -->
- <crn:parameter name="clientId">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- clientSecret: Specifies the client secret that is assigned to the application
- by the OpenID Connect identity provider. -->
- <!-- The client secret that is assigned to the application by the OpenID Connect
- identity provider. -->
- <crn:parameter name="clientSecret">
- <crn:value xsi:type="xsd:string" encrypted="false"/>
- </crn:parameter>
- <!-- returnUrl: Return URL that is configured with the OpenID Connect identity
- provider. -->
- <!-- The return URL is invoked by the OpenID Connect identity provider after
- successfully authenticating a user. The URL format is
- https://dispatcherHOST:dispatcherPORT/bi/completeAuth.jsp or
- https://webserverHOST:webserverPORT/ibmcognos/bi/completeAuth.jsp. This URL
- completes Cognos Analytics authentication using the OpenID Connect identity
- provider. -->
- <crn:parameter name="returnUrl">
- <crn:value xsi:type="cfg:anyPathURI">https://host:port/bi/completeAuth.jsp</crn:value>
- </crn:parameter>
- <!-- selectableForAuth: Specifies whether the namespace is selectable for
- authentication. -->
- <!-- If this property is set to true, the namespace will be available for
- authentication in the logon page namespace selection prompt. Set this value to
- false if the namespace should not be available for selection on the logon page.
- -->
- <crn:parameter name="selectableForAuth">
- <crn:value xsi:type="xsd:boolean">true</crn:value>
- </crn:parameter>
- <!-- advancedProperties: Specifies a set of advanced properties. -->
- <!-- The user needs to provide the name and the value for each advanced property. -->
- <crn:parameter name="advancedProperties">
- <crn:value xsi:type="cfg:array">
- </crn:value>
- </crn:parameter>
- <!-- accountCamidProperty: Specifies the value used to uniquely identify account
- objects. -->
- <!-- Specify either an existing Content Manager account object model property
- (e.g., email, username, defaultName, etc) or the name of a configured custom
- property. A claim must be returned for all accounts from the Identity Provider
- for either the Content Manager account object model property or the configured
- custom property. The value selected must be unique across all account objects.
- The value selected should be constant over time with a low probability of
- needing to be changed. NOTE: this value should not be changed after initial
- namespace configuration. -->
- <crn:parameter name="accountCamidProperty">
- <crn:value xsi:type="xsd:string">email</crn:value>
- </crn:parameter>
- <!-- customProperties: Specifies a set of custom properties. -->
- <!-- Use this set of custom properties to define additional account information.
- The "name" field corresponds to the property name set in the account while the
- "value" corresponds to the claim name in the id_token. -->
- <crn:parameter name="customProperties">
- <crn:value xsi:type="cfg:array">
- </crn:value>
- </crn:parameter>
- <!-- tenantIdMapping: Specifies how namespace users are mapped to tenant IDs. -->
- <!-- Specifying a value for this parameter enables multitenancy. The tenant ID for
- a user can be determined using a pattern or a tenant provider class. The
- pattern is a AAA service search path to a property which defines a tenant ID.
- The search path must be relative to a user account. For example:
- '~/ancestors[2]/defaultName'. A tenant provider class is Java class which
- implements the the ITenantProvider interface. For more details please consult
- the installation and configuration guide. -->
- <crn:parameter name="tenantIdMapping">
- <crn:value xsi:type="cfg:tenancyInfo">pattern</crn:value>
- </crn:parameter>
- <!-- tenantBoundingSetMapping: Specifies how the tenant bounding set is determined
- for a user. -->
- <!-- This parameter is used when multitenancy is enabled. The tenant bounding set
- for a user can be determined using a pattern or a tenant bounding set provider
- class. The pattern is a AAA service search path to a property which defines a
- tenant bounding set. The search path must be relative to a user account. For
- example: '˜/parameters/boundingSet'. A tenant bounding set provider class is
- Java class which implements the the IBoundingSetProvider interface. For more
- details please consult the installation and configuration guide. -->
- <crn:parameter name="tenantBoundingSetMapping">
- <crn:value xsi:type="cfg:tenancyInfo">pattern</crn:value>
- </crn:parameter>
- </crn:instance>
- <!--
- (End of) OIDC_ADFS template
- ===============================================================================
- -->
- <!--
- ===============================================================================
- (Begin of) OIDC_AzureAD template
- -->
- <crn:instance name="OIDC_AzureAD Name" class="OIDC_AzureAD">
- <!-- identityProviderType: Specifies the implementation of an OpenID Connect
- identity provider. -->
- <crn:parameter name="identityProviderType">
- <crn:value xsi:type="xsd:string">AzureAD</crn:value>
- </crn:parameter>
- <!-- id: Specifies a unique identifier for the authentication namespace. -->
- <!-- Use the namespace identifier to distinguish between multiple namespaces. Each
- namespace must have a unique identifier. When you select a namespace to use for
- authentication in the run-time environment, the identifier is used by the IBM
- Cognos components. Changing the namespace ID after the service has been started
- may invalidate the object security policies and the Cognos group and role
- memberships. The use of the colon in the Namespace ID is not supported. -->
- <crn:parameter name="id">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- oidcDiscEndpoint: Specifies the OpenID Connect discovery endpoint -->
- <!-- The discovery endpoint is used to retrieve the OpenID Connect configuration
- that includes the authorization endpoint, token endpoint, jwks endpoint, and
- issuer. -->
- <crn:parameter name="oidcDiscEndpoint">
- <crn:value xsi:type="cfg:anyPathURI">https://login.microsoftonline.com:443/{tenantid}/.well-known/openid-configuration</crn:value>
- </crn:parameter>
- <!-- clientId: Specifies the OpenID Connect client identifier -->
- <!-- The client identity that is assigned to the application by the OpenID Connect
- identity provider. -->
- <crn:parameter name="clientId">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- clientSecret: Specifies the client secret that is assigned to the application
- by the OpenID Connect identity provider. -->
- <!-- The client secret that is assigned to the application by the OpenID Connect
- identity provider. -->
- <crn:parameter name="clientSecret">
- <crn:value xsi:type="xsd:string" encrypted="false"/>
- </crn:parameter>
- <!-- returnUrl: Return URL that is configured with the OpenID Connect identity
- provider. -->
- <!-- The return URL is invoked by the OpenID Connect identity provider after
- successfully authenticating a user. The URL format is
- https://dispatcherHOST:dispatcherPORT/bi/completeAuth.jsp or
- https://webserverHOST:webserverPORT/ibmcognos/bi/completeAuth.jsp. This URL
- completes Cognos Analytics authentication using the OpenID Connect identity
- provider. -->
- <crn:parameter name="returnUrl">
- <crn:value xsi:type="cfg:anyPathURI">https://host:port/bi/completeAuth.jsp</crn:value>
- </crn:parameter>
- <!-- selectableForAuth: Specifies whether the namespace is selectable for
- authentication. -->
- <!-- If this property is set to true, the namespace will be available for
- authentication in the logon page namespace selection prompt. Set this value to
- false if the namespace should not be available for selection on the logon page.
- -->
- <crn:parameter name="selectableForAuth">
- <crn:value xsi:type="xsd:boolean">true</crn:value>
- </crn:parameter>
- <!-- advancedProperties: Specifies a set of advanced properties. -->
- <!-- The user needs to provide the name and the value for each advanced property. -->
- <crn:parameter name="advancedProperties">
- <crn:value xsi:type="cfg:array">
- </crn:value>
- </crn:parameter>
- <!-- accountCamidProperty: Specifies the value used to uniquely identify account
- objects. -->
- <!-- Specify either an existing Content Manager account object model property
- (e.g., email, username, defaultName, etc) or the name of a configured custom
- property. A claim must be returned for all accounts from the Identity Provider
- for either the Content Manager account object model property or the configured
- custom property. The value selected must be unique across all account objects.
- The value selected should be constant over time with a low probability of
- needing to be changed. NOTE: this value should not be changed after initial
- namespace configuration. -->
- <crn:parameter name="accountCamidProperty">
- <crn:value xsi:type="xsd:string">email</crn:value>
- </crn:parameter>
- <!-- customProperties: Specifies a set of custom properties. -->
- <!-- Use this set of custom properties to define additional account information.
- The "name" field corresponds to the property name set in the account while the
- "value" corresponds to the claim name in the id_token. -->
- <crn:parameter name="customProperties">
- <crn:value xsi:type="cfg:array">
- </crn:value>
- </crn:parameter>
- <!-- tenantIdMapping: Specifies how namespace users are mapped to tenant IDs. -->
- <!-- Specifying a value for this parameter enables multitenancy. The tenant ID for
- a user can be determined using a pattern or a tenant provider class. The
- pattern is a AAA service search path to a property which defines a tenant ID.
- The search path must be relative to a user account. For example:
- '~/ancestors[2]/defaultName'. A tenant provider class is Java class which
- implements the the ITenantProvider interface. For more details please consult
- the installation and configuration guide. -->
- <crn:parameter name="tenantIdMapping">
- <crn:value xsi:type="cfg:tenancyInfo">pattern</crn:value>
- </crn:parameter>
- <!-- tenantBoundingSetMapping: Specifies how the tenant bounding set is determined
- for a user. -->
- <!-- This parameter is used when multitenancy is enabled. The tenant bounding set
- for a user can be determined using a pattern or a tenant bounding set provider
- class. The pattern is a AAA service search path to a property which defines a
- tenant bounding set. The search path must be relative to a user account. For
- example: '˜/parameters/boundingSet'. A tenant bounding set provider class is
- Java class which implements the the IBoundingSetProvider interface. For more
- details please consult the installation and configuration guide. -->
- <crn:parameter name="tenantBoundingSetMapping">
- <crn:value xsi:type="cfg:tenancyInfo">pattern</crn:value>
- </crn:parameter>
- </crn:instance>
- <!--
- (End of) OIDC_AzureAD template
- ===============================================================================
- -->
- <!--
- ===============================================================================
- (Begin of) OIDC_BlueID template
- -->
- <crn:instance name="OIDC_BlueID Name" class="OIDC_BlueID">
- <!-- identityProviderType: Specifies the implementation of an OpenID Connect
- identity provider. -->
- <crn:parameter name="identityProviderType">
- <crn:value xsi:type="xsd:string">IBMid</crn:value>
- </crn:parameter>
- <!-- id: Specifies a unique identifier for the authentication namespace. -->
- <!-- Use the namespace identifier to distinguish between multiple namespaces. Each
- namespace must have a unique identifier. When you select a namespace to use for
- authentication in the run-time environment, the identifier is used by the IBM
- Cognos components. Changing the namespace ID after the service has been started
- may invalidate the object security policies and the Cognos group and role
- memberships. The use of the colon in the Namespace ID is not supported. -->
- <crn:parameter name="id">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- issuer: Specifies the OpenID claim issuer. -->
- <!-- A string that represents the identity provider that issued the claims in the
- ID token. This value must match the value of the 'iss' entry in the ID token
- JSON document. -->
- <crn:parameter name="issuer">
- <crn:value xsi:type="xsd:string">https://idaas.iam.ibm.com</crn:value>
- </crn:parameter>
- <!-- oidcTokenEndpoint: Specifies the OpenID Connect token endpoint -->
- <!-- The token endpoint is used to retrieve the identity token after a successful
- authentication to the OpenID Connect identity provider. -->
- <crn:parameter name="oidcTokenEndpoint">
- <crn:value xsi:type="cfg:anyPathURI">https://idaas.iam.ibm.com:443/idaas/oidc/endpoint/default/token</crn:value>
- </crn:parameter>
- <!-- oidcAuthEndpoint: Specifies the OpenID Connect authorization endpoint. -->
- <!-- The authorization endpoint is a URL that your OpenID Connect identity provider
- uses for authentication. In most cases, the URL should use the https scheme.
- The authorization endpoint is invoked when users authenticate to the OpenID
- Connect identity provider. -->
- <crn:parameter name="oidcAuthEndpoint">
- <crn:value xsi:type="cfg:anyPathURI">https://idaas.iam.ibm.com:443/idaas/oidc/endpoint/default/authorize</crn:value>
- </crn:parameter>
- <!-- clientId: Specifies the OpenID Connect client identifier -->
- <!-- The client identity that is assigned to the application by the OpenID Connect
- identity provider. -->
- <crn:parameter name="clientId">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- clientSecret: Specifies the client secret that is assigned to the application
- by the OpenID Connect identity provider. -->
- <!-- The client secret that is assigned to the application by the OpenID Connect
- identity provider. -->
- <crn:parameter name="clientSecret">
- <crn:value xsi:type="xsd:string" encrypted="false"/>
- </crn:parameter>
- <!-- idpCertificateFile: Specifies the location of the certificate that is used by
- the OpenID Connect identity provider to sign the identity token. -->
- <!-- A path to the file that contains the certificate used by the identity provider
- to sign the JSON Web Token. The path must include the certificate file name and
- be accessible to the running instance of Cognos Analytics. The certificate
- must be in a PEM format, include only the public key certificate, and include
- the begin and end certificate lines. The certificate file cannot be placed in
- the configuration/certs directory. -->
- <crn:parameter name="idpCertificateFile">
- <crn:value xsi:type="cfg:filePath">
- </crn:value>
- </crn:parameter>
- <!-- returnUrl: Return URL that is configured with the OpenID Connect identity
- provider. -->
- <!-- The return URL is invoked by the OpenID Connect identity provider after
- successfully authenticating a user. The URL format is
- https://dispatcherHOST:dispatcherPORT/bi/completeAuth.jsp or
- https://webserverHOST:webserverPORT/ibmcognos/bi/completeAuth.jsp. This URL
- completes Cognos Analytics authentication using the OpenID Connect identity
- provider. -->
- <crn:parameter name="returnUrl">
- <crn:value xsi:type="cfg:anyPathURI">https://host:port/bi/completeAuth.jsp</crn:value>
- </crn:parameter>
- <!-- selectableForAuth: Specifies whether the namespace is selectable for
- authentication. -->
- <!-- If this property is set to true, the namespace will be available for
- authentication in the logon page namespace selection prompt. Set this value to
- false if the namespace should not be available for selection on the logon page.
- -->
- <crn:parameter name="selectableForAuth">
- <crn:value xsi:type="xsd:boolean">true</crn:value>
- </crn:parameter>
- <!-- advancedProperties: Specifies a set of advanced properties. -->
- <!-- The user needs to provide the name and the value for each advanced property. -->
- <crn:parameter name="advancedProperties">
- <crn:value xsi:type="cfg:array">
- </crn:value>
- </crn:parameter>
- <!-- accountCamidProperty: Specifies the value used to uniquely identify account
- objects. -->
- <!-- Specify either an existing Content Manager account object model property
- (e.g., email, username, defaultName, etc) or the name of a configured custom
- property. A claim must be returned for all accounts from the Identity Provider
- for either the Content Manager account object model property or the configured
- custom property. The value selected must be unique across all account objects.
- The value selected should be constant over time with a low probability of
- needing to be changed. NOTE: this value should not be changed after initial
- namespace configuration. -->
- <crn:parameter name="accountCamidProperty">
- <crn:value xsi:type="xsd:string">email</crn:value>
- </crn:parameter>
- <!-- customProperties: Specifies a set of custom properties. -->
- <!-- Use this set of custom properties to define additional account information.
- The "name" field corresponds to the property name set in the account while the
- "value" corresponds to the claim name in the id_token. -->
- <crn:parameter name="customProperties">
- <crn:value xsi:type="cfg:array">
- </crn:value>
- </crn:parameter>
- <!-- tenantIdMapping: Specifies how namespace users are mapped to tenant IDs. -->
- <!-- Specifying a value for this parameter enables multitenancy. The tenant ID for
- a user can be determined using a pattern or a tenant provider class. The
- pattern is a AAA service search path to a property which defines a tenant ID.
- The search path must be relative to a user account. For example:
- '~/ancestors[2]/defaultName'. A tenant provider class is Java class which
- implements the the ITenantProvider interface. For more details please consult
- the installation and configuration guide. -->
- <crn:parameter name="tenantIdMapping">
- <crn:value xsi:type="cfg:tenancyInfo">pattern</crn:value>
- </crn:parameter>
- <!-- tenantBoundingSetMapping: Specifies how the tenant bounding set is determined
- for a user. -->
- <!-- This parameter is used when multitenancy is enabled. The tenant bounding set
- for a user can be determined using a pattern or a tenant bounding set provider
- class. The pattern is a AAA service search path to a property which defines a
- tenant bounding set. The search path must be relative to a user account. For
- example: '˜/parameters/boundingSet'. A tenant bounding set provider class is
- Java class which implements the the IBoundingSetProvider interface. For more
- details please consult the installation and configuration guide. -->
- <crn:parameter name="tenantBoundingSetMapping">
- <crn:value xsi:type="cfg:tenancyInfo">pattern</crn:value>
- </crn:parameter>
- </crn:instance>
- <!--
- (End of) OIDC_BlueID template
- ===============================================================================
- -->
- <!--
- ===============================================================================
- (Begin of) OIDC_Generic template
- -->
- <crn:instance name="OIDC_Generic Name" class="OIDC_Generic">
- <!-- identityProviderType: Specifies the implementation of an OpenID Connect
- identity provider. -->
- <crn:parameter name="identityProviderType">
- <crn:value xsi:type="xsd:string">Generic</crn:value>
- </crn:parameter>
- <!-- id: Specifies a unique identifier for the authentication namespace. -->
- <!-- Use the namespace identifier to distinguish between multiple namespaces. Each
- namespace must have a unique identifier. When you select a namespace to use for
- authentication in the run-time environment, the identifier is used by the IBM
- Cognos components. Changing the namespace ID after the service has been started
- may invalidate the object security policies and the Cognos group and role
- memberships. The use of the colon in the Namespace ID is not supported. -->
- <crn:parameter name="id">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- selectableForAuth: Specifies whether the namespace is selectable for
- authentication. -->
- <!-- If this property is set to true, the namespace will be available for
- authentication in the logon page namespace selection prompt. Set this value to
- false if the namespace should not be available for selection on the logon page.
- -->
- <crn:parameter name="selectableForAuth">
- <crn:value xsi:type="xsd:boolean">true</crn:value>
- </crn:parameter>
- <!-- advancedProperties: Specifies a set of advanced properties. -->
- <!-- The user needs to provide the name and the value for each advanced property. -->
- <crn:parameter name="advancedProperties">
- <crn:value xsi:type="cfg:array">
- </crn:value>
- </crn:parameter>
- <!-- useDiscoveryEndpoint: Specifies whether the Identity Provider returns a
- discovery document. -->
- <!-- Set this value to true if the Identity Provider supports a discovery document
- endpoint and fill out the discovery endpoint configuration group. Set this
- value to false if the Identity Provider does not support a discovery document
- endpoint and fill out the non-discovery endpoint configuration group. -->
- <crn:parameter name="useDiscoveryEndpoint">
- <crn:value xsi:type="xsd:boolean">true</crn:value>
- </crn:parameter>
- <!-- oidcDiscEndpoint: Specifies the OpenID Connect discovery endpoint -->
- <!-- The discovery endpoint is used to retrieve the OpenID Connect configuration
- that includes the authorization endpoint, token endpoint, jwks endpoint, and
- issuer. -->
- <crn:parameter name="oidcDiscEndpoint">
- <crn:value xsi:type="cfg:anyPathURI">
- </crn:value>
- </crn:parameter>
- <!-- issuer: Specifies the OpenID claim issuer. -->
- <!-- A string that represents the identity provider that issued the claims in the
- ID token. This value must match the value of the 'iss' entry in the ID token
- JSON document. -->
- <crn:parameter name="issuer">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- oidcTokenEndpoint: Specifies the OpenID Connect token endpoint, using the
- following syntax: https://<hostname:port>/<path> -->
- <!-- The token endpoint is used to retrieve the identity token after a successful
- authentication to the OpenID Connect identity provider. -->
- <crn:parameter name="oidcTokenEndpoint">
- <crn:value xsi:type="cfg:anyPathURI">
- </crn:value>
- </crn:parameter>
- <!-- oidcAuthEndpoint: Specifies the OpenID Connect authorization endpoint, using
- the following syntax: https://<hostname:port>/<path> -->
- <!-- The authorization endpoint is a URL that your OpenID Connect identity provider
- uses for authentication. In most cases, the URL should use the https scheme.
- The authorization endpoint is invoked when users authenticate to the OpenID
- Connect identity provider. -->
- <crn:parameter name="oidcAuthEndpoint">
- <crn:value xsi:type="cfg:anyPathURI">
- </crn:value>
- </crn:parameter>
- <!-- clientId: Specifies the OpenID Connect client identifier -->
- <!-- The client identity that is assigned to the application by the OpenID Connect
- identity provider. -->
- <crn:parameter name="clientId">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- returnUrl: Return URL that is configured with the OpenID Connect identity
- provider. -->
- <!-- The return URL is invoked by the OpenID Connect identity provider after
- successfully authenticating a user. The URL format is
- https://dispatcherHOST:dispatcherPORT/bi/completeAuth.jsp or
- https://webserverHOST:webserverPORT/ibmcognos/bi/completeAuth.jsp. This URL
- completes Cognos Analytics authentication using the OpenID Connect identity
- provider. -->
- <crn:parameter name="returnUrl">
- <crn:value xsi:type="cfg:anyPathURI">https://host:port/bi/completeAuth.jsp</crn:value>
- </crn:parameter>
- <!-- authScope: Specifies the scope parameter values provided to the authorize
- endpoint. -->
- <!-- The scope parameter values that will be added to the authorize endpoint URL
- for authentication. At a minimum, 'openid' must be included in the list of
- possible scope values. -->
- <crn:parameter name="authScope">
- <crn:value xsi:type="xsd:string">openid</crn:value>
- </crn:parameter>
- <!-- accountClaims: Specifies if the id_token contains all of the account claims. -->
- <!-- Set this value to token if the id_token contains all of the user claims. Set
- this value to userinfo if an additional call should be made to the userinfo
- endpoint in order to retrieve any user claims that are not part of the
- id_token. -->
- <crn:parameter name="accountClaims">
- <crn:value xsi:type="xsd:string">token</crn:value>
- </crn:parameter>
- <!-- tokenEndpointAuth: Specifies how to authenticate to the Identity Provider when
- invoking the token endpoint. -->
- <!-- Use client secret post if the client id and client secret should be
- transmitted in the request body. Use client secret basic if the client id and
- client secret should be transmitted in the HTTP header. Use private key JWT if
- the client id and a JWT client_assertion that is signed with a private key
- should be transmitted in the request body. -->
- <crn:parameter name="tokenEndpointAuth">
- <crn:value xsi:type="xsd:string">client_secret_post</crn:value>
- </crn:parameter>
- <!-- clientSecret: Specifies the client secret that is assigned to the application
- by the OpenID Connect identity provider. -->
- <!-- The client secret that is assigned to the application by the OpenID Connect
- identity provider. -->
- <crn:parameter name="clientSecret">
- <crn:value xsi:type="xsd:string" encrypted="false"/>
- </crn:parameter>
- <!-- privateKeyFile: Specifies the file that contains the private signing key. -->
- <!-- The file that contains the private signing key in PKCS8 format. It must
- contain a single private RSA key of length 2048 bits. -->
- <crn:parameter name="privateKeyFile">
- <crn:value xsi:type="cfg:filePath">
- </crn:value>
- </crn:parameter>
- <!-- privateKeyPassword: Specifies the private key password used to protect the
- private signing key. -->
- <!-- This password is required to secure the private key. It provides an extra
- layer of security by encrypted the private key file using a password. -->
- <crn:parameter name="privateKeyPassword">
- <crn:value xsi:type="xsd:string" encrypted="false"/>
- </crn:parameter>
- <!-- privateKeyId: Specifies the key identifier that should be placed in the JWT
- header. -->
- <!-- The key identifier that will be set in the JWT 'kid' header. Use this
- configuration item if your identity provider requires a 'kid'. Leave this value
- blank if your identity provider does not require a 'kid'. -->
- <crn:parameter name="privateKeyId">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- keyLocation: Specifies the location of the signing public key or certificate. -->
- <!-- Set this value to 'File' if the signing certificate is manually downloaded
- from the Identity Provider as a certificate and placed on the file system. Set
- this value to 'JWKS endpoint' if the Identity Provider supports an endpoint for
- retrieving id_token signature keys. Note: if the Identity Provider does not
- support a discovery document but provides public keys via a JWKS endpoint, then
- the JWKS Endpoint must contain a valid URI for retrieving the public keys. -->
- <crn:parameter name="keyLocation">
- <crn:value xsi:type="xsd:string">jwks_uri</crn:value>
- </crn:parameter>
- <!-- idpCertificateFile: Specifies the location of the certificate that is used by
- the OpenID Connect identity provider to sign the identity token. -->
- <!-- A path to the file that contains the certificate used by the identity provider
- to sign the JSON Web Token. The path must include the certificate file name and
- be accessible to the running instance of Cognos Analytics. The certificate
- must be in a PEM format, include only the public key certificate, and include
- the begin and end certificate lines. The certificate file cannot be placed in
- the configuration/certs directory. -->
- <crn:parameter name="idpCertificateFile">
- <crn:value xsi:type="cfg:filePath">
- </crn:value>
- </crn:parameter>
- <!-- jwksEndpoint: Specifies the OpenID Connect endpoint for retrieving JWT signing
- keys. -->
- <!-- The JWKS endpoint is a URL that your OpenID Connect identity provider uses to
- provide signing key data. In most cases, the URL should use the https scheme.
- The JWKS endpoint is invoked when validating an id_token returned from the
- identity provider. -->
- <crn:parameter name="jwksEndpoint">
- <crn:value xsi:type="cfg:anyPathURI">
- </crn:value>
- </crn:parameter>
- <!-- pgStrategy: Specifies how to get the user's identity when using the password
- grant flow. -->
- <!-- Set this value to 'ID token' if all user claims are returned in the id_token.
- Set this value to 'ID token and userinfo endpoint' if an id_token is returned
- from the password grant flow but does not contain all of the user claims. Set
- this value to 'Userinfo endpoint' if the id_token does not contain any user
- claims and if the user claims should be retrieved from the userinfo endpoint.
- Set this value to 'Unsupported' if the Identity Provider does not support the
- password grant flow. -->
- <crn:parameter name="pgStrategy">
- <crn:value xsi:type="xsd:string">idToken</crn:value>
- </crn:parameter>
- <!-- pgInclScope: Specifies that the scope should be included when using the
- password grant flow. -->
- <!-- Set this value to true to indicate that the scope parameter should be included
- as part of the query string for the password grant flow. Set this value to
- false to indicate that the scope should be omitted from the query string for
- the password grant flow. -->
- <crn:parameter name="pgInclScope">
- <crn:value xsi:type="xsd:boolean">true</crn:value>
- </crn:parameter>
- <!-- pgAddParams: Specifies any additional parameters that are required for the
- password grant flow. -->
- <!-- Set this value to reflect any additional parameters that should be included as
- part of the query string for the password grant flow. The parameter must begin
- with an '&&' and must be urlencoded so that it can be safely inserted into the
- query string. For example, if the 'resource=https://ca.ibm.com' parameter is
- required in the query string, it must be entered as:
- '&resource=https%3A%2F%2Fca.ibm.com'. -->
- <crn:parameter name="pgAddParams">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- tcStrategy: Specifies the information that should be stored for scheduling
- jobs. -->
- <!-- Set this value to 'Credentials' if the Identity Provider supports the password
- grant and returns a valid id_token that contains all of the user claims in the
- response. Set this value to 'Credentials and ID token' if the Identity Provider
- supports the password grant flow but does not return a valid id_token in the
- response or if the id_token does not contain all of the user claims. Set this
- value to 'Refresh token' if the Identity Provider supports the refresh token
- flow, provides a non-expiring refresh token, and returns a valid id_token that
- contains all of the user claims from the refresh token flow. Set this value to
- 'ID token only' if the Identity Provider does not support the password grant
- nor refresh token flows (Note: when set to 'ID token only', it will not be
- possible to verify that the user is still exists and is enabled in the Identity
- Provider). -->
- <crn:parameter name="tcStrategy">
- <crn:value xsi:type="xsd:string">credentials</crn:value>
- </crn:parameter>
- <!-- tcAccountClaims: Specifies if the id_token contains all of the account claims.
- -->
- <!-- Set this value to 'ID token' if the id_token returned from the token endpoint
- contains all of the user claims. Set this value to 'Userinfo endpoint' if an
- additional call to the userinfo endpoint is required in order to obtain all of
- the user claims. -->
- <crn:parameter name="tcAccountClaims">
- <crn:value xsi:type="xsd:string">id_token</crn:value>
- </crn:parameter>
- <!-- tenantIdMapping: Specifies how namespace users are mapped to tenant IDs. -->
- <!-- Specifying a value for this parameter enables multitenancy. The tenant ID for
- a user can be determined using a pattern or a tenant provider class. The
- pattern is a AAA service search path to a property which defines a tenant ID.
- The search path must be relative to a user account. For example:
- '~/ancestors[2]/defaultName'. A tenant provider class is Java class which
- implements the the ITenantProvider interface. For more details please consult
- the installation and configuration guide. -->
- <crn:parameter name="tenantIdMapping">
- <crn:value xsi:type="cfg:tenancyInfo">pattern</crn:value>
- </crn:parameter>
- <!-- tenantBoundingSetMapping: Specifies how the tenant bounding set is determined
- for a user. -->
- <!-- This parameter is used when multitenancy is enabled. The tenant bounding set
- for a user can be determined using a pattern or a tenant bounding set provider
- class. The pattern is a AAA service search path to a property which defines a
- tenant bounding set. The search path must be relative to a user account. For
- example: '˜/parameters/boundingSet'. A tenant bounding set provider class is
- Java class which implements the the IBoundingSetProvider interface. For more
- details please consult the installation and configuration guide. -->
- <crn:parameter name="tenantBoundingSetMapping">
- <crn:value xsi:type="cfg:tenancyInfo">pattern</crn:value>
- </crn:parameter>
- <!-- accountCamidProperty: Specifies the value used to uniquely identify account
- objects. -->
- <!-- Specify either an existing Content Manager account object model property
- (e.g., email, username, defaultName, etc) or the name of a configured custom
- property. A claim must be returned for all accounts from the Identity Provider
- for either the Content Manager account object model property or the configured
- custom property. The value selected must be unique across all account objects.
- The value selected should be constant over time with a low probability of
- needing to be changed. NOTE: this value should not be changed after initial
- namespace configuration. -->
- <crn:parameter name="accountCamidProperty">
- <crn:value xsi:type="xsd:string">email</crn:value>
- </crn:parameter>
- <!-- acEncoding: Specifies if the claims in the id_token are URL encoded. -->
- <!-- Set this value to URL encoded if the claims in the id_token are URL encoded.
- Set this value to Not encoded if the claims in the id_token are not encoded. -->
- <crn:parameter name="acEncoding">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- acBusinessPhone: Specifies the OIDC claim used for the "businessPhone"
- property for an account. -->
- <crn:parameter name="acBusinessPhone">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- acContentLocale: Specifies the OIDC claim used for the "contentLocale"
- property for an account. -->
- <crn:parameter name="acContentLocale">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- acDescription: Specifies the OIDC claim used for the "description" property
- for an account. -->
- <crn:parameter name="acDescription">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- acEmail: Specifies the OIDC claim used for the "email" property for an
- account. -->
- <crn:parameter name="acEmail">
- <crn:value xsi:type="xsd:string">email</crn:value>
- </crn:parameter>
- <!-- acFaxPhone: Specifies the OIDC claim used for the "faxPhone" property for an
- account. -->
- <crn:parameter name="acFaxPhone">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- acGivenName: Specifies the OIDC claim used for the "givenName" property for an
- account. -->
- <crn:parameter name="acGivenName">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- acHomePhone: Specifies the OIDC claim used for the "homePhone" property for an
- account. -->
- <crn:parameter name="acHomePhone">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- acMemberOf: Specifies the OIDC claim used for the "memberOf" property for an
- account. -->
- <crn:parameter name="acMemberOf">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- acMobilePhone: Specifies the OIDC claim used for the "mobilePhone" property
- for an account. -->
- <crn:parameter name="acMobilePhone">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- acName: Specifies the OIDC claim used for the "name" property for an account. -->
- <crn:parameter name="acName">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- acPagerPhone: Specifies the OIDC claim used for the "pagerPhone" property for
- an account. -->
- <crn:parameter name="acPagerPhone">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- acPostalAddr: Specifies the OIDC claim used for the "postalAddress" property
- for an account. -->
- <crn:parameter name="acPostalAddr">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- acProductLocale: Specifies the OIDC claim used for the "productLocale"
- property for an account. -->
- <crn:parameter name="acProductLocale">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- acSurname: Specifies the OIDC claim used for the "surname" property for an
- account. -->
- <crn:parameter name="acSurname">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- acUsername: Specifies the OIDC claim used for the "userName" property for an
- account. -->
- <crn:parameter name="acUsername">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- customProperties: Specifies a set of custom properties. -->
- <!-- Use this set of custom properties to define additional account information.
- The "name" field corresponds to the property name set in the account while the
- "value" corresponds to the claim name in the id_token. -->
- <crn:parameter name="customProperties">
- <crn:value xsi:type="cfg:array">
- </crn:value>
- </crn:parameter>
- </crn:instance>
- <!--
- (End of) OIDC_Generic template
- ===============================================================================
- -->
- <!--
- ===============================================================================
- (Begin of) OIDC_Google template
- -->
- <crn:instance name="OIDC_Google Name" class="OIDC_Google">
- <!-- identityProviderType: Specifies the implementation of an OpenID Connect
- identity provider. -->
- <crn:parameter name="identityProviderType">
- <crn:value xsi:type="xsd:string">Google</crn:value>
- </crn:parameter>
- <!-- id: Specifies a unique identifier for the authentication namespace. -->
- <!-- Use the namespace identifier to distinguish between multiple namespaces. Each
- namespace must have a unique identifier. When you select a namespace to use for
- authentication in the run-time environment, the identifier is used by the IBM
- Cognos components. Changing the namespace ID after the service has been started
- may invalidate the object security policies and the Cognos group and role
- memberships. The use of the colon in the Namespace ID is not supported. -->
- <crn:parameter name="id">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- oidcDiscEndpoint: Specifies the OpenID Connect discovery endpoint -->
- <!-- The discovery endpoint is used to retrieve the OpenID Connect configuration
- that includes the authorization endpoint, token endpoint, jwks endpoint, and
- issuer. -->
- <crn:parameter name="oidcDiscEndpoint">
- <crn:value xsi:type="cfg:anyPathURI">https://accounts.google.com:443/.well-known/openid-configuration</crn:value>
- </crn:parameter>
- <!-- clientId: Specifies the OpenID Connect client identifier -->
- <!-- The client identity that is assigned to the application by the OpenID Connect
- identity provider. -->
- <crn:parameter name="clientId">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- clientSecret: Specifies the client secret that is assigned to the application
- by the OpenID Connect identity provider. -->
- <!-- The client secret that is assigned to the application by the OpenID Connect
- identity provider. -->
- <crn:parameter name="clientSecret">
- <crn:value xsi:type="xsd:string" encrypted="false"/>
- </crn:parameter>
- <!-- returnUrl: Return URL that is configured with the OpenID Connect identity
- provider. -->
- <!-- The return URL is invoked by the OpenID Connect identity provider after
- successfully authenticating a user. The URL format is
- https://dispatcherHOST:dispatcherPORT/bi/completeAuth.jsp or
- https://webserverHOST:webserverPORT/ibmcognos/bi/completeAuth.jsp. This URL
- completes Cognos Analytics authentication using the OpenID Connect identity
- provider. -->
- <crn:parameter name="returnUrl">
- <crn:value xsi:type="cfg:anyPathURI">https://host:port/bi/completeAuth.jsp</crn:value>
- </crn:parameter>
- <!-- selectableForAuth: Specifies whether the namespace is selectable for
- authentication. -->
- <!-- If this property is set to true, the namespace will be available for
- authentication in the logon page namespace selection prompt. Set this value to
- false if the namespace should not be available for selection on the logon page.
- -->
- <crn:parameter name="selectableForAuth">
- <crn:value xsi:type="xsd:boolean">true</crn:value>
- </crn:parameter>
- <!-- advancedProperties: Specifies a set of advanced properties. -->
- <!-- The user needs to provide the name and the value for each advanced property. -->
- <crn:parameter name="advancedProperties">
- <crn:value xsi:type="cfg:array">
- </crn:value>
- </crn:parameter>
- <!-- accountCamidProperty: Specifies the value used to uniquely identify account
- objects. -->
- <!-- Specify either an existing Content Manager account object model property
- (e.g., email, username, defaultName, etc) or the name of a configured custom
- property. A claim must be returned for all accounts from the Identity Provider
- for either the Content Manager account object model property or the configured
- custom property. The value selected must be unique across all account objects.
- The value selected should be constant over time with a low probability of
- needing to be changed. NOTE: this value should not be changed after initial
- namespace configuration. -->
- <crn:parameter name="accountCamidProperty">
- <crn:value xsi:type="xsd:string">email</crn:value>
- </crn:parameter>
- <!-- customProperties: Specifies a set of custom properties. -->
- <!-- Use this set of custom properties to define additional account information.
- The "name" field corresponds to the property name set in the account while the
- "value" corresponds to the claim name in the id_token. -->
- <crn:parameter name="customProperties">
- <crn:value xsi:type="cfg:array">
- </crn:value>
- </crn:parameter>
- <!-- tenantIdMapping: Specifies how namespace users are mapped to tenant IDs. -->
- <!-- Specifying a value for this parameter enables multitenancy. The tenant ID for
- a user can be determined using a pattern or a tenant provider class. The
- pattern is a AAA service search path to a property which defines a tenant ID.
- The search path must be relative to a user account. For example:
- '~/ancestors[2]/defaultName'. A tenant provider class is Java class which
- implements the the ITenantProvider interface. For more details please consult
- the installation and configuration guide. -->
- <crn:parameter name="tenantIdMapping">
- <crn:value xsi:type="cfg:tenancyInfo">pattern</crn:value>
- </crn:parameter>
- <!-- tenantBoundingSetMapping: Specifies how the tenant bounding set is determined
- for a user. -->
- <!-- This parameter is used when multitenancy is enabled. The tenant bounding set
- for a user can be determined using a pattern or a tenant bounding set provider
- class. The pattern is a AAA service search path to a property which defines a
- tenant bounding set. The search path must be relative to a user account. For
- example: '˜/parameters/boundingSet'. A tenant bounding set provider class is
- Java class which implements the the IBoundingSetProvider interface. For more
- details please consult the installation and configuration guide. -->
- <crn:parameter name="tenantBoundingSetMapping">
- <crn:value xsi:type="cfg:tenancyInfo">pattern</crn:value>
- </crn:parameter>
- </crn:instance>
- <!--
- (End of) OIDC_Google template
- ===============================================================================
- -->
- <!--
- ===============================================================================
- (Begin of) OIDC_IBMCloudId template
- -->
- <crn:instance name="OIDC_IBMCloudId Name" class="OIDC_IBMCloudId">
- <!-- identityProviderType: Specifies the implementation of an OpenID Connect
- identity provider. -->
- <crn:parameter name="identityProviderType">
- <crn:value xsi:type="xsd:string">IBMCloudId</crn:value>
- </crn:parameter>
- <!-- id: Specifies a unique identifier for the authentication namespace. -->
- <!-- Use the namespace identifier to distinguish between multiple namespaces. Each
- namespace must have a unique identifier. When you select a namespace to use for
- authentication in the run-time environment, the identifier is used by the IBM
- Cognos components. Changing the namespace ID after the service has been started
- may invalidate the object security policies and the Cognos group and role
- memberships. The use of the colon in the Namespace ID is not supported. -->
- <crn:parameter name="id">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- oidcDiscEndpoint: Specifies the OpenID Connect discovery endpoint -->
- <!-- The discovery endpoint is used to retrieve the OpenID Connect configuration
- that includes the authorization endpoint, token endpoint, jwks endpoint, and
- issuer. -->
- <crn:parameter name="oidcDiscEndpoint">
- <crn:value xsi:type="cfg:anyPathURI">https://login.ibm.com:443/oidc/endpoint/default/.well-known/openid-configuration</crn:value>
- </crn:parameter>
- <!-- clientId: Specifies the OpenID Connect client identifier -->
- <!-- The client identity that is assigned to the application by the OpenID Connect
- identity provider. -->
- <crn:parameter name="clientId">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- clientSecret: Specifies the client secret that is assigned to the application
- by the OpenID Connect identity provider. -->
- <!-- The client secret that is assigned to the application by the OpenID Connect
- identity provider. -->
- <crn:parameter name="clientSecret">
- <crn:value xsi:type="xsd:string" encrypted="false"/>
- </crn:parameter>
- <!-- returnUrl: Return URL that is configured with the OpenID Connect identity
- provider. -->
- <!-- The return URL is invoked by the OpenID Connect identity provider after
- successfully authenticating a user. The URL format is
- https://dispatcherHOST:dispatcherPORT/bi/completeAuth.jsp or
- https://webserverHOST:webserverPORT/ibmcognos/bi/completeAuth.jsp. This URL
- completes Cognos Analytics authentication using the OpenID Connect identity
- provider. -->
- <crn:parameter name="returnUrl">
- <crn:value xsi:type="cfg:anyPathURI">https://host:port/bi/completeAuth.jsp</crn:value>
- </crn:parameter>
- <!-- selectableForAuth: Specifies whether the namespace is selectable for
- authentication. -->
- <!-- If this property is set to true, the namespace will be available for
- authentication in the logon page namespace selection prompt. Set this value to
- false if the namespace should not be available for selection on the logon page.
- -->
- <crn:parameter name="selectableForAuth">
- <crn:value xsi:type="xsd:boolean">true</crn:value>
- </crn:parameter>
- <!-- advancedProperties: Specifies a set of advanced properties. -->
- <!-- The user needs to provide the name and the value for each advanced property. -->
- <crn:parameter name="advancedProperties">
- <crn:value xsi:type="cfg:array">
- </crn:value>
- </crn:parameter>
- <!-- accountCamidProperty: Specifies the value used to uniquely identify account
- objects. -->
- <!-- Specify either an existing Content Manager account object model property
- (e.g., email, username, defaultName, etc) or the name of a configured custom
- property. A claim must be returned for all accounts from the Identity Provider
- for either the Content Manager account object model property or the configured
- custom property. The value selected must be unique across all account objects.
- The value selected should be constant over time with a low probability of
- needing to be changed. NOTE: this value should not be changed after initial
- namespace configuration. -->
- <crn:parameter name="accountCamidProperty">
- <crn:value xsi:type="xsd:string">email</crn:value>
- </crn:parameter>
- <!-- customProperties: Specifies a set of custom properties. -->
- <!-- Use this set of custom properties to define additional account information.
- The "name" field corresponds to the property name set in the account while the
- "value" corresponds to the claim name in the id_token. -->
- <crn:parameter name="customProperties">
- <crn:value xsi:type="cfg:array">
- </crn:value>
- </crn:parameter>
- <!-- tenantIdMapping: Specifies how namespace users are mapped to tenant IDs. -->
- <!-- Specifying a value for this parameter enables multitenancy. The tenant ID for
- a user can be determined using a pattern or a tenant provider class. The
- pattern is a AAA service search path to a property which defines a tenant ID.
- The search path must be relative to a user account. For example:
- '~/ancestors[2]/defaultName'. A tenant provider class is Java class which
- implements the the ITenantProvider interface. For more details please consult
- the installation and configuration guide. -->
- <crn:parameter name="tenantIdMapping">
- <crn:value xsi:type="cfg:tenancyInfo">pattern</crn:value>
- </crn:parameter>
- <!-- tenantBoundingSetMapping: Specifies how the tenant bounding set is determined
- for a user. -->
- <!-- This parameter is used when multitenancy is enabled. The tenant bounding set
- for a user can be determined using a pattern or a tenant bounding set provider
- class. The pattern is a AAA service search path to a property which defines a
- tenant bounding set. The search path must be relative to a user account. For
- example: '˜/parameters/boundingSet'. A tenant bounding set provider class is
- Java class which implements the the IBoundingSetProvider interface. For more
- details please consult the installation and configuration guide. -->
- <crn:parameter name="tenantBoundingSetMapping">
- <crn:value xsi:type="cfg:tenancyInfo">pattern</crn:value>
- </crn:parameter>
- </crn:instance>
- <!--
- (End of) OIDC_IBMCloudId template
- ===============================================================================
- -->
- <!--
- ===============================================================================
- (Begin of) OIDC_MSIdentity template
- -->
- <crn:instance name="OIDC_MSIdentity Name" class="OIDC_MSIdentity">
- <!-- identityProviderType: Specifies the implementation of an OpenID Connect
- identity provider. -->
- <crn:parameter name="identityProviderType">
- <crn:value xsi:type="xsd:string">MSIdentity</crn:value>
- </crn:parameter>
- <!-- id: Specifies a unique identifier for the authentication namespace. -->
- <!-- Use the namespace identifier to distinguish between multiple namespaces. Each
- namespace must have a unique identifier. When you select a namespace to use for
- authentication in the run-time environment, the identifier is used by the IBM
- Cognos components. Changing the namespace ID after the service has been started
- may invalidate the object security policies and the Cognos group and role
- memberships. The use of the colon in the Namespace ID is not supported. -->
- <crn:parameter name="id">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- oidcDiscEndpoint: Specifies the OpenID Connect discovery endpoint -->
- <!-- The discovery endpoint is used to retrieve the OpenID Connect configuration
- that includes the authorization endpoint, token endpoint, jwks endpoint, and
- issuer. -->
- <crn:parameter name="oidcDiscEndpoint">
- <crn:value xsi:type="cfg:anyPathURI">https://login.microsoftonline.com:443/{tenantid}/v2.0/.well-known/openid-configuration</crn:value>
- </crn:parameter>
- <!-- clientId: Specifies the OpenID Connect client identifier -->
- <!-- The client identity that is assigned to the application by the OpenID Connect
- identity provider. -->
- <crn:parameter name="clientId">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- clientSecret: Specifies the client secret that is assigned to the application
- by the OpenID Connect identity provider. -->
- <!-- The client secret that is assigned to the application by the OpenID Connect
- identity provider. -->
- <crn:parameter name="clientSecret">
- <crn:value xsi:type="xsd:string" encrypted="false"/>
- </crn:parameter>
- <!-- returnUrl: Return URL that is configured with the OpenID Connect identity
- provider. -->
- <!-- The return URL is invoked by the OpenID Connect identity provider after
- successfully authenticating a user. The URL format is
- https://dispatcherHOST:dispatcherPORT/bi/completeAuth.jsp or
- https://webserverHOST:webserverPORT/ibmcognos/bi/completeAuth.jsp. This URL
- completes Cognos Analytics authentication using the OpenID Connect identity
- provider. -->
- <crn:parameter name="returnUrl">
- <crn:value xsi:type="cfg:anyPathURI">https://host:port/bi/completeAuth.jsp</crn:value>
- </crn:parameter>
- <!-- selectableForAuth: Specifies whether the namespace is selectable for
- authentication. -->
- <!-- If this property is set to true, the namespace will be available for
- authentication in the logon page namespace selection prompt. Set this value to
- false if the namespace should not be available for selection on the logon page.
- -->
- <crn:parameter name="selectableForAuth">
- <crn:value xsi:type="xsd:boolean">true</crn:value>
- </crn:parameter>
- <!-- advancedProperties: Specifies a set of advanced properties. -->
- <!-- The user needs to provide the name and the value for each advanced property. -->
- <crn:parameter name="advancedProperties">
- <crn:value xsi:type="cfg:array">
- </crn:value>
- </crn:parameter>
- <!-- accountCamidProperty: Specifies the value used to uniquely identify account
- objects. -->
- <!-- Specify either an existing Content Manager account object model property
- (e.g., email, username, defaultName, etc) or the name of a configured custom
- property. A claim must be returned for all accounts from the Identity Provider
- for either the Content Manager account object model property or the configured
- custom property. The value selected must be unique across all account objects.
- The value selected should be constant over time with a low probability of
- needing to be changed. NOTE: this value should not be changed after initial
- namespace configuration. -->
- <crn:parameter name="accountCamidProperty">
- <crn:value xsi:type="xsd:string">email</crn:value>
- </crn:parameter>
- <!-- customProperties: Specifies a set of custom properties. -->
- <!-- Use this set of custom properties to define additional account information.
- The "name" field corresponds to the property name set in the account while the
- "value" corresponds to the claim name in the id_token. -->
- <crn:parameter name="customProperties">
- <crn:value xsi:type="cfg:array">
- </crn:value>
- </crn:parameter>
- <!-- tenantIdMapping: Specifies how namespace users are mapped to tenant IDs. -->
- <!-- Specifying a value for this parameter enables multitenancy. The tenant ID for
- a user can be determined using a pattern or a tenant provider class. The
- pattern is a AAA service search path to a property which defines a tenant ID.
- The search path must be relative to a user account. For example:
- '~/ancestors[2]/defaultName'. A tenant provider class is Java class which
- implements the the ITenantProvider interface. For more details please consult
- the installation and configuration guide. -->
- <crn:parameter name="tenantIdMapping">
- <crn:value xsi:type="cfg:tenancyInfo">pattern</crn:value>
- </crn:parameter>
- <!-- tenantBoundingSetMapping: Specifies how the tenant bounding set is determined
- for a user. -->
- <!-- This parameter is used when multitenancy is enabled. The tenant bounding set
- for a user can be determined using a pattern or a tenant bounding set provider
- class. The pattern is a AAA service search path to a property which defines a
- tenant bounding set. The search path must be relative to a user account. For
- example: '˜/parameters/boundingSet'. A tenant bounding set provider class is
- Java class which implements the the IBoundingSetProvider interface. For more
- details please consult the installation and configuration guide. -->
- <crn:parameter name="tenantBoundingSetMapping">
- <crn:value xsi:type="cfg:tenancyInfo">pattern</crn:value>
- </crn:parameter>
- </crn:instance>
- <!--
- (End of) OIDC_MSIdentity template
- ===============================================================================
- -->
- <!--
- ===============================================================================
- (Begin of) OIDC_OKTA template
- -->
- <crn:instance name="OIDC_OKTA Name" class="OIDC_OKTA">
- <!-- identityProviderType: Specifies the implementation of an OpenID Connect
- identity provider. -->
- <crn:parameter name="identityProviderType">
- <crn:value xsi:type="xsd:string">OKTA</crn:value>
- </crn:parameter>
- <!-- id: Specifies a unique identifier for the authentication namespace. -->
- <!-- Use the namespace identifier to distinguish between multiple namespaces. Each
- namespace must have a unique identifier. When you select a namespace to use for
- authentication in the run-time environment, the identifier is used by the IBM
- Cognos components. Changing the namespace ID after the service has been started
- may invalidate the object security policies and the Cognos group and role
- memberships. The use of the colon in the Namespace ID is not supported. -->
- <crn:parameter name="id">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- oidcDiscEndpoint: Specifies the OpenID Connect discovery endpoint -->
- <!-- The discovery endpoint is used to retrieve the OpenID Connect configuration
- that includes the authorization endpoint, token endpoint, jwks endpoint, and
- issuer. -->
- <crn:parameter name="oidcDiscEndpoint">
- <crn:value xsi:type="cfg:anyPathURI">https://{hostname}:443/.well-known/openid-configuration</crn:value>
- </crn:parameter>
- <!-- clientId: Specifies the OpenID Connect client identifier -->
- <!-- The client identity that is assigned to the application by the OpenID Connect
- identity provider. -->
- <crn:parameter name="clientId">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- clientSecret: Specifies the client secret that is assigned to the application
- by the OpenID Connect identity provider. -->
- <!-- The client secret that is assigned to the application by the OpenID Connect
- identity provider. -->
- <crn:parameter name="clientSecret">
- <crn:value xsi:type="xsd:string" encrypted="false"/>
- </crn:parameter>
- <!-- returnUrl: Return URL that is configured with the OpenID Connect identity
- provider. -->
- <!-- The return URL is invoked by the OpenID Connect identity provider after
- successfully authenticating a user. The URL format is
- https://dispatcherHOST:dispatcherPORT/bi/completeAuth.jsp or
- https://webserverHOST:webserverPORT/ibmcognos/bi/completeAuth.jsp. This URL
- completes Cognos Analytics authentication using the OpenID Connect identity
- provider. -->
- <crn:parameter name="returnUrl">
- <crn:value xsi:type="cfg:anyPathURI">https://host:port/bi/completeAuth.jsp</crn:value>
- </crn:parameter>
- <!-- selectableForAuth: Specifies whether the namespace is selectable for
- authentication. -->
- <!-- If this property is set to true, the namespace will be available for
- authentication in the logon page namespace selection prompt. Set this value to
- false if the namespace should not be available for selection on the logon page.
- -->
- <crn:parameter name="selectableForAuth">
- <crn:value xsi:type="xsd:boolean">true</crn:value>
- </crn:parameter>
- <!-- advancedProperties: Specifies a set of advanced properties. -->
- <!-- The user needs to provide the name and the value for each advanced property. -->
- <crn:parameter name="advancedProperties">
- <crn:value xsi:type="cfg:array">
- </crn:value>
- </crn:parameter>
- <!-- accountCamidProperty: Specifies the value used to uniquely identify account
- objects. -->
- <!-- Specify either an existing Content Manager account object model property
- (e.g., email, username, defaultName, etc) or the name of a configured custom
- property. A claim must be returned for all accounts from the Identity Provider
- for either the Content Manager account object model property or the configured
- custom property. The value selected must be unique across all account objects.
- The value selected should be constant over time with a low probability of
- needing to be changed. NOTE: this value should not be changed after initial
- namespace configuration. -->
- <crn:parameter name="accountCamidProperty">
- <crn:value xsi:type="xsd:string">email</crn:value>
- </crn:parameter>
- <!-- customProperties: Specifies a set of custom properties. -->
- <!-- Use this set of custom properties to define additional account information.
- The "name" field corresponds to the property name set in the account while the
- "value" corresponds to the claim name in the id_token. -->
- <crn:parameter name="customProperties">
- <crn:value xsi:type="cfg:array">
- </crn:value>
- </crn:parameter>
- <!-- tenantIdMapping: Specifies how namespace users are mapped to tenant IDs. -->
- <!-- Specifying a value for this parameter enables multitenancy. The tenant ID for
- a user can be determined using a pattern or a tenant provider class. The
- pattern is a AAA service search path to a property which defines a tenant ID.
- The search path must be relative to a user account. For example:
- '~/ancestors[2]/defaultName'. A tenant provider class is Java class which
- implements the the ITenantProvider interface. For more details please consult
- the installation and configuration guide. -->
- <crn:parameter name="tenantIdMapping">
- <crn:value xsi:type="cfg:tenancyInfo">pattern</crn:value>
- </crn:parameter>
- <!-- tenantBoundingSetMapping: Specifies how the tenant bounding set is determined
- for a user. -->
- <!-- This parameter is used when multitenancy is enabled. The tenant bounding set
- for a user can be determined using a pattern or a tenant bounding set provider
- class. The pattern is a AAA service search path to a property which defines a
- tenant bounding set. The search path must be relative to a user account. For
- example: '˜/parameters/boundingSet'. A tenant bounding set provider class is
- Java class which implements the the IBoundingSetProvider interface. For more
- details please consult the installation and configuration guide. -->
- <crn:parameter name="tenantBoundingSetMapping">
- <crn:value xsi:type="cfg:tenancyInfo">pattern</crn:value>
- </crn:parameter>
- </crn:instance>
- <!--
- (End of) OIDC_OKTA template
- ===============================================================================
- -->
- <!--
- ===============================================================================
- (Begin of) OIDC_Ping template
- -->
- <crn:instance name="OIDC_Ping Name" class="OIDC_Ping">
- <!-- identityProviderType: Specifies the implementation of an OpenID Connect
- identity provider. -->
- <crn:parameter name="identityProviderType">
- <crn:value xsi:type="xsd:string">Ping</crn:value>
- </crn:parameter>
- <!-- id: Specifies a unique identifier for the authentication namespace. -->
- <!-- Use the namespace identifier to distinguish between multiple namespaces. Each
- namespace must have a unique identifier. When you select a namespace to use for
- authentication in the run-time environment, the identifier is used by the IBM
- Cognos components. Changing the namespace ID after the service has been started
- may invalidate the object security policies and the Cognos group and role
- memberships. The use of the colon in the Namespace ID is not supported. -->
- <crn:parameter name="id">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- oidcDiscEndpoint: Specifies the OpenID Connect discovery endpoint -->
- <!-- The discovery endpoint is used to retrieve the OpenID Connect configuration
- that includes the authorization endpoint, token endpoint, jwks endpoint, and
- issuer. -->
- <crn:parameter name="oidcDiscEndpoint">
- <crn:value xsi:type="cfg:anyPathURI">https://pingfederatehost:port/.well-known/openid-configuration</crn:value>
- </crn:parameter>
- <!-- clientId: Specifies the OpenID Connect client identifier -->
- <!-- The client identity that is assigned to the application by the OpenID Connect
- identity provider. -->
- <crn:parameter name="clientId">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- clientSecret: Specifies the client secret that is assigned to the application
- by the OpenID Connect identity provider. -->
- <!-- The client secret that is assigned to the application by the OpenID Connect
- identity provider. -->
- <crn:parameter name="clientSecret">
- <crn:value xsi:type="xsd:string" encrypted="false"/>
- </crn:parameter>
- <!-- returnUrl: Return URL that is configured with the OpenID Connect identity
- provider. -->
- <!-- The return URL is invoked by the OpenID Connect identity provider after
- successfully authenticating a user. The URL format is
- https://dispatcherHOST:dispatcherPORT/bi/completeAuth.jsp or
- https://webserverHOST:webserverPORT/ibmcognos/bi/completeAuth.jsp. This URL
- completes Cognos Analytics authentication using the OpenID Connect identity
- provider. -->
- <crn:parameter name="returnUrl">
- <crn:value xsi:type="cfg:anyPathURI">https://host:port/bi/completeAuth.jsp</crn:value>
- </crn:parameter>
- <!-- selectableForAuth: Specifies whether the namespace is selectable for
- authentication. -->
- <!-- If this property is set to true, the namespace will be available for
- authentication in the logon page namespace selection prompt. Set this value to
- false if the namespace should not be available for selection on the logon page.
- -->
- <crn:parameter name="selectableForAuth">
- <crn:value xsi:type="xsd:boolean">true</crn:value>
- </crn:parameter>
- <!-- advancedProperties: Specifies a set of advanced properties. -->
- <!-- The user needs to provide the name and the value for each advanced property. -->
- <crn:parameter name="advancedProperties">
- <crn:value xsi:type="cfg:array">
- </crn:value>
- </crn:parameter>
- <!-- accountCamidProperty: Specifies the value used to uniquely identify account
- objects. -->
- <!-- Specify either an existing Content Manager account object model property
- (e.g., email, username, defaultName, etc) or the name of a configured custom
- property. A claim must be returned for all accounts from the Identity Provider
- for either the Content Manager account object model property or the configured
- custom property. The value selected must be unique across all account objects.
- The value selected should be constant over time with a low probability of
- needing to be changed. NOTE: this value should not be changed after initial
- namespace configuration. -->
- <crn:parameter name="accountCamidProperty">
- <crn:value xsi:type="xsd:string">email</crn:value>
- </crn:parameter>
- <!-- customProperties: Specifies a set of custom properties. -->
- <!-- Use this set of custom properties to define additional account information.
- The "name" field corresponds to the property name set in the account while the
- "value" corresponds to the claim name in the id_token. -->
- <crn:parameter name="customProperties">
- <crn:value xsi:type="cfg:array">
- </crn:value>
- </crn:parameter>
- <!-- tenantIdMapping: Specifies how namespace users are mapped to tenant IDs. -->
- <!-- Specifying a value for this parameter enables multitenancy. The tenant ID for
- a user can be determined using a pattern or a tenant provider class. The
- pattern is a AAA service search path to a property which defines a tenant ID.
- The search path must be relative to a user account. For example:
- '~/ancestors[2]/defaultName'. A tenant provider class is Java class which
- implements the the ITenantProvider interface. For more details please consult
- the installation and configuration guide. -->
- <crn:parameter name="tenantIdMapping">
- <crn:value xsi:type="cfg:tenancyInfo">pattern</crn:value>
- </crn:parameter>
- <!-- tenantBoundingSetMapping: Specifies how the tenant bounding set is determined
- for a user. -->
- <!-- This parameter is used when multitenancy is enabled. The tenant bounding set
- for a user can be determined using a pattern or a tenant bounding set provider
- class. The pattern is a AAA service search path to a property which defines a
- tenant bounding set. The search path must be relative to a user account. For
- example: '˜/parameters/boundingSet'. A tenant bounding set provider class is
- Java class which implements the the IBoundingSetProvider interface. For more
- details please consult the installation and configuration guide. -->
- <crn:parameter name="tenantBoundingSetMapping">
- <crn:value xsi:type="cfg:tenancyInfo">pattern</crn:value>
- </crn:parameter>
- </crn:instance>
- <!--
- (End of) OIDC_Ping template
- ===============================================================================
- -->
- <!--
- ===============================================================================
- (Begin of) OIDC_SalesForce template
- -->
- <crn:instance name="OIDC_SalesForce Name" class="OIDC_SalesForce">
- <!-- identityProviderType: Specifies the implementation of an OpenID Connect
- identity provider. -->
- <crn:parameter name="identityProviderType">
- <crn:value xsi:type="xsd:string">SalesForce</crn:value>
- </crn:parameter>
- <!-- id: Specifies a unique identifier for the authentication namespace. -->
- <!-- Use the namespace identifier to distinguish between multiple namespaces. Each
- namespace must have a unique identifier. When you select a namespace to use for
- authentication in the run-time environment, the identifier is used by the IBM
- Cognos components. Changing the namespace ID after the service has been started
- may invalidate the object security policies and the Cognos group and role
- memberships. The use of the colon in the Namespace ID is not supported. -->
- <crn:parameter name="id">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- oidcDiscEndpoint: Specifies the OpenID Connect discovery endpoint -->
- <!-- The discovery endpoint is used to retrieve the OpenID Connect configuration
- that includes the authorization endpoint, token endpoint, jwks endpoint, and
- issuer. -->
- <crn:parameter name="oidcDiscEndpoint">
- <crn:value xsi:type="cfg:anyPathURI">https://login.salesforce.com:443/.well-known/openid-configuration</crn:value>
- </crn:parameter>
- <!-- clientId: Specifies the OpenID Connect client identifier -->
- <!-- The client identity that is assigned to the application by the OpenID Connect
- identity provider. -->
- <crn:parameter name="clientId">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- clientSecret: Specifies the client secret that is assigned to the application
- by the OpenID Connect identity provider. -->
- <!-- The client secret that is assigned to the application by the OpenID Connect
- identity provider. -->
- <crn:parameter name="clientSecret">
- <crn:value xsi:type="xsd:string" encrypted="false"/>
- </crn:parameter>
- <!-- returnUrl: Return URL that is configured with the OpenID Connect identity
- provider. -->
- <!-- The return URL is invoked by the OpenID Connect identity provider after
- successfully authenticating a user. The URL format is
- https://dispatcherHOST:dispatcherPORT/bi/completeAuth.jsp or
- https://webserverHOST:webserverPORT/ibmcognos/bi/completeAuth.jsp. This URL
- completes Cognos Analytics authentication using the OpenID Connect identity
- provider. -->
- <crn:parameter name="returnUrl">
- <crn:value xsi:type="cfg:anyPathURI">https://host:port/bi/completeAuth.jsp</crn:value>
- </crn:parameter>
- <!-- selectableForAuth: Specifies whether the namespace is selectable for
- authentication. -->
- <!-- If this property is set to true, the namespace will be available for
- authentication in the logon page namespace selection prompt. Set this value to
- false if the namespace should not be available for selection on the logon page.
- -->
- <crn:parameter name="selectableForAuth">
- <crn:value xsi:type="xsd:boolean">true</crn:value>
- </crn:parameter>
- <!-- advancedProperties: Specifies a set of advanced properties. -->
- <!-- The user needs to provide the name and the value for each advanced property. -->
- <crn:parameter name="advancedProperties">
- <crn:value xsi:type="cfg:array">
- </crn:value>
- </crn:parameter>
- <!-- accountCamidProperty: Specifies the value used to uniquely identify account
- objects. -->
- <!-- Specify either an existing Content Manager account object model property
- (e.g., email, username, defaultName, etc) or the name of a configured custom
- property. A claim must be returned for all accounts from the Identity Provider
- for either the Content Manager account object model property or the configured
- custom property. The value selected must be unique across all account objects.
- The value selected should be constant over time with a low probability of
- needing to be changed. NOTE: this value should not be changed after initial
- namespace configuration. -->
- <crn:parameter name="accountCamidProperty">
- <crn:value xsi:type="xsd:string">email</crn:value>
- </crn:parameter>
- <!-- customProperties: Specifies a set of custom properties. -->
- <!-- Use this set of custom properties to define additional account information.
- The "name" field corresponds to the property name set in the account while the
- "value" corresponds to the claim name in the id_token. -->
- <crn:parameter name="customProperties">
- <crn:value xsi:type="cfg:array">
- </crn:value>
- </crn:parameter>
- <!-- tenantIdMapping: Specifies how namespace users are mapped to tenant IDs. -->
- <!-- Specifying a value for this parameter enables multitenancy. The tenant ID for
- a user can be determined using a pattern or a tenant provider class. The
- pattern is a AAA service search path to a property which defines a tenant ID.
- The search path must be relative to a user account. For example:
- '~/ancestors[2]/defaultName'. A tenant provider class is Java class which
- implements the the ITenantProvider interface. For more details please consult
- the installation and configuration guide. -->
- <crn:parameter name="tenantIdMapping">
- <crn:value xsi:type="cfg:tenancyInfo">pattern</crn:value>
- </crn:parameter>
- <!-- tenantBoundingSetMapping: Specifies how the tenant bounding set is determined
- for a user. -->
- <!-- This parameter is used when multitenancy is enabled. The tenant bounding set
- for a user can be determined using a pattern or a tenant bounding set provider
- class. The pattern is a AAA service search path to a property which defines a
- tenant bounding set. The search path must be relative to a user account. For
- example: '˜/parameters/boundingSet'. A tenant bounding set provider class is
- Java class which implements the the IBoundingSetProvider interface. For more
- details please consult the installation and configuration guide. -->
- <crn:parameter name="tenantBoundingSetMapping">
- <crn:value xsi:type="cfg:tenancyInfo">pattern</crn:value>
- </crn:parameter>
- </crn:instance>
- <!--
- (End of) OIDC_SalesForce template
- ===============================================================================
- -->
- <!--
- ===============================================================================
- (Begin of) OIDC_SiteMinder template
- -->
- <crn:instance name="OIDC_SiteMinder Name" class="OIDC_SiteMinder">
- <!-- identityProviderType: Specifies the implementation of an OpenID Connect
- identity provider. -->
- <crn:parameter name="identityProviderType">
- <crn:value xsi:type="xsd:string">SiteMinder</crn:value>
- </crn:parameter>
- <!-- id: Specifies a unique identifier for the authentication namespace. -->
- <!-- Use the namespace identifier to distinguish between multiple namespaces. Each
- namespace must have a unique identifier. When you select a namespace to use for
- authentication in the run-time environment, the identifier is used by the IBM
- Cognos components. Changing the namespace ID after the service has been started
- may invalidate the object security policies and the Cognos group and role
- memberships. The use of the colon in the Namespace ID is not supported. -->
- <crn:parameter name="id">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- issuer: Specifies the OpenID claim issuer. The value looks like:
- https://<SiteMinder fully qualified hostname> -->
- <!-- A string that represents the identity provider that issued the claims in the
- ID token. This value must match the value of the 'iss' entry in the ID token
- JSON document. -->
- <crn:parameter name="issuer">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- oidcTokenEndpoint: Specifies the OpenID Connect token endpoint, using the
- following syntax: https://<SiteMinder fully qualified
- hostname:port>/affwebservices/CASSO/oidc/token -->
- <!-- The token endpoint is used to retrieve the identity token after a successful
- authentication to the OpenID Connect identity provider. -->
- <crn:parameter name="oidcTokenEndpoint">
- <crn:value xsi:type="cfg:anyPathURI">
- </crn:value>
- </crn:parameter>
- <!-- oidcAuthEndpoint: Specifies the OpenID Connect authorization endpoint, using
- the following syntax: https://<SiteMinder fully qualified
- hostname:port>/affwebservices/CASSO/oidc/authorize -->
- <!-- The authorization endpoint is a URL that your OpenID Connect identity provider
- uses for authentication. In most cases, the URL should use the https scheme.
- The authorization endpoint is invoked when users authenticate to the OpenID
- Connect identity provider. -->
- <crn:parameter name="oidcAuthEndpoint">
- <crn:value xsi:type="cfg:anyPathURI">
- </crn:value>
- </crn:parameter>
- <!-- clientId: Specifies the OpenID Connect client identifier -->
- <!-- The client identity that is assigned to the application by the OpenID Connect
- identity provider. -->
- <crn:parameter name="clientId">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- clientSecret: Specifies the client secret that is assigned to the application
- by the OpenID Connect identity provider. -->
- <!-- The client secret that is assigned to the application by the OpenID Connect
- identity provider. -->
- <crn:parameter name="clientSecret">
- <crn:value xsi:type="xsd:string" encrypted="false"/>
- </crn:parameter>
- <!-- jwksEndpoint: Specifies the OpenID Connect endpoint for retrieving JWT signing
- keys, using the following syntax: https://<SiteMinder fully qualified
- hostname:port>/affwebservices/CASSO/oidc/jwks?AuthorizationProvider=<provider
- name> -->
- <!-- The JWKS endpoint is a URL that your OpenID Connect identity provider uses to
- provide signing key data. In most cases, the URL should use the https scheme.
- The JWKS endpoint is invoked when validating an id_token returned from the
- identity provider. -->
- <crn:parameter name="jwksEndpoint">
- <crn:value xsi:type="cfg:anyPathURI">
- </crn:value>
- </crn:parameter>
- <!-- returnUrl: Return URL that is configured with the OpenID Connect identity
- provider. -->
- <!-- The return URL is invoked by the OpenID Connect identity provider after
- successfully authenticating a user. The URL format is
- https://dispatcherHOST:dispatcherPORT/bi/completeAuth.jsp or
- https://webserverHOST:webserverPORT/ibmcognos/bi/completeAuth.jsp. This URL
- completes Cognos Analytics authentication using the OpenID Connect identity
- provider. -->
- <crn:parameter name="returnUrl">
- <crn:value xsi:type="cfg:anyPathURI">https://host:port/bi/completeAuth.jsp</crn:value>
- </crn:parameter>
- <!-- selectableForAuth: Specifies whether the namespace is selectable for
- authentication. -->
- <!-- If this property is set to true, the namespace will be available for
- authentication in the logon page namespace selection prompt. Set this value to
- false if the namespace should not be available for selection on the logon page.
- -->
- <crn:parameter name="selectableForAuth">
- <crn:value xsi:type="xsd:boolean">true</crn:value>
- </crn:parameter>
- <!-- advancedProperties: Specifies a set of advanced properties. -->
- <!-- The user needs to provide the name and the value for each advanced property. -->
- <crn:parameter name="advancedProperties">
- <crn:value xsi:type="cfg:array">
- </crn:value>
- </crn:parameter>
- <!-- accountCamidProperty: Specifies the value used to uniquely identify account
- objects. -->
- <!-- Specify either an existing Content Manager account object model property
- (e.g., email, username, defaultName, etc) or the name of a configured custom
- property. A claim must be returned for all accounts from the Identity Provider
- for either the Content Manager account object model property or the configured
- custom property. The value selected must be unique across all account objects.
- The value selected should be constant over time with a low probability of
- needing to be changed. NOTE: this value should not be changed after initial
- namespace configuration. -->
- <crn:parameter name="accountCamidProperty">
- <crn:value xsi:type="xsd:string">email</crn:value>
- </crn:parameter>
- <!-- customProperties: Specifies a set of custom properties. -->
- <!-- Use this set of custom properties to define additional account information.
- The "name" field corresponds to the property name set in the account while the
- "value" corresponds to the claim name in the id_token. -->
- <crn:parameter name="customProperties">
- <crn:value xsi:type="cfg:array">
- </crn:value>
- </crn:parameter>
- <!-- tenantIdMapping: Specifies how namespace users are mapped to tenant IDs. -->
- <!-- Specifying a value for this parameter enables multitenancy. The tenant ID for
- a user can be determined using a pattern or a tenant provider class. The
- pattern is a AAA service search path to a property which defines a tenant ID.
- The search path must be relative to a user account. For example:
- '~/ancestors[2]/defaultName'. A tenant provider class is Java class which
- implements the the ITenantProvider interface. For more details please consult
- the installation and configuration guide. -->
- <crn:parameter name="tenantIdMapping">
- <crn:value xsi:type="cfg:tenancyInfo">pattern</crn:value>
- </crn:parameter>
- <!-- tenantBoundingSetMapping: Specifies how the tenant bounding set is determined
- for a user. -->
- <!-- This parameter is used when multitenancy is enabled. The tenant bounding set
- for a user can be determined using a pattern or a tenant bounding set provider
- class. The pattern is a AAA service search path to a property which defines a
- tenant bounding set. The search path must be relative to a user account. For
- example: '˜/parameters/boundingSet'. A tenant bounding set provider class is
- Java class which implements the the IBoundingSetProvider interface. For more
- details please consult the installation and configuration guide. -->
- <crn:parameter name="tenantBoundingSetMapping">
- <crn:value xsi:type="cfg:tenancyInfo">pattern</crn:value>
- </crn:parameter>
- </crn:instance>
- <!--
- (End of) OIDC_SiteMinder template
- ===============================================================================
- -->
- <!--
- ===============================================================================
- (Begin of) OIDC_W3ID template
- -->
- <crn:instance name="OIDC_W3ID Name" class="OIDC_W3ID">
- <!-- identityProviderType: Specifies the implementation of an OpenID Connect
- identity provider. -->
- <crn:parameter name="identityProviderType">
- <crn:value xsi:type="xsd:string">W3ID</crn:value>
- </crn:parameter>
- <!-- id: Specifies a unique identifier for the authentication namespace. -->
- <!-- Use the namespace identifier to distinguish between multiple namespaces. Each
- namespace must have a unique identifier. When you select a namespace to use for
- authentication in the run-time environment, the identifier is used by the IBM
- Cognos components. Changing the namespace ID after the service has been started
- may invalidate the object security policies and the Cognos group and role
- memberships. The use of the colon in the Namespace ID is not supported. -->
- <crn:parameter name="id">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- issuer: Specifies the OpenID claim issuer. -->
- <!-- A string that represents the identity provider that issued the claims in the
- ID token. This value must match the value of the 'iss' entry in the ID token
- JSON document. -->
- <crn:parameter name="issuer">
- <crn:value xsi:type="xsd:string">https://w3id.sso.ibm.com/isam</crn:value>
- </crn:parameter>
- <!-- oidcTokenEndpoint: Specifies the OpenID Connect token endpoint -->
- <!-- The token endpoint is used to retrieve the identity token after a successful
- authentication to the OpenID Connect identity provider. -->
- <crn:parameter name="oidcTokenEndpoint">
- <crn:value xsi:type="cfg:anyPathURI">https://w3id.sso.ibm.com:443/isam/oidc/endpoint/amapp-runtime-oidcidp/token</crn:value>
- </crn:parameter>
- <!-- oidcAuthEndpoint: Specifies the OpenID Connect authorization endpoint. -->
- <!-- The authorization endpoint is a URL that your OpenID Connect identity provider
- uses for authentication. In most cases, the URL should use the https scheme.
- The authorization endpoint is invoked when users authenticate to the OpenID
- Connect identity provider. -->
- <crn:parameter name="oidcAuthEndpoint">
- <crn:value xsi:type="cfg:anyPathURI">https://w3id.sso.ibm.com:443/isam/oidc/endpoint/amapp-runtime-oidcidp/authorize</crn:value>
- </crn:parameter>
- <!-- clientId: Specifies the OpenID Connect client identifier -->
- <!-- The client identity that is assigned to the application by the OpenID Connect
- identity provider. -->
- <crn:parameter name="clientId">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- clientSecret: Specifies the client secret that is assigned to the application
- by the OpenID Connect identity provider. -->
- <!-- The client secret that is assigned to the application by the OpenID Connect
- identity provider. -->
- <crn:parameter name="clientSecret">
- <crn:value xsi:type="xsd:string" encrypted="false"/>
- </crn:parameter>
- <!-- idpCertificateFile: Specifies the location of the certificate that is used by
- the OpenID Connect identity provider to sign the identity token. -->
- <!-- A path to the file that contains the certificate used by the identity provider
- to sign the JSON Web Token. The path must include the certificate file name and
- be accessible to the running instance of Cognos Analytics. The certificate
- must be in a PEM format, include only the public key certificate, and include
- the begin and end certificate lines. The certificate file cannot be placed in
- the configuration/certs directory. -->
- <crn:parameter name="idpCertificateFile">
- <crn:value xsi:type="cfg:filePath">
- </crn:value>
- </crn:parameter>
- <!-- returnUrl: Return URL that is configured with the OpenID Connect identity
- provider. -->
- <!-- The return URL is invoked by the OpenID Connect identity provider after
- successfully authenticating a user. The URL format is
- https://dispatcherHOST:dispatcherPORT/bi/completeAuth.jsp or
- https://webserverHOST:webserverPORT/ibmcognos/bi/completeAuth.jsp. This URL
- completes Cognos Analytics authentication using the OpenID Connect identity
- provider. -->
- <crn:parameter name="returnUrl">
- <crn:value xsi:type="cfg:anyPathURI">https://host:port/bi/completeAuth.jsp</crn:value>
- </crn:parameter>
- <!-- selectableForAuth: Specifies whether the namespace is selectable for
- authentication. -->
- <!-- If this property is set to true, the namespace will be available for
- authentication in the logon page namespace selection prompt. Set this value to
- false if the namespace should not be available for selection on the logon page.
- -->
- <crn:parameter name="selectableForAuth">
- <crn:value xsi:type="xsd:boolean">true</crn:value>
- </crn:parameter>
- <!-- advancedProperties: Specifies a set of advanced properties. -->
- <!-- The user needs to provide the name and the value for each advanced property. -->
- <crn:parameter name="advancedProperties">
- <crn:value xsi:type="cfg:array">
- </crn:value>
- </crn:parameter>
- <!-- accountCamidProperty: Specifies the value used to uniquely identify account
- objects. -->
- <!-- Specify either an existing Content Manager account object model property
- (e.g., email, username, defaultName, etc) or the name of a configured custom
- property. A claim must be returned for all accounts from the Identity Provider
- for either the Content Manager account object model property or the configured
- custom property. The value selected must be unique across all account objects.
- The value selected should be constant over time with a low probability of
- needing to be changed. NOTE: this value should not be changed after initial
- namespace configuration. -->
- <crn:parameter name="accountCamidProperty">
- <crn:value xsi:type="xsd:string">email</crn:value>
- </crn:parameter>
- <!-- customProperties: Specifies a set of custom properties. -->
- <!-- Use this set of custom properties to define additional account information.
- The "name" field corresponds to the property name set in the account while the
- "value" corresponds to the claim name in the id_token. -->
- <crn:parameter name="customProperties">
- <crn:value xsi:type="cfg:array">
- </crn:value>
- </crn:parameter>
- <!-- tenantIdMapping: Specifies how namespace users are mapped to tenant IDs. -->
- <!-- Specifying a value for this parameter enables multitenancy. The tenant ID for
- a user can be determined using a pattern or a tenant provider class. The
- pattern is a AAA service search path to a property which defines a tenant ID.
- The search path must be relative to a user account. For example:
- '~/ancestors[2]/defaultName'. A tenant provider class is Java class which
- implements the the ITenantProvider interface. For more details please consult
- the installation and configuration guide. -->
- <crn:parameter name="tenantIdMapping">
- <crn:value xsi:type="cfg:tenancyInfo">pattern</crn:value>
- </crn:parameter>
- <!-- tenantBoundingSetMapping: Specifies how the tenant bounding set is determined
- for a user. -->
- <!-- This parameter is used when multitenancy is enabled. The tenant bounding set
- for a user can be determined using a pattern or a tenant bounding set provider
- class. The pattern is a AAA service search path to a property which defines a
- tenant bounding set. The search path must be relative to a user account. For
- example: '˜/parameters/boundingSet'. A tenant bounding set provider class is
- Java class which implements the the IBoundingSetProvider interface. For more
- details please consult the installation and configuration guide. -->
- <crn:parameter name="tenantBoundingSetMapping">
- <crn:value xsi:type="cfg:tenancyInfo">pattern</crn:value>
- </crn:parameter>
- </crn:instance>
- <!--
- (End of) OIDC_W3ID template
- ===============================================================================
- -->
- <!--
- ===============================================================================
- (Begin of) RACF template
- -->
- <crn:instance name="RACF Name" class="RACF">
- <!-- id: Specifies a unique identifier for the authentication namespace. -->
- <!-- Use the namespace identifier to distinguish between multiple namespaces. Each
- namespace must have a unique identifier. When you select a namespace to use for
- authentication in the run-time environment, the identifier is used by the IBM
- Cognos components. Changing the namespace ID after the service has been started
- may invalidate the object security policies and the Cognos group and role
- memberships. The use of the colon in the Namespace ID is not supported. -->
- <crn:parameter name="id">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- connection: Specifies the host name and port of the directory server. -->
- <!-- Use the following syntax to specify the host name and port for the directory
- server: host:port; for example, localhost:389. Ensure that if you use a fully
- qualified name for your computer that your DNS is set up to resolve it.
- Otherwise, you can also use the IP address. -->
- <crn:parameter name="connection">
- <crn:value xsi:type="cfg:hostPort">
- </crn:value>
- </crn:parameter>
- <!-- baseDN: Specifies the base distinguished name of the RACF server. -->
- <!-- The product uses the base DN to identify the top level of your directory
- server structure. The root of the hierarchal directory structure is the
- starting place for all searches. You restrict searches by specifying a base DN.
- -->
- <crn:parameter name="baseDN">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- identityMappingFlag: Specifies whether to use the identity mapping for user
- authentication. -->
- <crn:parameter name="identityMappingFlag">
- <crn:value xsi:type="xsd:boolean">false</crn:value>
- </crn:parameter>
- <!-- bindCredentials: Specifies the credentials used for binding to the RACF server
- when performing a search or when performing all operations using the identity
- mapping. -->
- <!-- This value corresponds to a RACF user who has read and search access to the
- user branch of the RACF directory server. -->
- <crn:parameter name="bindCredentials">
- <crn:value xsi:type="cfg:credential" encrypted="false">
- <credential>
- <username>joe</username>
- <password>paranoid</password>
- </credential>
- </crn:value>
- </crn:parameter>
- <!-- racfEnableSSL: Specifies that the RACF server expects SSL communication. -->
- <!-- Use this property to specify if SSL should be used when communicating with the
- RACF server. -->
- <crn:parameter name="racfEnableSSL">
- <crn:value xsi:type="xsd:boolean">false</crn:value>
- </crn:parameter>
- <!-- sizeLimit: Specifies the maximum number of responses permitted for a search
- request. -->
- <!-- The value depends on your environment. As a general rule, the minimum value
- for this setting should be greater than the maximum number of groups or users
- plus 100. When the size limit is reached the directory server stops searching.
- The default value of -1 indicates that the value on the RACF server will be
- used. -->
- <!-- Units: entries -->
- <crn:parameter name="sizeLimit">
- <crn:value xsi:type="xsd:int">-1</crn:value>
- </crn:parameter>
- <!-- timeOut: Specifies the number of seconds permitted to perform a search
- request. -->
- <!-- The product uses this value when it requests authentication from the namespace
- on your directory server. The value depends on your reporting environment. If
- the duration is exceeded, the search is timed out. The default value -1
- indicates that the value on the RACF server will be used. -->
- <!-- Units: sec -->
- <crn:parameter name="timeOut">
- <crn:value xsi:type="xsd:int">-1</crn:value>
- </crn:parameter>
- <!-- advancedProperties: Specifies a set of advanced properties. -->
- <!-- The user needs to provide the name and the value for each advanced property. -->
- <crn:parameter name="advancedProperties">
- <crn:value xsi:type="cfg:array">
- </crn:value>
- </crn:parameter>
- <!-- tenantIdMapping: Specifies how namespace users are mapped to tenant IDs. -->
- <!-- Specifying a value for this parameter enables multitenancy. The tenant ID for
- a user can be determined using a pattern or a tenant provider class. The
- pattern is a AAA service search path to a property which defines a tenant ID.
- The search path must be relative to a user account. For example:
- '~/ancestors[2]/defaultName'. A tenant provider class is Java class which
- implements the the ITenantProvider interface. For more details please consult
- the installation and configuration guide. -->
- <crn:parameter name="tenantIdMapping">
- <crn:value xsi:type="cfg:tenancyInfo">pattern</crn:value>
- </crn:parameter>
- <!-- tenantBoundingSetMapping: Specifies how the tenant bounding set is determined
- for a user. -->
- <!-- This parameter is used when multitenancy is enabled. The tenant bounding set
- for a user can be determined using a pattern or a tenant bounding set provider
- class. The pattern is a AAA service search path to a property which defines a
- tenant bounding set. The search path must be relative to a user account. For
- example: '˜/parameters/boundingSet'. A tenant bounding set provider class is
- Java class which implements the the IBoundingSetProvider interface. For more
- details please consult the installation and configuration guide. -->
- <crn:parameter name="tenantBoundingSetMapping">
- <crn:value xsi:type="cfg:tenancyInfo">pattern</crn:value>
- </crn:parameter>
- <!-- baseDataMappedProperty: Specifies the account property that will be mapped to
- the RACF Base Segment field, "DATA". -->
- <crn:parameter name="baseDataMappedProperty">
- <crn:value xsi:type="xsd:string">none</crn:value>
- </crn:parameter>
- <!-- TSODataMappedProperty: Specifies the account property that will be mapped to
- the RACF TSO Segment field, "USERDATA". -->
- <crn:parameter name="TSODataMappedProperty">
- <crn:value xsi:type="xsd:string">none</crn:value>
- </crn:parameter>
- </crn:instance>
- <!--
- (End of) RACF template
- ===============================================================================
- -->
- <!--
- ===============================================================================
- (Begin of) SAP template
- -->
- <crn:instance name="SAP Name" class="SAP">
- <!-- id: Specifies a unique identifier for the authentication namespace. -->
- <!-- Use the namespace identifier to distinguish between multiple namespaces. Each
- namespace must have a unique identifier. When you select a namespace to use for
- authentication in the run-time environment, the identifier is used by the IBM
- Cognos components. Changing the namespace ID after the service has been started
- may invalidate the object security policies and the Cognos group and role
- memberships. The use of the colon in the Namespace ID is not supported. -->
- <crn:parameter name="id">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- client: Specifies the name of the SAP logon client. -->
- <!-- Specifies the SAP client number. -->
- <crn:parameter name="client">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- hostname: Specifies the host name of the SAP server. -->
- <!-- Use this property so that you can connect to the computer that runs one or
- more SAP instances. -->
- <crn:parameter name="hostname">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- systnr: Specifies the SAP system number. -->
- <!-- The number must be an integer between 0 and 99. -->
- <crn:parameter name="systnr">
- <crn:value xsi:type="xsd:int">0</crn:value>
- </crn:parameter>
- <!-- codepage: Specifies the SAP BW server code page used to convert user
- credentials to the correct encoding. -->
- <!-- Use this property to convert the user ID and password from UTF8 encoding to
- the encoding used by the SAP server. To enable single signon, specify the same
- SAP Code page in the portal on the Data Sources page for the SAP BW connection
- string. -->
- <crn:parameter name="codepage">
- <crn:value xsi:type="xsd:string">4110</crn:value>
- </crn:parameter>
- <!-- selectableForAuth: Specifies whether the namespace is selectable for
- authentication. -->
- <!-- If this property is set to true, the namespace will be available for
- authentication in the logon page namespace selection prompt. Set this value to
- false if the namespace should not be available for selection on the logon page.
- -->
- <crn:parameter name="selectableForAuth">
- <crn:value xsi:type="xsd:boolean">true</crn:value>
- </crn:parameter>
- <!-- advancedProperties: Specifies a set of advanced properties. -->
- <!-- The user needs to provide the name and the value for each advanced property. -->
- <crn:parameter name="advancedProperties">
- <crn:value xsi:type="cfg:array">
- </crn:value>
- </crn:parameter>
- <!-- tenantIdMapping: Specifies how namespace users are mapped to tenant IDs. -->
- <!-- Specifying a value for this parameter enables multitenancy. The tenant ID for
- a user can be determined using a pattern or a tenant provider class. The
- pattern is a AAA service search path to a property which defines a tenant ID.
- The search path must be relative to a user account. For example:
- '~/ancestors[2]/defaultName'. A tenant provider class is Java class which
- implements the the ITenantProvider interface. For more details please consult
- the installation and configuration guide. -->
- <crn:parameter name="tenantIdMapping">
- <crn:value xsi:type="cfg:tenancyInfo">pattern</crn:value>
- </crn:parameter>
- <!-- tenantBoundingSetMapping: Specifies how the tenant bounding set is determined
- for a user. -->
- <!-- This parameter is used when multitenancy is enabled. The tenant bounding set
- for a user can be determined using a pattern or a tenant bounding set provider
- class. The pattern is a AAA service search path to a property which defines a
- tenant bounding set. The search path must be relative to a user account. For
- example: '˜/parameters/boundingSet'. A tenant bounding set provider class is
- Java class which implements the the IBoundingSetProvider interface. For more
- details please consult the installation and configuration guide. -->
- <crn:parameter name="tenantBoundingSetMapping">
- <crn:value xsi:type="cfg:tenancyInfo">pattern</crn:value>
- </crn:parameter>
- </crn:instance>
- <!--
- (End of) SAP template
- ===============================================================================
- -->
- <!--
- ===============================================================================
- (Begin of) Series7 template
- -->
- <crn:instance name="Series7 Name" class="Series7">
- <!-- id: Specifies a unique identifier for the authentication namespace. -->
- <!-- Use the namespace identifier to distinguish between multiple namespaces. Each
- namespace must have a unique identifier. When you select a namespace to use for
- authentication in the run-time environment, the identifier is used by the IBM
- Cognos components. Changing the namespace ID after the service has been started
- may invalidate the object security policies and the Cognos group and role
- memberships. The use of the colon in the Namespace ID is not supported. -->
- <crn:parameter name="id">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- connection: Specifies the host name and port of the directory server. -->
- <!-- Use the following syntax to specify the host name and port for the directory
- server: host:port; for example, localhost:389. Ensure that if you use a fully
- qualified name for your computer that your DNS is set up to resolve it.
- Otherwise, you can also use the IP address. -->
- <crn:parameter name="connection">
- <crn:value xsi:type="cfg:hostPort">
- </crn:value>
- </crn:parameter>
- <!-- baseDN: Specifies the base distinguished name of the LDAP server. -->
- <!-- The product uses the base DN to identify the top level of your directory
- server structure. The root of the hierarchal directory structure is the
- starting place for all searches. You restrict searches by specifying a base DN.
- -->
- <crn:parameter name="baseDN">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- namespace: Specifies the name of the IBM Cognos Series 7 namespace. -->
- <!-- Ensure that the namespace is available. -->
- <crn:parameter name="namespace">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- timeOut: Specifies the maximum number of seconds in which a connection to the
- directory server must be established. -->
- <!-- The product uses this value when it binds or re-binds to the directory server.
- A value of 0 indicates that the timeout is determined by the network
- connectivity software. The default value (10) sets the number of seconds that
- the Series7 provider waits for the bind operation to complete -->
- <!-- Units: sec -->
- <crn:parameter name="timeOut">
- <crn:value xsi:type="xsd:int">10</crn:value>
- </crn:parameter>
- <!-- dataEncoding: Specifies the encoding of the data stored in the LDAP directory
- server. -->
- <!-- Use this property to specify the encoding of data stored in the LDAP directory
- server. If this property is set to an encoding other than UTF-8, then
- conversion of the data from the encoding specified will be performed. The
- encoding value must follow IANA (RFC 1700) or MIME charset specifications. For
- example, windows-1252, iso-8859-1, iso-8859-15, Shift_JIS, utf-8, etc. If the
- Series 7 namespace version is 16.0 or greater, then this value must be set to
- UTF-8. If the Series 7 namespace version is 15.2 or lower, then this value must
- be set to the encoding of the system used to update the Access Manager data. To
- determine the namespace version, launch the Series 7 Access Manager -
- Administrator tool. Logon to the appropriate namespace, right click on the
- namespace name, and choose properties. -->
- <crn:parameter name="dataEncoding">
- <crn:value xsi:type="xsd:string">UTF-8</crn:value>
- </crn:parameter>
- <!-- sslCertificateDatabase: Specifies the location of the certificate database
- used by the directory server for SSL connections. -->
- <!-- Use this property to point to the location of the SSL certificate database for
- your LDAP server. -->
- <crn:parameter name="sslCertificateDatabase">
- <crn:value xsi:type="cfg:filePath">
- </crn:value>
- </crn:parameter>
- <!-- selectableForAuth: Specifies whether the namespace is selectable for
- authentication. -->
- <!-- If this property is set to true, the namespace will be available for
- authentication in the logon page namespace selection prompt. Set this value to
- false if the namespace should not be available for selection on the logon page.
- -->
- <crn:parameter name="selectableForAuth">
- <crn:value xsi:type="xsd:boolean">true</crn:value>
- </crn:parameter>
- <!-- advancedProperties: Specifies a set of advanced properties. -->
- <!-- The user needs to provide the name and the value for each advanced property. -->
- <crn:parameter name="advancedProperties">
- <crn:value xsi:type="cfg:array">
- </crn:value>
- </crn:parameter>
- <!-- tenantIdMapping: Specifies how namespace users are mapped to tenant IDs. -->
- <!-- Specifying a value for this parameter enables multitenancy. The tenant ID for
- a user can be determined using a pattern or a tenant provider class. The
- pattern is a AAA service search path to a property which defines a tenant ID.
- The search path must be relative to a user account. For example:
- '~/ancestors[2]/defaultName'. A tenant provider class is Java class which
- implements the the ITenantProvider interface. For more details please consult
- the installation and configuration guide. -->
- <crn:parameter name="tenantIdMapping">
- <crn:value xsi:type="cfg:tenancyInfo">pattern</crn:value>
- </crn:parameter>
- <!-- tenantBoundingSetMapping: Specifies how the tenant bounding set is determined
- for a user. -->
- <!-- This parameter is used when multitenancy is enabled. The tenant bounding set
- for a user can be determined using a pattern or a tenant bounding set provider
- class. The pattern is a AAA service search path to a property which defines a
- tenant bounding set. The search path must be relative to a user account. For
- example: '˜/parameters/boundingSet'. A tenant bounding set provider class is
- Java class which implements the the IBoundingSetProvider interface. For more
- details please consult the installation and configuration guide. -->
- <crn:parameter name="tenantBoundingSetMapping">
- <crn:value xsi:type="cfg:tenancyInfo">pattern</crn:value>
- </crn:parameter>
- <!-- CookiePath: Specifies the subset of URLs in a domain for which the cookie is
- valid. -->
- <!-- If a cookie successfully passes domain matching, the pathname component of the
- URL is compared to the value of this property. If the values match, the cookie
- is valid. The path "/" is the most general path. -->
- <crn:parameter name="CookiePath">
- <crn:value xsi:type="xsd:string">/</crn:value>
- </crn:parameter>
- <!-- CookieDomain: Specifies the domain for which the cookie is valid. -->
- <!-- The domain attributes of the cookie are compared with the Internet domain
- name of the host from which the URL will be fetched. If the values match, the
- cookie is valid. -->
- <crn:parameter name="CookieDomain">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- CookieSecure: Specifies whether the cookie is sent only to secure servers. -->
- <!-- If this property is set to true, then the cookie will only be sent to HTTPS
- servers. If the property is set to false, the cookie can be sent over unsecured
- channels. -->
- <crn:parameter name="CookieSecure">
- <crn:value xsi:type="xsd:boolean">false</crn:value>
- </crn:parameter>
- </crn:instance>
- <!--
- (End of) Series7 template
- ===============================================================================
- -->
- <!--
- ===============================================================================
- (Begin of) SiteMinder template
- -->
- <crn:instance name="SiteMinder Name" class="SiteMinder">
- <!-- id: Specifies a unique identifier for the authentication namespace. -->
- <!-- Use the namespace identifier to distinguish between multiple namespaces. Each
- namespace must have a unique identifier. When you select a namespace to use for
- authentication in the run-time environment, the identifier is used by the IBM
- Cognos components. Changing the namespace ID after the service has been started
- may invalidate the object security policies and the Cognos group and role
- memberships. The use of the colon in the Namespace ID is not supported. -->
- <crn:parameter name="id">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- advancedProperties: Specifies a set of advanced properties. -->
- <!-- The user needs to provide the name and the value for each advanced property. -->
- <crn:parameter name="advancedProperties">
- <crn:value xsi:type="cfg:array">
- </crn:value>
- </crn:parameter>
- <!-- selectableForAuth: Specifies whether the namespace is selectable for
- authentication. -->
- <!-- If this property is set to true, the namespace will be available for
- authentication in the logon page namespace selection prompt. Set this value to
- false if the namespace should not be available for selection on the logon page.
- -->
- <crn:parameter name="selectableForAuth">
- <crn:value xsi:type="xsd:boolean">true</crn:value>
- </crn:parameter>
- <!-- agentName: Specifies the agent name as registered with the Policy Server. -->
- <!-- This property is case-sensitive. -->
- <crn:parameter name="agentName">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- sharedSecret: Specifies the shared secret registered with the Policy Server
- for this agent. -->
- <!-- This property is case-sensitive. -->
- <crn:parameter name="sharedSecret">
- <crn:value xsi:type="xsd:string" encrypted="false"/>
- </crn:parameter>
- <!-- failOverMode: Specifies whether to use fail over. -->
- <!-- If this property is set to true, when a connection fails, a new connection is
- made to the list of servers in the specified order. Set this value to false to
- access the Policy Servers in a round-robin configuration. -->
- <crn:parameter name="failOverMode">
- <crn:value xsi:type="xsd:boolean">true</crn:value>
- </crn:parameter>
- <crn:instances name="policyServerList">
- <!--
- ===============================================================================
- (Begin of) PolicyServer template
- -->
- <crn:instance name="PolicyServer Name" class="PolicyServer">
- <!-- policyServerHost: Specifies the host name of the Policy Server. -->
- <!-- Ensure that if you use a fully qualified name for your computer that your DNS
- is set up to resolve it. Otherwise, use the IP address. -->
- <crn:parameter name="policyServerHost">
- <crn:value xsi:type="cfg:hostOnly">
- </crn:value>
- </crn:parameter>
- <!-- connMin: Specifies the minimum number of TCP connections. -->
- <!-- Use this property to specify the initial number of TCP connections. -->
- <crn:parameter name="connMin">
- <crn:value xsi:type="xsd:unsignedShort">1</crn:value>
- </crn:parameter>
- <!-- connMax: Specifies the maximum number of TCP connections. -->
- <!-- Use this property to specify the maximum number of TCP connections. -->
- <crn:parameter name="connMax">
- <crn:value xsi:type="xsd:unsignedShort">1</crn:value>
- </crn:parameter>
- <!-- connStep: Specifies the increment by which the number of TCP connections will
- be increased. -->
- <!-- Use this property to specify the number of TCP connections that will be added,
- when necessary. -->
- <crn:parameter name="connStep">
- <crn:value xsi:type="xsd:unsignedShort">1</crn:value>
- </crn:parameter>
- <!-- timeout: Specifies the maximum number of seconds to wait for the agent to get
- a response from the Policy Server. -->
- <!-- Use this property to specify the number of seconds until it is determined that
- the agent cannot reach the Policy Server. -->
- <!-- Units: sec -->
- <crn:parameter name="timeout">
- <crn:value xsi:type="xsd:int">75</crn:value>
- </crn:parameter>
- <!-- authPort: Specifies the authentication port of the SiteMinder Policy Server. -->
- <!-- Use this property to specify the authentication port that the Policy Server
- uses to listen for an agent connection. -->
- <crn:parameter name="authPort">
- <crn:value xsi:type="xsd:unsignedShort">44442</crn:value>
- </crn:parameter>
- <!-- aznPort: Specifies the authorization port of the SiteMinder Policy Server. -->
- <!-- Use this property to specify the authorization port that the Policy Server
- uses to listen for an agent connection. -->
- <crn:parameter name="aznPort">
- <crn:value xsi:type="xsd:unsignedShort">44443</crn:value>
- </crn:parameter>
- <!-- accPort: Specifies the accounting port of the SiteMinder Policy Server. -->
- <!-- Use this property to specify the accounting port that the Policy Server
- listens for an agent connection. -->
- <crn:parameter name="accPort">
- <crn:value xsi:type="xsd:unsignedShort">44441</crn:value>
- </crn:parameter>
- <crn:instances name="userDirectory">
- <!--
- ===============================================================================
- (Begin of) userDirectory template
- -->
- <crn:instance name="userDirectory Name" class="userDirectory">
- <!-- nsID: Specifies a reference to a unique identifier for an authentication
- namespace. -->
- <!-- Use the namespace reference to uniquely identify an authentication namespace. -->
- <crn:parameter name="nsID">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- </crn:instance>
- <!--
- (End of) userDirectory template
- ===============================================================================
- -->
- </crn:instances>
- </crn:instance>
- <!--
- (End of) PolicyServer template
- ===============================================================================
- -->
- </crn:instances>
- </crn:instance>
- <!--
- (End of) SiteMinder template
- ===============================================================================
- -->
- <!--
- ===============================================================================
- (Begin of) TSP_OIDC_ADFS template
- -->
- <crn:instance name="TSP_OIDC_ADFS Name" class="TSP_OIDC_ADFS">
- <!-- identityProviderType: Specifies the implementation of an OpenID Connect
- identity provider. -->
- <crn:parameter name="identityProviderType">
- <crn:value xsi:type="xsd:string">ADFS</crn:value>
- </crn:parameter>
- <!-- id: Specifies a unique identifier for the authentication namespace. -->
- <!-- Use the namespace identifier to distinguish between multiple namespaces. Each
- namespace must have a unique identifier. When you select a namespace to use for
- authentication in the run-time environment, the identifier is used by the IBM
- Cognos components. Changing the namespace ID after the service has been started
- may invalidate the object security policies and the Cognos group and role
- memberships. The use of the colon in the Namespace ID is not supported. -->
- <crn:parameter name="id">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- oidcDiscEndpoint: Specifies the OpenID Connect discovery endpoint -->
- <!-- The discovery endpoint is used to retrieve the OpenID Connect configuration
- that includes the authorization endpoint, token endpoint, jwks endpoint, and
- issuer. -->
- <crn:parameter name="oidcDiscEndpoint">
- <crn:value xsi:type="cfg:anyPathURI">https://{hostname}:443/adfs/.well-known/openid-configuration</crn:value>
- </crn:parameter>
- <!-- clientId: Specifies the OpenID Connect client identifier -->
- <!-- The client identity that is assigned to the application by the OpenID Connect
- identity provider. -->
- <crn:parameter name="clientId">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- clientSecret: Specifies the client secret that is assigned to the application
- by the OpenID Connect identity provider. -->
- <!-- The client secret that is assigned to the application by the OpenID Connect
- identity provider. -->
- <crn:parameter name="clientSecret">
- <crn:value xsi:type="xsd:string" encrypted="false"/>
- </crn:parameter>
- <!-- returnUrl: Return URL that is configured with the OpenID Connect identity
- provider. -->
- <!-- The return URL is invoked by the OpenID Connect identity provider after
- successfully authenticating a user. The URL format is
- https://dispatcherHOST:dispatcherPORT/bi/completeAuth.jsp or
- https://webserverHOST:webserverPORT/ibmcognos/bi/completeAuth.jsp. This URL
- completes Cognos Analytics authentication using the OpenID Connect identity
- provider. -->
- <crn:parameter name="returnUrl">
- <crn:value xsi:type="cfg:anyPathURI">https://host:port/bi/completeAuth.jsp</crn:value>
- </crn:parameter>
- <!-- selectableForAuth: Specifies whether the namespace is selectable for
- authentication. -->
- <!-- If this property is set to true, the namespace will be available for
- authentication in the logon page namespace selection prompt. Set this value to
- false if the namespace should not be available for selection on the logon page.
- -->
- <crn:parameter name="selectableForAuth">
- <crn:value xsi:type="xsd:boolean">true</crn:value>
- </crn:parameter>
- <!-- advancedProperties: Specifies a set of advanced properties. -->
- <!-- The user needs to provide the name and the value for each advanced property. -->
- <crn:parameter name="advancedProperties">
- <crn:value xsi:type="cfg:array">
- </crn:value>
- </crn:parameter>
- <!-- claimName: Specifies the name of the claim that will be provided to the target
- namespace. -->
- <!-- A string that represents the name of the claim from the id_token that will be
- provided to the target namespace. This value must be a single string value in
- the id_token and must exist for all account objects. -->
- <crn:parameter name="claimName">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- trustedEnvName: Specifies the environment variable name that will be used to
- transfer the claim to the target namespace. -->
- <!-- A string that represents the environment variable name that will be used to
- transfer the claim to the target namespace. This value is dependent on the
- target namespace type and corresponds to how the target namespace will obtain
- the user's identity. For example, the LDAP and Active Directory namespace types
- both expect the user's identity to be passed in the REMOTE_USER environment
- variable. -->
- <crn:parameter name="trustedEnvName">
- <crn:value xsi:type="xsd:string">REMOTE_USER</crn:value>
- </crn:parameter>
- <!-- redirectNsID: Specifies the namespace ID that will be invoked with the claim
- obtained from the OpenID identity provider. -->
- <!-- A string that represents the ID of the namespace that will be invoked with the
- claim obtained from the OpenID identity provider. This value must match the
- namespace ID of a configured namespace (e.g., LDAP, AD, etc). -->
- <crn:parameter name="redirectNsID">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- </crn:instance>
- <!--
- (End of) TSP_OIDC_ADFS template
- ===============================================================================
- -->
- <!--
- ===============================================================================
- (Begin of) TSP_OIDC_AzureAD template
- -->
- <crn:instance name="TSP_OIDC_AzureAD Name" class="TSP_OIDC_AzureAD">
- <!-- identityProviderType: Specifies the implementation of an OpenID Connect
- identity provider. -->
- <crn:parameter name="identityProviderType">
- <crn:value xsi:type="xsd:string">AzureAD</crn:value>
- </crn:parameter>
- <!-- id: Specifies a unique identifier for the authentication namespace. -->
- <!-- Use the namespace identifier to distinguish between multiple namespaces. Each
- namespace must have a unique identifier. When you select a namespace to use for
- authentication in the run-time environment, the identifier is used by the IBM
- Cognos components. Changing the namespace ID after the service has been started
- may invalidate the object security policies and the Cognos group and role
- memberships. The use of the colon in the Namespace ID is not supported. -->
- <crn:parameter name="id">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- oidcDiscEndpoint: Specifies the OpenID Connect discovery endpoint -->
- <!-- The discovery endpoint is used to retrieve the OpenID Connect configuration
- that includes the authorization endpoint, token endpoint, jwks endpoint, and
- issuer. -->
- <crn:parameter name="oidcDiscEndpoint">
- <crn:value xsi:type="cfg:anyPathURI">https://login.microsoftonline.com:443/{tenantid}/.well-known/openid-configuration</crn:value>
- </crn:parameter>
- <!-- clientId: Specifies the OpenID Connect client identifier -->
- <!-- The client identity that is assigned to the application by the OpenID Connect
- identity provider. -->
- <crn:parameter name="clientId">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- clientSecret: Specifies the client secret that is assigned to the application
- by the OpenID Connect identity provider. -->
- <!-- The client secret that is assigned to the application by the OpenID Connect
- identity provider. -->
- <crn:parameter name="clientSecret">
- <crn:value xsi:type="xsd:string" encrypted="false"/>
- </crn:parameter>
- <!-- returnUrl: Return URL that is configured with the OpenID Connect identity
- provider. -->
- <!-- The return URL is invoked by the OpenID Connect identity provider after
- successfully authenticating a user. The URL format is
- https://dispatcherHOST:dispatcherPORT/bi/completeAuth.jsp or
- https://webserverHOST:webserverPORT/ibmcognos/bi/completeAuth.jsp. This URL
- completes Cognos Analytics authentication using the OpenID Connect identity
- provider. -->
- <crn:parameter name="returnUrl">
- <crn:value xsi:type="cfg:anyPathURI">https://host:port/bi/completeAuth.jsp</crn:value>
- </crn:parameter>
- <!-- selectableForAuth: Specifies whether the namespace is selectable for
- authentication. -->
- <!-- If this property is set to true, the namespace will be available for
- authentication in the logon page namespace selection prompt. Set this value to
- false if the namespace should not be available for selection on the logon page.
- -->
- <crn:parameter name="selectableForAuth">
- <crn:value xsi:type="xsd:boolean">true</crn:value>
- </crn:parameter>
- <!-- advancedProperties: Specifies a set of advanced properties. -->
- <!-- The user needs to provide the name and the value for each advanced property. -->
- <crn:parameter name="advancedProperties">
- <crn:value xsi:type="cfg:array">
- </crn:value>
- </crn:parameter>
- <!-- claimName: Specifies the name of the claim that will be provided to the target
- namespace. -->
- <!-- A string that represents the name of the claim from the id_token that will be
- provided to the target namespace. This value must be a single string value in
- the id_token and must exist for all account objects. -->
- <crn:parameter name="claimName">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- trustedEnvName: Specifies the environment variable name that will be used to
- transfer the claim to the target namespace. -->
- <!-- A string that represents the environment variable name that will be used to
- transfer the claim to the target namespace. This value is dependent on the
- target namespace type and corresponds to how the target namespace will obtain
- the user's identity. For example, the LDAP and Active Directory namespace types
- both expect the user's identity to be passed in the REMOTE_USER environment
- variable. -->
- <crn:parameter name="trustedEnvName">
- <crn:value xsi:type="xsd:string">REMOTE_USER</crn:value>
- </crn:parameter>
- <!-- redirectNsID: Specifies the namespace ID that will be invoked with the claim
- obtained from the OpenID identity provider. -->
- <!-- A string that represents the ID of the namespace that will be invoked with the
- claim obtained from the OpenID identity provider. This value must match the
- namespace ID of a configured namespace (e.g., LDAP, AD, etc). -->
- <crn:parameter name="redirectNsID">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- </crn:instance>
- <!--
- (End of) TSP_OIDC_AzureAD template
- ===============================================================================
- -->
- <!--
- ===============================================================================
- (Begin of) TSP_OIDC_BlueID template
- -->
- <crn:instance name="TSP_OIDC_BlueID Name" class="TSP_OIDC_BlueID">
- <!-- identityProviderType: Specifies the implementation of an OpenID Connect
- identity provider. -->
- <crn:parameter name="identityProviderType">
- <crn:value xsi:type="xsd:string">IBMid</crn:value>
- </crn:parameter>
- <!-- id: Specifies a unique identifier for the authentication namespace. -->
- <!-- Use the namespace identifier to distinguish between multiple namespaces. Each
- namespace must have a unique identifier. When you select a namespace to use for
- authentication in the run-time environment, the identifier is used by the IBM
- Cognos components. Changing the namespace ID after the service has been started
- may invalidate the object security policies and the Cognos group and role
- memberships. The use of the colon in the Namespace ID is not supported. -->
- <crn:parameter name="id">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- issuer: Specifies the OpenID claim issuer. -->
- <!-- A string that represents the identity provider that issued the claims in the
- ID token. This value must match the value of the 'iss' entry in the ID token
- JSON document. -->
- <crn:parameter name="issuer">
- <crn:value xsi:type="xsd:string">https://idaas.iam.ibm.com</crn:value>
- </crn:parameter>
- <!-- oidcTokenEndpoint: Specifies the OpenID Connect token endpoint -->
- <!-- The token endpoint is used to retrieve the identity token after a successful
- authentication to the OpenID Connect identity provider. -->
- <crn:parameter name="oidcTokenEndpoint">
- <crn:value xsi:type="cfg:anyPathURI">https://idaas.iam.ibm.com:443/idaas/oidc/endpoint/default/token</crn:value>
- </crn:parameter>
- <!-- oidcAuthEndpoint: Specifies the OpenID Connect authorization endpoint. -->
- <!-- The authorization endpoint is a URL that your OpenID Connect identity provider
- uses for authentication. In most cases, the URL should use the https scheme.
- The authorization endpoint is invoked when users authenticate to the OpenID
- Connect identity provider. -->
- <crn:parameter name="oidcAuthEndpoint">
- <crn:value xsi:type="cfg:anyPathURI">https://idaas.iam.ibm.com:443/idaas/oidc/endpoint/default/authorize</crn:value>
- </crn:parameter>
- <!-- clientId: Specifies the OpenID Connect client identifier -->
- <!-- The client identity that is assigned to the application by the OpenID Connect
- identity provider. -->
- <crn:parameter name="clientId">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- clientSecret: Specifies the client secret that is assigned to the application
- by the OpenID Connect identity provider. -->
- <!-- The client secret that is assigned to the application by the OpenID Connect
- identity provider. -->
- <crn:parameter name="clientSecret">
- <crn:value xsi:type="xsd:string" encrypted="false"/>
- </crn:parameter>
- <!-- idpCertificateFile: Specifies the location of the certificate that is used by
- the OpenID Connect identity provider to sign the identity token. -->
- <!-- A path to the file that contains the certificate used by the identity provider
- to sign the JSON Web Token. The path must include the certificate file name and
- be accessible to the running instance of Cognos Analytics. The certificate
- must be in a PEM format, include only the public key certificate, and include
- the begin and end certificate lines. The certificate file cannot be placed in
- the configuration/certs directory. -->
- <crn:parameter name="idpCertificateFile">
- <crn:value xsi:type="cfg:filePath">
- </crn:value>
- </crn:parameter>
- <!-- returnUrl: Return URL that is configured with the OpenID Connect identity
- provider. -->
- <!-- The return URL is invoked by the OpenID Connect identity provider after
- successfully authenticating a user. The URL format is
- https://dispatcherHOST:dispatcherPORT/bi/completeAuth.jsp or
- https://webserverHOST:webserverPORT/ibmcognos/bi/completeAuth.jsp. This URL
- completes Cognos Analytics authentication using the OpenID Connect identity
- provider. -->
- <crn:parameter name="returnUrl">
- <crn:value xsi:type="cfg:anyPathURI">https://host:port/bi/completeAuth.jsp</crn:value>
- </crn:parameter>
- <!-- selectableForAuth: Specifies whether the namespace is selectable for
- authentication. -->
- <!-- If this property is set to true, the namespace will be available for
- authentication in the logon page namespace selection prompt. Set this value to
- false if the namespace should not be available for selection on the logon page.
- -->
- <crn:parameter name="selectableForAuth">
- <crn:value xsi:type="xsd:boolean">true</crn:value>
- </crn:parameter>
- <!-- advancedProperties: Specifies a set of advanced properties. -->
- <!-- The user needs to provide the name and the value for each advanced property. -->
- <crn:parameter name="advancedProperties">
- <crn:value xsi:type="cfg:array">
- </crn:value>
- </crn:parameter>
- <!-- claimName: Specifies the name of the claim that will be provided to the target
- namespace. -->
- <!-- A string that represents the name of the claim from the id_token that will be
- provided to the target namespace. This value must be a single string value in
- the id_token and must exist for all account objects. -->
- <crn:parameter name="claimName">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- trustedEnvName: Specifies the environment variable name that will be used to
- transfer the claim to the target namespace. -->
- <!-- A string that represents the environment variable name that will be used to
- transfer the claim to the target namespace. This value is dependent on the
- target namespace type and corresponds to how the target namespace will obtain
- the user's identity. For example, the LDAP and Active Directory namespace types
- both expect the user's identity to be passed in the REMOTE_USER environment
- variable. -->
- <crn:parameter name="trustedEnvName">
- <crn:value xsi:type="xsd:string">REMOTE_USER</crn:value>
- </crn:parameter>
- <!-- redirectNsID: Specifies the namespace ID that will be invoked with the claim
- obtained from the OpenID identity provider. -->
- <!-- A string that represents the ID of the namespace that will be invoked with the
- claim obtained from the OpenID identity provider. This value must match the
- namespace ID of a configured namespace (e.g., LDAP, AD, etc). -->
- <crn:parameter name="redirectNsID">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- </crn:instance>
- <!--
- (End of) TSP_OIDC_BlueID template
- ===============================================================================
- -->
- <!--
- ===============================================================================
- (Begin of) TSP_OIDC_Generic template
- -->
- <crn:instance name="TSP_OIDC_Generic Name" class="TSP_OIDC_Generic">
- <!-- identityProviderType: Specifies the implementation of an OpenID Connect
- identity provider. -->
- <crn:parameter name="identityProviderType">
- <crn:value xsi:type="xsd:string">Generic</crn:value>
- </crn:parameter>
- <!-- id: Specifies a unique identifier for the authentication namespace. -->
- <!-- Use the namespace identifier to distinguish between multiple namespaces. Each
- namespace must have a unique identifier. When you select a namespace to use for
- authentication in the run-time environment, the identifier is used by the IBM
- Cognos components. Changing the namespace ID after the service has been started
- may invalidate the object security policies and the Cognos group and role
- memberships. The use of the colon in the Namespace ID is not supported. -->
- <crn:parameter name="id">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- selectableForAuth: Specifies whether the namespace is selectable for
- authentication. -->
- <!-- If this property is set to true, the namespace will be available for
- authentication in the logon page namespace selection prompt. Set this value to
- false if the namespace should not be available for selection on the logon page.
- -->
- <crn:parameter name="selectableForAuth">
- <crn:value xsi:type="xsd:boolean">true</crn:value>
- </crn:parameter>
- <!-- claimName: Specifies the name of the claim that will be provided to the target
- namespace. -->
- <!-- A string that represents the name of the claim from the id_token that will be
- provided to the target namespace. This value must be a single string value in
- the id_token and must exist for all account objects. -->
- <crn:parameter name="claimName">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- trustedEnvName: Specifies the environment variable name that will be used to
- transfer the claim to the target namespace. -->
- <!-- A string that represents the environment variable name that will be used to
- transfer the claim to the target namespace. This value is dependent on the
- target namespace type and corresponds to how the target namespace will obtain
- the user's identity. For example, the LDAP and Active Directory namespace types
- both expect the user's identity to be passed in the REMOTE_USER environment
- variable. -->
- <crn:parameter name="trustedEnvName">
- <crn:value xsi:type="xsd:string">REMOTE_USER</crn:value>
- </crn:parameter>
- <!-- redirectNsID: Specifies the namespace ID that will be invoked with the claim
- obtained from the OpenID identity provider. -->
- <!-- A string that represents the ID of the namespace that will be invoked with the
- claim obtained from the OpenID identity provider. This value must match the
- namespace ID of a configured namespace (e.g., LDAP, AD, etc). -->
- <crn:parameter name="redirectNsID">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- advancedProperties: Specifies a set of advanced properties. -->
- <!-- The user needs to provide the name and the value for each advanced property. -->
- <crn:parameter name="advancedProperties">
- <crn:value xsi:type="cfg:array">
- </crn:value>
- </crn:parameter>
- <!-- useDiscoveryEndpoint: Specifies whether the Identity Provider returns a
- discovery document. -->
- <!-- Set this value to true if the Identity Provider supports a discovery document
- endpoint and fill out the discovery endpoint configuration group. Set this
- value to false if the Identity Provider does not support a discovery document
- endpoint and fill out the non-discovery endpoint configuration group. -->
- <crn:parameter name="useDiscoveryEndpoint">
- <crn:value xsi:type="xsd:boolean">true</crn:value>
- </crn:parameter>
- <!-- oidcDiscEndpoint: Specifies the OpenID Connect discovery endpoint -->
- <!-- The discovery endpoint is used to retrieve the OpenID Connect configuration
- that includes the authorization endpoint, token endpoint, jwks endpoint, and
- issuer. -->
- <crn:parameter name="oidcDiscEndpoint">
- <crn:value xsi:type="cfg:anyPathURI">
- </crn:value>
- </crn:parameter>
- <!-- issuer: Specifies the OpenID claim issuer. -->
- <!-- A string that represents the identity provider that issued the claims in the
- ID token. This value must match the value of the 'iss' entry in the ID token
- JSON document. -->
- <crn:parameter name="issuer">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- oidcTokenEndpoint: Specifies the OpenID Connect token endpoint, using the
- following syntax: https://<hostname:port>/<path> -->
- <!-- The token endpoint is used to retrieve the identity token after a successful
- authentication to the OpenID Connect identity provider. -->
- <crn:parameter name="oidcTokenEndpoint">
- <crn:value xsi:type="cfg:anyPathURI">
- </crn:value>
- </crn:parameter>
- <!-- oidcAuthEndpoint: Specifies the OpenID Connect authorization endpoint, using
- the following syntax: https://<hostname:port>/<path> -->
- <!-- The authorization endpoint is a URL that your OpenID Connect identity provider
- uses for authentication. In most cases, the URL should use the https scheme.
- The authorization endpoint is invoked when users authenticate to the OpenID
- Connect identity provider. -->
- <crn:parameter name="oidcAuthEndpoint">
- <crn:value xsi:type="cfg:anyPathURI">
- </crn:value>
- </crn:parameter>
- <!-- clientId: Specifies the OpenID Connect client identifier -->
- <!-- The client identity that is assigned to the application by the OpenID Connect
- identity provider. -->
- <crn:parameter name="clientId">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- returnUrl: Return URL that is configured with the OpenID Connect identity
- provider. -->
- <!-- The return URL is invoked by the OpenID Connect identity provider after
- successfully authenticating a user. The URL format is
- https://dispatcherHOST:dispatcherPORT/bi/completeAuth.jsp or
- https://webserverHOST:webserverPORT/ibmcognos/bi/completeAuth.jsp. This URL
- completes Cognos Analytics authentication using the OpenID Connect identity
- provider. -->
- <crn:parameter name="returnUrl">
- <crn:value xsi:type="cfg:anyPathURI">https://host:port/bi/completeAuth.jsp</crn:value>
- </crn:parameter>
- <!-- authScope: Specifies the scope parameter values provided to the authorize
- endpoint. -->
- <!-- The scope parameter values that will be added to the authorize endpoint URL
- for authentication. At a minimum, 'openid' must be included in the list of
- possible scope values. -->
- <crn:parameter name="authScope">
- <crn:value xsi:type="xsd:string">openid</crn:value>
- </crn:parameter>
- <!-- accountClaims: Specifies if the id_token contains all of the account claims. -->
- <!-- Set this value to token if the id_token contains all of the user claims. Set
- this value to userinfo if an additional call should be made to the userinfo
- endpoint in order to retrieve any user claims that are not part of the
- id_token. -->
- <crn:parameter name="accountClaims">
- <crn:value xsi:type="xsd:string">token</crn:value>
- </crn:parameter>
- <!-- tokenEndpointAuth: Specifies how to authenticate to the Identity Provider when
- invoking the token endpoint. -->
- <!-- Use client secret post if the client id and client secret should be
- transmitted in the request body. Use client secret basic if the client id and
- client secret should be transmitted in the HTTP header. Use private key JWT if
- the client id and a JWT client_assertion that is signed with a private key
- should be transmitted in the request body. -->
- <crn:parameter name="tokenEndpointAuth">
- <crn:value xsi:type="xsd:string">client_secret_post</crn:value>
- </crn:parameter>
- <!-- clientSecret: Specifies the client secret that is assigned to the application
- by the OpenID Connect identity provider. -->
- <!-- The client secret that is assigned to the application by the OpenID Connect
- identity provider. -->
- <crn:parameter name="clientSecret">
- <crn:value xsi:type="xsd:string" encrypted="false"/>
- </crn:parameter>
- <!-- privateKeyFile: Specifies the file that contains the private signing key. -->
- <!-- The file that contains the private signing key in PKCS8 format. It must
- contain a single private RSA key of length 2048 bits. -->
- <crn:parameter name="privateKeyFile">
- <crn:value xsi:type="cfg:filePath">
- </crn:value>
- </crn:parameter>
- <!-- privateKeyPassword: Specifies the private key password used to protect the
- private signing key. -->
- <!-- This password is required to secure the private key. It provides an extra
- layer of security by encrypted the private key file using a password. -->
- <crn:parameter name="privateKeyPassword">
- <crn:value xsi:type="xsd:string" encrypted="false"/>
- </crn:parameter>
- <!-- privateKeyId: Specifies the key identifier that should be placed in the JWT
- header. -->
- <!-- The key identifier that will be set in the JWT 'kid' header. Use this
- configuration item if your identity provider requires a 'kid'. Leave this value
- blank if your identity provider does not require a 'kid'. -->
- <crn:parameter name="privateKeyId">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- keyLocation: Specifies the location of the signing public key or certificate. -->
- <!-- Set this value to 'File' if the signing certificate is manually downloaded
- from the Identity Provider as a certificate and placed on the file system. Set
- this value to 'JWKS endpoint' if the Identity Provider supports an endpoint for
- retrieving id_token signature keys. Note: if the Identity Provider does not
- support a discovery document but provides public keys via a JWKS endpoint, then
- the JWKS Endpoint must contain a valid URI for retrieving the public keys. -->
- <crn:parameter name="keyLocation">
- <crn:value xsi:type="xsd:string">jwks_uri</crn:value>
- </crn:parameter>
- <!-- idpCertificateFile: Specifies the location of the certificate that is used by
- the OpenID Connect identity provider to sign the identity token. -->
- <!-- A path to the file that contains the certificate used by the identity provider
- to sign the JSON Web Token. The path must include the certificate file name and
- be accessible to the running instance of Cognos Analytics. The certificate
- must be in a PEM format, include only the public key certificate, and include
- the begin and end certificate lines. The certificate file cannot be placed in
- the configuration/certs directory. -->
- <crn:parameter name="idpCertificateFile">
- <crn:value xsi:type="cfg:filePath">
- </crn:value>
- </crn:parameter>
- <!-- jwksEndpoint: Specifies the OpenID Connect endpoint for retrieving JWT signing
- keys. -->
- <!-- The JWKS endpoint is a URL that your OpenID Connect identity provider uses to
- provide signing key data. In most cases, the URL should use the https scheme.
- The JWKS endpoint is invoked when validating an id_token returned from the
- identity provider. -->
- <crn:parameter name="jwksEndpoint">
- <crn:value xsi:type="cfg:anyPathURI">
- </crn:value>
- </crn:parameter>
- <!-- pgStrategy: Specifies how to get the user's identity when using the password
- grant flow. -->
- <!-- Set this value to 'ID token' if all user claims are returned in the id_token.
- Set this value to 'ID token and userinfo endpoint' if an id_token is returned
- from the password grant flow but does not contain all of the user claims. Set
- this value to 'Userinfo endpoint' if the id_token does not contain any user
- claims and if the user claims should be retrieved from the userinfo endpoint.
- Set this value to 'Unsupported' if the Identity Provider does not support the
- password grant flow. -->
- <crn:parameter name="pgStrategy">
- <crn:value xsi:type="xsd:string">idToken</crn:value>
- </crn:parameter>
- <!-- pgInclScope: Specifies that the scope should be included when using the
- password grant flow. -->
- <!-- Set this value to true to indicate that the scope parameter should be included
- as part of the query string for the password grant flow. Set this value to
- false to indicate that the scope should be omitted from the query string for
- the password grant flow. -->
- <crn:parameter name="pgInclScope">
- <crn:value xsi:type="xsd:boolean">true</crn:value>
- </crn:parameter>
- <!-- pgAddParams: Specifies any additional parameters that are required for the
- password grant flow. -->
- <!-- Set this value to reflect any additional parameters that should be included as
- part of the query string for the password grant flow. The parameter must begin
- with an '&&' and must be urlencoded so that it can be safely inserted into the
- query string. For example, if the 'resource=https://ca.ibm.com' parameter is
- required in the query string, it must be entered as:
- '&resource=https%3A%2F%2Fca.ibm.com'. -->
- <crn:parameter name="pgAddParams">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- tcStrategy: Specifies the information that should be stored for scheduling
- jobs. -->
- <!-- Set this value to 'Credentials' if the Identity Provider supports the password
- grant and returns a valid id_token that contains all of the user claims in the
- response. Set this value to 'Credentials and ID token' if the Identity Provider
- supports the password grant flow but does not return a valid id_token in the
- response or if the id_token does not contain all of the user claims. Set this
- value to 'Refresh token' if the Identity Provider supports the refresh token
- flow, provides a non-expiring refresh token, and returns a valid id_token that
- contains all of the user claims from the refresh token flow. Set this value to
- 'ID token only' if the Identity Provider does not support the password grant
- nor refresh token flows (Note: when set to 'ID token only', it will not be
- possible to verify that the user is still exists and is enabled in the Identity
- Provider). -->
- <crn:parameter name="tcStrategy">
- <crn:value xsi:type="xsd:string">credentials</crn:value>
- </crn:parameter>
- <!-- tcAccountClaims: Specifies if the id_token contains all of the account claims.
- -->
- <!-- Set this value to 'ID token' if the id_token returned from the token endpoint
- contains all of the user claims. Set this value to 'Userinfo endpoint' if an
- additional call to the userinfo endpoint is required in order to obtain all of
- the user claims. -->
- <crn:parameter name="tcAccountClaims">
- <crn:value xsi:type="xsd:string">id_token</crn:value>
- </crn:parameter>
- </crn:instance>
- <!--
- (End of) TSP_OIDC_Generic template
- ===============================================================================
- -->
- <!--
- ===============================================================================
- (Begin of) TSP_OIDC_Google template
- -->
- <crn:instance name="TSP_OIDC_Google Name" class="TSP_OIDC_Google">
- <!-- identityProviderType: Specifies the implementation of an OpenID Connect
- identity provider. -->
- <crn:parameter name="identityProviderType">
- <crn:value xsi:type="xsd:string">Google</crn:value>
- </crn:parameter>
- <!-- id: Specifies a unique identifier for the authentication namespace. -->
- <!-- Use the namespace identifier to distinguish between multiple namespaces. Each
- namespace must have a unique identifier. When you select a namespace to use for
- authentication in the run-time environment, the identifier is used by the IBM
- Cognos components. Changing the namespace ID after the service has been started
- may invalidate the object security policies and the Cognos group and role
- memberships. The use of the colon in the Namespace ID is not supported. -->
- <crn:parameter name="id">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- oidcDiscEndpoint: Specifies the OpenID Connect discovery endpoint -->
- <!-- The discovery endpoint is used to retrieve the OpenID Connect configuration
- that includes the authorization endpoint, token endpoint, jwks endpoint, and
- issuer. -->
- <crn:parameter name="oidcDiscEndpoint">
- <crn:value xsi:type="cfg:anyPathURI">https://accounts.google.com:443/.well-known/openid-configuration</crn:value>
- </crn:parameter>
- <!-- clientId: Specifies the OpenID Connect client identifier -->
- <!-- The client identity that is assigned to the application by the OpenID Connect
- identity provider. -->
- <crn:parameter name="clientId">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- clientSecret: Specifies the client secret that is assigned to the application
- by the OpenID Connect identity provider. -->
- <!-- The client secret that is assigned to the application by the OpenID Connect
- identity provider. -->
- <crn:parameter name="clientSecret">
- <crn:value xsi:type="xsd:string" encrypted="false"/>
- </crn:parameter>
- <!-- returnUrl: Return URL that is configured with the OpenID Connect identity
- provider. -->
- <!-- The return URL is invoked by the OpenID Connect identity provider after
- successfully authenticating a user. The URL format is
- https://dispatcherHOST:dispatcherPORT/bi/completeAuth.jsp or
- https://webserverHOST:webserverPORT/ibmcognos/bi/completeAuth.jsp. This URL
- completes Cognos Analytics authentication using the OpenID Connect identity
- provider. -->
- <crn:parameter name="returnUrl">
- <crn:value xsi:type="cfg:anyPathURI">https://host:port/bi/completeAuth.jsp</crn:value>
- </crn:parameter>
- <!-- selectableForAuth: Specifies whether the namespace is selectable for
- authentication. -->
- <!-- If this property is set to true, the namespace will be available for
- authentication in the logon page namespace selection prompt. Set this value to
- false if the namespace should not be available for selection on the logon page.
- -->
- <crn:parameter name="selectableForAuth">
- <crn:value xsi:type="xsd:boolean">true</crn:value>
- </crn:parameter>
- <!-- advancedProperties: Specifies a set of advanced properties. -->
- <!-- The user needs to provide the name and the value for each advanced property. -->
- <crn:parameter name="advancedProperties">
- <crn:value xsi:type="cfg:array">
- </crn:value>
- </crn:parameter>
- <!-- claimName: Specifies the name of the claim that will be provided to the target
- namespace. -->
- <!-- A string that represents the name of the claim from the id_token that will be
- provided to the target namespace. This value must be a single string value in
- the id_token and must exist for all account objects. -->
- <crn:parameter name="claimName">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- trustedEnvName: Specifies the environment variable name that will be used to
- transfer the claim to the target namespace. -->
- <!-- A string that represents the environment variable name that will be used to
- transfer the claim to the target namespace. This value is dependent on the
- target namespace type and corresponds to how the target namespace will obtain
- the user's identity. For example, the LDAP and Active Directory namespace types
- both expect the user's identity to be passed in the REMOTE_USER environment
- variable. -->
- <crn:parameter name="trustedEnvName">
- <crn:value xsi:type="xsd:string">REMOTE_USER</crn:value>
- </crn:parameter>
- <!-- redirectNsID: Specifies the namespace ID that will be invoked with the claim
- obtained from the OpenID identity provider. -->
- <!-- A string that represents the ID of the namespace that will be invoked with the
- claim obtained from the OpenID identity provider. This value must match the
- namespace ID of a configured namespace (e.g., LDAP, AD, etc). -->
- <crn:parameter name="redirectNsID">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- </crn:instance>
- <!--
- (End of) TSP_OIDC_Google template
- ===============================================================================
- -->
- <!--
- ===============================================================================
- (Begin of) TSP_OIDC_IBMCloudId template
- -->
- <crn:instance name="TSP_OIDC_IBMCloudId Name" class="TSP_OIDC_IBMCloudId">
- <!-- identityProviderType: Specifies the implementation of an OpenID Connect
- identity provider. -->
- <crn:parameter name="identityProviderType">
- <crn:value xsi:type="xsd:string">IBMCloudId</crn:value>
- </crn:parameter>
- <!-- id: Specifies a unique identifier for the authentication namespace. -->
- <!-- Use the namespace identifier to distinguish between multiple namespaces. Each
- namespace must have a unique identifier. When you select a namespace to use for
- authentication in the run-time environment, the identifier is used by the IBM
- Cognos components. Changing the namespace ID after the service has been started
- may invalidate the object security policies and the Cognos group and role
- memberships. The use of the colon in the Namespace ID is not supported. -->
- <crn:parameter name="id">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- oidcDiscEndpoint: Specifies the OpenID Connect discovery endpoint -->
- <!-- The discovery endpoint is used to retrieve the OpenID Connect configuration
- that includes the authorization endpoint, token endpoint, jwks endpoint, and
- issuer. -->
- <crn:parameter name="oidcDiscEndpoint">
- <crn:value xsi:type="cfg:anyPathURI">https://login.ibm.com:443/oidc/endpoint/default/.well-known/openid-configuration</crn:value>
- </crn:parameter>
- <!-- clientId: Specifies the OpenID Connect client identifier -->
- <!-- The client identity that is assigned to the application by the OpenID Connect
- identity provider. -->
- <crn:parameter name="clientId">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- clientSecret: Specifies the client secret that is assigned to the application
- by the OpenID Connect identity provider. -->
- <!-- The client secret that is assigned to the application by the OpenID Connect
- identity provider. -->
- <crn:parameter name="clientSecret">
- <crn:value xsi:type="xsd:string" encrypted="false"/>
- </crn:parameter>
- <!-- returnUrl: Return URL that is configured with the OpenID Connect identity
- provider. -->
- <!-- The return URL is invoked by the OpenID Connect identity provider after
- successfully authenticating a user. The URL format is
- https://dispatcherHOST:dispatcherPORT/bi/completeAuth.jsp or
- https://webserverHOST:webserverPORT/ibmcognos/bi/completeAuth.jsp. This URL
- completes Cognos Analytics authentication using the OpenID Connect identity
- provider. -->
- <crn:parameter name="returnUrl">
- <crn:value xsi:type="cfg:anyPathURI">https://host:port/bi/completeAuth.jsp</crn:value>
- </crn:parameter>
- <!-- selectableForAuth: Specifies whether the namespace is selectable for
- authentication. -->
- <!-- If this property is set to true, the namespace will be available for
- authentication in the logon page namespace selection prompt. Set this value to
- false if the namespace should not be available for selection on the logon page.
- -->
- <crn:parameter name="selectableForAuth">
- <crn:value xsi:type="xsd:boolean">true</crn:value>
- </crn:parameter>
- <!-- advancedProperties: Specifies a set of advanced properties. -->
- <!-- The user needs to provide the name and the value for each advanced property. -->
- <crn:parameter name="advancedProperties">
- <crn:value xsi:type="cfg:array">
- </crn:value>
- </crn:parameter>
- <!-- claimName: Specifies the name of the claim that will be provided to the target
- namespace. -->
- <!-- A string that represents the name of the claim from the id_token that will be
- provided to the target namespace. This value must be a single string value in
- the id_token and must exist for all account objects. -->
- <crn:parameter name="claimName">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- trustedEnvName: Specifies the environment variable name that will be used to
- transfer the claim to the target namespace. -->
- <!-- A string that represents the environment variable name that will be used to
- transfer the claim to the target namespace. This value is dependent on the
- target namespace type and corresponds to how the target namespace will obtain
- the user's identity. For example, the LDAP and Active Directory namespace types
- both expect the user's identity to be passed in the REMOTE_USER environment
- variable. -->
- <crn:parameter name="trustedEnvName">
- <crn:value xsi:type="xsd:string">REMOTE_USER</crn:value>
- </crn:parameter>
- <!-- redirectNsID: Specifies the namespace ID that will be invoked with the claim
- obtained from the OpenID identity provider. -->
- <!-- A string that represents the ID of the namespace that will be invoked with the
- claim obtained from the OpenID identity provider. This value must match the
- namespace ID of a configured namespace (e.g., LDAP, AD, etc). -->
- <crn:parameter name="redirectNsID">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- </crn:instance>
- <!--
- (End of) TSP_OIDC_IBMCloudId template
- ===============================================================================
- -->
- <!--
- ===============================================================================
- (Begin of) TSP_OIDC_MSIdentity template
- -->
- <crn:instance name="TSP_OIDC_MSIdentity Name" class="TSP_OIDC_MSIdentity">
- <!-- identityProviderType: Specifies the implementation of an OpenID Connect
- identity provider. -->
- <crn:parameter name="identityProviderType">
- <crn:value xsi:type="xsd:string">MSIdentity</crn:value>
- </crn:parameter>
- <!-- id: Specifies a unique identifier for the authentication namespace. -->
- <!-- Use the namespace identifier to distinguish between multiple namespaces. Each
- namespace must have a unique identifier. When you select a namespace to use for
- authentication in the run-time environment, the identifier is used by the IBM
- Cognos components. Changing the namespace ID after the service has been started
- may invalidate the object security policies and the Cognos group and role
- memberships. The use of the colon in the Namespace ID is not supported. -->
- <crn:parameter name="id">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- oidcDiscEndpoint: Specifies the OpenID Connect discovery endpoint -->
- <!-- The discovery endpoint is used to retrieve the OpenID Connect configuration
- that includes the authorization endpoint, token endpoint, jwks endpoint, and
- issuer. -->
- <crn:parameter name="oidcDiscEndpoint">
- <crn:value xsi:type="cfg:anyPathURI">https://login.microsoftonline.com:443/{tenantid}/v2.0/.well-known/openid-configuration</crn:value>
- </crn:parameter>
- <!-- clientId: Specifies the OpenID Connect client identifier -->
- <!-- The client identity that is assigned to the application by the OpenID Connect
- identity provider. -->
- <crn:parameter name="clientId">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- clientSecret: Specifies the client secret that is assigned to the application
- by the OpenID Connect identity provider. -->
- <!-- The client secret that is assigned to the application by the OpenID Connect
- identity provider. -->
- <crn:parameter name="clientSecret">
- <crn:value xsi:type="xsd:string" encrypted="false"/>
- </crn:parameter>
- <!-- returnUrl: Return URL that is configured with the OpenID Connect identity
- provider. -->
- <!-- The return URL is invoked by the OpenID Connect identity provider after
- successfully authenticating a user. The URL format is
- https://dispatcherHOST:dispatcherPORT/bi/completeAuth.jsp or
- https://webserverHOST:webserverPORT/ibmcognos/bi/completeAuth.jsp. This URL
- completes Cognos Analytics authentication using the OpenID Connect identity
- provider. -->
- <crn:parameter name="returnUrl">
- <crn:value xsi:type="cfg:anyPathURI">https://host:port/bi/completeAuth.jsp</crn:value>
- </crn:parameter>
- <!-- selectableForAuth: Specifies whether the namespace is selectable for
- authentication. -->
- <!-- If this property is set to true, the namespace will be available for
- authentication in the logon page namespace selection prompt. Set this value to
- false if the namespace should not be available for selection on the logon page.
- -->
- <crn:parameter name="selectableForAuth">
- <crn:value xsi:type="xsd:boolean">true</crn:value>
- </crn:parameter>
- <!-- advancedProperties: Specifies a set of advanced properties. -->
- <!-- The user needs to provide the name and the value for each advanced property. -->
- <crn:parameter name="advancedProperties">
- <crn:value xsi:type="cfg:array">
- </crn:value>
- </crn:parameter>
- <!-- claimName: Specifies the name of the claim that will be provided to the target
- namespace. -->
- <!-- A string that represents the name of the claim from the id_token that will be
- provided to the target namespace. This value must be a single string value in
- the id_token and must exist for all account objects. -->
- <crn:parameter name="claimName">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- trustedEnvName: Specifies the environment variable name that will be used to
- transfer the claim to the target namespace. -->
- <!-- A string that represents the environment variable name that will be used to
- transfer the claim to the target namespace. This value is dependent on the
- target namespace type and corresponds to how the target namespace will obtain
- the user's identity. For example, the LDAP and Active Directory namespace types
- both expect the user's identity to be passed in the REMOTE_USER environment
- variable. -->
- <crn:parameter name="trustedEnvName">
- <crn:value xsi:type="xsd:string">REMOTE_USER</crn:value>
- </crn:parameter>
- <!-- redirectNsID: Specifies the namespace ID that will be invoked with the claim
- obtained from the OpenID identity provider. -->
- <!-- A string that represents the ID of the namespace that will be invoked with the
- claim obtained from the OpenID identity provider. This value must match the
- namespace ID of a configured namespace (e.g., LDAP, AD, etc). -->
- <crn:parameter name="redirectNsID">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- </crn:instance>
- <!--
- (End of) TSP_OIDC_MSIdentity template
- ===============================================================================
- -->
- <!--
- ===============================================================================
- (Begin of) TSP_OIDC_OKTA template
- -->
- <crn:instance name="TSP_OIDC_OKTA Name" class="TSP_OIDC_OKTA">
- <!-- identityProviderType: Specifies the implementation of an OpenID Connect
- identity provider. -->
- <crn:parameter name="identityProviderType">
- <crn:value xsi:type="xsd:string">OKTA</crn:value>
- </crn:parameter>
- <!-- id: Specifies a unique identifier for the authentication namespace. -->
- <!-- Use the namespace identifier to distinguish between multiple namespaces. Each
- namespace must have a unique identifier. When you select a namespace to use for
- authentication in the run-time environment, the identifier is used by the IBM
- Cognos components. Changing the namespace ID after the service has been started
- may invalidate the object security policies and the Cognos group and role
- memberships. The use of the colon in the Namespace ID is not supported. -->
- <crn:parameter name="id">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- oidcDiscEndpoint: Specifies the OpenID Connect discovery endpoint -->
- <!-- The discovery endpoint is used to retrieve the OpenID Connect configuration
- that includes the authorization endpoint, token endpoint, jwks endpoint, and
- issuer. -->
- <crn:parameter name="oidcDiscEndpoint">
- <crn:value xsi:type="cfg:anyPathURI">https://{hostname}:443/.well-known/openid-configuration</crn:value>
- </crn:parameter>
- <!-- clientId: Specifies the OpenID Connect client identifier -->
- <!-- The client identity that is assigned to the application by the OpenID Connect
- identity provider. -->
- <crn:parameter name="clientId">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- clientSecret: Specifies the client secret that is assigned to the application
- by the OpenID Connect identity provider. -->
- <!-- The client secret that is assigned to the application by the OpenID Connect
- identity provider. -->
- <crn:parameter name="clientSecret">
- <crn:value xsi:type="xsd:string" encrypted="false"/>
- </crn:parameter>
- <!-- returnUrl: Return URL that is configured with the OpenID Connect identity
- provider. -->
- <!-- The return URL is invoked by the OpenID Connect identity provider after
- successfully authenticating a user. The URL format is
- https://dispatcherHOST:dispatcherPORT/bi/completeAuth.jsp or
- https://webserverHOST:webserverPORT/ibmcognos/bi/completeAuth.jsp. This URL
- completes Cognos Analytics authentication using the OpenID Connect identity
- provider. -->
- <crn:parameter name="returnUrl">
- <crn:value xsi:type="cfg:anyPathURI">https://host:port/bi/completeAuth.jsp</crn:value>
- </crn:parameter>
- <!-- selectableForAuth: Specifies whether the namespace is selectable for
- authentication. -->
- <!-- If this property is set to true, the namespace will be available for
- authentication in the logon page namespace selection prompt. Set this value to
- false if the namespace should not be available for selection on the logon page.
- -->
- <crn:parameter name="selectableForAuth">
- <crn:value xsi:type="xsd:boolean">true</crn:value>
- </crn:parameter>
- <!-- advancedProperties: Specifies a set of advanced properties. -->
- <!-- The user needs to provide the name and the value for each advanced property. -->
- <crn:parameter name="advancedProperties">
- <crn:value xsi:type="cfg:array">
- </crn:value>
- </crn:parameter>
- <!-- claimName: Specifies the name of the claim that will be provided to the target
- namespace. -->
- <!-- A string that represents the name of the claim from the id_token that will be
- provided to the target namespace. This value must be a single string value in
- the id_token and must exist for all account objects. -->
- <crn:parameter name="claimName">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- trustedEnvName: Specifies the environment variable name that will be used to
- transfer the claim to the target namespace. -->
- <!-- A string that represents the environment variable name that will be used to
- transfer the claim to the target namespace. This value is dependent on the
- target namespace type and corresponds to how the target namespace will obtain
- the user's identity. For example, the LDAP and Active Directory namespace types
- both expect the user's identity to be passed in the REMOTE_USER environment
- variable. -->
- <crn:parameter name="trustedEnvName">
- <crn:value xsi:type="xsd:string">REMOTE_USER</crn:value>
- </crn:parameter>
- <!-- redirectNsID: Specifies the namespace ID that will be invoked with the claim
- obtained from the OpenID identity provider. -->
- <!-- A string that represents the ID of the namespace that will be invoked with the
- claim obtained from the OpenID identity provider. This value must match the
- namespace ID of a configured namespace (e.g., LDAP, AD, etc). -->
- <crn:parameter name="redirectNsID">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- </crn:instance>
- <!--
- (End of) TSP_OIDC_OKTA template
- ===============================================================================
- -->
- <!--
- ===============================================================================
- (Begin of) TSP_OIDC_Ping template
- -->
- <crn:instance name="TSP_OIDC_Ping Name" class="TSP_OIDC_Ping">
- <!-- identityProviderType: Specifies the implementation of an OpenID Connect
- identity provider. -->
- <crn:parameter name="identityProviderType">
- <crn:value xsi:type="xsd:string">Ping</crn:value>
- </crn:parameter>
- <!-- id: Specifies a unique identifier for the authentication namespace. -->
- <!-- Use the namespace identifier to distinguish between multiple namespaces. Each
- namespace must have a unique identifier. When you select a namespace to use for
- authentication in the run-time environment, the identifier is used by the IBM
- Cognos components. Changing the namespace ID after the service has been started
- may invalidate the object security policies and the Cognos group and role
- memberships. The use of the colon in the Namespace ID is not supported. -->
- <crn:parameter name="id">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- oidcDiscEndpoint: Specifies the OpenID Connect discovery endpoint -->
- <!-- The discovery endpoint is used to retrieve the OpenID Connect configuration
- that includes the authorization endpoint, token endpoint, jwks endpoint, and
- issuer. -->
- <crn:parameter name="oidcDiscEndpoint">
- <crn:value xsi:type="cfg:anyPathURI">https://pingfederatehost:port/.well-known/openid-configuration</crn:value>
- </crn:parameter>
- <!-- clientId: Specifies the OpenID Connect client identifier -->
- <!-- The client identity that is assigned to the application by the OpenID Connect
- identity provider. -->
- <crn:parameter name="clientId">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- clientSecret: Specifies the client secret that is assigned to the application
- by the OpenID Connect identity provider. -->
- <!-- The client secret that is assigned to the application by the OpenID Connect
- identity provider. -->
- <crn:parameter name="clientSecret">
- <crn:value xsi:type="xsd:string" encrypted="false"/>
- </crn:parameter>
- <!-- returnUrl: Return URL that is configured with the OpenID Connect identity
- provider. -->
- <!-- The return URL is invoked by the OpenID Connect identity provider after
- successfully authenticating a user. The URL format is
- https://dispatcherHOST:dispatcherPORT/bi/completeAuth.jsp or
- https://webserverHOST:webserverPORT/ibmcognos/bi/completeAuth.jsp. This URL
- completes Cognos Analytics authentication using the OpenID Connect identity
- provider. -->
- <crn:parameter name="returnUrl">
- <crn:value xsi:type="cfg:anyPathURI">https://host:port/bi/completeAuth.jsp</crn:value>
- </crn:parameter>
- <!-- selectableForAuth: Specifies whether the namespace is selectable for
- authentication. -->
- <!-- If this property is set to true, the namespace will be available for
- authentication in the logon page namespace selection prompt. Set this value to
- false if the namespace should not be available for selection on the logon page.
- -->
- <crn:parameter name="selectableForAuth">
- <crn:value xsi:type="xsd:boolean">true</crn:value>
- </crn:parameter>
- <!-- advancedProperties: Specifies a set of advanced properties. -->
- <!-- The user needs to provide the name and the value for each advanced property. -->
- <crn:parameter name="advancedProperties">
- <crn:value xsi:type="cfg:array">
- </crn:value>
- </crn:parameter>
- <!-- claimName: Specifies the name of the claim that will be provided to the target
- namespace. -->
- <!-- A string that represents the name of the claim from the id_token that will be
- provided to the target namespace. This value must be a single string value in
- the id_token and must exist for all account objects. -->
- <crn:parameter name="claimName">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- trustedEnvName: Specifies the environment variable name that will be used to
- transfer the claim to the target namespace. -->
- <!-- A string that represents the environment variable name that will be used to
- transfer the claim to the target namespace. This value is dependent on the
- target namespace type and corresponds to how the target namespace will obtain
- the user's identity. For example, the LDAP and Active Directory namespace types
- both expect the user's identity to be passed in the REMOTE_USER environment
- variable. -->
- <crn:parameter name="trustedEnvName">
- <crn:value xsi:type="xsd:string">REMOTE_USER</crn:value>
- </crn:parameter>
- <!-- redirectNsID: Specifies the namespace ID that will be invoked with the claim
- obtained from the OpenID identity provider. -->
- <!-- A string that represents the ID of the namespace that will be invoked with the
- claim obtained from the OpenID identity provider. This value must match the
- namespace ID of a configured namespace (e.g., LDAP, AD, etc). -->
- <crn:parameter name="redirectNsID">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- </crn:instance>
- <!--
- (End of) TSP_OIDC_Ping template
- ===============================================================================
- -->
- <!--
- ===============================================================================
- (Begin of) TSP_OIDC_SalesForce template
- -->
- <crn:instance name="TSP_OIDC_SalesForce Name" class="TSP_OIDC_SalesForce">
- <!-- identityProviderType: Specifies the implementation of an OpenID Connect
- identity provider. -->
- <crn:parameter name="identityProviderType">
- <crn:value xsi:type="xsd:string">SalesForce</crn:value>
- </crn:parameter>
- <!-- id: Specifies a unique identifier for the authentication namespace. -->
- <!-- Use the namespace identifier to distinguish between multiple namespaces. Each
- namespace must have a unique identifier. When you select a namespace to use for
- authentication in the run-time environment, the identifier is used by the IBM
- Cognos components. Changing the namespace ID after the service has been started
- may invalidate the object security policies and the Cognos group and role
- memberships. The use of the colon in the Namespace ID is not supported. -->
- <crn:parameter name="id">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- oidcDiscEndpoint: Specifies the OpenID Connect discovery endpoint -->
- <!-- The discovery endpoint is used to retrieve the OpenID Connect configuration
- that includes the authorization endpoint, token endpoint, jwks endpoint, and
- issuer. -->
- <crn:parameter name="oidcDiscEndpoint">
- <crn:value xsi:type="cfg:anyPathURI">https://login.salesforce.com:443/.well-known/openid-configuration</crn:value>
- </crn:parameter>
- <!-- clientId: Specifies the OpenID Connect client identifier -->
- <!-- The client identity that is assigned to the application by the OpenID Connect
- identity provider. -->
- <crn:parameter name="clientId">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- clientSecret: Specifies the client secret that is assigned to the application
- by the OpenID Connect identity provider. -->
- <!-- The client secret that is assigned to the application by the OpenID Connect
- identity provider. -->
- <crn:parameter name="clientSecret">
- <crn:value xsi:type="xsd:string" encrypted="false"/>
- </crn:parameter>
- <!-- returnUrl: Return URL that is configured with the OpenID Connect identity
- provider. -->
- <!-- The return URL is invoked by the OpenID Connect identity provider after
- successfully authenticating a user. The URL format is
- https://dispatcherHOST:dispatcherPORT/bi/completeAuth.jsp or
- https://webserverHOST:webserverPORT/ibmcognos/bi/completeAuth.jsp. This URL
- completes Cognos Analytics authentication using the OpenID Connect identity
- provider. -->
- <crn:parameter name="returnUrl">
- <crn:value xsi:type="cfg:anyPathURI">https://host:port/bi/completeAuth.jsp</crn:value>
- </crn:parameter>
- <!-- selectableForAuth: Specifies whether the namespace is selectable for
- authentication. -->
- <!-- If this property is set to true, the namespace will be available for
- authentication in the logon page namespace selection prompt. Set this value to
- false if the namespace should not be available for selection on the logon page.
- -->
- <crn:parameter name="selectableForAuth">
- <crn:value xsi:type="xsd:boolean">true</crn:value>
- </crn:parameter>
- <!-- advancedProperties: Specifies a set of advanced properties. -->
- <!-- The user needs to provide the name and the value for each advanced property. -->
- <crn:parameter name="advancedProperties">
- <crn:value xsi:type="cfg:array">
- </crn:value>
- </crn:parameter>
- <!-- claimName: Specifies the name of the claim that will be provided to the target
- namespace. -->
- <!-- A string that represents the name of the claim from the id_token that will be
- provided to the target namespace. This value must be a single string value in
- the id_token and must exist for all account objects. -->
- <crn:parameter name="claimName">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- trustedEnvName: Specifies the environment variable name that will be used to
- transfer the claim to the target namespace. -->
- <!-- A string that represents the environment variable name that will be used to
- transfer the claim to the target namespace. This value is dependent on the
- target namespace type and corresponds to how the target namespace will obtain
- the user's identity. For example, the LDAP and Active Directory namespace types
- both expect the user's identity to be passed in the REMOTE_USER environment
- variable. -->
- <crn:parameter name="trustedEnvName">
- <crn:value xsi:type="xsd:string">REMOTE_USER</crn:value>
- </crn:parameter>
- <!-- redirectNsID: Specifies the namespace ID that will be invoked with the claim
- obtained from the OpenID identity provider. -->
- <!-- A string that represents the ID of the namespace that will be invoked with the
- claim obtained from the OpenID identity provider. This value must match the
- namespace ID of a configured namespace (e.g., LDAP, AD, etc). -->
- <crn:parameter name="redirectNsID">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- </crn:instance>
- <!--
- (End of) TSP_OIDC_SalesForce template
- ===============================================================================
- -->
- <!--
- ===============================================================================
- (Begin of) TSP_OIDC_SiteMinder template
- -->
- <crn:instance name="TSP_OIDC_SiteMinder Name" class="TSP_OIDC_SiteMinder">
- <!-- identityProviderType: Specifies the implementation of an OpenID Connect
- identity provider. -->
- <crn:parameter name="identityProviderType">
- <crn:value xsi:type="xsd:string">SiteMinder</crn:value>
- </crn:parameter>
- <!-- id: Specifies a unique identifier for the authentication namespace. -->
- <!-- Use the namespace identifier to distinguish between multiple namespaces. Each
- namespace must have a unique identifier. When you select a namespace to use for
- authentication in the run-time environment, the identifier is used by the IBM
- Cognos components. Changing the namespace ID after the service has been started
- may invalidate the object security policies and the Cognos group and role
- memberships. The use of the colon in the Namespace ID is not supported. -->
- <crn:parameter name="id">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- issuer: Specifies the OpenID claim issuer. The value looks like:
- https://<SiteMinder fully qualified hostname> -->
- <!-- A string that represents the identity provider that issued the claims in the
- ID token. This value must match the value of the 'iss' entry in the ID token
- JSON document. -->
- <crn:parameter name="issuer">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- oidcTokenEndpoint: Specifies the OpenID Connect token endpoint, using the
- following syntax: https://<SiteMinder fully qualified
- hostname:port>/affwebservices/CASSO/oidc/token -->
- <!-- The token endpoint is used to retrieve the identity token after a successful
- authentication to the OpenID Connect identity provider. -->
- <crn:parameter name="oidcTokenEndpoint">
- <crn:value xsi:type="cfg:anyPathURI">
- </crn:value>
- </crn:parameter>
- <!-- oidcAuthEndpoint: Specifies the OpenID Connect authorization endpoint, using
- the following syntax: https://<SiteMinder fully qualified
- hostname:port>/affwebservices/CASSO/oidc/authorize -->
- <!-- The authorization endpoint is a URL that your OpenID Connect identity provider
- uses for authentication. In most cases, the URL should use the https scheme.
- The authorization endpoint is invoked when users authenticate to the OpenID
- Connect identity provider. -->
- <crn:parameter name="oidcAuthEndpoint">
- <crn:value xsi:type="cfg:anyPathURI">
- </crn:value>
- </crn:parameter>
- <!-- clientId: Specifies the OpenID Connect client identifier -->
- <!-- The client identity that is assigned to the application by the OpenID Connect
- identity provider. -->
- <crn:parameter name="clientId">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- clientSecret: Specifies the client secret that is assigned to the application
- by the OpenID Connect identity provider. -->
- <!-- The client secret that is assigned to the application by the OpenID Connect
- identity provider. -->
- <crn:parameter name="clientSecret">
- <crn:value xsi:type="xsd:string" encrypted="false"/>
- </crn:parameter>
- <!-- jwksEndpoint: Specifies the OpenID Connect endpoint for retrieving JWT signing
- keys, using the following syntax: https://<SiteMinder fully qualified
- hostname:port>/affwebservices/CASSO/oidc/jwks?AuthorizationProvider=<provider
- name> -->
- <!-- The JWKS endpoint is a URL that your OpenID Connect identity provider uses to
- provide signing key data. In most cases, the URL should use the https scheme.
- The JWKS endpoint is invoked when validating an id_token returned from the
- identity provider. -->
- <crn:parameter name="jwksEndpoint">
- <crn:value xsi:type="cfg:anyPathURI">
- </crn:value>
- </crn:parameter>
- <!-- returnUrl: Return URL that is configured with the OpenID Connect identity
- provider. -->
- <!-- The return URL is invoked by the OpenID Connect identity provider after
- successfully authenticating a user. The URL format is
- https://dispatcherHOST:dispatcherPORT/bi/completeAuth.jsp or
- https://webserverHOST:webserverPORT/ibmcognos/bi/completeAuth.jsp. This URL
- completes Cognos Analytics authentication using the OpenID Connect identity
- provider. -->
- <crn:parameter name="returnUrl">
- <crn:value xsi:type="cfg:anyPathURI">https://host:port/bi/completeAuth.jsp</crn:value>
- </crn:parameter>
- <!-- selectableForAuth: Specifies whether the namespace is selectable for
- authentication. -->
- <!-- If this property is set to true, the namespace will be available for
- authentication in the logon page namespace selection prompt. Set this value to
- false if the namespace should not be available for selection on the logon page.
- -->
- <crn:parameter name="selectableForAuth">
- <crn:value xsi:type="xsd:boolean">true</crn:value>
- </crn:parameter>
- <!-- advancedProperties: Specifies a set of advanced properties. -->
- <!-- The user needs to provide the name and the value for each advanced property. -->
- <crn:parameter name="advancedProperties">
- <crn:value xsi:type="cfg:array">
- </crn:value>
- </crn:parameter>
- <!-- claimName: Specifies the name of the claim that will be provided to the target
- namespace. -->
- <!-- A string that represents the name of the claim from the id_token that will be
- provided to the target namespace. This value must be a single string value in
- the id_token and must exist for all account objects. -->
- <crn:parameter name="claimName">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- trustedEnvName: Specifies the environment variable name that will be used to
- transfer the claim to the target namespace. -->
- <!-- A string that represents the environment variable name that will be used to
- transfer the claim to the target namespace. This value is dependent on the
- target namespace type and corresponds to how the target namespace will obtain
- the user's identity. For example, the LDAP and Active Directory namespace types
- both expect the user's identity to be passed in the REMOTE_USER environment
- variable. -->
- <crn:parameter name="trustedEnvName">
- <crn:value xsi:type="xsd:string">REMOTE_USER</crn:value>
- </crn:parameter>
- <!-- redirectNsID: Specifies the namespace ID that will be invoked with the claim
- obtained from the OpenID identity provider. -->
- <!-- A string that represents the ID of the namespace that will be invoked with the
- claim obtained from the OpenID identity provider. This value must match the
- namespace ID of a configured namespace (e.g., LDAP, AD, etc). -->
- <crn:parameter name="redirectNsID">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- </crn:instance>
- <!--
- (End of) TSP_OIDC_SiteMinder template
- ===============================================================================
- -->
- <!--
- ===============================================================================
- (Begin of) TSP_OIDC_W3ID template
- -->
- <crn:instance name="TSP_OIDC_W3ID Name" class="TSP_OIDC_W3ID">
- <!-- identityProviderType: Specifies the implementation of an OpenID Connect
- identity provider. -->
- <crn:parameter name="identityProviderType">
- <crn:value xsi:type="xsd:string">W3ID</crn:value>
- </crn:parameter>
- <!-- id: Specifies a unique identifier for the authentication namespace. -->
- <!-- Use the namespace identifier to distinguish between multiple namespaces. Each
- namespace must have a unique identifier. When you select a namespace to use for
- authentication in the run-time environment, the identifier is used by the IBM
- Cognos components. Changing the namespace ID after the service has been started
- may invalidate the object security policies and the Cognos group and role
- memberships. The use of the colon in the Namespace ID is not supported. -->
- <crn:parameter name="id">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- issuer: Specifies the OpenID claim issuer. -->
- <!-- A string that represents the identity provider that issued the claims in the
- ID token. This value must match the value of the 'iss' entry in the ID token
- JSON document. -->
- <crn:parameter name="issuer">
- <crn:value xsi:type="xsd:string">https://w3id.sso.ibm.com/isam</crn:value>
- </crn:parameter>
- <!-- oidcTokenEndpoint: Specifies the OpenID Connect token endpoint -->
- <!-- The token endpoint is used to retrieve the identity token after a successful
- authentication to the OpenID Connect identity provider. -->
- <crn:parameter name="oidcTokenEndpoint">
- <crn:value xsi:type="cfg:anyPathURI">https://w3id.sso.ibm.com:443/isam/oidc/endpoint/amapp-runtime-oidcidp/token</crn:value>
- </crn:parameter>
- <!-- oidcAuthEndpoint: Specifies the OpenID Connect authorization endpoint. -->
- <!-- The authorization endpoint is a URL that your OpenID Connect identity provider
- uses for authentication. In most cases, the URL should use the https scheme.
- The authorization endpoint is invoked when users authenticate to the OpenID
- Connect identity provider. -->
- <crn:parameter name="oidcAuthEndpoint">
- <crn:value xsi:type="cfg:anyPathURI">https://w3id.sso.ibm.com:443/isam/oidc/endpoint/amapp-runtime-oidcidp/authorize</crn:value>
- </crn:parameter>
- <!-- clientId: Specifies the OpenID Connect client identifier -->
- <!-- The client identity that is assigned to the application by the OpenID Connect
- identity provider. -->
- <crn:parameter name="clientId">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- clientSecret: Specifies the client secret that is assigned to the application
- by the OpenID Connect identity provider. -->
- <!-- The client secret that is assigned to the application by the OpenID Connect
- identity provider. -->
- <crn:parameter name="clientSecret">
- <crn:value xsi:type="xsd:string" encrypted="false"/>
- </crn:parameter>
- <!-- idpCertificateFile: Specifies the location of the certificate that is used by
- the OpenID Connect identity provider to sign the identity token. -->
- <!-- A path to the file that contains the certificate used by the identity provider
- to sign the JSON Web Token. The path must include the certificate file name and
- be accessible to the running instance of Cognos Analytics. The certificate
- must be in a PEM format, include only the public key certificate, and include
- the begin and end certificate lines. The certificate file cannot be placed in
- the configuration/certs directory. -->
- <crn:parameter name="idpCertificateFile">
- <crn:value xsi:type="cfg:filePath">
- </crn:value>
- </crn:parameter>
- <!-- returnUrl: Return URL that is configured with the OpenID Connect identity
- provider. -->
- <!-- The return URL is invoked by the OpenID Connect identity provider after
- successfully authenticating a user. The URL format is
- https://dispatcherHOST:dispatcherPORT/bi/completeAuth.jsp or
- https://webserverHOST:webserverPORT/ibmcognos/bi/completeAuth.jsp. This URL
- completes Cognos Analytics authentication using the OpenID Connect identity
- provider. -->
- <crn:parameter name="returnUrl">
- <crn:value xsi:type="cfg:anyPathURI">https://host:port/bi/completeAuth.jsp</crn:value>
- </crn:parameter>
- <!-- selectableForAuth: Specifies whether the namespace is selectable for
- authentication. -->
- <!-- If this property is set to true, the namespace will be available for
- authentication in the logon page namespace selection prompt. Set this value to
- false if the namespace should not be available for selection on the logon page.
- -->
- <crn:parameter name="selectableForAuth">
- <crn:value xsi:type="xsd:boolean">true</crn:value>
- </crn:parameter>
- <!-- advancedProperties: Specifies a set of advanced properties. -->
- <!-- The user needs to provide the name and the value for each advanced property. -->
- <crn:parameter name="advancedProperties">
- <crn:value xsi:type="cfg:array">
- </crn:value>
- </crn:parameter>
- <!-- claimName: Specifies the name of the claim that will be provided to the target
- namespace. -->
- <!-- A string that represents the name of the claim from the id_token that will be
- provided to the target namespace. This value must be a single string value in
- the id_token and must exist for all account objects. -->
- <crn:parameter name="claimName">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- <!-- trustedEnvName: Specifies the environment variable name that will be used to
- transfer the claim to the target namespace. -->
- <!-- A string that represents the environment variable name that will be used to
- transfer the claim to the target namespace. This value is dependent on the
- target namespace type and corresponds to how the target namespace will obtain
- the user's identity. For example, the LDAP and Active Directory namespace types
- both expect the user's identity to be passed in the REMOTE_USER environment
- variable. -->
- <crn:parameter name="trustedEnvName">
- <crn:value xsi:type="xsd:string">REMOTE_USER</crn:value>
- </crn:parameter>
- <!-- redirectNsID: Specifies the namespace ID that will be invoked with the claim
- obtained from the OpenID identity provider. -->
- <!-- A string that represents the ID of the namespace that will be invoked with the
- claim obtained from the OpenID identity provider. This value must match the
- namespace ID of a configured namespace (e.g., LDAP, AD, etc). -->
- <crn:parameter name="redirectNsID">
- <crn:value xsi:type="xsd:string">
- </crn:value>
- </crn:parameter>
- </crn:instance>
- <!--
- (End of) TSP_OIDC_W3ID template
- ===============================================================================
- -->
- </crn:instances>
- </crn:value>
- </crn:parameter>
- </crn:parameters>
|