---
name: "authorize"
mode: "kit"
versionRequirements:
  - { name: "BaseKit", version: "2.0.1" }
  - { name: "@ray-js/ray", version: "0.3.23" }
platform:
  - "iOS"
  - "Android"
async: true
---

## authorize

> [VERSION] BaseKit >= 2.0.1 | @ray-js/ray >= 0.3.23

> [PLATFORM] iOS, Android

> ⚡ **Supports Promise** — Returns a Promise when success / fail / complete callbacks are omitted.

### Description

Permission request method

### Parameters

| Property | Type | Required | Default | Since | Description |
| --- | --- | --- | --- | --- | --- |
| `scope` | `"scope.bluetooth" \| "scope.record" \| "scope.writePhotosAlbum" \| "scope.camera" \| "scope.userLocation" \| "scope.userPreciseLocation" \| "scope.userLocationBackground" \| "scope.userInfo" \| "scope.calendar" \| "scope.nearByWifiDevice"` | No | `'scope.writePhotosAlbum'` | `2.0.1` | scope permission name |
| `complete` | `() => void` | No | - | - | Completion callback (executed on both success and failure) |
| `success` | `() => void` | No | - | - | Callback on successful API call |
| `fail` | `(params: Object) => void` ↓see below | No | - | - | Failure callback |

#### fail callback parameters

| Property | Type | Description |
| --- | --- | --- |
| `errorMsg` | `string` | Error message |
| `errorCode` | `string \| number` | Error code |
| `innerError` | `Object` | Error extension |

##### fail(params).innerError properties

| Property | Type | Description |
| --- | --- | --- |
| `errorCode` | `string \| number` | Error extension code |
| `errorMsg` | `string` | Error extension message |


### Valid Values

##### `scope` valid values

| Value | Description |
| --- | --- |
| `"scope.bluetooth"` | Bluetooth permission |
| `"scope.record"` | Microphone permission |
| `"scope.writePhotosAlbum"` | Write permission |
| `"scope.camera"` | Camera permission |
| `"scope.userLocation"` | Low-accuracy location permission |
| `"scope.userPreciseLocation"` | High-accuracy location permission |
| `"scope.userLocationBackground"` | Background location permission
Note: On iOS, enable TARGETS->Capabilities->Background Modes->Location updates |
| `"scope.userInfo"` | User information |
| `"scope.calendar"` | Calendar read/write permission |
| `"scope.nearByWifiDevice"` | Connect to nearby Wi-Fi devices, Android only |


### Examples

#### Demo

```tsx
import { authorize } from '@ray-js/ray'

authorize({
  scope: "scope.writePhotosAlbum",
  success: data => {
    console.log(data);
  },
  fail: error => {
    console.error(error);
  },
});
```