Profiles
15 methods on the Profiles resource.
15 methods · 0 available to app tokens36 pages in SDK Reference
import { Compozy } from "@compozy/client";15 of 15
archiveProfilecreateProfiledeleteProfilegetProfilegetProfileSelectionslistProfileOperationslistProfilesprepareProfileArchiveprepareProfileDeleteprepareProfileRenameputProfileSelectionrenameProfileretryProfileOperationunarchiveProfileupdateProfile
archiveProfile
Archive a profile
compozy.profiles.archiveProfile({ path, body }) → Promise<ArchiveProfileResponse>
Options
- namestringpathrequired
- Profile name
Request bodyProfilePlanRequest
POST /api/profiles/{name}/archiveapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.profiles.archiveProfile({ path: { "name": "name" }, body: { /* request fields */ } });createProfile
Create a profile
compozy.profiles.createProfile({ body }) → Promise<Profile>
Request bodyCreateProfileRequest
POST /api/profilesapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.profiles.createProfile({ body: { /* request fields */ } });deleteProfile
Delete a profile
compozy.profiles.deleteProfile({ path, query }) → Promise<DeleteProfileResponse>
Options
- namestringpathrequired
- Profile name
- plan_revisionstringqueryrequired
- Revision returned by the delete plan
DELETE /api/profiles/{name}app tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.profiles.deleteProfile({ path: { "name": "name" }, query: { "plan_revision": "plan_revision" } });getProfile
Get a profile
compozy.profiles.getProfile({ path }) → Promise<Profile>
Options
- namestringpathrequired
- Profile name
GET /api/profiles/{name}app tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.profiles.getProfile({ path: { "name": "name" } });getProfileSelections
Read profile selections
compozy.profiles.getProfileSelections({ query }) → Promise<Array<ProfileSelection> | ProfileSelection>
Options
- scope"global" | "workspace"query
- Selection scope
- workspace_idstringquery
- Workspace selection lens
GET /api/profiles/selectionapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.profiles.getProfileSelections();listProfileOperations
List profile lifecycle operations
compozy.profiles.listProfileOperations() → Promise<Array<ProfileOperation>>
GET /api/profiles/opsapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.profiles.listProfileOperations();listProfiles
List profiles
compozy.profiles.listProfiles() → Promise<Array<Profile>>
GET /api/profilesapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.profiles.listProfiles();prepareProfileArchive
Preview profile archival
compozy.profiles.prepareProfileArchive({ path }) → Promise<ArchiveProfilePlan>
Options
- namestringpathrequired
- Profile name
GET /api/profiles/{name}/archive-planapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.profiles.prepareProfileArchive({ path: { "name": "name" } });prepareProfileDelete
Preview profile deletion
compozy.profiles.prepareProfileDelete({ path }) → Promise<DeleteProfilePlan>
Options
- namestringpathrequired
- Profile name
GET /api/profiles/{name}/delete-planapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.profiles.prepareProfileDelete({ path: { "name": "name" } });prepareProfileRename
Preview a profile rename
compozy.profiles.prepareProfileRename({ path, query }) → Promise<RenameProfilePlan>
Options
- namestringpathrequired
- Profile name
- new_namestringqueryrequired
- New profile name
GET /api/profiles/{name}/rename-planapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.profiles.prepareProfileRename({ path: { "name": "name" }, query: { "new_name": "new_name" } });Show all 15 methods
putProfileSelection
Remember a profile selection
compozy.profiles.putProfileSelection({ body }) → Promise<ProfileSelection>
Request bodyProfileSelection
PUT /api/profiles/selectionapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.profiles.putProfileSelection({ body: { /* request fields */ } });renameProfile
Rename a profile
compozy.profiles.renameProfile({ path, body }) → Promise<RenameProfileResponse>
Options
- namestringpathrequired
- Profile name
Request bodyRenameProfileRequest
POST /api/profiles/{name}/renameapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.profiles.renameProfile({ path: { "name": "name" }, body: { /* request fields */ } });retryProfileOperation
Retry a profile lifecycle operation
compozy.profiles.retryProfileOperation({ path }) → Promise<ProfileOperation>
Options
- op_idstringpathrequired
- Lifecycle operation id
POST /api/profiles/ops/{op_id}/retryapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.profiles.retryProfileOperation({ path: { "op_id": "op_id" } });unarchiveProfile
Unarchive a profile
compozy.profiles.unarchiveProfile({ path, body }) → Promise<UnarchiveProfileResponse>
Options
- namestringpathrequired
- Profile name
Request bodyunknown
POST /api/profiles/{name}/unarchiveapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.profiles.unarchiveProfile({ path: { "name": "name" }, body: { /* request fields */ } });updateProfile
Update profile identity
compozy.profiles.updateProfile({ path, body }) → Promise<Profile>
Options
- namestringpathrequired
- Profile name
Request bodyUpdateProfileRequest
PATCH /api/profiles/{name}app tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.profiles.updateProfile({ path: { "name": "name" }, body: { /* request fields */ } });