add documentation for the token-based authentication

This commit is contained in:
Vincent Behar 2011-08-01 13:32:00 +02:00
parent 7af15bb237
commit 5b29add352
3 changed files with 42 additions and 0 deletions

View file

@ -37,6 +37,20 @@ println "All RunDeck jobs : ${rundeck.jobs}"
println "All RunDeck running executions : ${rundeck.runningExecutions}"
{code}
h2. Authentication
Starting with RunDeck API 2, there are 2 ways to authenticate :
* the *login-based authentication* : with your login and password
* the *token-based authentication* : with a unique token that you can generate from the RunDeck webUI
{code}
// using login-based authentication (admin/admin is the default login/password for a new RunDeck instance) :
rundeck = new RundeckClient("http://localhost:4440", "admin", "admin");
// using token-based authentication :
rundeck = new RundeckClient("http://localhost:4440", "PDDNKo5VE29kpk4prOUDr2rsKdRkEvsD");
{code}
h2. Running a job
{code}

View file

@ -37,6 +37,20 @@ puts "All RunDeck jobs : #{rundeck.jobs}"
puts "All RunDeck running executions : #{rundeck.runningExecutions}"
{code}
h2. Authentication
Starting with RunDeck API 2, there are 2 ways to authenticate :
* the *login-based authentication* : with your login and password
* the *token-based authentication* : with a unique token that you can generate from the RunDeck webUI
{code}
// using login-based authentication (admin/admin is the default login/password for a new RunDeck instance) :
rundeck = RundeckClient.new("http://localhost:4440", "admin", "admin");
// using token-based authentication :
rundeck = RundeckClient.new("http://localhost:4440", "PDDNKo5VE29kpk4prOUDr2rsKdRkEvsD");
{code}
h2. Running a job
{code}

View file

@ -21,6 +21,20 @@ print("All RunDeck jobs : %s" % rundeck.jobs)
print("All RunDeck running executions : %s" % rundeck.runningExecutions)
{code}
h2. Authentication
Starting with RunDeck API 2, there are 2 ways to authenticate :
* the *login-based authentication* : with your login and password
* the *token-based authentication* : with a unique token that you can generate from the RunDeck webUI
{code}
// using login-based authentication (admin/admin is the default login/password for a new RunDeck instance) :
rundeck = RundeckClient("http://localhost:4440", "admin", "admin");
// using token-based authentication :
rundeck = RundeckClient("http://localhost:4440", "PDDNKo5VE29kpk4prOUDr2rsKdRkEvsD");
{code}
h2. Running a job
{code}