-
Notifications
You must be signed in to change notification settings - Fork 119
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix: change to trigger a catch-up release (#1164)
adding a readme to this package that lacks one.
- Loading branch information
1 parent
11adbce
commit c3a70f1
Showing
1 changed file
with
87 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,87 @@ | ||
[![npm version][npm-img]][npm-url] | ||
[![gzip bundle size][gzip-image]][npm-url] | ||
[![Coverage Status][coverage-img]][coverage-url] | ||
[![apache licensed](https://img.shields.io/badge/license-Apache-green.svg?style=flat-square)](https://raw.githubusercontent.com/Esri/arcgis-rest-js/master/LICENSE) | ||
|
||
[npm-img]: https://img.shields.io/npm/v/@esri/arcgis-rest-developer-credentials.svg?style=flat-square | ||
[npm-url]: https://www.npmjs.com/package/@esri/arcgis-rest-developer-credentials | ||
[gzip-image]: https://img.badgesize.io/https://unpkg.com/@esri/arcgis-rest-developer-credentials/dist/bundled/developer-credentials.umd.min.js?compression=gzip | ||
[coverage-img]: https://codecov.io/gh/Esri/arcgis-rest-js/branch/master/graph/badge.svg | ||
[coverage-url]: https://codecov.io/gh/Esri/arcgis-rest-js | ||
|
||
# @esri/arcgis-rest-developer-credentials | ||
|
||
> Access and manage API keys and OAuth 2.0 application credentials with REST JS. | ||
### Example | ||
|
||
```bash | ||
npm install @esri/arcgis-rest-request | ||
npm install @esri/arcgis-rest-developer-credentials | ||
``` | ||
|
||
```js | ||
import { | ||
createApiKey, | ||
Privileges | ||
} from "@esri/arcgis-rest-developer-credentials"; | ||
|
||
const authSession: ArcGISIdentityManager = await ArcGISIdentityManager.signIn({ | ||
username: "xyz_usrName", | ||
password: "xyz_pw" | ||
}); | ||
|
||
createApiKey({ | ||
title: "xyz_title", | ||
description: "xyz_desc", | ||
tags: ["xyz_tag1", "xyz_tag2"], | ||
privileges: [Privileges.Geocode, Privileges.FeatureReport], | ||
authentication: authSession | ||
}) | ||
.then((registeredAPIKey) => { | ||
// => {apiKey: "xyz_key", item: {tags: ["xyz_tag1", "xyz_tag2"], ...}, ...} | ||
}) | ||
.catch((e) => { | ||
// => an exception object | ||
}); | ||
``` | ||
|
||
### [API Reference](https://developers.arcgis.com/arcgis-rest-js/api-reference/arcgis-rest-developer-credentials/) | ||
|
||
Please see [all the exports](https://developers.arcgis.com/arcgis-rest-js/api-reference/arcgis-rest-developer-credentials/#exports). | ||
|
||
### Issues | ||
|
||
If something isn't working the way you expected, please take a look at [previously logged issues](https://github.com/Esri/arcgis-rest-js/issues) first. Have you found a new bug? Want to request a new feature? We'd [**love**](https://github.com/Esri/arcgis-rest-js/issues/new) to hear from you. | ||
|
||
If you're looking for help you can also post issues on [GIS Stackexchange](http://gis.stackexchange.com/questions/ask?tags=esri-oss). | ||
|
||
### Versioning | ||
|
||
For transparency into the release cycle and in striving to maintain backward compatibility, @esri/arcgis-rest-js is maintained under Semantic Versioning guidelines and will adhere to these rules whenever possible. | ||
|
||
For more information on SemVer, please visit <http://semver.org/>. | ||
|
||
### Contributing | ||
|
||
Esri welcomes contributions from anyone and everyone. Please see our [guidelines for contributing](CONTRIBUTING.md). | ||
|
||
### [Changelog](https://github.com/Esri/arcgis-rest-js/blob/master/CHANGELOG.md) | ||
|
||
### License | ||
|
||
Copyright © 2017-2024 Esri | ||
|
||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
|
||
> <http://www.apache.org/licenses/LICENSE-2.0> | ||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
|
||
A copy of the license is available in the repository's [LICENSE](../../LICENSE) file. |