{ "opencollection": "1.0.0", "info": { "name": "IAM API", "version": "v1alpha1" }, "items": [ { "info": { "name": "API Keys", "type": "folder" }, "items": [ { "info": { "name": "List API keys", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/iam/v1alpha1/api-keys", "params": [ { "name": "order_by", "value": "", "type": "query", "description": "Criteria for sorting results." }, { "name": "page", "value": "", "type": "query", "description": "Page number. Value must be greater or equal to 1." }, { "name": "page_size", "value": "", "type": "query", "description": "Number of results per page. Value must be between 1 and 100." }, { "name": "organization_id", "value": "", "type": "query", "description": "ID of Organization." }, { "name": "editable", "value": "", "type": "query", "description": "Defines whether to filter out editable API keys or not." }, { "name": "expired", "value": "", "type": "query", "description": "Defines whether to filter out expired API keys or not." }, { "name": "access_key", "value": "", "type": "query", "description": "Filter by access key (deprecated in favor of `access_keys`)." }, { "name": "description", "value": "", "type": "query", "description": "Filter by description." }, { "name": "bearer_id", "value": "", "type": "query", "description": "Filter by bearer ID." }, { "name": "bearer_type", "value": "", "type": "query", "description": "Filter by type of bearer." }, { "name": "access_keys", "value": "", "type": "query", "description": "Filter by a list of access keys." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "List API keys. By default, the API keys listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You can define additional parameters for your query such as `editable`, `expired`, `access_key` and `bearer_id`." }, { "info": { "name": "Create an API key", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/iam/v1alpha1/api-keys", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Create an API key. You must specify the `application_id` or the `user_id` and the description. You can also specify the `default_project_id`, which is the Project ID of your preferred Project, to use with Object Storage. The `access_key` and `secret_key` values are returned in the response. Note that the secret key is only shown once. Make sure that you copy and store both keys somewhere safe." }, { "info": { "name": "Get an API key", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/iam/v1alpha1/api-keys/:access_key", "params": [ { "name": "access_key", "value": "", "type": "path", "description": "Access key to search for." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Retrieve information about an API key, specified by the `access_key` parameter. The API key's details, including either the `user_id` or `application_id` of its bearer are returned in the response. Note that the string value for the `secret_key` is nullable, and therefore is not displayed in the response. The `secret_key` value is only displayed upon API key creation." }, { "info": { "name": "Update an API key", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.scaleway.com/iam/v1alpha1/api-keys/:access_key", "params": [ { "name": "access_key", "value": "", "type": "path", "description": "Access key to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Update the parameters of an API key, including `default_project_id` and `description`." }, { "info": { "name": "Delete an API key", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.scaleway.com/iam/v1alpha1/api-keys/:access_key", "params": [ { "name": "access_key", "value": "", "type": "path", "description": "Access key to delete." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Delete an API key. Note that this action is irreversible and cannot be undone. Make sure you update any configurations using the API keys you delete." } ] }, { "info": { "name": "Applications", "type": "folder" }, "items": [ { "info": { "name": "List applications of an Organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/iam/v1alpha1/applications", "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 than 1." }, { "name": "name", "value": "", "type": "query", "description": "Name of the application to filter." }, { "name": "organization_id", "value": "", "type": "query", "description": "ID of the Organization to filter." }, { "name": "editable", "value": "", "type": "query", "description": "Defines whether to filter out editable applications or not." }, { "name": "application_ids", "value": "", "type": "query", "description": "Filter by list of IDs." }, { "name": "tag", "value": "", "type": "query", "description": "Filter by tags containing a given string." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "List the applications of an Organization. By default, the applications 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 `application_ids`." }, { "info": { "name": "Create a new application", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/iam/v1alpha1/applications", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Create a new application. You must define the `name` parameter in the request." }, { "info": { "name": "Get a given application", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/iam/v1alpha1/applications/:application_id", "params": [ { "name": "application_id", "value": "", "type": "path", "description": "ID of the application to find." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Retrieve information about an application, specified by the `application_id` parameter. The application's full details, including `id`, `email`, `organization_id`, `status` and `two_factor_enabled` are returned in the response." }, { "info": { "name": "Update an application", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.scaleway.com/iam/v1alpha1/applications/:application_id", "params": [ { "name": "application_id", "value": "", "type": "path", "description": "ID of the application to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Update the parameters of an application, including `name` and `description`." }, { "info": { "name": "Delete an application", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.scaleway.com/iam/v1alpha1/applications/:application_id", "params": [ { "name": "application_id", "value": "", "type": "path", "description": "ID of the application to delete." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Delete an application. Note that this action is irreversible and will automatically delete the application's API keys. Policies attached to users and applications via this group will no longer apply." } ] }, { "info": { "name": "Default", "type": "folder" }, "items": [ { "info": { "name": "CheckPermissions", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/iam/v1alpha1/check-permissions", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } } }, { "info": { "name": "Get your Organization's IAM information", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/iam/v1alpha1/organizations/:organization_id", "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "ID of the Organization." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Get your Organization's IAM information" }, { "info": { "name": "Set your Organization's alias.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.scaleway.com/iam/v1alpha1/organizations/:organization_id/alias", "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "ID of the Organization." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "This will fail if an alias has already been defined. Please contact support if you need to change your Organization's alias." }, { "info": { "name": "Set your Organization's allowed login methods.", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.scaleway.com/iam/v1alpha1/organizations/:organization_id/login-methods", "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "ID of the Organization." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Set your Organization's allowed login methods." }, { "info": { "name": "GetUserConnections", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/iam/v1alpha1/users/:user_id/connections", "params": [ { "name": "user_id", "value": "", "type": "path", "description": "ID of the user to list connections for." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } } }, { "info": { "name": "InitiateUserConnection", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/iam/v1alpha1/users/:user_id/initiate-connection", "params": [ { "name": "user_id", "value": "", "type": "path", "description": "ID of the user that will be added to your connection." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } } }, { "info": { "name": "JoinUserConnection", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/iam/v1alpha1/users/:user_id/join-connection", "params": [ { "name": "user_id", "value": "", "type": "path", "description": "User ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } } }, { "info": { "name": "RemoveUserConnection", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/iam/v1alpha1/users/:user_id/remove-connection", "params": [ { "name": "user_id", "value": "", "type": "path", "description": "ID of the user you want to manage the connection for." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } } } ] }, { "info": { "name": "Users", "type": "folder" }, "items": [ { "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." } ] }, { "info": { "name": "Groups", "type": "folder" }, "items": [ { "info": { "name": "List groups", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/iam/v1alpha1/groups", "params": [ { "name": "order_by", "value": "", "type": "query", "description": "Sort order of groups." }, { "name": "page", "value": "", "type": "query", "description": "Requested page number. Value must be greater or equal to 1." }, { "name": "page_size", "value": "", "type": "query", "description": "Number of items per page. Value must be between 1 and 100." }, { "name": "organization_id", "value": "", "type": "query", "description": "Filter by Organization ID." }, { "name": "name", "value": "", "type": "query", "description": "Name of group to find." }, { "name": "application_ids", "value": "", "type": "query", "description": "Filter by a list of application IDs." }, { "name": "user_ids", "value": "", "type": "query", "description": "Filter by a list of user IDs." }, { "name": "group_ids", "value": "", "type": "query", "description": "Filter by a list of group IDs." }, { "name": "tag", "value": "", "type": "query", "description": "Filter by tags containing a given string." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "List groups. By default, the groups listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You can define additional parameters to filter your query. Use `user_ids` or `application_ids` to list all groups certain users or applications belong to." }, { "info": { "name": "Create a group", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/iam/v1alpha1/groups", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Create a new group. You must define the `name` and `organization_id` parameters in the request." }, { "info": { "name": "Get a group", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/iam/v1alpha1/groups/:group_id", "params": [ { "name": "group_id", "value": "", "type": "path", "description": "ID of the group." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Retrieve information about a given group, specified by the `group_id` parameter. The group's full details, including `user_ids` and `application_ids` are returned in the response." }, { "info": { "name": "Update a group", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.scaleway.com/iam/v1alpha1/groups/:group_id", "params": [ { "name": "group_id", "value": "", "type": "path", "description": "ID of the group to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Update the parameters of group, including `name` and `description`." }, { "info": { "name": "Delete a group", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.scaleway.com/iam/v1alpha1/groups/:group_id", "params": [ { "name": "group_id", "value": "", "type": "path", "description": "ID of the group to delete." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Delete a group. Note that this action is irreversible and could delete permissions for group members. Policies attached to users and applications via this group will no longer apply." }, { "info": { "name": "Add a user or an application to a group", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/iam/v1alpha1/groups/:group_id/add-member", "params": [ { "name": "group_id", "value": "", "type": "path", "description": "ID of the group." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Add a user or an application to a group. You can specify a `user_id` and `application_id` in the body of your request. Note that you can only add one of each per request." }, { "info": { "name": "Add multiple users and applications to a group", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/iam/v1alpha1/groups/:group_id/add-members", "params": [ { "name": "group_id", "value": "", "type": "path", "description": "ID of the group." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Add multiple users and applications to a group in a single call. You can specify an array of `user_id`s and `application_id`s. Note that any existing users and applications in the group will remain. To add new users/applications and delete pre-existing ones, use the [Overwrite users and applications of a group](#path-groups-overwrite-users-and-applications-of-a-group) method." }, { "info": { "name": "Overwrite users and applications of a group", "type": "http" }, "http": { "method": "PUT", "url": "https://api.scaleway.com/iam/v1alpha1/groups/:group_id/members", "params": [ { "name": "group_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Overwrite users and applications configuration in a group. Any information that you add using this command will overwrite the previous configuration." }, { "info": { "name": "Remove a user or an application from a group", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/iam/v1alpha1/groups/:group_id/remove-member", "params": [ { "name": "group_id", "value": "", "type": "path", "description": "ID of the group." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Remove a user or an application from a group. You can specify a `user_id` and `application_id` in the body of your request. Note that you can only remove one of each per request. Removing a user from a group means that any permissions given to them via the group (i.e. from an attached policy) will no longer apply. Be sure you want to remove these permissions from the user before proceeding." } ] }, { "info": { "name": "JWTs", "type": "folder" }, "items": [ { "info": { "name": "List JWTs", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/iam/v1alpha1/jwts", "params": [ { "name": "order_by", "value": "", "type": "query", "description": "Criteria for sorting results." }, { "name": "audience_id", "value": "", "type": "query", "description": "ID of the user to search." }, { "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 to 1." }, { "name": "expired", "value": "", "type": "query", "description": "Filter out expired JWTs or not." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "List JWTs" }, { "info": { "name": "Get a JWT", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/iam/v1alpha1/jwts/:jti", "params": [ { "name": "jti", "value": "", "type": "path", "description": "JWT ID of the JWT to get." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Get a JWT" }, { "info": { "name": "Delete a JWT", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.scaleway.com/iam/v1alpha1/jwts/:jti", "params": [ { "name": "jti", "value": "", "type": "path", "description": "JWT ID of the JWT to delete." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Delete a JWT" } ] }, { "info": { "name": "Logs", "type": "folder" }, "items": [ { "info": { "name": "List logs", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/iam/v1alpha1/logs", "params": [ { "name": "order_by", "value": "", "type": "query", "description": "Criteria for sorting results." }, { "name": "organization_id", "value": "", "type": "query", "description": "Filter by Organization ID." }, { "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 to 1." }, { "name": "created_after", "value": "", "type": "query", "description": "Defined whether or not to filter out logs created after this timestamp. (RFC 3339 format)" }, { "name": "created_before", "value": "", "type": "query", "description": "Defined whether or not to filter out logs created before this timestamp. (RFC 3339 format)" }, { "name": "action", "value": "", "type": "query", "description": "Defined whether or not to filter out by a specific action." }, { "name": "resource_type", "value": "", "type": "query", "description": "Defined whether or not to filter out by a specific type of resource." }, { "name": "search", "value": "", "type": "query", "description": "Defined whether or not to filter out log by bearer ID or resource ID." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "List logs available for given Organization. You must define the `organization_id` in the query path of your request." }, { "info": { "name": "Get a log", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/iam/v1alpha1/logs/:log_id", "params": [ { "name": "log_id", "value": "", "type": "path", "description": "ID of the log." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Retrieve information about a log, specified by the `log_id` parameter. The log's full details, including `id`, `ip`, `user_agent`, `action`, `bearer_id`, `resource_type` and `resource_id` are returned in the response." } ] }, { "info": { "name": "SAML", "type": "folder" }, "items": [ { "info": { "name": "Get SAML Identity Provider configuration of an Organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/iam/v1alpha1/organizations/:organization_id/saml", "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "ID of the Organization." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Get SAML Identity Provider configuration of an Organization" }, { "info": { "name": "Enable SAML Identity Provider for an Organization", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/iam/v1alpha1/organizations/:organization_id/saml", "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "ID of the Organization." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Enable SAML Identity Provider for an Organization" }, { "info": { "name": "Get a SAML certificate", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/iam/v1alpha1/saml-certificates/:certificate_id", "params": [ { "name": "certificate_id", "value": "", "type": "path", "description": "ID of the certificate to get." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Get a SAML certificate" }, { "info": { "name": "Delete a SAML certificate", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.scaleway.com/iam/v1alpha1/saml-certificates/:certificate_id", "params": [ { "name": "certificate_id", "value": "", "type": "path", "description": "ID of the certificate to delete." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Delete a SAML certificate" }, { "info": { "name": "Update SAML Identity Provider configuration", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.scaleway.com/iam/v1alpha1/saml/:saml_id", "params": [ { "name": "saml_id", "value": "", "type": "path", "description": "ID of the SAML configuration." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Update SAML Identity Provider configuration" }, { "info": { "name": "Disable SAML Identity Provider for an Organization", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.scaleway.com/iam/v1alpha1/saml/:saml_id", "params": [ { "name": "saml_id", "value": "", "type": "path", "description": "ID of the SAML configuration." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Disable SAML Identity Provider for an Organization" }, { "info": { "name": "List SAML certificates", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/iam/v1alpha1/saml/:saml_id/certificates", "params": [ { "name": "saml_id", "value": "", "type": "path", "description": "ID of the SAML configuration." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "List SAML certificates" }, { "info": { "name": "Add a SAML certificate", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/iam/v1alpha1/saml/:saml_id/certificates", "params": [ { "name": "saml_id", "value": "", "type": "path", "description": "ID of the SAML configuration." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Add a SAML certificate" } ] }, { "info": { "name": "Security Settings", "type": "folder" }, "items": [ { "info": { "name": "Get security settings of an Organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/iam/v1alpha1/organizations/:organization_id/security-settings", "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "ID of the Organization." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Retrieve information about the security settings of an Organization, specified by the `organization_id` parameter." }, { "info": { "name": "Update the security settings of an Organization", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.scaleway.com/iam/v1alpha1/organizations/:organization_id/security-settings", "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "ID of the Organization." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Update the security settings of an Organization" } ] }, { "info": { "name": "Permission sets", "type": "folder" }, "items": [ { "info": { "name": "List permission sets", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/iam/v1alpha1/permission-sets", "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 than 1." }, { "name": "organization_id", "value": "", "type": "query", "description": "Filter by Organization ID." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "List permission sets available for given Organization. You must define the `organization_id` in the query path of your request." } ] }, { "info": { "name": "Policies", "type": "folder" }, "items": [ { "info": { "name": "List policies of an Organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/iam/v1alpha1/policies", "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 than 1." }, { "name": "organization_id", "value": "", "type": "query", "description": "ID of the Organization to filter." }, { "name": "editable", "value": "", "type": "query", "description": "Defines whether or not filter out editable policies." }, { "name": "user_ids", "value": "", "type": "query", "description": "Defines whether or not to filter by list of user IDs." }, { "name": "group_ids", "value": "", "type": "query", "description": "Defines whether or not to filter by list of group IDs." }, { "name": "application_ids", "value": "", "type": "query", "description": "Filter by a list of application IDs." }, { "name": "no_principal", "value": "", "type": "query", "description": "Defines whether or not the policy is attributed to a principal." }, { "name": "policy_name", "value": "", "type": "query", "description": "Name of the policy to fetch." }, { "name": "tag", "value": "", "type": "query", "description": "Filter by tags containing a given string." }, { "name": "policy_ids", "value": "", "type": "query", "description": "Filter by a list of IDs." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "List the policies of an Organization. By default, the policies 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 to filter your query, such as `user_ids`, `groups_ids`, `application_ids`, and `policy_name`." }, { "info": { "name": "Create a new policy", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/iam/v1alpha1/policies", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Create a new application. You must define the `name` parameter in the request. You can specify parameters such as `user_id`, `groups_id`, `application_id`, `no_principal`, `rules` and its child attributes." }, { "info": { "name": "Get an existing policy", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/iam/v1alpha1/policies/:policy_id", "params": [ { "name": "policy_id", "value": "", "type": "path", "description": "Id of policy to search." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Retrieve information about a policy, specified by the `policy_id` parameter. The policy's full details, including `id`, `name`, `organization_id`, `nb_rules` and `nb_scopes`, `nb_permission_sets` are returned in the response." }, { "info": { "name": "Update an existing policy", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.scaleway.com/iam/v1alpha1/policies/:policy_id", "params": [ { "name": "policy_id", "value": "", "type": "path", "description": "Id of policy 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 policy, including `name`, `description`, `user_id`, `group_id`, `application_id` and `no_principal`." }, { "info": { "name": "Delete a policy", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.scaleway.com/iam/v1alpha1/policies/:policy_id", "params": [ { "name": "policy_id", "value": "", "type": "path", "description": "Id of policy to delete." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Delete a policy. You must define specify the `policy_id` parameter in your request. Note that when deleting a policy, all permissions it gives to its principal (user, group or application) will be revoked." }, { "info": { "name": "Clone a policy", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/iam/v1alpha1/policies/:policy_id/clone", "params": [ { "name": "policy_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Clone a policy. You must define specify the `policy_id` parameter in your request." } ] }, { "info": { "name": "Quotas", "type": "folder" }, "items": [ { "info": { "name": "List all quotas in the Organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/iam/v1alpha1/quota", "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 than 1." }, { "name": "organization_id", "value": "", "type": "query", "description": "Filter by Organization ID." }, { "name": "quotum_names", "value": "", "type": "query", "description": "List of quotum names to filter from." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "List all product and features quota for an Organization, with their associated limits. By default, the quota 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." }, { "info": { "name": "Get a quota in the Organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/iam/v1alpha1/quota/:quotum_name", "params": [ { "name": "quotum_name", "value": "", "type": "path", "description": "Name of the quota to get." }, { "name": "organization_id", "value": "", "type": "query", "description": "ID of the Organization." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Retrieve information about a resource quota, specified by the `quotum_name` parameter. The quota's `limit`, or whether it is unlimited, is returned in the response." } ] }, { "info": { "name": "Rules", "type": "folder" }, "items": [ { "info": { "name": "List rules of a given policy", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/iam/v1alpha1/rules", "params": [ { "name": "policy_id", "value": "", "type": "query", "description": "Id of policy to search." }, { "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 than 1." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "List the rules of a given policy. By default, the rules listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You must define the `policy_id` in the query path of your request." }, { "info": { "name": "Set rules of a given policy", "type": "http" }, "http": { "method": "PUT", "url": "https://api.scaleway.com/iam/v1alpha1/rules", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Overwrite the rules of a given policy. Any information that you add using this command will overwrite the previous configuration. If you include some of the rules you already had in your previous configuration in your new one, but you change their order, the new order of display will apply. While policy rules are ordered, they have no impact on the access logic of IAM because rules are allow-only." } ] }, { "info": { "name": "SSH Keys", "type": "folder" }, "items": [ { "info": { "name": "List SSH keys", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/iam/v1alpha1/ssh-keys", "params": [ { "name": "order_by", "value": "", "type": "query", "description": "Sort order of the SSH keys." }, { "name": "page", "value": "", "type": "query", "description": "Requested page number. Value must be greater or equal to 1." }, { "name": "page_size", "value": "", "type": "query", "description": "Number of items per page. Value must be between 1 and 100." }, { "name": "organization_id", "value": "", "type": "query", "description": "Filter by Organization ID." }, { "name": "name", "value": "", "type": "query", "description": "Name of group to find." }, { "name": "project_id", "value": "", "type": "query", "description": "Filter by Project ID." }, { "name": "disabled", "value": "", "type": "query", "description": "Defines whether to include disabled SSH keys or not." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "List SSH keys. By default, the SSH keys listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You can define additional parameters for your query such as `organization_id`, `name`, `project_id` and `disabled`." }, { "info": { "name": "Create an SSH key", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/iam/v1alpha1/ssh-keys", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Add a new SSH key to a Scaleway Project. You must specify the `name`, `public_key` and `project_id`." }, { "info": { "name": "Get an SSH key", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/iam/v1alpha1/ssh-keys/:ssh_key_id", "params": [ { "name": "ssh_key_id", "value": "", "type": "path", "description": "ID of the SSH key." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Retrieve information about a given SSH key, specified by the `ssh_key_id` parameter. The SSH key's full details, including `id`, `name`, `public_key`, and `project_id` are returned in the response." }, { "info": { "name": "Update an SSH key", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.scaleway.com/iam/v1alpha1/ssh-keys/:ssh_key_id", "params": [ { "name": "ssh_key_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Update the parameters of an SSH key, including `name` and `disable`." }, { "info": { "name": "Delete an SSH key", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.scaleway.com/iam/v1alpha1/ssh-keys/:ssh_key_id", "params": [ { "name": "ssh_key_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Delete a given SSH key, specified by the `ssh_key_id`. Deleting an SSH is permanent, and cannot be undone. Note that you might need to update any configurations that used the SSH key." } ] } ], "bundled": true }