identitystore-2020-06-15.min.json 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892
  1. {
  2. "version": "2.0",
  3. "metadata": {
  4. "apiVersion": "2020-06-15",
  5. "endpointPrefix": "identitystore",
  6. "jsonVersion": "1.1",
  7. "protocol": "json",
  8. "serviceAbbreviation": "IdentityStore",
  9. "serviceFullName": "AWS SSO Identity Store",
  10. "serviceId": "identitystore",
  11. "signatureVersion": "v4",
  12. "signingName": "identitystore",
  13. "targetPrefix": "AWSIdentityStore",
  14. "uid": "identitystore-2020-06-15"
  15. },
  16. "operations": {
  17. "CreateGroup": {
  18. "input": {
  19. "type": "structure",
  20. "required": [
  21. "IdentityStoreId"
  22. ],
  23. "members": {
  24. "IdentityStoreId": {},
  25. "DisplayName": {
  26. "shape": "S3"
  27. },
  28. "Description": {
  29. "shape": "S4"
  30. }
  31. }
  32. },
  33. "output": {
  34. "type": "structure",
  35. "required": [
  36. "GroupId",
  37. "IdentityStoreId"
  38. ],
  39. "members": {
  40. "GroupId": {},
  41. "IdentityStoreId": {}
  42. }
  43. }
  44. },
  45. "CreateGroupMembership": {
  46. "input": {
  47. "type": "structure",
  48. "required": [
  49. "IdentityStoreId",
  50. "GroupId",
  51. "MemberId"
  52. ],
  53. "members": {
  54. "IdentityStoreId": {},
  55. "GroupId": {},
  56. "MemberId": {
  57. "shape": "S8"
  58. }
  59. }
  60. },
  61. "output": {
  62. "type": "structure",
  63. "required": [
  64. "MembershipId",
  65. "IdentityStoreId"
  66. ],
  67. "members": {
  68. "MembershipId": {},
  69. "IdentityStoreId": {}
  70. }
  71. }
  72. },
  73. "CreateUser": {
  74. "input": {
  75. "type": "structure",
  76. "required": [
  77. "IdentityStoreId"
  78. ],
  79. "members": {
  80. "IdentityStoreId": {},
  81. "UserName": {
  82. "shape": "Sb"
  83. },
  84. "Name": {
  85. "shape": "Sc"
  86. },
  87. "DisplayName": {
  88. "shape": "S4"
  89. },
  90. "NickName": {
  91. "shape": "S4"
  92. },
  93. "ProfileUrl": {
  94. "shape": "S4"
  95. },
  96. "Emails": {
  97. "shape": "Sd"
  98. },
  99. "Addresses": {
  100. "shape": "Sg"
  101. },
  102. "PhoneNumbers": {
  103. "shape": "Si"
  104. },
  105. "UserType": {
  106. "shape": "S4"
  107. },
  108. "Title": {
  109. "shape": "S4"
  110. },
  111. "PreferredLanguage": {
  112. "shape": "S4"
  113. },
  114. "Locale": {
  115. "shape": "S4"
  116. },
  117. "Timezone": {
  118. "shape": "S4"
  119. }
  120. }
  121. },
  122. "output": {
  123. "type": "structure",
  124. "required": [
  125. "UserId",
  126. "IdentityStoreId"
  127. ],
  128. "members": {
  129. "UserId": {},
  130. "IdentityStoreId": {}
  131. }
  132. }
  133. },
  134. "DeleteGroup": {
  135. "input": {
  136. "type": "structure",
  137. "required": [
  138. "IdentityStoreId",
  139. "GroupId"
  140. ],
  141. "members": {
  142. "IdentityStoreId": {},
  143. "GroupId": {}
  144. }
  145. },
  146. "output": {
  147. "type": "structure",
  148. "members": {}
  149. },
  150. "idempotent": true
  151. },
  152. "DeleteGroupMembership": {
  153. "input": {
  154. "type": "structure",
  155. "required": [
  156. "IdentityStoreId",
  157. "MembershipId"
  158. ],
  159. "members": {
  160. "IdentityStoreId": {},
  161. "MembershipId": {}
  162. }
  163. },
  164. "output": {
  165. "type": "structure",
  166. "members": {}
  167. },
  168. "idempotent": true
  169. },
  170. "DeleteUser": {
  171. "input": {
  172. "type": "structure",
  173. "required": [
  174. "IdentityStoreId",
  175. "UserId"
  176. ],
  177. "members": {
  178. "IdentityStoreId": {},
  179. "UserId": {}
  180. }
  181. },
  182. "output": {
  183. "type": "structure",
  184. "members": {}
  185. },
  186. "idempotent": true
  187. },
  188. "DescribeGroup": {
  189. "input": {
  190. "type": "structure",
  191. "required": [
  192. "IdentityStoreId",
  193. "GroupId"
  194. ],
  195. "members": {
  196. "IdentityStoreId": {},
  197. "GroupId": {}
  198. }
  199. },
  200. "output": {
  201. "type": "structure",
  202. "required": [
  203. "GroupId",
  204. "IdentityStoreId"
  205. ],
  206. "members": {
  207. "GroupId": {},
  208. "DisplayName": {
  209. "shape": "S3"
  210. },
  211. "ExternalIds": {
  212. "shape": "St"
  213. },
  214. "Description": {
  215. "shape": "S4"
  216. },
  217. "IdentityStoreId": {}
  218. }
  219. }
  220. },
  221. "DescribeGroupMembership": {
  222. "input": {
  223. "type": "structure",
  224. "required": [
  225. "IdentityStoreId",
  226. "MembershipId"
  227. ],
  228. "members": {
  229. "IdentityStoreId": {},
  230. "MembershipId": {}
  231. }
  232. },
  233. "output": {
  234. "type": "structure",
  235. "required": [
  236. "IdentityStoreId",
  237. "MembershipId",
  238. "GroupId",
  239. "MemberId"
  240. ],
  241. "members": {
  242. "IdentityStoreId": {},
  243. "MembershipId": {},
  244. "GroupId": {},
  245. "MemberId": {
  246. "shape": "S8"
  247. }
  248. }
  249. }
  250. },
  251. "DescribeUser": {
  252. "input": {
  253. "type": "structure",
  254. "required": [
  255. "IdentityStoreId",
  256. "UserId"
  257. ],
  258. "members": {
  259. "IdentityStoreId": {},
  260. "UserId": {}
  261. }
  262. },
  263. "output": {
  264. "type": "structure",
  265. "required": [
  266. "UserId",
  267. "IdentityStoreId"
  268. ],
  269. "members": {
  270. "UserName": {
  271. "shape": "Sb"
  272. },
  273. "UserId": {},
  274. "ExternalIds": {
  275. "shape": "St"
  276. },
  277. "Name": {
  278. "shape": "Sc"
  279. },
  280. "DisplayName": {
  281. "shape": "S4"
  282. },
  283. "NickName": {
  284. "shape": "S4"
  285. },
  286. "ProfileUrl": {
  287. "shape": "S4"
  288. },
  289. "Emails": {
  290. "shape": "Sd"
  291. },
  292. "Addresses": {
  293. "shape": "Sg"
  294. },
  295. "PhoneNumbers": {
  296. "shape": "Si"
  297. },
  298. "UserType": {
  299. "shape": "S4"
  300. },
  301. "Title": {
  302. "shape": "S4"
  303. },
  304. "PreferredLanguage": {
  305. "shape": "S4"
  306. },
  307. "Locale": {
  308. "shape": "S4"
  309. },
  310. "Timezone": {
  311. "shape": "S4"
  312. },
  313. "IdentityStoreId": {}
  314. }
  315. }
  316. },
  317. "GetGroupId": {
  318. "input": {
  319. "type": "structure",
  320. "required": [
  321. "IdentityStoreId",
  322. "AlternateIdentifier"
  323. ],
  324. "members": {
  325. "IdentityStoreId": {},
  326. "AlternateIdentifier": {
  327. "shape": "S12"
  328. }
  329. }
  330. },
  331. "output": {
  332. "type": "structure",
  333. "required": [
  334. "GroupId",
  335. "IdentityStoreId"
  336. ],
  337. "members": {
  338. "GroupId": {},
  339. "IdentityStoreId": {}
  340. }
  341. }
  342. },
  343. "GetGroupMembershipId": {
  344. "input": {
  345. "type": "structure",
  346. "required": [
  347. "IdentityStoreId",
  348. "GroupId",
  349. "MemberId"
  350. ],
  351. "members": {
  352. "IdentityStoreId": {},
  353. "GroupId": {},
  354. "MemberId": {
  355. "shape": "S8"
  356. }
  357. }
  358. },
  359. "output": {
  360. "type": "structure",
  361. "required": [
  362. "MembershipId",
  363. "IdentityStoreId"
  364. ],
  365. "members": {
  366. "MembershipId": {},
  367. "IdentityStoreId": {}
  368. }
  369. }
  370. },
  371. "GetUserId": {
  372. "input": {
  373. "type": "structure",
  374. "required": [
  375. "IdentityStoreId",
  376. "AlternateIdentifier"
  377. ],
  378. "members": {
  379. "IdentityStoreId": {},
  380. "AlternateIdentifier": {
  381. "shape": "S12"
  382. }
  383. }
  384. },
  385. "output": {
  386. "type": "structure",
  387. "required": [
  388. "UserId",
  389. "IdentityStoreId"
  390. ],
  391. "members": {
  392. "UserId": {},
  393. "IdentityStoreId": {}
  394. }
  395. }
  396. },
  397. "IsMemberInGroups": {
  398. "input": {
  399. "type": "structure",
  400. "required": [
  401. "IdentityStoreId",
  402. "MemberId",
  403. "GroupIds"
  404. ],
  405. "members": {
  406. "IdentityStoreId": {},
  407. "MemberId": {
  408. "shape": "S8"
  409. },
  410. "GroupIds": {
  411. "type": "list",
  412. "member": {}
  413. }
  414. }
  415. },
  416. "output": {
  417. "type": "structure",
  418. "required": [
  419. "Results"
  420. ],
  421. "members": {
  422. "Results": {
  423. "type": "list",
  424. "member": {
  425. "type": "structure",
  426. "members": {
  427. "GroupId": {},
  428. "MemberId": {
  429. "shape": "S8"
  430. },
  431. "MembershipExists": {
  432. "shape": "Sf"
  433. }
  434. }
  435. }
  436. }
  437. }
  438. }
  439. },
  440. "ListGroupMemberships": {
  441. "input": {
  442. "type": "structure",
  443. "required": [
  444. "IdentityStoreId",
  445. "GroupId"
  446. ],
  447. "members": {
  448. "IdentityStoreId": {},
  449. "GroupId": {},
  450. "MaxResults": {
  451. "type": "integer"
  452. },
  453. "NextToken": {}
  454. }
  455. },
  456. "output": {
  457. "type": "structure",
  458. "required": [
  459. "GroupMemberships"
  460. ],
  461. "members": {
  462. "GroupMemberships": {
  463. "shape": "S1k"
  464. },
  465. "NextToken": {}
  466. }
  467. }
  468. },
  469. "ListGroupMembershipsForMember": {
  470. "input": {
  471. "type": "structure",
  472. "required": [
  473. "IdentityStoreId",
  474. "MemberId"
  475. ],
  476. "members": {
  477. "IdentityStoreId": {},
  478. "MemberId": {
  479. "shape": "S8"
  480. },
  481. "MaxResults": {
  482. "type": "integer"
  483. },
  484. "NextToken": {}
  485. }
  486. },
  487. "output": {
  488. "type": "structure",
  489. "required": [
  490. "GroupMemberships"
  491. ],
  492. "members": {
  493. "GroupMemberships": {
  494. "shape": "S1k"
  495. },
  496. "NextToken": {}
  497. }
  498. }
  499. },
  500. "ListGroups": {
  501. "input": {
  502. "type": "structure",
  503. "required": [
  504. "IdentityStoreId"
  505. ],
  506. "members": {
  507. "IdentityStoreId": {},
  508. "MaxResults": {
  509. "type": "integer"
  510. },
  511. "NextToken": {},
  512. "Filters": {
  513. "shape": "S1p",
  514. "deprecated": true,
  515. "deprecatedMessage": "Using filters with ListGroups API is deprecated, please use GetGroupId API instead."
  516. }
  517. }
  518. },
  519. "output": {
  520. "type": "structure",
  521. "required": [
  522. "Groups"
  523. ],
  524. "members": {
  525. "Groups": {
  526. "type": "list",
  527. "member": {
  528. "type": "structure",
  529. "required": [
  530. "GroupId",
  531. "IdentityStoreId"
  532. ],
  533. "members": {
  534. "GroupId": {},
  535. "DisplayName": {
  536. "shape": "S3"
  537. },
  538. "ExternalIds": {
  539. "shape": "St"
  540. },
  541. "Description": {
  542. "shape": "S4"
  543. },
  544. "IdentityStoreId": {}
  545. }
  546. }
  547. },
  548. "NextToken": {}
  549. }
  550. }
  551. },
  552. "ListUsers": {
  553. "input": {
  554. "type": "structure",
  555. "required": [
  556. "IdentityStoreId"
  557. ],
  558. "members": {
  559. "IdentityStoreId": {},
  560. "MaxResults": {
  561. "type": "integer"
  562. },
  563. "NextToken": {},
  564. "Filters": {
  565. "shape": "S1p",
  566. "deprecated": true,
  567. "deprecatedMessage": "Using filters with ListUsers API is deprecated, please use GetGroupId API instead."
  568. }
  569. }
  570. },
  571. "output": {
  572. "type": "structure",
  573. "required": [
  574. "Users"
  575. ],
  576. "members": {
  577. "Users": {
  578. "type": "list",
  579. "member": {
  580. "type": "structure",
  581. "required": [
  582. "UserId",
  583. "IdentityStoreId"
  584. ],
  585. "members": {
  586. "UserName": {
  587. "shape": "Sb"
  588. },
  589. "UserId": {},
  590. "ExternalIds": {
  591. "shape": "St"
  592. },
  593. "Name": {
  594. "shape": "Sc"
  595. },
  596. "DisplayName": {
  597. "shape": "S4"
  598. },
  599. "NickName": {
  600. "shape": "S4"
  601. },
  602. "ProfileUrl": {
  603. "shape": "S4"
  604. },
  605. "Emails": {
  606. "shape": "Sd"
  607. },
  608. "Addresses": {
  609. "shape": "Sg"
  610. },
  611. "PhoneNumbers": {
  612. "shape": "Si"
  613. },
  614. "UserType": {
  615. "shape": "S4"
  616. },
  617. "Title": {
  618. "shape": "S4"
  619. },
  620. "PreferredLanguage": {
  621. "shape": "S4"
  622. },
  623. "Locale": {
  624. "shape": "S4"
  625. },
  626. "Timezone": {
  627. "shape": "S4"
  628. },
  629. "IdentityStoreId": {}
  630. }
  631. }
  632. },
  633. "NextToken": {}
  634. }
  635. }
  636. },
  637. "UpdateGroup": {
  638. "input": {
  639. "type": "structure",
  640. "required": [
  641. "IdentityStoreId",
  642. "GroupId",
  643. "Operations"
  644. ],
  645. "members": {
  646. "IdentityStoreId": {},
  647. "GroupId": {},
  648. "Operations": {
  649. "shape": "S1z"
  650. }
  651. }
  652. },
  653. "output": {
  654. "type": "structure",
  655. "members": {}
  656. }
  657. },
  658. "UpdateUser": {
  659. "input": {
  660. "type": "structure",
  661. "required": [
  662. "IdentityStoreId",
  663. "UserId",
  664. "Operations"
  665. ],
  666. "members": {
  667. "IdentityStoreId": {},
  668. "UserId": {},
  669. "Operations": {
  670. "shape": "S1z"
  671. }
  672. }
  673. },
  674. "output": {
  675. "type": "structure",
  676. "members": {}
  677. }
  678. }
  679. },
  680. "shapes": {
  681. "S3": {
  682. "type": "string",
  683. "sensitive": true
  684. },
  685. "S4": {
  686. "type": "string",
  687. "sensitive": true
  688. },
  689. "S8": {
  690. "type": "structure",
  691. "members": {
  692. "UserId": {}
  693. },
  694. "union": true
  695. },
  696. "Sb": {
  697. "type": "string",
  698. "sensitive": true
  699. },
  700. "Sc": {
  701. "type": "structure",
  702. "members": {
  703. "Formatted": {
  704. "shape": "S4"
  705. },
  706. "FamilyName": {
  707. "shape": "S4"
  708. },
  709. "GivenName": {
  710. "shape": "S4"
  711. },
  712. "MiddleName": {
  713. "shape": "S4"
  714. },
  715. "HonorificPrefix": {
  716. "shape": "S4"
  717. },
  718. "HonorificSuffix": {
  719. "shape": "S4"
  720. }
  721. }
  722. },
  723. "Sd": {
  724. "type": "list",
  725. "member": {
  726. "type": "structure",
  727. "members": {
  728. "Value": {
  729. "shape": "S4"
  730. },
  731. "Type": {
  732. "shape": "S4"
  733. },
  734. "Primary": {
  735. "shape": "Sf"
  736. }
  737. }
  738. }
  739. },
  740. "Sf": {
  741. "type": "boolean",
  742. "sensitive": true
  743. },
  744. "Sg": {
  745. "type": "list",
  746. "member": {
  747. "type": "structure",
  748. "members": {
  749. "StreetAddress": {
  750. "shape": "S4"
  751. },
  752. "Locality": {
  753. "shape": "S4"
  754. },
  755. "Region": {
  756. "shape": "S4"
  757. },
  758. "PostalCode": {
  759. "shape": "S4"
  760. },
  761. "Country": {
  762. "shape": "S4"
  763. },
  764. "Formatted": {
  765. "shape": "S4"
  766. },
  767. "Type": {
  768. "shape": "S4"
  769. },
  770. "Primary": {
  771. "shape": "Sf"
  772. }
  773. }
  774. }
  775. },
  776. "Si": {
  777. "type": "list",
  778. "member": {
  779. "type": "structure",
  780. "members": {
  781. "Value": {
  782. "shape": "S4"
  783. },
  784. "Type": {
  785. "shape": "S4"
  786. },
  787. "Primary": {
  788. "shape": "Sf"
  789. }
  790. }
  791. }
  792. },
  793. "St": {
  794. "type": "list",
  795. "member": {
  796. "shape": "Su"
  797. }
  798. },
  799. "Su": {
  800. "type": "structure",
  801. "required": [
  802. "Issuer",
  803. "Id"
  804. ],
  805. "members": {
  806. "Issuer": {
  807. "type": "string",
  808. "sensitive": true
  809. },
  810. "Id": {
  811. "type": "string",
  812. "sensitive": true
  813. }
  814. }
  815. },
  816. "S12": {
  817. "type": "structure",
  818. "members": {
  819. "ExternalId": {
  820. "shape": "Su"
  821. },
  822. "UniqueAttribute": {
  823. "type": "structure",
  824. "required": [
  825. "AttributePath",
  826. "AttributeValue"
  827. ],
  828. "members": {
  829. "AttributePath": {},
  830. "AttributeValue": {
  831. "shape": "S15"
  832. }
  833. }
  834. }
  835. },
  836. "union": true
  837. },
  838. "S15": {
  839. "type": "structure",
  840. "members": {},
  841. "document": true
  842. },
  843. "S1k": {
  844. "type": "list",
  845. "member": {
  846. "type": "structure",
  847. "required": [
  848. "IdentityStoreId"
  849. ],
  850. "members": {
  851. "IdentityStoreId": {},
  852. "MembershipId": {},
  853. "GroupId": {},
  854. "MemberId": {
  855. "shape": "S8"
  856. }
  857. }
  858. }
  859. },
  860. "S1p": {
  861. "type": "list",
  862. "member": {
  863. "type": "structure",
  864. "required": [
  865. "AttributePath",
  866. "AttributeValue"
  867. ],
  868. "members": {
  869. "AttributePath": {},
  870. "AttributeValue": {
  871. "shape": "S4"
  872. }
  873. }
  874. }
  875. },
  876. "S1z": {
  877. "type": "list",
  878. "member": {
  879. "type": "structure",
  880. "required": [
  881. "AttributePath"
  882. ],
  883. "members": {
  884. "AttributePath": {},
  885. "AttributeValue": {
  886. "shape": "S15"
  887. }
  888. }
  889. }
  890. }
  891. }
  892. }