Skip to content

Commit d076e98

Browse files
allmightyspiffallmightyspiff
committed
actually added aliass since mac doesn't seem to like case sensitive files...
1 parent cc4cfd3 commit d076e98

6,022 files changed

Lines changed: 89315 additions & 63732 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎article/api-operations-search-services/index.html‎

Lines changed: 382 additions & 0 deletions
Large diffs are not rendered by default.

‎article/authenticating-softlayer-api/index.html‎

Lines changed: 259 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,259 @@
1+
<!doctype html>
2+
<html lang="en">
3+
<head>
4+
5+
<meta charset="utf-8">
6+
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
7+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
8+
<meta name="description" content="SoftLayer API Examples, implementations, and release notes.">
9+
<meta name="author" content="SoftLayer">
10+
11+
<title>Authenticating to the SoftLayer API - https://softlayer.github.io/</title>
12+
<link rel="canonical" href="https://softlayer.github.io/article/authenticating-softlayer-api/">
13+
<link href="https://softlayer.github.io/css/main.css" rel="stylesheet">
14+
<link href="https://softlayer.github.io/css/bootstrap.css" rel="stylesheet">
15+
<link href="https://softlayer.github.io/css/fa-svg-with-js.css" rel="stylesheet">
16+
<link href="https://softlayer.github.io/css/custom.css" rel="stylesheet">
17+
<link href="https://softlayer.github.io/css/highlight/solarized_dark.css" rel="stylesheet">
18+
19+
<script src="https://softlayer.github.io/js/highlight.pack.js"></script>
20+
21+
<script>hljs.initHighlightingOnLoad();</script>
22+
<link rel="shortcut icon" href="https://softlayer.github.io/img/favicon.ico" type="image/x-icon" />
23+
<link rel="stylesheet" type="text/css" href="https://fonts.googleapis.com/css?family=Lato" />
24+
25+
26+
<script src="https://softlayer.github.io/js/jquery-3.3.1.min.js"></script>
27+
<script src="https://softlayer.github.io/js/sldn.js"></script>
28+
<script src="https://softlayer.github.io/js/fontawesome-all.js"></script>
29+
30+
31+
<script>
32+
$(document).ready(function() {
33+
$('table').addClass("table table-hover table-striped")
34+
})
35+
</script>
36+
37+
<script>
38+
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
39+
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
40+
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
41+
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
42+
43+
ga('create', 'UA-88235803-1', 'auto');
44+
ga('send', 'pageview');
45+
</script>
46+
47+
</head>
48+
49+
<body>
50+
<nav class="navbar navbar-default navbar-fixed-top" role="navigation">
51+
<div class="container">
52+
<div class="navbar-header">
53+
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-ex1-collapse">
54+
<span class="sr-only">Toggle Navigation</span>
55+
<span class="icon-bar"></span>
56+
<span class="icon-bar"></span>
57+
<span class="icon-bar"></span>
58+
</button>
59+
<a class="navbar-brand" href="https://softlayer.github.io/">SoftLayer API</a>
60+
</div>
61+
<div class="collapse navbar-collapse navbar-ex1-collapse">
62+
<ul class="nav navbar-nav">
63+
64+
<li><a href="https://softlayer.github.io/article/">Articles</a></li>
65+
66+
<li><a href="https://softlayer.github.io/reference/softlayerapi">Documentation</a></li>
67+
68+
<li><a href="https://softlayer.github.io/go/">Go</a></li>
69+
70+
<li><a href="https://softlayer.github.io/php/">PHP</a></li>
71+
72+
<li><a href="https://softlayer.github.io/perl/">Perl</a></li>
73+
74+
<li><a href="https://softlayer.github.io/python/">Python</a></li>
75+
76+
<li><a href="https://softlayer.github.io/rest/">Rest</a></li>
77+
78+
<li><a href="https://softlayer.github.io/ruby/">Ruby</a></li>
79+
80+
<li><a href="https://softlayer.github.io/tools/">Tools</a></li>
81+
82+
83+
84+
</ul>
85+
<div id="custom-search-input" class="pull-right">
86+
<form class="navbar-form" role="search" method="get" action="https://www.bing.com/">
87+
<div class="input-group col-md-12">
88+
<input type="text" class="form-control input-md" placeholder="Search" name="q" id="srch-term">
89+
<input type="hidden" name="q1" value="site:softlayer.github.io" />
90+
<div class="input-group-btn">
91+
<button class="btn btn-info" type="submit">
92+
<i class="glyphicon glyphicon-search"></i>
93+
</button>
94+
</div>
95+
</div>
96+
</form>
97+
</div>
98+
</div>
99+
</div>
100+
</nav>
101+
102+
<div class="container">
103+
<div class="row">
104+
105+
<div class="col-md-3">
106+
<div style="word-wrap: break-word;">
107+
<h4>June 20, 2011<br></h4>
108+
</div>
109+
</div>
110+
<div class="col-md-9">
111+
<strong>Tags <span class="fa fa-tags"/></strong>
112+
113+
<a class="label label-danger" href="https://softlayer.github.io/tags/article">article</a>
114+
115+
<a class="label label-danger" href="https://softlayer.github.io/tags/sldn">sldn</a>
116+
117+
</div>
118+
</div>
119+
<hr>
120+
<div class="row">
121+
<div class="col-md-12">
122+
<div class="well well-sm release-note" style="word-wrap: break-word;">
123+
<h3>Authenticating to the SoftLayer API<br> <small>Authenticating to the SoftLayer API</small></h3>
124+
125+
126+
127+
128+
129+
<p>&ldquo;username&rdquo; which contains your portal/API username, and &ldquo;apiKey&rdquo; which contains your API access key. If you don&rsquo;t provide the authenticate header the API returns the [[exception]] &ldquo;No valid authentication headers found.&rdquo;, and if you provide an invalid username and apiKey combination the API returns the exception &ldquo;Invalid API Token&rdquo;.</p>
130+
131+
<p>A SOAP representation of the &ldquo;authenticate&rdquo; header looks like this:
132+
<xml>
133+
<authenticate xsi:type="slt:authenticate" xmlns:slt="http://api.service.softlayer.com/soap/v3/SLTypes/">
134+
<username xsi:type="xsd:string">MY_USERNAME</username>
135+
<apiKey xsi:type="xsd:string">MY_API_ACCESS_KEY</apiKey>
136+
</authenticate>
137+
</xml>
138+
while it&rsquo;s XML-RPC counterpart looks like this:
139+
<xml>
140+
<struct>
141+
<member>
142+
<name>authenticate</name>
143+
<value>
144+
<struct>
145+
<member>
146+
<name>username</name>
147+
<value>
148+
<string>MY_USERNAME</string>
149+
</value>
150+
</member>
151+
<member>
152+
<name>apiKey</name>
153+
<value>
154+
<string>MY_API_ACCESS_KEY</string>
155+
</value>
156+
</member>
157+
</struct>
158+
</value>
159+
</member>
160+
</struct>
161+
</xml></p>
162+
163+
<h2 id="generating-your-api-key">Generating Your API Key</h2>
164+
165+
<p>There are two ways to generate an API access key, via the portal or by direct API calls. To generate your own API access key in the customer portal:</p>
166+
167+
<ol>
168+
<li>Log into the [<a href="https://manage.softlayer.com/">https://manage.softlayer.com/</a> SoftLayer customer portal] with your customer account master user&rsquo;s username and portal password.</li>
169+
<li>Click the &ldquo;administrative&rdquo; then &ldquo;API Access&rdquo; links.</li>
170+
<li>Select the user you wish to generate a key for and click &ldquo;Generate API Access Key&rdquo;</li>
171+
</ol>
172+
173+
<p>To generate an API access key via API calls invoke the [[SoftLayer_User_Customer::addApiAuthenticationKey|addApiAuthenticationKey]] method in the [[SoftLayer_User_Customer]] service. To remove a user&rsquo;s API access key execute the [[SoftLayer_User_Customer::removeApiAuthenticationKey|removeApiAuthenticationKey]] method in the same service. Be careful when removing API access keys. Removing these keys will remove that user&rsquo;s ability to use the SoftLayer API.</p>
174+
175+
<h2 id="temporary-api-key">Temporary API Key</h2>
176+
177+
<p>It is possible to get a short lived API key using a username/password combination with [[SoftLayer_User_Customer::getPortalLoginToken]]. This token can be used in place of an API key during calls and will expire after 48 hours.</p>
178+
179+
<h2 id="associated-methods">Associated Methods</h2>
180+
181+
<ul>
182+
<li>[[SoftLayer_User_Customer::getApiAuthenticationKeys]]</li>
183+
<li>[[SoftLayer_User_Customer::addApiAuthenticationKey]]</li>
184+
185+
<li><p>[[SoftLayer_User_Customer::removeApiAuthenticationKey]]</p>
186+
187+
<h2 id="see-also">See Also</h2></li>
188+
189+
<li><p>[[SoftLayer_User_Customer_ApiAuthentication]]</p></li>
190+
</ul>
191+
192+
<h2 id="external-links">External Links</h2>
193+
194+
<ul>
195+
<li>The [<a href="https://manage.softlayer.com/UserManagement/apiKeychain">https://manage.softlayer.com/UserManagement/apiKeychain</a> API keychain] page at the [<a href="https://manage.softlayer.com/">https://manage.softlayer.com/</a> SoftLayer customer portal]</li>
196+
</ul>
197+
198+
</div>
199+
</div>
200+
201+
</div>
202+
<hr>
203+
<div class="row">
204+
205+
<div class="col-md-6">
206+
207+
<div class="panel panel-default">
208+
<div class="panel-heading" style="padding: 2px 15px;">
209+
<h4>More Documentation</h4>
210+
</div>
211+
<div class="panel-body">
212+
<a href="https://softlayer.github.com/reference/softlayerapi"><i class="fa fa-link"></i> SoftLayer API Reference<br></a>
213+
<a href="https://github.com/softlayer/softlayer-java"><i class="fab fa-github"></i> softlayer-java<br></a>
214+
<a href="https://github.com/softlayer/softlayer-api-perl-client"><i class="fab fa-github"></i> softlayer-perl<br></a>
215+
<a href="https://github.com/softlayer/softlayer-api-php-client"><i class="fab fa-github"></i> softlayer-php<br></a>
216+
<a href="https://github.com/softlayer/softlayer-python"><i class="fab fa-github"></i> softlayer-python<br></a>
217+
<a href="https://github.com/softlayer/softlayer-ruby"><i class="fab fa-github"></i> softlayer-ruby<br></a>
218+
</div>
219+
</div>
220+
221+
<div class="panel panel-default">
222+
<div class="panel-heading text-center" style="padding: 2px 15px;">
223+
<a href="https://www.facebook.com/IBMBluemixIaaS/"><i class="fab fa-facebook-square" alt="facebook"></i> </a>
224+
<a href="https://twitter.com/IBMBluemixIaaS"><i class="fab fa-twitter" alt="twitter"></i> </a>
225+
<a href="http://www.linkedin.com/company/softlayer-technologies-inc-" alt="linked-in"><i class="fab fa-linkedin"></i> </a>
226+
<a href="https://github.com/softlayer/softlayer.github.io"><i class="fab fa-github" alt="github"></i> </a>
227+
228+
</div>
229+
</div>
230+
231+
</div>
232+
<div class="col-md-6">
233+
<div class="well well-sm" style="word-wrap: break-word;">
234+
<strong>Feedback? <span class="fa fa-comment"/></strong>
235+
<p>
236+
We would love to hear it<br>
237+
<a class="" href="https://github.com/softlayer/api_examples/issues/new?title=Feedback%20for%20article%20-%20Authenticating%20to%20the%20SoftLayer%20API&body=Feedback+regarding%3A%20https%3a%2f%2fsoftlayer.github.io%2farticle%2fauthenticating-softlayer-api%2f"><span class="fa fa-github-square"/> Open an issue</a>
238+
</p>
239+
</div>
240+
</div>
241+
242+
</div>
243+
<footer>
244+
<div class="row">
245+
<hr>
246+
<div class="col-sm-12">
247+
<p>&copy; SoftLayer 2015<br>
248+
Built with <a href="https://github.com/spf13/hugo">Hugo</a></p>
249+
</div>
250+
</div>
251+
</footer>
252+
</div>
253+
254+
<script src="https://softlayer.github.io/js/jquery.js"></script>
255+
<script src="https://softlayer.github.io/js/bootstrap.js"></script>
256+
</body>
257+
</html>
258+
259+
/article/authenticating-softlayer-api/

0 commit comments

Comments
 (0)