Skip to content

Latest commit

 

History

History
2626 lines (1672 loc) · 81.1 KB

OrganizationsAPI.md

File metadata and controls

2626 lines (1672 loc) · 81.1 KB
Raw

\OrganizationsAPI

All URIs are relative to http://localhost

Method HTTP request Description
AddOrganizationApplications Post /api/organizations/{id}/applications Add organization application
AddOrganizationUsers Post /api/organizations/{id}/users Add user members to organization
AssignOrganizationRolesToApplication Post /api/organizations/{id}/applications/{applicationId}/roles Add organization application role
AssignOrganizationRolesToApplications Post /api/organizations/{id}/applications/roles Assign roles to applications in an organization
AssignOrganizationRolesToUser Post /api/organizations/{id}/users/{userId}/roles Assign roles to a user in an organization
AssignOrganizationRolesToUsers Post /api/organizations/{id}/users/roles Assign roles to organization user members
CreateOrganization Post /api/organizations Create an organization
CreateOrganizationJitEmailDomain Post /api/organizations/{id}/jit/email-domains Add organization JIT email domain
CreateOrganizationJitRole Post /api/organizations/{id}/jit/roles Add organization JIT default roles
CreateOrganizationJitSsoConnector Post /api/organizations/{id}/jit/sso-connectors Add organization JIT SSO connectors
DeleteOrganization Delete /api/organizations/{id} Delete organization
DeleteOrganizationApplication Delete /api/organizations/{id}/applications/{applicationId} Remove organization application
DeleteOrganizationApplicationRole Delete /api/organizations/{id}/applications/{applicationId}/roles/{organizationRoleId} Remove organization application role
DeleteOrganizationJitEmailDomain Delete /api/organizations/{id}/jit/email-domains/{emailDomain} Remove organization JIT email domain
DeleteOrganizationJitRole Delete /api/organizations/{id}/jit/roles/{organizationRoleId} Remove organization JIT default role
DeleteOrganizationJitSsoConnector Delete /api/organizations/{id}/jit/sso-connectors/{ssoConnectorId} Remove organization JIT SSO connector
DeleteOrganizationUser Delete /api/organizations/{id}/users/{userId} Remove user member from organization
DeleteOrganizationUserRole Delete /api/organizations/{id}/users/{userId}/roles/{organizationRoleId} Remove a role from a user in an organization
GetOrganization Get /api/organizations/{id} Get organization
ListOrganizationApplicationRoles Get /api/organizations/{id}/applications/{applicationId}/roles Get organization application roles
ListOrganizationApplications Get /api/organizations/{id}/applications Get organization applications
ListOrganizationJitEmailDomains Get /api/organizations/{id}/jit/email-domains Get organization JIT email domains
ListOrganizationJitRoles Get /api/organizations/{id}/jit/roles Get organization JIT default roles
ListOrganizationJitSsoConnectors Get /api/organizations/{id}/jit/sso-connectors Get organization JIT SSO connectors
ListOrganizationUserRoles Get /api/organizations/{id}/users/{userId}/roles Get roles for a user in an organization
ListOrganizationUserScopes Get /api/organizations/{id}/users/{userId}/scopes Get scopes for a user in an organization tailored by the organization roles
ListOrganizationUsers Get /api/organizations/{id}/users Get organization user members
ListOrganizations Get /api/organizations Get organizations
ReplaceOrganizationApplicationRoles Put /api/organizations/{id}/applications/{applicationId}/roles Replace organization application roles
ReplaceOrganizationApplications Put /api/organizations/{id}/applications Replace organization applications
ReplaceOrganizationJitEmailDomains Put /api/organizations/{id}/jit/email-domains Replace organization JIT email domains
ReplaceOrganizationJitRoles Put /api/organizations/{id}/jit/roles Replace organization JIT default roles
ReplaceOrganizationJitSsoConnectors Put /api/organizations/{id}/jit/sso-connectors Replace organization JIT SSO connectors
ReplaceOrganizationUserRoles Put /api/organizations/{id}/users/{userId}/roles Update roles for a user in an organization
ReplaceOrganizationUsers Put /api/organizations/{id}/users Replace organization user members
UpdateOrganization Patch /api/organizations/{id} Update organization

AddOrganizationApplications

AddOrganizationApplications(ctx, id).AddOrganizationApplicationsRequest(addOrganizationApplicationsRequest).Execute()

Add organization application

Example

package main

import (
	"context"
	"fmt"
	"os"
	logto "github.com/mostafa/go-api-client"
)

func main() {
	id := "id_example" // string | The unique identifier of the organization.
	addOrganizationApplicationsRequest := *logto.NewAddOrganizationApplicationsRequest([]string{"ApplicationIds_example"}) // AddOrganizationApplicationsRequest | 

	configuration := logto.NewConfiguration()
	apiClient := logto.NewAPIClient(configuration)
	r, err := apiClient.OrganizationsAPI.AddOrganizationApplications(context.Background(), id).AddOrganizationApplicationsRequest(addOrganizationApplicationsRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsAPI.AddOrganizationApplications``: %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.
id string The unique identifier of the organization.

Other Parameters

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

Name Type Description Notes

addOrganizationApplicationsRequest | AddOrganizationApplicationsRequest | |

Return type

(empty response body)

Authorization

ManagementApi

HTTP request headers

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

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

AddOrganizationUsers

AddOrganizationUsers(ctx, id).AddOrganizationUsersRequest(addOrganizationUsersRequest).Execute()

Add user members to organization

Example

package main

import (
	"context"
	"fmt"
	"os"
	logto "github.com/mostafa/go-api-client"
)

func main() {
	id := "id_example" // string | The unique identifier of the organization.
	addOrganizationUsersRequest := *logto.NewAddOrganizationUsersRequest([]string{"UserIds_example"}) // AddOrganizationUsersRequest | 

	configuration := logto.NewConfiguration()
	apiClient := logto.NewAPIClient(configuration)
	r, err := apiClient.OrganizationsAPI.AddOrganizationUsers(context.Background(), id).AddOrganizationUsersRequest(addOrganizationUsersRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsAPI.AddOrganizationUsers``: %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.
id string The unique identifier of the organization.

Other Parameters

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

Name Type Description Notes

addOrganizationUsersRequest | AddOrganizationUsersRequest | |

Return type

(empty response body)

Authorization

ManagementApi

HTTP request headers

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

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

AssignOrganizationRolesToApplication

AssignOrganizationRolesToApplication(ctx, id, applicationId).AssignOrganizationRolesToApplicationRequest(assignOrganizationRolesToApplicationRequest).Execute()

Add organization application role

Example

package main

import (
	"context"
	"fmt"
	"os"
	logto "github.com/mostafa/go-api-client"
)

func main() {
	id := "id_example" // string | The unique identifier of the organization.
	applicationId := "applicationId_example" // string | The unique identifier of the application.
	assignOrganizationRolesToApplicationRequest := *logto.NewAssignOrganizationRolesToApplicationRequest([]string{"OrganizationRoleIds_example"}) // AssignOrganizationRolesToApplicationRequest | 

	configuration := logto.NewConfiguration()
	apiClient := logto.NewAPIClient(configuration)
	r, err := apiClient.OrganizationsAPI.AssignOrganizationRolesToApplication(context.Background(), id, applicationId).AssignOrganizationRolesToApplicationRequest(assignOrganizationRolesToApplicationRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsAPI.AssignOrganizationRolesToApplication``: %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.
id string The unique identifier of the organization.
applicationId string The unique identifier of the application.

Other Parameters

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

Name Type Description Notes

assignOrganizationRolesToApplicationRequest | AssignOrganizationRolesToApplicationRequest | |

Return type

(empty response body)

Authorization

ManagementApi

HTTP request headers

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

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

AssignOrganizationRolesToApplications

AssignOrganizationRolesToApplications(ctx, id).AssignOrganizationRolesToApplicationsRequest(assignOrganizationRolesToApplicationsRequest).Execute()

Assign roles to applications in an organization

Example

package main

import (
	"context"
	"fmt"
	"os"
	logto "github.com/mostafa/go-api-client"
)

func main() {
	id := "id_example" // string | The unique identifier of the organization.
	assignOrganizationRolesToApplicationsRequest := *logto.NewAssignOrganizationRolesToApplicationsRequest([]string{"ApplicationIds_example"}, []string{"OrganizationRoleIds_example"}) // AssignOrganizationRolesToApplicationsRequest | 

	configuration := logto.NewConfiguration()
	apiClient := logto.NewAPIClient(configuration)
	r, err := apiClient.OrganizationsAPI.AssignOrganizationRolesToApplications(context.Background(), id).AssignOrganizationRolesToApplicationsRequest(assignOrganizationRolesToApplicationsRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsAPI.AssignOrganizationRolesToApplications``: %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.
id string The unique identifier of the organization.

Other Parameters

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

Name Type Description Notes

assignOrganizationRolesToApplicationsRequest | AssignOrganizationRolesToApplicationsRequest | |

Return type

(empty response body)

Authorization

ManagementApi

HTTP request headers

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

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

AssignOrganizationRolesToUser

AssignOrganizationRolesToUser(ctx, id, userId).AssignOrganizationRolesToUserRequest(assignOrganizationRolesToUserRequest).Execute()

Assign roles to a user in an organization

Example

package main

import (
	"context"
	"fmt"
	"os"
	logto "github.com/mostafa/go-api-client"
)

func main() {
	id := "id_example" // string | The unique identifier of the organization.
	userId := "userId_example" // string | The unique identifier of the user.
	assignOrganizationRolesToUserRequest := *logto.NewAssignOrganizationRolesToUserRequest([]string{"OrganizationRoleIds_example"}) // AssignOrganizationRolesToUserRequest | 

	configuration := logto.NewConfiguration()
	apiClient := logto.NewAPIClient(configuration)
	r, err := apiClient.OrganizationsAPI.AssignOrganizationRolesToUser(context.Background(), id, userId).AssignOrganizationRolesToUserRequest(assignOrganizationRolesToUserRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsAPI.AssignOrganizationRolesToUser``: %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.
id string The unique identifier of the organization.
userId string The unique identifier of the user.

Other Parameters

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

Name Type Description Notes

assignOrganizationRolesToUserRequest | AssignOrganizationRolesToUserRequest | |

Return type

(empty response body)

Authorization

ManagementApi

HTTP request headers

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

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

AssignOrganizationRolesToUsers

AssignOrganizationRolesToUsers(ctx, id).AssignOrganizationRolesToUsersRequest(assignOrganizationRolesToUsersRequest).Execute()

Assign roles to organization user members

Example

package main

import (
	"context"
	"fmt"
	"os"
	logto "github.com/mostafa/go-api-client"
)

func main() {
	id := "id_example" // string | The unique identifier of the organization.
	assignOrganizationRolesToUsersRequest := *logto.NewAssignOrganizationRolesToUsersRequest([]string{"UserIds_example"}, []string{"OrganizationRoleIds_example"}) // AssignOrganizationRolesToUsersRequest | 

	configuration := logto.NewConfiguration()
	apiClient := logto.NewAPIClient(configuration)
	r, err := apiClient.OrganizationsAPI.AssignOrganizationRolesToUsers(context.Background(), id).AssignOrganizationRolesToUsersRequest(assignOrganizationRolesToUsersRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsAPI.AssignOrganizationRolesToUsers``: %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.
id string The unique identifier of the organization.

Other Parameters

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

Name Type Description Notes

assignOrganizationRolesToUsersRequest | AssignOrganizationRolesToUsersRequest | |

Return type

(empty response body)

Authorization

ManagementApi

HTTP request headers

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

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

CreateOrganization

CreateOrganization(ctx).CreateOrganizationRequest(createOrganizationRequest).Execute()

Create an organization

Example

package main

import (
	"context"
	"fmt"
	"os"
	logto "github.com/mostafa/go-api-client"
)

func main() {
	createOrganizationRequest := *logto.NewCreateOrganizationRequest("Name_example") // CreateOrganizationRequest | 

	configuration := logto.NewConfiguration()
	apiClient := logto.NewAPIClient(configuration)
	r, err := apiClient.OrganizationsAPI.CreateOrganization(context.Background()).CreateOrganizationRequest(createOrganizationRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsAPI.CreateOrganization``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Other Parameters

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

Name Type Description Notes
createOrganizationRequest CreateOrganizationRequest

Return type

(empty response body)

Authorization

ManagementApi

HTTP request headers

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

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

CreateOrganizationJitEmailDomain

CreateOrganizationJitEmailDomain(ctx, id).CreateOrganizationJitEmailDomainRequest(createOrganizationJitEmailDomainRequest).Execute()

Add organization JIT email domain

Example

package main

import (
	"context"
	"fmt"
	"os"
	logto "github.com/mostafa/go-api-client"
)

func main() {
	id := "id_example" // string | The unique identifier of the organization.
	createOrganizationJitEmailDomainRequest := *logto.NewCreateOrganizationJitEmailDomainRequest("EmailDomain_example") // CreateOrganizationJitEmailDomainRequest | 

	configuration := logto.NewConfiguration()
	apiClient := logto.NewAPIClient(configuration)
	r, err := apiClient.OrganizationsAPI.CreateOrganizationJitEmailDomain(context.Background(), id).CreateOrganizationJitEmailDomainRequest(createOrganizationJitEmailDomainRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsAPI.CreateOrganizationJitEmailDomain``: %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.
id string The unique identifier of the organization.

Other Parameters

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

Name Type Description Notes

createOrganizationJitEmailDomainRequest | CreateOrganizationJitEmailDomainRequest | |

Return type

(empty response body)

Authorization

ManagementApi

HTTP request headers

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

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

CreateOrganizationJitRole

CreateOrganizationJitRole(ctx, id).CreateOrganizationJitRoleRequest(createOrganizationJitRoleRequest).Execute()

Add organization JIT default roles

Example

package main

import (
	"context"
	"fmt"
	"os"
	logto "github.com/mostafa/go-api-client"
)

func main() {
	id := "id_example" // string | The unique identifier of the organization.
	createOrganizationJitRoleRequest := *logto.NewCreateOrganizationJitRoleRequest([]string{"OrganizationRoleIds_example"}) // CreateOrganizationJitRoleRequest | 

	configuration := logto.NewConfiguration()
	apiClient := logto.NewAPIClient(configuration)
	r, err := apiClient.OrganizationsAPI.CreateOrganizationJitRole(context.Background(), id).CreateOrganizationJitRoleRequest(createOrganizationJitRoleRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsAPI.CreateOrganizationJitRole``: %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.
id string The unique identifier of the organization.

Other Parameters

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

Name Type Description Notes

createOrganizationJitRoleRequest | CreateOrganizationJitRoleRequest | |

Return type

(empty response body)

Authorization

ManagementApi

HTTP request headers

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

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

CreateOrganizationJitSsoConnector

CreateOrganizationJitSsoConnector(ctx, id).CreateOrganizationJitSsoConnectorRequest(createOrganizationJitSsoConnectorRequest).Execute()

Add organization JIT SSO connectors

Example

package main

import (
	"context"
	"fmt"
	"os"
	logto "github.com/mostafa/go-api-client"
)

func main() {
	id := "id_example" // string | The unique identifier of the organization.
	createOrganizationJitSsoConnectorRequest := *logto.NewCreateOrganizationJitSsoConnectorRequest([]string{"SsoConnectorIds_example"}) // CreateOrganizationJitSsoConnectorRequest | 

	configuration := logto.NewConfiguration()
	apiClient := logto.NewAPIClient(configuration)
	r, err := apiClient.OrganizationsAPI.CreateOrganizationJitSsoConnector(context.Background(), id).CreateOrganizationJitSsoConnectorRequest(createOrganizationJitSsoConnectorRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsAPI.CreateOrganizationJitSsoConnector``: %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.
id string The unique identifier of the organization.

Other Parameters

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

Name Type Description Notes

createOrganizationJitSsoConnectorRequest | CreateOrganizationJitSsoConnectorRequest | |

Return type

(empty response body)

Authorization

ManagementApi

HTTP request headers

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

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

DeleteOrganization

DeleteOrganization(ctx, id).Execute()

Delete organization

Example

package main

import (
	"context"
	"fmt"
	"os"
	logto "github.com/mostafa/go-api-client"
)

func main() {
	id := "id_example" // string | The unique identifier of the organization.

	configuration := logto.NewConfiguration()
	apiClient := logto.NewAPIClient(configuration)
	r, err := apiClient.OrganizationsAPI.DeleteOrganization(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsAPI.DeleteOrganization``: %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.
id string The unique identifier of the organization.

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

Authorization

ManagementApi

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

DeleteOrganizationApplication

DeleteOrganizationApplication(ctx, id, applicationId).Execute()

Remove organization application

Example

package main

import (
	"context"
	"fmt"
	"os"
	logto "github.com/mostafa/go-api-client"
)

func main() {
	id := "id_example" // string | The unique identifier of the organization.
	applicationId := "applicationId_example" // string | The unique identifier of the application.

	configuration := logto.NewConfiguration()
	apiClient := logto.NewAPIClient(configuration)
	r, err := apiClient.OrganizationsAPI.DeleteOrganizationApplication(context.Background(), id, applicationId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsAPI.DeleteOrganizationApplication``: %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.
id string The unique identifier of the organization.
applicationId string The unique identifier of the application.

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

Authorization

ManagementApi

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

DeleteOrganizationApplicationRole

DeleteOrganizationApplicationRole(ctx, id, applicationId, organizationRoleId).Execute()

Remove organization application role

Example

package main

import (
	"context"
	"fmt"
	"os"
	logto "github.com/mostafa/go-api-client"
)

func main() {
	id := "id_example" // string | The unique identifier of the organization.
	applicationId := "applicationId_example" // string | The unique identifier of the application.
	organizationRoleId := "organizationRoleId_example" // string | The unique identifier of the organization role.

	configuration := logto.NewConfiguration()
	apiClient := logto.NewAPIClient(configuration)
	r, err := apiClient.OrganizationsAPI.DeleteOrganizationApplicationRole(context.Background(), id, applicationId, organizationRoleId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsAPI.DeleteOrganizationApplicationRole``: %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.
id string The unique identifier of the organization.
applicationId string The unique identifier of the application.
organizationRoleId string The unique identifier of the organization role.

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

Authorization

ManagementApi

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

DeleteOrganizationJitEmailDomain

DeleteOrganizationJitEmailDomain(ctx, id, emailDomain).Execute()

Remove organization JIT email domain

Example

package main

import (
	"context"
	"fmt"
	"os"
	logto "github.com/mostafa/go-api-client"
)

func main() {
	id := "id_example" // string | The unique identifier of the organization.
	emailDomain := "emailDomain_example" // string | The email domain to remove.

	configuration := logto.NewConfiguration()
	apiClient := logto.NewAPIClient(configuration)
	r, err := apiClient.OrganizationsAPI.DeleteOrganizationJitEmailDomain(context.Background(), id, emailDomain).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsAPI.DeleteOrganizationJitEmailDomain``: %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.
id string The unique identifier of the organization.
emailDomain string The email domain to remove.

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

Authorization

ManagementApi

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

DeleteOrganizationJitRole

DeleteOrganizationJitRole(ctx, id, organizationRoleId).Execute()

Remove organization JIT default role

Example

package main

import (
	"context"
	"fmt"
	"os"
	logto "github.com/mostafa/go-api-client"
)

func main() {
	id := "id_example" // string | The unique identifier of the organization.
	organizationRoleId := "organizationRoleId_example" // string | The unique identifier of the organization role.

	configuration := logto.NewConfiguration()
	apiClient := logto.NewAPIClient(configuration)
	r, err := apiClient.OrganizationsAPI.DeleteOrganizationJitRole(context.Background(), id, organizationRoleId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsAPI.DeleteOrganizationJitRole``: %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.
id string The unique identifier of the organization.
organizationRoleId string The unique identifier of the organization role.

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

Authorization

ManagementApi

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

DeleteOrganizationJitSsoConnector

DeleteOrganizationJitSsoConnector(ctx, id, ssoConnectorId).Execute()

Remove organization JIT SSO connector

Example

package main

import (
	"context"
	"fmt"
	"os"
	logto "github.com/mostafa/go-api-client"
)

func main() {
	id := "id_example" // string | The unique identifier of the organization.
	ssoConnectorId := "ssoConnectorId_example" // string | The unique identifier of the sso connector.

	configuration := logto.NewConfiguration()
	apiClient := logto.NewAPIClient(configuration)
	r, err := apiClient.OrganizationsAPI.DeleteOrganizationJitSsoConnector(context.Background(), id, ssoConnectorId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsAPI.DeleteOrganizationJitSsoConnector``: %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.
id string The unique identifier of the organization.
ssoConnectorId string The unique identifier of the sso connector.

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

Authorization

ManagementApi

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

DeleteOrganizationUser

DeleteOrganizationUser(ctx, id, userId).Execute()

Remove user member from organization

Example

package main

import (
	"context"
	"fmt"
	"os"
	logto "github.com/mostafa/go-api-client"
)

func main() {
	id := "id_example" // string | The unique identifier of the organization.
	userId := "userId_example" // string | The unique identifier of the user.

	configuration := logto.NewConfiguration()
	apiClient := logto.NewAPIClient(configuration)
	r, err := apiClient.OrganizationsAPI.DeleteOrganizationUser(context.Background(), id, userId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsAPI.DeleteOrganizationUser``: %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.
id string The unique identifier of the organization.
userId string The unique identifier of the user.

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

Authorization

ManagementApi

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

DeleteOrganizationUserRole

DeleteOrganizationUserRole(ctx, id, userId, organizationRoleId).Execute()

Remove a role from a user in an organization

Example

package main

import (
	"context"
	"fmt"
	"os"
	logto "github.com/mostafa/go-api-client"
)

func main() {
	id := "id_example" // string | The unique identifier of the organization.
	userId := "userId_example" // string | The unique identifier of the user.
	organizationRoleId := "organizationRoleId_example" // string | The unique identifier of the organization role.

	configuration := logto.NewConfiguration()
	apiClient := logto.NewAPIClient(configuration)
	r, err := apiClient.OrganizationsAPI.DeleteOrganizationUserRole(context.Background(), id, userId, organizationRoleId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsAPI.DeleteOrganizationUserRole``: %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.
id string The unique identifier of the organization.
userId string The unique identifier of the user.
organizationRoleId string The unique identifier of the organization role.

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

Authorization

ManagementApi

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

GetOrganization

ListApplicationUserConsentOrganizations200ResponseOrganizationsInner GetOrganization(ctx, id).Execute()

Get organization

Example

package main

import (
	"context"
	"fmt"
	"os"
	logto "github.com/mostafa/go-api-client"
)

func main() {
	id := "id_example" // string | The unique identifier of the organization.

	configuration := logto.NewConfiguration()
	apiClient := logto.NewAPIClient(configuration)
	resp, r, err := apiClient.OrganizationsAPI.GetOrganization(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsAPI.GetOrganization``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetOrganization`: ListApplicationUserConsentOrganizations200ResponseOrganizationsInner
	fmt.Fprintf(os.Stdout, "Response from `OrganizationsAPI.GetOrganization`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string The unique identifier of the organization.

Other Parameters

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

Name Type Description Notes

Return type

ListApplicationUserConsentOrganizations200ResponseOrganizationsInner

Authorization

ManagementApi

HTTP request headers

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

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

ListOrganizationApplicationRoles

[]GetOrganizationRole200Response ListOrganizationApplicationRoles(ctx, id, applicationId).Page(page).PageSize(pageSize).Execute()

Get organization application roles

Example

package main

import (
	"context"
	"fmt"
	"os"
	logto "github.com/mostafa/go-api-client"
)

func main() {
	id := "id_example" // string | The unique identifier of the organization.
	applicationId := "applicationId_example" // string | The unique identifier of the application.
	page := int32(56) // int32 | Page number (starts from 1). (optional) (default to 1)
	pageSize := int32(56) // int32 | Entries per page. (optional) (default to 20)

	configuration := logto.NewConfiguration()
	apiClient := logto.NewAPIClient(configuration)
	resp, r, err := apiClient.OrganizationsAPI.ListOrganizationApplicationRoles(context.Background(), id, applicationId).Page(page).PageSize(pageSize).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsAPI.ListOrganizationApplicationRoles``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListOrganizationApplicationRoles`: []GetOrganizationRole200Response
	fmt.Fprintf(os.Stdout, "Response from `OrganizationsAPI.ListOrganizationApplicationRoles`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string The unique identifier of the organization.
applicationId string The unique identifier of the application.

Other Parameters

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

Name Type Description Notes

page | int32 | Page number (starts from 1). | [default to 1] pageSize | int32 | Entries per page. | [default to 20]

Return type

[]GetOrganizationRole200Response

Authorization

ManagementApi

HTTP request headers

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

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

ListOrganizationApplications

[]ListOrganizationApplications200ResponseInner ListOrganizationApplications(ctx, id).Q(q).Page(page).PageSize(pageSize).Execute()

Get organization applications

Example

package main

import (
	"context"
	"fmt"
	"os"
	logto "github.com/mostafa/go-api-client"
)

func main() {
	id := "id_example" // string | The unique identifier of the organization.
	q := "q_example" // string |  (optional)
	page := int32(56) // int32 | Page number (starts from 1). (optional) (default to 1)
	pageSize := int32(56) // int32 | Entries per page. (optional) (default to 20)

	configuration := logto.NewConfiguration()
	apiClient := logto.NewAPIClient(configuration)
	resp, r, err := apiClient.OrganizationsAPI.ListOrganizationApplications(context.Background(), id).Q(q).Page(page).PageSize(pageSize).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsAPI.ListOrganizationApplications``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListOrganizationApplications`: []ListOrganizationApplications200ResponseInner
	fmt.Fprintf(os.Stdout, "Response from `OrganizationsAPI.ListOrganizationApplications`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string The unique identifier of the organization.

Other Parameters

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

Name Type Description Notes

q | string | | page | int32 | Page number (starts from 1). | [default to 1] pageSize | int32 | Entries per page. | [default to 20]

Return type

[]ListOrganizationApplications200ResponseInner

Authorization

ManagementApi

HTTP request headers

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

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

ListOrganizationJitEmailDomains

[]ListOrganizationJitEmailDomains200ResponseInner ListOrganizationJitEmailDomains(ctx, id).Page(page).PageSize(pageSize).Execute()

Get organization JIT email domains

Example

package main

import (
	"context"
	"fmt"
	"os"
	logto "github.com/mostafa/go-api-client"
)

func main() {
	id := "id_example" // string | The unique identifier of the organization.
	page := int32(56) // int32 | Page number (starts from 1). (optional) (default to 1)
	pageSize := int32(56) // int32 | Entries per page. (optional) (default to 20)

	configuration := logto.NewConfiguration()
	apiClient := logto.NewAPIClient(configuration)
	resp, r, err := apiClient.OrganizationsAPI.ListOrganizationJitEmailDomains(context.Background(), id).Page(page).PageSize(pageSize).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsAPI.ListOrganizationJitEmailDomains``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListOrganizationJitEmailDomains`: []ListOrganizationJitEmailDomains200ResponseInner
	fmt.Fprintf(os.Stdout, "Response from `OrganizationsAPI.ListOrganizationJitEmailDomains`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string The unique identifier of the organization.

Other Parameters

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

Name Type Description Notes

page | int32 | Page number (starts from 1). | [default to 1] pageSize | int32 | Entries per page. | [default to 20]

Return type

[]ListOrganizationJitEmailDomains200ResponseInner

Authorization

ManagementApi

HTTP request headers

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

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

ListOrganizationJitRoles

[]GetOrganizationRole200Response ListOrganizationJitRoles(ctx, id).Page(page).PageSize(pageSize).Execute()

Get organization JIT default roles

Example

package main

import (
	"context"
	"fmt"
	"os"
	logto "github.com/mostafa/go-api-client"
)

func main() {
	id := "id_example" // string | The unique identifier of the organization.
	page := int32(56) // int32 | Page number (starts from 1). (optional) (default to 1)
	pageSize := int32(56) // int32 | Entries per page. (optional) (default to 20)

	configuration := logto.NewConfiguration()
	apiClient := logto.NewAPIClient(configuration)
	resp, r, err := apiClient.OrganizationsAPI.ListOrganizationJitRoles(context.Background(), id).Page(page).PageSize(pageSize).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsAPI.ListOrganizationJitRoles``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListOrganizationJitRoles`: []GetOrganizationRole200Response
	fmt.Fprintf(os.Stdout, "Response from `OrganizationsAPI.ListOrganizationJitRoles`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string The unique identifier of the organization.

Other Parameters

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

Name Type Description Notes

page | int32 | Page number (starts from 1). | [default to 1] pageSize | int32 | Entries per page. | [default to 20]

Return type

[]GetOrganizationRole200Response

Authorization

ManagementApi

HTTP request headers

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

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

ListOrganizationJitSsoConnectors

[]ListOrganizationJitSsoConnectors200ResponseInner ListOrganizationJitSsoConnectors(ctx, id).Page(page).PageSize(pageSize).Execute()

Get organization JIT SSO connectors

Example

package main

import (
	"context"
	"fmt"
	"os"
	logto "github.com/mostafa/go-api-client"
)

func main() {
	id := "id_example" // string | The unique identifier of the organization.
	page := int32(56) // int32 | Page number (starts from 1). (optional) (default to 1)
	pageSize := int32(56) // int32 | Entries per page. (optional) (default to 20)

	configuration := logto.NewConfiguration()
	apiClient := logto.NewAPIClient(configuration)
	resp, r, err := apiClient.OrganizationsAPI.ListOrganizationJitSsoConnectors(context.Background(), id).Page(page).PageSize(pageSize).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsAPI.ListOrganizationJitSsoConnectors``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListOrganizationJitSsoConnectors`: []ListOrganizationJitSsoConnectors200ResponseInner
	fmt.Fprintf(os.Stdout, "Response from `OrganizationsAPI.ListOrganizationJitSsoConnectors`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string The unique identifier of the organization.

Other Parameters

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

Name Type Description Notes

page | int32 | Page number (starts from 1). | [default to 1] pageSize | int32 | Entries per page. | [default to 20]

Return type

[]ListOrganizationJitSsoConnectors200ResponseInner

Authorization

ManagementApi

HTTP request headers

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

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

ListOrganizationUserRoles

[]GetOrganizationRole200Response ListOrganizationUserRoles(ctx, id, userId).Page(page).PageSize(pageSize).Execute()

Get roles for a user in an organization

Example

package main

import (
	"context"
	"fmt"
	"os"
	logto "github.com/mostafa/go-api-client"
)

func main() {
	id := "id_example" // string | The unique identifier of the organization.
	userId := "userId_example" // string | The unique identifier of the user.
	page := int32(56) // int32 | Page number (starts from 1). (optional) (default to 1)
	pageSize := int32(56) // int32 | Entries per page. (optional) (default to 20)

	configuration := logto.NewConfiguration()
	apiClient := logto.NewAPIClient(configuration)
	resp, r, err := apiClient.OrganizationsAPI.ListOrganizationUserRoles(context.Background(), id, userId).Page(page).PageSize(pageSize).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsAPI.ListOrganizationUserRoles``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListOrganizationUserRoles`: []GetOrganizationRole200Response
	fmt.Fprintf(os.Stdout, "Response from `OrganizationsAPI.ListOrganizationUserRoles`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string The unique identifier of the organization.
userId string The unique identifier of the user.

Other Parameters

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

Name Type Description Notes

page | int32 | Page number (starts from 1). | [default to 1] pageSize | int32 | Entries per page. | [default to 20]

Return type

[]GetOrganizationRole200Response

Authorization

ManagementApi

HTTP request headers

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

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

ListOrganizationUserScopes

[]ListOrganizationRoleScopes200ResponseInner ListOrganizationUserScopes(ctx, id, userId).Execute()

Get scopes for a user in an organization tailored by the organization roles

Example

package main

import (
	"context"
	"fmt"
	"os"
	logto "github.com/mostafa/go-api-client"
)

func main() {
	id := "id_example" // string | The unique identifier of the organization.
	userId := "userId_example" // string | The unique identifier of the user.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string The unique identifier of the organization.
userId string The unique identifier of the user.

Other Parameters

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

Name Type Description Notes

Return type

[]ListOrganizationRoleScopes200ResponseInner

Authorization

ManagementApi

HTTP request headers

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

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

ListOrganizationUsers

[]ListOrganizationUsers200ResponseInner ListOrganizationUsers(ctx, id).Q(q).Page(page).PageSize(pageSize).Execute()

Get organization user members

Example

package main

import (
	"context"
	"fmt"
	"os"
	logto "github.com/mostafa/go-api-client"
)

func main() {
	id := "id_example" // string | The unique identifier of the organization.
	q := "q_example" // string | The query to filter users. It will match multiple fields of users, including ID, name, username, email, and phone number.  If not provided, all users will be returned. (optional)
	page := int32(56) // int32 | Page number (starts from 1). (optional) (default to 1)
	pageSize := int32(56) // int32 | Entries per page. (optional) (default to 20)

	configuration := logto.NewConfiguration()
	apiClient := logto.NewAPIClient(configuration)
	resp, r, err := apiClient.OrganizationsAPI.ListOrganizationUsers(context.Background(), id).Q(q).Page(page).PageSize(pageSize).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsAPI.ListOrganizationUsers``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListOrganizationUsers`: []ListOrganizationUsers200ResponseInner
	fmt.Fprintf(os.Stdout, "Response from `OrganizationsAPI.ListOrganizationUsers`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string The unique identifier of the organization.

Other Parameters

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

Name Type Description Notes

q | string | The query to filter users. It will match multiple fields of users, including ID, name, username, email, and phone number. If not provided, all users will be returned. | page | int32 | Page number (starts from 1). | [default to 1] pageSize | int32 | Entries per page. | [default to 20]

Return type

[]ListOrganizationUsers200ResponseInner

Authorization

ManagementApi

HTTP request headers

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

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

ListOrganizations

[]ListOrganizations200ResponseInner ListOrganizations(ctx).Q(q).ShowFeatured(showFeatured).Page(page).PageSize(pageSize).Execute()

Get organizations

Example

package main

import (
	"context"
	"fmt"
	"os"
	logto "github.com/mostafa/go-api-client"
)

func main() {
	q := "q_example" // string | The query to filter organizations. It can be a partial ID or name.  If not provided, all organizations will be returned. (optional)
	showFeatured := "showFeatured_example" // string | Whether to show featured users in the organization. Featured users are randomly selected from the organization members.  If not provided, `featuredUsers` will not be included in the response. (optional)
	page := int32(56) // int32 | Page number (starts from 1). (optional) (default to 1)
	pageSize := int32(56) // int32 | Entries per page. (optional) (default to 20)

	configuration := logto.NewConfiguration()
	apiClient := logto.NewAPIClient(configuration)
	resp, r, err := apiClient.OrganizationsAPI.ListOrganizations(context.Background()).Q(q).ShowFeatured(showFeatured).Page(page).PageSize(pageSize).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsAPI.ListOrganizations``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListOrganizations`: []ListOrganizations200ResponseInner
	fmt.Fprintf(os.Stdout, "Response from `OrganizationsAPI.ListOrganizations`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
q string The query to filter organizations. It can be a partial ID or name. If not provided, all organizations will be returned.
showFeatured string Whether to show featured users in the organization. Featured users are randomly selected from the organization members. If not provided, `featuredUsers` will not be included in the response.
page int32 Page number (starts from 1). [default to 1]
pageSize int32 Entries per page. [default to 20]

Return type

[]ListOrganizations200ResponseInner

Authorization

ManagementApi

HTTP request headers

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

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

ReplaceOrganizationApplicationRoles

ReplaceOrganizationApplicationRoles(ctx, id, applicationId).ReplaceOrganizationApplicationRolesRequest(replaceOrganizationApplicationRolesRequest).Execute()

Replace organization application roles

Example

package main

import (
	"context"
	"fmt"
	"os"
	logto "github.com/mostafa/go-api-client"
)

func main() {
	id := "id_example" // string | The unique identifier of the organization.
	applicationId := "applicationId_example" // string | The unique identifier of the application.
	replaceOrganizationApplicationRolesRequest := *logto.NewReplaceOrganizationApplicationRolesRequest([]string{"OrganizationRoleIds_example"}) // ReplaceOrganizationApplicationRolesRequest | 

	configuration := logto.NewConfiguration()
	apiClient := logto.NewAPIClient(configuration)
	r, err := apiClient.OrganizationsAPI.ReplaceOrganizationApplicationRoles(context.Background(), id, applicationId).ReplaceOrganizationApplicationRolesRequest(replaceOrganizationApplicationRolesRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsAPI.ReplaceOrganizationApplicationRoles``: %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.
id string The unique identifier of the organization.
applicationId string The unique identifier of the application.

Other Parameters

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

Name Type Description Notes

replaceOrganizationApplicationRolesRequest | ReplaceOrganizationApplicationRolesRequest | |

Return type

(empty response body)

Authorization

ManagementApi

HTTP request headers

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

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

ReplaceOrganizationApplications

ReplaceOrganizationApplications(ctx, id).ReplaceOrganizationApplicationsRequest(replaceOrganizationApplicationsRequest).Execute()

Replace organization applications

Example

package main

import (
	"context"
	"fmt"
	"os"
	logto "github.com/mostafa/go-api-client"
)

func main() {
	id := "id_example" // string | The unique identifier of the organization.
	replaceOrganizationApplicationsRequest := *logto.NewReplaceOrganizationApplicationsRequest([]string{"ApplicationIds_example"}) // ReplaceOrganizationApplicationsRequest | 

	configuration := logto.NewConfiguration()
	apiClient := logto.NewAPIClient(configuration)
	r, err := apiClient.OrganizationsAPI.ReplaceOrganizationApplications(context.Background(), id).ReplaceOrganizationApplicationsRequest(replaceOrganizationApplicationsRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsAPI.ReplaceOrganizationApplications``: %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.
id string The unique identifier of the organization.

Other Parameters

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

Name Type Description Notes

replaceOrganizationApplicationsRequest | ReplaceOrganizationApplicationsRequest | |

Return type

(empty response body)

Authorization

ManagementApi

HTTP request headers

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

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

ReplaceOrganizationJitEmailDomains

ReplaceOrganizationJitEmailDomains(ctx, id).ReplaceOrganizationJitEmailDomainsRequest(replaceOrganizationJitEmailDomainsRequest).Execute()

Replace organization JIT email domains

Example

package main

import (
	"context"
	"fmt"
	"os"
	logto "github.com/mostafa/go-api-client"
)

func main() {
	id := "id_example" // string | The unique identifier of the organization.
	replaceOrganizationJitEmailDomainsRequest := *logto.NewReplaceOrganizationJitEmailDomainsRequest([]string{"EmailDomains_example"}) // ReplaceOrganizationJitEmailDomainsRequest | 

	configuration := logto.NewConfiguration()
	apiClient := logto.NewAPIClient(configuration)
	r, err := apiClient.OrganizationsAPI.ReplaceOrganizationJitEmailDomains(context.Background(), id).ReplaceOrganizationJitEmailDomainsRequest(replaceOrganizationJitEmailDomainsRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsAPI.ReplaceOrganizationJitEmailDomains``: %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.
id string The unique identifier of the organization.

Other Parameters

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

Name Type Description Notes

replaceOrganizationJitEmailDomainsRequest | ReplaceOrganizationJitEmailDomainsRequest | |

Return type

(empty response body)

Authorization

ManagementApi

HTTP request headers

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

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

ReplaceOrganizationJitRoles

ReplaceOrganizationJitRoles(ctx, id).ReplaceOrganizationJitRolesRequest(replaceOrganizationJitRolesRequest).Execute()

Replace organization JIT default roles

Example

package main

import (
	"context"
	"fmt"
	"os"
	logto "github.com/mostafa/go-api-client"
)

func main() {
	id := "id_example" // string | The unique identifier of the organization.
	replaceOrganizationJitRolesRequest := *logto.NewReplaceOrganizationJitRolesRequest([]string{"OrganizationRoleIds_example"}) // ReplaceOrganizationJitRolesRequest | 

	configuration := logto.NewConfiguration()
	apiClient := logto.NewAPIClient(configuration)
	r, err := apiClient.OrganizationsAPI.ReplaceOrganizationJitRoles(context.Background(), id).ReplaceOrganizationJitRolesRequest(replaceOrganizationJitRolesRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsAPI.ReplaceOrganizationJitRoles``: %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.
id string The unique identifier of the organization.

Other Parameters

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

Name Type Description Notes

replaceOrganizationJitRolesRequest | ReplaceOrganizationJitRolesRequest | |

Return type

(empty response body)

Authorization

ManagementApi

HTTP request headers

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

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

ReplaceOrganizationJitSsoConnectors

ReplaceOrganizationJitSsoConnectors(ctx, id).ReplaceOrganizationJitSsoConnectorsRequest(replaceOrganizationJitSsoConnectorsRequest).Execute()

Replace organization JIT SSO connectors

Example

package main

import (
	"context"
	"fmt"
	"os"
	logto "github.com/mostafa/go-api-client"
)

func main() {
	id := "id_example" // string | The unique identifier of the organization.
	replaceOrganizationJitSsoConnectorsRequest := *logto.NewReplaceOrganizationJitSsoConnectorsRequest([]string{"SsoConnectorIds_example"}) // ReplaceOrganizationJitSsoConnectorsRequest | 

	configuration := logto.NewConfiguration()
	apiClient := logto.NewAPIClient(configuration)
	r, err := apiClient.OrganizationsAPI.ReplaceOrganizationJitSsoConnectors(context.Background(), id).ReplaceOrganizationJitSsoConnectorsRequest(replaceOrganizationJitSsoConnectorsRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsAPI.ReplaceOrganizationJitSsoConnectors``: %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.
id string The unique identifier of the organization.

Other Parameters

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

Name Type Description Notes

replaceOrganizationJitSsoConnectorsRequest | ReplaceOrganizationJitSsoConnectorsRequest | |

Return type

(empty response body)

Authorization

ManagementApi

HTTP request headers

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

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

ReplaceOrganizationUserRoles

ReplaceOrganizationUserRoles(ctx, id, userId).ReplaceOrganizationUserRolesRequest(replaceOrganizationUserRolesRequest).Execute()

Update roles for a user in an organization

Example

package main

import (
	"context"
	"fmt"
	"os"
	logto "github.com/mostafa/go-api-client"
)

func main() {
	id := "id_example" // string | The unique identifier of the organization.
	userId := "userId_example" // string | The unique identifier of the user.
	replaceOrganizationUserRolesRequest := *logto.NewReplaceOrganizationUserRolesRequest([]string{"OrganizationRoleIds_example"}) // ReplaceOrganizationUserRolesRequest | 

	configuration := logto.NewConfiguration()
	apiClient := logto.NewAPIClient(configuration)
	r, err := apiClient.OrganizationsAPI.ReplaceOrganizationUserRoles(context.Background(), id, userId).ReplaceOrganizationUserRolesRequest(replaceOrganizationUserRolesRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsAPI.ReplaceOrganizationUserRoles``: %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.
id string The unique identifier of the organization.
userId string The unique identifier of the user.

Other Parameters

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

Name Type Description Notes

replaceOrganizationUserRolesRequest | ReplaceOrganizationUserRolesRequest | |

Return type

(empty response body)

Authorization

ManagementApi

HTTP request headers

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

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

ReplaceOrganizationUsers

ReplaceOrganizationUsers(ctx, id).ReplaceOrganizationUsersRequest(replaceOrganizationUsersRequest).Execute()

Replace organization user members

Example

package main

import (
	"context"
	"fmt"
	"os"
	logto "github.com/mostafa/go-api-client"
)

func main() {
	id := "id_example" // string | The unique identifier of the organization.
	replaceOrganizationUsersRequest := *logto.NewReplaceOrganizationUsersRequest([]string{"UserIds_example"}) // ReplaceOrganizationUsersRequest | 

	configuration := logto.NewConfiguration()
	apiClient := logto.NewAPIClient(configuration)
	r, err := apiClient.OrganizationsAPI.ReplaceOrganizationUsers(context.Background(), id).ReplaceOrganizationUsersRequest(replaceOrganizationUsersRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsAPI.ReplaceOrganizationUsers``: %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.
id string The unique identifier of the organization.

Other Parameters

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

Name Type Description Notes

replaceOrganizationUsersRequest | ReplaceOrganizationUsersRequest | |

Return type

(empty response body)

Authorization

ManagementApi

HTTP request headers

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

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

UpdateOrganization

ListApplicationUserConsentOrganizations200ResponseOrganizationsInner UpdateOrganization(ctx, id).UpdateOrganizationRequest(updateOrganizationRequest).Execute()

Update organization

Example

package main

import (
	"context"
	"fmt"
	"os"
	logto "github.com/mostafa/go-api-client"
)

func main() {
	id := "id_example" // string | The unique identifier of the organization.
	updateOrganizationRequest := *logto.NewUpdateOrganizationRequest() // UpdateOrganizationRequest | 

	configuration := logto.NewConfiguration()
	apiClient := logto.NewAPIClient(configuration)
	resp, r, err := apiClient.OrganizationsAPI.UpdateOrganization(context.Background(), id).UpdateOrganizationRequest(updateOrganizationRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsAPI.UpdateOrganization``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `UpdateOrganization`: ListApplicationUserConsentOrganizations200ResponseOrganizationsInner
	fmt.Fprintf(os.Stdout, "Response from `OrganizationsAPI.UpdateOrganization`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string The unique identifier of the organization.

Other Parameters

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

Name Type Description Notes

updateOrganizationRequest | UpdateOrganizationRequest | |

Return type

ListApplicationUserConsentOrganizations200ResponseOrganizationsInner

Authorization

ManagementApi

HTTP request headers

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

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