{
  "opencollection": "1.0.0",
  "info": {
    "name": "Managed Database for PostgreSQL and MySQL Access Control List Users API",
    "version": "v1"
  },
  "items": [
    {
      "info": {
        "name": "Users",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List users of a Database Instance",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.scaleway.com/rdb/v1/regions/:region/instances/:instance_id/users",
            "params": [
              {
                "name": "region",
                "value": "",
                "type": "path",
                "description": "The region you want to target"
              },
              {
                "name": "instance_id",
                "value": "",
                "type": "path",
                "description": "UUID of the Database Instance."
              },
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "Name of the user."
              },
              {
                "name": "order_by",
                "value": "",
                "type": "query",
                "description": "Criteria to use when requesting user listing."
              },
              {
                "name": "page",
                "value": "",
                "type": "query"
              },
              {
                "name": "page_size",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "List all users of a given Database Instance. By default, the users returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field."
        },
        {
          "info": {
            "name": "Create a user for a Database Instance",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.scaleway.com/rdb/v1/regions/:region/instances/:instance_id/users",
            "params": [
              {
                "name": "region",
                "value": "",
                "type": "path",
                "description": "The region you want to target"
              },
              {
                "name": "instance_id",
                "value": "",
                "type": "path",
                "description": "UUID of the Database Instance in which you want to create a user."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Create a new user for a Database Instance. You must define the `name`, `password` and `is_admin` parameters."
        },
        {
          "info": {
            "name": "Update a user on a Database Instance",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.scaleway.com/rdb/v1/regions/:region/instances/:instance_id/users/:name",
            "params": [
              {
                "name": "region",
                "value": "",
                "type": "path",
                "description": "The region you want to target"
              },
              {
                "name": "instance_id",
                "value": "",
                "type": "path",
                "description": "UUID of the Database Instance the user belongs to."
              },
              {
                "name": "name",
                "value": "",
                "type": "path",
                "description": "Name of the database user."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Update the parameters of a user on a Database Instance. You can update the `password` and `is_admin` parameters, but you cannot change the name of the user."
        },
        {
          "info": {
            "name": "Delete a user on a Database Instance",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.scaleway.com/rdb/v1/regions/:region/instances/:instance_id/users/:name",
            "params": [
              {
                "name": "region",
                "value": "",
                "type": "path",
                "description": "The region you want to target"
              },
              {
                "name": "instance_id",
                "value": "",
                "type": "path",
                "description": "UUID of the Database Instance to delete the user from."
              },
              {
                "name": "name",
                "value": "",
                "type": "path",
                "description": "Name of the user."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Delete a given user on a Database Instance. You must specify, in the endpoint,  the `region`, `instance_id` and `name` parameters of the user you want to delete."
        },
        {
          "info": {
            "name": "List grace periods of a member",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.scaleway.com/iam/v1alpha1/grace-periods",
            "params": [
              {
                "name": "user_id",
                "value": "",
                "type": "query",
                "description": "ID of the user to list grace periods for."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "List the grace periods of a member."
        },
        {
          "info": {
            "name": "List users of an Organization",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.scaleway.com/iam/v1alpha1/users",
            "params": [
              {
                "name": "order_by",
                "value": "",
                "type": "query",
                "description": "Criteria for sorting results."
              },
              {
                "name": "page_size",
                "value": "",
                "type": "query",
                "description": "Number of results per page. Value must be between 1 and 100."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page number. Value must be greater or equal to 1."
              },
              {
                "name": "organization_id",
                "value": "",
                "type": "query",
                "description": "ID of the Organization to filter."
              },
              {
                "name": "user_ids",
                "value": "",
                "type": "query",
                "description": "Filter by list of IDs."
              },
              {
                "name": "mfa",
                "value": "",
                "type": "query",
                "description": "Filter by MFA status."
              },
              {
                "name": "tag",
                "value": "",
                "type": "query",
                "description": "Filter by tags containing a given string."
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "Filter by user type."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "List the users of an Organization. By default, the users listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You must define the `organization_id` in the query path of your request. You can also define additional parameters for your query such as `user_ids`."
        },
        {
          "info": {
            "name": "Create a new user",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.scaleway.com/iam/v1alpha1/users",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Create a new user. You must define the `organization_id` in your request. If you are adding a member, enter the member's details. If you are adding a guest, you must define the `email` and not add the member attribute."
        },
        {
          "info": {
            "name": "Get a given user",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.scaleway.com/iam/v1alpha1/users/:user_id",
            "params": [
              {
                "name": "user_id",
                "value": "",
                "type": "path",
                "description": "ID of the user to find."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Retrieve information about a user, specified by the `user_id` parameter. The user's full details, including `id`, `email`, `organization_id`, `status` and `mfa` are returned in the response."
        },
        {
          "info": {
            "name": "Update a user",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.scaleway.com/iam/v1alpha1/users/:user_id",
            "params": [
              {
                "name": "user_id",
                "value": "",
                "type": "path",
                "description": "ID of the user to update."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Update the parameters of a user, including `tags`."
        },
        {
          "info": {
            "name": "Delete a guest user from an Organization",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.scaleway.com/iam/v1alpha1/users/:user_id",
            "params": [
              {
                "name": "user_id",
                "value": "",
                "type": "path",
                "description": "ID of the user to delete."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Remove a user from an Organization in which they are a guest. You must define the `user_id` in your request. Note that removing a user from an Organization automatically deletes their API keys, and any policies directly attached to them become orphaned."
        },
        {
          "info": {
            "name": "Lock a member",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.scaleway.com/iam/v1alpha1/users/:user_id/lock",
            "params": [
              {
                "name": "user_id",
                "value": "",
                "type": "path",
                "description": "ID of the user to lock."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Lock a member. A locked member cannot log in or use API keys until the locked status is removed."
        },
        {
          "info": {
            "name": "Create a MFA OTP.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.scaleway.com/iam/v1alpha1/users/:user_id/mfa-otp",
            "params": [
              {
                "name": "user_id",
                "value": "",
                "type": "path",
                "description": "User ID of the MFA OTP."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Create a MFA OTP."
        },
        {
          "info": {
            "name": "Delete a MFA OTP.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.scaleway.com/iam/v1alpha1/users/:user_id/mfa-otp",
            "params": [
              {
                "name": "user_id",
                "value": "",
                "type": "path",
                "description": "User ID of the MFA OTP."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Delete a MFA OTP."
        },
        {
          "info": {
            "name": "Unlock a member",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.scaleway.com/iam/v1alpha1/users/:user_id/unlock",
            "params": [
              {
                "name": "user_id",
                "value": "",
                "type": "path",
                "description": "ID of the user to unlock."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Unlock a member"
        },
        {
          "info": {
            "name": "Update an user's password.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.scaleway.com/iam/v1alpha1/users/:user_id/update-password",
            "params": [
              {
                "name": "user_id",
                "value": "",
                "type": "path",
                "description": "ID of the user to update."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Update an user's password."
        },
        {
          "info": {
            "name": "Update an user's username.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.scaleway.com/iam/v1alpha1/users/:user_id/update-username",
            "params": [
              {
                "name": "user_id",
                "value": "",
                "type": "path",
                "description": "ID of the user to update."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Update an user's username."
        },
        {
          "info": {
            "name": "Validate a MFA OTP.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.scaleway.com/iam/v1alpha1/users/:user_id/validate-mfa-otp",
            "params": [
              {
                "name": "user_id",
                "value": "",
                "type": "path",
                "description": "User ID of the MFA OTP."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Validate a MFA OTP."
        }
      ]
    }
  ],
  "bundled": true
}