Integrations

Read, create, update or delete integrations.

To manipulate the integrations, access the integrations object on the SDK. Through that, you can invoke all integration methods mentioned, like this:


                                                        
                                                        
                                                            const oAuthRequestURL = await sdk.integrations.getFigmaOAuthURL()
                                                        
                                                            

Read methods

Get Figma OAuth URL

Returns a URL that can be used to authenticate the current user (identified by the token) with Figma.


                                                        
                                                        
                                                            async getFigmaOAuthURL(): Promise<string>
                                                        
                                                            

Get GitHub OAuth URL

Returns a URL that can be used to authenticate the current user (identified by the token) with GitHub.


                                                        
                                                        
                                                            async getGitHubOAuthURL(): Promise<string>
                                                        
                                                            

Get GitLab OAuth URL

Returns a URL that can be used to authenticate the current user (identified by the token) with GitLab.


                                                        
                                                        
                                                            async getGitLabOAuthURL(): Promise<string>
                                                        
                                                            

Get Bitbucket OAuth URL

Returns a URL that can be used to authenticate the current user (identified by the token) with Bitbucket.


                                                        
                                                        
                                                            async getBitbucketOAuthURL(): Promise<string>
                                                        
                                                            

Get Azure OAuth URL

Returns a URL that can be used to authenticate the current user (identified by the token) with Azure.


                                                        
                                                        
                                                            async getAzureOAuthURL(): Promise<string>
                                                        
                                                            

Delete methods

Delete Figma OAuth integration

Use this method to revoke the Figma OAuth integration for a specific user. This action removes the integration between the user's account and Figma.


                                                        
                                                        
                                                            async deleteFigmaOAuthIntegration(userId: string): Promise<void>
                                                        
                                                            

Delete GitHub OAuth integration

Use this method to revoke the GitHub OAuth integration for a specific user. This action removes the integration between the user's account and GitHub.


                                                        
                                                        
                                                            async deleteGitHubOAuthIntegration(userId: string): Promise<void>
                                                        
                                                            

Delete GitLab OAuth integration

Use this method to revoke the GitLab OAuth integration for a specific user. This action removes the integration between the user's account and GitLab.


                                                        
                                                        
                                                            async deleteGitLabOAuthIntegration(userId: string): Promise<void>
                                                        
                                                            

Delete Bitbucket OAuth integration

Use this method to revoke the Bitbucket OAuth integration for a specific user. This action removes the integration between the user's account and Bitbucket.


                                                        
                                                        
                                                            async deleteBitbucketOAuthIntegration(userId: string): Promise<void>
                                                        
                                                            

Delete Azure OAuth integration

Use this method to revoke the Azure OAuth integration for a specific user. This action removes the integration between the user's account and Azure.


                                                        
                                                        
                                                            async deleteAzureOAuthIntegration(userId: string): Promise<void>