Skip to main content

createApiKey

This endpoint requires the apiKey.create permission.

Request Body REQUIRED
name string
permissions string[] REQUIRED

Possible values: [all, activity.create, activity.read, activity.update, activity.delete, activity.statistics, apiKey.create, apiKey.read, apiKey.update, apiKey.delete, asset.read, asset.update, asset.delete, asset.statistics, asset.share, asset.view, asset.download, asset.upload, asset.replace, album.create, album.read, album.update, album.delete, album.statistics, album.share, album.download, albumAsset.create, albumAsset.delete, albumUser.create, albumUser.update, albumUser.delete, auth.changePassword, authDevice.delete, archive.read, duplicate.read, duplicate.delete, face.create, face.read, face.update, face.delete, job.create, job.read, library.create, library.read, library.update, library.delete, library.statistics, timeline.read, timeline.download, memory.create, memory.read, memory.update, memory.delete, memory.statistics, memoryAsset.create, memoryAsset.delete, notification.create, notification.read, notification.update, notification.delete, partner.create, partner.read, partner.update, partner.delete, person.create, person.read, person.update, person.delete, person.statistics, person.merge, person.reassign, pinCode.create, pinCode.update, pinCode.delete, server.about, server.apkLinks, server.storage, server.statistics, serverLicense.read, serverLicense.update, serverLicense.delete, session.create, session.read, session.update, session.delete, session.lock, sharedLink.create, sharedLink.read, sharedLink.update, sharedLink.delete, stack.create, stack.read, stack.update, stack.delete, sync.stream, syncCheckpoint.read, syncCheckpoint.update, syncCheckpoint.delete, systemConfig.read, systemConfig.update, systemMetadata.read, systemMetadata.update, tag.create, tag.read, tag.update, tag.delete, tag.asset, user.read, user.update, userLicense.create, userLicense.read, userLicense.update, userLicense.delete, userOnboarding.read, userOnboarding.update, userOnboarding.delete, userPreference.read, userPreference.update, userProfileImage.create, userProfileImage.read, userProfileImage.update, userProfileImage.delete, adminUser.create, adminUser.read, adminUser.update, adminUser.delete]

Responses
201
Schema OPTIONAL
apiKey object
createdAt date-time
id string
name string
permissions string[]

Possible values: [all, activity.create, activity.read, activity.update, activity.delete, activity.statistics, apiKey.create, apiKey.read, apiKey.update, apiKey.delete, asset.read, asset.update, asset.delete, asset.statistics, asset.share, asset.view, asset.download, asset.upload, asset.replace, album.create, album.read, album.update, album.delete, album.statistics, album.share, album.download, albumAsset.create, albumAsset.delete, albumUser.create, albumUser.update, albumUser.delete, auth.changePassword, authDevice.delete, archive.read, duplicate.read, duplicate.delete, face.create, face.read, face.update, face.delete, job.create, job.read, library.create, library.read, library.update, library.delete, library.statistics, timeline.read, timeline.download, memory.create, memory.read, memory.update, memory.delete, memory.statistics, memoryAsset.create, memoryAsset.delete, notification.create, notification.read, notification.update, notification.delete, partner.create, partner.read, partner.update, partner.delete, person.create, person.read, person.update, person.delete, person.statistics, person.merge, person.reassign, pinCode.create, pinCode.update, pinCode.delete, server.about, server.apkLinks, server.storage, server.statistics, serverLicense.read, serverLicense.update, serverLicense.delete, session.create, session.read, session.update, session.delete, session.lock, sharedLink.create, sharedLink.read, sharedLink.update, sharedLink.delete, stack.create, stack.read, stack.update, stack.delete, sync.stream, syncCheckpoint.read, syncCheckpoint.update, syncCheckpoint.delete, systemConfig.read, systemConfig.update, systemMetadata.read, systemMetadata.update, tag.create, tag.read, tag.update, tag.delete, tag.asset, user.read, user.update, userLicense.create, userLicense.read, userLicense.update, userLicense.delete, userOnboarding.read, userOnboarding.update, userOnboarding.delete, userPreference.read, userPreference.update, userProfileImage.create, userProfileImage.read, userProfileImage.update, userProfileImage.delete, adminUser.create, adminUser.read, adminUser.update, adminUser.delete]

updatedAt date-time
secret string