feat(iam/v1alpha1): add GetSamlInformation (#2324)

Co-authored-by: Jonathan R. <jremy@scaleway.com>

Author: scaleway-bot

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

@@ -64,6 +64,7 @@ import {
   unmarshalQuotum,
   unmarshalSaml,
   unmarshalSamlCertificate,
+  unmarshalSamlInformation,
   unmarshalSetRulesResponse,
   unmarshalSSHKey,
   unmarshalUser,
@@ -106,6 +107,7 @@ import type {
   GetOrganizationSecuritySettingsRequest,
   GetPolicyRequest,
   GetQuotumRequest,
+  GetSamlInformationRequest,
   GetSSHKeyRequest,
   GetUserConnectionsRequest,
   GetUserConnectionsResponse,
@@ -153,6 +155,7 @@ import type {
   RemoveUserConnectionRequest,
   Saml,
   SamlCertificate,
+  SamlInformation,
   SetGroupMembersRequest,
   SetOrganizationAliasRequest,
   SetRulesRequest,
@@ -1518,4 +1521,19 @@ export class API extends ParentAPI {
       method: 'DELETE',
       path: `/iam/v1alpha1/saml-certificates/${validatePathParam('certificateId', request.certificateId)}`,
     })
+
+  /**
+   * Get SAML information.
+   *
+   * @param request - The request {@link GetSamlInformationRequest}
+   * @returns A Promise of SamlInformation
+   */
+  getSamlInformation = (request: Readonly<GetSamlInformationRequest> = {}) =>
+    this.client.fetch<SamlInformation>(
+      {
+        method: 'GET',
+        path: `/iam/v1alpha1/saml-information`,
+      },
+      unmarshalSamlInformation,
+    )
 }

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

@@ -44,6 +44,7 @@ export type {
   GetOrganizationSecuritySettingsRequest,
   GetPolicyRequest,
   GetQuotumRequest,
+  GetSamlInformationRequest,
   GetSSHKeyRequest,
   GetUserConnectionsRequest,
   GetUserConnectionsResponse,
@@ -113,6 +114,7 @@ export type {
   SamlCertificate,
   SamlCertificateOrigin,
   SamlCertificateType,
+  SamlInformation,
   SetGroupMembersRequest,
   SetOrganizationAliasRequest,
   SetRulesRequest,

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

@@ -60,6 +60,7 @@ import type {
   RuleSpecs,
   Saml,
   SamlCertificate,
+  SamlInformation,
   SetGroupMembersRequest,
   SetOrganizationAliasRequest,
   SetRulesRequest,
@@ -711,6 +712,19 @@ export const unmarshalSaml = (data: unknown): Saml => {
   } as Saml
 }
 
+export const unmarshalSamlInformation = (data: unknown): SamlInformation => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'SamlInformation' failed as data isn't a dictionary.`,
+    )
+  }
+
+  return {
+    assertionConsumerServiceUrl: data.assertion_consumer_service_url,
+    entityId: data.entity_id,
+  } as SamlInformation
+}
+
 export const unmarshalSetRulesResponse = (data: unknown): SetRulesResponse => {
   if (!isJSONObject(data)) {
     throw new TypeError(

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

@@ -1191,6 +1191,8 @@ export type GetSSHKeyRequest = {
   sshKeyId: string
 }
 
+export type GetSamlInformationRequest = Record<string, never>
+
 export type GetUserConnectionsRequest = {
   /**
    * ID of the user to list connections for.
@@ -1842,6 +1844,17 @@ export interface Saml {
   singleSignOnUrl: string
 }
 
+export interface SamlInformation {
+  /**
+   * Entity ID.
+   */
+  entityId: string
+  /**
+   * SAML Assertion Consumer Service url.
+   */
+  assertionConsumerServiceUrl: string
+}
+
 export type SetGroupMembersRequest = {
   groupId: string
   userIds: string[]