rest - 具有PowerShell的Invoke-RestMethod的OneLogin REST API

我正在使用OneLogin REST API，并且似乎无法使用PUT方法正常工作。当我在Postman中进行测试时，我可以像这样传递原始的JSON正文:

{
   "role_id_array":  [
                        115028
                     ]
}

到端点:

https://api.us.onelogin.com/api/1/users/ / add_roles

这样很好。但是，当我尝试使用PowerShell的Invoke-RestMethod命令执行相同操作时，出现了400错误请求错误。我的代码如下所示:

$Splat = @{
    Method      = $Method
    Uri         = https://api.us.onelogin.com/api/1/users/12345678/add_roles
    ContentType = "application/json"
    Headers     = @{authorization = "bearer:$($Token.access_token)"}
    Body        = @{role_id_array = @(123456)}
}

Invoke-RestMethod @Splat

到目前为止，我对任何GET调用都没有问题，仅对PUT没问题。另外，如果我运行通过ConvertTo-Json传递的Body哈希表，则输出看起来就像上面的工作示例。有谁对为什么这个不起作用有任何想法？

最佳答案

我能够得到一个PUT来工作!

如何从Invoke-RestMethod获取丰富的错误响应数据

首先，我使用了this blog post here，它具有一种出色的方法来检索Invoke-RestMethod或WebRequest cmdlet的完整错误消息。

在他的方法中，首先定义一个称为故障的函数。

function Failure {
    $global:helpme = $body
    $global:helpmoref = $moref
    $global:result = $_.Exception.Response.GetResponseStream()
    $global:reader = New-Object System.IO.StreamReader($global:result)
    $global:responseBody = $global:reader.ReadToEnd();
    Write-Host -BackgroundColor:Black -ForegroundColor:Red "Status: A system exception was caught."
    Write-Host -BackgroundColor:Black -ForegroundColor:Red $global:responsebody
    Write-Host -BackgroundColor:Black -ForegroundColor:Red "The request body has been saved to `$global:helpme"
    break
}

然后，将所有Invoke-RestMethod调用包装在try Catch块中，如下所示。

try {
    $e = Invoke-WebRequest 'https://api.us.onelogin.com/api/1/users/$id' `
        -Headers  @{ Authorization = "bearer:$token" } `
        -Body ( @{ phone = "7709746046" } | ConvertTo-Json ) `
        -Method Put `
        -ErrorAction:Stop `
        -ContentType 'application/json'
}
catch {Failure}

现在，当您遇到错误时，您可以看到实际的消息，如下所示

> Status: A system exception was caught.
{"status":{"error":true,"code":400,"type":"bad request","message":{"description":"notes is not a valid attribute for user model","attribute":"notes"}}}
The request body has been saved to $global:helpme

这对于帮助我摆脱遇到的错误非常有帮助，并且我能够使用PUT动词更新用户条目并使之正常工作。

解决您的问题

我只需要对您的代码进行两项更改即可使其正常工作。

首先，在URI周围加上引号，因为您的示例代码中没有引号，并且您必须在哈希表中的字符串周围加上引号。

最后，将您的 body 内容传递给ConvertTo-JSON，否则数据将作为字符串发送，就像您在Fiddler中发现的那样。

有了这两个更改，这是我的请求和响应

$Splat = @{
    Method      = 'PUT'
    Uri         = 'https://api.us.onelogin.com/api/1/users/27697924/add_roles'
    ContentType = "application/json"
    Headers     = @{authorization = "bearer:$token" }
    Body        = @{role_id_array = @(143175)} | ConvertTo-Json
}

try {Invoke-RestMethod @Splat -ErrorAction Stop }
catch {Failure}

这是回应:

status
------
@{type=success; message=Success; error=False; code=200}

更新:我们做到了，现在已经解决了!

如果您认为PowerShell应该显示非200状态代码的实际服务器响应，则请帮助吸引人们注意Github上的open issue on the PowerShell项目页面。

添加您的反馈或赞许，我们可能会在将来的语言版本中对此进行更改。

从PowerShell v6.1 起现已解决此问题