API tools faq
paste
Advertisement
Guest User

Untitled

a guest
Jan 15th, 2019
208
0
Never
Add comment
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 78.26 KB | None | 0 0
raw download clone embed print report
  1. ---
  2. swagger: '2.0'
  3. info:
  4. title: StorageGRID Webscale Management API v2
  5. description: 'REST API for managing StorageGRID Webscale deployments. Copyright
  6. (c) 2018 NetApp, Inc. All Rights Reserved'
  7. version: '2.2'
  8. schemes:
  9. - https
  10. basePath: "/api/v2"
  11. produces:
  12. - application/json
  13. securityDefinitions:
  14. BearerToken:
  15. type: apiKey
  16. name: Authorization
  17. in: header
  18. security:
  19. - BearerToken: []
  20. definitions:
  21. error-response:
  22. title: Error Response
  23. description: an error response format that augments the response with information
  24. describing the error that occurred
  25. type: object
  26. allOf:
  27. - "$ref": "#/definitions/response"
  28. - properties:
  29. code:
  30. description: the HTTP response code
  31. type: integer
  32. message:
  33. description: the localized error message
  34. "$ref": "#/definitions/localized-error"
  35. errors:
  36. description: additional error messages such as per-field errors in a validation
  37. failure
  38. type: array
  39. items:
  40. "$ref": "#/definitions/localized-error"
  41. localized-error:
  42. required:
  43. - text
  44. properties:
  45. text:
  46. description: the localized text describing the error
  47. type: string
  48. key:
  49. description: a unique key representing the message (for programmatic use)
  50. type: string
  51. context:
  52. description: the situation or field where error was triggered
  53. type: string
  54. developerMessage:
  55. description: additional information to aid in debugging
  56. type: string
  57. response:
  58. title: Response
  59. description: a response format that includes metadata characterizing the response's
  60. generation and status
  61. type: object
  62. required:
  63. - responseTime
  64. - status
  65. - apiVersion
  66. properties:
  67. responseTime:
  68. description: the date and time when the response was generated
  69. type: string
  70. format: date-time
  71. status:
  72. description: the result of the request
  73. type: string
  74. enum:
  75. - success
  76. - error
  77. apiVersion:
  78. description: the major and minor version of the API
  79. type: string
  80. example: '2.2'
  81. deprecated:
  82. description: whether the requested API is deprecated, default false
  83. type: boolean
  84. default: false
  85. data:
  86. description: the response data for the request (required on success and optional
  87. on error; type and content vary by request)
  88. credentials:
  89. title: Credentials
  90. description: authentication credentials
  91. type: object
  92. required:
  93. - accountId
  94. - username
  95. - password
  96. properties:
  97. accountId:
  98. type: string
  99. example: '12345678901234567000'
  100. username:
  101. type: string
  102. example: MyUserName
  103. password:
  104. type: string
  105. example: MyPassword
  106. cookie:
  107. description: flag to ask for an authorization token in the response using
  108. the Set-Cookie header
  109. type: boolean
  110. csrfToken:
  111. description: flag to ask for a CSRF token in the response using the Set-Cookie
  112. header. See the Administrator Guide for more information
  113. type: boolean
  114. default: false
  115. authorize-response:
  116. allOf:
  117. - "$ref": "#/definitions/response"
  118. - properties:
  119. data:
  120. description: authorization bearer token
  121. type: string
  122. example: 00000000-0000-0000-0000-000000000000
  123. required:
  124. - data
  125. identity-source:
  126. title: Identity Source
  127. description: An external LDAP server for authentication.
  128. type: object
  129. required:
  130. - id
  131. - ldapServiceType
  132. - hostname
  133. - port
  134. - username
  135. - password
  136. - baseGroupDn
  137. - baseUserDn
  138. properties:
  139. id:
  140. title: Identity Source identifier
  141. description: a unique identifier for the identity source (automatically assigned
  142. when the identity source is configured)
  143. type: string
  144. example: 00000000-0000-0000-0000-000000000000
  145. disable:
  146. title: disable
  147. description: whether the identity source will be used for authentication
  148. type: boolean
  149. default: true
  150. hostname:
  151. title: Hostname
  152. description: the server hostname or IP address of the identity source
  153. type: string
  154. example: 10.1.2.3
  155. port:
  156. title: Port
  157. description: the port to use to connect to the identity source
  158. type: integer
  159. example: 389
  160. username:
  161. title: Username
  162. description: the username to use to access the identity source
  163. type: string
  164. example: MYDOMAIN\Administrator
  165. password:
  166. title: Password
  167. description: the password to use to access the identity source
  168. type: string
  169. example: mypassword
  170. baseGroupDn:
  171. title: Group Base DN
  172. description: the fully qualified Distinguished Name (DN) of an LDAP subtree
  173. you want to search for groups
  174. type: string
  175. example: DC=example,DC=com
  176. baseUserDn:
  177. title: User Base DN
  178. description: the fully qualified Distinguished Name (DN) of an LDAP subtree
  179. you want to search for users
  180. type: string
  181. example: DC=example,DC=com
  182. ldapServiceType:
  183. title: LDAP service type
  184. description: type of the LDAP service
  185. type: string
  186. enum:
  187. - OpenLDAP
  188. - Active Directory
  189. - Other
  190. type:
  191. title: type
  192. description: type of the identity source
  193. type: string
  194. enum:
  195. - ldap
  196. default: ldap
  197. ldapUserIdAttribute:
  198. title: LDAP User ID Attribute
  199. description: LDAP attribute that identifies the LDAP user who attempts authentication
  200. with unique name/login (only required when ldapServiceType is "Other")
  201. type: string
  202. example: sAMAccountName
  203. ldapUserUUIDAttribute:
  204. title: LDAP User UUID Attribute
  205. description: LDAP attribute that identifies the LDAP user's permanent unique
  206. identity (only required when ldapServiceType is "Other")
  207. type: string
  208. example: objectGUID
  209. ldapGroupIdAttribute:
  210. title: LDAP Group ID Attribute
  211. description: LDAP attribute that identifies the LDAP group of the user who
  212. attempts authentication (only required when ldapServiceType is "Other")
  213. type: string
  214. example: sAMAccountName
  215. ldapGroupUUIDAttribute:
  216. title: LDAP Group UUID Attribute
  217. description: LDAP attribute that identifies the LDAP group's permanent unique
  218. identity (only required when ldapServiceType is "Other")
  219. type: string
  220. example: objectGUID
  221. disableTLS:
  222. title: Disable TLS
  223. description: whether Transport Layer Security (TLS) is used to connect to
  224. the identity source server
  225. type: boolean
  226. default: false
  227. caCert:
  228. title: CA Certificate
  229. description: custom certificate to use to connect to the identity source server
  230. (if no custom certificate is supplied and TLS is enabled, the Operating
  231. System CA certificate will be used)
  232. type: string
  233. example: "-----BEGIN CERTIFICATE----- abcdefghijkl123456780ABCDEFGHIJKL 123456/7890ABCDEFabcdefghijklABCD
  234. -----END CERTIFICATE-----\n"
  235. identity-source-get-put-response:
  236. allOf:
  237. - "$ref": "#/definitions/response"
  238. - properties:
  239. data:
  240. "$ref": "#/definitions/identity-source"
  241. required:
  242. - data
  243. container:
  244. description: An S3 bucket or Swift container
  245. properties:
  246. name:
  247. description: S3 bucket or Swift container name
  248. type: string
  249. minLength: 3
  250. maxLength: 63
  251. example: my-container
  252. creationTime:
  253. description: time the bucket or container was created
  254. type: string
  255. format: date-time
  256. region:
  257. description: the region of this bucket (returned only if requested using the
  258. S3 include parameter)
  259. type: string
  260. example: us-east-1
  261. default: us-east-1
  262. compliance:
  263. description: compliance settings (returned only if requested using the S3
  264. include parameter)
  265. allOf:
  266. - "$ref": "#/definitions/container-compliance-settings"
  267. required:
  268. - name
  269. - creationTime
  270. container-compliance-settings:
  271. description: Compliance settings
  272. required:
  273. - autoDelete
  274. - legalHold
  275. - retentionPeriodMinutes
  276. properties:
  277. autoDelete:
  278. description: whether the objects in this bucket will be deleted automatically
  279. when their retention period expires, unless the bucket is under a legal
  280. hold
  281. type: boolean
  282. example: false
  283. legalHold:
  284. description: whether the bucket is currently under a legal hold (objects cannot
  285. be deleted)
  286. type: boolean
  287. example: false
  288. retentionPeriodMinutes:
  289. description: the length of the retention period for objects added to this
  290. bucket, in minutes, starting when the object is ingested into the grid
  291. type: integer
  292. example: 2629800
  293. minValue: 1
  294. container-compliance-settings-get-put-response:
  295. allOf:
  296. - "$ref": "#/definitions/response"
  297. - properties:
  298. data:
  299. "$ref": "#/definitions/container-compliance-settings"
  300. required:
  301. - data
  302. container-consistency:
  303. description: S3 bucket or Swift container consistency setting
  304. properties:
  305. consistency:
  306. description: Consistency level. The default option is deprecated in the v2
  307. API. In the v3 API, a new read-after-new-write option will provide the same
  308. functionality.
  309. type: string
  310. enum:
  311. - all
  312. - strong-global
  313. - strong-site
  314. - default
  315. - available
  316. - weak
  317. example: available
  318. required:
  319. - consistency
  320. container-consistency-get-put-response:
  321. allOf:
  322. - "$ref": "#/definitions/response"
  323. - properties:
  324. data:
  325. "$ref": "#/definitions/container-consistency"
  326. required:
  327. - data
  328. container-cors-configuration:
  329. description: Configure CORS
  330. properties:
  331. cors:
  332. description: XML for configuring CORS, or null to disable CORS
  333. type: string
  334. example: |
  335. <CORSConfiguration>
  336. <CORSRule>
  337. <AllowedOrigin>http://www.example.com</AllowedOrigin>
  338. <AllowedMethod>GET</AllowedMethod>
  339. </CORSRule>
  340. </CORSConfiguration>
  341. container-cors-configuration-get-put-response:
  342. allOf:
  343. - "$ref": "#/definitions/response"
  344. - properties:
  345. data:
  346. "$ref": "#/definitions/container-cors-configuration"
  347. required:
  348. - data
  349. container-create:
  350. description: Create S3 bucket
  351. required:
  352. - name
  353. properties:
  354. name:
  355. description: Bucket name (must be DNS-compatible; see the S3 Implementation
  356. Guide for details)
  357. type: string
  358. example: bucket-1
  359. minLength: 3
  360. maxLength: 63
  361. region:
  362. description: the region for this bucket, which must already be defined (defaults
  363. to us-east-1 if not specified)
  364. type: string
  365. example: us-east-1
  366. default: us-east-1
  367. compliance:
  368. "$ref": "#/definitions/container-compliance-settings"
  369. container-create-response:
  370. allOf:
  371. - "$ref": "#/definitions/response"
  372. - properties:
  373. data:
  374. "$ref": "#definitions/container-create"
  375. required:
  376. - data
  377. container-last-access-time:
  378. description: Last access time
  379. properties:
  380. lastAccessTime:
  381. description: Last access time value
  382. type: string
  383. enum:
  384. - disabled
  385. - enabled
  386. example: disabled
  387. required:
  388. - lastAccessTime
  389. container-last-access-time-get-put-response:
  390. allOf:
  391. - "$ref": "#/definitions/response"
  392. - properties:
  393. data:
  394. "$ref": "#/definitions/container-last-access-time"
  395. required:
  396. - data
  397. container-list-response:
  398. allOf:
  399. - "$ref": "#/definitions/response"
  400. - properties:
  401. data:
  402. type: array
  403. items:
  404. "$ref": "#/definitions/container"
  405. required:
  406. - data
  407. container-metadata-notification-configuration:
  408. description: Configure metadata notifications (search)
  409. properties:
  410. metadataNotification:
  411. description: XML for configuring metadata notifications (search), or null
  412. to disable metadata notifications (search)
  413. type: string
  414. example: |
  415. <MetadataNotificationConfiguration>
  416. <Rule>
  417. <ID>Rule-1</ID>
  418. <Status>Enabled</Status>
  419. <Prefix></Prefix>
  420. <Destination>
  421. <Urn>arn:aws:es:us-east-1:3333333:domain-name</Urn>
  422. </Destination>
  423. </Rule>
  424. </MetadataNotificationConfiguration>
  425. container-metadata-notification-configuration-get-put-response:
  426. allOf:
  427. - "$ref": "#/definitions/response"
  428. - properties:
  429. data:
  430. "$ref": "#/definitions/container-metadata-notification-configuration"
  431. required:
  432. - data
  433. container-notification-configuration:
  434. description: Notification configuration
  435. properties:
  436. notification:
  437. description: notification configuration XML, or null to disable notifications
  438. type: string
  439. example: |
  440. <?xml version="1.0" encoding="UTF-8"?>
  441. <NotificationConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
  442. <TopicConfiguration>
  443. <Id>MyEventForPut</Id>
  444. <Topic>arn:aws:sns:us-east-1:050340950352:my-topic</Topic>
  445. <Event>s3:ObjectCreated:Put</Event>
  446. <Filter>
  447. <S3Key>
  448. <FilterRule>
  449. <Name>prefix</Name>
  450. <Value>images/</Value>
  451. </FilterRule>
  452. <FilterRule>
  453. <Name>suffix</Name>
  454. <Value>.jpg</Value>
  455. </FilterRule>
  456. </S3Key>
  457. </Filter>
  458. </TopicConfiguration>
  459. </NotificationConfiguration>
  460. container-notification-configuration-get-put-response:
  461. allOf:
  462. - "$ref": "#/definitions/response"
  463. - properties:
  464. data:
  465. "$ref": "#/definitions/container-notification-configuration"
  466. required:
  467. - data
  468. container-replication-configuration:
  469. description: Replication configuration
  470. properties:
  471. replication:
  472. description: replication configuration XML, or null to disable replications
  473. type: string
  474. example: |
  475. <?xml version="1.0" encoding="UTF-8"?>
  476. <ReplicationConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
  477. <Rule>
  478. <ID>rule1</ID>
  479. <Status>Enabled</Status>
  480. <Prefix></Prefix>
  481. <Destination>
  482. <Bucket>arn:aws:s3:::mybucket-replicated</Bucket>
  483. <StorageClass>STANDARD</StorageClass>
  484. </Destination>
  485. <Role>arn:aws:iam::35667example:role/CrossRegionReplicationRoleForS3</Role>
  486. </Rule>
  487. </ReplicationConfiguration>
  488. container-replication-configuration-get-put-response:
  489. allOf:
  490. - "$ref": "#/definitions/response"
  491. - properties:
  492. data:
  493. "$ref": "#/definitions/container-replication-configuration"
  494. required:
  495. - data
  496. regions-get-response:
  497. allOf:
  498. - "$ref": "#/definitions/response"
  499. - properties:
  500. data:
  501. type: array
  502. description: the list of region names configured
  503. items:
  504. "$ref": "#/definitions/region-name"
  505. required:
  506. - data
  507. region-name:
  508. type: string
  509. description: the name of a region, can only include letters, numbers, and hyphens
  510. maxLength: 32
  511. minLength: 2
  512. pattern: "[-a-zA-Z0-9]+"
  513. example: us-east-1
  514. policies:
  515. title: Policies
  516. description: Sets of permissions
  517. type: object
  518. properties:
  519. management:
  520. description: permissions related to the Tenant Management UI/API
  521. "$ref": "#/definitions/policy-management"
  522. s3:
  523. description: permissions related to the S3 API (Tenant only)
  524. "$ref": "#/definitions/policy-s3"
  525. swift:
  526. description: permissions related to the Swift API (Tenant only)
  527. "$ref": "#/definitions/policy-swift"
  528. policy-account:
  529. title: Account Policy
  530. description: settings for the tenant account
  531. required:
  532. - useAccountIdentitySource
  533. - allowPlatformServices
  534. properties:
  535. useAccountIdentitySource:
  536. title: Use Tenant Account Identity Source
  537. description: whether the tenant account should configure its own identity
  538. source. If false, the tenant uses the grid-wide identity source.
  539. type: boolean
  540. default: true
  541. allowPlatformServices:
  542. title: Allow Platform Services
  543. description: allows a tenant to use platform services features such as CloudMirror.
  544. These features send data to an external service that is specified using
  545. a StorageGRID Webscale endpoint.
  546. type: boolean
  547. default: false
  548. example: false
  549. quotaObjectBytes:
  550. title: Object Quota (bytes)
  551. description: the maximum number of bytes available for this tenant's objects.
  552. Represents a logical amount (object size), not a physical amount (size on
  553. disk). If null, an unlimited number of bytes is available.
  554. type: integer
  555. minimum: 1
  556. example: 100000000000
  557. permissions-list-except-root:
  558. type: object
  559. properties:
  560. manageAllContainers:
  561. description: ability to manage all S3 buckets or Swift containers for this
  562. tenant account (overrides permission settings in group or bucket policies)
  563. type: boolean
  564. manageEndpoints:
  565. description: ability to manage all S3 endpoints for this tenant account
  566. type: boolean
  567. manageOwnS3Credentials:
  568. description: ability to manage your personal S3 credentials
  569. type: boolean
  570. policy-management:
  571. title: Management Policy
  572. allOf:
  573. - "$ref": "#/definitions/permissions-list-except-root"
  574. - properties:
  575. rootAccess:
  576. description: full access to all tenant administration features
  577. type: boolean
  578. policy-s3:
  579. title: S3 Policy
  580. type: object
  581. required:
  582. - Statement
  583. properties:
  584. Id:
  585. description: S3 Policy ID provided by policy generator tools (currently not
  586. used)
  587. type: string
  588. example: '123456'
  589. Version:
  590. description: S3 API Version (currently not used)
  591. type: string
  592. example: '2015-09-08'
  593. Statement:
  594. description: a list of group policy statements
  595. type: array
  596. items:
  597. "$ref": "#/definitions/policy-s3-statement"
  598. policy-s3-statement:
  599. title: S3 Group Policy Statement
  600. type: object
  601. properties:
  602. Sid:
  603. description: an optional identifier that you provide for the policy statement
  604. type: string
  605. Effect:
  606. description: the specific result of the statement (either an allow or an explicit
  607. deny)
  608. type: string
  609. required: true
  610. enum:
  611. - Allow
  612. - Deny
  613. Action:
  614. description: the specific actions that will be allowed (Can be a string if
  615. only one element. A statement must have either Action or NotAction.)
  616. type: array
  617. required: true
  618. items:
  619. type: string
  620. example: s3:GetObject
  621. NotAction:
  622. description: the specific exceptional actions (Can be a string if only one
  623. element. A statement must have either Action or NotAction.)
  624. type: array
  625. items:
  626. type: string
  627. example: s3:GetObject
  628. Resource:
  629. description: the objects that the statement covers (Can be a string if only
  630. one element. A statement must have either Resource or NotResource.)
  631. items:
  632. type: string
  633. example: urn:s3:::mybucket/myobject
  634. NotResource:
  635. description: the objects that the statement does not cover (Can be a string
  636. if only one element. A statement must have either Resource or NotResource.)
  637. type: array
  638. items:
  639. type: string
  640. example: urn:s3:::mybucket/myobject
  641. policy-swift:
  642. title: Swift Policy
  643. type: object
  644. properties:
  645. roles:
  646. description: Swift roles to grant
  647. type: array
  648. items:
  649. type: string
  650. enum:
  651. - admin
  652. api-versions-get-response:
  653. allOf:
  654. - "$ref": "#/definitions/response"
  655. - required:
  656. - data
  657. properties:
  658. data:
  659. type: array
  660. description: major API versions supported
  661. items:
  662. type: integer
  663. example: 2
  664. config:
  665. required:
  666. - auto-logout
  667. - user
  668. - token
  669. - permissions
  670. - account
  671. properties:
  672. auto-logout:
  673. title: GUI Inactivity Timeout
  674. description: the timeout period for the browser session in seconds (zero for
  675. disabled)
  676. type: integer
  677. example: 900
  678. user:
  679. description: information about the current User
  680. "$ref": "#/definitions/config-user"
  681. token:
  682. description: information about the current token
  683. "$ref": "#/definitions/config-token"
  684. permissions:
  685. description: the management permissions of the current token
  686. "$ref": "#/definitions/policy-management"
  687. deactivated-features:
  688. description: 'the features that are currently deactivated and thus denied
  689. to users with rootAccess (returned only if the current token has rootAccess)
  690.  
  691. '
  692. "$ref": "#/definitions/deactivated-features"
  693. account:
  694. description: the current account
  695. "$ref": "#/definitions/account"
  696. config-get-response:
  697. allOf:
  698. - "$ref": "#/definitions/response"
  699. - required:
  700. - data
  701. properties:
  702. data:
  703. "$ref": "#/definitions/config"
  704. config-token:
  705. title: Config Token
  706. required:
  707. - expires
  708. properties:
  709. expires:
  710. title: Token Expiration
  711. description: time when the token expires
  712. type: string
  713. format: date-time
  714. example: '2020-09-04T00:00:00.000Z'
  715. config-user:
  716. title: Config User
  717. required:
  718. - id
  719. - username
  720. - uniqueName
  721. - firstName
  722. - fullName
  723. - federated
  724. properties:
  725. id:
  726. title: Id
  727. description: UUID for the User (generated automatically)
  728. type: string
  729. format: uuid
  730. example: 00000000-0000-0000-0000-000000000000
  731. username:
  732. title: Username
  733. description: the username that is used to sign in
  734. type: string
  735. example: Test
  736. maxLength: 1024
  737. uniqueName:
  738. title: Unique Name
  739. description: the machine-readable name for the User (unique within an Account)
  740. type: string
  741. example: user/Test
  742. maxLength: 1024
  743. firstName:
  744. title: First Name
  745. description: the User's first name
  746. type: string
  747. example: Test
  748. maxLength: 32
  749. fullName:
  750. title: Full Name
  751. description: the human-readable name for the User
  752. type: string
  753. example: Test User
  754. maxLength: 128
  755. federated:
  756. title: Federated
  757. description: true if the User is federated, for example, an LDAP User
  758. type: boolean
  759. product-version:
  760. type: object
  761. required:
  762. - productVersion
  763. properties:
  764. productVersion:
  765. title: Product Version
  766. description: 'the product release version currently running on the Admin Node
  767. serving the request
  768.  
  769. '
  770. type: string
  771. example: 10.3.0-20160614.1639.bf71535
  772. product-version-get-response:
  773. allOf:
  774. - "$ref": "#/definitions/response"
  775. - required:
  776. - data
  777. properties:
  778. data:
  779. "$ref": "#/definitions/product-version"
  780. deactivated-features:
  781. title: deactivated features
  782. description: currently deactivated features
  783. allOf:
  784. - "$ref": "#/definitions/permissions-list-except-root"
  785. deactivated-features-get-response:
  786. allOf:
  787. - "$ref": "#/definitions/response"
  788. - required:
  789. - data
  790. - properties:
  791. data:
  792. "$ref": "#/definitions/deactivated-features"
  793. password-change-request:
  794. title: Change Password
  795. required:
  796. - password
  797. properties:
  798. password:
  799. title: New password
  800. type: string
  801. minLength: 8
  802. maxLength: 32
  803. currentPassword:
  804. title: Current password
  805. description: required for requests that change the password of the current
  806. User
  807. type: string
  808. minLength: 8
  809. maxLength: 32
  810. patch-user-request:
  811. title: User
  812. description: Users can be local or federated.
  813. type: object
  814. properties:
  815. fullName:
  816. title: Full name
  817. description: the human-readable name for the User (required for local Users
  818. and imported automatically for federated Users)
  819. type: string
  820. example: Test User
  821. maxLength: 128
  822. memberOf:
  823. description: Group memberships for this User (required for local Users and
  824. imported automatically for federated Users)
  825. type: array
  826. items:
  827. type: string
  828. format: uuid
  829. example:
  830. - 00000000-0000-0000-0000-000000000000
  831. disable:
  832. title: Prevent login
  833. description: if true, the local User cannot sign in (does not apply to federated
  834. Users)
  835. type: boolean
  836. default: false
  837. post-user-request:
  838. title: User
  839. description: Creates a local User.
  840. allOf:
  841. - "$ref": "#/definitions/patch-user-request"
  842. - required:
  843. - uniqueName
  844. - properties:
  845. uniqueName:
  846. title: Unique name
  847. description: the machine-readable name for the User (unique within an Account;
  848. must begin with user/ or federated-user/). The portion after the slash
  849. is the "username" that is used to sign in
  850. type: string
  851. example: user/Test
  852. maxLength: 1024
  853. user:
  854. title: User
  855. description: Users can be local or federated.
  856. allOf:
  857. - "$ref": "#/definitions/post-user-request"
  858. - required:
  859. - accountId
  860. - id
  861. - federated
  862. - userURN
  863. - properties:
  864. accountId:
  865. title: Account Identifier
  866. description: Storage Tenant Account ID
  867. type: string
  868. example: '0'
  869. id:
  870. title: Id
  871. description: UUID for the User (generated automatically)
  872. type: string
  873. format: uuid
  874. example: 00000000-0000-0000-0000-000000000000
  875. federated:
  876. title: Federated
  877. description: true if the User is federated, for example, an LDAP User
  878. type: boolean
  879. userURN:
  880. title: User Uniform Resource Name
  881. description: contains the User uniqueName and Account ID (generated automatically)
  882. type: string
  883. example: urn:sgws:identity::0:user/Test
  884. list-users-response:
  885. allOf:
  886. - "$ref": "#/definitions/response"
  887. - properties:
  888. data:
  889. type: array
  890. items:
  891. "$ref": "#/definitions/user"
  892. required:
  893. - data
  894. get-patch-post-put-user-response:
  895. allOf:
  896. - "$ref": "#/definitions/response"
  897. - properties:
  898. data:
  899. "$ref": "#/definitions/user"
  900. required:
  901. - data
  902. s3-access-key-expires:
  903. title: Key expiration time
  904. description: The key pair will no longer be valid after this time. Null means
  905. never expires.
  906. type: string
  907. format: date-time
  908. example: '2020-09-04T00:00:00.000Z'
  909. s3-access-key:
  910. title: S3 Access Key
  911. description: S3 credential pair information
  912. type: object
  913. required:
  914. - id
  915. - accountId
  916. - displayName
  917. - userUUID
  918. properties:
  919. id:
  920. title: S3 Credential Pair Identifier
  921. description: a unique identifier for the S3 credential pair (automatically
  922. assigned when an access key is created)
  923. type: string
  924. example: abcABC_01234-0123456789abcABCabc0123456789==
  925. accountId:
  926. title: Account Identifier
  927. description: Storage Tenant Account ID
  928. type: string
  929. example: 12345678901234567890
  930. displayName:
  931. title: Display name
  932. description: Obfuscated Access Key
  933. type: string
  934. example: "****************AB12"
  935. userURN:
  936. title: User Uniform Resource Name
  937. description: contains the user name and Account ID (generated automatically)
  938. type: string
  939. example: urn:sgws:identity::12345678901234567890:root
  940. userUUID:
  941. title: User Universally Unique ID
  942. description: uniquely identifies the user (generated automatically)
  943. type: string
  944. example: 00000000-0000-0000-0000-000000000000
  945. expires:
  946. "$ref": "#/definitions/s3-access-key-expires"
  947. s3-access-key-with-secrets:
  948. title: S3 Access Key with secrets
  949. description: S3 credential pair and associated user/account information
  950. allOf:
  951. - "$ref": "#/definitions/s3-access-key"
  952. - type: object
  953. - properties:
  954. accessKey:
  955. title: Access Key
  956. description: generated automatically (returned only when generated and otherwise
  957. omitted)
  958. type: string
  959. example: ABCDEFabcd1234567890
  960. secretAccessKey:
  961. title: Secret Access Key
  962. description: generated automatically (returned only when generated and otherwise
  963. omitted)
  964. type: string
  965. example: abcABC+123456789012345678901234567890123
  966. list-access-keys-response:
  967. allOf:
  968. - "$ref": "#/definitions/response"
  969. - properties:
  970. data:
  971. type: array
  972. items:
  973. "$ref": "#/definitions/s3-access-key"
  974. required:
  975. - data
  976. get-access-key-response:
  977. allOf:
  978. - "$ref": "#/definitions/response"
  979. - properties:
  980. data:
  981. "$ref": "#/definitions/s3-access-key"
  982. required:
  983. - data
  984. post-access-key-response:
  985. allOf:
  986. - "$ref": "#/definitions/response"
  987. - properties:
  988. data:
  989. "$ref": "#/definitions/s3-access-key-with-secrets"
  990. required:
  991. - data
  992. compliance-global:
  993. title: Compliance Global Settings
  994. type: object
  995. required:
  996. - complianceEnabled
  997. properties:
  998. complianceEnabled:
  999. title: Compliance Enabled
  1000. description: indicates whether compliance is enabled on the grid
  1001. type: boolean
  1002. example: false
  1003. compliance-global-get-response:
  1004. allOf:
  1005. - "$ref": "#/definitions/response"
  1006. - properties:
  1007. data:
  1008. "$ref": "#/definitions/compliance-global"
  1009. required:
  1010. - data
  1011. endpoint-no-id:
  1012. title: Endpoint
  1013. description: The URI and URN for the external resource.
  1014. type: object
  1015. required:
  1016. - displayName
  1017. - endpointURI
  1018. - endpointURN
  1019. properties:
  1020. displayName:
  1021. title: Display Name
  1022. description: the descriptive name that will be displayed for the endpoint;
  1023. does not need to be unique
  1024. type: string
  1025. maxLength: 32
  1026. example: My endpoint
  1027. endpointURI:
  1028. title: Endpoint URI
  1029. description: the Uniform Resource Locator (URL) of the external resource
  1030. type: string
  1031. maxLength: 255
  1032. example: https://s3-aws-region.amazonaws.com
  1033. endpointURN:
  1034. title: Endpoint URN
  1035. description: the Uniform Resource Name (URN) of the external resource; immutable
  1036. once the endpoint is created
  1037. type: string
  1038. maxLength: 255
  1039. example: arn:aws:s3:::bucket_name
  1040. caCert:
  1041. title: CA Certificate
  1042. description: custom certificate used to connect to the endpoint
  1043. type: string
  1044. maxLength: 64000
  1045. example: "-----BEGIN CERTIFICATE----- abcdefghijkl123456780ABCDEFGHIJKL 123456/7890ABCDEFabcdefghijklABCD
  1046. -----END CERTIFICATE-----\n"
  1047. insecureTLS:
  1048. title: Insecure TLS flag
  1049. description: flag to permit insecure Transport Layer Security (TLS) for endpoint
  1050. connections
  1051. type: boolean
  1052. default: false
  1053. credentials:
  1054. title: Endpoint Credentials
  1055. type: object
  1056. properties:
  1057. accessKeyId:
  1058. title: Access key ID
  1059. description: access key credential for this endpoint; will be obfuscated
  1060. in the response
  1061. type: string
  1062. maxLength: 255
  1063. example: ABCDEFabcd1234567890
  1064. secretAccessKey:
  1065. title: Secret access key
  1066. description: secret access key credential for this endpoint; will be obfuscated
  1067. in the response
  1068. type: string
  1069. maxLength: 255
  1070. example: abcABC+123456789012345678901234567890123
  1071. endpoint:
  1072. allOf:
  1073. - "$ref": "#/definitions/endpoint-no-id"
  1074. - type: object
  1075. required:
  1076. - id
  1077. properties:
  1078. id:
  1079. title: Endpoint Identifier
  1080. description: a unique identifier for the endpoint; automatically assigned
  1081. when an endpoint is created
  1082. type: string
  1083. format: uuid
  1084. example: 00000000-0000-0000-0000-000000000000
  1085. endpoint-get-post-put-response:
  1086. allOf:
  1087. - "$ref": "#/definitions/response"
  1088. - properties:
  1089. data:
  1090. "$ref": "#/definitions/endpoint"
  1091. required:
  1092. - data
  1093. endpoint-get-all-response:
  1094. allOf:
  1095. - "$ref": "#/definitions/response"
  1096. - properties:
  1097. data:
  1098. type: array
  1099. items:
  1100. "$ref": "#/definitions/endpoint"
  1101. required:
  1102. - data
  1103. account:
  1104. title: Storage Tenant Account (Organization)
  1105. type: object
  1106. required:
  1107. - id
  1108. - name
  1109. properties:
  1110. id:
  1111. title: Account Identifier
  1112. description: a unique identifier for the account (automatically assigned when
  1113. an account is created)
  1114. type: string
  1115. example: '12345678901234567890'
  1116. name:
  1117. title: Display Name
  1118. description: the descriptive name specified for the account (This name is
  1119. for display only and might not be unique.)
  1120. type: string
  1121. maxLength: 64
  1122. example: Widgets Unlimited
  1123. capabilities:
  1124. title: Capabilities
  1125. description: the high-level features enabled for this account, such as S3
  1126. or Swift protocols (Accounts must have the "management" capability if users
  1127. will sign into the Tenant Manager.)
  1128. type: array
  1129. items:
  1130. type: string
  1131. enum:
  1132. - management
  1133. - s3
  1134. - swift
  1135. example:
  1136. - management
  1137. - s3
  1138. policy:
  1139. description: settings for the tenant account
  1140. "$ref": "#/definitions/policy-account"
  1141. account-usage-response:
  1142. allOf:
  1143. - "$ref": "#/definitions/response"
  1144. - properties:
  1145. data:
  1146. title: Storage Tenant Account usage metrics
  1147. type: object
  1148. required:
  1149. - calculationTime
  1150. - objectCount
  1151. - dataBytes
  1152. properties:
  1153. calculationTime:
  1154. description: time when the usage data was calculated
  1155. type: string
  1156. format: date-time
  1157. objectCount:
  1158. description: number of objects under this Account
  1159. type: integer
  1160. dataBytes:
  1161. description: logical size in bytes of all objects under this Account
  1162. type: integer
  1163. buckets:
  1164. description: per-container usage metrics (including S3 buckets)
  1165. type: array
  1166. items:
  1167. type: object
  1168. title: Container usage metrics
  1169. required:
  1170. - name
  1171. - objectCount
  1172. - dataBytes
  1173. properties:
  1174. name:
  1175. description: container name
  1176. type: string
  1177. objectCount:
  1178. description: number of objects in this container
  1179. type: integer
  1180. dataBytes:
  1181. description: logical size in bytes of all objects in this container
  1182. type: integer
  1183. patch-group-request:
  1184. title: Group
  1185. description: An organizational unit for Users. Groups can be local or federated.
  1186. type: object
  1187. properties:
  1188. displayName:
  1189. title: Display name
  1190. description: the human-readable name for the Group (required for local Groups
  1191. and imported automatically for federated Groups)
  1192. type: string
  1193. example: Developers
  1194. maxLength: 32
  1195. policies:
  1196. description: Permissions for this Group
  1197. "$ref": "#/definitions/policies"
  1198. post-group-request:
  1199. title: Group
  1200. description: An organizational unit for Users. Groups can be local or federated.
  1201. allOf:
  1202. - "$ref": "#/definitions/patch-group-request"
  1203. - required:
  1204. - uniqueName
  1205. - properties:
  1206. uniqueName:
  1207. title: Unique name
  1208. description: the machine-readable name for the Group (unique within an Account;
  1209. must begin with group/ or federated-group/)
  1210. type: string
  1211. example: federated-group/developers
  1212. maxLength: 1024
  1213. group:
  1214. title: Group
  1215. description: An organizational unit for Users. Groups can be local or federated.
  1216. allOf:
  1217. - "$ref": "#/definitions/post-group-request"
  1218. - required:
  1219. - accountId
  1220. - id
  1221. - federated
  1222. - groupURN
  1223. - properties:
  1224. accountId:
  1225. title: Account Identifier
  1226. description: Storage Tenant Account ID
  1227. type: string
  1228. example: '12345678901234567890'
  1229. id:
  1230. title: Id
  1231. description: UUID for the Group (generated automatically)
  1232. type: string
  1233. example: 00000000-0000-0000-0000-000000000000
  1234. federated:
  1235. title: Federated
  1236. description: true if the Group is federated, for example, an LDAP Group
  1237. type: boolean
  1238. groupURN:
  1239. title: Group Uniform Resource Name
  1240. description: contains the Group uniqueName and Account ID (generated automatically)
  1241. type: string
  1242. example: urn:sgws:identity::12345678901234567890:federated-group/developers
  1243. list-groups-response:
  1244. allOf:
  1245. - "$ref": "#/definitions/response"
  1246. - properties:
  1247. data:
  1248. type: array
  1249. items:
  1250. "$ref": "#/definitions/group"
  1251. required:
  1252. - data
  1253. get-patch-post-put-group-response:
  1254. allOf:
  1255. - "$ref": "#/definitions/response"
  1256. - properties:
  1257. data:
  1258. "$ref": "#/definitions/group"
  1259. required:
  1260. - data
  1261. tags:
  1262. - name: auth
  1263. description: Operations on authorization
  1264. - name: identity-source
  1265. description: Operations on identity sources
  1266. - name: containers
  1267. description: Operations on S3 buckets or Swift containers
  1268. - name: regions
  1269. description: Operations on regions
  1270. - name: config
  1271. description: Operations on version or session information
  1272. - name: deactivated-features
  1273. description: Operations on deactivated features
  1274. - name: users
  1275. description: Operations on users
  1276. - name: s3
  1277. description: Operations on S3 Access Keys
  1278. - name: compliance
  1279. description: Operations on compliance
  1280. - name: endpoints
  1281. description: Operations on endpoints
  1282. - name: account
  1283. description: Operations on the current Storage Tenant Account
  1284. - name: groups
  1285. description: Operations on groups
  1286. paths:
  1287. "/authorize":
  1288. post:
  1289. tags:
  1290. - auth
  1291. summary: Get authorization token
  1292. parameters:
  1293. - name: body
  1294. in: body
  1295. required: true
  1296. schema:
  1297. "$ref": "#/definitions/credentials"
  1298. responses:
  1299. 200:
  1300. schema:
  1301. "$ref": "#/definitions/authorize-response"
  1302. headers:
  1303. Cache-Control:
  1304. description: Indicates the time in seconds until the token expires
  1305. type: string
  1306. example: private, no-cache, max-age=57599
  1307. Expires:
  1308. description: Indicates the token expiration time in RFC2616 format
  1309. type: string
  1310. example: Thu, 19 Nov 2015 08:40:58 GMT
  1311. 401:
  1312. description: invalid credentials
  1313. schema:
  1314. "$ref": "#/definitions/error-response"
  1315. default:
  1316. description: General error
  1317. schema:
  1318. "$ref": "#/definitions/error-response"
  1319. delete:
  1320. tags:
  1321. - auth
  1322. summary: Delete authorization token
  1323. responses:
  1324. 204:
  1325. description: successfully deleted
  1326. default:
  1327. description: General error
  1328. schema:
  1329. "$ref": "#/definitions/error-response"
  1330. "/org/identity-source":
  1331. get:
  1332. tags:
  1333. - identity-source
  1334. summary: Lists Identity Sources
  1335. responses:
  1336. 200:
  1337. schema:
  1338. "$ref": "#/definitions/identity-source-get-put-response"
  1339. default:
  1340. description: General error
  1341. schema:
  1342. "$ref": "#/definitions/error-response"
  1343. put:
  1344. tags:
  1345. - identity-source
  1346. summary: Set or update the Identity Source
  1347. parameters:
  1348. - name: body
  1349. in: body
  1350. required: true
  1351. schema:
  1352. "$ref": "#/definitions/identity-source"
  1353. - name: test
  1354. description: 'If specified, tests communication with the identity source,
  1355. but does not modify the stored configuration. Always succeeds if "disable"
  1356. is omitted or set to true.
  1357.  
  1358. '
  1359. in: query
  1360. type: boolean
  1361. responses:
  1362. 200:
  1363. schema:
  1364. "$ref": "#/definitions/identity-source-get-put-response"
  1365. 204:
  1366. description: communication test succeeded
  1367. 422:
  1368. description: validation failure
  1369. schema:
  1370. "$ref": "#/definitions/error-response"
  1371. default:
  1372. description: General error
  1373. schema:
  1374. "$ref": "#/definitions/error-response"
  1375. "/org/identity-source/synchronize":
  1376. post:
  1377. tags:
  1378. - identity-source
  1379. summary: Requests that users and groups from the identity source be synchronized
  1380. as soon as possible
  1381. parameters:
  1382. - name: body
  1383. description: Ignored, leave blank
  1384. in: body
  1385. required: false
  1386. schema:
  1387. type: string
  1388. responses:
  1389. 204:
  1390. description: request successfully received
  1391. default:
  1392. description: General error
  1393. schema:
  1394. "$ref": "#/definitions/error-response"
  1395. "/org/containers":
  1396. get:
  1397. tags:
  1398. - containers
  1399. summary: Lists the S3 buckets or Swift containers for a tenant account
  1400. parameters:
  1401. - name: include
  1402. description: include optional information (S3 only)
  1403. in: query
  1404. type: array
  1405. items:
  1406. type: string
  1407. enum:
  1408. - compliance
  1409. - region
  1410. responses:
  1411. 200:
  1412. schema:
  1413. "$ref": "#/definitions/container-list-response"
  1414. default:
  1415. description: General error
  1416. schema:
  1417. "$ref": "#/definitions/error-response"
  1418. post:
  1419. tags:
  1420. - containers
  1421. summary: Create a bucket for an S3 tenant account
  1422. parameters:
  1423. - name: body
  1424. in: body
  1425. description: Parameters for creating an S3 bucket
  1426. required: true
  1427. schema:
  1428. "$ref": "#/definitions/container-create"
  1429. responses:
  1430. 201:
  1431. description: successfully created
  1432. schema:
  1433. "$ref": "#/definitions/container-create-response"
  1434. default:
  1435. description: General error
  1436. schema:
  1437. "$ref": "#/definitions/error-response"
  1438. "/org/containers/{bucketName}/compliance":
  1439. get:
  1440. tags:
  1441. - containers
  1442. summary: Gets the compliance settings for an S3 bucket
  1443. parameters:
  1444. - name: bucketName
  1445. in: path
  1446. description: S3 bucket name
  1447. required: true
  1448. type: string
  1449. responses:
  1450. 200:
  1451. schema:
  1452. "$ref": "#/definitions/container-compliance-settings-get-put-response"
  1453. 404:
  1454. description: bucket not found or is not compliant
  1455. schema:
  1456. "$ref": "#/definitions/error-response"
  1457. default:
  1458. description: General error
  1459. schema:
  1460. "$ref": "#/definitions/error-response"
  1461. put:
  1462. tags:
  1463. - containers
  1464. summary: Sets the compliance settings for an S3 bucket
  1465. parameters:
  1466. - name: bucketName
  1467. in: path
  1468. description: S3 bucket name
  1469. required: true
  1470. type: string
  1471. - name: force
  1472. description: if set, the Strong-site consistency level is used (if not set,
  1473. the Strong-global consistency level is used); only use when directed by
  1474. technical support
  1475. in: query
  1476. type: boolean
  1477. - name: body
  1478. in: body
  1479. required: true
  1480. schema:
  1481. "$ref": "#/definitions/container-compliance-settings"
  1482. responses:
  1483. 200:
  1484. schema:
  1485. "$ref": "#/definitions/container-compliance-settings-get-put-response"
  1486. 404:
  1487. description: bucket not found or is not compliant
  1488. schema:
  1489. "$ref": "#/definitions/error-response"
  1490. 422:
  1491. description: validation failure
  1492. schema:
  1493. "$ref": "#/definitions/error-response"
  1494. 503:
  1495. description: unable to achieve the requested consistency level
  1496. schema:
  1497. "$ref": "#/definitions/error-response"
  1498. default:
  1499. description: General error
  1500. schema:
  1501. "$ref": "#/definitions/error-response"
  1502. "/org/containers/{containerName}/consistency":
  1503. get:
  1504. tags:
  1505. - containers
  1506. summary: Gets the consistency level for an S3 bucket or Swift container
  1507. parameters:
  1508. - name: containerName
  1509. in: path
  1510. description: S3 bucket or Swift container name
  1511. required: true
  1512. type: string
  1513. responses:
  1514. 200:
  1515. schema:
  1516. "$ref": "#/definitions/container-consistency-get-put-response"
  1517. default:
  1518. description: General error
  1519. schema:
  1520. "$ref": "#/definitions/error-response"
  1521. put:
  1522. tags:
  1523. - containers
  1524. summary: Sets the consistency level for an S3 bucket or Swift container
  1525. parameters:
  1526. - name: containerName
  1527. in: path
  1528. description: S3 bucket or Swift container name
  1529. required: true
  1530. type: string
  1531. - name: body
  1532. in: body
  1533. required: true
  1534. schema:
  1535. "$ref": "#/definitions/container-consistency"
  1536. responses:
  1537. 200:
  1538. schema:
  1539. "$ref": "#/definitions/container-consistency-get-put-response"
  1540. default:
  1541. description: General error
  1542. schema:
  1543. "$ref": "#/definitions/error-response"
  1544. "/org/containers/{bucketName}/cors":
  1545. get:
  1546. tags:
  1547. - containers
  1548. summary: Gets the Cross-Origin Resource Sharing (CORS) configuration for an
  1549. S3 bucket
  1550. parameters:
  1551. - name: bucketName
  1552. in: path
  1553. description: S3 bucket name
  1554. required: true
  1555. type: string
  1556. responses:
  1557. 200:
  1558. schema:
  1559. "$ref": "#/definitions/container-cors-configuration-get-put-response"
  1560. default:
  1561. description: General error
  1562. schema:
  1563. "$ref": "#/definitions/error-response"
  1564. put:
  1565. tags:
  1566. - containers
  1567. summary: Sets the Cross-Origin Resource Sharing (CORS) configuration for an
  1568. S3 bucket
  1569. parameters:
  1570. - name: bucketName
  1571. in: path
  1572. description: S3 bucket name
  1573. required: true
  1574. type: string
  1575. - name: body
  1576. in: body
  1577. required: true
  1578. schema:
  1579. "$ref": "#/definitions/container-cors-configuration"
  1580. responses:
  1581. 200:
  1582. schema:
  1583. "$ref": "#/definitions/container-cors-configuration-get-put-response"
  1584. default:
  1585. description: General error
  1586. schema:
  1587. "$ref": "#/definitions/error-response"
  1588. "/org/containers/{bucketName}/last-access-time":
  1589. get:
  1590. tags:
  1591. - containers
  1592. summary: Determines if last access time is enabled for an S3 bucket
  1593. parameters:
  1594. - name: bucketName
  1595. in: path
  1596. description: S3 bucket name
  1597. required: true
  1598. type: string
  1599. responses:
  1600. 200:
  1601. schema:
  1602. "$ref": "#/definitions/container-last-access-time-get-put-response"
  1603. default:
  1604. description: General error
  1605. schema:
  1606. "$ref": "#/definitions/error-response"
  1607. put:
  1608. tags:
  1609. - containers
  1610. summary: Enables or disables last access time updates for an S3 bucket
  1611. parameters:
  1612. - name: bucketName
  1613. in: path
  1614. description: S3 bucket name
  1615. required: true
  1616. type: string
  1617. - name: body
  1618. in: body
  1619. required: true
  1620. schema:
  1621. "$ref": "#/definitions/container-last-access-time"
  1622. responses:
  1623. 200:
  1624. schema:
  1625. "$ref": "#/definitions/container-last-access-time-get-put-response"
  1626. default:
  1627. description: General error
  1628. schema:
  1629. "$ref": "#/definitions/error-response"
  1630. "/org/containers/{bucketName}/metadata-notification":
  1631. get:
  1632. tags:
  1633. - containers
  1634. summary: Gets the metadata notification (search) configuration for an S3 bucket
  1635. parameters:
  1636. - name: bucketName
  1637. in: path
  1638. description: S3 bucket name
  1639. required: true
  1640. type: string
  1641. responses:
  1642. 200:
  1643. schema:
  1644. "$ref": "#/definitions/container-metadata-notification-configuration-get-put-response"
  1645. default:
  1646. description: General error
  1647. schema:
  1648. "$ref": "#/definitions/error-response"
  1649. put:
  1650. tags:
  1651. - containers
  1652. summary: Sets the metadata notification (search) configuration for an S3 bucket
  1653. parameters:
  1654. - name: bucketName
  1655. in: path
  1656. description: S3 bucket name
  1657. required: true
  1658. type: string
  1659. - name: body
  1660. in: body
  1661. required: true
  1662. schema:
  1663. "$ref": "#/definitions/container-metadata-notification-configuration"
  1664. responses:
  1665. 200:
  1666. schema:
  1667. "$ref": "#/definitions/container-metadata-notification-configuration-get-put-response"
  1668. default:
  1669. description: General error
  1670. schema:
  1671. "$ref": "#/definitions/error-response"
  1672. "/org/containers/{bucketName}/notification":
  1673. get:
  1674. tags:
  1675. - containers
  1676. summary: Gets the notification configuration for an S3 bucket
  1677. parameters:
  1678. - name: bucketName
  1679. in: path
  1680. description: S3 bucket name
  1681. required: true
  1682. type: string
  1683. responses:
  1684. 200:
  1685. schema:
  1686. "$ref": "#/definitions/container-notification-configuration-get-put-response"
  1687. default:
  1688. description: General error
  1689. schema:
  1690. "$ref": "#/definitions/error-response"
  1691. put:
  1692. tags:
  1693. - containers
  1694. summary: Sets the notification configuration for an S3 bucket
  1695. parameters:
  1696. - name: bucketName
  1697. in: path
  1698. description: S3 bucket name
  1699. required: true
  1700. type: string
  1701. - name: body
  1702. in: body
  1703. required: true
  1704. schema:
  1705. "$ref": "#/definitions/container-notification-configuration"
  1706. responses:
  1707. 200:
  1708. schema:
  1709. "$ref": "#/definitions/container-notification-configuration-get-put-response"
  1710. default:
  1711. description: General error
  1712. schema:
  1713. "$ref": "#/definitions/error-response"
  1714. "/org/containers/{bucketName}/replication":
  1715. get:
  1716. tags:
  1717. - containers
  1718. summary: Gets the replication configuration for an S3 bucket
  1719. parameters:
  1720. - name: bucketName
  1721. in: path
  1722. description: S3 bucket name
  1723. required: true
  1724. type: string
  1725. responses:
  1726. 200:
  1727. schema:
  1728. "$ref": "#/definitions/container-replication-configuration-get-put-response"
  1729. default:
  1730. description: General error
  1731. schema:
  1732. "$ref": "#/definitions/error-response"
  1733. put:
  1734. tags:
  1735. - containers
  1736. summary: Sets the replication configuration for an S3 bucket
  1737. parameters:
  1738. - name: bucketName
  1739. in: path
  1740. description: S3 bucket name
  1741. required: true
  1742. type: string
  1743. - name: body
  1744. in: body
  1745. required: true
  1746. schema:
  1747. "$ref": "#/definitions/container-replication-configuration"
  1748. responses:
  1749. 200:
  1750. schema:
  1751. "$ref": "#/definitions/container-replication-configuration-get-put-response"
  1752. default:
  1753. description: General error
  1754. schema:
  1755. "$ref": "#/definitions/error-response"
  1756. "/org/regions":
  1757. get:
  1758. tags:
  1759. - regions
  1760. summary: Lists configured regions
  1761. responses:
  1762. 200:
  1763. schema:
  1764. "$ref": "#/definitions/regions-get-response"
  1765. default:
  1766. description: General error
  1767. schema:
  1768. "$ref": "#/definitions/error-response"
  1769. "/org/config":
  1770. get:
  1771. tags:
  1772. - config
  1773. summary: Retrieves global configuration and token information
  1774. responses:
  1775. 200:
  1776. schema:
  1777. "$ref": "#/definitions/config-get-response"
  1778. default:
  1779. description: General error
  1780. schema:
  1781. "$ref": "#/definitions/error-response"
  1782. "/org/config/product-version":
  1783. get:
  1784. tags:
  1785. - config
  1786. summary: Retrieves the product release version
  1787. responses:
  1788. 200:
  1789. schema:
  1790. "$ref": "#/definitions/product-version-get-response"
  1791. default:
  1792. description: General error
  1793. schema:
  1794. "$ref": "#/definitions/error-response"
  1795. "/versions":
  1796. get:
  1797. tags:
  1798. - config
  1799. summary: 'Retrieves the major versions of the management API supported by the
  1800. product release
  1801.  
  1802. '
  1803. responses:
  1804. 200:
  1805. schema:
  1806. "$ref": "#/definitions/api-versions-get-response"
  1807. default:
  1808. description: General error
  1809. schema:
  1810. "$ref": "#/definitions/error-response"
  1811. "/org/deactivated-features":
  1812. get:
  1813. tags:
  1814. - deactivated-features
  1815. summary: Retrieves the currently deactivated features
  1816. responses:
  1817. 200:
  1818. schema:
  1819. "$ref": "#/definitions/deactivated-features-get-response"
  1820. default:
  1821. description: General error
  1822. schema:
  1823. "$ref": "#/definitions/error-response"
  1824. "/org/users":
  1825. get:
  1826. tags:
  1827. - users
  1828. summary: Lists Tenant Users
  1829. parameters:
  1830. - name: type
  1831. description: filter by user type
  1832. in: query
  1833. type: string
  1834. enum:
  1835. - local
  1836. - federated
  1837. - name: limit
  1838. description: maximum number of results
  1839. in: query
  1840. type: integer
  1841. default: 25
  1842. maximum: 500
  1843. - name: marker
  1844. description: marker-style pagination offset (value is User's URN)
  1845. in: query
  1846. type: string
  1847. - name: includeMarker
  1848. description: if set, the marker element is also returned
  1849. in: query
  1850. type: boolean
  1851. - name: order
  1852. description: pagination order (desc requires marker)
  1853. in: query
  1854. type: string
  1855. enum:
  1856. - asc
  1857. - desc
  1858. responses:
  1859. 200:
  1860. schema:
  1861. "$ref": "#/definitions/list-users-response"
  1862. default:
  1863. description: General error
  1864. schema:
  1865. "$ref": "#/definitions/error-response"
  1866. post:
  1867. tags:
  1868. - users
  1869. summary: Creates a new local Tenant User
  1870. parameters:
  1871. - name: body
  1872. in: body
  1873. required: true
  1874. schema:
  1875. "$ref": "#/definitions/post-user-request"
  1876. responses:
  1877. 201:
  1878. description: successfully created
  1879. schema:
  1880. "$ref": "#/definitions/get-patch-post-put-user-response"
  1881. 422:
  1882. description: validation failure
  1883. schema:
  1884. "$ref": "#/definitions/error-response"
  1885. default:
  1886. description: General error
  1887. schema:
  1888. "$ref": "#/definitions/error-response"
  1889. "/org/users/current-user/change-password":
  1890. post:
  1891. tags:
  1892. - users
  1893. summary: Updates the current Tenant User's password
  1894. parameters:
  1895. - name: body
  1896. in: body
  1897. required: true
  1898. schema:
  1899. "$ref": "#/definitions/password-change-request"
  1900. responses:
  1901. 204:
  1902. description: successfully updated
  1903. 422:
  1904. description: validation failure
  1905. schema:
  1906. "$ref": "#/definitions/error-response"
  1907. default:
  1908. description: General error
  1909. schema:
  1910. "$ref": "#/definitions/error-response"
  1911. "/org/users/user/{shortName}":
  1912. get:
  1913. tags:
  1914. - users
  1915. summary: Retrieves a local Tenant User by unique name
  1916. parameters:
  1917. - name: shortName
  1918. in: path
  1919. description: uniqueName minus prefix
  1920. required: true
  1921. type: string
  1922. responses:
  1923. 200:
  1924. schema:
  1925. "$ref": "#/definitions/get-patch-post-put-user-response"
  1926. default:
  1927. description: General error
  1928. schema:
  1929. "$ref": "#/definitions/error-response"
  1930. "/org/users/user/{shortName}/change-password":
  1931. post:
  1932. tags:
  1933. - users
  1934. summary: Updates a local Tenant User password by unique name
  1935. parameters:
  1936. - name: shortName
  1937. in: path
  1938. description: uniqueName minus prefix
  1939. required: true
  1940. type: string
  1941. - name: body
  1942. in: body
  1943. required: true
  1944. schema:
  1945. "$ref": "#/definitions/password-change-request"
  1946. responses:
  1947. 204:
  1948. description: successfully updated
  1949. 422:
  1950. description: validation failure
  1951. schema:
  1952. "$ref": "#/definitions/error-response"
  1953. default:
  1954. description: General error
  1955. schema:
  1956. "$ref": "#/definitions/error-response"
  1957. "/org/users/federated-user/{shortName}":
  1958. get:
  1959. tags:
  1960. - users
  1961. summary: Retrieves a federated Tenant User by unique name
  1962. parameters:
  1963. - name: shortName
  1964. in: path
  1965. description: uniqueName minus prefix
  1966. required: true
  1967. type: string
  1968. responses:
  1969. 200:
  1970. schema:
  1971. "$ref": "#/definitions/get-patch-post-put-user-response"
  1972. default:
  1973. description: General error
  1974. schema:
  1975. "$ref": "#/definitions/error-response"
  1976. "/org/users/root":
  1977. get:
  1978. tags:
  1979. - users
  1980. summary: Retrieves the root Tenant User
  1981. responses:
  1982. 200:
  1983. schema:
  1984. "$ref": "#/definitions/get-patch-post-put-user-response"
  1985. default:
  1986. description: General error
  1987. schema:
  1988. "$ref": "#/definitions/error-response"
  1989. "/org/users/root/change-password":
  1990. post:
  1991. tags:
  1992. - users
  1993. summary: Updates the root Tenant User password
  1994. parameters:
  1995. - name: body
  1996. in: body
  1997. required: true
  1998. schema:
  1999. "$ref": "#/definitions/password-change-request"
  2000. responses:
  2001. 204:
  2002. description: successfully updated
  2003. 422:
  2004. description: validation failure
  2005. schema:
  2006. "$ref": "#/definitions/error-response"
  2007. default:
  2008. description: General error
  2009. schema:
  2010. "$ref": "#/definitions/error-response"
  2011. "/org/users/{id}":
  2012. get:
  2013. tags:
  2014. - users
  2015. summary: Retrieves a single Tenant User
  2016. parameters:
  2017. - name: id
  2018. in: path
  2019. description: User ID
  2020. required: true
  2021. type: string
  2022. responses:
  2023. 200:
  2024. schema:
  2025. "$ref": "#/definitions/get-patch-post-put-user-response"
  2026. default:
  2027. description: General error
  2028. schema:
  2029. "$ref": "#/definitions/error-response"
  2030. delete:
  2031. tags:
  2032. - users
  2033. summary: Deletes a single Tenant User
  2034. parameters:
  2035. - name: id
  2036. in: path
  2037. description: User ID
  2038. required: true
  2039. type: string
  2040. responses:
  2041. 204:
  2042. description: successfully deleted
  2043. default:
  2044. description: General error
  2045. schema:
  2046. "$ref": "#/definitions/error-response"
  2047. patch:
  2048. tags:
  2049. - users
  2050. summary: Updates a single Tenant User
  2051. parameters:
  2052. - name: id
  2053. in: path
  2054. description: User ID
  2055. required: true
  2056. type: string
  2057. - name: body
  2058. in: body
  2059. required: true
  2060. schema:
  2061. "$ref": "#/definitions/patch-user-request"
  2062. responses:
  2063. 200:
  2064. schema:
  2065. "$ref": "#/definitions/get-patch-post-put-user-response"
  2066. default:
  2067. description: General error
  2068. schema:
  2069. "$ref": "#/definitions/error-response"
  2070. put:
  2071. tags:
  2072. - users
  2073. summary: Replaces a single Tenant User
  2074. parameters:
  2075. - name: id
  2076. in: path
  2077. description: User ID
  2078. required: true
  2079. type: string
  2080. - in: body
  2081. name: body
  2082. required: true
  2083. schema:
  2084. "$ref": "#/definitions/user"
  2085. responses:
  2086. 200:
  2087. description: successfully replaced
  2088. schema:
  2089. "$ref": "#/definitions/get-patch-post-put-user-response"
  2090. default:
  2091. description: General error
  2092. schema:
  2093. "$ref": "#/definitions/error-response"
  2094. "/org/users/{id}/change-password":
  2095. post:
  2096. tags:
  2097. - users
  2098. summary: Updates a local Tenant User password by UUID
  2099. parameters:
  2100. - name: id
  2101. in: path
  2102. description: User ID
  2103. required: true
  2104. type: string
  2105. - name: body
  2106. in: body
  2107. required: true
  2108. schema:
  2109. "$ref": "#/definitions/password-change-request"
  2110. responses:
  2111. 204:
  2112. description: successfully updated
  2113. 422:
  2114. description: validation failure
  2115. schema:
  2116. "$ref": "#/definitions/error-response"
  2117. default:
  2118. description: General error
  2119. schema:
  2120. "$ref": "#/definitions/error-response"
  2121. "/org/users/current-user/s3-access-keys":
  2122. get:
  2123. tags:
  2124. - s3
  2125. summary: Lists S3 Access Keys for the current User
  2126. responses:
  2127. 200:
  2128. schema:
  2129. "$ref": "#/definitions/list-access-keys-response"
  2130. default:
  2131. description: General error
  2132. schema:
  2133. "$ref": "#/definitions/error-response"
  2134. post:
  2135. tags:
  2136. - s3
  2137. summary: Creates a new S3 Access Key for the current User
  2138. parameters:
  2139. - name: body
  2140. in: body
  2141. required: true
  2142. schema:
  2143. type: object
  2144. properties:
  2145. expires:
  2146. "$ref": "#/definitions/s3-access-key-expires"
  2147. responses:
  2148. 201:
  2149. description: successfully created
  2150. schema:
  2151. "$ref": "#/definitions/post-access-key-response"
  2152. 422:
  2153. description: validation failure
  2154. schema:
  2155. "$ref": "#/definitions/error-response"
  2156. default:
  2157. description: General error
  2158. schema:
  2159. "$ref": "#/definitions/error-response"
  2160. "/org/users/current-user/s3-access-keys/{accessKey}":
  2161. get:
  2162. tags:
  2163. - s3
  2164. summary: Retrieves a single S3 Access Key for the current User
  2165. parameters:
  2166. - name: accessKey
  2167. in: path
  2168. description: Access Key
  2169. required: true
  2170. type: string
  2171. responses:
  2172. 200:
  2173. schema:
  2174. "$ref": "#/definitions/get-access-key-response"
  2175. default:
  2176. description: General error
  2177. schema:
  2178. "$ref": "#/definitions/error-response"
  2179. delete:
  2180. tags:
  2181. - s3
  2182. summary: Deletes a single S3 Access Key for the current User
  2183. parameters:
  2184. - name: accessKey
  2185. in: path
  2186. description: Access Key or S3 credential pair identifier
  2187. required: true
  2188. type: string
  2189. responses:
  2190. 204:
  2191. description: successfully deleted
  2192. default:
  2193. description: General error
  2194. schema:
  2195. "$ref": "#/definitions/error-response"
  2196. "/org/users/{userId}/s3-access-keys":
  2197. get:
  2198. tags:
  2199. - s3
  2200. summary: Lists S3 Access Keys for a given User
  2201. parameters:
  2202. - name: userId
  2203. in: path
  2204. description: User ID
  2205. required: true
  2206. type: string
  2207. responses:
  2208. 200:
  2209. schema:
  2210. "$ref": "#/definitions/list-access-keys-response"
  2211. default:
  2212. description: General error
  2213. schema:
  2214. "$ref": "#/definitions/error-response"
  2215. post:
  2216. tags:
  2217. - s3
  2218. summary: Creates a new S3 Access Key for a given User
  2219. parameters:
  2220. - name: userId
  2221. in: path
  2222. description: User ID
  2223. required: true
  2224. type: string
  2225. - name: body
  2226. in: body
  2227. required: true
  2228. schema:
  2229. type: object
  2230. properties:
  2231. expires:
  2232. "$ref": "#/definitions/s3-access-key-expires"
  2233. responses:
  2234. 201:
  2235. description: successfully created
  2236. schema:
  2237. "$ref": "#/definitions/post-access-key-response"
  2238. 422:
  2239. description: validation failure
  2240. schema:
  2241. "$ref": "#/definitions/error-response"
  2242. default:
  2243. description: General error
  2244. schema:
  2245. "$ref": "#/definitions/error-response"
  2246. "/org/users/{userId}/s3-access-keys/{accessKey}":
  2247. get:
  2248. tags:
  2249. - s3
  2250. summary: Retrieves a single S3 Access Key for a given User
  2251. parameters:
  2252. - name: userId
  2253. in: path
  2254. description: User ID
  2255. required: true
  2256. type: string
  2257. - name: accessKey
  2258. in: path
  2259. description: Access Key
  2260. required: true
  2261. type: string
  2262. responses:
  2263. 200:
  2264. schema:
  2265. "$ref": "#/definitions/get-access-key-response"
  2266. default:
  2267. description: General error
  2268. schema:
  2269. "$ref": "#/definitions/error-response"
  2270. delete:
  2271. tags:
  2272. - s3
  2273. summary: Deletes a single S3 Access Key for a given User
  2274. parameters:
  2275. - name: userId
  2276. in: path
  2277. description: User ID
  2278. required: true
  2279. type: string
  2280. - name: accessKey
  2281. in: path
  2282. description: Access Key or S3 credential pair identifier
  2283. required: true
  2284. type: string
  2285. responses:
  2286. 204:
  2287. description: successfully deleted
  2288. default:
  2289. description: General error
  2290. schema:
  2291. "$ref": "#/definitions/error-response"
  2292. "/org/compliance-global":
  2293. get:
  2294. tags:
  2295. - compliance
  2296. summary: Retrieves the global compliance settings
  2297. responses:
  2298. 200:
  2299. schema:
  2300. "$ref": "#/definitions/compliance-global-get-response"
  2301. default:
  2302. description: General error
  2303. schema:
  2304. "$ref": "#/definitions/error-response"
  2305. "/org/endpoints":
  2306. get:
  2307. tags:
  2308. - endpoints
  2309. summary: Gets the list of endpoints
  2310. parameters:
  2311. - name: limit
  2312. description: maximum number of results
  2313. in: query
  2314. type: integer
  2315. default: 25
  2316. maximum: 500
  2317. - name: marker
  2318. description: marker-style pagination offset (value is Endpoint's URN)
  2319. in: query
  2320. type: string
  2321. - name: includeMarker
  2322. description: if set, the marker element is also returned
  2323. in: query
  2324. type: boolean
  2325. - name: order
  2326. description: pagination order (desc requires marker)
  2327. in: query
  2328. type: string
  2329. enum:
  2330. - asc
  2331. - desc
  2332. responses:
  2333. 200:
  2334. schema:
  2335. "$ref": "#/definitions/endpoint-get-all-response"
  2336. default:
  2337. description: General error
  2338. schema:
  2339. "$ref": "#/definitions/error-response"
  2340. post:
  2341. tags:
  2342. - endpoints
  2343. summary: Creates a new endpoint
  2344. parameters:
  2345. - name: body
  2346. in: body
  2347. required: true
  2348. schema:
  2349. "$ref": "#/definitions/endpoint-no-id"
  2350. - name: test
  2351. description: 'If specified, tests the validity of the endpoint, but does not
  2352. save the endpoint.
  2353.  
  2354. '
  2355. in: query
  2356. type: boolean
  2357. - name: forceSave
  2358. description: save the endpoint without testing its validity
  2359. in: query
  2360. type: boolean
  2361. responses:
  2362. 201:
  2363. description: successfully created
  2364. schema:
  2365. "$ref": "#/definitions/endpoint-get-post-put-response"
  2366. 204:
  2367. description: endpoint validation test succeeded
  2368. 422:
  2369. description: validation failure
  2370. schema:
  2371. "$ref": "#/definitions/error-response"
  2372. default:
  2373. description: General error
  2374. schema:
  2375. "$ref": "#/definitions/error-response"
  2376. "/org/endpoints/{id}":
  2377. get:
  2378. tags:
  2379. - endpoints
  2380. summary: Retrieves a single endpoint
  2381. parameters:
  2382. - name: id
  2383. in: path
  2384. description: Endpoint ID
  2385. required: true
  2386. type: string
  2387. responses:
  2388. 200:
  2389. schema:
  2390. "$ref": "#/definitions/endpoint-get-post-put-response"
  2391. default:
  2392. description: General error
  2393. schema:
  2394. "$ref": "#/definitions/error-response"
  2395. delete:
  2396. tags:
  2397. - endpoints
  2398. summary: Deletes a single endpoint
  2399. parameters:
  2400. - name: id
  2401. in: path
  2402. description: Endpoint ID
  2403. required: true
  2404. type: string
  2405. responses:
  2406. 204:
  2407. description: successfully deleted
  2408. default:
  2409. description: General error
  2410. schema:
  2411. "$ref": "#/definitions/error-response"
  2412. put:
  2413. tags:
  2414. - endpoints
  2415. summary: Replaces a single endpoint
  2416. parameters:
  2417. - name: id
  2418. in: path
  2419. description: Endpoint ID
  2420. required: true
  2421. type: string
  2422. - name: body
  2423. in: body
  2424. required: true
  2425. schema:
  2426. "$ref": "#/definitions/endpoint"
  2427. - name: test
  2428. description: 'If specified, tests the validity of the endpoint, but does not
  2429. modify the stored endpoint.
  2430.  
  2431. '
  2432. in: query
  2433. type: boolean
  2434. - name: forceSave
  2435. description: update the endpoint without testing its validity
  2436. in: query
  2437. type: boolean
  2438. responses:
  2439. 200:
  2440. description: successfully changed
  2441. schema:
  2442. "$ref": "#/definitions/endpoint-get-post-put-response"
  2443. 204:
  2444. description: endpoint validation test succeeded
  2445. 422:
  2446. description: validation failure
  2447. schema:
  2448. "$ref": "#/definitions/error-response"
  2449. default:
  2450. description: General error
  2451. schema:
  2452. "$ref": "#/definitions/error-response"
  2453. "/org/usage":
  2454. get:
  2455. tags:
  2456. - account
  2457. summary: Gets the storage usage information for the current Storage Tenant Account
  2458. responses:
  2459. 200:
  2460. schema:
  2461. "$ref": "#/definitions/account-usage-response"
  2462. default:
  2463. description: General error
  2464. schema:
  2465. "$ref": "#/definitions/error-response"
  2466. "/org/groups":
  2467. get:
  2468. tags:
  2469. - groups
  2470. summary: Lists Tenant User Groups
  2471. parameters:
  2472. - name: type
  2473. description: filter by group type
  2474. in: query
  2475. type: string
  2476. enum:
  2477. - local
  2478. - federated
  2479. - name: limit
  2480. description: maximum number of results
  2481. in: query
  2482. type: integer
  2483. default: 25
  2484. maximum: 500
  2485. - name: marker
  2486. description: marker-style pagination offset (value is Group's URN)
  2487. in: query
  2488. type: string
  2489. - name: includeMarker
  2490. description: if set, the marker element is also returned
  2491. in: query
  2492. type: boolean
  2493. - name: order
  2494. description: pagination order (desc requires marker)
  2495. in: query
  2496. type: string
  2497. enum:
  2498. - asc
  2499. - desc
  2500. responses:
  2501. 200:
  2502. schema:
  2503. "$ref": "#/definitions/list-groups-response"
  2504. default:
  2505. description: General error
  2506. schema:
  2507. "$ref": "#/definitions/error-response"
  2508. post:
  2509. tags:
  2510. - groups
  2511. summary: Creates a new Tenant User Group
  2512. parameters:
  2513. - name: body
  2514. in: body
  2515. required: true
  2516. schema:
  2517. "$ref": "#/definitions/post-group-request"
  2518. responses:
  2519. 201:
  2520. description: successfully created
  2521. schema:
  2522. "$ref": "#/definitions/get-patch-post-put-group-response"
  2523. 422:
  2524. description: validation failure
  2525. schema:
  2526. "$ref": "#/definitions/error-response"
  2527. default:
  2528. description: General error
  2529. schema:
  2530. "$ref": "#/definitions/error-response"
  2531. "/org/groups/group/{shortName}":
  2532. get:
  2533. tags:
  2534. - groups
  2535. summary: Retrieves a local Tenant User Group by unique name
  2536. parameters:
  2537. - name: shortName
  2538. in: path
  2539. description: uniqueName minus prefix
  2540. required: true
  2541. type: string
  2542. responses:
  2543. 200:
  2544. schema:
  2545. "$ref": "#/definitions/get-patch-post-put-group-response"
  2546. default:
  2547. description: General error
  2548. schema:
  2549. "$ref": "#/definitions/error-response"
  2550. "/org/groups/federated-group/{shortName}":
  2551. get:
  2552. tags:
  2553. - groups
  2554. summary: Retrieves a federated Tenant User Group by unique name
  2555. parameters:
  2556. - name: shortName
  2557. in: path
  2558. description: uniqueName minus prefix
  2559. required: true
  2560. type: string
  2561. responses:
  2562. 200:
  2563. schema:
  2564. "$ref": "#/definitions/get-patch-post-put-group-response"
  2565. default:
  2566. description: General error
  2567. schema:
  2568. "$ref": "#/definitions/error-response"
  2569. "/org/groups/{id}":
  2570. get:
  2571. tags:
  2572. - groups
  2573. summary: Retrieves a single Tenant User Group by UUID
  2574. parameters:
  2575. - name: id
  2576. in: path
  2577. description: Group ID
  2578. required: true
  2579. type: string
  2580. responses:
  2581. 200:
  2582. schema:
  2583. "$ref": "#/definitions/get-patch-post-put-group-response"
  2584. default:
  2585. description: General error
  2586. schema:
  2587. "$ref": "#/definitions/error-response"
  2588. delete:
  2589. tags:
  2590. - groups
  2591. summary: Deletes a single Tenant User Group
  2592. parameters:
  2593. - name: id
  2594. in: path
  2595. description: Group ID
  2596. required: true
  2597. type: string
  2598. responses:
  2599. 204:
  2600. description: successfully deleted
  2601. default:
  2602. description: General error
  2603. schema:
  2604. "$ref": "#/definitions/error-response"
  2605. patch:
  2606. tags:
  2607. - groups
  2608. summary: Updates a single Tenant User Group
  2609. parameters:
  2610. - name: id
  2611. in: path
  2612. description: Group ID
  2613. required: true
  2614. type: string
  2615. - name: body
  2616. in: body
  2617. required: true
  2618. schema:
  2619. "$ref": "#/definitions/patch-group-request"
  2620. responses:
  2621. 200:
  2622. schema:
  2623. "$ref": "#/definitions/get-patch-post-put-group-response"
  2624. default:
  2625. description: General error
  2626. schema:
  2627. "$ref": "#/definitions/error-response"
  2628. put:
  2629. tags:
  2630. - groups
  2631. summary: Replaces a single Tenant User Group
  2632. parameters:
  2633. - name: id
  2634. in: path
  2635. description: Group ID
  2636. required: true
  2637. type: string
  2638. - in: body
  2639. name: body
  2640. required: true
  2641. schema:
  2642. "$ref": "#/definitions/group"
  2643. responses:
  2644. 200:
  2645. description: successfully replaced
  2646. schema:
  2647. "$ref": "#/definitions/get-patch-post-put-group-response"
  2648. default:
  2649. description: General error
  2650. schema:
  2651. "$ref": "#/definitions/error-response"
Advertisement
Add Comment
Please, Sign In to add comment
Advertisement
Public Pastes
Advertisement
We use cookies for various purposes including analytics. By continuing to use Pastebin, you agree to our use of cookies as described in the Cookies Policy.  OK, I Understand
Not a member of Pastebin yet?
Sign Up, it unlocks many cool features!