feat(iam): add GetOrganization and SetOrganizationAlias (#2183)

Author: scaleway-bot

packages_generated/iam/src/v1alpha1/api.gen.ts

@@ -21,6 +21,7 @@ import {
   marshalRemoveGroupMemberRequest,
   marshalRemoveUserConnectionRequest,
   marshalSetGroupMembersRequest,
+  marshalSetOrganizationAliasRequest,
   marshalSetRulesRequest,
   marshalUpdateAPIKeyRequest,
   marshalUpdateApplicationRequest,
@@ -53,6 +54,7 @@ import {
   unmarshalListUsersResponse,
   unmarshalLog,
   unmarshalMFAOTP,
+  unmarshalOrganization,
   unmarshalOrganizationSecuritySettings,
   unmarshalPolicy,
   unmarshalQuotum,
@@ -89,6 +91,7 @@ import type {
   GetGroupRequest,
   GetJWTRequest,
   GetLogRequest,
+  GetOrganizationRequest,
   GetOrganizationSecuritySettingsRequest,
   GetPolicyRequest,
   GetQuotumRequest,
@@ -129,13 +132,15 @@ import type {
   Log,
   MFAOTP,
   MigrateOrganizationGuestsRequest,
+  Organization,
   OrganizationSecuritySettings,
   Policy,
   Quotum,
   RemoveGroupMemberRequest,
   RemoveUserConnectionRequest,
   SSHKey,
   SetGroupMembersRequest,
+  SetOrganizationAliasRequest,
   SetRulesRequest,
   SetRulesResponse,
   UnlockUserRequest,
@@ -1338,6 +1343,40 @@ export class API extends ParentAPI {
       unmarshalOrganizationSecuritySettings,
     )
 
+  /**
+   * Set your Organization's alias.. This will fail if an alias has already been defined. Please contact support if you need to change your Organization's alias.
+   *
+   * @param request - The request {@link SetOrganizationAliasRequest}
+   * @returns A Promise of Organization
+   */
+  setOrganizationAlias = (request: Readonly<SetOrganizationAliasRequest>) =>
+    this.client.fetch<Organization>(
+      {
+        body: JSON.stringify(
+          marshalSetOrganizationAliasRequest(request, this.client.settings),
+        ),
+        headers: jsonContentHeaders,
+        method: 'PUT',
+        path: `/iam/v1alpha1/organizations/${validatePathParam('organizationId', request.organizationId ?? this.client.settings.defaultOrganizationId)}/alias`,
+      },
+      unmarshalOrganization,
+    )
+
+  /**
+   * Get your Organization's IAM information.
+   *
+   * @param request - The request {@link GetOrganizationRequest}
+   * @returns A Promise of Organization
+   */
+  getOrganization = (request: Readonly<GetOrganizationRequest> = {}) =>
+    this.client.fetch<Organization>(
+      {
+        method: 'GET',
+        path: `/iam/v1alpha1/organizations/${validatePathParam('organizationId', request.organizationId ?? this.client.settings.defaultOrganizationId)}`,
+      },
+      unmarshalOrganization,
+    )
+
   /**
    * Migrate the organization's guests to IAM members.
    *

packages_generated/iam/src/v1alpha1/index.gen.ts

@@ -35,6 +35,7 @@ export type {
   GetGroupRequest,
   GetJWTRequest,
   GetLogRequest,
+  GetOrganizationRequest,
   GetOrganizationSecuritySettingsRequest,
   GetPolicyRequest,
   GetQuotumRequest,
@@ -90,6 +91,7 @@ export type {
   LogResourceType,
   MFAOTP,
   MigrateOrganizationGuestsRequest,
+  Organization,
   OrganizationSecuritySettings,
   PermissionSet,
   PermissionSetScopeType,
@@ -102,6 +104,7 @@ export type {
   RuleSpecs,
   SSHKey,
   SetGroupMembersRequest,
+  SetOrganizationAliasRequest,
   SetRulesRequest,
   SetRulesResponse,
   UnlockUserRequest,

packages_generated/iam/src/v1alpha1/marshalling.gen.ts

@@ -45,6 +45,7 @@ import type {
   ListUsersResponse,
   Log,
   MFAOTP,
+  Organization,
   OrganizationSecuritySettings,
   PermissionSet,
   Policy,
@@ -56,6 +57,7 @@ import type {
   RuleSpecs,
   SSHKey,
   SetGroupMembersRequest,
+  SetOrganizationAliasRequest,
   SetRulesRequest,
   SetRulesResponse,
   UpdateAPIKeyRequest,
@@ -626,6 +628,20 @@ export const unmarshalMFAOTP = (data: unknown): MFAOTP => {
   } as MFAOTP
 }
 
+export const unmarshalOrganization = (data: unknown): Organization => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'Organization' failed as data isn't a dictionary.`,
+    )
+  }
+
+  return {
+    alias: data.alias,
+    id: data.id,
+    name: data.name,
+  } as Organization
+}
+
 export const unmarshalOrganizationSecuritySettings = (
   data: unknown,
 ): OrganizationSecuritySettings => {
@@ -833,6 +849,13 @@ export const marshalSetGroupMembersRequest = (
   user_ids: request.userIds,
 })
 
+export const marshalSetOrganizationAliasRequest = (
+  request: SetOrganizationAliasRequest,
+  defaults: DefaultValues,
+): Record<string, unknown> => ({
+  alias: request.alias,
+})
+
 export const marshalSetRulesRequest = (
   request: SetRulesRequest,
   defaults: DefaultValues,

packages_generated/iam/src/v1alpha1/types.gen.ts

@@ -1068,6 +1068,13 @@ export type GetLogRequest = {
   logId: string
 }
 
+export type GetOrganizationRequest = {
+  /**
+   * ID of the Organization.
+   */
+  organizationId?: string
+}
+
 export type GetOrganizationSecuritySettingsRequest = {
   /**
    * ID of the Organization.
@@ -1662,6 +1669,21 @@ export type MigrateOrganizationGuestsRequest = {
   organizationId?: string
 }
 
+export interface Organization {
+  /**
+   * ID of the Organization.
+   */
+  id: string
+  /**
+   * Name of the Organization.
+   */
+  name: string
+  /**
+   * Alias of the Organization.
+   */
+  alias: string
+}
+
 export interface OrganizationSecuritySettings {
   /**
    * Defines whether password renewal is enforced during first login.
@@ -1713,6 +1735,17 @@ export type SetGroupMembersRequest = {
   applicationIds: string[]
 }
 
+export type SetOrganizationAliasRequest = {
+  /**
+   * ID of the Organization.
+   */
+  organizationId?: string
+  /**
+   * Alias of the Organization.
+   */
+  alias: string
+}
+
 export type SetRulesRequest = {
   /**
    * Id of policy to update.

packages_generated/iam/src/v1alpha1/validation-rules.gen.ts

@@ -230,6 +230,14 @@ export const RuleSpecs = {
   },
 }
 
+export const SetOrganizationAliasRequest = {
+  alias: {
+    maxLength: 32,
+    minLength: 2,
+    pattern: /^[a-z0-9]+$/,
+  },
+}
+
 export const UpdateAPIKeyRequest = {
   description: {
     maxLength: 200,