AppSuite:OAuth client management: Difference between revisions

From Open-Xchange
(Created page with "== createoauthclient == '''<code> createoauthclient </code>''' is the tool to create a new OAuth client app. === Parameters === {| border="1" |- | -h,--help |Prints a help...")
 
(Add remaining clts)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
The following command-line tools are available with v7.8.1
== createoauthclient ==
== createoauthclient ==


'''<code> createoauthclient </code>''' is the tool to create a new OAuth client app.
'''<code> createoauthclient </code>''' is the tool to create a new OAuth client app.


=== Parameters ===
=== Parameters ===
Line 12: Line 13:
|-
|-
| --environment
| --environment
|Show infoabout commandline environment
|Show info about commandline environment
|-
|-
| --nonl
| --nonl
Line 18: Line 19:
|-
|-
| --responsetimeout &lt;integer&gt;
| --responsetimeout &lt;integer&gt;
|response timeout in seconds for reading response from the backend (default 0s; infinite) '''Available with v7.8.0'''
|Response timeout in seconds for reading response from the backend (default 0s; infinite) '''Available with v7.8.0'''
|-
|-
| -c/--context-group-id &lt;string&gt;
| -c/--context-group-id &lt;string&gt;
Line 44: Line 45:
|The redirect urls of the OAuth client as a comma-separated list   
|The redirect urls of the OAuth client as a comma-separated list   
|}
|}


=== Extra parameters when authentication is enabled ===
=== Extra parameters when authentication is enabled ===
Line 62: Line 62:


<code>&gt;0</code> on failure
<code>&gt;0</code> on failure


=== Mandatory parameters ===
=== Mandatory parameters ===
Line 81: Line 80:
== enableoauthclient ==
== enableoauthclient ==


'''<code> enableoauthclient </code>''' is the tool to enable(disable a certain OAuth client app.
'''<code> enableoauthclient </code>''' is the tool to enable or disable a certain OAuth client app.
 
=== Parameters ===
 
{| border="1"
|-
| -h,--help
|Prints a help text
|-
| --environment
|Show info about commandline environment
|-
| --nonl
|Remove all newlines (\n) from output
|-
| --responsetimeout &lt;integer&gt;
|Response timeout in seconds for reading response from the backend (default 0s; infinite) '''Available with v7.8.0'''
|-
| --id &lt;integer&gt;
|The id of the oauth client
|-
| -e, --enable  &lt;string&gt;
|Flag that indicates whether the client should be enabled or disabled (values: 'true' or 'false')
|}
 
=== Extra parameters when authentication is enabled ===


{| border="1"
|-
| -A,--adminuser &lt;string&gt;
|Context admin user name
|-
| -P,--adminpass &lt;string&gt;
|Context admin password
|}
=== Return value ===
<code>0</code> on success
<code>&gt;0</code> on failure
=== Mandatory parameters ===
<code>id {adminuser adminpass} enable</code>
=== Command output ===
On success:
<code>Enabling the oauth client was successful!</code>
On failure:
<code>Enabling the oauth client has failed!</code>
== updateoauthclient ==
'''<code> updateoauthclient </code>''' is the tool to update a certain OAuth client app.


=== Parameters ===
=== Parameters ===


{| border="1"
|-
|--environment
|Show info about commandline environment
|-
|--nonl
|Remove all newlines (\n) from output
|-
|--responsetimeout &lt;integer&gt;
|Response timeout in seconds for reading response from the backend (default 0s; infinite) '''Available with v7.8.0'''
|-
|--id <id> &lt;integer&gt;
|The id of the oauth client
|-
|-x, --context-group-id &lt;integer&gt;
|The id of the context group
|-
|-n, --name &lt;string&gt;
|The name of the oauth client
|-
|-d, --description &lt;string&gt;
|The description of the oauth client
|-
|-w, --website &lt;string&gt;
|The client website
|-
|-o, --contact-address &lt;string&gt;
|The contact adress of the oauth client
|-
|-i, --icon-path &lt;string&gt;
|Path to a image file which acts as a icon for the oauth client
|-
|-s, --default-scope &lt;string&gt;
|The default scope of the oauth client
|-
|--urls &lt;string&gt;
|The redirect urls of the oauth client as a comma separated list
|}
=== Extra parameters when authentication is enabled ===
{| border="1"
|-
| -A,--adminuser &lt;string&gt;
|Context admin user name
|-
| -P,--adminpass &lt;string&gt;
|Context admin password
|}
=== Return value ===
<code>0</code> on success
<code>&gt;0</code> on failure
=== Mandatory parameters ===
<code>id {adminuser adminpass}</code>
=== Command output ===
On success:
<code>The update of oauth client with id XYZ was successful!<br>
The updated oauth client: <br>
Client_ID = id <br>
Name = name <br>
Enabled = true|false <br>
Description = description <br>
Website = url <br>
Contact address = address <br>
Default scope = scope <br>
Redirect URL's = urls <br>
Client's current secret = secret <br>
</code>
On failure:
<code>The update of oauth client with id XYZ has failed!</code>
== removeoauthclient ==
'''<code> removeoauthclient </code>''' is the tool to remove (unregister) a certain OAuth client app.
=== Parameters ===


{| border="1"
|-
|--environment
|Show info about commandline environment
|-
|--nonl
|Remove all newlines (\n) from output
|-
|--responsetimeout &lt;integer&gt;
|Response timeout in seconds for reading response from the backend (default 0s; infinite) '''Available with v7.8.0'''
|-
|--id <id> &lt;integer&gt;
|The id of the oauth client
|}
=== Extra parameters when authentication is enabled ===
{| border="1"
|-
| -A,--adminuser &lt;string&gt;
|Context admin user name
|-
| -P,--adminpass &lt;string&gt;
|Context admin password
|}
=== Return value ===
<code>0</code> on success
<code>&gt;0</code> on failure
=== Mandatory parameters ===
<code>id {adminuser adminpass}</code>
=== Command output ===
On success:
<code>The removal of oauth client with id XYZ was successful!</code>
On failure:
<code>The removal of oauth client with id XYZ has failed!</code>
== getoauthclient ==
'''<code> getoauthclient </code>''' is the tool to get a certain OAuth client app.
=== Parameters ===
{| border="1"
|-
|--environment
|Show info about commandline environment
|-
|--nonl
|Remove all newlines (\n) from output
|-
|--responsetimeout &lt;integer&gt;
|Response timeout in seconds for reading response from the backend (default 0s; infinite) '''Available with v7.8.0'''
|-
|--id <id> &lt;integer&gt;
|The id of the oauth client
|}
=== Extra parameters when authentication is enabled ===
{| border="1"
|-
| -A,--adminuser &lt;string&gt;
|Context admin user name
|-
| -P,--adminpass &lt;string&gt;
|Context admin password
|}
=== Return value ===
<code>0</code> on success
<code>&gt;0</code> on failure
=== Mandatory parameters ===
<code>id {adminuser adminpass}</code>
=== Command output ===
On success:
<code>Client_ID = id <br>
Name = name <br>
Enabled = true|false <br>
Description = description <br>
Website = url <br>
Contact address = address <br>
Default scope = scope <br>
Redirect URL's = urls <br>
Client's current secret = secret <br>
</code>
On failure:
<code>Client not found!</code>
== listoauthclient ==
'''<code> listoauthclient </code>''' is the tool to list all OAuth client apps for a certain context-group-id.
=== Parameters ===
{| border="1"
|-
|--environment
|Show info about commandline environment
|-
|--nonl
|Remove all newlines (\n) from output
|-
|--responsetimeout &lt;integer&gt;
|Response timeout in seconds for reading response from the backend (default 0s; infinite) '''Available with v7.8.0'''
|-
|-c, --context-group-id &lt;integer&gt;
|The id of the context group
|}
=== Extra parameters when authentication is enabled ===
{| border="1"
|-
| -A,--adminuser &lt;string&gt;
|Context admin user name
|-
| -P,--adminpass &lt;string&gt;
|Context admin password
|}
=== Return value ===
<code>0</code> on success
<code>&gt;0</code> on failure
=== Mandatory parameters ===
<code>context-group-id {adminuser adminpass}</code>
=== Command output ===
On success:<br>
<code>Following clients are registered: <br>
Client_ID = id <br>
Name = name <br>
Enabled = true|false <br>
Description = description <br>
Website = url <br>
Contact address = address <br>
Default scope = scope <br>
Redirect URL's = urls <br>
Client's current secret = secret <br>
[...]
</code>
On failure: <br>
An empty list.
== revokeoauthclient ==
'''<code> revokeoauthclient </code>''' is the tool to revoke the secret of a certain OAuth client app.
=== Parameters ===
{| border="1"
|-
|--environment
|Show info about commandline environment
|-
|--nonl
|Remove all newlines (\n) from output
|-
|--responsetimeout &lt;integer&gt;
|Response timeout in seconds for reading response from the backend (default 0s; infinite) '''Available with v7.8.0'''
|-
|--id <id> &lt;integer&gt;
|The id of the oauth client
|}
=== Extra parameters when authentication is enabled ===
{| border="1"
|-
| -A,--adminuser &lt;string&gt;
|Context admin user name
|-
| -P,--adminpass &lt;string&gt;
|Context admin password
|}
=== Return value ===
<code>0</code> on success
<code>&gt;0</code> on failure
=== Mandatory parameters ===
<code>id {adminuser adminpass}</code>
=== Command output ===
On success:
<code>The revocation of the client's current secret was successfull!<br>
Generated a new secret for following client: <br>
Client_ID = id <br>
Name = name <br>
Enabled = true|false <br>
Description = description <br>
Website = url <br>
Contact address = address <br>
Default scope = scope <br>
Redirect URL's = urls <br>
Client's current secret = secret
</code>
On failure:
<code>The revocation of the client's current secret has failed!</code>




[[Category: Administrator]]
[[Category: Administrator]]
[[Category: AppSuite]]
[[Category: AppSuite]]
[[Category: AdminGuide]]
[[Category: AdminGuide]]
[[Category: CommandLineTools]]
[[Category: CommandLineTools]]

Latest revision as of 10:42, 20 October 2015

The following command-line tools are available with v7.8.1

createoauthclient

createoauthclient is the tool to create a new OAuth client app.

Parameters

-h,--help Prints a help text
--environment Show info about commandline environment
--nonl Remove all newlines (\n) from output
--responsetimeout <integer> Response timeout in seconds for reading response from the backend (default 0s; infinite) Available with v7.8.0
-c/--context-group-id <string> The id of the context group
-n/--name <string> The name for the OAuth client app
-d/--description <string> The description for the OAuth client app
-w/--website <string> The client website
-o/--contact-address <string> The contact address for the OAuth client app
-i/--icon-path <string> Path to an image file which acts as a icon for the OAuth client
-s/--default-scope <string> The default scope of the OAuth client
--urls <string> The redirect urls of the OAuth client as a comma-separated list

Extra parameters when authentication is enabled

-A,--adminuser <string> Context admin user name
-P,--adminpass <string> Context admin password

Return value

0 on success

>0 on failure

Mandatory parameters

context-group-id {adminuser adminpass} name description website contact-address icon-path default-scope urls

Command output

On success:

The registration of oauth client was successful

On failure:

The registration of oauth client has failed


enableoauthclient

enableoauthclient is the tool to enable or disable a certain OAuth client app.

Parameters

-h,--help Prints a help text
--environment Show info about commandline environment
--nonl Remove all newlines (\n) from output
--responsetimeout <integer> Response timeout in seconds for reading response from the backend (default 0s; infinite) Available with v7.8.0
--id <integer> The id of the oauth client
-e, --enable <string> Flag that indicates whether the client should be enabled or disabled (values: 'true' or 'false')

Extra parameters when authentication is enabled

-A,--adminuser <string> Context admin user name
-P,--adminpass <string> Context admin password

Return value

0 on success

>0 on failure

Mandatory parameters

id {adminuser adminpass} enable

Command output

On success:

Enabling the oauth client was successful!

On failure:

Enabling the oauth client has failed!


updateoauthclient

updateoauthclient is the tool to update a certain OAuth client app.

Parameters

Show info about commandline environment
Remove all newlines (\n) from output
Response timeout in seconds for reading response from the backend (default 0s; infinite) Available with v7.8.0
The id of the oauth client
The id of the context group
The name of the oauth client
The description of the oauth client
The client website
The contact adress of the oauth client
Path to a image file which acts as a icon for the oauth client
The default scope of the oauth client
The redirect urls of the oauth client as a comma separated list

Extra parameters when authentication is enabled

-A,--adminuser <string> Context admin user name
-P,--adminpass <string> Context admin password

Return value

0 on success

>0 on failure

Mandatory parameters

id {adminuser adminpass}

Command output

On success:

The update of oauth client with id XYZ was successful!
The updated oauth client:
Client_ID = id
Name = name
Enabled = true|false
Description = description
Website = url
Contact address = address
Default scope = scope
Redirect URL's = urls
Client's current secret = secret

On failure:

The update of oauth client with id XYZ has failed!


removeoauthclient

removeoauthclient is the tool to remove (unregister) a certain OAuth client app.

Parameters

Show info about commandline environment
Remove all newlines (\n) from output
Response timeout in seconds for reading response from the backend (default 0s; infinite) Available with v7.8.0
The id of the oauth client

Extra parameters when authentication is enabled

-A,--adminuser <string> Context admin user name
-P,--adminpass <string> Context admin password

Return value

0 on success

>0 on failure

Mandatory parameters

id {adminuser adminpass}

Command output

On success:

The removal of oauth client with id XYZ was successful!

On failure:

The removal of oauth client with id XYZ has failed!


getoauthclient

getoauthclient is the tool to get a certain OAuth client app.

Parameters

Show info about commandline environment
Remove all newlines (\n) from output
Response timeout in seconds for reading response from the backend (default 0s; infinite) Available with v7.8.0
The id of the oauth client

Extra parameters when authentication is enabled

-A,--adminuser <string> Context admin user name
-P,--adminpass <string> Context admin password

Return value

0 on success

>0 on failure

Mandatory parameters

id {adminuser adminpass}

Command output

On success:

Client_ID = id
Name = name
Enabled = true|false
Description = description
Website = url
Contact address = address
Default scope = scope
Redirect URL's = urls
Client's current secret = secret

On failure:

Client not found!


listoauthclient

listoauthclient is the tool to list all OAuth client apps for a certain context-group-id.

Parameters

Show info about commandline environment
Remove all newlines (\n) from output
Response timeout in seconds for reading response from the backend (default 0s; infinite) Available with v7.8.0
The id of the context group

Extra parameters when authentication is enabled

-A,--adminuser <string> Context admin user name
-P,--adminpass <string> Context admin password

Return value

0 on success

>0 on failure

Mandatory parameters

context-group-id {adminuser adminpass}

Command output

On success:
Following clients are registered:
Client_ID = id
Name = name
Enabled = true|false
Description = description
Website = url
Contact address = address
Default scope = scope
Redirect URL's = urls
Client's current secret = secret
[...]

On failure:
An empty list.


revokeoauthclient

revokeoauthclient is the tool to revoke the secret of a certain OAuth client app.

Parameters

Show info about commandline environment
Remove all newlines (\n) from output
Response timeout in seconds for reading response from the backend (default 0s; infinite) Available with v7.8.0
The id of the oauth client

Extra parameters when authentication is enabled

-A,--adminuser <string> Context admin user name
-P,--adminpass <string> Context admin password

Return value

0 on success

>0 on failure

Mandatory parameters

id {adminuser adminpass}

Command output

On success:

The revocation of the client's current secret was successfull!
Generated a new secret for following client:
Client_ID = id
Name = name
Enabled = true|false
Description = description
Website = url
Contact address = address
Default scope = scope
Redirect URL's = urls
Client's current secret = secret

On failure:

The revocation of the client's current secret has failed!

Retrieved from "https://wiki.open-xchange.com/wiki/index.php?title=AppSuite:OAuth_client_management&oldid=20788"