Skip to content

feat: add prestashop:api-client command #2002

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: 9.x
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions development/components/console/prestashop-apiclient.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@

---
title: prestashop:api-client
---

# `prestashop:api-client`

## Informations

* Path: `src/PrestaShopBundle/Command/APIClientCommand.php`
* Arguments:
* `action`: Action to perform, create/delete.
* `client-id`: Client ID.
* Options:
* `--name`: Client Name
* `--description`: Client Description (Created by CLI command., by default)
* `--all-scopes`: Automatically assign all available scopes
* `--scopes`: OClient list of scopes separated by commas
* `--secret-only`: Only output secret value after creation
* `--timeout`: Timeout in seconds (3600, by default)
* `--secret`: Force secret value (auto generated, by default)

## Description

Manage Admin API client.

## Usage

Create an AminApi client.

```bash
bin/console prestashop:api-client create DevDocs
```

Create an AminApi client with custom description.

```bash
bin/console prestashop:api-client create DevDocs --description="Made by DevDocs"
```
```

Create an AminApi client and display only secret.

```bash
bin/console prestashop:api-client create DevDocs --secret-only
```

Delete an AminApi client.

```bash
bin/console prestashop:api-client delete DevDocs
```