Skip to content

Latest commit

 

History

History
370 lines (231 loc) · 9.47 KB

RolesApi.md

File metadata and controls

370 lines (231 loc) · 9.47 KB
Raw

\RolesApi

All URIs are relative to https://app.corellium.com/api

Method HTTP request Description
V1AddTeamRoleToProject Put /v1/roles/projects/{projectId}/teams/{teamId}/roles/{roleId} Add team role to project
V1AddUserRoleToProject Put /v1/roles/projects/{projectId}/users/{userId}/roles/{roleId} Add user role to project
V1RemoveTeamRoleFromProject Delete /v1/roles/projects/{projectId}/teams/{teamId}/roles/{roleId} Remove team role from project
V1RemoveUserRoleFromProject Delete /v1/roles/projects/{projectId}/users/{userId}/roles/{roleId} Remove user role from project
V1Roles Get /v1/roles Get all roles

V1AddTeamRoleToProject

V1AddTeamRoleToProject(ctx, projectId, teamId, roleId).Execute()

Add team role to project

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/corellium/go-corellium-api-client"
)

func main() {
    projectId := "projectId_example" // string | Project ID - uuid
    teamId := "teamId_example" // string | Team ID - uuid
    roleId := "roleId_example" // string | Role ID - uuid

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.RolesApi.V1AddTeamRoleToProject(context.Background(), projectId, teamId, roleId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `RolesApi.V1AddTeamRoleToProject``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
projectId string Project ID - uuid
teamId string Team ID - uuid
roleId string Role ID - uuid

Other Parameters

Other parameters are passed through a pointer to a apiV1AddTeamRoleToProjectRequest struct via the builder pattern

Name Type Description Notes

Return type

(empty response body)

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1AddUserRoleToProject

V1AddUserRoleToProject(ctx, projectId, userId, roleId).Execute()

Add user role to project

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/corellium/go-corellium-api-client"
)

func main() {
    projectId := "projectId_example" // string | Project ID - uuid
    userId := "userId_example" // string | User ID - uuid
    roleId := "roleId_example" // string | Role ID - uuid

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.RolesApi.V1AddUserRoleToProject(context.Background(), projectId, userId, roleId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `RolesApi.V1AddUserRoleToProject``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
projectId string Project ID - uuid
userId string User ID - uuid
roleId string Role ID - uuid

Other Parameters

Other parameters are passed through a pointer to a apiV1AddUserRoleToProjectRequest struct via the builder pattern

Name Type Description Notes

Return type

(empty response body)

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1RemoveTeamRoleFromProject

V1RemoveTeamRoleFromProject(ctx, projectId, teamId, roleId).Execute()

Remove team role from project

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/corellium/go-corellium-api-client"
)

func main() {
    projectId := "projectId_example" // string | Project ID - uuid
    teamId := "teamId_example" // string | Team ID - uuid
    roleId := "roleId_example" // string | Role ID - uuid

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.RolesApi.V1RemoveTeamRoleFromProject(context.Background(), projectId, teamId, roleId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `RolesApi.V1RemoveTeamRoleFromProject``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
projectId string Project ID - uuid
teamId string Team ID - uuid
roleId string Role ID - uuid

Other Parameters

Other parameters are passed through a pointer to a apiV1RemoveTeamRoleFromProjectRequest struct via the builder pattern

Name Type Description Notes

Return type

(empty response body)

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1RemoveUserRoleFromProject

V1RemoveUserRoleFromProject(ctx, projectId, userId, roleId).Execute()

Remove user role from project

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/corellium/go-corellium-api-client"
)

func main() {
    projectId := "projectId_example" // string | Project ID - uuid
    userId := "userId_example" // string | User ID - uuid
    roleId := "roleId_example" // string | Role ID - uuid

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.RolesApi.V1RemoveUserRoleFromProject(context.Background(), projectId, userId, roleId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `RolesApi.V1RemoveUserRoleFromProject``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
projectId string Project ID - uuid
userId string User ID - uuid
roleId string Role ID - uuid

Other Parameters

Other parameters are passed through a pointer to a apiV1RemoveUserRoleFromProjectRequest struct via the builder pattern

Name Type Description Notes

Return type

(empty response body)

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1Roles

[]Role V1Roles(ctx).Execute()

Get all roles

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/corellium/go-corellium-api-client"
)

func main() {

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.RolesApi.V1Roles(context.Background()).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `RolesApi.V1Roles``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `V1Roles`: []Role
    fmt.Fprintf(os.Stdout, "Response from `RolesApi.V1Roles`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiV1RolesRequest struct via the builder pattern

Return type

[]Role

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]