An application (also known as an IAM application) is a non-human user in a Scaleway Organization. IAM applications may be used when you want to create an API key that is not linked to a user, to give programmatic access to resources.
Note that applications cannot, by definition, have access to the Scaleway console, as they have only an API key and no account themselves (they are not accountsOpen in new context).
List applications of an Organization
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.
query Parameters
order_byCriteria for sorting results.
page_sizeNumber of results per page. Value must be between 1 and 100.
pagePage number. Value must be greater than 1.
nameName of the application to filter.
organization_idID of the Organization to filter.
editableDefines whether to filter out editable applications or not.
application_idsFilter by list of IDs.
tagFilter by tags containing a given string.
List applications of an Organization › Responses
List of applications.
total_countTotal count of applications.
Create a new application
Create a new application. You must define the name parameter in the request.
Create a new application › Request Body
nameName of the application to create (max length is 64 characters).
organization_idID of the Organization.
descriptionDescription of the application (max length is 200 characters).
tagsTags associated with the application (maximum of 10 tags).
Create a new application › Responses
idID of the application.
nameName of the application.
descriptionDescription of the application.
created_atDate and time application was created. (RFC 3339 format)
updated_atDate and time of last application update. (RFC 3339 format)
organization_idID of the Organization.
editableDefines whether or not the application is editable.
deletableDefines whether or not the application is deletable.
managedDefines whether or not the application is managed.
nb_api_keysNumber of API keys attributed to the application.
tagsTags associated with the user.
Get a given application
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.
path Parameters
application_idID of the application to find.
Get a given application › Responses
idID of the application.
nameName of the application.
descriptionDescription of the application.
created_atDate and time application was created. (RFC 3339 format)
updated_atDate and time of last application update. (RFC 3339 format)
organization_idID of the Organization.
editableDefines whether or not the application is editable.
deletableDefines whether or not the application is deletable.
managedDefines whether or not the application is managed.
nb_api_keysNumber of API keys attributed to the application.
tagsTags associated with the user.
Delete an application
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.
path Parameters
application_idID of the application to delete.
Delete an application › Responses
Update an application
Update the parameters of an application, including name and description.
path Parameters
application_idID of the application to update.
Update an application › Request Body
nameNew name for the application (max length is 64 chars).
descriptionNew description for the application (max length is 200 chars).
tagsNew tags for the application (maximum of 10 tags).
Update an application › Responses
idID of the application.
nameName of the application.
descriptionDescription of the application.
created_atDate and time application was created. (RFC 3339 format)
updated_atDate and time of last application update. (RFC 3339 format)
organization_idID of the Organization.
editableDefines whether or not the application is editable.
deletableDefines whether or not the application is deletable.
managedDefines whether or not the application is managed.
nb_api_keysNumber of API keys attributed to the application.
tagsTags associated with the user.